Skip to content

Commit

Permalink
feat(client-kinesis-analytics-v2): This release adds support for new …
Browse files Browse the repository at this point in the history
…ListApplicationOperations and DescribeApplicationOperation APIs. It adds a new configuration to enable system rollbacks, adds field ApplicationVersionCreateTimestamp for clarity and improves support for pagination for APIs.
  • Loading branch information
awstools committed Jun 26, 2024
1 parent 3520f1a commit 07be7ea
Show file tree
Hide file tree
Showing 29 changed files with 1,446 additions and 37 deletions.
16 changes: 16 additions & 0 deletions clients/client-kinesis-analytics-v2/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -343,6 +343,14 @@ DescribeApplication

[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/kinesis-analytics-v2/command/DescribeApplicationCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-kinesis-analytics-v2/Interface/DescribeApplicationCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-kinesis-analytics-v2/Interface/DescribeApplicationCommandOutput/)

</details>
<details>
<summary>
DescribeApplicationOperation
</summary>

[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/kinesis-analytics-v2/command/DescribeApplicationOperationCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-kinesis-analytics-v2/Interface/DescribeApplicationOperationCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-kinesis-analytics-v2/Interface/DescribeApplicationOperationCommandOutput/)

</details>
<details>
<summary>
Expand All @@ -367,6 +375,14 @@ DiscoverInputSchema

[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/kinesis-analytics-v2/command/DiscoverInputSchemaCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-kinesis-analytics-v2/Interface/DiscoverInputSchemaCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-kinesis-analytics-v2/Interface/DiscoverInputSchemaCommandOutput/)

</details>
<details>
<summary>
ListApplicationOperations
</summary>

[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/kinesis-analytics-v2/command/ListApplicationOperationsCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-kinesis-analytics-v2/Interface/ListApplicationOperationsCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-kinesis-analytics-v2/Interface/ListApplicationOperationsCommandOutput/)

