Amazon Timestream for InfluxDB is a managed time-series database engine that makes it easy for application developers and DevOps teams to run InfluxDB databases on AWS for near real-time time-series applications using open-source APIs. With Amazon Timestream for InfluxDB, it is easy to set up, operate, and scale time-series workloads that can answer queries with single-digit millisecond query response time.
+ +## Installing + +To install the this package, simply type add or install @aws-sdk/client-timestream-influxdb +using your favorite package manager: + +- `npm install @aws-sdk/client-timestream-influxdb` +- `yarn add @aws-sdk/client-timestream-influxdb` +- `pnpm add @aws-sdk/client-timestream-influxdb` + +## Getting Started + +### Import + +The AWS SDK is modulized by clients and commands. +To send a request, you only need to import the `TimestreamInfluxDBClient` and +the commands you need, for example `ListDbInstancesCommand`: + +```js +// ES5 example +const { TimestreamInfluxDBClient, ListDbInstancesCommand } = require("@aws-sdk/client-timestream-influxdb"); +``` + +```ts +// ES6+ example +import { TimestreamInfluxDBClient, ListDbInstancesCommand } from "@aws-sdk/client-timestream-influxdb"; +``` + +### Usage + +To send a request, you: + +- Initiate client with configuration (e.g. credentials, region). +- Initiate command with input parameters. +- Call `send` operation on client with command object as input. +- If you are using a custom http handler, you may call `destroy()` to close open connections. + +```js +// a client can be shared by different commands. +const client = new TimestreamInfluxDBClient({ region: "REGION" }); + +const params = { + /** input parameters */ +}; +const command = new ListDbInstancesCommand(params); +``` + +#### Async/await + +We recommend using [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await) +operator to wait for the promise returned by send operation as follows: + +```js +// async/await. +try { + const data = await client.send(command); + // process data. +} catch (error) { + // error handling. +} finally { + // finally. +} +``` + +Async-await is clean, concise, intuitive, easy to debug and has better error handling +as compared to using Promise chains or callbacks. + +#### Promises + +You can also use [Promise chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining) +to execute send operation. + +```js +client.send(command).then( + (data) => { + // process data. + }, + (error) => { + // error handling. + } +); +``` + +Promises can also be called using `.catch()` and `.finally()` as follows: + +```js +client + .send(command) + .then((data) => { + // process data. + }) + .catch((error) => { + // error handling. + }) + .finally(() => { + // finally. + }); +``` + +#### Callbacks + +We do not recommend using callbacks because of [callback hell](http://callbackhell.com/), +but they are supported by the send operation. + +```js +// callbacks. +client.send(command, (err, data) => { + // process err and data. +}); +``` + +#### v2 compatible style + +The client can also send requests using v2 compatible style. +However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post +on [modular packages in AWS SDK for JavaScript](https://aws.amazon.com/blogs/developer/modular-packages-in-aws-sdk-for-javascript/) + +```ts +import * as AWS from "@aws-sdk/client-timestream-influxdb"; +const client = new AWS.TimestreamInfluxDB({ region: "REGION" }); + +// async/await. +try { + const data = await client.listDbInstances(params); + // process data. +} catch (error) { + // error handling. +} + +// Promises. +client + .listDbInstances(params) + .then((data) => { + // process data. + }) + .catch((error) => { + // error handling. + }); + +// callbacks. +client.listDbInstances(params, (err, data) => { + // process err and data. +}); +``` + +### Troubleshooting + +When the service returns an exception, the error will include the exception information, +as well as response metadata (e.g. request id). + +```js +try { + const data = await client.send(command); + // process data. +} catch (error) { + const { requestId, cfId, extendedRequestId } = error.$metadata; + console.log({ requestId, cfId, extendedRequestId }); + /** + * The keys within exceptions are also parsed. + * You can access them by specifying exception names: + * if (error.name === 'SomeServiceException') { + * const value = error.specialKeyInException; + * } + */ +} +``` + +## Getting Help + +Please use these community resources for getting help. +We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them. + +- Visit [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html) + or [API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/index.html). +- Check out the blog posts tagged with [`aws-sdk-js`](https://aws.amazon.com/blogs/developer/tag/aws-sdk-js/) + on AWS Developer Blog. +- Ask a question on [StackOverflow](https://stackoverflow.com/questions/tagged/aws-sdk-js) and tag it with `aws-sdk-js`. +- Join the AWS JavaScript community on [gitter](https://gitter.im/aws/aws-sdk-js-v3). +- If it turns out that you may have found a bug, please [open an issue](https://github.com/aws/aws-sdk-js-v3/issues/new/choose). + +To test your universal JavaScript code in Node.js, browser and react-native environments, +visit our [code samples repo](https://github.com/aws-samples/aws-sdk-js-tests). + +## Contributing + +This client code is generated automatically. Any modifications will be overwritten the next time the `@aws-sdk/client-timestream-influxdb` package is updated. +To contribute to client you can check our [generate clients scripts](https://github.com/aws/aws-sdk-js-v3/tree/main/scripts/generate-clients). + +## License + +This SDK is distributed under the +[Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0), +see LICENSE for more information. + +## Client Commands (Operations List) + +Amazon Timestream for InfluxDB is a managed time-series database engine that makes it easy for application developers and DevOps teams to run InfluxDB databases on AWS for near real-time time-series applications using open-source APIs. With Amazon Timestream for InfluxDB, it is easy to set up, operate, and scale time-series workloads that can answer queries with single-digit millisecond query response time.
+ */ +export class TimestreamInfluxDB extends TimestreamInfluxDBClient implements TimestreamInfluxDB {} +createAggregatedClient(commands, TimestreamInfluxDB); diff --git a/clients/client-timestream-influxdb/src/TimestreamInfluxDBClient.ts b/clients/client-timestream-influxdb/src/TimestreamInfluxDBClient.ts new file mode 100644 index 000000000000..6c23e38c0d35 --- /dev/null +++ b/clients/client-timestream-influxdb/src/TimestreamInfluxDBClient.ts @@ -0,0 +1,352 @@ +// smithy-typescript generated code +import { + getHostHeaderPlugin, + HostHeaderInputConfig, + HostHeaderResolvedConfig, + resolveHostHeaderConfig, +} from "@aws-sdk/middleware-host-header"; +import { getLoggerPlugin } from "@aws-sdk/middleware-logger"; +import { getRecursionDetectionPlugin } from "@aws-sdk/middleware-recursion-detection"; +import { + getUserAgentPlugin, + resolveUserAgentConfig, + UserAgentInputConfig, + UserAgentResolvedConfig, +} from "@aws-sdk/middleware-user-agent"; +import { RegionInputConfig, RegionResolvedConfig, resolveRegionConfig } from "@smithy/config-resolver"; +import { + DefaultIdentityProviderConfig, + getHttpAuthSchemeEndpointRuleSetPlugin, + getHttpSigningPlugin, +} from "@smithy/core"; +import { getContentLengthPlugin } from "@smithy/middleware-content-length"; +import { EndpointInputConfig, EndpointResolvedConfig, resolveEndpointConfig } from "@smithy/middleware-endpoint"; +import { getRetryPlugin, resolveRetryConfig, RetryInputConfig, RetryResolvedConfig } from "@smithy/middleware-retry"; +import { HttpHandlerUserInput as __HttpHandlerUserInput } from "@smithy/protocol-http"; +import { + Client as __Client, + DefaultsMode as __DefaultsMode, + SmithyConfiguration as __SmithyConfiguration, + SmithyResolvedConfiguration as __SmithyResolvedConfiguration, +} from "@smithy/smithy-client"; +import { + AwsCredentialIdentityProvider, + BodyLengthCalculator as __BodyLengthCalculator, + CheckOptionalClientConfig as __CheckOptionalClientConfig, + ChecksumConstructor as __ChecksumConstructor, + Decoder as __Decoder, + Encoder as __Encoder, + EndpointV2 as __EndpointV2, + HashConstructor as __HashConstructor, + HttpHandlerOptions as __HttpHandlerOptions, + Logger as __Logger, + Provider as __Provider, + Provider, + StreamCollector as __StreamCollector, + UrlParser as __UrlParser, + UserAgent as __UserAgent, +} from "@smithy/types"; + +import { + defaultTimestreamInfluxDBHttpAuthSchemeParametersProvider, + HttpAuthSchemeInputConfig, + HttpAuthSchemeResolvedConfig, + resolveHttpAuthSchemeConfig, +} from "./auth/httpAuthSchemeProvider"; +import { CreateDbInstanceCommandInput, CreateDbInstanceCommandOutput } from "./commands/CreateDbInstanceCommand"; +import { + CreateDbParameterGroupCommandInput, + CreateDbParameterGroupCommandOutput, +} from "./commands/CreateDbParameterGroupCommand"; +import { DeleteDbInstanceCommandInput, DeleteDbInstanceCommandOutput } from "./commands/DeleteDbInstanceCommand"; +import { GetDbInstanceCommandInput, GetDbInstanceCommandOutput } from "./commands/GetDbInstanceCommand"; +import { + GetDbParameterGroupCommandInput, + GetDbParameterGroupCommandOutput, +} from "./commands/GetDbParameterGroupCommand"; +import { ListDbInstancesCommandInput, ListDbInstancesCommandOutput } from "./commands/ListDbInstancesCommand"; +import { + ListDbParameterGroupsCommandInput, + ListDbParameterGroupsCommandOutput, +} from "./commands/ListDbParameterGroupsCommand"; +import { + ListTagsForResourceCommandInput, + ListTagsForResourceCommandOutput, +} from "./commands/ListTagsForResourceCommand"; +import { TagResourceCommandInput, TagResourceCommandOutput } from "./commands/TagResourceCommand"; +import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./commands/UntagResourceCommand"; +import { UpdateDbInstanceCommandInput, UpdateDbInstanceCommandOutput } from "./commands/UpdateDbInstanceCommand"; +import { + ClientInputEndpointParameters, + ClientResolvedEndpointParameters, + EndpointParameters, + resolveClientEndpointParameters, +} from "./endpoint/EndpointParameters"; +import { getRuntimeConfig as __getRuntimeConfig } from "./runtimeConfig"; +import { resolveRuntimeExtensions, RuntimeExtension, RuntimeExtensionsConfig } from "./runtimeExtensions"; + +export { __Client }; + +/** + * @public + */ +export type ServiceInputTypes = + | CreateDbInstanceCommandInput + | CreateDbParameterGroupCommandInput + | DeleteDbInstanceCommandInput + | GetDbInstanceCommandInput + | GetDbParameterGroupCommandInput + | ListDbInstancesCommandInput + | ListDbParameterGroupsCommandInput + | ListTagsForResourceCommandInput + | TagResourceCommandInput + | UntagResourceCommandInput + | UpdateDbInstanceCommandInput; + +/** + * @public + */ +export type ServiceOutputTypes = + | CreateDbInstanceCommandOutput + | CreateDbParameterGroupCommandOutput + | DeleteDbInstanceCommandOutput + | GetDbInstanceCommandOutput + | GetDbParameterGroupCommandOutput + | ListDbInstancesCommandOutput + | ListDbParameterGroupsCommandOutput + | ListTagsForResourceCommandOutput + | TagResourceCommandOutput + | UntagResourceCommandOutput + | UpdateDbInstanceCommandOutput; + +/** + * @public + */ +export interface ClientDefaults extends Partial<__SmithyConfiguration<__HttpHandlerOptions>> { + /** + * The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs. + */ + requestHandler?: __HttpHandlerUserInput; + + /** + * A constructor for a class implementing the {@link @smithy/types#ChecksumConstructor} interface + * that computes the SHA-256 HMAC or checksum of a string or binary buffer. + * @internal + */ + sha256?: __ChecksumConstructor | __HashConstructor; + + /** + * The function that will be used to convert strings into HTTP endpoints. + * @internal + */ + urlParser?: __UrlParser; + + /** + * A function that can calculate the length of a request body. + * @internal + */ + bodyLengthChecker?: __BodyLengthCalculator; + + /** + * A function that converts a stream into an array of bytes. + * @internal + */ + streamCollector?: __StreamCollector; + + /** + * The function that will be used to convert a base64-encoded string to a byte array. + * @internal + */ + base64Decoder?: __Decoder; + + /** + * The function that will be used to convert binary data to a base64-encoded string. + * @internal + */ + base64Encoder?: __Encoder; + + /** + * The function that will be used to convert a UTF8-encoded string to a byte array. + * @internal + */ + utf8Decoder?: __Decoder; + + /** + * The function that will be used to convert binary data to a UTF-8 encoded string. + * @internal + */ + utf8Encoder?: __Encoder; + + /** + * The runtime environment. + * @internal + */ + runtime?: string; + + /** + * Disable dynamically changing the endpoint of the client based on the hostPrefix + * trait of an operation. + */ + disableHostPrefix?: boolean; + + /** + * Unique service identifier. + * @internal + */ + serviceId?: string; + + /** + * Enables IPv6/IPv4 dualstack endpoint. + */ + useDualstackEndpoint?: boolean | __ProviderAmazon Timestream for InfluxDB is a managed time-series database engine that makes it easy for application developers and DevOps teams to run InfluxDB databases on AWS for near real-time time-series applications using open-source APIs. With Amazon Timestream for InfluxDB, it is easy to set up, operate, and scale time-series workloads that can answer queries with single-digit millisecond query response time.
+ */ +export class TimestreamInfluxDBClient extends __Client< + __HttpHandlerOptions, + ServiceInputTypes, + ServiceOutputTypes, + TimestreamInfluxDBClientResolvedConfig +> { + /** + * The resolved configuration of TimestreamInfluxDBClient class. This is resolved and normalized from the {@link TimestreamInfluxDBClientConfig | constructor configuration interface}. + */ + readonly config: TimestreamInfluxDBClientResolvedConfig; + + constructor(...[configuration]: __CheckOptionalClientConfigCreates a new Timestream for InfluxDB DB instance.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { TimestreamInfluxDBClient, CreateDbInstanceCommand } from "@aws-sdk/client-timestream-influxdb"; // ES Modules import + * // const { TimestreamInfluxDBClient, CreateDbInstanceCommand } = require("@aws-sdk/client-timestream-influxdb"); // CommonJS import + * const client = new TimestreamInfluxDBClient(config); + * const input = { // CreateDbInstanceInput + * name: "STRING_VALUE", // required + * username: "STRING_VALUE", + * password: "STRING_VALUE", // required + * organization: "STRING_VALUE", + * bucket: "STRING_VALUE", + * dbInstanceType: "db.influx.medium" || "db.influx.large" || "db.influx.xlarge" || "db.influx.2xlarge" || "db.influx.4xlarge" || "db.influx.8xlarge" || "db.influx.12xlarge" || "db.influx.16xlarge", // required + * vpcSubnetIds: [ // VpcSubnetIdList // required + * "STRING_VALUE", + * ], + * vpcSecurityGroupIds: [ // VpcSecurityGroupIdList // required + * "STRING_VALUE", + * ], + * publiclyAccessible: true || false, + * dbStorageType: "InfluxIOIncludedT1" || "InfluxIOIncludedT2" || "InfluxIOIncludedT3", + * allocatedStorage: Number("int"), // required + * dbParameterGroupIdentifier: "STRING_VALUE", + * deploymentType: "SINGLE_AZ" || "WITH_MULTIAZ_STANDBY", + * logDeliveryConfiguration: { // LogDeliveryConfiguration + * s3Configuration: { // S3Configuration + * bucketName: "STRING_VALUE", // required + * enabled: true || false, // required + * }, + * }, + * tags: { // RequestTagMap + * "You do not have sufficient access to perform this action.
+ * + * @throws {@link ConflictException} (client fault) + *The request conflicts with an existing resource in Timestream for InfluxDB.
+ * + * @throws {@link InternalServerException} (server fault) + *The request processing has failed because of an unknown error, exception or failure.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The requested resource was not found or does not exist.
+ * + * @throws {@link ServiceQuotaExceededException} (client fault) + *The request exceeds the service quota.
+ * + * @throws {@link ThrottlingException} (client fault) + *The request was denied due to request throttling.
+ * + * @throws {@link ValidationException} (client fault) + *The input fails to satisfy the constraints specified by Timestream for InfluxDB.
+ * + * @throws {@link TimestreamInfluxDBServiceException} + *Base exception class for all service exceptions from TimestreamInfluxDB service.
+ * + */ +export class CreateDbInstanceCommand extends $Command + .classBuilder< + CreateDbInstanceCommandInput, + CreateDbInstanceCommandOutput, + TimestreamInfluxDBClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep({ + ...commonParams, + }) + .m(function (this: any, Command: any, cs: any, config: TimestreamInfluxDBClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("AmazonTimestreamInfluxDB", "CreateDbInstance", {}) + .n("TimestreamInfluxDBClient", "CreateDbInstanceCommand") + .f(CreateDbInstanceInputFilterSensitiveLog, void 0) + .ser(se_CreateDbInstanceCommand) + .de(de_CreateDbInstanceCommand) + .build() {} diff --git a/clients/client-timestream-influxdb/src/commands/CreateDbParameterGroupCommand.ts b/clients/client-timestream-influxdb/src/commands/CreateDbParameterGroupCommand.ts new file mode 100644 index 000000000000..2aba820dce44 --- /dev/null +++ b/clients/client-timestream-influxdb/src/commands/CreateDbParameterGroupCommand.ts @@ -0,0 +1,135 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { commonParams } from "../endpoint/EndpointParameters"; +import { CreateDbParameterGroupInput, CreateDbParameterGroupOutput } from "../models/models_0"; +import { de_CreateDbParameterGroupCommand, se_CreateDbParameterGroupCommand } from "../protocols/Aws_json1_0"; +import { + ServiceInputTypes, + ServiceOutputTypes, + TimestreamInfluxDBClientResolvedConfig, +} from "../TimestreamInfluxDBClient"; + +/** + * @public + */ +export { __MetadataBearer, $Command }; +/** + * @public + * + * The input for {@link CreateDbParameterGroupCommand}. + */ +export interface CreateDbParameterGroupCommandInput extends CreateDbParameterGroupInput {} +/** + * @public + * + * The output of {@link CreateDbParameterGroupCommand}. + */ +export interface CreateDbParameterGroupCommandOutput extends CreateDbParameterGroupOutput, __MetadataBearer {} + +/** + * @public + *Creates a new Timestream for InfluxDB DB parameter group to associate with DB instances.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { TimestreamInfluxDBClient, CreateDbParameterGroupCommand } from "@aws-sdk/client-timestream-influxdb"; // ES Modules import + * // const { TimestreamInfluxDBClient, CreateDbParameterGroupCommand } = require("@aws-sdk/client-timestream-influxdb"); // CommonJS import + * const client = new TimestreamInfluxDBClient(config); + * const input = { // CreateDbParameterGroupInput + * name: "STRING_VALUE", // required + * description: "STRING_VALUE", + * parameters: { // Parameters Union: only one key present + * InfluxDBv2: { // InfluxDBv2Parameters + * fluxLogEnabled: true || false, + * logLevel: "debug" || "info" || "error", + * noTasks: true || false, + * queryConcurrency: Number("int"), + * queryQueueSize: Number("int"), + * tracingType: "log" || "jaeger", + * metricsDisabled: true || false, + * }, + * }, + * tags: { // RequestTagMap + * "You do not have sufficient access to perform this action.
+ * + * @throws {@link ConflictException} (client fault) + *The request conflicts with an existing resource in Timestream for InfluxDB.
+ * + * @throws {@link InternalServerException} (server fault) + *The request processing has failed because of an unknown error, exception or failure.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The requested resource was not found or does not exist.
+ * + * @throws {@link ServiceQuotaExceededException} (client fault) + *The request exceeds the service quota.
+ * + * @throws {@link ThrottlingException} (client fault) + *The request was denied due to request throttling.
+ * + * @throws {@link ValidationException} (client fault) + *The input fails to satisfy the constraints specified by Timestream for InfluxDB.
+ * + * @throws {@link TimestreamInfluxDBServiceException} + *Base exception class for all service exceptions from TimestreamInfluxDB service.
+ * + */ +export class CreateDbParameterGroupCommand extends $Command + .classBuilder< + CreateDbParameterGroupCommandInput, + CreateDbParameterGroupCommandOutput, + TimestreamInfluxDBClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep({ + ...commonParams, + }) + .m(function (this: any, Command: any, cs: any, config: TimestreamInfluxDBClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("AmazonTimestreamInfluxDB", "CreateDbParameterGroup", {}) + .n("TimestreamInfluxDBClient", "CreateDbParameterGroupCommand") + .f(void 0, void 0) + .ser(se_CreateDbParameterGroupCommand) + .de(de_CreateDbParameterGroupCommand) + .build() {} diff --git a/clients/client-timestream-influxdb/src/commands/DeleteDbInstanceCommand.ts b/clients/client-timestream-influxdb/src/commands/DeleteDbInstanceCommand.ts new file mode 100644 index 000000000000..d1a21b837777 --- /dev/null +++ b/clients/client-timestream-influxdb/src/commands/DeleteDbInstanceCommand.ts @@ -0,0 +1,128 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { commonParams } from "../endpoint/EndpointParameters"; +import { DeleteDbInstanceInput, DeleteDbInstanceOutput } from "../models/models_0"; +import { de_DeleteDbInstanceCommand, se_DeleteDbInstanceCommand } from "../protocols/Aws_json1_0"; +import { + ServiceInputTypes, + ServiceOutputTypes, + TimestreamInfluxDBClientResolvedConfig, +} from "../TimestreamInfluxDBClient"; + +/** + * @public + */ +export { __MetadataBearer, $Command }; +/** + * @public + * + * The input for {@link DeleteDbInstanceCommand}. + */ +export interface DeleteDbInstanceCommandInput extends DeleteDbInstanceInput {} +/** + * @public + * + * The output of {@link DeleteDbInstanceCommand}. + */ +export interface DeleteDbInstanceCommandOutput extends DeleteDbInstanceOutput, __MetadataBearer {} + +/** + * @public + *Deletes a Timestream for InfluxDB DB instance.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { TimestreamInfluxDBClient, DeleteDbInstanceCommand } from "@aws-sdk/client-timestream-influxdb"; // ES Modules import + * // const { TimestreamInfluxDBClient, DeleteDbInstanceCommand } = require("@aws-sdk/client-timestream-influxdb"); // CommonJS import + * const client = new TimestreamInfluxDBClient(config); + * const input = { // DeleteDbInstanceInput + * identifier: "STRING_VALUE", // required + * }; + * const command = new DeleteDbInstanceCommand(input); + * const response = await client.send(command); + * // { // DeleteDbInstanceOutput + * // id: "STRING_VALUE", // required + * // name: "STRING_VALUE", // required + * // arn: "STRING_VALUE", // required + * // status: "CREATING" || "AVAILABLE" || "DELETING" || "MODIFYING" || "UPDATING" || "DELETED" || "FAILED", + * // endpoint: "STRING_VALUE", + * // dbInstanceType: "db.influx.medium" || "db.influx.large" || "db.influx.xlarge" || "db.influx.2xlarge" || "db.influx.4xlarge" || "db.influx.8xlarge" || "db.influx.12xlarge" || "db.influx.16xlarge", + * // dbStorageType: "InfluxIOIncludedT1" || "InfluxIOIncludedT2" || "InfluxIOIncludedT3", + * // allocatedStorage: Number("int"), + * // deploymentType: "SINGLE_AZ" || "WITH_MULTIAZ_STANDBY", + * // vpcSubnetIds: [ // VpcSubnetIdList // required + * // "STRING_VALUE", + * // ], + * // publiclyAccessible: true || false, + * // vpcSecurityGroupIds: [ // VpcSecurityGroupIdList + * // "STRING_VALUE", + * // ], + * // dbParameterGroupIdentifier: "STRING_VALUE", + * // availabilityZone: "STRING_VALUE", + * // secondaryAvailabilityZone: "STRING_VALUE", + * // logDeliveryConfiguration: { // LogDeliveryConfiguration + * // s3Configuration: { // S3Configuration + * // bucketName: "STRING_VALUE", // required + * // enabled: true || false, // required + * // }, + * // }, + * // influxAuthParametersSecretArn: "STRING_VALUE", + * // }; + * + * ``` + * + * @param DeleteDbInstanceCommandInput - {@link DeleteDbInstanceCommandInput} + * @returns {@link DeleteDbInstanceCommandOutput} + * @see {@link DeleteDbInstanceCommandInput} for command's `input` shape. + * @see {@link DeleteDbInstanceCommandOutput} for command's `response` shape. + * @see {@link TimestreamInfluxDBClientResolvedConfig | config} for TimestreamInfluxDBClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *You do not have sufficient access to perform this action.
+ * + * @throws {@link ConflictException} (client fault) + *The request conflicts with an existing resource in Timestream for InfluxDB.
+ * + * @throws {@link InternalServerException} (server fault) + *The request processing has failed because of an unknown error, exception or failure.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The requested resource was not found or does not exist.
+ * + * @throws {@link ThrottlingException} (client fault) + *The request was denied due to request throttling.
+ * + * @throws {@link ValidationException} (client fault) + *The input fails to satisfy the constraints specified by Timestream for InfluxDB.
+ * + * @throws {@link TimestreamInfluxDBServiceException} + *Base exception class for all service exceptions from TimestreamInfluxDB service.
+ * + */ +export class DeleteDbInstanceCommand extends $Command + .classBuilder< + DeleteDbInstanceCommandInput, + DeleteDbInstanceCommandOutput, + TimestreamInfluxDBClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep({ + ...commonParams, + }) + .m(function (this: any, Command: any, cs: any, config: TimestreamInfluxDBClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("AmazonTimestreamInfluxDB", "DeleteDbInstance", {}) + .n("TimestreamInfluxDBClient", "DeleteDbInstanceCommand") + .f(void 0, void 0) + .ser(se_DeleteDbInstanceCommand) + .de(de_DeleteDbInstanceCommand) + .build() {} diff --git a/clients/client-timestream-influxdb/src/commands/GetDbInstanceCommand.ts b/clients/client-timestream-influxdb/src/commands/GetDbInstanceCommand.ts new file mode 100644 index 000000000000..87beff8c8ae1 --- /dev/null +++ b/clients/client-timestream-influxdb/src/commands/GetDbInstanceCommand.ts @@ -0,0 +1,125 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { commonParams } from "../endpoint/EndpointParameters"; +import { GetDbInstanceInput, GetDbInstanceOutput } from "../models/models_0"; +import { de_GetDbInstanceCommand, se_GetDbInstanceCommand } from "../protocols/Aws_json1_0"; +import { + ServiceInputTypes, + ServiceOutputTypes, + TimestreamInfluxDBClientResolvedConfig, +} from "../TimestreamInfluxDBClient"; + +/** + * @public + */ +export { __MetadataBearer, $Command }; +/** + * @public + * + * The input for {@link GetDbInstanceCommand}. + */ +export interface GetDbInstanceCommandInput extends GetDbInstanceInput {} +/** + * @public + * + * The output of {@link GetDbInstanceCommand}. + */ +export interface GetDbInstanceCommandOutput extends GetDbInstanceOutput, __MetadataBearer {} + +/** + * @public + *Returns a Timestream for InfluxDB DB instance.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { TimestreamInfluxDBClient, GetDbInstanceCommand } from "@aws-sdk/client-timestream-influxdb"; // ES Modules import + * // const { TimestreamInfluxDBClient, GetDbInstanceCommand } = require("@aws-sdk/client-timestream-influxdb"); // CommonJS import + * const client = new TimestreamInfluxDBClient(config); + * const input = { // GetDbInstanceInput + * identifier: "STRING_VALUE", // required + * }; + * const command = new GetDbInstanceCommand(input); + * const response = await client.send(command); + * // { // GetDbInstanceOutput + * // id: "STRING_VALUE", // required + * // name: "STRING_VALUE", // required + * // arn: "STRING_VALUE", // required + * // status: "CREATING" || "AVAILABLE" || "DELETING" || "MODIFYING" || "UPDATING" || "DELETED" || "FAILED", + * // endpoint: "STRING_VALUE", + * // dbInstanceType: "db.influx.medium" || "db.influx.large" || "db.influx.xlarge" || "db.influx.2xlarge" || "db.influx.4xlarge" || "db.influx.8xlarge" || "db.influx.12xlarge" || "db.influx.16xlarge", + * // dbStorageType: "InfluxIOIncludedT1" || "InfluxIOIncludedT2" || "InfluxIOIncludedT3", + * // allocatedStorage: Number("int"), + * // deploymentType: "SINGLE_AZ" || "WITH_MULTIAZ_STANDBY", + * // vpcSubnetIds: [ // VpcSubnetIdList // required + * // "STRING_VALUE", + * // ], + * // publiclyAccessible: true || false, + * // vpcSecurityGroupIds: [ // VpcSecurityGroupIdList + * // "STRING_VALUE", + * // ], + * // dbParameterGroupIdentifier: "STRING_VALUE", + * // availabilityZone: "STRING_VALUE", + * // secondaryAvailabilityZone: "STRING_VALUE", + * // logDeliveryConfiguration: { // LogDeliveryConfiguration + * // s3Configuration: { // S3Configuration + * // bucketName: "STRING_VALUE", // required + * // enabled: true || false, // required + * // }, + * // }, + * // influxAuthParametersSecretArn: "STRING_VALUE", + * // }; + * + * ``` + * + * @param GetDbInstanceCommandInput - {@link GetDbInstanceCommandInput} + * @returns {@link GetDbInstanceCommandOutput} + * @see {@link GetDbInstanceCommandInput} for command's `input` shape. + * @see {@link GetDbInstanceCommandOutput} for command's `response` shape. + * @see {@link TimestreamInfluxDBClientResolvedConfig | config} for TimestreamInfluxDBClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *You do not have sufficient access to perform this action.
+ * + * @throws {@link InternalServerException} (server fault) + *The request processing has failed because of an unknown error, exception or failure.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The requested resource was not found or does not exist.
+ * + * @throws {@link ThrottlingException} (client fault) + *The request was denied due to request throttling.
+ * + * @throws {@link ValidationException} (client fault) + *The input fails to satisfy the constraints specified by Timestream for InfluxDB.
+ * + * @throws {@link TimestreamInfluxDBServiceException} + *Base exception class for all service exceptions from TimestreamInfluxDB service.
+ * + */ +export class GetDbInstanceCommand extends $Command + .classBuilder< + GetDbInstanceCommandInput, + GetDbInstanceCommandOutput, + TimestreamInfluxDBClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep({ + ...commonParams, + }) + .m(function (this: any, Command: any, cs: any, config: TimestreamInfluxDBClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("AmazonTimestreamInfluxDB", "GetDbInstance", {}) + .n("TimestreamInfluxDBClient", "GetDbInstanceCommand") + .f(void 0, void 0) + .ser(se_GetDbInstanceCommand) + .de(de_GetDbInstanceCommand) + .build() {} diff --git a/clients/client-timestream-influxdb/src/commands/GetDbParameterGroupCommand.ts b/clients/client-timestream-influxdb/src/commands/GetDbParameterGroupCommand.ts new file mode 100644 index 000000000000..52bf3031eea1 --- /dev/null +++ b/clients/client-timestream-influxdb/src/commands/GetDbParameterGroupCommand.ts @@ -0,0 +1,114 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { commonParams } from "../endpoint/EndpointParameters"; +import { GetDbParameterGroupInput, GetDbParameterGroupOutput } from "../models/models_0"; +import { de_GetDbParameterGroupCommand, se_GetDbParameterGroupCommand } from "../protocols/Aws_json1_0"; +import { + ServiceInputTypes, + ServiceOutputTypes, + TimestreamInfluxDBClientResolvedConfig, +} from "../TimestreamInfluxDBClient"; + +/** + * @public + */ +export { __MetadataBearer, $Command }; +/** + * @public + * + * The input for {@link GetDbParameterGroupCommand}. + */ +export interface GetDbParameterGroupCommandInput extends GetDbParameterGroupInput {} +/** + * @public + * + * The output of {@link GetDbParameterGroupCommand}. + */ +export interface GetDbParameterGroupCommandOutput extends GetDbParameterGroupOutput, __MetadataBearer {} + +/** + * @public + *Returns a Timestream for InfluxDB DB parameter group.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { TimestreamInfluxDBClient, GetDbParameterGroupCommand } from "@aws-sdk/client-timestream-influxdb"; // ES Modules import + * // const { TimestreamInfluxDBClient, GetDbParameterGroupCommand } = require("@aws-sdk/client-timestream-influxdb"); // CommonJS import + * const client = new TimestreamInfluxDBClient(config); + * const input = { // GetDbParameterGroupInput + * identifier: "STRING_VALUE", // required + * }; + * const command = new GetDbParameterGroupCommand(input); + * const response = await client.send(command); + * // { // GetDbParameterGroupOutput + * // id: "STRING_VALUE", // required + * // name: "STRING_VALUE", // required + * // arn: "STRING_VALUE", // required + * // description: "STRING_VALUE", + * // parameters: { // Parameters Union: only one key present + * // InfluxDBv2: { // InfluxDBv2Parameters + * // fluxLogEnabled: true || false, + * // logLevel: "debug" || "info" || "error", + * // noTasks: true || false, + * // queryConcurrency: Number("int"), + * // queryQueueSize: Number("int"), + * // tracingType: "log" || "jaeger", + * // metricsDisabled: true || false, + * // }, + * // }, + * // }; + * + * ``` + * + * @param GetDbParameterGroupCommandInput - {@link GetDbParameterGroupCommandInput} + * @returns {@link GetDbParameterGroupCommandOutput} + * @see {@link GetDbParameterGroupCommandInput} for command's `input` shape. + * @see {@link GetDbParameterGroupCommandOutput} for command's `response` shape. + * @see {@link TimestreamInfluxDBClientResolvedConfig | config} for TimestreamInfluxDBClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *You do not have sufficient access to perform this action.
+ * + * @throws {@link InternalServerException} (server fault) + *The request processing has failed because of an unknown error, exception or failure.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The requested resource was not found or does not exist.
+ * + * @throws {@link ThrottlingException} (client fault) + *The request was denied due to request throttling.
+ * + * @throws {@link ValidationException} (client fault) + *The input fails to satisfy the constraints specified by Timestream for InfluxDB.
+ * + * @throws {@link TimestreamInfluxDBServiceException} + *Base exception class for all service exceptions from TimestreamInfluxDB service.
+ * + */ +export class GetDbParameterGroupCommand extends $Command + .classBuilder< + GetDbParameterGroupCommandInput, + GetDbParameterGroupCommandOutput, + TimestreamInfluxDBClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep({ + ...commonParams, + }) + .m(function (this: any, Command: any, cs: any, config: TimestreamInfluxDBClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("AmazonTimestreamInfluxDB", "GetDbParameterGroup", {}) + .n("TimestreamInfluxDBClient", "GetDbParameterGroupCommand") + .f(void 0, void 0) + .ser(se_GetDbParameterGroupCommand) + .de(de_GetDbParameterGroupCommand) + .build() {} diff --git a/clients/client-timestream-influxdb/src/commands/ListDbInstancesCommand.ts b/clients/client-timestream-influxdb/src/commands/ListDbInstancesCommand.ts new file mode 100644 index 000000000000..ec388da1080f --- /dev/null +++ b/clients/client-timestream-influxdb/src/commands/ListDbInstancesCommand.ts @@ -0,0 +1,114 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { commonParams } from "../endpoint/EndpointParameters"; +import { ListDbInstancesInput, ListDbInstancesOutput } from "../models/models_0"; +import { de_ListDbInstancesCommand, se_ListDbInstancesCommand } from "../protocols/Aws_json1_0"; +import { + ServiceInputTypes, + ServiceOutputTypes, + TimestreamInfluxDBClientResolvedConfig, +} from "../TimestreamInfluxDBClient"; + +/** + * @public + */ +export { __MetadataBearer, $Command }; +/** + * @public + * + * The input for {@link ListDbInstancesCommand}. + */ +export interface ListDbInstancesCommandInput extends ListDbInstancesInput {} +/** + * @public + * + * The output of {@link ListDbInstancesCommand}. + */ +export interface ListDbInstancesCommandOutput extends ListDbInstancesOutput, __MetadataBearer {} + +/** + * @public + *Returns a list of Timestream for InfluxDB DB instances.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { TimestreamInfluxDBClient, ListDbInstancesCommand } from "@aws-sdk/client-timestream-influxdb"; // ES Modules import + * // const { TimestreamInfluxDBClient, ListDbInstancesCommand } = require("@aws-sdk/client-timestream-influxdb"); // CommonJS import + * const client = new TimestreamInfluxDBClient(config); + * const input = { // ListDbInstancesInput + * nextToken: "STRING_VALUE", + * maxResults: Number("int"), + * }; + * const command = new ListDbInstancesCommand(input); + * const response = await client.send(command); + * // { // ListDbInstancesOutput + * // items: [ // DbInstanceSummaryList // required + * // { // DbInstanceSummary + * // id: "STRING_VALUE", // required + * // name: "STRING_VALUE", // required + * // arn: "STRING_VALUE", // required + * // status: "CREATING" || "AVAILABLE" || "DELETING" || "MODIFYING" || "UPDATING" || "DELETED" || "FAILED", + * // endpoint: "STRING_VALUE", + * // dbInstanceType: "db.influx.medium" || "db.influx.large" || "db.influx.xlarge" || "db.influx.2xlarge" || "db.influx.4xlarge" || "db.influx.8xlarge" || "db.influx.12xlarge" || "db.influx.16xlarge", + * // dbStorageType: "InfluxIOIncludedT1" || "InfluxIOIncludedT2" || "InfluxIOIncludedT3", + * // allocatedStorage: Number("int"), + * // deploymentType: "SINGLE_AZ" || "WITH_MULTIAZ_STANDBY", + * // }, + * // ], + * // nextToken: "STRING_VALUE", + * // }; + * + * ``` + * + * @param ListDbInstancesCommandInput - {@link ListDbInstancesCommandInput} + * @returns {@link ListDbInstancesCommandOutput} + * @see {@link ListDbInstancesCommandInput} for command's `input` shape. + * @see {@link ListDbInstancesCommandOutput} for command's `response` shape. + * @see {@link TimestreamInfluxDBClientResolvedConfig | config} for TimestreamInfluxDBClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *You do not have sufficient access to perform this action.
+ * + * @throws {@link InternalServerException} (server fault) + *The request processing has failed because of an unknown error, exception or failure.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The requested resource was not found or does not exist.
+ * + * @throws {@link ThrottlingException} (client fault) + *The request was denied due to request throttling.
+ * + * @throws {@link ValidationException} (client fault) + *The input fails to satisfy the constraints specified by Timestream for InfluxDB.
+ * + * @throws {@link TimestreamInfluxDBServiceException} + *Base exception class for all service exceptions from TimestreamInfluxDB service.
+ * + */ +export class ListDbInstancesCommand extends $Command + .classBuilder< + ListDbInstancesCommandInput, + ListDbInstancesCommandOutput, + TimestreamInfluxDBClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep({ + ...commonParams, + }) + .m(function (this: any, Command: any, cs: any, config: TimestreamInfluxDBClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("AmazonTimestreamInfluxDB", "ListDbInstances", {}) + .n("TimestreamInfluxDBClient", "ListDbInstancesCommand") + .f(void 0, void 0) + .ser(se_ListDbInstancesCommand) + .de(de_ListDbInstancesCommand) + .build() {} diff --git a/clients/client-timestream-influxdb/src/commands/ListDbParameterGroupsCommand.ts b/clients/client-timestream-influxdb/src/commands/ListDbParameterGroupsCommand.ts new file mode 100644 index 000000000000..919cc002ce8b --- /dev/null +++ b/clients/client-timestream-influxdb/src/commands/ListDbParameterGroupsCommand.ts @@ -0,0 +1,109 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { commonParams } from "../endpoint/EndpointParameters"; +import { ListDbParameterGroupsInput, ListDbParameterGroupsOutput } from "../models/models_0"; +import { de_ListDbParameterGroupsCommand, se_ListDbParameterGroupsCommand } from "../protocols/Aws_json1_0"; +import { + ServiceInputTypes, + ServiceOutputTypes, + TimestreamInfluxDBClientResolvedConfig, +} from "../TimestreamInfluxDBClient"; + +/** + * @public + */ +export { __MetadataBearer, $Command }; +/** + * @public + * + * The input for {@link ListDbParameterGroupsCommand}. + */ +export interface ListDbParameterGroupsCommandInput extends ListDbParameterGroupsInput {} +/** + * @public + * + * The output of {@link ListDbParameterGroupsCommand}. + */ +export interface ListDbParameterGroupsCommandOutput extends ListDbParameterGroupsOutput, __MetadataBearer {} + +/** + * @public + *Returns a list of Timestream for InfluxDB DB parameter groups.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { TimestreamInfluxDBClient, ListDbParameterGroupsCommand } from "@aws-sdk/client-timestream-influxdb"; // ES Modules import + * // const { TimestreamInfluxDBClient, ListDbParameterGroupsCommand } = require("@aws-sdk/client-timestream-influxdb"); // CommonJS import + * const client = new TimestreamInfluxDBClient(config); + * const input = { // ListDbParameterGroupsInput + * nextToken: "STRING_VALUE", + * maxResults: Number("int"), + * }; + * const command = new ListDbParameterGroupsCommand(input); + * const response = await client.send(command); + * // { // ListDbParameterGroupsOutput + * // items: [ // DbParameterGroupSummaryList // required + * // { // DbParameterGroupSummary + * // id: "STRING_VALUE", // required + * // name: "STRING_VALUE", // required + * // arn: "STRING_VALUE", // required + * // description: "STRING_VALUE", + * // }, + * // ], + * // nextToken: "STRING_VALUE", + * // }; + * + * ``` + * + * @param ListDbParameterGroupsCommandInput - {@link ListDbParameterGroupsCommandInput} + * @returns {@link ListDbParameterGroupsCommandOutput} + * @see {@link ListDbParameterGroupsCommandInput} for command's `input` shape. + * @see {@link ListDbParameterGroupsCommandOutput} for command's `response` shape. + * @see {@link TimestreamInfluxDBClientResolvedConfig | config} for TimestreamInfluxDBClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *You do not have sufficient access to perform this action.
+ * + * @throws {@link InternalServerException} (server fault) + *The request processing has failed because of an unknown error, exception or failure.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The requested resource was not found or does not exist.
+ * + * @throws {@link ThrottlingException} (client fault) + *The request was denied due to request throttling.
+ * + * @throws {@link ValidationException} (client fault) + *The input fails to satisfy the constraints specified by Timestream for InfluxDB.
+ * + * @throws {@link TimestreamInfluxDBServiceException} + *Base exception class for all service exceptions from TimestreamInfluxDB service.
+ * + */ +export class ListDbParameterGroupsCommand extends $Command + .classBuilder< + ListDbParameterGroupsCommandInput, + ListDbParameterGroupsCommandOutput, + TimestreamInfluxDBClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep({ + ...commonParams, + }) + .m(function (this: any, Command: any, cs: any, config: TimestreamInfluxDBClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("AmazonTimestreamInfluxDB", "ListDbParameterGroups", {}) + .n("TimestreamInfluxDBClient", "ListDbParameterGroupsCommand") + .f(void 0, void 0) + .ser(se_ListDbParameterGroupsCommand) + .de(de_ListDbParameterGroupsCommand) + .build() {} diff --git a/clients/client-timestream-influxdb/src/commands/ListTagsForResourceCommand.ts b/clients/client-timestream-influxdb/src/commands/ListTagsForResourceCommand.ts new file mode 100644 index 000000000000..a6b095a01a3c --- /dev/null +++ b/clients/client-timestream-influxdb/src/commands/ListTagsForResourceCommand.ts @@ -0,0 +1,90 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { commonParams } from "../endpoint/EndpointParameters"; +import { ListTagsForResourceRequest, ListTagsForResourceResponse } from "../models/models_0"; +import { de_ListTagsForResourceCommand, se_ListTagsForResourceCommand } from "../protocols/Aws_json1_0"; +import { + ServiceInputTypes, + ServiceOutputTypes, + TimestreamInfluxDBClientResolvedConfig, +} from "../TimestreamInfluxDBClient"; + +/** + * @public + */ +export { __MetadataBearer, $Command }; +/** + * @public + * + * The input for {@link ListTagsForResourceCommand}. + */ +export interface ListTagsForResourceCommandInput extends ListTagsForResourceRequest {} +/** + * @public + * + * The output of {@link ListTagsForResourceCommand}. + */ +export interface ListTagsForResourceCommandOutput extends ListTagsForResourceResponse, __MetadataBearer {} + +/** + * @public + *A list of tags applied to the resource.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { TimestreamInfluxDBClient, ListTagsForResourceCommand } from "@aws-sdk/client-timestream-influxdb"; // ES Modules import + * // const { TimestreamInfluxDBClient, ListTagsForResourceCommand } = require("@aws-sdk/client-timestream-influxdb"); // CommonJS import + * const client = new TimestreamInfluxDBClient(config); + * const input = { // ListTagsForResourceRequest + * resourceArn: "STRING_VALUE", // required + * }; + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * // { // ListTagsForResourceResponse + * // tags: { // ResponseTagMap + * // "The requested resource was not found or does not exist.
+ * + * @throws {@link TimestreamInfluxDBServiceException} + *Base exception class for all service exceptions from TimestreamInfluxDB service.
+ * + */ +export class ListTagsForResourceCommand extends $Command + .classBuilder< + ListTagsForResourceCommandInput, + ListTagsForResourceCommandOutput, + TimestreamInfluxDBClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep({ + ...commonParams, + }) + .m(function (this: any, Command: any, cs: any, config: TimestreamInfluxDBClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("AmazonTimestreamInfluxDB", "ListTagsForResource", {}) + .n("TimestreamInfluxDBClient", "ListTagsForResourceCommand") + .f(void 0, void 0) + .ser(se_ListTagsForResourceCommand) + .de(de_ListTagsForResourceCommand) + .build() {} diff --git a/clients/client-timestream-influxdb/src/commands/TagResourceCommand.ts b/clients/client-timestream-influxdb/src/commands/TagResourceCommand.ts new file mode 100644 index 000000000000..a305180e4f37 --- /dev/null +++ b/clients/client-timestream-influxdb/src/commands/TagResourceCommand.ts @@ -0,0 +1,89 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { commonParams } from "../endpoint/EndpointParameters"; +import { TagResourceRequest } from "../models/models_0"; +import { de_TagResourceCommand, se_TagResourceCommand } from "../protocols/Aws_json1_0"; +import { + ServiceInputTypes, + ServiceOutputTypes, + TimestreamInfluxDBClientResolvedConfig, +} from "../TimestreamInfluxDBClient"; + +/** + * @public + */ +export { __MetadataBearer, $Command }; +/** + * @public + * + * The input for {@link TagResourceCommand}. + */ +export interface TagResourceCommandInput extends TagResourceRequest {} +/** + * @public + * + * The output of {@link TagResourceCommand}. + */ +export interface TagResourceCommandOutput extends __MetadataBearer {} + +/** + * @public + *Tags are composed of a Key/Value pairs. You can use tags to categorize and track your Timestream for InfluxDB resources.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { TimestreamInfluxDBClient, TagResourceCommand } from "@aws-sdk/client-timestream-influxdb"; // ES Modules import + * // const { TimestreamInfluxDBClient, TagResourceCommand } = require("@aws-sdk/client-timestream-influxdb"); // CommonJS import + * const client = new TimestreamInfluxDBClient(config); + * const input = { // TagResourceRequest + * resourceArn: "STRING_VALUE", // required + * tags: { // RequestTagMap // required + * "The requested resource was not found or does not exist.
+ * + * @throws {@link TimestreamInfluxDBServiceException} + *Base exception class for all service exceptions from TimestreamInfluxDB service.
+ * + */ +export class TagResourceCommand extends $Command + .classBuilder< + TagResourceCommandInput, + TagResourceCommandOutput, + TimestreamInfluxDBClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep({ + ...commonParams, + }) + .m(function (this: any, Command: any, cs: any, config: TimestreamInfluxDBClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("AmazonTimestreamInfluxDB", "TagResource", {}) + .n("TimestreamInfluxDBClient", "TagResourceCommand") + .f(void 0, void 0) + .ser(se_TagResourceCommand) + .de(de_TagResourceCommand) + .build() {} diff --git a/clients/client-timestream-influxdb/src/commands/UntagResourceCommand.ts b/clients/client-timestream-influxdb/src/commands/UntagResourceCommand.ts new file mode 100644 index 000000000000..02f2b4f134f9 --- /dev/null +++ b/clients/client-timestream-influxdb/src/commands/UntagResourceCommand.ts @@ -0,0 +1,89 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { commonParams } from "../endpoint/EndpointParameters"; +import { UntagResourceRequest } from "../models/models_0"; +import { de_UntagResourceCommand, se_UntagResourceCommand } from "../protocols/Aws_json1_0"; +import { + ServiceInputTypes, + ServiceOutputTypes, + TimestreamInfluxDBClientResolvedConfig, +} from "../TimestreamInfluxDBClient"; + +/** + * @public + */ +export { __MetadataBearer, $Command }; +/** + * @public + * + * The input for {@link UntagResourceCommand}. + */ +export interface UntagResourceCommandInput extends UntagResourceRequest {} +/** + * @public + * + * The output of {@link UntagResourceCommand}. + */ +export interface UntagResourceCommandOutput extends __MetadataBearer {} + +/** + * @public + *Removes the tag from the specified resource.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { TimestreamInfluxDBClient, UntagResourceCommand } from "@aws-sdk/client-timestream-influxdb"; // ES Modules import + * // const { TimestreamInfluxDBClient, UntagResourceCommand } = require("@aws-sdk/client-timestream-influxdb"); // CommonJS import + * const client = new TimestreamInfluxDBClient(config); + * const input = { // UntagResourceRequest + * resourceArn: "STRING_VALUE", // required + * tagKeys: [ // TagKeys // required + * "STRING_VALUE", + * ], + * }; + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * // {}; + * + * ``` + * + * @param UntagResourceCommandInput - {@link UntagResourceCommandInput} + * @returns {@link UntagResourceCommandOutput} + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link TimestreamInfluxDBClientResolvedConfig | config} for TimestreamInfluxDBClient's `config` shape. + * + * @throws {@link ResourceNotFoundException} (client fault) + *The requested resource was not found or does not exist.
+ * + * @throws {@link TimestreamInfluxDBServiceException} + *Base exception class for all service exceptions from TimestreamInfluxDB service.
+ * + */ +export class UntagResourceCommand extends $Command + .classBuilder< + UntagResourceCommandInput, + UntagResourceCommandOutput, + TimestreamInfluxDBClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep({ + ...commonParams, + }) + .m(function (this: any, Command: any, cs: any, config: TimestreamInfluxDBClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("AmazonTimestreamInfluxDB", "UntagResource", {}) + .n("TimestreamInfluxDBClient", "UntagResourceCommand") + .f(void 0, void 0) + .ser(se_UntagResourceCommand) + .de(de_UntagResourceCommand) + .build() {} diff --git a/clients/client-timestream-influxdb/src/commands/UpdateDbInstanceCommand.ts b/clients/client-timestream-influxdb/src/commands/UpdateDbInstanceCommand.ts new file mode 100644 index 000000000000..8380dbd6723a --- /dev/null +++ b/clients/client-timestream-influxdb/src/commands/UpdateDbInstanceCommand.ts @@ -0,0 +1,135 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { commonParams } from "../endpoint/EndpointParameters"; +import { UpdateDbInstanceInput, UpdateDbInstanceOutput } from "../models/models_0"; +import { de_UpdateDbInstanceCommand, se_UpdateDbInstanceCommand } from "../protocols/Aws_json1_0"; +import { + ServiceInputTypes, + ServiceOutputTypes, + TimestreamInfluxDBClientResolvedConfig, +} from "../TimestreamInfluxDBClient"; + +/** + * @public + */ +export { __MetadataBearer, $Command }; +/** + * @public + * + * The input for {@link UpdateDbInstanceCommand}. + */ +export interface UpdateDbInstanceCommandInput extends UpdateDbInstanceInput {} +/** + * @public + * + * The output of {@link UpdateDbInstanceCommand}. + */ +export interface UpdateDbInstanceCommandOutput extends UpdateDbInstanceOutput, __MetadataBearer {} + +/** + * @public + *Updates a Timestream for InfluxDB DB instance.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { TimestreamInfluxDBClient, UpdateDbInstanceCommand } from "@aws-sdk/client-timestream-influxdb"; // ES Modules import + * // const { TimestreamInfluxDBClient, UpdateDbInstanceCommand } = require("@aws-sdk/client-timestream-influxdb"); // CommonJS import + * const client = new TimestreamInfluxDBClient(config); + * const input = { // UpdateDbInstanceInput + * identifier: "STRING_VALUE", // required + * logDeliveryConfiguration: { // LogDeliveryConfiguration + * s3Configuration: { // S3Configuration + * bucketName: "STRING_VALUE", // required + * enabled: true || false, // required + * }, + * }, + * dbParameterGroupIdentifier: "STRING_VALUE", + * }; + * const command = new UpdateDbInstanceCommand(input); + * const response = await client.send(command); + * // { // UpdateDbInstanceOutput + * // id: "STRING_VALUE", // required + * // name: "STRING_VALUE", // required + * // arn: "STRING_VALUE", // required + * // status: "CREATING" || "AVAILABLE" || "DELETING" || "MODIFYING" || "UPDATING" || "DELETED" || "FAILED", + * // endpoint: "STRING_VALUE", + * // dbInstanceType: "db.influx.medium" || "db.influx.large" || "db.influx.xlarge" || "db.influx.2xlarge" || "db.influx.4xlarge" || "db.influx.8xlarge" || "db.influx.12xlarge" || "db.influx.16xlarge", + * // dbStorageType: "InfluxIOIncludedT1" || "InfluxIOIncludedT2" || "InfluxIOIncludedT3", + * // allocatedStorage: Number("int"), + * // deploymentType: "SINGLE_AZ" || "WITH_MULTIAZ_STANDBY", + * // vpcSubnetIds: [ // VpcSubnetIdList // required + * // "STRING_VALUE", + * // ], + * // publiclyAccessible: true || false, + * // vpcSecurityGroupIds: [ // VpcSecurityGroupIdList + * // "STRING_VALUE", + * // ], + * // dbParameterGroupIdentifier: "STRING_VALUE", + * // availabilityZone: "STRING_VALUE", + * // secondaryAvailabilityZone: "STRING_VALUE", + * // logDeliveryConfiguration: { // LogDeliveryConfiguration + * // s3Configuration: { // S3Configuration + * // bucketName: "STRING_VALUE", // required + * // enabled: true || false, // required + * // }, + * // }, + * // influxAuthParametersSecretArn: "STRING_VALUE", + * // }; + * + * ``` + * + * @param UpdateDbInstanceCommandInput - {@link UpdateDbInstanceCommandInput} + * @returns {@link UpdateDbInstanceCommandOutput} + * @see {@link UpdateDbInstanceCommandInput} for command's `input` shape. + * @see {@link UpdateDbInstanceCommandOutput} for command's `response` shape. + * @see {@link TimestreamInfluxDBClientResolvedConfig | config} for TimestreamInfluxDBClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *You do not have sufficient access to perform this action.
+ * + * @throws {@link ConflictException} (client fault) + *The request conflicts with an existing resource in Timestream for InfluxDB.
+ * + * @throws {@link InternalServerException} (server fault) + *The request processing has failed because of an unknown error, exception or failure.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The requested resource was not found or does not exist.
+ * + * @throws {@link ThrottlingException} (client fault) + *The request was denied due to request throttling.
+ * + * @throws {@link ValidationException} (client fault) + *The input fails to satisfy the constraints specified by Timestream for InfluxDB.
+ * + * @throws {@link TimestreamInfluxDBServiceException} + *Base exception class for all service exceptions from TimestreamInfluxDB service.
+ * + */ +export class UpdateDbInstanceCommand extends $Command + .classBuilder< + UpdateDbInstanceCommandInput, + UpdateDbInstanceCommandOutput, + TimestreamInfluxDBClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep({ + ...commonParams, + }) + .m(function (this: any, Command: any, cs: any, config: TimestreamInfluxDBClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("AmazonTimestreamInfluxDB", "UpdateDbInstance", {}) + .n("TimestreamInfluxDBClient", "UpdateDbInstanceCommand") + .f(void 0, void 0) + .ser(se_UpdateDbInstanceCommand) + .de(de_UpdateDbInstanceCommand) + .build() {} diff --git a/clients/client-timestream-influxdb/src/commands/index.ts b/clients/client-timestream-influxdb/src/commands/index.ts new file mode 100644 index 000000000000..4a5adf00fd19 --- /dev/null +++ b/clients/client-timestream-influxdb/src/commands/index.ts @@ -0,0 +1,12 @@ +// smithy-typescript generated code +export * from "./CreateDbInstanceCommand"; +export * from "./CreateDbParameterGroupCommand"; +export * from "./DeleteDbInstanceCommand"; +export * from "./GetDbInstanceCommand"; +export * from "./GetDbParameterGroupCommand"; +export * from "./ListDbInstancesCommand"; +export * from "./ListDbParameterGroupsCommand"; +export * from "./ListTagsForResourceCommand"; +export * from "./TagResourceCommand"; +export * from "./UntagResourceCommand"; +export * from "./UpdateDbInstanceCommand"; diff --git a/clients/client-timestream-influxdb/src/endpoint/EndpointParameters.ts b/clients/client-timestream-influxdb/src/endpoint/EndpointParameters.ts new file mode 100644 index 000000000000..1095eca6e048 --- /dev/null +++ b/clients/client-timestream-influxdb/src/endpoint/EndpointParameters.ts @@ -0,0 +1,41 @@ +// smithy-typescript generated code +import { Endpoint, EndpointParameters as __EndpointParameters, EndpointV2, Provider } from "@smithy/types"; + +/** + * @public + */ +export interface ClientInputEndpointParameters { + region?: string | ProviderAmazon Timestream for InfluxDB is a managed time-series database engine that makes it easy for application developers and DevOps teams to run InfluxDB databases on AWS for near real-time time-series applications using open-source APIs. With Amazon Timestream for InfluxDB, it is easy to set up, operate, and scale time-series workloads that can answer queries with single-digit millisecond query response time.
+ * + * @packageDocumentation + */ +export * from "./TimestreamInfluxDBClient"; +export * from "./TimestreamInfluxDB"; +export { ClientInputEndpointParameters } from "./endpoint/EndpointParameters"; +export { RuntimeExtension } from "./runtimeExtensions"; +export { TimestreamInfluxDBExtensionConfiguration } from "./extensionConfiguration"; +export * from "./commands"; +export * from "./pagination"; +export * from "./models"; + +import "@aws-sdk/util-endpoints"; + +export { TimestreamInfluxDBServiceException } from "./models/TimestreamInfluxDBServiceException"; diff --git a/clients/client-timestream-influxdb/src/models/TimestreamInfluxDBServiceException.ts b/clients/client-timestream-influxdb/src/models/TimestreamInfluxDBServiceException.ts new file mode 100644 index 000000000000..f4c87db09d16 --- /dev/null +++ b/clients/client-timestream-influxdb/src/models/TimestreamInfluxDBServiceException.ts @@ -0,0 +1,22 @@ +// smithy-typescript generated code +import { + ServiceException as __ServiceException, + ServiceExceptionOptions as __ServiceExceptionOptions, +} from "@smithy/smithy-client"; + +export { __ServiceException, __ServiceExceptionOptions }; + +/** + * @public + * + * Base exception class for all service exceptions from TimestreamInfluxDB service. + */ +export class TimestreamInfluxDBServiceException extends __ServiceException { + /** + * @internal + */ + constructor(options: __ServiceExceptionOptions) { + super(options); + Object.setPrototypeOf(this, TimestreamInfluxDBServiceException.prototype); + } +} diff --git a/clients/client-timestream-influxdb/src/models/index.ts b/clients/client-timestream-influxdb/src/models/index.ts new file mode 100644 index 000000000000..9eaceb12865f --- /dev/null +++ b/clients/client-timestream-influxdb/src/models/index.ts @@ -0,0 +1,2 @@ +// smithy-typescript generated code +export * from "./models_0"; diff --git a/clients/client-timestream-influxdb/src/models/models_0.ts b/clients/client-timestream-influxdb/src/models/models_0.ts new file mode 100644 index 000000000000..5d509fce936f --- /dev/null +++ b/clients/client-timestream-influxdb/src/models/models_0.ts @@ -0,0 +1,1336 @@ +// smithy-typescript generated code +import { ExceptionOptionType as __ExceptionOptionType, SENSITIVE_STRING } from "@smithy/smithy-client"; + +import { TimestreamInfluxDBServiceException as __BaseException } from "./TimestreamInfluxDBServiceException"; + +/** + * @public + *You do not have sufficient access to perform this action.
+ */ +export class AccessDeniedException extends __BaseException { + readonly name: "AccessDeniedException" = "AccessDeniedException"; + readonly $fault: "client" = "client"; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeThe request conflicts with an existing resource in Timestream for InfluxDB.
+ */ +export class ConflictException extends __BaseException { + readonly name: "ConflictException" = "ConflictException"; + readonly $fault: "client" = "client"; + /** + * @public + *The identifier for the Timestream for InfluxDB resource associated with the request.
+ */ + resourceId: string | undefined; + + /** + * @public + *The type of Timestream for InfluxDB resource associated with the request.
+ */ + resourceType: string | undefined; + + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeConfiguration for S3 bucket log delivery.
+ */ +export interface S3Configuration { + /** + * @public + *The name of the S3 bucket to deliver logs to.
+ */ + bucketName: string | undefined; + + /** + * @public + *Indicates whether log delivery to the S3 bucket is enabled.
+ */ + enabled: boolean | undefined; +} + +/** + * @public + *Configuration for sending InfluxDB engine logs to send to specified S3 bucket.
+ */ +export interface LogDeliveryConfiguration { + /** + * @public + *Configuration for S3 bucket log delivery.
+ */ + s3Configuration: S3Configuration | undefined; +} + +/** + * @public + */ +export interface CreateDbInstanceInput { + /** + * @public + *The name that uniquely identifies the DB instance when interacting with the Amazon Timestream for InfluxDB API and CLI commands. This name will also be a prefix included in the endpoint. DB instance names must be unique per customer and per region.
+ */ + name: string | undefined; + + /** + * @public + *The username of the initial admin user created in InfluxDB. Must start with a letter and can't end with a hyphen or contain two consecutive hyphens. For example, my-user1. This username will allow you to access the InfluxDB UI to perform various administrative tasks and also use the InfluxDB CLI to create an operator token. These attributes will be stored in a Secret created in Amazon Secrets Manager in your account.
+ */ + username?: string; + + /** + * @public + *The password of the initial admin user created in InfluxDB. This password will allow you to access the InfluxDB UI to perform various administrative tasks and also use the InfluxDB CLI to create an operator token. These attributes will be stored in a Secret created in AWS SecretManager in your account.
+ */ + password: string | undefined; + + /** + * @public + *The name of the initial organization for the initial admin user in InfluxDB. An InfluxDB organization is a workspace for a group of users.
+ */ + organization?: string; + + /** + * @public + *The name of the initial InfluxDB bucket. All InfluxDB data is stored in a bucket. A bucket combines the concept of a database and a retention period (the duration of time that each data point persists). A bucket belongs to an organization.
+ */ + bucket?: string; + + /** + * @public + *The Timestream for InfluxDB DB instance type to run InfluxDB on.
+ */ + dbInstanceType: DbInstanceType | undefined; + + /** + * @public + *A list of VPC subnet IDs to associate with the DB instance. Provide at least two VPC subnet IDs in different availability zones when deploying with a Multi-AZ standby.
+ */ + vpcSubnetIds: string[] | undefined; + + /** + * @public + *A list of VPC security group IDs to associate with the DB instance.
+ */ + vpcSecurityGroupIds: string[] | undefined; + + /** + * @public + *Configures the DB instance with a public IP to facilitate access.
+ */ + publiclyAccessible?: boolean; + + /** + * @public + *The Timestream for InfluxDB DB storage type to read and write InfluxDB data.
+ *You can choose between 3 different types of provisioned Influx IOPS included storage according to your workloads requirements:
+ *Influx IO Included 3000 IOPS
+ *Influx IO Included 12000 IOPS
+ *Influx IO Included 16000 IOPS
+ *The amount of storage to allocate for your DB storage type in GiB (gibibytes).
+ */ + allocatedStorage: number | undefined; + + /** + * @public + *The id of the DB parameter group to assign to your DB instance. DB parameter groups specify how the database is configured. For example, DB parameter groups can specify the limit for query concurrency.
+ */ + dbParameterGroupIdentifier?: string; + + /** + * @public + *Specifies whether the DB instance will be deployed as a standalone instance or with a Multi-AZ standby for high availability.
+ */ + deploymentType?: DeploymentType; + + /** + * @public + *Configuration for sending InfluxDB engine logs to a specified S3 bucket.
+ */ + logDeliveryConfiguration?: LogDeliveryConfiguration; + + /** + * @public + *A list of key-value pairs to associate with the DB instance.
+ */ + tags?: RecordA service-generated unique identifier.
+ */ + id: string | undefined; + + /** + * @public + *The customer-supplied name that uniquely identifies the DB instance when interacting with the Amazon Timestream for InfluxDB API and CLI commands.
+ */ + name: string | undefined; + + /** + * @public + *The Amazon Resource Name (ARN) of the DB instance.
+ */ + arn: string | undefined; + + /** + * @public + *The status of the DB instance.
+ */ + status?: Status; + + /** + * @public + *The endpoint used to connect to InfluxDB. The default InfluxDB port is 8086.
+ */ + endpoint?: string; + + /** + * @public + *The Timestream for InfluxDB instance type that InfluxDB runs on.
+ */ + dbInstanceType?: DbInstanceType; + + /** + * @public + *The Timestream for InfluxDB DB storage type that InfluxDB stores data on.
+ */ + dbStorageType?: DbStorageType; + + /** + * @public + *The amount of storage allocated for your DB storage type (in gibibytes).
+ */ + allocatedStorage?: number; + + /** + * @public + *Specifies whether the Timestream for InfluxDB is deployed as Single-AZ or with a MultiAZ Standby for High availability.
+ */ + deploymentType?: DeploymentType; + + /** + * @public + *A list of VPC subnet IDs associated with the DB instance.
+ */ + vpcSubnetIds: string[] | undefined; + + /** + * @public + *Indicates if the DB instance has a public IP to facilitate access.
+ */ + publiclyAccessible?: boolean; + + /** + * @public + *A list of VPC security group IDs associated with the DB instance.
+ */ + vpcSecurityGroupIds?: string[]; + + /** + * @public + *The id of the DB parameter group assigned to your DB instance.
+ */ + dbParameterGroupIdentifier?: string; + + /** + * @public + *The Availability Zone in which the DB instance resides.
+ */ + availabilityZone?: string; + + /** + * @public + *The Availability Zone in which the standby instance is located when deploying with a MultiAZ standby instance.
+ */ + secondaryAvailabilityZone?: string; + + /** + * @public + *Configuration for sending InfluxDB engine logs to send to specified S3 bucket.
+ */ + logDeliveryConfiguration?: LogDeliveryConfiguration; + + /** + * @public + *The Amazon Resource Name (ARN) of the AWS Secrets Manager secret containing the initial InfluxDB authorization parameters. The secret value is a JSON formatted key-value pair holding InfluxDB authorization values: organization, bucket, username, and password.
+ */ + influxAuthParametersSecretArn?: string; +} + +/** + * @public + *The request processing has failed because of an unknown error, exception or failure.
+ */ +export class InternalServerException extends __BaseException { + readonly name: "InternalServerException" = "InternalServerException"; + readonly $fault: "server" = "server"; + $retryable = {}; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeThe requested resource was not found or does not exist.
+ */ +export class ResourceNotFoundException extends __BaseException { + readonly name: "ResourceNotFoundException" = "ResourceNotFoundException"; + readonly $fault: "client" = "client"; + /** + * @public + *The identifier for the Timestream for InfluxDB resource associated with the request.
+ */ + resourceId: string | undefined; + + /** + * @public + *The type of Timestream for InfluxDB resource associated with the request.
+ */ + resourceType: string | undefined; + + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeThe request exceeds the service quota.
+ */ +export class ServiceQuotaExceededException extends __BaseException { + readonly name: "ServiceQuotaExceededException" = "ServiceQuotaExceededException"; + readonly $fault: "client" = "client"; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeThe request was denied due to request throttling.
+ */ +export class ThrottlingException extends __BaseException { + readonly name: "ThrottlingException" = "ThrottlingException"; + readonly $fault: "client" = "client"; + $retryable = {}; + /** + * @public + *The number of seconds the caller should wait before retrying.
+ */ + retryAfterSeconds?: number; + + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeThe input fails to satisfy the constraints specified by Timestream for InfluxDB.
+ */ +export class ValidationException extends __BaseException { + readonly name: "ValidationException" = "ValidationException"; + readonly $fault: "client" = "client"; + /** + * @public + *The reason that validation failed.
+ */ + reason: ValidationExceptionReason | undefined; + + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeThe id of the DB instance.
+ */ + identifier: string | undefined; +} + +/** + * @public + */ +export interface DeleteDbInstanceOutput { + /** + * @public + *A service-generated unique identifier.
+ */ + id: string | undefined; + + /** + * @public + *The customer-supplied name that uniquely identifies the DB instance when interacting with the Amazon Timestream for InfluxDB API and CLI commands.
+ */ + name: string | undefined; + + /** + * @public + *The Amazon Resource Name (ARN) of the DB instance.
+ */ + arn: string | undefined; + + /** + * @public + *The status of the DB instance.
+ */ + status?: Status; + + /** + * @public + *The endpoint used to connect to InfluxDB. The default InfluxDB port is 8086.
+ */ + endpoint?: string; + + /** + * @public + *The Timestream for InfluxDB instance type that InfluxDB runs on.
+ */ + dbInstanceType?: DbInstanceType; + + /** + * @public + *The Timestream for InfluxDB DB storage type that InfluxDB stores data on.
+ */ + dbStorageType?: DbStorageType; + + /** + * @public + *The amount of storage allocated for your DB storage type (in gibibytes).
+ */ + allocatedStorage?: number; + + /** + * @public + *Specifies whether the Timestream for InfluxDB is deployed as Single-AZ or with a MultiAZ Standby for High availability.
+ */ + deploymentType?: DeploymentType; + + /** + * @public + *A list of VPC subnet IDs associated with the DB instance.
+ */ + vpcSubnetIds: string[] | undefined; + + /** + * @public + *Indicates if the DB instance has a public IP to facilitate access.
+ */ + publiclyAccessible?: boolean; + + /** + * @public + *A list of VPC security group IDs associated with the DB instance.
+ */ + vpcSecurityGroupIds?: string[]; + + /** + * @public + *The id of the DB parameter group assigned to your DB instance.
+ */ + dbParameterGroupIdentifier?: string; + + /** + * @public + *The Availability Zone in which the DB instance resides.
+ */ + availabilityZone?: string; + + /** + * @public + *The Availability Zone in which the standby instance is located when deploying with a MultiAZ standby instance.
+ */ + secondaryAvailabilityZone?: string; + + /** + * @public + *Configuration for sending InfluxDB engine logs to send to specified S3 bucket.
+ */ + logDeliveryConfiguration?: LogDeliveryConfiguration; + + /** + * @public + *The Amazon Resource Name (ARN) of the AWS Secrets Manager secret containing the initial InfluxDB authorization parameters. The secret value is a JSON formatted key-value pair holding InfluxDB authorization values: organization, bucket, username, and password.
+ */ + influxAuthParametersSecretArn?: string; +} + +/** + * @public + */ +export interface GetDbInstanceInput { + /** + * @public + *The id of the DB instance.
+ */ + identifier: string | undefined; +} + +/** + * @public + */ +export interface GetDbInstanceOutput { + /** + * @public + *A service-generated unique identifier.
+ */ + id: string | undefined; + + /** + * @public + *The customer-supplied name that uniquely identifies the DB instance when interacting with the Amazon Timestream for InfluxDB API and CLI commands.
+ */ + name: string | undefined; + + /** + * @public + *The Amazon Resource Name (ARN) of the DB instance.
+ */ + arn: string | undefined; + + /** + * @public + *The status of the DB instance.
+ */ + status?: Status; + + /** + * @public + *The endpoint used to connect to InfluxDB. The default InfluxDB port is 8086.
+ */ + endpoint?: string; + + /** + * @public + *The Timestream for InfluxDB instance type that InfluxDB runs on.
+ */ + dbInstanceType?: DbInstanceType; + + /** + * @public + *The Timestream for InfluxDB DB storage type that InfluxDB stores data on.
+ */ + dbStorageType?: DbStorageType; + + /** + * @public + *The amount of storage allocated for your DB storage type (in gibibytes).
+ */ + allocatedStorage?: number; + + /** + * @public + *Specifies whether the Timestream for InfluxDB is deployed as Single-AZ or with a MultiAZ Standby for High availability.
+ */ + deploymentType?: DeploymentType; + + /** + * @public + *A list of VPC subnet IDs associated with the DB instance.
+ */ + vpcSubnetIds: string[] | undefined; + + /** + * @public + *Indicates if the DB instance has a public IP to facilitate access.
+ */ + publiclyAccessible?: boolean; + + /** + * @public + *A list of VPC security group IDs associated with the DB instance.
+ */ + vpcSecurityGroupIds?: string[]; + + /** + * @public + *The id of the DB parameter group assigned to your DB instance.
+ */ + dbParameterGroupIdentifier?: string; + + /** + * @public + *The Availability Zone in which the DB instance resides.
+ */ + availabilityZone?: string; + + /** + * @public + *The Availability Zone in which the standby instance is located when deploying with a MultiAZ standby instance.
+ */ + secondaryAvailabilityZone?: string; + + /** + * @public + *Configuration for sending InfluxDB engine logs to send to specified S3 bucket.
+ */ + logDeliveryConfiguration?: LogDeliveryConfiguration; + + /** + * @public + *The Amazon Resource Name (ARN) of the AWS Secrets Manager secret containing the initial InfluxDB authorization parameters. The secret value is a JSON formatted key-value pair holding InfluxDB authorization values: organization, bucket, username, and password.
+ */ + influxAuthParametersSecretArn?: string; +} + +/** + * @public + */ +export interface ListDbInstancesInput { + /** + * @public + *The pagination token. To resume pagination, provide the NextToken value as argument of a subsequent API invocation.
+ */ + nextToken?: string; + + /** + * @public + *The maximum number of items to return in the output. If the total number of items available is more than the value specified, a NextToken is provided in the output. To resume pagination, provide the NextToken value as argument of a subsequent API invocation.
+ */ + maxResults?: number; +} + +/** + * @public + *Contains a summary of a DB instance.
+ */ +export interface DbInstanceSummary { + /** + * @public + *The service-generated unique identifier of the DB instance.
+ */ + id: string | undefined; + + /** + * @public + *This customer-supplied name uniquely identifies the DB instance when interacting with the Amazon Timestream for InfluxDB API and AWS CLI commands.
+ */ + name: string | undefined; + + /** + * @public + *The Amazon Resource Name (ARN) of the DB instance.
+ */ + arn: string | undefined; + + /** + * @public + *The status of the DB instance.
+ */ + status?: Status; + + /** + * @public + *The endpoint used to connect to InfluxDB. The default InfluxDB port is 8086.
+ */ + endpoint?: string; + + /** + * @public + *The Timestream for InfluxDB instance type to run InfluxDB on.
+ */ + dbInstanceType?: DbInstanceType; + + /** + * @public + *The storage type for your DB instance.
+ */ + dbStorageType?: DbStorageType; + + /** + * @public + *The amount of storage to allocate for your DbStorageType in GiB (gibibytes).
+ */ + allocatedStorage?: number; + + /** + * @public + *Single-Instance or with a MultiAZ Standby for High availability.
+ */ + deploymentType?: DeploymentType; +} + +/** + * @public + */ +export interface ListDbInstancesOutput { + /** + * @public + *A list of Timestream for InfluxDB DB instance summaries.
+ */ + items: DbInstanceSummary[] | undefined; + + /** + * @public + *Token from a previous call of the operation. When this value is provided, the + * service returns results from where the previous response left off.
+ */ + nextToken?: string; +} + +/** + * @public + */ +export interface UpdateDbInstanceInput { + /** + * @public + *The id of the DB instance.
+ */ + identifier: string | undefined; + + /** + * @public + *Configuration for sending InfluxDB engine logs to send to specified S3 bucket.
+ */ + logDeliveryConfiguration?: LogDeliveryConfiguration; + + /** + * @public + *The id of the DB parameter group to assign to your DB instance. DB parameter groups specify how the database is configured. For example, DB parameter groups can specify the limit for query concurrency.
+ */ + dbParameterGroupIdentifier?: string; +} + +/** + * @public + */ +export interface UpdateDbInstanceOutput { + /** + * @public + *A service-generated unique identifier.
+ */ + id: string | undefined; + + /** + * @public + *This customer-supplied name uniquely identifies the DB instance when interacting with the Amazon Timestream for InfluxDB API and AWS CLI commands.
+ */ + name: string | undefined; + + /** + * @public + *The Amazon Resource Name (ARN) of the DB instance.
+ */ + arn: string | undefined; + + /** + * @public + *The status of the DB instance.
+ */ + status?: Status; + + /** + * @public + *The endpoint used to connect to InfluxDB. The default InfluxDB port is 8086.
+ */ + endpoint?: string; + + /** + * @public + *The Timestream for InfluxDB instance type that InfluxDB runs on.
+ */ + dbInstanceType?: DbInstanceType; + + /** + * @public + *The Timestream for InfluxDB DB storage type that InfluxDB stores data on.
+ */ + dbStorageType?: DbStorageType; + + /** + * @public + *The amount of storage allocated for your DB storage type (in gibibytes).
+ */ + allocatedStorage?: number; + + /** + * @public + *Specifies whether the Timestream for InfluxDB is deployed as Single-AZ or with a MultiAZ Standby for High availability.
+ */ + deploymentType?: DeploymentType; + + /** + * @public + *A list of VPC subnet IDs associated with the DB instance.
+ */ + vpcSubnetIds: string[] | undefined; + + /** + * @public + *Indicates if the DB instance has a public IP to facilitate access.
+ */ + publiclyAccessible?: boolean; + + /** + * @public + *A list of VPC security group IDs associated with the DB instance.
+ */ + vpcSecurityGroupIds?: string[]; + + /** + * @public + *The id of the DB parameter group assigned to your DB instance.
+ */ + dbParameterGroupIdentifier?: string; + + /** + * @public + *The Availability Zone in which the DB instance resides.
+ */ + availabilityZone?: string; + + /** + * @public + *The Availability Zone in which the standby instance is located when deploying with a MultiAZ standby instance.
+ */ + secondaryAvailabilityZone?: string; + + /** + * @public + *Configuration for sending InfluxDB engine logs to send to specified S3 bucket.
+ */ + logDeliveryConfiguration?: LogDeliveryConfiguration; + + /** + * @public + *The Amazon Resource Name (ARN) of the AWS Secrets Manager secret containing the initial InfluxDB authorization parameters. The secret value is a JSON formatted key-value pair holding InfluxDB authorization values: organization, bucket, username, and password.
+ */ + influxAuthParametersSecretArn?: string; +} + +/** + * @public + * @enum + */ +export const LogLevel = { + DEBUG: "debug", + ERROR: "error", + INFO: "info", +} as const; + +/** + * @public + */ +export type LogLevel = (typeof LogLevel)[keyof typeof LogLevel]; + +/** + * @public + * @enum + */ +export const TracingType = { + JAEGER: "jaeger", + LOG: "log", +} as const; + +/** + * @public + */ +export type TracingType = (typeof TracingType)[keyof typeof TracingType]; + +/** + * @public + *All the customer-modifiable InfluxDB v2 parameters in Timestream for InfluxDB.
+ */ +export interface InfluxDBv2Parameters { + /** + * @public + *Include option to show detailed logs for Flux queries.
+ *Default: false
+ */ + fluxLogEnabled?: boolean; + + /** + * @public + *Log output level. InfluxDB outputs log entries with severity levels greater than or equal to the level specified.
+ *Default: info
+ */ + logLevel?: LogLevel; + + /** + * @public + *Disable the task scheduler. If problematic tasks prevent InfluxDB from starting, use this option to start InfluxDB without scheduling or executing tasks.
+ *Default: false
+ */ + noTasks?: boolean; + + /** + * @public + *Number of queries allowed to execute concurrently. Setting to 0 allows an unlimited number of concurrent queries.
+ *Default: 0
+ */ + queryConcurrency?: number; + + /** + * @public + *Maximum number of queries allowed in execution queue. When queue limit is reached, new queries are rejected. Setting to 0 allows an unlimited number of queries in the queue.
+ *Default: 0
+ */ + queryQueueSize?: number; + + /** + * @public + *Enable tracing in InfluxDB and specifies the tracing type. Tracing is disabled by default.
+ */ + tracingType?: TracingType; + + /** + * @public + *Disable the HTTP /metrics endpoint which exposes internal InfluxDB metrics.
+ *Default: false
+ */ + metricsDisabled?: boolean; +} + +/** + * @public + *The parameters that comprise the parameter group.
+ */ +export type _Parameters = _Parameters.InfluxDBv2Member | _Parameters.$UnknownMember; + +/** + * @public + */ +export namespace _Parameters { + /** + * @public + *All the customer-modifiable InfluxDB v2 parameters in Timestream for InfluxDB.
+ */ + export interface InfluxDBv2Member { + InfluxDBv2: InfluxDBv2Parameters; + $unknown?: never; + } + + /** + * @public + */ + export interface $UnknownMember { + InfluxDBv2?: never; + $unknown: [string, any]; + } + + export interface VisitorThe name of the DB parameter group. The name must be unique per customer and per region.
+ */ + name: string | undefined; + + /** + * @public + *A description of the DB parameter group.
+ */ + description?: string; + + /** + * @public + *A list of the parameters that comprise the DB parameter group.
+ */ + parameters?: _Parameters; + + /** + * @public + *A list of key-value pairs to associate with the DB parameter group.
+ */ + tags?: RecordA service-generated unique identifier.
+ */ + id: string | undefined; + + /** + * @public + *The customer-supplied name that uniquely identifies the DB parameter group when interacting with the Amazon Timestream for InfluxDB API and CLI commands.
+ */ + name: string | undefined; + + /** + * @public + *The Amazon Resource Name (ARM) of the DB parameter group.
+ */ + arn: string | undefined; + + /** + * @public + *The description of the DB parameter group.
+ */ + description?: string; + + /** + * @public + *A list of the parameters that comprise the DB parameter group.
+ */ + parameters?: _Parameters; +} + +/** + * @public + */ +export interface GetDbParameterGroupInput { + /** + * @public + *The id of the DB parameter group.
+ */ + identifier: string | undefined; +} + +/** + * @public + */ +export interface GetDbParameterGroupOutput { + /** + * @public + *A service-generated unique identifier.
+ */ + id: string | undefined; + + /** + * @public + *The customer-supplied name that uniquely identifies the DB parameter group when interacting with the Amazon Timestream for InfluxDB API and CLI commands.
+ */ + name: string | undefined; + + /** + * @public + *The Amazon Resource Name (ARN) of the DB parameter group.
+ */ + arn: string | undefined; + + /** + * @public + *A description of the DB parameter group.
+ */ + description?: string; + + /** + * @public + *The parameters that comprise the DB parameter group.
+ */ + parameters?: _Parameters; +} + +/** + * @public + */ +export interface ListDbParameterGroupsInput { + /** + * @public + *The pagination token. To resume pagination, provide the NextToken value as argument of a subsequent API invocation.
+ */ + nextToken?: string; + + /** + * @public + *The maximum number of items to return in the output. If the total number of items available is more than the value specified, a NextToken is provided in the output. To resume pagination, provide the NextToken value as argument of a subsequent API invocation.
+ */ + maxResults?: number; +} + +/** + * @public + *Contains a summary of a DB parameter group.
+ */ +export interface DbParameterGroupSummary { + /** + * @public + *A service-generated unique identifier.
+ */ + id: string | undefined; + + /** + * @public + *This customer-supplied name uniquely identifies the parameter group.
+ */ + name: string | undefined; + + /** + * @public + *The Amazon Resource Name (ARN) of the DB parameter group.
+ */ + arn: string | undefined; + + /** + * @public + *A description of the DB parameter group.
+ */ + description?: string; +} + +/** + * @public + */ +export interface ListDbParameterGroupsOutput { + /** + * @public + *A list of Timestream for InfluxDB DB parameter group summaries.
+ */ + items: DbParameterGroupSummary[] | undefined; + + /** + * @public + *Token from a previous call of the operation. When this value is provided, the + * service returns results from where the previous response left off.
+ */ + nextToken?: string; +} + +/** + * @public + */ +export interface ListTagsForResourceRequest { + /** + * @public + *The Amazon Resource Name (ARN) of the tagged resource.
+ */ + resourceArn: string | undefined; +} + +/** + * @public + */ +export interface ListTagsForResourceResponse { + /** + * @public + *A list of tags used to categorize and track resources.
+ */ + tags?: RecordThe Amazon Resource Name (ARN) of the tagged resource.
+ */ + resourceArn: string | undefined; + + /** + * @public + *A list of tags used to categorize and track resources.
+ */ + tags: RecordThe Amazon Resource Name (ARN) of the tagged resource.
+ */ + resourceArn: string | undefined; + + /** + * @public + *The keys used to identify the tags.
+ */ + tagKeys: string[] | undefined; +} + +/** + * @internal + */ +export const CreateDbInstanceInputFilterSensitiveLog = (obj: CreateDbInstanceInput): any => ({ + ...obj, + ...(obj.username && { username: SENSITIVE_STRING }), + ...(obj.password && { password: SENSITIVE_STRING }), +}); diff --git a/clients/client-timestream-influxdb/src/pagination/Interfaces.ts b/clients/client-timestream-influxdb/src/pagination/Interfaces.ts new file mode 100644 index 000000000000..8d94aa09d4a3 --- /dev/null +++ b/clients/client-timestream-influxdb/src/pagination/Interfaces.ts @@ -0,0 +1,11 @@ +// smithy-typescript generated code +import { PaginationConfiguration } from "@smithy/types"; + +import { TimestreamInfluxDBClient } from "../TimestreamInfluxDBClient"; + +/** + * @public + */ +export interface TimestreamInfluxDBPaginationConfiguration extends PaginationConfiguration { + client: TimestreamInfluxDBClient; +} diff --git a/clients/client-timestream-influxdb/src/pagination/ListDbInstancesPaginator.ts b/clients/client-timestream-influxdb/src/pagination/ListDbInstancesPaginator.ts new file mode 100644 index 000000000000..6f9235a27fdc --- /dev/null +++ b/clients/client-timestream-influxdb/src/pagination/ListDbInstancesPaginator.ts @@ -0,0 +1,24 @@ +// smithy-typescript generated code +import { createPaginator } from "@smithy/core"; +import { Paginator } from "@smithy/types"; + +import { + ListDbInstancesCommand, + ListDbInstancesCommandInput, + ListDbInstancesCommandOutput, +} from "../commands/ListDbInstancesCommand"; +import { TimestreamInfluxDBClient } from "../TimestreamInfluxDBClient"; +import { TimestreamInfluxDBPaginationConfiguration } from "./Interfaces"; + +/** + * @public + */ +export const paginateListDbInstances: ( + config: TimestreamInfluxDBPaginationConfiguration, + input: ListDbInstancesCommandInput, + ...rest: any[] +) => PaginatorYou do not have sufficient access to perform this action.
", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.timestreaminfluxdb#AllocatedStorage": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 20, + "max": 16384 + } + } + }, + "com.amazonaws.timestreaminfluxdb#AmazonTimestreamInfluxDB": { + "type": "service", + "version": "2023-01-27", + "operations": [ + { + "target": "com.amazonaws.timestreaminfluxdb#ListTagsForResource" + }, + { + "target": "com.amazonaws.timestreaminfluxdb#TagResource" + }, + { + "target": "com.amazonaws.timestreaminfluxdb#UntagResource" + } + ], + "resources": [ + { + "target": "com.amazonaws.timestreaminfluxdb#DbInstanceResource" + }, + { + "target": "com.amazonaws.timestreaminfluxdb#DbParameterGroupResource" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "Timestream InfluxDB", + "arnNamespace": "timestream-influxdb" + }, + "aws.auth#sigv4": { + "name": "timestream-influxdb" + }, + "aws.iam#defineConditionKeys": { + "aws:ResourceTag/${TagKey}": { + "type": "String", + "documentation": "Filters access by a tag key and value pair of a resource", + "externalDocumentation": "${DocHomeURL}IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-resourcetag" + }, + "aws:RequestTag/${TagKey}": { + "type": "String", + "documentation": "Filters access by a tag key and value pair that is allowed in the request", + "externalDocumentation": "${DocHomeURL}IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-requesttag" + }, + "aws:TagKeys": { + "type": "ArrayOfString", + "documentation": "Filters access by a list of tag keys that are allowed in the request", + "externalDocumentation": "${DocHomeURL}IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-tagkeys" + } + }, + "aws.iam#disableConditionKeyInference": {}, + "aws.protocols#awsJson1_0": {}, + "smithy.api#cors": { + "additionalAllowedHeaders": [ + "*,authorization,date,x-amz-date,x-amz-security-token,x-amz-target,content-type,x-amz-content-sha256,x-amz-user-agent,x-amzn-platform-id,x-amzn-trace-id,amz-sdk-invocation-id,amz-sdk-request" + ] + }, + "smithy.api#documentation": "Amazon Timestream for InfluxDB is a managed time-series database engine that makes it easy for application developers and DevOps teams to run InfluxDB databases on AWS for near real-time time-series applications using open-source APIs. With Amazon Timestream for InfluxDB, it is easy to set up, operate, and scale time-series workloads that can answer queries with single-digit millisecond query response time.
", + "smithy.api#title": "Timestream InfluxDB", + "smithy.rules#endpointRuleSet": { + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://timestream-influxdb-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + }, + true + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://timestream-influxdb-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://timestream-influxdb.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://timestream-influxdb.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ], + "type": "tree" + } + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://timestream-influxdb-fips.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://timestream-influxdb-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://timestream-influxdb.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://timestream-influxdb.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://timestream-influxdb-fips.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://timestream-influxdb-fips.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://timestream-influxdb.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://timestream-influxdb.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://timestream-influxdb-fips.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://timestream-influxdb-fips.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://timestream-influxdb.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://timestream-influxdb.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://timestream-influxdb-fips.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://timestream-influxdb.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://timestream-influxdb-fips.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://timestream-influxdb.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips enabled and dualstack disabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "Missing region", + "expect": { + "error": "Invalid Configuration: Missing Region" + } + } + ], + "version": "1.0" + } + } + }, + "com.amazonaws.timestreaminfluxdb#Arn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1011 + }, + "smithy.api#pattern": "^arn:aws[a-z\\-]*:timestream\\-influxdb:[a-z0-9\\-]+:[0-9]{12}:(db\\-instance|db\\-parameter\\-group)/[a-zA-Z0-9]{3,64}$" + } + }, + "com.amazonaws.timestreaminfluxdb#Bucket": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 2, + "max": 64 + }, + "smithy.api#pattern": "^[^_][^\"]*$" + } + }, + "com.amazonaws.timestreaminfluxdb#ConflictException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + }, + "resourceId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The identifier for the Timestream for InfluxDB resource associated with the request.
", + "smithy.api#required": {} + } + }, + "resourceType": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The type of Timestream for InfluxDB resource associated with the request.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The request conflicts with an existing resource in Timestream for InfluxDB.
", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.timestreaminfluxdb#CreateDbInstance": { + "type": "operation", + "input": { + "target": "com.amazonaws.timestreaminfluxdb#CreateDbInstanceInput" + }, + "output": { + "target": "com.amazonaws.timestreaminfluxdb#CreateDbInstanceOutput" + }, + "errors": [ + { + "target": "com.amazonaws.timestreaminfluxdb#AccessDeniedException" + }, + { + "target": "com.amazonaws.timestreaminfluxdb#ConflictException" + }, + { + "target": "com.amazonaws.timestreaminfluxdb#InternalServerException" + }, + { + "target": "com.amazonaws.timestreaminfluxdb#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.timestreaminfluxdb#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.timestreaminfluxdb#ThrottlingException" + }, + { + "target": "com.amazonaws.timestreaminfluxdb#ValidationException" + } + ], + "traits": { + "aws.iam#conditionKeys": ["aws:RequestTag/${TagKey}", "aws:TagKeys"], + "smithy.api#documentation": "Creates a new Timestream for InfluxDB DB instance.
", + "smithy.api#idempotent": {}, + "smithy.api#tags": ["DbInstance"] + } + }, + "com.amazonaws.timestreaminfluxdb#CreateDbInstanceInput": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.timestreaminfluxdb#DbInstanceName", + "traits": { + "smithy.api#documentation": "The name that uniquely identifies the DB instance when interacting with the Amazon Timestream for InfluxDB API and CLI commands. This name will also be a prefix included in the endpoint. DB instance names must be unique per customer and per region.
", + "smithy.api#required": {} + } + }, + "username": { + "target": "com.amazonaws.timestreaminfluxdb#Username", + "traits": { + "smithy.api#documentation": "The username of the initial admin user created in InfluxDB. Must start with a letter and can't end with a hyphen or contain two consecutive hyphens. For example, my-user1. This username will allow you to access the InfluxDB UI to perform various administrative tasks and also use the InfluxDB CLI to create an operator token. These attributes will be stored in a Secret created in Amazon Secrets Manager in your account.
" + } + }, + "password": { + "target": "com.amazonaws.timestreaminfluxdb#Password", + "traits": { + "smithy.api#documentation": "The password of the initial admin user created in InfluxDB. This password will allow you to access the InfluxDB UI to perform various administrative tasks and also use the InfluxDB CLI to create an operator token. These attributes will be stored in a Secret created in AWS SecretManager in your account.
", + "smithy.api#required": {} + } + }, + "organization": { + "target": "com.amazonaws.timestreaminfluxdb#Organization", + "traits": { + "smithy.api#documentation": "The name of the initial organization for the initial admin user in InfluxDB. An InfluxDB organization is a workspace for a group of users.
" + } + }, + "bucket": { + "target": "com.amazonaws.timestreaminfluxdb#Bucket", + "traits": { + "smithy.api#documentation": "The name of the initial InfluxDB bucket. All InfluxDB data is stored in a bucket. A bucket combines the concept of a database and a retention period (the duration of time that each data point persists). A bucket belongs to an organization.
" + } + }, + "dbInstanceType": { + "target": "com.amazonaws.timestreaminfluxdb#DbInstanceType", + "traits": { + "smithy.api#documentation": "The Timestream for InfluxDB DB instance type to run InfluxDB on.
", + "smithy.api#required": {} + } + }, + "vpcSubnetIds": { + "target": "com.amazonaws.timestreaminfluxdb#VpcSubnetIdList", + "traits": { + "smithy.api#documentation": "A list of VPC subnet IDs to associate with the DB instance. Provide at least two VPC subnet IDs in different availability zones when deploying with a Multi-AZ standby.
", + "smithy.api#required": {} + } + }, + "vpcSecurityGroupIds": { + "target": "com.amazonaws.timestreaminfluxdb#VpcSecurityGroupIdList", + "traits": { + "smithy.api#documentation": "A list of VPC security group IDs to associate with the DB instance.
", + "smithy.api#required": {} + } + }, + "publiclyAccessible": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Configures the DB instance with a public IP to facilitate access.
" + } + }, + "dbStorageType": { + "target": "com.amazonaws.timestreaminfluxdb#DbStorageType", + "traits": { + "smithy.api#documentation": "The Timestream for InfluxDB DB storage type to read and write InfluxDB data.
\nYou can choose between 3 different types of provisioned Influx IOPS included storage according to your workloads requirements:
\nInflux IO Included 3000 IOPS
\nInflux IO Included 12000 IOPS
\nInflux IO Included 16000 IOPS
\nThe amount of storage to allocate for your DB storage type in GiB (gibibytes).
", + "smithy.api#required": {} + } + }, + "dbParameterGroupIdentifier": { + "target": "com.amazonaws.timestreaminfluxdb#DbParameterGroupIdentifier", + "traits": { + "smithy.api#documentation": "The id of the DB parameter group to assign to your DB instance. DB parameter groups specify how the database is configured. For example, DB parameter groups can specify the limit for query concurrency.
" + } + }, + "deploymentType": { + "target": "com.amazonaws.timestreaminfluxdb#DeploymentType", + "traits": { + "smithy.api#documentation": "Specifies whether the DB instance will be deployed as a standalone instance or with a Multi-AZ standby for high availability.
" + } + }, + "logDeliveryConfiguration": { + "target": "com.amazonaws.timestreaminfluxdb#LogDeliveryConfiguration", + "traits": { + "smithy.api#documentation": "Configuration for sending InfluxDB engine logs to a specified S3 bucket.
" + } + }, + "tags": { + "target": "com.amazonaws.timestreaminfluxdb#RequestTagMap", + "traits": { + "smithy.api#documentation": "A list of key-value pairs to associate with the DB instance.
" + } + } + }, + "traits": { + "smithy.api#input": {}, + "smithy.api#references": [ + { + "resource": "com.amazonaws.timestreaminfluxdb#DbParameterGroupResource" + } + ] + } + }, + "com.amazonaws.timestreaminfluxdb#CreateDbInstanceOutput": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.timestreaminfluxdb#DbInstanceId", + "traits": { + "smithy.api#documentation": "A service-generated unique identifier.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.timestreaminfluxdb#DbInstanceName", + "traits": { + "smithy.api#documentation": "The customer-supplied name that uniquely identifies the DB instance when interacting with the Amazon Timestream for InfluxDB API and CLI commands.
", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.timestreaminfluxdb#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the DB instance.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.timestreaminfluxdb#Status", + "traits": { + "smithy.api#documentation": "The status of the DB instance.
" + } + }, + "endpoint": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The endpoint used to connect to InfluxDB. The default InfluxDB port is 8086.
" + } + }, + "dbInstanceType": { + "target": "com.amazonaws.timestreaminfluxdb#DbInstanceType", + "traits": { + "smithy.api#documentation": "The Timestream for InfluxDB instance type that InfluxDB runs on.
" + } + }, + "dbStorageType": { + "target": "com.amazonaws.timestreaminfluxdb#DbStorageType", + "traits": { + "smithy.api#documentation": "The Timestream for InfluxDB DB storage type that InfluxDB stores data on.
" + } + }, + "allocatedStorage": { + "target": "com.amazonaws.timestreaminfluxdb#AllocatedStorage", + "traits": { + "smithy.api#documentation": "The amount of storage allocated for your DB storage type (in gibibytes).
" + } + }, + "deploymentType": { + "target": "com.amazonaws.timestreaminfluxdb#DeploymentType", + "traits": { + "smithy.api#documentation": "Specifies whether the Timestream for InfluxDB is deployed as Single-AZ or with a MultiAZ Standby for High availability.
" + } + }, + "vpcSubnetIds": { + "target": "com.amazonaws.timestreaminfluxdb#VpcSubnetIdList", + "traits": { + "smithy.api#documentation": "A list of VPC subnet IDs associated with the DB instance.
", + "smithy.api#required": {} + } + }, + "publiclyAccessible": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Indicates if the DB instance has a public IP to facilitate access.
" + } + }, + "vpcSecurityGroupIds": { + "target": "com.amazonaws.timestreaminfluxdb#VpcSecurityGroupIdList", + "traits": { + "smithy.api#documentation": "A list of VPC security group IDs associated with the DB instance.
" + } + }, + "dbParameterGroupIdentifier": { + "target": "com.amazonaws.timestreaminfluxdb#DbParameterGroupIdentifier", + "traits": { + "smithy.api#documentation": "The id of the DB parameter group assigned to your DB instance.
" + } + }, + "availabilityZone": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The Availability Zone in which the DB instance resides.
" + } + }, + "secondaryAvailabilityZone": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The Availability Zone in which the standby instance is located when deploying with a MultiAZ standby instance.
" + } + }, + "logDeliveryConfiguration": { + "target": "com.amazonaws.timestreaminfluxdb#LogDeliveryConfiguration", + "traits": { + "smithy.api#documentation": "Configuration for sending InfluxDB engine logs to send to specified S3 bucket.
" + } + }, + "influxAuthParametersSecretArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AWS Secrets Manager secret containing the initial InfluxDB authorization parameters. The secret value is a JSON formatted key-value pair holding InfluxDB authorization values: organization, bucket, username, and password.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.timestreaminfluxdb#CreateDbParameterGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.timestreaminfluxdb#CreateDbParameterGroupInput" + }, + "output": { + "target": "com.amazonaws.timestreaminfluxdb#CreateDbParameterGroupOutput" + }, + "errors": [ + { + "target": "com.amazonaws.timestreaminfluxdb#AccessDeniedException" + }, + { + "target": "com.amazonaws.timestreaminfluxdb#ConflictException" + }, + { + "target": "com.amazonaws.timestreaminfluxdb#InternalServerException" + }, + { + "target": "com.amazonaws.timestreaminfluxdb#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.timestreaminfluxdb#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.timestreaminfluxdb#ThrottlingException" + }, + { + "target": "com.amazonaws.timestreaminfluxdb#ValidationException" + } + ], + "traits": { + "aws.iam#conditionKeys": ["aws:RequestTag/${TagKey}", "aws:TagKeys"], + "smithy.api#documentation": "Creates a new Timestream for InfluxDB DB parameter group to associate with DB instances.
", + "smithy.api#idempotent": {}, + "smithy.api#tags": ["DbParameterGroup"] + } + }, + "com.amazonaws.timestreaminfluxdb#CreateDbParameterGroupInput": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.timestreaminfluxdb#DbParameterGroupName", + "traits": { + "smithy.api#documentation": "The name of the DB parameter group. The name must be unique per customer and per region.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "A description of the DB parameter group.
", + "smithy.api#length": { + "min": 0, + "max": 500 + } + } + }, + "parameters": { + "target": "com.amazonaws.timestreaminfluxdb#Parameters", + "traits": { + "smithy.api#documentation": "A list of the parameters that comprise the DB parameter group.
" + } + }, + "tags": { + "target": "com.amazonaws.timestreaminfluxdb#RequestTagMap", + "traits": { + "smithy.api#documentation": "A list of key-value pairs to associate with the DB parameter group.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.timestreaminfluxdb#CreateDbParameterGroupOutput": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.timestreaminfluxdb#DbParameterGroupId", + "traits": { + "smithy.api#documentation": "A service-generated unique identifier.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.timestreaminfluxdb#DbParameterGroupName", + "traits": { + "smithy.api#documentation": "The customer-supplied name that uniquely identifies the DB parameter group when interacting with the Amazon Timestream for InfluxDB API and CLI commands.
", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.timestreaminfluxdb#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARM) of the DB parameter group.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The description of the DB parameter group.
" + } + }, + "parameters": { + "target": "com.amazonaws.timestreaminfluxdb#Parameters", + "traits": { + "smithy.api#documentation": "A list of the parameters that comprise the DB parameter group.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.timestreaminfluxdb#DbInstanceId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 64 + }, + "smithy.api#pattern": "^[a-zA-Z0-9]+$" + } + }, + "com.amazonaws.timestreaminfluxdb#DbInstanceIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 64 + }, + "smithy.api#pattern": "^[a-zA-Z0-9]+$" + } + }, + "com.amazonaws.timestreaminfluxdb#DbInstanceName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 40 + }, + "smithy.api#pattern": "^[a-zA-z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*$" + } + }, + "com.amazonaws.timestreaminfluxdb#DbInstanceResource": { + "type": "resource", + "identifiers": { + "dbInstanceIdentifier": { + "target": "com.amazonaws.timestreaminfluxdb#DbInstanceIdentifier" + } + }, + "create": { + "target": "com.amazonaws.timestreaminfluxdb#CreateDbInstance" + }, + "read": { + "target": "com.amazonaws.timestreaminfluxdb#GetDbInstance" + }, + "update": { + "target": "com.amazonaws.timestreaminfluxdb#UpdateDbInstance" + }, + "delete": { + "target": "com.amazonaws.timestreaminfluxdb#DeleteDbInstance" + }, + "list": { + "target": "com.amazonaws.timestreaminfluxdb#ListDbInstances" + }, + "traits": { + "aws.iam#conditionKeys": ["aws:ResourceTag/${TagKey}"], + "aws.iam#iamResource": { + "name": "db-instance" + } + } + }, + "com.amazonaws.timestreaminfluxdb#DbInstanceSummary": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.timestreaminfluxdb#DbInstanceId", + "traits": { + "smithy.api#documentation": "The service-generated unique identifier of the DB instance.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.timestreaminfluxdb#DbInstanceName", + "traits": { + "smithy.api#documentation": "This customer-supplied name uniquely identifies the DB instance when interacting with the Amazon Timestream for InfluxDB API and AWS CLI commands.
", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.timestreaminfluxdb#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the DB instance.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.timestreaminfluxdb#Status", + "traits": { + "smithy.api#documentation": "The status of the DB instance.
" + } + }, + "endpoint": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The endpoint used to connect to InfluxDB. The default InfluxDB port is 8086.
" + } + }, + "dbInstanceType": { + "target": "com.amazonaws.timestreaminfluxdb#DbInstanceType", + "traits": { + "smithy.api#documentation": "The Timestream for InfluxDB instance type to run InfluxDB on.
" + } + }, + "dbStorageType": { + "target": "com.amazonaws.timestreaminfluxdb#DbStorageType", + "traits": { + "smithy.api#documentation": "The storage type for your DB instance.
" + } + }, + "allocatedStorage": { + "target": "com.amazonaws.timestreaminfluxdb#AllocatedStorage", + "traits": { + "smithy.api#documentation": "The amount of storage to allocate for your DbStorageType in GiB (gibibytes).
" + } + }, + "deploymentType": { + "target": "com.amazonaws.timestreaminfluxdb#DeploymentType", + "traits": { + "smithy.api#documentation": "Single-Instance or with a MultiAZ Standby for High availability.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains a summary of a DB instance.
" + } + }, + "com.amazonaws.timestreaminfluxdb#DbInstanceSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.timestreaminfluxdb#DbInstanceSummary" + } + }, + "com.amazonaws.timestreaminfluxdb#DbInstanceType": { + "type": "enum", + "members": { + "DB_INFLUX_MEDIUM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "db.influx.medium" + } + }, + "DB_INFLUX_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "db.influx.large" + } + }, + "DB_INFLUX_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "db.influx.xlarge" + } + }, + "DB_INFLUX_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "db.influx.2xlarge" + } + }, + "DB_INFLUX_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "db.influx.4xlarge" + } + }, + "DB_INFLUX_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "db.influx.8xlarge" + } + }, + "DB_INFLUX_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "db.influx.12xlarge" + } + }, + "DB_INFLUX_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "db.influx.16xlarge" + } + } + } + }, + "com.amazonaws.timestreaminfluxdb#DbParameterGroupId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 64 + }, + "smithy.api#pattern": "^[a-zA-Z0-9]+$" + } + }, + "com.amazonaws.timestreaminfluxdb#DbParameterGroupIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 64 + }, + "smithy.api#pattern": "^[a-zA-Z0-9]+$" + } + }, + "com.amazonaws.timestreaminfluxdb#DbParameterGroupName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 64 + }, + "smithy.api#pattern": "^[a-zA-z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*$" + } + }, + "com.amazonaws.timestreaminfluxdb#DbParameterGroupResource": { + "type": "resource", + "identifiers": { + "dbParameterGroupIdentifier": { + "target": "com.amazonaws.timestreaminfluxdb#DbParameterGroupIdentifier" + } + }, + "create": { + "target": "com.amazonaws.timestreaminfluxdb#CreateDbParameterGroup" + }, + "read": { + "target": "com.amazonaws.timestreaminfluxdb#GetDbParameterGroup" + }, + "list": { + "target": "com.amazonaws.timestreaminfluxdb#ListDbParameterGroups" + }, + "traits": { + "aws.iam#conditionKeys": ["aws:ResourceTag/${TagKey}"], + "aws.iam#iamResource": { + "name": "db-parameter-group" + } + } + }, + "com.amazonaws.timestreaminfluxdb#DbParameterGroupSummary": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.timestreaminfluxdb#DbParameterGroupId", + "traits": { + "smithy.api#documentation": "A service-generated unique identifier.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.timestreaminfluxdb#DbParameterGroupName", + "traits": { + "smithy.api#documentation": "This customer-supplied name uniquely identifies the parameter group.
", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.timestreaminfluxdb#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the DB parameter group.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "A description of the DB parameter group.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains a summary of a DB parameter group.
" + } + }, + "com.amazonaws.timestreaminfluxdb#DbParameterGroupSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.timestreaminfluxdb#DbParameterGroupSummary" + } + }, + "com.amazonaws.timestreaminfluxdb#DbStorageType": { + "type": "enum", + "members": { + "INFLUX_IO_INCLUDED_T1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InfluxIOIncludedT1" + } + }, + "INFLUX_IO_INCLUDED_T2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InfluxIOIncludedT2" + } + }, + "INFLUX_IO_INCLUDED_T3": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InfluxIOIncludedT3" + } + } + } + }, + "com.amazonaws.timestreaminfluxdb#DeleteDbInstance": { + "type": "operation", + "input": { + "target": "com.amazonaws.timestreaminfluxdb#DeleteDbInstanceInput" + }, + "output": { + "target": "com.amazonaws.timestreaminfluxdb#DeleteDbInstanceOutput" + }, + "errors": [ + { + "target": "com.amazonaws.timestreaminfluxdb#AccessDeniedException" + }, + { + "target": "com.amazonaws.timestreaminfluxdb#ConflictException" + }, + { + "target": "com.amazonaws.timestreaminfluxdb#InternalServerException" + }, + { + "target": "com.amazonaws.timestreaminfluxdb#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.timestreaminfluxdb#ThrottlingException" + }, + { + "target": "com.amazonaws.timestreaminfluxdb#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a Timestream for InfluxDB DB instance.
", + "smithy.api#idempotent": {}, + "smithy.api#tags": ["DbInstance"] + } + }, + "com.amazonaws.timestreaminfluxdb#DeleteDbInstanceInput": { + "type": "structure", + "members": { + "identifier": { + "target": "com.amazonaws.timestreaminfluxdb#DbInstanceIdentifier", + "traits": { + "smithy.api#documentation": "The id of the DB instance.
", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "dbInstanceIdentifier" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.timestreaminfluxdb#DeleteDbInstanceOutput": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.timestreaminfluxdb#DbInstanceId", + "traits": { + "smithy.api#documentation": "A service-generated unique identifier.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.timestreaminfluxdb#DbInstanceName", + "traits": { + "smithy.api#documentation": "The customer-supplied name that uniquely identifies the DB instance when interacting with the Amazon Timestream for InfluxDB API and CLI commands.
", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.timestreaminfluxdb#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the DB instance.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.timestreaminfluxdb#Status", + "traits": { + "smithy.api#documentation": "The status of the DB instance.
" + } + }, + "endpoint": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The endpoint used to connect to InfluxDB. The default InfluxDB port is 8086.
" + } + }, + "dbInstanceType": { + "target": "com.amazonaws.timestreaminfluxdb#DbInstanceType", + "traits": { + "smithy.api#documentation": "The Timestream for InfluxDB instance type that InfluxDB runs on.
" + } + }, + "dbStorageType": { + "target": "com.amazonaws.timestreaminfluxdb#DbStorageType", + "traits": { + "smithy.api#documentation": "The Timestream for InfluxDB DB storage type that InfluxDB stores data on.
" + } + }, + "allocatedStorage": { + "target": "com.amazonaws.timestreaminfluxdb#AllocatedStorage", + "traits": { + "smithy.api#documentation": "The amount of storage allocated for your DB storage type (in gibibytes).
" + } + }, + "deploymentType": { + "target": "com.amazonaws.timestreaminfluxdb#DeploymentType", + "traits": { + "smithy.api#documentation": "Specifies whether the Timestream for InfluxDB is deployed as Single-AZ or with a MultiAZ Standby for High availability.
" + } + }, + "vpcSubnetIds": { + "target": "com.amazonaws.timestreaminfluxdb#VpcSubnetIdList", + "traits": { + "smithy.api#documentation": "A list of VPC subnet IDs associated with the DB instance.
", + "smithy.api#required": {} + } + }, + "publiclyAccessible": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Indicates if the DB instance has a public IP to facilitate access.
" + } + }, + "vpcSecurityGroupIds": { + "target": "com.amazonaws.timestreaminfluxdb#VpcSecurityGroupIdList", + "traits": { + "smithy.api#documentation": "A list of VPC security group IDs associated with the DB instance.
" + } + }, + "dbParameterGroupIdentifier": { + "target": "com.amazonaws.timestreaminfluxdb#DbParameterGroupIdentifier", + "traits": { + "smithy.api#documentation": "The id of the DB parameter group assigned to your DB instance.
" + } + }, + "availabilityZone": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The Availability Zone in which the DB instance resides.
" + } + }, + "secondaryAvailabilityZone": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The Availability Zone in which the standby instance is located when deploying with a MultiAZ standby instance.
" + } + }, + "logDeliveryConfiguration": { + "target": "com.amazonaws.timestreaminfluxdb#LogDeliveryConfiguration", + "traits": { + "smithy.api#documentation": "Configuration for sending InfluxDB engine logs to send to specified S3 bucket.
" + } + }, + "influxAuthParametersSecretArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AWS Secrets Manager secret containing the initial InfluxDB authorization parameters. The secret value is a JSON formatted key-value pair holding InfluxDB authorization values: organization, bucket, username, and password.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.timestreaminfluxdb#DeploymentType": { + "type": "enum", + "members": { + "SINGLE_AZ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SINGLE_AZ" + } + }, + "WITH_MULTIAZ_STANDBY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WITH_MULTIAZ_STANDBY" + } + } + } + }, + "com.amazonaws.timestreaminfluxdb#GetDbInstance": { + "type": "operation", + "input": { + "target": "com.amazonaws.timestreaminfluxdb#GetDbInstanceInput" + }, + "output": { + "target": "com.amazonaws.timestreaminfluxdb#GetDbInstanceOutput" + }, + "errors": [ + { + "target": "com.amazonaws.timestreaminfluxdb#AccessDeniedException" + }, + { + "target": "com.amazonaws.timestreaminfluxdb#InternalServerException" + }, + { + "target": "com.amazonaws.timestreaminfluxdb#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.timestreaminfluxdb#ThrottlingException" + }, + { + "target": "com.amazonaws.timestreaminfluxdb#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Returns a Timestream for InfluxDB DB instance.
", + "smithy.api#readonly": {}, + "smithy.api#tags": ["DbInstance"] + } + }, + "com.amazonaws.timestreaminfluxdb#GetDbInstanceInput": { + "type": "structure", + "members": { + "identifier": { + "target": "com.amazonaws.timestreaminfluxdb#DbInstanceIdentifier", + "traits": { + "smithy.api#documentation": "The id of the DB instance.
", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "dbInstanceIdentifier" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.timestreaminfluxdb#GetDbInstanceOutput": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.timestreaminfluxdb#DbInstanceId", + "traits": { + "smithy.api#documentation": "A service-generated unique identifier.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.timestreaminfluxdb#DbInstanceName", + "traits": { + "smithy.api#documentation": "The customer-supplied name that uniquely identifies the DB instance when interacting with the Amazon Timestream for InfluxDB API and CLI commands.
", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.timestreaminfluxdb#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the DB instance.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.timestreaminfluxdb#Status", + "traits": { + "smithy.api#documentation": "The status of the DB instance.
" + } + }, + "endpoint": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The endpoint used to connect to InfluxDB. The default InfluxDB port is 8086.
" + } + }, + "dbInstanceType": { + "target": "com.amazonaws.timestreaminfluxdb#DbInstanceType", + "traits": { + "smithy.api#documentation": "The Timestream for InfluxDB instance type that InfluxDB runs on.
" + } + }, + "dbStorageType": { + "target": "com.amazonaws.timestreaminfluxdb#DbStorageType", + "traits": { + "smithy.api#documentation": "The Timestream for InfluxDB DB storage type that InfluxDB stores data on.
" + } + }, + "allocatedStorage": { + "target": "com.amazonaws.timestreaminfluxdb#AllocatedStorage", + "traits": { + "smithy.api#documentation": "The amount of storage allocated for your DB storage type (in gibibytes).
" + } + }, + "deploymentType": { + "target": "com.amazonaws.timestreaminfluxdb#DeploymentType", + "traits": { + "smithy.api#documentation": "Specifies whether the Timestream for InfluxDB is deployed as Single-AZ or with a MultiAZ Standby for High availability.
" + } + }, + "vpcSubnetIds": { + "target": "com.amazonaws.timestreaminfluxdb#VpcSubnetIdList", + "traits": { + "smithy.api#documentation": "A list of VPC subnet IDs associated with the DB instance.
", + "smithy.api#required": {} + } + }, + "publiclyAccessible": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Indicates if the DB instance has a public IP to facilitate access.
" + } + }, + "vpcSecurityGroupIds": { + "target": "com.amazonaws.timestreaminfluxdb#VpcSecurityGroupIdList", + "traits": { + "smithy.api#documentation": "A list of VPC security group IDs associated with the DB instance.
" + } + }, + "dbParameterGroupIdentifier": { + "target": "com.amazonaws.timestreaminfluxdb#DbParameterGroupIdentifier", + "traits": { + "smithy.api#documentation": "The id of the DB parameter group assigned to your DB instance.
" + } + }, + "availabilityZone": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The Availability Zone in which the DB instance resides.
" + } + }, + "secondaryAvailabilityZone": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The Availability Zone in which the standby instance is located when deploying with a MultiAZ standby instance.
" + } + }, + "logDeliveryConfiguration": { + "target": "com.amazonaws.timestreaminfluxdb#LogDeliveryConfiguration", + "traits": { + "smithy.api#documentation": "Configuration for sending InfluxDB engine logs to send to specified S3 bucket.
" + } + }, + "influxAuthParametersSecretArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AWS Secrets Manager secret containing the initial InfluxDB authorization parameters. The secret value is a JSON formatted key-value pair holding InfluxDB authorization values: organization, bucket, username, and password.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.timestreaminfluxdb#GetDbParameterGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.timestreaminfluxdb#GetDbParameterGroupInput" + }, + "output": { + "target": "com.amazonaws.timestreaminfluxdb#GetDbParameterGroupOutput" + }, + "errors": [ + { + "target": "com.amazonaws.timestreaminfluxdb#AccessDeniedException" + }, + { + "target": "com.amazonaws.timestreaminfluxdb#InternalServerException" + }, + { + "target": "com.amazonaws.timestreaminfluxdb#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.timestreaminfluxdb#ThrottlingException" + }, + { + "target": "com.amazonaws.timestreaminfluxdb#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Returns a Timestream for InfluxDB DB parameter group.
", + "smithy.api#readonly": {}, + "smithy.api#tags": ["DbParameterGroup"] + } + }, + "com.amazonaws.timestreaminfluxdb#GetDbParameterGroupInput": { + "type": "structure", + "members": { + "identifier": { + "target": "com.amazonaws.timestreaminfluxdb#DbParameterGroupIdentifier", + "traits": { + "smithy.api#documentation": "The id of the DB parameter group.
", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "dbParameterGroupIdentifier" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.timestreaminfluxdb#GetDbParameterGroupOutput": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.timestreaminfluxdb#DbParameterGroupId", + "traits": { + "smithy.api#documentation": "A service-generated unique identifier.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.timestreaminfluxdb#DbParameterGroupName", + "traits": { + "smithy.api#documentation": "The customer-supplied name that uniquely identifies the DB parameter group when interacting with the Amazon Timestream for InfluxDB API and CLI commands.
", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.timestreaminfluxdb#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the DB parameter group.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "A description of the DB parameter group.
" + } + }, + "parameters": { + "target": "com.amazonaws.timestreaminfluxdb#Parameters", + "traits": { + "smithy.api#documentation": "The parameters that comprise the DB parameter group.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.timestreaminfluxdb#InfluxDBv2Parameters": { + "type": "structure", + "members": { + "fluxLogEnabled": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Include option to show detailed logs for Flux queries.
\nDefault: false
" + } + }, + "logLevel": { + "target": "com.amazonaws.timestreaminfluxdb#LogLevel", + "traits": { + "smithy.api#documentation": "Log output level. InfluxDB outputs log entries with severity levels greater than or equal to the level specified.
\nDefault: info
" + } + }, + "noTasks": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Disable the task scheduler. If problematic tasks prevent InfluxDB from starting, use this option to start InfluxDB without scheduling or executing tasks.
\nDefault: false
" + } + }, + "queryConcurrency": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "Number of queries allowed to execute concurrently. Setting to 0 allows an unlimited number of concurrent queries.
\nDefault: 0
", + "smithy.api#range": { + "min": 0, + "max": 256 + } + } + }, + "queryQueueSize": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "Maximum number of queries allowed in execution queue. When queue limit is reached, new queries are rejected. Setting to 0 allows an unlimited number of queries in the queue.
\nDefault: 0
", + "smithy.api#range": { + "min": 0, + "max": 256 + } + } + }, + "tracingType": { + "target": "com.amazonaws.timestreaminfluxdb#TracingType", + "traits": { + "smithy.api#documentation": "Enable tracing in InfluxDB and specifies the tracing type. Tracing is disabled by default.
" + } + }, + "metricsDisabled": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Disable the HTTP /metrics endpoint which exposes internal InfluxDB metrics.
\nDefault: false
" + } + } + }, + "traits": { + "smithy.api#documentation": "All the customer-modifiable InfluxDB v2 parameters in Timestream for InfluxDB.
" + } + }, + "com.amazonaws.timestreaminfluxdb#InternalServerException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The request processing has failed because of an unknown error, exception or failure.
", + "smithy.api#error": "server", + "smithy.api#httpError": 500, + "smithy.api#retryable": {} + } + }, + "com.amazonaws.timestreaminfluxdb#ListDbInstances": { + "type": "operation", + "input": { + "target": "com.amazonaws.timestreaminfluxdb#ListDbInstancesInput" + }, + "output": { + "target": "com.amazonaws.timestreaminfluxdb#ListDbInstancesOutput" + }, + "errors": [ + { + "target": "com.amazonaws.timestreaminfluxdb#AccessDeniedException" + }, + { + "target": "com.amazonaws.timestreaminfluxdb#InternalServerException" + }, + { + "target": "com.amazonaws.timestreaminfluxdb#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.timestreaminfluxdb#ThrottlingException" + }, + { + "target": "com.amazonaws.timestreaminfluxdb#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Returns a list of Timestream for InfluxDB DB instances.
", + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "items" + }, + "smithy.api#readonly": {}, + "smithy.api#tags": ["DbInstance"] + } + }, + "com.amazonaws.timestreaminfluxdb#ListDbInstancesInput": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.timestreaminfluxdb#NextToken", + "traits": { + "smithy.api#documentation": "The pagination token. To resume pagination, provide the NextToken value as argument of a subsequent API invocation.
" + } + }, + "maxResults": { + "target": "com.amazonaws.timestreaminfluxdb#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of items to return in the output. If the total number of items available is more than the value specified, a NextToken is provided in the output. To resume pagination, provide the NextToken value as argument of a subsequent API invocation.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.timestreaminfluxdb#ListDbInstancesOutput": { + "type": "structure", + "members": { + "items": { + "target": "com.amazonaws.timestreaminfluxdb#DbInstanceSummaryList", + "traits": { + "smithy.api#documentation": "A list of Timestream for InfluxDB DB instance summaries.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.timestreaminfluxdb#NextToken", + "traits": { + "smithy.api#documentation": "Token from a previous call of the operation. When this value is provided, the\n service returns results from where the previous response left off.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.timestreaminfluxdb#ListDbParameterGroups": { + "type": "operation", + "input": { + "target": "com.amazonaws.timestreaminfluxdb#ListDbParameterGroupsInput" + }, + "output": { + "target": "com.amazonaws.timestreaminfluxdb#ListDbParameterGroupsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.timestreaminfluxdb#AccessDeniedException" + }, + { + "target": "com.amazonaws.timestreaminfluxdb#InternalServerException" + }, + { + "target": "com.amazonaws.timestreaminfluxdb#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.timestreaminfluxdb#ThrottlingException" + }, + { + "target": "com.amazonaws.timestreaminfluxdb#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Returns a list of Timestream for InfluxDB DB parameter groups.
", + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "items" + }, + "smithy.api#readonly": {}, + "smithy.api#tags": ["DbParameterGroup"] + } + }, + "com.amazonaws.timestreaminfluxdb#ListDbParameterGroupsInput": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.timestreaminfluxdb#NextToken", + "traits": { + "smithy.api#documentation": "The pagination token. To resume pagination, provide the NextToken value as argument of a subsequent API invocation.
" + } + }, + "maxResults": { + "target": "com.amazonaws.timestreaminfluxdb#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of items to return in the output. If the total number of items available is more than the value specified, a NextToken is provided in the output. To resume pagination, provide the NextToken value as argument of a subsequent API invocation.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.timestreaminfluxdb#ListDbParameterGroupsOutput": { + "type": "structure", + "members": { + "items": { + "target": "com.amazonaws.timestreaminfluxdb#DbParameterGroupSummaryList", + "traits": { + "smithy.api#documentation": "A list of Timestream for InfluxDB DB parameter group summaries.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.timestreaminfluxdb#NextToken", + "traits": { + "smithy.api#documentation": "Token from a previous call of the operation. When this value is provided, the\n service returns results from where the previous response left off.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.timestreaminfluxdb#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.timestreaminfluxdb#ListTagsForResourceRequest" + }, + "output": { + "target": "com.amazonaws.timestreaminfluxdb#ListTagsForResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.timestreaminfluxdb#ResourceNotFoundException" + } + ], + "traits": { + "aws.iam#conditionKeys": ["aws:ResourceTag/${TagKey}"], + "smithy.api#documentation": "A list of tags applied to the resource.
", + "smithy.api#readonly": {} + } + }, + "com.amazonaws.timestreaminfluxdb#ListTagsForResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.timestreaminfluxdb#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the tagged resource.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.timestreaminfluxdb#ListTagsForResourceResponse": { + "type": "structure", + "members": { + "tags": { + "target": "com.amazonaws.timestreaminfluxdb#ResponseTagMap", + "traits": { + "smithy.api#documentation": "A list of tags used to categorize and track resources.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.timestreaminfluxdb#LogDeliveryConfiguration": { + "type": "structure", + "members": { + "s3Configuration": { + "target": "com.amazonaws.timestreaminfluxdb#S3Configuration", + "traits": { + "smithy.api#documentation": "Configuration for S3 bucket log delivery.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration for sending InfluxDB engine logs to send to specified S3 bucket.
" + } + }, + "com.amazonaws.timestreaminfluxdb#LogLevel": { + "type": "enum", + "members": { + "DEBUG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "debug" + } + }, + "INFO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "info" + } + }, + "ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "error" + } + } + } + }, + "com.amazonaws.timestreaminfluxdb#MaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.timestreaminfluxdb#NextToken": { + "type": "string" + }, + "com.amazonaws.timestreaminfluxdb#Organization": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + } + } + }, + "com.amazonaws.timestreaminfluxdb#Parameters": { + "type": "union", + "members": { + "InfluxDBv2": { + "target": "com.amazonaws.timestreaminfluxdb#InfluxDBv2Parameters", + "traits": { + "smithy.api#documentation": "All the customer-modifiable InfluxDB v2 parameters in Timestream for InfluxDB.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The parameters that comprise the parameter group.
" + } + }, + "com.amazonaws.timestreaminfluxdb#Password": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 8, + "max": 64 + }, + "smithy.api#pattern": "^[a-zA-Z0-9]+$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.timestreaminfluxdb#RequestTagMap": { + "type": "map", + "key": { + "target": "com.amazonaws.timestreaminfluxdb#TagKey" + }, + "value": { + "target": "com.amazonaws.timestreaminfluxdb#TagValue" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + } + } + }, + "com.amazonaws.timestreaminfluxdb#ResourceNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + }, + "resourceId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The identifier for the Timestream for InfluxDB resource associated with the request.
", + "smithy.api#required": {} + } + }, + "resourceType": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The type of Timestream for InfluxDB resource associated with the request.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The requested resource was not found or does not exist.
", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.timestreaminfluxdb#ResponseTagMap": { + "type": "map", + "key": { + "target": "com.amazonaws.timestreaminfluxdb#TagKey" + }, + "value": { + "target": "com.amazonaws.timestreaminfluxdb#TagValue" + }, + "traits": { + "smithy.api#length": { + "max": 200 + } + } + }, + "com.amazonaws.timestreaminfluxdb#S3Configuration": { + "type": "structure", + "members": { + "bucketName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the S3 bucket to deliver logs to.
", + "smithy.api#length": { + "min": 3, + "max": 63 + }, + "smithy.api#pattern": "^[0-9a-z]+[0-9a-z\\.\\-]*[0-9a-z]+$", + "smithy.api#required": {} + } + }, + "enabled": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Indicates whether log delivery to the S3 bucket is enabled.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration for S3 bucket log delivery.
" + } + }, + "com.amazonaws.timestreaminfluxdb#ServiceQuotaExceededException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The request exceeds the service quota.
", + "smithy.api#error": "client", + "smithy.api#httpError": 402 + } + }, + "com.amazonaws.timestreaminfluxdb#Status": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "AVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AVAILABLE" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "MODIFYING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MODIFYING" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" + } + }, + "DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETED" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + } + } + }, + "com.amazonaws.timestreaminfluxdb#TagKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.timestreaminfluxdb#TagKeys": { + "type": "list", + "member": { + "target": "com.amazonaws.timestreaminfluxdb#TagKey" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + } + } + }, + "com.amazonaws.timestreaminfluxdb#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.timestreaminfluxdb#TagResourceRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.timestreaminfluxdb#ResourceNotFoundException" + } + ], + "traits": { + "aws.iam#conditionKeys": ["aws:ResourceTag/${TagKey}", "aws:RequestTag/${TagKey}", "aws:TagKeys"], + "smithy.api#documentation": "Tags are composed of a Key/Value pairs. You can use tags to categorize and track your Timestream for InfluxDB resources.
", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.timestreaminfluxdb#TagResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.timestreaminfluxdb#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the tagged resource.
", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.timestreaminfluxdb#RequestTagMap", + "traits": { + "smithy.api#documentation": "A list of tags used to categorize and track resources.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.timestreaminfluxdb#TagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.timestreaminfluxdb#ThrottlingException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + }, + "retryAfterSeconds": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The number of seconds the caller should wait before retrying.
", + "smithy.api#httpHeader": "Retry-After" + } + } + }, + "traits": { + "smithy.api#documentation": "The request was denied due to request throttling.
", + "smithy.api#error": "client", + "smithy.api#httpError": 429, + "smithy.api#retryable": {} + } + }, + "com.amazonaws.timestreaminfluxdb#TracingType": { + "type": "enum", + "members": { + "LOG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "log" + } + }, + "JAEGER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "jaeger" + } + } + } + }, + "com.amazonaws.timestreaminfluxdb#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.timestreaminfluxdb#UntagResourceRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.timestreaminfluxdb#ResourceNotFoundException" + } + ], + "traits": { + "aws.iam#conditionKeys": ["aws:ResourceTag/${TagKey}", "aws:TagKeys"], + "smithy.api#documentation": "Removes the tag from the specified resource.
", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.timestreaminfluxdb#UntagResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.timestreaminfluxdb#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the tagged resource.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "tagKeys": { + "target": "com.amazonaws.timestreaminfluxdb#TagKeys", + "traits": { + "aws.iam#conditionKeyValue": "aws:TagKeys", + "smithy.api#documentation": "The keys used to identify the tags.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.timestreaminfluxdb#UpdateDbInstance": { + "type": "operation", + "input": { + "target": "com.amazonaws.timestreaminfluxdb#UpdateDbInstanceInput" + }, + "output": { + "target": "com.amazonaws.timestreaminfluxdb#UpdateDbInstanceOutput" + }, + "errors": [ + { + "target": "com.amazonaws.timestreaminfluxdb#AccessDeniedException" + }, + { + "target": "com.amazonaws.timestreaminfluxdb#ConflictException" + }, + { + "target": "com.amazonaws.timestreaminfluxdb#InternalServerException" + }, + { + "target": "com.amazonaws.timestreaminfluxdb#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.timestreaminfluxdb#ThrottlingException" + }, + { + "target": "com.amazonaws.timestreaminfluxdb#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates a Timestream for InfluxDB DB instance.
", + "smithy.api#idempotent": {}, + "smithy.api#tags": ["DbInstance"] + } + }, + "com.amazonaws.timestreaminfluxdb#UpdateDbInstanceInput": { + "type": "structure", + "members": { + "identifier": { + "target": "com.amazonaws.timestreaminfluxdb#DbInstanceIdentifier", + "traits": { + "smithy.api#documentation": "The id of the DB instance.
", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "dbInstanceIdentifier" + } + }, + "logDeliveryConfiguration": { + "target": "com.amazonaws.timestreaminfluxdb#LogDeliveryConfiguration", + "traits": { + "smithy.api#documentation": "Configuration for sending InfluxDB engine logs to send to specified S3 bucket.
" + } + }, + "dbParameterGroupIdentifier": { + "target": "com.amazonaws.timestreaminfluxdb#DbParameterGroupIdentifier", + "traits": { + "smithy.api#documentation": "The id of the DB parameter group to assign to your DB instance. DB parameter groups specify how the database is configured. For example, DB parameter groups can specify the limit for query concurrency.
" + } + } + }, + "traits": { + "smithy.api#input": {}, + "smithy.api#references": [ + { + "resource": "com.amazonaws.timestreaminfluxdb#DbParameterGroupResource" + } + ] + } + }, + "com.amazonaws.timestreaminfluxdb#UpdateDbInstanceOutput": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.timestreaminfluxdb#DbInstanceId", + "traits": { + "smithy.api#documentation": "A service-generated unique identifier.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.timestreaminfluxdb#DbInstanceName", + "traits": { + "smithy.api#documentation": "This customer-supplied name uniquely identifies the DB instance when interacting with the Amazon Timestream for InfluxDB API and AWS CLI commands.
", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.timestreaminfluxdb#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the DB instance.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.timestreaminfluxdb#Status", + "traits": { + "smithy.api#documentation": "The status of the DB instance.
" + } + }, + "endpoint": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The endpoint used to connect to InfluxDB. The default InfluxDB port is 8086.
" + } + }, + "dbInstanceType": { + "target": "com.amazonaws.timestreaminfluxdb#DbInstanceType", + "traits": { + "smithy.api#documentation": "The Timestream for InfluxDB instance type that InfluxDB runs on.
" + } + }, + "dbStorageType": { + "target": "com.amazonaws.timestreaminfluxdb#DbStorageType", + "traits": { + "smithy.api#documentation": "The Timestream for InfluxDB DB storage type that InfluxDB stores data on.
" + } + }, + "allocatedStorage": { + "target": "com.amazonaws.timestreaminfluxdb#AllocatedStorage", + "traits": { + "smithy.api#documentation": "The amount of storage allocated for your DB storage type (in gibibytes).
" + } + }, + "deploymentType": { + "target": "com.amazonaws.timestreaminfluxdb#DeploymentType", + "traits": { + "smithy.api#documentation": "Specifies whether the Timestream for InfluxDB is deployed as Single-AZ or with a MultiAZ Standby for High availability.
" + } + }, + "vpcSubnetIds": { + "target": "com.amazonaws.timestreaminfluxdb#VpcSubnetIdList", + "traits": { + "smithy.api#documentation": "A list of VPC subnet IDs associated with the DB instance.
", + "smithy.api#required": {} + } + }, + "publiclyAccessible": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Indicates if the DB instance has a public IP to facilitate access.
" + } + }, + "vpcSecurityGroupIds": { + "target": "com.amazonaws.timestreaminfluxdb#VpcSecurityGroupIdList", + "traits": { + "smithy.api#documentation": "A list of VPC security group IDs associated with the DB instance.
" + } + }, + "dbParameterGroupIdentifier": { + "target": "com.amazonaws.timestreaminfluxdb#DbParameterGroupIdentifier", + "traits": { + "smithy.api#documentation": "The id of the DB parameter group assigned to your DB instance.
" + } + }, + "availabilityZone": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The Availability Zone in which the DB instance resides.
" + } + }, + "secondaryAvailabilityZone": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The Availability Zone in which the standby instance is located when deploying with a MultiAZ standby instance.
" + } + }, + "logDeliveryConfiguration": { + "target": "com.amazonaws.timestreaminfluxdb#LogDeliveryConfiguration", + "traits": { + "smithy.api#documentation": "Configuration for sending InfluxDB engine logs to send to specified S3 bucket.
" + } + }, + "influxAuthParametersSecretArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AWS Secrets Manager secret containing the initial InfluxDB authorization parameters. The secret value is a JSON formatted key-value pair holding InfluxDB authorization values: organization, bucket, username, and password.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.timestreaminfluxdb#Username": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.timestreaminfluxdb#ValidationException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + }, + "reason": { + "target": "com.amazonaws.timestreaminfluxdb#ValidationExceptionReason", + "traits": { + "smithy.api#documentation": "The reason that validation failed.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The input fails to satisfy the constraints specified by Timestream for InfluxDB.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.timestreaminfluxdb#ValidationExceptionReason": { + "type": "enum", + "members": { + "FIELD_VALIDATION_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FIELD_VALIDATION_FAILED" + } + }, + "OTHER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OTHER" + } + } + } + }, + "com.amazonaws.timestreaminfluxdb#VpcSecurityGroupId": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 64 + }, + "smithy.api#pattern": "^sg-[a-z0-9]+$" + } + }, + "com.amazonaws.timestreaminfluxdb#VpcSecurityGroupIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.timestreaminfluxdb#VpcSecurityGroupId" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.timestreaminfluxdb#VpcSubnetId": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 64 + }, + "smithy.api#pattern": "^subnet-[a-z0-9]+$" + } + }, + "com.amazonaws.timestreaminfluxdb#VpcSubnetIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.timestreaminfluxdb#VpcSubnetId" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 3 + } + } + } + } +}