</details>
<details>
<summary>
Expand Down
46 changes: 46 additions & 0 deletions clients/client-kinesis-analytics-v2/src/KinesisAnalyticsV2.ts
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,11 @@ import {
DescribeApplicationCommandInput,
DescribeApplicationCommandOutput,
} from "./commands/DescribeApplicationCommand";
import {
DescribeApplicationOperationCommand,
DescribeApplicationOperationCommandInput,
DescribeApplicationOperationCommandOutput,
} from "./commands/DescribeApplicationOperationCommand";
import {
DescribeApplicationSnapshotCommand,
DescribeApplicationSnapshotCommandInput,
Expand All @@ -102,6 +107,11 @@ import {
DiscoverInputSchemaCommandInput,
DiscoverInputSchemaCommandOutput,
} from "./commands/DiscoverInputSchemaCommand";
import {
ListApplicationOperationsCommand,
ListApplicationOperationsCommandInput,
ListApplicationOperationsCommandOutput,
} from "./commands/ListApplicationOperationsCommand";
import {
ListApplicationsCommand,
ListApplicationsCommandInput,
Expand Down Expand Up @@ -173,9 +183,11 @@ const commands = {
DeleteApplicationSnapshotCommand,
DeleteApplicationVpcConfigurationCommand,
DescribeApplicationCommand,
DescribeApplicationOperationCommand,
DescribeApplicationSnapshotCommand,
DescribeApplicationVersionCommand,
DiscoverInputSchemaCommand,
ListApplicationOperationsCommand,
ListApplicationsCommand,
ListApplicationSnapshotsCommand,
ListApplicationVersionsCommand,
Expand Down Expand Up @@ -479,6 +491,23 @@ export interface KinesisAnalyticsV2 {
cb: (err: any, data?: DescribeApplicationCommandOutput) => void
): void;

/**
* @see {@link DescribeApplicationOperationCommand}
*/
describeApplicationOperation(
args: DescribeApplicationOperationCommandInput,
options?: __HttpHandlerOptions
): Promise<DescribeApplicationOperationCommandOutput>;
describeApplicationOperation(
args: DescribeApplicationOperationCommandInput,
cb: (err: any, data?: DescribeApplicationOperationCommandOutput) => void
): void;
describeApplicationOperation(
args: DescribeApplicationOperationCommandInput,
options: __HttpHandlerOptions,
cb: (err: any, data?: DescribeApplicationOperationCommandOutput) => void
): void;

/**
* @see {@link DescribeApplicationSnapshotCommand}
*/
Expand Down Expand Up @@ -530,6 +559,23 @@ export interface KinesisAnalyticsV2 {
cb: (err: any, data?: DiscoverInputSchemaCommandOutput) => void
): void;

/**
* @see {@link ListApplicationOperationsCommand}
*/
listApplicationOperations(
args: ListApplicationOperationsCommandInput,
options?: __HttpHandlerOptions
): Promise<ListApplicationOperationsCommandOutput>;
listApplicationOperations(
args: ListApplicationOperationsCommandInput,
cb: (err: any, data?: ListApplicationOperationsCommandOutput) => void
): void;
listApplicationOperations(
args: ListApplicationOperationsCommandInput,
options: __HttpHandlerOptions,
cb: (err: any, data?: ListApplicationOperationsCommandOutput) => void
): void;

/**
* @see {@link ListApplicationsCommand}
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,10 @@ import {
DescribeApplicationCommandInput,
DescribeApplicationCommandOutput,
} from "./commands/DescribeApplicationCommand";
import {
DescribeApplicationOperationCommandInput,
DescribeApplicationOperationCommandOutput,
} from "./commands/DescribeApplicationOperationCommand";
import {
DescribeApplicationSnapshotCommandInput,
DescribeApplicationSnapshotCommandOutput,
Expand All @@ -127,6 +131,10 @@ import {
DiscoverInputSchemaCommandInput,
DiscoverInputSchemaCommandOutput,
} from "./commands/DiscoverInputSchemaCommand";
import {
ListApplicationOperationsCommandInput,
ListApplicationOperationsCommandOutput,
} from "./commands/ListApplicationOperationsCommand";
import { ListApplicationsCommandInput, ListApplicationsCommandOutput } from "./commands/ListApplicationsCommand";
import {
ListApplicationSnapshotsCommandInput,
Expand Down Expand Up @@ -185,9 +193,11 @@ export type ServiceInputTypes =
| DeleteApplicationSnapshotCommandInput
| DeleteApplicationVpcConfigurationCommandInput
| DescribeApplicationCommandInput
| DescribeApplicationOperationCommandInput
| DescribeApplicationSnapshotCommandInput
| DescribeApplicationVersionCommandInput
| DiscoverInputSchemaCommandInput
| ListApplicationOperationsCommandInput
| ListApplicationSnapshotsCommandInput
| ListApplicationVersionsCommandInput
| ListApplicationsCommandInput
Expand Down Expand Up @@ -221,9 +231,11 @@ export type ServiceOutputTypes =
| DeleteApplicationSnapshotCommandOutput
| DeleteApplicationVpcConfigurationCommandOutput
| DescribeApplicationCommandOutput
| DescribeApplicationOperationCommandOutput
| DescribeApplicationSnapshotCommandOutput
| DescribeApplicationVersionCommandOutput
| DiscoverInputSchemaCommandOutput
| ListApplicationOperationsCommandOutput
| ListApplicationSnapshotsCommandOutput
| ListApplicationVersionsCommandOutput
| ListApplicationsCommandOutput
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,7 @@ export interface AddApplicationCloudWatchLoggingOptionCommandOutput
* // RoleARN: "STRING_VALUE",
* // },
* // ],
* // OperationId: "STRING_VALUE",
* // };
*
* ```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,7 @@ export interface AddApplicationVpcConfigurationCommandOutput
* // "STRING_VALUE",
* // ],
* // },
* // OperationId: "STRING_VALUE",
* // };
*
* ```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -182,6 +182,9 @@ export interface CreateApplicationCommandOutput extends CreateApplicationRespons
* ApplicationSnapshotConfiguration: { // ApplicationSnapshotConfiguration
* SnapshotsEnabled: true || false, // required
* },
* ApplicationSystemRollbackConfiguration: { // ApplicationSystemRollbackConfiguration
* RollbackEnabled: true || false, // required
* },
* VpcConfigurations: [ // VpcConfigurations
* { // VpcConfiguration
* SubnetIds: [ // SubnetIds // required
Expand Down Expand Up @@ -414,6 +417,9 @@ export interface CreateApplicationCommandOutput extends CreateApplicationRespons
* // ApplicationSnapshotConfigurationDescription: { // ApplicationSnapshotConfigurationDescription
* // SnapshotsEnabled: true || false, // required
* // },
* // ApplicationSystemRollbackConfigurationDescription: { // ApplicationSystemRollbackConfigurationDescription
* // RollbackEnabled: true || false, // required
* // },
* // VpcConfigurationDescriptions: [ // VpcConfigurationDescriptions
* // { // VpcConfigurationDescription
* // VpcConfigurationId: "STRING_VALUE", // required
Expand Down Expand Up @@ -471,6 +477,7 @@ export interface CreateApplicationCommandOutput extends CreateApplicationRespons
* // },
* // ApplicationVersionUpdatedFrom: Number("long"),
* // ApplicationVersionRolledBackFrom: Number("long"),
* // ApplicationVersionCreateTimestamp: new Date("TIMESTAMP"),
* // ConditionalToken: "STRING_VALUE",
* // ApplicationVersionRolledBackTo: Number("long"),
* // ApplicationMode: "STREAMING" || "INTERACTIVE",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,13 +39,13 @@ export interface CreateApplicationPresignedUrlCommandOutput
/**
* <p>Creates and returns a URL that you can use to connect to
* an application's extension.</p>
* <p>The IAM role or user used to call this API defines the permissions to access the
* <p>The IAM role or user used to call this API defines the permissions to access the
* extension. After the presigned URL is created, no additional permission is required to access
* this URL. IAM authorization policies for this API are also enforced for every HTTP request
* that attempts to connect to the extension. </p>
* <p>You control the amount of time that the URL will be valid using the <code>SessionExpirationDurationInSeconds</code>
* <p>You control the amount of time that the URL will be valid using the <code>SessionExpirationDurationInSeconds</code>
* parameter. If you do not provide this parameter, the returned URL is valid for twelve hours.</p>
* <note>
* <note>
* <p>The URL that you get from a call to CreateApplicationPresignedUrl must be used within 3 minutes
* to be valid.
* If you first try to use the URL after the 3-minute limit expires, the service returns an HTTP 403 Forbidden error.</p>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,7 @@ export interface DeleteApplicationCloudWatchLoggingOptionCommandOutput
* // RoleARN: "STRING_VALUE",
* // },
* // ],
* // OperationId: "STRING_VALUE",
* // };
*
* ```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,7 @@ export interface DeleteApplicationVpcConfigurationCommandOutput
* // { // DeleteApplicationVpcConfigurationResponse
* // ApplicationARN: "STRING_VALUE",
* // ApplicationVersionId: Number("long"),
* // OperationId: "STRING_VALUE",
* // };
*
* ```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -222,6 +222,9 @@ export interface DescribeApplicationCommandOutput extends DescribeApplicationRes
* // ApplicationSnapshotConfigurationDescription: { // ApplicationSnapshotConfigurationDescription
* // SnapshotsEnabled: true || false, // required
* // },
* // ApplicationSystemRollbackConfigurationDescription: { // ApplicationSystemRollbackConfigurationDescription
* // RollbackEnabled: true || false, // required
* // },
* // VpcConfigurationDescriptions: [ // VpcConfigurationDescriptions
* // { // VpcConfigurationDescription
* // VpcConfigurationId: "STRING_VALUE", // required
Expand Down Expand Up @@ -279,6 +282,7 @@ export interface DescribeApplicationCommandOutput extends DescribeApplicationRes
* // },
* // ApplicationVersionUpdatedFrom: Number("long"),
* // ApplicationVersionRolledBackFrom: Number("long"),
* // ApplicationVersionCreateTimestamp: new Date("TIMESTAMP"),
* // ConditionalToken: "STRING_VALUE",
* // ApplicationVersionRolledBackTo: Number("long"),
* // ApplicationMode: "STREAMING" || "INTERACTIVE",
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,117 @@
// 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 {
KinesisAnalyticsV2ClientResolvedConfig,
ServiceInputTypes,
ServiceOutputTypes,
} from "../KinesisAnalyticsV2Client";
import { DescribeApplicationOperationRequest, DescribeApplicationOperationResponse } from "../models/models_0";
import {
de_DescribeApplicationOperationCommand,
se_DescribeApplicationOperationCommand,
} from "../protocols/Aws_json1_1";

/**
* @public
*/
export type { __MetadataBearer };
export { $Command };
/**
* @public
*
* The input for {@link DescribeApplicationOperationCommand}.
*/
export interface DescribeApplicationOperationCommandInput extends DescribeApplicationOperationRequest {}
/**
* @public
*
* The output of {@link DescribeApplicationOperationCommand}.
*/
export interface DescribeApplicationOperationCommandOutput
extends DescribeApplicationOperationResponse,
__MetadataBearer {}

/**
* Returns information about a specific operation performed on a Managed Service for Apache Flink application
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
* import { KinesisAnalyticsV2Client, DescribeApplicationOperationCommand } from "@aws-sdk/client-kinesis-analytics-v2"; // ES Modules import
* // const { KinesisAnalyticsV2Client, DescribeApplicationOperationCommand } = require("@aws-sdk/client-kinesis-analytics-v2"); // CommonJS import
* const client = new KinesisAnalyticsV2Client(config);
* const input = { // DescribeApplicationOperationRequest
* ApplicationName: "STRING_VALUE", // required
* OperationId: "STRING_VALUE", // required
* };
* const command = new DescribeApplicationOperationCommand(input);
* const response = await client.send(command);
* // { // DescribeApplicationOperationResponse
* // ApplicationOperationInfoDetails: { // ApplicationOperationInfoDetails
* // Operation: "STRING_VALUE", // required
* // StartTime: new Date("TIMESTAMP"), // required
* // EndTime: new Date("TIMESTAMP"), // required
* // OperationStatus: "IN_PROGRESS" || "CANCELLED" || "SUCCESSFUL" || "FAILED", // required
* // ApplicationVersionChangeDetails: { // ApplicationVersionChangeDetails
* // ApplicationVersionUpdatedFrom: Number("long"), // required
* // ApplicationVersionUpdatedTo: Number("long"), // required
* // },
* // OperationFailureDetails: { // OperationFailureDetails
* // RollbackOperationId: "STRING_VALUE",
* // ErrorInfo: { // ErrorInfo
* // ErrorString: "STRING_VALUE",
* // },
* // },
* // },
* // };
*
* ```
*
* @param DescribeApplicationOperationCommandInput - {@link DescribeApplicationOperationCommandInput}
* @returns {@link DescribeApplicationOperationCommandOutput}
* @see {@link DescribeApplicationOperationCommandInput} for command's `input` shape.
* @see {@link DescribeApplicationOperationCommandOutput} for command's `response` shape.
* @see {@link KinesisAnalyticsV2ClientResolvedConfig | config} for KinesisAnalyticsV2Client's `config` shape.
*
* @throws {@link InvalidArgumentException} (client fault)
* <p>The specified input parameter value is not valid.</p>
*
* @throws {@link ResourceNotFoundException} (client fault)
* <p>Specified application can't be found.</p>
*
* @throws {@link UnsupportedOperationException} (client fault)
* <p>The request was rejected because a specified parameter is not supported or a specified resource is not valid for this
* operation. </p>
*
* @throws {@link KinesisAnalyticsV2ServiceException}
* <p>Base exception class for all service exceptions from KinesisAnalyticsV2 service.</p>
*
* @public
*/
export class DescribeApplicationOperationCommand extends $Command
.classBuilder<
DescribeApplicationOperationCommandInput,
DescribeApplicationOperationCommandOutput,
KinesisAnalyticsV2ClientResolvedConfig,
ServiceInputTypes,
ServiceOutputTypes
>()
.ep({
...commonParams,
})
.m(function (this: any, Command: any, cs: any, config: KinesisAnalyticsV2ClientResolvedConfig, o: any) {
return [
getSerdePlugin(config, this.serialize, this.deserialize),
getEndpointPlugin(config, Command.getEndpointParameterInstructions()),
];
})
.s("KinesisAnalytics_20180523", "DescribeApplicationOperation", {})
.n("KinesisAnalyticsV2Client", "DescribeApplicationOperationCommand")
.f(void 0, void 0)
.ser(se_DescribeApplicationOperationCommand)
.de(de_DescribeApplicationOperationCommand)
.build() {}
Original file line number Diff line number Diff line change
Expand Up @@ -223,6 +223,9 @@ export interface DescribeApplicationVersionCommandOutput extends DescribeApplica
* // ApplicationSnapshotConfigurationDescription: { // ApplicationSnapshotConfigurationDescription
* // SnapshotsEnabled: true || false, // required
* // },
* // ApplicationSystemRollbackConfigurationDescription: { // ApplicationSystemRollbackConfigurationDescription
* // RollbackEnabled: true || false, // required
* // },
* // VpcConfigurationDescriptions: [ // VpcConfigurationDescriptions
* // { // VpcConfigurationDescription
* // VpcConfigurationId: "STRING_VALUE", // required
Expand Down Expand Up @@ -280,6 +283,7 @@ export interface DescribeApplicationVersionCommandOutput extends DescribeApplica
* // },
* // ApplicationVersionUpdatedFrom: Number("long"),
* // ApplicationVersionRolledBackFrom: Number("long"),
* // ApplicationVersionCreateTimestamp: new Date("TIMESTAMP"),
* // ConditionalToken: "STRING_VALUE",
* // ApplicationVersionRolledBackTo: Number("long"),
* // ApplicationMode: "STREAMING" || "INTERACTIVE",
Expand Down
Loading

0 comments on commit 07be7ea

Please sign in to comment.