From 63d7f8c539e0fd782fa5bf997bd6ac2730e4bfda Mon Sep 17 00:00:00 2001 From: AllanZhengYP Date: Fri, 4 Feb 2022 13:10:52 -0800 Subject: [PATCH] feat(clients): update clients as of 02/04/2022 (#3280) * chore(models): update models as of 02/04/2022 * chore(endpoints): update endpoints as of 02/04/2022 * feat(clients): update clients as of 02/04/2022 --- clients/client-appflow/src/Appflow.ts | 162 +- clients/client-appflow/src/AppflowClient.ts | 15 + .../commands/CreateConnectorProfileCommand.ts | 8 +- .../src/commands/DescribeConnectorCommand.ts | 97 + .../src/commands/ListConnectorsCommand.ts | 97 + .../src/commands/RegisterConnectorCommand.ts | 96 + .../commands/UnregisterConnectorCommand.ts | 96 + clients/client-appflow/src/commands/index.ts | 4 + clients/client-appflow/src/models/models_0.ts | 1137 +++++++++- .../pagination/DescribeConnectorsPaginator.ts | 1 + .../src/pagination/ListConnectorsPaginator.ts | 59 + .../client-appflow/src/pagination/index.ts | 1 + .../src/protocols/Aws_restJson1.ts | 1295 +++++++++++- clients/client-athena/src/Athena.ts | 6 + .../src/commands/GetQueryResultsCommand.ts | 6 + clients/client-athena/src/models/models_0.ts | 44 +- .../src/protocols/Aws_json1_1.ts | 7 + clients/client-comprehend/src/Comprehend.ts | 149 +- .../client-comprehend/src/ComprehendClient.ts | 18 + .../src/commands/CreateEndpointCommand.ts | 3 +- .../commands/DeleteResourcePolicyCommand.ts | 95 + .../commands/DescribeResourcePolicyCommand.ts | 96 + .../src/commands/ImportModelCommand.ts | 100 + .../src/commands/PutResourcePolicyCommand.ts | 97 + .../client-comprehend/src/commands/index.ts | 4 + .../client-comprehend/src/models/models_0.ts | 368 +++- .../src/protocols/Aws_json1_1.ts | 488 +++++ .../client-cost-explorer/src/CostExplorer.ts | 8 - .../GetSavingsPlansCoverageCommand.ts | 4 - .../GetSavingsPlansUtilizationCommand.ts | 2 - ...etSavingsPlansUtilizationDetailsCommand.ts | 2 - .../src/models/models_0.ts | 55 +- clients/client-dynamodb/src/DynamoDB.ts | 12 +- .../src/commands/BatchWriteItemCommand.ts | 8 +- .../UpdateContributorInsightsCommand.ts | 4 +- .../client-dynamodb/src/models/models_0.ts | 4 - clients/client-ec2/src/EC2.ts | 104 +- clients/client-ec2/src/EC2Client.ts | 12 + .../src/commands/CreateImageCommand.ts | 6 + .../src/commands/DeregisterImageCommand.ts | 16 +- .../src/commands/DisableFastLaunchCommand.ts | 3 + .../src/commands/EnableFastLaunchCommand.ts | 3 + .../commands/ListImagesInRecycleBinCommand.ts | 97 + .../commands/ResetInstanceAttributeCommand.ts | 2 +- .../ResetNetworkInterfaceAttributeCommand.ts | 2 +- .../commands/ResetSnapshotAttributeCommand.ts | 2 +- .../RestoreImageFromRecycleBinCommand.ts | 98 + clients/client-ec2/src/commands/index.ts | 2 + clients/client-ec2/src/models/models_0.ts | 30 + clients/client-ec2/src/models/models_2.ts | 27 + clients/client-ec2/src/models/models_4.ts | 2 +- clients/client-ec2/src/models/models_5.ts | 204 +- clients/client-ec2/src/models/models_6.ts | 139 +- .../ListImagesInRecycleBinPaginator.ts | 59 + clients/client-ec2/src/pagination/index.ts | 1 + clients/client-ec2/src/protocols/Aws_ec2.ts | 254 ++- .../client-elasticache/src/models/models_0.ts | 7 +- .../src/ElasticsearchService.ts | 38 + .../src/ElasticsearchServiceClient.ts | 6 + .../DescribeDomainChangeProgressCommand.ts | 105 + .../src/commands/index.ts | 1 + .../src/models/models_0.ts | 179 ++ .../src/protocols/Aws_restJson1.ts | 195 ++ clients/client-emr/src/EMR.ts | 15 +- .../src/commands/AddJobFlowStepsCommand.ts | 3 + .../PutAutoTerminationPolicyCommand.ts | 5 +- .../commands/SetVisibleToAllUsersCommand.ts | 7 +- clients/client-emr/src/models/models_0.ts | 26 +- clients/client-fis/src/Fis.ts | 74 + clients/client-fis/src/FisClient.ts | 12 + .../commands/GetTargetResourceTypeCommand.ts | 95 + .../ListTargetResourceTypesCommand.ts | 95 + clients/client-fis/src/commands/index.ts | 2 + clients/client-fis/src/models/models_0.ts | 176 +- .../ListTargetResourceTypesPaginator.ts | 59 + clients/client-fis/src/pagination/index.ts | 1 + .../client-fis/src/protocols/Aws_restJson1.ts | 313 +++ clients/client-glue/src/models/models_0.ts | 7 +- clients/client-glue/src/models/models_1.ts | 6 +- .../client-glue/src/protocols/Aws_json1_1.ts | 16 + clients/client-iot/src/models/models_1.ts | 3 + .../src/models/models_0.ts | 2 +- clients/client-marketplace-metering/README.md | 57 +- .../src/MarketplaceMetering.ts | 195 +- .../src/MarketplaceMeteringClient.ts | 58 +- .../src/commands/BatchMeterUsageCommand.ts | 38 +- .../src/commands/MeterUsageCommand.ts | 18 +- .../src/commands/RegisterUsageCommand.ts | 63 +- .../src/commands/ResolveCustomerCommand.ts | 18 +- .../src/models/models_0.ts | 226 +- .../src/protocols/Aws_json1_1.ts | 1 + clients/client-personalize/src/Personalize.ts | 23 + .../src/commands/CreateRecommenderCommand.ts | 23 + .../client-personalize/src/models/models_0.ts | 10 +- .../src/protocols/Aws_json1_1.ts | 5 + clients/client-rbin/README.md | 20 +- clients/client-rbin/src/Rbin.ts | 30 +- clients/client-rbin/src/RbinClient.ts | 18 +- .../src/commands/CreateRuleCommand.ts | 2 +- .../src/commands/DeleteRuleCommand.ts | 2 +- .../commands/ListTagsForResourceCommand.ts | 2 +- .../src/commands/TagResourceCommand.ts | 2 +- .../src/commands/UntagResourceCommand.ts | 2 +- .../src/commands/UpdateRuleCommand.ts | 2 +- clients/client-rbin/src/models/models_0.ts | 104 +- clients/client-rds/src/RDS.ts | 11 +- .../CreateCustomDBEngineVersionCommand.ts | 11 +- clients/client-rds/src/models/models_0.ts | 28 +- clients/client-rds/src/models/models_1.ts | 32 +- clients/client-robomaker/src/RoboMaker.ts | 87 +- .../commands/CancelDeploymentJobCommand.ts | 5 + .../commands/CreateDeploymentJobCommand.ts | 5 + .../src/commands/CreateFleetCommand.ts | 5 + .../src/commands/CreateRobotCommand.ts | 5 + .../src/commands/DeleteFleetCommand.ts | 5 + .../src/commands/DeleteRobotCommand.ts | 5 + .../src/commands/DeregisterRobotCommand.ts | 5 + .../commands/DescribeDeploymentJobCommand.ts | 5 + .../src/commands/DescribeFleetCommand.ts | 5 + .../src/commands/DescribeRobotCommand.ts | 5 + .../src/commands/ListDeploymentJobsCommand.ts | 8 +- .../src/commands/ListFleetsCommand.ts | 8 +- .../src/commands/ListRobotsCommand.ts | 8 +- .../src/commands/RegisterRobotCommand.ts | 5 + .../src/commands/SyncDeploymentJobCommand.ts | 8 +- codegen/sdk-codegen/aws-models/appflow.json | 1855 +++++++++++++++-- codegen/sdk-codegen/aws-models/athena.json | 24 +- .../sdk-codegen/aws-models/comprehend.json | 392 +++- .../sdk-codegen/aws-models/cost-explorer.json | 32 +- codegen/sdk-codegen/aws-models/dynamodb.json | 6 +- codegen/sdk-codegen/aws-models/ec2.json | 235 ++- .../sdk-codegen/aws-models/elasticache.json | 6 +- .../aws-models/elasticsearch-service.json | 245 +++ codegen/sdk-codegen/aws-models/emr.json | 62 +- codegen/sdk-codegen/aws-models/fis.json | 348 +++- codegen/sdk-codegen/aws-models/glue.json | 22 +- codegen/sdk-codegen/aws-models/iot.json | 12 + .../sdk-codegen/aws-models/lakeformation.json | 3 +- .../aws-models/marketplace-metering.json | 146 +- .../sdk-codegen/aws-models/personalize.json | 12 +- codegen/sdk-codegen/aws-models/rbin.json | 80 +- codegen/sdk-codegen/aws-models/rds.json | 34 +- codegen/sdk-codegen/aws-models/robomaker.json | 263 ++- .../aws/typescript/codegen/endpoints.json | 55 + 144 files changed, 10989 insertions(+), 1177 deletions(-) create mode 100644 clients/client-appflow/src/commands/DescribeConnectorCommand.ts create mode 100644 clients/client-appflow/src/commands/ListConnectorsCommand.ts create mode 100644 clients/client-appflow/src/commands/RegisterConnectorCommand.ts create mode 100644 clients/client-appflow/src/commands/UnregisterConnectorCommand.ts create mode 100644 clients/client-appflow/src/pagination/ListConnectorsPaginator.ts create mode 100644 clients/client-comprehend/src/commands/DeleteResourcePolicyCommand.ts create mode 100644 clients/client-comprehend/src/commands/DescribeResourcePolicyCommand.ts create mode 100644 clients/client-comprehend/src/commands/ImportModelCommand.ts create mode 100644 clients/client-comprehend/src/commands/PutResourcePolicyCommand.ts create mode 100644 clients/client-ec2/src/commands/ListImagesInRecycleBinCommand.ts create mode 100644 clients/client-ec2/src/commands/RestoreImageFromRecycleBinCommand.ts create mode 100644 clients/client-ec2/src/pagination/ListImagesInRecycleBinPaginator.ts create mode 100644 clients/client-elasticsearch-service/src/commands/DescribeDomainChangeProgressCommand.ts create mode 100644 clients/client-fis/src/commands/GetTargetResourceTypeCommand.ts create mode 100644 clients/client-fis/src/commands/ListTargetResourceTypesCommand.ts create mode 100644 clients/client-fis/src/pagination/ListTargetResourceTypesPaginator.ts diff --git a/clients/client-appflow/src/Appflow.ts b/clients/client-appflow/src/Appflow.ts index 9e93505048b08..6e1e8fb73174a 100644 --- a/clients/client-appflow/src/Appflow.ts +++ b/clients/client-appflow/src/Appflow.ts @@ -13,6 +13,11 @@ import { DeleteConnectorProfileCommandOutput, } from "./commands/DeleteConnectorProfileCommand"; import { DeleteFlowCommand, DeleteFlowCommandInput, DeleteFlowCommandOutput } from "./commands/DeleteFlowCommand"; +import { + DescribeConnectorCommand, + DescribeConnectorCommandInput, + DescribeConnectorCommandOutput, +} from "./commands/DescribeConnectorCommand"; import { DescribeConnectorEntityCommand, DescribeConnectorEntityCommandInput, @@ -43,15 +48,30 @@ import { ListConnectorEntitiesCommandInput, ListConnectorEntitiesCommandOutput, } from "./commands/ListConnectorEntitiesCommand"; +import { + ListConnectorsCommand, + ListConnectorsCommandInput, + ListConnectorsCommandOutput, +} from "./commands/ListConnectorsCommand"; import { ListFlowsCommand, ListFlowsCommandInput, ListFlowsCommandOutput } from "./commands/ListFlowsCommand"; import { ListTagsForResourceCommand, ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput, } from "./commands/ListTagsForResourceCommand"; +import { + RegisterConnectorCommand, + RegisterConnectorCommandInput, + RegisterConnectorCommandOutput, +} from "./commands/RegisterConnectorCommand"; import { StartFlowCommand, StartFlowCommandInput, StartFlowCommandOutput } from "./commands/StartFlowCommand"; import { StopFlowCommand, StopFlowCommandInput, StopFlowCommandOutput } from "./commands/StopFlowCommand"; import { TagResourceCommand, TagResourceCommandInput, TagResourceCommandOutput } from "./commands/TagResourceCommand"; +import { + UnregisterConnectorCommand, + UnregisterConnectorCommandInput, + UnregisterConnectorCommandOutput, +} from "./commands/UnregisterConnectorCommand"; import { UntagResourceCommand, UntagResourceCommandInput, @@ -109,10 +129,10 @@ import { UpdateFlowCommand, UpdateFlowCommandInput, UpdateFlowCommandOutput } fr */ export class Appflow extends AppflowClient { /** - *

Creates a new connector profile associated with your Amazon Web Services account. There is a soft quota - * of 100 connector profiles per Amazon Web Services account. If you need more connector profiles than this quota - * allows, you can submit a request to the Amazon AppFlow team through the Amazon AppFlow support - * channel.

+ *

Creates a new connector profile associated with your Amazon Web Services account. There + * is a soft quota of 100 connector profiles per Amazon Web Services account. If you need more + * connector profiles than this quota allows, you can submit a request to the Amazon AppFlow team + * through the Amazon AppFlow support channel.

*/ public createConnectorProfile( args: CreateConnectorProfileCommandInput, @@ -232,6 +252,40 @@ export class Appflow extends AppflowClient { } } + /** + *

Describes the given custom connector registered in your Amazon Web Services account. This + * API can be used for custom connectors that are registered in your account and also for Amazon + * authored connectors.

+ */ + public describeConnector( + args: DescribeConnectorCommandInput, + options?: __HttpHandlerOptions + ): Promise; + public describeConnector( + args: DescribeConnectorCommandInput, + cb: (err: any, data?: DescribeConnectorCommandOutput) => void + ): void; + public describeConnector( + args: DescribeConnectorCommandInput, + options: __HttpHandlerOptions, + cb: (err: any, data?: DescribeConnectorCommandOutput) => void + ): void; + public describeConnector( + args: DescribeConnectorCommandInput, + optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeConnectorCommandOutput) => void), + cb?: (err: any, data?: DescribeConnectorCommandOutput) => void + ): Promise | void { + const command = new DescribeConnectorCommand(args); + if (typeof optionsOrCb === "function") { + this.send(command, optionsOrCb); + } else if (typeof cb === "function") { + if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); + this.send(command, optionsOrCb || {}, cb); + } else { + return this.send(command, optionsOrCb); + } + } + /** *

Provides details regarding the entity used with the connector, with a description of the * data model for each entity.

@@ -433,6 +487,40 @@ export class Appflow extends AppflowClient { } } + /** + *

Returns the list of all registered custom connectors in your Amazon Web Services account. + * This API lists only custom connectors registered in this account, not the Amazon Web Services + * authored connectors.

+ */ + public listConnectors( + args: ListConnectorsCommandInput, + options?: __HttpHandlerOptions + ): Promise; + public listConnectors( + args: ListConnectorsCommandInput, + cb: (err: any, data?: ListConnectorsCommandOutput) => void + ): void; + public listConnectors( + args: ListConnectorsCommandInput, + options: __HttpHandlerOptions, + cb: (err: any, data?: ListConnectorsCommandOutput) => void + ): void; + public listConnectors( + args: ListConnectorsCommandInput, + optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListConnectorsCommandOutput) => void), + cb?: (err: any, data?: ListConnectorsCommandOutput) => void + ): Promise | void { + const command = new ListConnectorsCommand(args); + if (typeof optionsOrCb === "function") { + this.send(command, optionsOrCb); + } else if (typeof cb === "function") { + if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); + this.send(command, optionsOrCb || {}, cb); + } else { + return this.send(command, optionsOrCb); + } + } + /** *

Lists all of the flows associated with your account.

*/ @@ -491,6 +579,39 @@ export class Appflow extends AppflowClient { } } + /** + *

Registers a new connector with your Amazon Web Services account. Before you can register + * the connector, you must deploy lambda in your account.

+ */ + public registerConnector( + args: RegisterConnectorCommandInput, + options?: __HttpHandlerOptions + ): Promise; + public registerConnector( + args: RegisterConnectorCommandInput, + cb: (err: any, data?: RegisterConnectorCommandOutput) => void + ): void; + public registerConnector( + args: RegisterConnectorCommandInput, + options: __HttpHandlerOptions, + cb: (err: any, data?: RegisterConnectorCommandOutput) => void + ): void; + public registerConnector( + args: RegisterConnectorCommandInput, + optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RegisterConnectorCommandOutput) => void), + cb?: (err: any, data?: RegisterConnectorCommandOutput) => void + ): Promise | void { + const command = new RegisterConnectorCommand(args); + if (typeof optionsOrCb === "function") { + this.send(command, optionsOrCb); + } else if (typeof cb === "function") { + if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); + this.send(command, optionsOrCb || {}, cb); + } else { + return this.send(command, optionsOrCb); + } + } + /** *

Activates an existing flow. For on-demand flows, this operation runs the flow * immediately. For schedule and event-triggered flows, this operation activates the flow.

@@ -572,6 +693,39 @@ export class Appflow extends AppflowClient { } } + /** + *

Unregisters the custom connector registered in your account that matches the + * connectorLabel provided in the request.

+ */ + public unregisterConnector( + args: UnregisterConnectorCommandInput, + options?: __HttpHandlerOptions + ): Promise; + public unregisterConnector( + args: UnregisterConnectorCommandInput, + cb: (err: any, data?: UnregisterConnectorCommandOutput) => void + ): void; + public unregisterConnector( + args: UnregisterConnectorCommandInput, + options: __HttpHandlerOptions, + cb: (err: any, data?: UnregisterConnectorCommandOutput) => void + ): void; + public unregisterConnector( + args: UnregisterConnectorCommandInput, + optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UnregisterConnectorCommandOutput) => void), + cb?: (err: any, data?: UnregisterConnectorCommandOutput) => void + ): Promise | void { + const command = new UnregisterConnectorCommand(args); + if (typeof optionsOrCb === "function") { + this.send(command, optionsOrCb); + } else if (typeof cb === "function") { + if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); + this.send(command, optionsOrCb || {}, cb); + } else { + return this.send(command, optionsOrCb); + } + } + /** *

Removes a tag from the specified flow.

*/ diff --git a/clients/client-appflow/src/AppflowClient.ts b/clients/client-appflow/src/AppflowClient.ts index be155467f309a..a826727713683 100644 --- a/clients/client-appflow/src/AppflowClient.ts +++ b/clients/client-appflow/src/AppflowClient.ts @@ -60,6 +60,7 @@ import { DeleteConnectorProfileCommandOutput, } from "./commands/DeleteConnectorProfileCommand"; import { DeleteFlowCommandInput, DeleteFlowCommandOutput } from "./commands/DeleteFlowCommand"; +import { DescribeConnectorCommandInput, DescribeConnectorCommandOutput } from "./commands/DescribeConnectorCommand"; import { DescribeConnectorEntityCommandInput, DescribeConnectorEntityCommandOutput, @@ -78,14 +79,20 @@ import { ListConnectorEntitiesCommandInput, ListConnectorEntitiesCommandOutput, } from "./commands/ListConnectorEntitiesCommand"; +import { ListConnectorsCommandInput, ListConnectorsCommandOutput } from "./commands/ListConnectorsCommand"; import { ListFlowsCommandInput, ListFlowsCommandOutput } from "./commands/ListFlowsCommand"; import { ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput, } from "./commands/ListTagsForResourceCommand"; +import { RegisterConnectorCommandInput, RegisterConnectorCommandOutput } from "./commands/RegisterConnectorCommand"; import { StartFlowCommandInput, StartFlowCommandOutput } from "./commands/StartFlowCommand"; import { StopFlowCommandInput, StopFlowCommandOutput } from "./commands/StopFlowCommand"; import { TagResourceCommandInput, TagResourceCommandOutput } from "./commands/TagResourceCommand"; +import { + UnregisterConnectorCommandInput, + UnregisterConnectorCommandOutput, +} from "./commands/UnregisterConnectorCommand"; import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./commands/UntagResourceCommand"; import { UpdateConnectorProfileCommandInput, @@ -99,17 +106,21 @@ export type ServiceInputTypes = | CreateFlowCommandInput | DeleteConnectorProfileCommandInput | DeleteFlowCommandInput + | DescribeConnectorCommandInput | DescribeConnectorEntityCommandInput | DescribeConnectorProfilesCommandInput | DescribeConnectorsCommandInput | DescribeFlowCommandInput | DescribeFlowExecutionRecordsCommandInput | ListConnectorEntitiesCommandInput + | ListConnectorsCommandInput | ListFlowsCommandInput | ListTagsForResourceCommandInput + | RegisterConnectorCommandInput | StartFlowCommandInput | StopFlowCommandInput | TagResourceCommandInput + | UnregisterConnectorCommandInput | UntagResourceCommandInput | UpdateConnectorProfileCommandInput | UpdateFlowCommandInput; @@ -119,17 +130,21 @@ export type ServiceOutputTypes = | CreateFlowCommandOutput | DeleteConnectorProfileCommandOutput | DeleteFlowCommandOutput + | DescribeConnectorCommandOutput | DescribeConnectorEntityCommandOutput | DescribeConnectorProfilesCommandOutput | DescribeConnectorsCommandOutput | DescribeFlowCommandOutput | DescribeFlowExecutionRecordsCommandOutput | ListConnectorEntitiesCommandOutput + | ListConnectorsCommandOutput | ListFlowsCommandOutput | ListTagsForResourceCommandOutput + | RegisterConnectorCommandOutput | StartFlowCommandOutput | StopFlowCommandOutput | TagResourceCommandOutput + | UnregisterConnectorCommandOutput | UntagResourceCommandOutput | UpdateConnectorProfileCommandOutput | UpdateFlowCommandOutput; diff --git a/clients/client-appflow/src/commands/CreateConnectorProfileCommand.ts b/clients/client-appflow/src/commands/CreateConnectorProfileCommand.ts index a017eb05bff34..c585d226ba0ca 100644 --- a/clients/client-appflow/src/commands/CreateConnectorProfileCommand.ts +++ b/clients/client-appflow/src/commands/CreateConnectorProfileCommand.ts @@ -22,10 +22,10 @@ export interface CreateConnectorProfileCommandInput extends CreateConnectorProfi export interface CreateConnectorProfileCommandOutput extends CreateConnectorProfileResponse, __MetadataBearer {} /** - *

Creates a new connector profile associated with your Amazon Web Services account. There is a soft quota - * of 100 connector profiles per Amazon Web Services account. If you need more connector profiles than this quota - * allows, you can submit a request to the Amazon AppFlow team through the Amazon AppFlow support - * channel.

+ *

Creates a new connector profile associated with your Amazon Web Services account. There + * is a soft quota of 100 connector profiles per Amazon Web Services account. If you need more + * connector profiles than this quota allows, you can submit a request to the Amazon AppFlow team + * through the Amazon AppFlow support channel.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-appflow/src/commands/DescribeConnectorCommand.ts b/clients/client-appflow/src/commands/DescribeConnectorCommand.ts new file mode 100644 index 0000000000000..010736002db25 --- /dev/null +++ b/clients/client-appflow/src/commands/DescribeConnectorCommand.ts @@ -0,0 +1,97 @@ +import { getSerdePlugin } from "@aws-sdk/middleware-serde"; +import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@aws-sdk/protocol-http"; +import { Command as $Command } from "@aws-sdk/smithy-client"; +import { + FinalizeHandlerArguments, + Handler, + HandlerExecutionContext, + HttpHandlerOptions as __HttpHandlerOptions, + MetadataBearer as __MetadataBearer, + MiddlewareStack, + SerdeContext as __SerdeContext, +} from "@aws-sdk/types"; + +import { AppflowClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AppflowClient"; +import { DescribeConnectorRequest, DescribeConnectorResponse } from "../models/models_0"; +import { + deserializeAws_restJson1DescribeConnectorCommand, + serializeAws_restJson1DescribeConnectorCommand, +} from "../protocols/Aws_restJson1"; + +export interface DescribeConnectorCommandInput extends DescribeConnectorRequest {} +export interface DescribeConnectorCommandOutput extends DescribeConnectorResponse, __MetadataBearer {} + +/** + *

Describes the given custom connector registered in your Amazon Web Services account. This + * API can be used for custom connectors that are registered in your account and also for Amazon + * authored connectors.

+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppflowClient, DescribeConnectorCommand } from "@aws-sdk/client-appflow"; // ES Modules import + * // const { AppflowClient, DescribeConnectorCommand } = require("@aws-sdk/client-appflow"); // CommonJS import + * const client = new AppflowClient(config); + * const command = new DescribeConnectorCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeConnectorCommandInput} for command's `input` shape. + * @see {@link DescribeConnectorCommandOutput} for command's `response` shape. + * @see {@link AppflowClientResolvedConfig | config} for AppflowClient's `config` shape. + * + */ +export class DescribeConnectorCommand extends $Command< + DescribeConnectorCommandInput, + DescribeConnectorCommandOutput, + AppflowClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + constructor(readonly input: DescribeConnectorCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStack, + configuration: AppflowClientResolvedConfig, + options?: __HttpHandlerOptions + ): Handler { + this.middlewareStack.use(getSerdePlugin(configuration, this.serialize, this.deserialize)); + + const stack = clientStack.concat(this.middlewareStack); + + const { logger } = configuration; + const clientName = "AppflowClient"; + const commandName = "DescribeConnectorCommand"; + const handlerExecutionContext: HandlerExecutionContext = { + logger, + clientName, + commandName, + inputFilterSensitiveLog: DescribeConnectorRequest.filterSensitiveLog, + outputFilterSensitiveLog: DescribeConnectorResponse.filterSensitiveLog, + }; + const { requestHandler } = configuration; + return stack.resolve( + (request: FinalizeHandlerArguments) => + requestHandler.handle(request.request as __HttpRequest, options || {}), + handlerExecutionContext + ); + } + + private serialize(input: DescribeConnectorCommandInput, context: __SerdeContext): Promise<__HttpRequest> { + return serializeAws_restJson1DescribeConnectorCommand(input, context); + } + + private deserialize(output: __HttpResponse, context: __SerdeContext): Promise { + return deserializeAws_restJson1DescribeConnectorCommand(output, context); + } + + // Start section: command_body_extra + // End section: command_body_extra +} diff --git a/clients/client-appflow/src/commands/ListConnectorsCommand.ts b/clients/client-appflow/src/commands/ListConnectorsCommand.ts new file mode 100644 index 0000000000000..7a035d2f3020f --- /dev/null +++ b/clients/client-appflow/src/commands/ListConnectorsCommand.ts @@ -0,0 +1,97 @@ +import { getSerdePlugin } from "@aws-sdk/middleware-serde"; +import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@aws-sdk/protocol-http"; +import { Command as $Command } from "@aws-sdk/smithy-client"; +import { + FinalizeHandlerArguments, + Handler, + HandlerExecutionContext, + HttpHandlerOptions as __HttpHandlerOptions, + MetadataBearer as __MetadataBearer, + MiddlewareStack, + SerdeContext as __SerdeContext, +} from "@aws-sdk/types"; + +import { AppflowClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AppflowClient"; +import { ListConnectorsRequest, ListConnectorsResponse } from "../models/models_0"; +import { + deserializeAws_restJson1ListConnectorsCommand, + serializeAws_restJson1ListConnectorsCommand, +} from "../protocols/Aws_restJson1"; + +export interface ListConnectorsCommandInput extends ListConnectorsRequest {} +export interface ListConnectorsCommandOutput extends ListConnectorsResponse, __MetadataBearer {} + +/** + *

Returns the list of all registered custom connectors in your Amazon Web Services account. + * This API lists only custom connectors registered in this account, not the Amazon Web Services + * authored connectors.

+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppflowClient, ListConnectorsCommand } from "@aws-sdk/client-appflow"; // ES Modules import + * // const { AppflowClient, ListConnectorsCommand } = require("@aws-sdk/client-appflow"); // CommonJS import + * const client = new AppflowClient(config); + * const command = new ListConnectorsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListConnectorsCommandInput} for command's `input` shape. + * @see {@link ListConnectorsCommandOutput} for command's `response` shape. + * @see {@link AppflowClientResolvedConfig | config} for AppflowClient's `config` shape. + * + */ +export class ListConnectorsCommand extends $Command< + ListConnectorsCommandInput, + ListConnectorsCommandOutput, + AppflowClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + constructor(readonly input: ListConnectorsCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStack, + configuration: AppflowClientResolvedConfig, + options?: __HttpHandlerOptions + ): Handler { + this.middlewareStack.use(getSerdePlugin(configuration, this.serialize, this.deserialize)); + + const stack = clientStack.concat(this.middlewareStack); + + const { logger } = configuration; + const clientName = "AppflowClient"; + const commandName = "ListConnectorsCommand"; + const handlerExecutionContext: HandlerExecutionContext = { + logger, + clientName, + commandName, + inputFilterSensitiveLog: ListConnectorsRequest.filterSensitiveLog, + outputFilterSensitiveLog: ListConnectorsResponse.filterSensitiveLog, + }; + const { requestHandler } = configuration; + return stack.resolve( + (request: FinalizeHandlerArguments) => + requestHandler.handle(request.request as __HttpRequest, options || {}), + handlerExecutionContext + ); + } + + private serialize(input: ListConnectorsCommandInput, context: __SerdeContext): Promise<__HttpRequest> { + return serializeAws_restJson1ListConnectorsCommand(input, context); + } + + private deserialize(output: __HttpResponse, context: __SerdeContext): Promise { + return deserializeAws_restJson1ListConnectorsCommand(output, context); + } + + // Start section: command_body_extra + // End section: command_body_extra +} diff --git a/clients/client-appflow/src/commands/RegisterConnectorCommand.ts b/clients/client-appflow/src/commands/RegisterConnectorCommand.ts new file mode 100644 index 0000000000000..7c0cc2309273c --- /dev/null +++ b/clients/client-appflow/src/commands/RegisterConnectorCommand.ts @@ -0,0 +1,96 @@ +import { getSerdePlugin } from "@aws-sdk/middleware-serde"; +import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@aws-sdk/protocol-http"; +import { Command as $Command } from "@aws-sdk/smithy-client"; +import { + FinalizeHandlerArguments, + Handler, + HandlerExecutionContext, + HttpHandlerOptions as __HttpHandlerOptions, + MetadataBearer as __MetadataBearer, + MiddlewareStack, + SerdeContext as __SerdeContext, +} from "@aws-sdk/types"; + +import { AppflowClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AppflowClient"; +import { RegisterConnectorRequest, RegisterConnectorResponse } from "../models/models_0"; +import { + deserializeAws_restJson1RegisterConnectorCommand, + serializeAws_restJson1RegisterConnectorCommand, +} from "../protocols/Aws_restJson1"; + +export interface RegisterConnectorCommandInput extends RegisterConnectorRequest {} +export interface RegisterConnectorCommandOutput extends RegisterConnectorResponse, __MetadataBearer {} + +/** + *

Registers a new connector with your Amazon Web Services account. Before you can register + * the connector, you must deploy lambda in your account.

+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppflowClient, RegisterConnectorCommand } from "@aws-sdk/client-appflow"; // ES Modules import + * // const { AppflowClient, RegisterConnectorCommand } = require("@aws-sdk/client-appflow"); // CommonJS import + * const client = new AppflowClient(config); + * const command = new RegisterConnectorCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RegisterConnectorCommandInput} for command's `input` shape. + * @see {@link RegisterConnectorCommandOutput} for command's `response` shape. + * @see {@link AppflowClientResolvedConfig | config} for AppflowClient's `config` shape. + * + */ +export class RegisterConnectorCommand extends $Command< + RegisterConnectorCommandInput, + RegisterConnectorCommandOutput, + AppflowClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + constructor(readonly input: RegisterConnectorCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStack, + configuration: AppflowClientResolvedConfig, + options?: __HttpHandlerOptions + ): Handler { + this.middlewareStack.use(getSerdePlugin(configuration, this.serialize, this.deserialize)); + + const stack = clientStack.concat(this.middlewareStack); + + const { logger } = configuration; + const clientName = "AppflowClient"; + const commandName = "RegisterConnectorCommand"; + const handlerExecutionContext: HandlerExecutionContext = { + logger, + clientName, + commandName, + inputFilterSensitiveLog: RegisterConnectorRequest.filterSensitiveLog, + outputFilterSensitiveLog: RegisterConnectorResponse.filterSensitiveLog, + }; + const { requestHandler } = configuration; + return stack.resolve( + (request: FinalizeHandlerArguments) => + requestHandler.handle(request.request as __HttpRequest, options || {}), + handlerExecutionContext + ); + } + + private serialize(input: RegisterConnectorCommandInput, context: __SerdeContext): Promise<__HttpRequest> { + return serializeAws_restJson1RegisterConnectorCommand(input, context); + } + + private deserialize(output: __HttpResponse, context: __SerdeContext): Promise { + return deserializeAws_restJson1RegisterConnectorCommand(output, context); + } + + // Start section: command_body_extra + // End section: command_body_extra +} diff --git a/clients/client-appflow/src/commands/UnregisterConnectorCommand.ts b/clients/client-appflow/src/commands/UnregisterConnectorCommand.ts new file mode 100644 index 0000000000000..4c75f5c92a37d --- /dev/null +++ b/clients/client-appflow/src/commands/UnregisterConnectorCommand.ts @@ -0,0 +1,96 @@ +import { getSerdePlugin } from "@aws-sdk/middleware-serde"; +import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@aws-sdk/protocol-http"; +import { Command as $Command } from "@aws-sdk/smithy-client"; +import { + FinalizeHandlerArguments, + Handler, + HandlerExecutionContext, + HttpHandlerOptions as __HttpHandlerOptions, + MetadataBearer as __MetadataBearer, + MiddlewareStack, + SerdeContext as __SerdeContext, +} from "@aws-sdk/types"; + +import { AppflowClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AppflowClient"; +import { UnregisterConnectorRequest, UnregisterConnectorResponse } from "../models/models_0"; +import { + deserializeAws_restJson1UnregisterConnectorCommand, + serializeAws_restJson1UnregisterConnectorCommand, +} from "../protocols/Aws_restJson1"; + +export interface UnregisterConnectorCommandInput extends UnregisterConnectorRequest {} +export interface UnregisterConnectorCommandOutput extends UnregisterConnectorResponse, __MetadataBearer {} + +/** + *

Unregisters the custom connector registered in your account that matches the + * connectorLabel provided in the request.

+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppflowClient, UnregisterConnectorCommand } from "@aws-sdk/client-appflow"; // ES Modules import + * // const { AppflowClient, UnregisterConnectorCommand } = require("@aws-sdk/client-appflow"); // CommonJS import + * const client = new AppflowClient(config); + * const command = new UnregisterConnectorCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UnregisterConnectorCommandInput} for command's `input` shape. + * @see {@link UnregisterConnectorCommandOutput} for command's `response` shape. + * @see {@link AppflowClientResolvedConfig | config} for AppflowClient's `config` shape. + * + */ +export class UnregisterConnectorCommand extends $Command< + UnregisterConnectorCommandInput, + UnregisterConnectorCommandOutput, + AppflowClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + constructor(readonly input: UnregisterConnectorCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStack, + configuration: AppflowClientResolvedConfig, + options?: __HttpHandlerOptions + ): Handler { + this.middlewareStack.use(getSerdePlugin(configuration, this.serialize, this.deserialize)); + + const stack = clientStack.concat(this.middlewareStack); + + const { logger } = configuration; + const clientName = "AppflowClient"; + const commandName = "UnregisterConnectorCommand"; + const handlerExecutionContext: HandlerExecutionContext = { + logger, + clientName, + commandName, + inputFilterSensitiveLog: UnregisterConnectorRequest.filterSensitiveLog, + outputFilterSensitiveLog: UnregisterConnectorResponse.filterSensitiveLog, + }; + const { requestHandler } = configuration; + return stack.resolve( + (request: FinalizeHandlerArguments) => + requestHandler.handle(request.request as __HttpRequest, options || {}), + handlerExecutionContext + ); + } + + private serialize(input: UnregisterConnectorCommandInput, context: __SerdeContext): Promise<__HttpRequest> { + return serializeAws_restJson1UnregisterConnectorCommand(input, context); + } + + private deserialize(output: __HttpResponse, context: __SerdeContext): Promise { + return deserializeAws_restJson1UnregisterConnectorCommand(output, context); + } + + // Start section: command_body_extra + // End section: command_body_extra +} diff --git a/clients/client-appflow/src/commands/index.ts b/clients/client-appflow/src/commands/index.ts index 33ece442c41f4..c57014b17a2dc 100644 --- a/clients/client-appflow/src/commands/index.ts +++ b/clients/client-appflow/src/commands/index.ts @@ -2,17 +2,21 @@ export * from "./CreateConnectorProfileCommand"; export * from "./CreateFlowCommand"; export * from "./DeleteConnectorProfileCommand"; export * from "./DeleteFlowCommand"; +export * from "./DescribeConnectorCommand"; export * from "./DescribeConnectorEntityCommand"; export * from "./DescribeConnectorProfilesCommand"; export * from "./DescribeConnectorsCommand"; export * from "./DescribeFlowCommand"; export * from "./DescribeFlowExecutionRecordsCommand"; export * from "./ListConnectorEntitiesCommand"; +export * from "./ListConnectorsCommand"; export * from "./ListFlowsCommand"; export * from "./ListTagsForResourceCommand"; +export * from "./RegisterConnectorCommand"; export * from "./StartFlowCommand"; export * from "./StopFlowCommand"; export * from "./TagResourceCommand"; +export * from "./UnregisterConnectorCommand"; export * from "./UntagResourceCommand"; export * from "./UpdateConnectorProfileCommand"; export * from "./UpdateFlowCommand"; diff --git a/clients/client-appflow/src/models/models_0.ts b/clients/client-appflow/src/models/models_0.ts index 5b1edca247131..739d939f77722 100644 --- a/clients/client-appflow/src/models/models_0.ts +++ b/clients/client-appflow/src/models/models_0.ts @@ -1,6 +1,15 @@ import { SENSITIVE_STRING } from "@aws-sdk/smithy-client"; import { MetadataBearer as $MetadataBearer, SmithyException as __SmithyException } from "@aws-sdk/types"; +/** + *

AppFlow/Requester has invalid or missing permissions.

+ */ +export interface AccessDeniedException extends __SmithyException, $MetadataBearer { + name: "AccessDeniedException"; + $fault: "client"; + message?: string; +} + export enum AggregationType { NONE = "None", SINGLE_FILE = "SingleFile", @@ -53,6 +62,7 @@ export namespace AmplitudeConnectorProfileCredentials { */ export const filterSensitiveLog = (obj: AmplitudeConnectorProfileCredentials): any => ({ ...obj, + ...(obj.apiKey && { apiKey: SENSITIVE_STRING }), ...(obj.secretKey && { secretKey: SENSITIVE_STRING }), }); } @@ -104,6 +114,191 @@ export namespace AmplitudeSourceProperties { }); } +/** + *

The API key credentials required for API key authentication.

+ */ +export interface ApiKeyCredentials { + /** + *

The API key required for API key authentication.

+ */ + apiKey: string | undefined; + + /** + *

The API secret key required for API key authentication.

+ */ + apiSecretKey?: string; +} + +export namespace ApiKeyCredentials { + /** + * @internal + */ + export const filterSensitiveLog = (obj: ApiKeyCredentials): any => ({ + ...obj, + ...(obj.apiKey && { apiKey: SENSITIVE_STRING }), + ...(obj.apiSecretKey && { apiSecretKey: SENSITIVE_STRING }), + }); +} + +/** + *

Information about required authentication parameters.

+ */ +export interface AuthParameter { + /** + *

The authentication key required to authenticate with the connector.

+ */ + key?: string; + + /** + *

Indicates whether this authentication parameter is required.

+ */ + isRequired?: boolean; + + /** + *

Label used for authentication parameter.

+ */ + label?: string; + + /** + *

A description about the authentication parameter.

+ */ + description?: string; + + /** + *

Indicates whether this authentication parameter is a sensitive field.

+ */ + isSensitiveField?: boolean; + + /** + *

Contains default values for this authentication parameter that are supplied by the + * connector.

+ */ + connectorSuppliedValues?: string[]; +} + +export namespace AuthParameter { + /** + * @internal + */ + export const filterSensitiveLog = (obj: AuthParameter): any => ({ + ...obj, + }); +} + +/** + *

Configuration information required for custom authentication.

+ */ +export interface CustomAuthConfig { + /** + *

The authentication type that the custom connector uses.

+ */ + customAuthenticationType?: string; + + /** + *

Information about authentication parameters required for authentication.

+ */ + authParameters?: AuthParameter[]; +} + +export namespace CustomAuthConfig { + /** + * @internal + */ + export const filterSensitiveLog = (obj: CustomAuthConfig): any => ({ + ...obj, + }); +} + +export enum OAuth2GrantType { + AUTHORIZATION_CODE = "AUTHORIZATION_CODE", + CLIENT_CREDENTIALS = "CLIENT_CREDENTIALS", +} + +/** + *

Contains the default values required for OAuth 2.0 authentication.

+ */ +export interface OAuth2Defaults { + /** + *

OAuth 2.0 scopes that the connector supports.

+ */ + oauthScopes?: string[]; + + /** + *

Token URLs that can be used for OAuth 2.0 authentication.

+ */ + tokenUrls?: string[]; + + /** + *

Auth code URLs that can be used for OAuth 2.0 authentication.

+ */ + authCodeUrls?: string[]; + + /** + *

OAuth 2.0 grant types supported by the connector.

+ */ + oauth2GrantTypesSupported?: (OAuth2GrantType | string)[]; +} + +export namespace OAuth2Defaults { + /** + * @internal + */ + export const filterSensitiveLog = (obj: OAuth2Defaults): any => ({ + ...obj, + }); +} + +/** + *

Contains information about the authentication config that the connector supports.

+ */ +export interface AuthenticationConfig { + /** + *

Indicates whether basic authentication is supported by the connector.

+ */ + isBasicAuthSupported?: boolean; + + /** + *

Indicates whether API key authentication is supported by the connector

+ */ + isApiKeyAuthSupported?: boolean; + + /** + *

Indicates whether OAuth 2.0 authentication is supported by the connector.

+ */ + isOAuth2Supported?: boolean; + + /** + *

Indicates whether custom authentication is supported by the connector

+ */ + isCustomAuthSupported?: boolean; + + /** + *

Contains the default values required for OAuth 2.0 authentication.

+ */ + oAuth2Defaults?: OAuth2Defaults; + + /** + *

Contains information required for custom authentication.

+ */ + customAuthConfigs?: CustomAuthConfig[]; +} + +export namespace AuthenticationConfig { + /** + * @internal + */ + export const filterSensitiveLog = (obj: AuthenticationConfig): any => ({ + ...obj, + }); +} + +export enum AuthenticationType { + APIKEY = "APIKEY", + BASIC = "BASIC", + CUSTOM = "CUSTOM", + OAUTH2 = "OAUTH2", +} + /** *

The basic auth credentials required for basic authentication.

*/ @@ -583,8 +778,104 @@ export namespace ConnectorMetadata { }); } +/** + *

Contains information about the configuration of the lambda which is being registered as + * the connector.

+ */ +export interface LambdaConnectorProvisioningConfig { + /** + *

Lambda ARN of the connector being registered.

+ */ + lambdaArn: string | undefined; +} + +export namespace LambdaConnectorProvisioningConfig { + /** + * @internal + */ + export const filterSensitiveLog = (obj: LambdaConnectorProvisioningConfig): any => ({ + ...obj, + }); +} + +/** + *

Contains information about the configuration of the connector being registered.

+ */ +export interface ConnectorProvisioningConfig { + /** + *

Contains information about the configuration of the lambda which is being registered as + * the connector.

+ */ + lambda?: LambdaConnectorProvisioningConfig; +} + +export namespace ConnectorProvisioningConfig { + /** + * @internal + */ + export const filterSensitiveLog = (obj: ConnectorProvisioningConfig): any => ({ + ...obj, + }); +} + +export enum ConnectorProvisioningType { + LAMBDA = "LAMBDA", +} + +/** + *

Contains information about the connector runtime settings that are required for flow + * execution.

+ */ +export interface ConnectorRuntimeSetting { + /** + *

Contains value information about the connector runtime setting.

+ */ + key?: string; + + /** + *

Data type of the connector runtime setting.

+ */ + dataType?: string; + + /** + *

Indicates whether this connector runtime setting is required.

+ */ + isRequired?: boolean; + + /** + *

A label used for connector runtime setting.

+ */ + label?: string; + + /** + *

A description about the connector runtime setting.

+ */ + description?: string; + + /** + *

Indicates the scope of the connector runtime setting.

+ */ + scope?: string; + + /** + *

Contains default values for the connector runtime setting that are supplied by the + * connector.

+ */ + connectorSuppliedValueOptions?: string[]; +} + +export namespace ConnectorRuntimeSetting { + /** + * @internal + */ + export const filterSensitiveLog = (obj: ConnectorRuntimeSetting): any => ({ + ...obj, + }); +} + export enum ConnectorType { AMPLITUDE = "Amplitude", + CUSTOMCONNECTOR = "CustomConnector", CUSTOMERPROFILES = "CustomerProfiles", DATADOG = "Datadog", DYNATRACE = "Dynatrace", @@ -608,6 +899,30 @@ export enum ConnectorType { ZENDESK = "Zendesk", } +export enum Operators { + ADDITION = "ADDITION", + BETWEEN = "BETWEEN", + CONTAINS = "CONTAINS", + DIVISION = "DIVISION", + EQUAL_TO = "EQUAL_TO", + GREATER_THAN = "GREATER_THAN", + GREATER_THAN_OR_EQUAL_TO = "GREATER_THAN_OR_EQUAL_TO", + LESS_THAN = "LESS_THAN", + LESS_THAN_OR_EQUAL_TO = "LESS_THAN_OR_EQUAL_TO", + MASK_ALL = "MASK_ALL", + MASK_FIRST_N = "MASK_FIRST_N", + MASK_LAST_N = "MASK_LAST_N", + MULTIPLICATION = "MULTIPLICATION", + NOT_EQUAL_TO = "NOT_EQUAL_TO", + NO_OP = "NO_OP", + PROJECTION = "PROJECTION", + SUBTRACTION = "SUBTRACTION", + VALIDATE_NON_NEGATIVE = "VALIDATE_NON_NEGATIVE", + VALIDATE_NON_NULL = "VALIDATE_NON_NULL", + VALIDATE_NON_ZERO = "VALIDATE_NON_ZERO", + VALIDATE_NUMERIC = "VALIDATE_NUMERIC", +} + export enum ScheduleFrequencyType { BYMINUTE = "BYMINUTE", DAILY = "DAILY", @@ -623,6 +938,13 @@ export enum TriggerType { SCHEDULED = "Scheduled", } +export enum WriteOperationType { + DELETE = "DELETE", + INSERT = "INSERT", + UPDATE = "UPDATE", + UPSERT = "UPSERT", +} + /** *

The configuration settings related to a given connector.

*/ @@ -667,6 +989,96 @@ export interface ConnectorConfiguration { * supportedRegions, privateLinkServiceUrl, and so on.

*/ connectorMetadata?: ConnectorMetadata; + + /** + *

The connector type.

+ */ + connectorType?: ConnectorType | string; + + /** + *

The label used for registering the connector.

+ */ + connectorLabel?: string; + + /** + *

A description about the connector.

+ */ + connectorDescription?: string; + + /** + *

The owner who developed the connector.

+ */ + connectorOwner?: string; + + /** + *

The connector name.

+ */ + connectorName?: string; + + /** + *

The connector version.

+ */ + connectorVersion?: string; + + /** + *

The Amazon Resource Name (ARN) for the registered connector.

+ */ + connectorArn?: string; + + /** + *

The connection modes that the connector supports.

+ */ + connectorModes?: string[]; + + /** + *

The authentication config required for the connector.

+ */ + authenticationConfig?: AuthenticationConfig; + + /** + *

The required connector runtime settings.

+ */ + connectorRuntimeSettings?: ConnectorRuntimeSetting[]; + + /** + *

A list of API versions that are supported by the connector.

+ */ + supportedApiVersions?: string[]; + + /** + *

A list of operators supported by the connector.

+ */ + supportedOperators?: (Operators | string)[]; + + /** + *

A list of write operations supported by the connector.

+ */ + supportedWriteOperations?: (WriteOperationType | string)[]; + + /** + *

The provisioning type used to register the connector.

+ */ + connectorProvisioningType?: ConnectorProvisioningType | string; + + /** + *

The configuration required for registering the connector.

+ */ + connectorProvisioningConfig?: ConnectorProvisioningConfig; + + /** + *

Logo URL of the connector.

+ */ + logoURL?: string; + + /** + *

The date on which the connector was registered.

+ */ + registeredAt?: Date; + + /** + *

Information about who registered the connector.

+ */ + registeredBy?: string; } export namespace ConnectorConfiguration { @@ -678,6 +1090,75 @@ export namespace ConnectorConfiguration { }); } +/** + *

Information about the registered connector.

+ */ +export interface ConnectorDetail { + /** + *

A description about the registered connector.

+ */ + connectorDescription?: string; + + /** + *

The name of the connector.

+ */ + connectorName?: string; + + /** + *

The owner of the connector.

+ */ + connectorOwner?: string; + + /** + *

The connector version.

+ */ + connectorVersion?: string; + + /** + *

The application type of the connector.

+ */ + applicationType?: string; + + /** + *

The connector type.

+ */ + connectorType?: ConnectorType | string; + + /** + *

A label used for the connector.

+ */ + connectorLabel?: string; + + /** + *

The time at which the connector was registered.

+ */ + registeredAt?: Date; + + /** + *

The user who registered the connector.

+ */ + registeredBy?: string; + + /** + *

The provisioning type that the connector uses.

+ */ + connectorProvisioningType?: ConnectorProvisioningType | string; + + /** + *

The connection mode that the connector supports.

+ */ + connectorModes?: string[]; +} + +export namespace ConnectorDetail { + /** + * @internal + */ + export const filterSensitiveLog = (obj: ConnectorDetail): any => ({ + ...obj, + }); +} + /** *

The high-level entity that can be queried in Amazon AppFlow. For example, a Salesforce * entity might be an Account or Opportunity, whereas a @@ -713,12 +1194,6 @@ export namespace ConnectorEntity { }); } -export enum WriteOperationType { - INSERT = "INSERT", - UPDATE = "UPDATE", - UPSERT = "UPSERT", -} - /** *

The properties that can be applied to a field when connector is being used as a * destination.

@@ -746,6 +1221,11 @@ export interface DestinationFieldProperties { */ isUpdatable?: boolean; + /** + *

Specifies whether the field can use the default value during a Create operation.

+ */ + isDefaultedOnCreate?: boolean; + /** *

A list of supported write operations. For each write operation listed, this field can be * used in idFieldNames when that write operation is present as a destination @@ -777,6 +1257,11 @@ export interface SourceFieldProperties { *

Indicates if the field can be queried.

*/ isQueryable?: boolean; + + /** + *

Indicates if this timestamp field can be used for incremental queries.

+ */ + isTimestampFieldForIncrementalQueries?: boolean; } export namespace SourceFieldProperties { @@ -788,6 +1273,30 @@ export namespace SourceFieldProperties { }); } +/** + *

The range of values that the property supports.

+ */ +export interface Range { + /** + *

Maximum value supported by the field.

+ */ + maximum?: number; + + /** + *

Minimum value supported by the field.

+ */ + minimum?: number; +} + +export namespace Range { + /** + * @internal + */ + export const filterSensitiveLog = (obj: Range): any => ({ + ...obj, + }); +} + export enum Operator { ADDITION = "ADDITION", BETWEEN = "BETWEEN", @@ -832,6 +1341,26 @@ export interface FieldTypeDetails { * fieldType can have two values: "true" and "false".

*/ supportedValues?: string[]; + + /** + *

The regular expression pattern for the field name.

+ */ + valueRegexPattern?: string; + + /** + *

The date format that the field supports.

+ */ + supportedDateFormat?: string; + + /** + *

The range of values this field can hold.

+ */ + fieldValueRange?: Range; + + /** + *

This is the allowable length range for this field's value.

+ */ + fieldLengthRange?: Range; } export namespace FieldTypeDetails { @@ -875,11 +1404,31 @@ export interface ConnectorEntityField { */ identifier: string | undefined; + /** + *

The parent identifier of the connector field.

+ */ + parentIdentifier?: string; + /** *

The label applied to a connector entity field.

*/ label?: string; + /** + *

Booelan value that indicates whether this field can be used as a primary key.

+ */ + isPrimaryKey?: boolean; + + /** + *

Default value that can be assigned to this field.

+ */ + defaultValue?: string; + + /** + *

Booelan value that indicates whether this field is deprecated or not.

+ */ + isDeprecated?: boolean; + /** *

Contains details regarding the supported FieldType, including the * corresponding filterOperators and supportedValues.

@@ -902,6 +1451,11 @@ export interface ConnectorEntityField { *

*/ destinationProperties?: DestinationFieldProperties; + + /** + *

A map that has specific properties related to the ConnectorEntityField.

+ */ + customProperties?: { [key: string]: string }; } export namespace ConnectorEntityField { @@ -1288,6 +1842,11 @@ export interface ConnectorOperator { *

The operation to be performed on the provided SAPOData source fields.

*/ SAPOData?: SAPODataConnectorOperator | string; + + /** + *

Operators supported by the custom connector.

+ */ + CustomConnector?: Operator | string; } export namespace ConnectorOperator { @@ -1299,6 +1858,54 @@ export namespace ConnectorOperator { }); } +/** + *

The OAuth 2.0 properties required for OAuth 2.0 authentication.

+ */ +export interface OAuth2Properties { + /** + *

The token URL required for OAuth 2.0 authentication.

+ */ + tokenUrl: string | undefined; + + /** + *

The OAuth 2.0 grant type used by connector for OAuth 2.0 authentication.

+ */ + oAuth2GrantType: OAuth2GrantType | string | undefined; +} + +export namespace OAuth2Properties { + /** + * @internal + */ + export const filterSensitiveLog = (obj: OAuth2Properties): any => ({ + ...obj, + }); +} + +/** + *

The profile properties required by the custom connector.

+ */ +export interface CustomConnectorProfileProperties { + /** + *

A map of properties that are required to create a profile for the custom connector.

+ */ + profileProperties?: { [key: string]: string }; + + /** + *

The OAuth 2.0 properties required for OAuth 2.0 authentication.

+ */ + oAuth2Properties?: OAuth2Properties; +} + +export namespace CustomConnectorProfileProperties { + /** + * @internal + */ + export const filterSensitiveLog = (obj: CustomConnectorProfileProperties): any => ({ + ...obj, + }); +} + /** *

The connector-specific profile properties required by Datadog.

*/ @@ -1468,14 +2075,14 @@ export namespace SalesforceConnectorProfileProperties { */ export interface OAuthProperties { /** - *

The token url required to fetch access/refresh tokens using authorization code and also to refresh expired - * access token using refresh token.

+ *

The token url required to fetch access/refresh tokens using authorization code and also + * to refresh expired access token using refresh token.

*/ tokenUrl: string | undefined; /** - *

The authorization code url required to redirect to SAP Login Page to fetch authorization code for OAuth type - * authentication.

+ *

The authorization code url required to redirect to SAP Login Page to fetch authorization + * code for OAuth type authentication.

*/ authCodeUrl: string | undefined; @@ -1786,6 +2393,11 @@ export interface ConnectorProfileProperties { *

The connector-specific profile properties required when using SAPOData.

*/ SAPOData?: SAPODataConnectorProfileProperties; + + /** + *

The properties required by the custom connector.

+ */ + CustomConnector?: CustomConnectorProfileProperties; } export namespace ConnectorProfileProperties { @@ -1864,6 +2476,11 @@ export interface ConnectorProfile { */ connectorType?: ConnectorType | string; + /** + *

The label for the connector profile being created.

+ */ + connectorLabel?: string; + /** *

Indicates the connection mode and if it is public or private.

*/ @@ -1895,12 +2512,126 @@ export interface ConnectorProfile { privateConnectionProvisioningState?: PrivateConnectionProvisioningState; } -export namespace ConnectorProfile { +export namespace ConnectorProfile { + /** + * @internal + */ + export const filterSensitiveLog = (obj: ConnectorProfile): any => ({ + ...obj, + }); +} + +/** + *

The custom credentials required for custom authentication.

+ */ +export interface CustomAuthCredentials { + /** + *

The custom authentication type that the connector uses.

+ */ + customAuthenticationType: string | undefined; + + /** + *

A map that holds custom authentication credentials.

+ */ + credentialsMap?: { [key: string]: string }; +} + +export namespace CustomAuthCredentials { + /** + * @internal + */ + export const filterSensitiveLog = (obj: CustomAuthCredentials): any => ({ + ...obj, + ...(obj.credentialsMap && { credentialsMap: SENSITIVE_STRING }), + }); +} + +/** + *

The OAuth 2.0 credentials required for OAuth 2.0 authentication.

+ */ +export interface OAuth2Credentials { + /** + *

The identifier for the desired client.

+ */ + clientId?: string; + + /** + *

The client secret used by the OAuth client to authenticate to the authorization + * server.

+ */ + clientSecret?: string; + + /** + *

The access token used to access the connector on your behalf.

+ */ + accessToken?: string; + + /** + *

The refresh token used to refresh an expired access token.

+ */ + refreshToken?: string; + + /** + *

Used by select connectors for which the OAuth workflow is supported, such as Salesforce, + * Google Analytics, Marketo, Zendesk, and Slack.

+ */ + oAuthRequest?: ConnectorOAuthRequest; +} + +export namespace OAuth2Credentials { + /** + * @internal + */ + export const filterSensitiveLog = (obj: OAuth2Credentials): any => ({ + ...obj, + ...(obj.clientSecret && { clientSecret: SENSITIVE_STRING }), + ...(obj.accessToken && { accessToken: SENSITIVE_STRING }), + }); +} + +/** + *

The connector-specific profile credentials that are required when using the custom + * connector.

+ */ +export interface CustomConnectorProfileCredentials { + /** + *

The authentication type that the custom connector uses for authenticating while creating a + * connector profile.

+ */ + authenticationType: AuthenticationType | string | undefined; + + /** + *

The basic credentials that are required for the authentication of the user.

+ */ + basic?: BasicAuthCredentials; + + /** + *

The OAuth 2.0 credentials required for the authentication of the user.

+ */ + oauth2?: OAuth2Credentials; + + /** + *

The API keys required for the authentication of the user.

+ */ + apiKey?: ApiKeyCredentials; + + /** + *

If the connector uses the custom authentication mechanism, this holds the required + * credentials.

+ */ + custom?: CustomAuthCredentials; +} + +export namespace CustomConnectorProfileCredentials { /** * @internal */ - export const filterSensitiveLog = (obj: ConnectorProfile): any => ({ + export const filterSensitiveLog = (obj: CustomConnectorProfileCredentials): any => ({ ...obj, + ...(obj.basic && { basic: BasicAuthCredentials.filterSensitiveLog(obj.basic) }), + ...(obj.oauth2 && { oauth2: OAuth2Credentials.filterSensitiveLog(obj.oauth2) }), + ...(obj.apiKey && { apiKey: ApiKeyCredentials.filterSensitiveLog(obj.apiKey) }), + ...(obj.custom && { custom: CustomAuthCredentials.filterSensitiveLog(obj.custom) }), }); } @@ -1928,6 +2659,7 @@ export namespace DatadogConnectorProfileCredentials { */ export const filterSensitiveLog = (obj: DatadogConnectorProfileCredentials): any => ({ ...obj, + ...(obj.apiKey && { apiKey: SENSITIVE_STRING }), }); } @@ -2274,6 +3006,7 @@ export namespace SingularConnectorProfileCredentials { */ export const filterSensitiveLog = (obj: SingularConnectorProfileCredentials): any => ({ ...obj, + ...(obj.apiKey && { apiKey: SENSITIVE_STRING }), }); } @@ -2511,6 +3244,12 @@ export interface ConnectorProfileCredentials { *

The connector-specific profile credentials required when using SAPOData.

*/ SAPOData?: SAPODataConnectorProfileCredentials; + + /** + *

The connector-specific profile credentials that are required when using the custom + * connector.

+ */ + CustomConnector?: CustomConnectorProfileCredentials; } export namespace ConnectorProfileCredentials { @@ -2520,6 +3259,7 @@ export namespace ConnectorProfileCredentials { export const filterSensitiveLog = (obj: ConnectorProfileCredentials): any => ({ ...obj, ...(obj.Amplitude && { Amplitude: AmplitudeConnectorProfileCredentials.filterSensitiveLog(obj.Amplitude) }), + ...(obj.Datadog && { Datadog: DatadogConnectorProfileCredentials.filterSensitiveLog(obj.Datadog) }), ...(obj.GoogleAnalytics && { GoogleAnalytics: GoogleAnalyticsConnectorProfileCredentials.filterSensitiveLog(obj.GoogleAnalytics), }), @@ -2529,12 +3269,16 @@ export namespace ConnectorProfileCredentials { ...(obj.Redshift && { Redshift: RedshiftConnectorProfileCredentials.filterSensitiveLog(obj.Redshift) }), ...(obj.Salesforce && { Salesforce: SalesforceConnectorProfileCredentials.filterSensitiveLog(obj.Salesforce) }), ...(obj.ServiceNow && { ServiceNow: ServiceNowConnectorProfileCredentials.filterSensitiveLog(obj.ServiceNow) }), + ...(obj.Singular && { Singular: SingularConnectorProfileCredentials.filterSensitiveLog(obj.Singular) }), ...(obj.Slack && { Slack: SlackConnectorProfileCredentials.filterSensitiveLog(obj.Slack) }), ...(obj.Snowflake && { Snowflake: SnowflakeConnectorProfileCredentials.filterSensitiveLog(obj.Snowflake) }), ...(obj.Trendmicro && { Trendmicro: TrendmicroConnectorProfileCredentials.filterSensitiveLog(obj.Trendmicro) }), ...(obj.Veeva && { Veeva: VeevaConnectorProfileCredentials.filterSensitiveLog(obj.Veeva) }), ...(obj.Zendesk && { Zendesk: ZendeskConnectorProfileCredentials.filterSensitiveLog(obj.Zendesk) }), ...(obj.SAPOData && { SAPOData: SAPODataConnectorProfileCredentials.filterSensitiveLog(obj.SAPOData) }), + ...(obj.CustomConnector && { + CustomConnector: CustomConnectorProfileCredentials.filterSensitiveLog(obj.CustomConnector), + }), }); } @@ -2595,10 +3339,17 @@ export interface CreateConnectorProfileRequest { */ connectorType: ConnectorType | string | undefined; + /** + *

The label of the connector. The label is unique for each + * ConnectorRegistration in your Amazon Web Services account. Only needed if + * calling for CUSTOMCONNECTOR connector type/.

+ */ + connectorLabel?: string; + /** *

Indicates the connection mode and specifies whether it is public or private. Private - * flows use Amazon Web Services PrivateLink to route data over Amazon Web Services infrastructure without exposing it to the - * public internet.

+ * flows use Amazon Web Services PrivateLink to route data over Amazon Web Services infrastructure + * without exposing it to the public internet.

*/ connectionMode: ConnectionMode | string | undefined; @@ -2663,60 +3414,104 @@ export interface ValidationException extends __SmithyException, $MetadataBearer } /** - *

The properties that are applied when Amazon Connect Customer Profiles is used as a - * destination.

+ *

The settings that determine how Amazon AppFlow handles an error when placing data in the + * destination. For example, this setting would determine if the flow should fail after one + * insertion error, or continue and attempt to insert every record regardless of the initial + * failure. ErrorHandlingConfig is a part of the destination connector details. + *

*/ -export interface CustomerProfilesDestinationProperties { +export interface ErrorHandlingConfig { /** - *

The unique name of the Amazon Connect Customer Profiles domain.

+ *

Specifies if the flow should fail after the first instance of a failure when attempting + * to place data in the destination.

*/ - domainName: string | undefined; + failOnFirstDestinationError?: boolean; /** - *

The object specified in the Amazon Connect Customer Profiles flow destination.

+ *

Specifies the Amazon S3 bucket prefix.

*/ - objectTypeName?: string; + bucketPrefix?: string; + + /** + *

Specifies the name of the Amazon S3 bucket.

+ */ + bucketName?: string; } -export namespace CustomerProfilesDestinationProperties { +export namespace ErrorHandlingConfig { /** * @internal */ - export const filterSensitiveLog = (obj: CustomerProfilesDestinationProperties): any => ({ + export const filterSensitiveLog = (obj: ErrorHandlingConfig): any => ({ ...obj, }); } /** - *

The settings that determine how Amazon AppFlow handles an error when placing data in the - * destination. For example, this setting would determine if the flow should fail after one - * insertion error, or continue and attempt to insert every record regardless of the initial - * failure. ErrorHandlingConfig is a part of the destination connector details. - *

+ *

The properties that are applied when the custom connector is being used as a + * destination.

*/ -export interface ErrorHandlingConfig { +export interface CustomConnectorDestinationProperties { /** - *

Specifies if the flow should fail after the first instance of a failure when attempting - * to place data in the destination.

+ *

The entity specified in the custom connector as a destination in the flow.

*/ - failOnFirstDestinationError?: boolean; + entityName: string | undefined; /** - *

Specifies the Amazon S3 bucket prefix.

+ *

The settings that determine how Amazon AppFlow handles an error when placing data in the + * custom connector as destination.

*/ - bucketPrefix?: string; + errorHandlingConfig?: ErrorHandlingConfig; /** - *

Specifies the name of the Amazon S3 bucket.

+ *

Specifies the type of write operation to be performed in the custom connector when it's + * used as destination.

*/ - bucketName?: string; + writeOperationType?: WriteOperationType | string; + + /** + *

The name of the field that Amazon AppFlow uses as an ID when performing a write operation + * such as update, delete, or upsert.

+ */ + idFieldNames?: string[]; + + /** + *

The custom properties that are specific to the connector when it's used as a destination + * in the flow.

+ */ + customProperties?: { [key: string]: string }; } -export namespace ErrorHandlingConfig { +export namespace CustomConnectorDestinationProperties { /** * @internal */ - export const filterSensitiveLog = (obj: ErrorHandlingConfig): any => ({ + export const filterSensitiveLog = (obj: CustomConnectorDestinationProperties): any => ({ + ...obj, + }); +} + +/** + *

The properties that are applied when Amazon Connect Customer Profiles is used as a + * destination.

+ */ +export interface CustomerProfilesDestinationProperties { + /** + *

The unique name of the Amazon Connect Customer Profiles domain.

+ */ + domainName: string | undefined; + + /** + *

The object specified in the Amazon Connect Customer Profiles flow destination.

+ */ + objectTypeName?: string; +} + +export namespace CustomerProfilesDestinationProperties { + /** + * @internal + */ + export const filterSensitiveLog = (obj: CustomerProfilesDestinationProperties): any => ({ ...obj, }); } @@ -3180,6 +3975,11 @@ export interface DestinationConnectorProperties { *

The properties required to query Zendesk.

*/ Zendesk?: ZendeskDestinationProperties; + + /** + *

The properties that are required to query the custom Connector.

+ */ + CustomConnector?: CustomConnectorDestinationProperties; } export namespace DestinationConnectorProperties { @@ -3201,6 +4001,11 @@ export interface DestinationFlowConfig { */ connectorType: ConnectorType | string | undefined; + /** + *

The API version that the destination connector uses.

+ */ + apiVersion?: string; + /** *

The name of the connector profile. This name must be unique for each connector profile in * the Amazon Web Services account.

@@ -3243,6 +4048,31 @@ export namespace IncrementalPullConfig { }); } +/** + *

The properties that are applied when the custom connector is being used as a + * source.

+ */ +export interface CustomConnectorSourceProperties { + /** + *

The entity specified in the custom connector as a source in the flow.

+ */ + entityName: string | undefined; + + /** + *

Custom properties that are required to use the custom connector as a source.

+ */ + customProperties?: { [key: string]: string }; +} + +export namespace CustomConnectorSourceProperties { + /** + * @internal + */ + export const filterSensitiveLog = (obj: CustomConnectorSourceProperties): any => ({ + ...obj, + }); +} + /** *

The properties that are applied when Datadog is being used as a source.

*/ @@ -3652,6 +4482,12 @@ export interface SourceConnectorProperties { *

The properties that are applied when using SAPOData as a flow source.

*/ SAPOData?: SAPODataSourceProperties; + + /** + *

The properties that are applied when the custom connector is being used as a + * source.

+ */ + CustomConnector?: CustomConnectorSourceProperties; } export namespace SourceConnectorProperties { @@ -3673,6 +4509,11 @@ export interface SourceFlowConfig { */ connectorType: ConnectorType | string | undefined; + /** + *

The API version of the connector when it's used as a source in the flow.

+ */ + apiVersion?: string; + /** *

The name of the connector profile. This name must be unique for each connector profile in * the Amazon Web Services account.

@@ -4047,6 +4888,46 @@ export namespace DeleteFlowResponse { }); } +export interface DescribeConnectorRequest { + /** + *

The connector type, such as CUSTOMCONNECTOR, Saleforce, Marketo. Please choose + * CUSTOMCONNECTOR for Lambda based custom connectors.

+ */ + connectorType: ConnectorType | string | undefined; + + /** + *

The label of the connector. The label is unique for each + * ConnectorRegistration in your Amazon Web Services account. Only needed if + * calling for CUSTOMCONNECTOR connector type/.

+ */ + connectorLabel?: string; +} + +export namespace DescribeConnectorRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: DescribeConnectorRequest): any => ({ + ...obj, + }); +} + +export interface DescribeConnectorResponse { + /** + *

Configuration info of all the connectors that the user requested.

+ */ + connectorConfiguration?: ConnectorConfiguration; +} + +export namespace DescribeConnectorResponse { + /** + * @internal + */ + export const filterSensitiveLog = (obj: DescribeConnectorResponse): any => ({ + ...obj, + }); +} + export interface DescribeConnectorEntityRequest { /** *

The entity name for that connector.

@@ -4063,6 +4944,11 @@ export interface DescribeConnectorEntityRequest { * ConnectorProfile in the Amazon Web Services account.

*/ connectorProfileName?: string; + + /** + *

The version of the API that's used by the connector.

+ */ + apiVersion?: string; } export namespace DescribeConnectorEntityRequest { @@ -4104,6 +4990,13 @@ export interface DescribeConnectorProfilesRequest { */ connectorType?: ConnectorType | string; + /** + *

The name of the connector. The name is unique for each ConnectorRegistration + * in your Amazon Web Services account. Only needed if calling for CUSTOMCONNECTOR connector + * type/.

+ */ + connectorLabel?: string; + /** *

Specifies the maximum number of items that should be returned in the result set. The * default for maxResults is 20 (for all paginated API operations).

@@ -4153,6 +5046,12 @@ export interface DescribeConnectorsRequest { */ connectorTypes?: (ConnectorType | string)[]; + /** + *

The maximum number of items that should be returned in the result set. The default is + * 20.

+ */ + maxResults?: number; + /** *

The pagination token for the next page of data.

*/ @@ -4174,6 +5073,11 @@ export interface DescribeConnectorsResponse { */ connectorConfigurations?: { [key: string]: ConnectorConfiguration }; + /** + *

Information about the connectors supported in Amazon AppFlow.

+ */ + connectors?: ConnectorDetail[]; + /** *

The pagination token for the next page of data.

*/ @@ -4533,12 +5437,22 @@ export interface FlowDefinition { */ sourceConnectorType?: ConnectorType | string; + /** + *

The label of the source connector in the flow.

+ */ + sourceConnectorLabel?: string; + /** *

Specifies the destination connector type, such as Salesforce, Amazon S3, Amplitude, and * so on.

*/ destinationConnectorType?: ConnectorType | string; + /** + *

The label of the destination connector in the flow.

+ */ + destinationConnectorLabel?: string; + /** *

Specifies the type of flow trigger. This can be OnDemand, * Scheduled, or Event.

@@ -4588,8 +5502,8 @@ export namespace FlowDefinition { export interface ListConnectorEntitiesRequest { /** *

The name of the connector profile. The name is unique for each - * ConnectorProfile in the Amazon Web Services account, and is used to query the downstream - * connector.

+ * ConnectorProfile in the Amazon Web Services account, and is used to query the + * downstream connector.

*/ connectorProfileName?: string; @@ -4606,6 +5520,11 @@ export interface ListConnectorEntitiesRequest { * roots. Otherwise, this request returns all entities supported by the provider.

*/ entitiesPath?: string; + + /** + *

The version of the API that's used by the connector.

+ */ + apiVersion?: string; } export namespace ListConnectorEntitiesRequest { @@ -4635,6 +5554,50 @@ export namespace ListConnectorEntitiesResponse { }); } +export interface ListConnectorsRequest { + /** + *

Specifies the maximum number of items that should be returned in the result set. The + * default for maxResults is 20 (for all paginated API operations).

+ */ + maxResults?: number; + + /** + *

The pagination token for the next page of data.

+ */ + nextToken?: string; +} + +export namespace ListConnectorsRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: ListConnectorsRequest): any => ({ + ...obj, + }); +} + +export interface ListConnectorsResponse { + /** + *

Contains information about the connectors supported by Amazon AppFlow.

+ */ + connectors?: ConnectorDetail[]; + + /** + *

The pagination token for the next page of data. If nextToken=null, this means that all + * records have been fetched.

+ */ + nextToken?: string; +} + +export namespace ListConnectorsResponse { + /** + * @internal + */ + export const filterSensitiveLog = (obj: ListConnectorsResponse): any => ({ + ...obj, + }); +} + export interface ListFlowsRequest { /** *

Specifies the maximum number of items that should be returned in the result set.

@@ -4709,6 +5672,66 @@ export namespace ListTagsForResourceResponse { }); } +export interface RegisterConnectorRequest { + /** + *

The name of the connector. The name is unique for each ConnectorRegistration + * in your Amazon Web Services account.

+ */ + connectorLabel?: string; + + /** + *

A description about the connector that's being registered.

+ */ + description?: string; + + /** + *

The provisioning type of the connector. Currently the only supported value is LAMBDA. + *

+ */ + connectorProvisioningType?: ConnectorProvisioningType | string; + + /** + *

The provisioning type of the connector. Currently the only supported value is + * LAMBDA.

+ */ + connectorProvisioningConfig?: ConnectorProvisioningConfig; +} + +export namespace RegisterConnectorRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: RegisterConnectorRequest): any => ({ + ...obj, + }); +} + +export interface RegisterConnectorResponse { + /** + *

The ARN of the connector being registered.

+ */ + connectorArn?: string; +} + +export namespace RegisterConnectorResponse { + /** + * @internal + */ + export const filterSensitiveLog = (obj: RegisterConnectorResponse): any => ({ + ...obj, + }); +} + +/** + *

API calls have exceeded the maximum allowed API request rate per account and per Region. + *

+ */ +export interface ThrottlingException extends __SmithyException, $MetadataBearer { + name: "ThrottlingException"; + $fault: "client"; + message?: string; +} + export interface StartFlowRequest { /** *

The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens @@ -4832,6 +5855,40 @@ export namespace TagResourceResponse { }); } +export interface UnregisterConnectorRequest { + /** + *

The label of the connector. The label is unique for each + * ConnectorRegistration in your Amazon Web Services account.

+ */ + connectorLabel: string | undefined; + + /** + *

Indicates whether Amazon AppFlow should unregister the connector, even if it is currently + * in use in one or more connector profiles. The default value is false.

+ */ + forceDelete?: boolean; +} + +export namespace UnregisterConnectorRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: UnregisterConnectorRequest): any => ({ + ...obj, + }); +} + +export interface UnregisterConnectorResponse {} + +export namespace UnregisterConnectorResponse { + /** + * @internal + */ + export const filterSensitiveLog = (obj: UnregisterConnectorResponse): any => ({ + ...obj, + }); +} + export interface UntagResourceRequest { /** *

The Amazon Resource Name (ARN) of the flow that you want to untag.

diff --git a/clients/client-appflow/src/pagination/DescribeConnectorsPaginator.ts b/clients/client-appflow/src/pagination/DescribeConnectorsPaginator.ts index 3fbad393ab371..6b75aaab8722e 100644 --- a/clients/client-appflow/src/pagination/DescribeConnectorsPaginator.ts +++ b/clients/client-appflow/src/pagination/DescribeConnectorsPaginator.ts @@ -42,6 +42,7 @@ export async function* paginateDescribeConnectors( let page: DescribeConnectorsCommandOutput; while (hasNext) { input.nextToken = token; + input["maxResults"] = config.pageSize; if (config.client instanceof Appflow) { page = await makePagedRequest(config.client, input, ...additionalArguments); } else if (config.client instanceof AppflowClient) { diff --git a/clients/client-appflow/src/pagination/ListConnectorsPaginator.ts b/clients/client-appflow/src/pagination/ListConnectorsPaginator.ts new file mode 100644 index 0000000000000..7cbe7dd3d1a96 --- /dev/null +++ b/clients/client-appflow/src/pagination/ListConnectorsPaginator.ts @@ -0,0 +1,59 @@ +import { Paginator } from "@aws-sdk/types"; + +import { Appflow } from "../Appflow"; +import { AppflowClient } from "../AppflowClient"; +import { + ListConnectorsCommand, + ListConnectorsCommandInput, + ListConnectorsCommandOutput, +} from "../commands/ListConnectorsCommand"; +import { AppflowPaginationConfiguration } from "./Interfaces"; + +/** + * @private + */ +const makePagedClientRequest = async ( + client: AppflowClient, + input: ListConnectorsCommandInput, + ...args: any +): Promise => { + // @ts-ignore + return await client.send(new ListConnectorsCommand(input), ...args); +}; +/** + * @private + */ +const makePagedRequest = async ( + client: Appflow, + input: ListConnectorsCommandInput, + ...args: any +): Promise => { + // @ts-ignore + return await client.listConnectors(input, ...args); +}; +export async function* paginateListConnectors( + config: AppflowPaginationConfiguration, + input: ListConnectorsCommandInput, + ...additionalArguments: any +): Paginator { + // ToDo: replace with actual type instead of typeof input.nextToken + let token: typeof input.nextToken | undefined = config.startingToken || undefined; + let hasNext = true; + let page: ListConnectorsCommandOutput; + while (hasNext) { + input.nextToken = token; + input["maxResults"] = config.pageSize; + if (config.client instanceof Appflow) { + page = await makePagedRequest(config.client, input, ...additionalArguments); + } else if (config.client instanceof AppflowClient) { + page = await makePagedClientRequest(config.client, input, ...additionalArguments); + } else { + throw new Error("Invalid client, expected Appflow | AppflowClient"); + } + yield page; + token = page.nextToken; + hasNext = !!token; + } + // @ts-ignore + return undefined; +} diff --git a/clients/client-appflow/src/pagination/index.ts b/clients/client-appflow/src/pagination/index.ts index 353af3a405ab0..7ccf4ffc5c086 100644 --- a/clients/client-appflow/src/pagination/index.ts +++ b/clients/client-appflow/src/pagination/index.ts @@ -2,4 +2,5 @@ export * from "./DescribeConnectorProfilesPaginator"; export * from "./DescribeConnectorsPaginator"; export * from "./DescribeFlowExecutionRecordsPaginator"; export * from "./Interfaces"; +export * from "./ListConnectorsPaginator"; export * from "./ListFlowsPaginator"; diff --git a/clients/client-appflow/src/protocols/Aws_restJson1.ts b/clients/client-appflow/src/protocols/Aws_restJson1.ts index 456b918c15dec..ffa8eea56bdd3 100644 --- a/clients/client-appflow/src/protocols/Aws_restJson1.ts +++ b/clients/client-appflow/src/protocols/Aws_restJson1.ts @@ -8,6 +8,7 @@ import { expectObject as __expectObject, expectString as __expectString, extendedEncodeURIComponent as __extendedEncodeURIComponent, + limitedParseDouble as __limitedParseDouble, parseEpochTimestamp as __parseEpochTimestamp, } from "@aws-sdk/smithy-client"; import { @@ -28,6 +29,7 @@ import { DeleteConnectorProfileCommandOutput, } from "../commands/DeleteConnectorProfileCommand"; import { DeleteFlowCommandInput, DeleteFlowCommandOutput } from "../commands/DeleteFlowCommand"; +import { DescribeConnectorCommandInput, DescribeConnectorCommandOutput } from "../commands/DescribeConnectorCommand"; import { DescribeConnectorEntityCommandInput, DescribeConnectorEntityCommandOutput, @@ -46,14 +48,20 @@ import { ListConnectorEntitiesCommandInput, ListConnectorEntitiesCommandOutput, } from "../commands/ListConnectorEntitiesCommand"; +import { ListConnectorsCommandInput, ListConnectorsCommandOutput } from "../commands/ListConnectorsCommand"; import { ListFlowsCommandInput, ListFlowsCommandOutput } from "../commands/ListFlowsCommand"; import { ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput, } from "../commands/ListTagsForResourceCommand"; +import { RegisterConnectorCommandInput, RegisterConnectorCommandOutput } from "../commands/RegisterConnectorCommand"; import { StartFlowCommandInput, StartFlowCommandOutput } from "../commands/StartFlowCommand"; import { StopFlowCommandInput, StopFlowCommandOutput } from "../commands/StopFlowCommand"; import { TagResourceCommandInput, TagResourceCommandOutput } from "../commands/TagResourceCommand"; +import { + UnregisterConnectorCommandInput, + UnregisterConnectorCommandOutput, +} from "../commands/UnregisterConnectorCommand"; import { UntagResourceCommandInput, UntagResourceCommandOutput } from "../commands/UntagResourceCommand"; import { UpdateConnectorProfileCommandInput, @@ -61,15 +69,20 @@ import { } from "../commands/UpdateConnectorProfileCommand"; import { UpdateFlowCommandInput, UpdateFlowCommandOutput } from "../commands/UpdateFlowCommand"; import { + AccessDeniedException, AggregationConfig, AmplitudeConnectorProfileCredentials, AmplitudeConnectorProfileProperties, AmplitudeMetadata, AmplitudeSourceProperties, + ApiKeyCredentials, + AuthenticationConfig, + AuthParameter, BasicAuthCredentials, ConflictException, ConnectorAuthenticationException, ConnectorConfiguration, + ConnectorDetail, ConnectorEntity, ConnectorEntityField, ConnectorMetadata, @@ -79,8 +92,16 @@ import { ConnectorProfileConfig, ConnectorProfileCredentials, ConnectorProfileProperties, + ConnectorProvisioningConfig, + ConnectorRuntimeSetting, ConnectorServerException, ConnectorType, + CustomAuthConfig, + CustomAuthCredentials, + CustomConnectorDestinationProperties, + CustomConnectorProfileCredentials, + CustomConnectorProfileProperties, + CustomConnectorSourceProperties, CustomerProfilesDestinationProperties, CustomerProfilesMetadata, DatadogConnectorProfileCredentials, @@ -117,17 +138,24 @@ import { InforNexusMetadata, InforNexusSourceProperties, InternalServerException, + LambdaConnectorProvisioningConfig, LookoutMetricsDestinationProperties, MarketoConnectorProfileCredentials, MarketoConnectorProfileProperties, MarketoMetadata, MarketoSourceProperties, + OAuth2Credentials, + OAuth2Defaults, + OAuth2GrantType, + OAuth2Properties, OAuthCredentials, OAuthProperties, Operator, OperatorPropertiesKeys, + Operators, PrefixConfig, PrivateConnectionProvisioningState, + Range, RedshiftConnectorProfileCredentials, RedshiftConnectorProfileProperties, RedshiftDestinationProperties, @@ -171,6 +199,7 @@ import { SourceFlowConfig, SupportedFieldTypeDetails, Task, + ThrottlingException, TrendmicroConnectorProfileCredentials, TrendmicroConnectorProfileProperties, TrendmicroMetadata, @@ -209,6 +238,8 @@ export const serializeAws_restJson1CreateConnectorProfileCommand = async ( body = JSON.stringify({ ...(input.connectionMode !== undefined && input.connectionMode !== null && { connectionMode: input.connectionMode }), + ...(input.connectorLabel !== undefined && + input.connectorLabel !== null && { connectorLabel: input.connectorLabel }), ...(input.connectorProfileConfig !== undefined && input.connectorProfileConfig !== null && { connectorProfileConfig: serializeAws_restJson1ConnectorProfileConfig(input.connectorProfileConfig, context), @@ -325,6 +356,32 @@ export const serializeAws_restJson1DeleteFlowCommand = async ( }); }; +export const serializeAws_restJson1DescribeConnectorCommand = async ( + input: DescribeConnectorCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const { hostname, protocol = "https", port, path: basePath } = await context.endpoint(); + const headers: any = { + "content-type": "application/json", + }; + const resolvedPath = `${basePath?.endsWith("/") ? basePath.slice(0, -1) : basePath || ""}` + "/describe-connector"; + let body: any; + body = JSON.stringify({ + ...(input.connectorLabel !== undefined && + input.connectorLabel !== null && { connectorLabel: input.connectorLabel }), + ...(input.connectorType !== undefined && input.connectorType !== null && { connectorType: input.connectorType }), + }); + return new __HttpRequest({ + protocol, + hostname, + port, + method: "POST", + headers, + path: resolvedPath, + body, + }); +}; + export const serializeAws_restJson1DescribeConnectorEntityCommand = async ( input: DescribeConnectorEntityCommandInput, context: __SerdeContext @@ -337,6 +394,7 @@ export const serializeAws_restJson1DescribeConnectorEntityCommand = async ( `${basePath?.endsWith("/") ? basePath.slice(0, -1) : basePath || ""}` + "/describe-connector-entity"; let body: any; body = JSON.stringify({ + ...(input.apiVersion !== undefined && input.apiVersion !== null && { apiVersion: input.apiVersion }), ...(input.connectorEntityName !== undefined && input.connectorEntityName !== null && { connectorEntityName: input.connectorEntityName }), ...(input.connectorProfileName !== undefined && @@ -366,6 +424,8 @@ export const serializeAws_restJson1DescribeConnectorProfilesCommand = async ( `${basePath?.endsWith("/") ? basePath.slice(0, -1) : basePath || ""}` + "/describe-connector-profiles"; let body: any; body = JSON.stringify({ + ...(input.connectorLabel !== undefined && + input.connectorLabel !== null && { connectorLabel: input.connectorLabel }), ...(input.connectorProfileNames !== undefined && input.connectorProfileNames !== null && { connectorProfileNames: serializeAws_restJson1ConnectorProfileNameList(input.connectorProfileNames, context), @@ -400,6 +460,7 @@ export const serializeAws_restJson1DescribeConnectorsCommand = async ( input.connectorTypes !== null && { connectorTypes: serializeAws_restJson1ConnectorTypeList(input.connectorTypes, context), }), + ...(input.maxResults !== undefined && input.maxResults !== null && { maxResults: input.maxResults }), ...(input.nextToken !== undefined && input.nextToken !== null && { nextToken: input.nextToken }), }); return new __HttpRequest({ @@ -476,6 +537,7 @@ export const serializeAws_restJson1ListConnectorEntitiesCommand = async ( `${basePath?.endsWith("/") ? basePath.slice(0, -1) : basePath || ""}` + "/list-connector-entities"; let body: any; body = JSON.stringify({ + ...(input.apiVersion !== undefined && input.apiVersion !== null && { apiVersion: input.apiVersion }), ...(input.connectorProfileName !== undefined && input.connectorProfileName !== null && { connectorProfileName: input.connectorProfileName }), ...(input.connectorType !== undefined && input.connectorType !== null && { connectorType: input.connectorType }), @@ -492,6 +554,31 @@ export const serializeAws_restJson1ListConnectorEntitiesCommand = async ( }); }; +export const serializeAws_restJson1ListConnectorsCommand = async ( + input: ListConnectorsCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const { hostname, protocol = "https", port, path: basePath } = await context.endpoint(); + const headers: any = { + "content-type": "application/json", + }; + const resolvedPath = `${basePath?.endsWith("/") ? basePath.slice(0, -1) : basePath || ""}` + "/list-connectors"; + let body: any; + body = JSON.stringify({ + ...(input.maxResults !== undefined && input.maxResults !== null && { maxResults: input.maxResults }), + ...(input.nextToken !== undefined && input.nextToken !== null && { nextToken: input.nextToken }), + }); + return new __HttpRequest({ + protocol, + hostname, + port, + method: "POST", + headers, + path: resolvedPath, + body, + }); +}; + export const serializeAws_restJson1ListFlowsCommand = async ( input: ListFlowsCommandInput, context: __SerdeContext @@ -545,6 +632,41 @@ export const serializeAws_restJson1ListTagsForResourceCommand = async ( }); }; +export const serializeAws_restJson1RegisterConnectorCommand = async ( + input: RegisterConnectorCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const { hostname, protocol = "https", port, path: basePath } = await context.endpoint(); + const headers: any = { + "content-type": "application/json", + }; + const resolvedPath = `${basePath?.endsWith("/") ? basePath.slice(0, -1) : basePath || ""}` + "/register-connector"; + let body: any; + body = JSON.stringify({ + ...(input.connectorLabel !== undefined && + input.connectorLabel !== null && { connectorLabel: input.connectorLabel }), + ...(input.connectorProvisioningConfig !== undefined && + input.connectorProvisioningConfig !== null && { + connectorProvisioningConfig: serializeAws_restJson1ConnectorProvisioningConfig( + input.connectorProvisioningConfig, + context + ), + }), + ...(input.connectorProvisioningType !== undefined && + input.connectorProvisioningType !== null && { connectorProvisioningType: input.connectorProvisioningType }), + ...(input.description !== undefined && input.description !== null && { description: input.description }), + }); + return new __HttpRequest({ + protocol, + hostname, + port, + method: "POST", + headers, + path: resolvedPath, + body, + }); +}; + export const serializeAws_restJson1StartFlowCommand = async ( input: StartFlowCommandInput, context: __SerdeContext @@ -626,6 +748,32 @@ export const serializeAws_restJson1TagResourceCommand = async ( }); }; +export const serializeAws_restJson1UnregisterConnectorCommand = async ( + input: UnregisterConnectorCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const { hostname, protocol = "https", port, path: basePath } = await context.endpoint(); + const headers: any = { + "content-type": "application/json", + }; + const resolvedPath = `${basePath?.endsWith("/") ? basePath.slice(0, -1) : basePath || ""}` + "/unregister-connector"; + let body: any; + body = JSON.stringify({ + ...(input.connectorLabel !== undefined && + input.connectorLabel !== null && { connectorLabel: input.connectorLabel }), + ...(input.forceDelete !== undefined && input.forceDelete !== null && { forceDelete: input.forceDelete }), + }); + return new __HttpRequest({ + protocol, + hostname, + port, + method: "POST", + headers, + path: resolvedPath, + body, + }); +}; + export const serializeAws_restJson1UntagResourceCommand = async ( input: UntagResourceCommandInput, context: __SerdeContext @@ -1060,6 +1208,80 @@ const deserializeAws_restJson1DeleteFlowCommandError = async ( return Promise.reject(Object.assign(new Error(message), response)); }; +export const deserializeAws_restJson1DescribeConnectorCommand = async ( + output: __HttpResponse, + context: __SerdeContext +): Promise => { + if (output.statusCode !== 200 && output.statusCode >= 300) { + return deserializeAws_restJson1DescribeConnectorCommandError(output, context); + } + const contents: DescribeConnectorCommandOutput = { + $metadata: deserializeMetadata(output), + connectorConfiguration: undefined, + }; + const data: { [key: string]: any } = __expectNonNull(__expectObject(await parseBody(output.body, context)), "body"); + if (data.connectorConfiguration !== undefined && data.connectorConfiguration !== null) { + contents.connectorConfiguration = deserializeAws_restJson1ConnectorConfiguration( + data.connectorConfiguration, + context + ); + } + return Promise.resolve(contents); +}; + +const deserializeAws_restJson1DescribeConnectorCommandError = async ( + output: __HttpResponse, + context: __SerdeContext +): Promise => { + const parsedOutput: any = { + ...output, + body: await parseBody(output.body, context), + }; + let response: __SmithyException & __MetadataBearer & { [key: string]: any }; + let errorCode = "UnknownError"; + errorCode = loadRestJsonErrorCode(output, parsedOutput.body); + switch (errorCode) { + case "InternalServerException": + case "com.amazonaws.appflow#InternalServerException": + response = { + ...(await deserializeAws_restJson1InternalServerExceptionResponse(parsedOutput, context)), + name: errorCode, + $metadata: deserializeMetadata(output), + }; + break; + case "ResourceNotFoundException": + case "com.amazonaws.appflow#ResourceNotFoundException": + response = { + ...(await deserializeAws_restJson1ResourceNotFoundExceptionResponse(parsedOutput, context)), + name: errorCode, + $metadata: deserializeMetadata(output), + }; + break; + case "ValidationException": + case "com.amazonaws.appflow#ValidationException": + response = { + ...(await deserializeAws_restJson1ValidationExceptionResponse(parsedOutput, context)), + name: errorCode, + $metadata: deserializeMetadata(output), + }; + break; + default: + const parsedBody = parsedOutput.body; + errorCode = parsedBody.code || parsedBody.Code || errorCode; + response = { + ...parsedBody, + name: `${errorCode}`, + message: parsedBody.message || parsedBody.Message || errorCode, + $fault: "client", + $metadata: deserializeMetadata(output), + } as any; + } + const message = response.message || response.Message || errorCode; + response.message = message; + delete response.Message; + return Promise.reject(Object.assign(new Error(message), response)); +}; + export const deserializeAws_restJson1DescribeConnectorEntityCommand = async ( output: __HttpResponse, context: __SerdeContext @@ -1230,6 +1452,7 @@ export const deserializeAws_restJson1DescribeConnectorsCommand = async ( const contents: DescribeConnectorsCommandOutput = { $metadata: deserializeMetadata(output), connectorConfigurations: undefined, + connectors: undefined, nextToken: undefined, }; const data: { [key: string]: any } = __expectNonNull(__expectObject(await parseBody(output.body, context)), "body"); @@ -1239,6 +1462,9 @@ export const deserializeAws_restJson1DescribeConnectorsCommand = async ( context ); } + if (data.connectors !== undefined && data.connectors !== null) { + contents.connectors = deserializeAws_restJson1ConnectorList(data.connectors, context); + } if (data.nextToken !== undefined && data.nextToken !== null) { contents.nextToken = __expectString(data.nextToken); } @@ -1578,21 +1804,21 @@ const deserializeAws_restJson1ListConnectorEntitiesCommandError = async ( return Promise.reject(Object.assign(new Error(message), response)); }; -export const deserializeAws_restJson1ListFlowsCommand = async ( +export const deserializeAws_restJson1ListConnectorsCommand = async ( output: __HttpResponse, context: __SerdeContext -): Promise => { +): Promise => { if (output.statusCode !== 200 && output.statusCode >= 300) { - return deserializeAws_restJson1ListFlowsCommandError(output, context); + return deserializeAws_restJson1ListConnectorsCommandError(output, context); } - const contents: ListFlowsCommandOutput = { + const contents: ListConnectorsCommandOutput = { $metadata: deserializeMetadata(output), - flows: undefined, + connectors: undefined, nextToken: undefined, }; const data: { [key: string]: any } = __expectNonNull(__expectObject(await parseBody(output.body, context)), "body"); - if (data.flows !== undefined && data.flows !== null) { - contents.flows = deserializeAws_restJson1FlowList(data.flows, context); + if (data.connectors !== undefined && data.connectors !== null) { + contents.connectors = deserializeAws_restJson1ConnectorList(data.connectors, context); } if (data.nextToken !== undefined && data.nextToken !== null) { contents.nextToken = __expectString(data.nextToken); @@ -1600,10 +1826,10 @@ export const deserializeAws_restJson1ListFlowsCommand = async ( return Promise.resolve(contents); }; -const deserializeAws_restJson1ListFlowsCommandError = async ( +const deserializeAws_restJson1ListConnectorsCommandError = async ( output: __HttpResponse, context: __SerdeContext -): Promise => { +): Promise => { const parsedOutput: any = { ...output, body: await parseBody(output.body, context), @@ -1645,28 +1871,32 @@ const deserializeAws_restJson1ListFlowsCommandError = async ( return Promise.reject(Object.assign(new Error(message), response)); }; -export const deserializeAws_restJson1ListTagsForResourceCommand = async ( +export const deserializeAws_restJson1ListFlowsCommand = async ( output: __HttpResponse, context: __SerdeContext -): Promise => { +): Promise => { if (output.statusCode !== 200 && output.statusCode >= 300) { - return deserializeAws_restJson1ListTagsForResourceCommandError(output, context); + return deserializeAws_restJson1ListFlowsCommandError(output, context); } - const contents: ListTagsForResourceCommandOutput = { + const contents: ListFlowsCommandOutput = { $metadata: deserializeMetadata(output), - tags: undefined, + flows: undefined, + nextToken: undefined, }; const data: { [key: string]: any } = __expectNonNull(__expectObject(await parseBody(output.body, context)), "body"); - if (data.tags !== undefined && data.tags !== null) { - contents.tags = deserializeAws_restJson1TagMap(data.tags, context); + if (data.flows !== undefined && data.flows !== null) { + contents.flows = deserializeAws_restJson1FlowList(data.flows, context); + } + if (data.nextToken !== undefined && data.nextToken !== null) { + contents.nextToken = __expectString(data.nextToken); } return Promise.resolve(contents); }; -const deserializeAws_restJson1ListTagsForResourceCommandError = async ( +const deserializeAws_restJson1ListFlowsCommandError = async ( output: __HttpResponse, context: __SerdeContext -): Promise => { +): Promise => { const parsedOutput: any = { ...output, body: await parseBody(output.body, context), @@ -1683,14 +1913,6 @@ const deserializeAws_restJson1ListTagsForResourceCommandError = async ( $metadata: deserializeMetadata(output), }; break; - case "ResourceNotFoundException": - case "com.amazonaws.appflow#ResourceNotFoundException": - response = { - ...(await deserializeAws_restJson1ResourceNotFoundExceptionResponse(parsedOutput, context)), - name: errorCode, - $metadata: deserializeMetadata(output), - }; - break; case "ValidationException": case "com.amazonaws.appflow#ValidationException": response = { @@ -1716,36 +1938,28 @@ const deserializeAws_restJson1ListTagsForResourceCommandError = async ( return Promise.reject(Object.assign(new Error(message), response)); }; -export const deserializeAws_restJson1StartFlowCommand = async ( +export const deserializeAws_restJson1ListTagsForResourceCommand = async ( output: __HttpResponse, context: __SerdeContext -): Promise => { +): Promise => { if (output.statusCode !== 200 && output.statusCode >= 300) { - return deserializeAws_restJson1StartFlowCommandError(output, context); + return deserializeAws_restJson1ListTagsForResourceCommandError(output, context); } - const contents: StartFlowCommandOutput = { + const contents: ListTagsForResourceCommandOutput = { $metadata: deserializeMetadata(output), - executionId: undefined, - flowArn: undefined, - flowStatus: undefined, + tags: undefined, }; const data: { [key: string]: any } = __expectNonNull(__expectObject(await parseBody(output.body, context)), "body"); - if (data.executionId !== undefined && data.executionId !== null) { - contents.executionId = __expectString(data.executionId); - } - if (data.flowArn !== undefined && data.flowArn !== null) { - contents.flowArn = __expectString(data.flowArn); - } - if (data.flowStatus !== undefined && data.flowStatus !== null) { - contents.flowStatus = __expectString(data.flowStatus); + if (data.tags !== undefined && data.tags !== null) { + contents.tags = deserializeAws_restJson1TagMap(data.tags, context); } return Promise.resolve(contents); }; -const deserializeAws_restJson1StartFlowCommandError = async ( +const deserializeAws_restJson1ListTagsForResourceCommandError = async ( output: __HttpResponse, context: __SerdeContext -): Promise => { +): Promise => { const parsedOutput: any = { ...output, body: await parseBody(output.body, context), @@ -1754,14 +1968,6 @@ const deserializeAws_restJson1StartFlowCommandError = async ( let errorCode = "UnknownError"; errorCode = loadRestJsonErrorCode(output, parsedOutput.body); switch (errorCode) { - case "ConflictException": - case "com.amazonaws.appflow#ConflictException": - response = { - ...(await deserializeAws_restJson1ConflictExceptionResponse(parsedOutput, context)), - name: errorCode, - $metadata: deserializeMetadata(output), - }; - break; case "InternalServerException": case "com.amazonaws.appflow#InternalServerException": response = { @@ -1778,10 +1984,10 @@ const deserializeAws_restJson1StartFlowCommandError = async ( $metadata: deserializeMetadata(output), }; break; - case "ServiceQuotaExceededException": - case "com.amazonaws.appflow#ServiceQuotaExceededException": + case "ValidationException": + case "com.amazonaws.appflow#ValidationException": response = { - ...(await deserializeAws_restJson1ServiceQuotaExceededExceptionResponse(parsedOutput, context)), + ...(await deserializeAws_restJson1ValidationExceptionResponse(parsedOutput, context)), name: errorCode, $metadata: deserializeMetadata(output), }; @@ -1803,32 +2009,28 @@ const deserializeAws_restJson1StartFlowCommandError = async ( return Promise.reject(Object.assign(new Error(message), response)); }; -export const deserializeAws_restJson1StopFlowCommand = async ( +export const deserializeAws_restJson1RegisterConnectorCommand = async ( output: __HttpResponse, context: __SerdeContext -): Promise => { +): Promise => { if (output.statusCode !== 200 && output.statusCode >= 300) { - return deserializeAws_restJson1StopFlowCommandError(output, context); + return deserializeAws_restJson1RegisterConnectorCommandError(output, context); } - const contents: StopFlowCommandOutput = { + const contents: RegisterConnectorCommandOutput = { $metadata: deserializeMetadata(output), - flowArn: undefined, - flowStatus: undefined, + connectorArn: undefined, }; const data: { [key: string]: any } = __expectNonNull(__expectObject(await parseBody(output.body, context)), "body"); - if (data.flowArn !== undefined && data.flowArn !== null) { - contents.flowArn = __expectString(data.flowArn); - } - if (data.flowStatus !== undefined && data.flowStatus !== null) { - contents.flowStatus = __expectString(data.flowStatus); + if (data.connectorArn !== undefined && data.connectorArn !== null) { + contents.connectorArn = __expectString(data.connectorArn); } return Promise.resolve(contents); }; -const deserializeAws_restJson1StopFlowCommandError = async ( +const deserializeAws_restJson1RegisterConnectorCommandError = async ( output: __HttpResponse, context: __SerdeContext -): Promise => { +): Promise => { const parsedOutput: any = { ...output, body: await parseBody(output.body, context), @@ -1837,18 +2039,228 @@ const deserializeAws_restJson1StopFlowCommandError = async ( let errorCode = "UnknownError"; errorCode = loadRestJsonErrorCode(output, parsedOutput.body); switch (errorCode) { - case "ConflictException": - case "com.amazonaws.appflow#ConflictException": + case "AccessDeniedException": + case "com.amazonaws.appflow#AccessDeniedException": response = { - ...(await deserializeAws_restJson1ConflictExceptionResponse(parsedOutput, context)), + ...(await deserializeAws_restJson1AccessDeniedExceptionResponse(parsedOutput, context)), name: errorCode, $metadata: deserializeMetadata(output), }; break; - case "InternalServerException": - case "com.amazonaws.appflow#InternalServerException": + case "ConflictException": + case "com.amazonaws.appflow#ConflictException": response = { - ...(await deserializeAws_restJson1InternalServerExceptionResponse(parsedOutput, context)), + ...(await deserializeAws_restJson1ConflictExceptionResponse(parsedOutput, context)), + name: errorCode, + $metadata: deserializeMetadata(output), + }; + break; + case "ConnectorAuthenticationException": + case "com.amazonaws.appflow#ConnectorAuthenticationException": + response = { + ...(await deserializeAws_restJson1ConnectorAuthenticationExceptionResponse(parsedOutput, context)), + name: errorCode, + $metadata: deserializeMetadata(output), + }; + break; + case "ConnectorServerException": + case "com.amazonaws.appflow#ConnectorServerException": + response = { + ...(await deserializeAws_restJson1ConnectorServerExceptionResponse(parsedOutput, context)), + name: errorCode, + $metadata: deserializeMetadata(output), + }; + break; + case "InternalServerException": + case "com.amazonaws.appflow#InternalServerException": + response = { + ...(await deserializeAws_restJson1InternalServerExceptionResponse(parsedOutput, context)), + name: errorCode, + $metadata: deserializeMetadata(output), + }; + break; + case "ResourceNotFoundException": + case "com.amazonaws.appflow#ResourceNotFoundException": + response = { + ...(await deserializeAws_restJson1ResourceNotFoundExceptionResponse(parsedOutput, context)), + name: errorCode, + $metadata: deserializeMetadata(output), + }; + break; + case "ServiceQuotaExceededException": + case "com.amazonaws.appflow#ServiceQuotaExceededException": + response = { + ...(await deserializeAws_restJson1ServiceQuotaExceededExceptionResponse(parsedOutput, context)), + name: errorCode, + $metadata: deserializeMetadata(output), + }; + break; + case "ThrottlingException": + case "com.amazonaws.appflow#ThrottlingException": + response = { + ...(await deserializeAws_restJson1ThrottlingExceptionResponse(parsedOutput, context)), + name: errorCode, + $metadata: deserializeMetadata(output), + }; + break; + case "ValidationException": + case "com.amazonaws.appflow#ValidationException": + response = { + ...(await deserializeAws_restJson1ValidationExceptionResponse(parsedOutput, context)), + name: errorCode, + $metadata: deserializeMetadata(output), + }; + break; + default: + const parsedBody = parsedOutput.body; + errorCode = parsedBody.code || parsedBody.Code || errorCode; + response = { + ...parsedBody, + name: `${errorCode}`, + message: parsedBody.message || parsedBody.Message || errorCode, + $fault: "client", + $metadata: deserializeMetadata(output), + } as any; + } + const message = response.message || response.Message || errorCode; + response.message = message; + delete response.Message; + return Promise.reject(Object.assign(new Error(message), response)); +}; + +export const deserializeAws_restJson1StartFlowCommand = async ( + output: __HttpResponse, + context: __SerdeContext +): Promise => { + if (output.statusCode !== 200 && output.statusCode >= 300) { + return deserializeAws_restJson1StartFlowCommandError(output, context); + } + const contents: StartFlowCommandOutput = { + $metadata: deserializeMetadata(output), + executionId: undefined, + flowArn: undefined, + flowStatus: undefined, + }; + const data: { [key: string]: any } = __expectNonNull(__expectObject(await parseBody(output.body, context)), "body"); + if (data.executionId !== undefined && data.executionId !== null) { + contents.executionId = __expectString(data.executionId); + } + if (data.flowArn !== undefined && data.flowArn !== null) { + contents.flowArn = __expectString(data.flowArn); + } + if (data.flowStatus !== undefined && data.flowStatus !== null) { + contents.flowStatus = __expectString(data.flowStatus); + } + return Promise.resolve(contents); +}; + +const deserializeAws_restJson1StartFlowCommandError = async ( + output: __HttpResponse, + context: __SerdeContext +): Promise => { + const parsedOutput: any = { + ...output, + body: await parseBody(output.body, context), + }; + let response: __SmithyException & __MetadataBearer & { [key: string]: any }; + let errorCode = "UnknownError"; + errorCode = loadRestJsonErrorCode(output, parsedOutput.body); + switch (errorCode) { + case "ConflictException": + case "com.amazonaws.appflow#ConflictException": + response = { + ...(await deserializeAws_restJson1ConflictExceptionResponse(parsedOutput, context)), + name: errorCode, + $metadata: deserializeMetadata(output), + }; + break; + case "InternalServerException": + case "com.amazonaws.appflow#InternalServerException": + response = { + ...(await deserializeAws_restJson1InternalServerExceptionResponse(parsedOutput, context)), + name: errorCode, + $metadata: deserializeMetadata(output), + }; + break; + case "ResourceNotFoundException": + case "com.amazonaws.appflow#ResourceNotFoundException": + response = { + ...(await deserializeAws_restJson1ResourceNotFoundExceptionResponse(parsedOutput, context)), + name: errorCode, + $metadata: deserializeMetadata(output), + }; + break; + case "ServiceQuotaExceededException": + case "com.amazonaws.appflow#ServiceQuotaExceededException": + response = { + ...(await deserializeAws_restJson1ServiceQuotaExceededExceptionResponse(parsedOutput, context)), + name: errorCode, + $metadata: deserializeMetadata(output), + }; + break; + default: + const parsedBody = parsedOutput.body; + errorCode = parsedBody.code || parsedBody.Code || errorCode; + response = { + ...parsedBody, + name: `${errorCode}`, + message: parsedBody.message || parsedBody.Message || errorCode, + $fault: "client", + $metadata: deserializeMetadata(output), + } as any; + } + const message = response.message || response.Message || errorCode; + response.message = message; + delete response.Message; + return Promise.reject(Object.assign(new Error(message), response)); +}; + +export const deserializeAws_restJson1StopFlowCommand = async ( + output: __HttpResponse, + context: __SerdeContext +): Promise => { + if (output.statusCode !== 200 && output.statusCode >= 300) { + return deserializeAws_restJson1StopFlowCommandError(output, context); + } + const contents: StopFlowCommandOutput = { + $metadata: deserializeMetadata(output), + flowArn: undefined, + flowStatus: undefined, + }; + const data: { [key: string]: any } = __expectNonNull(__expectObject(await parseBody(output.body, context)), "body"); + if (data.flowArn !== undefined && data.flowArn !== null) { + contents.flowArn = __expectString(data.flowArn); + } + if (data.flowStatus !== undefined && data.flowStatus !== null) { + contents.flowStatus = __expectString(data.flowStatus); + } + return Promise.resolve(contents); +}; + +const deserializeAws_restJson1StopFlowCommandError = async ( + output: __HttpResponse, + context: __SerdeContext +): Promise => { + const parsedOutput: any = { + ...output, + body: await parseBody(output.body, context), + }; + let response: __SmithyException & __MetadataBearer & { [key: string]: any }; + let errorCode = "UnknownError"; + errorCode = loadRestJsonErrorCode(output, parsedOutput.body); + switch (errorCode) { + case "ConflictException": + case "com.amazonaws.appflow#ConflictException": + response = { + ...(await deserializeAws_restJson1ConflictExceptionResponse(parsedOutput, context)), + name: errorCode, + $metadata: deserializeMetadata(output), + }; + break; + case "InternalServerException": + case "com.amazonaws.appflow#InternalServerException": + response = { + ...(await deserializeAws_restJson1InternalServerExceptionResponse(parsedOutput, context)), name: errorCode, $metadata: deserializeMetadata(output), }; @@ -1953,6 +2365,73 @@ const deserializeAws_restJson1TagResourceCommandError = async ( return Promise.reject(Object.assign(new Error(message), response)); }; +export const deserializeAws_restJson1UnregisterConnectorCommand = async ( + output: __HttpResponse, + context: __SerdeContext +): Promise => { + if (output.statusCode !== 200 && output.statusCode >= 300) { + return deserializeAws_restJson1UnregisterConnectorCommandError(output, context); + } + const contents: UnregisterConnectorCommandOutput = { + $metadata: deserializeMetadata(output), + }; + await collectBody(output.body, context); + return Promise.resolve(contents); +}; + +const deserializeAws_restJson1UnregisterConnectorCommandError = async ( + output: __HttpResponse, + context: __SerdeContext +): Promise => { + const parsedOutput: any = { + ...output, + body: await parseBody(output.body, context), + }; + let response: __SmithyException & __MetadataBearer & { [key: string]: any }; + let errorCode = "UnknownError"; + errorCode = loadRestJsonErrorCode(output, parsedOutput.body); + switch (errorCode) { + case "ConflictException": + case "com.amazonaws.appflow#ConflictException": + response = { + ...(await deserializeAws_restJson1ConflictExceptionResponse(parsedOutput, context)), + name: errorCode, + $metadata: deserializeMetadata(output), + }; + break; + case "InternalServerException": + case "com.amazonaws.appflow#InternalServerException": + response = { + ...(await deserializeAws_restJson1InternalServerExceptionResponse(parsedOutput, context)), + name: errorCode, + $metadata: deserializeMetadata(output), + }; + break; + case "ResourceNotFoundException": + case "com.amazonaws.appflow#ResourceNotFoundException": + response = { + ...(await deserializeAws_restJson1ResourceNotFoundExceptionResponse(parsedOutput, context)), + name: errorCode, + $metadata: deserializeMetadata(output), + }; + break; + default: + const parsedBody = parsedOutput.body; + errorCode = parsedBody.code || parsedBody.Code || errorCode; + response = { + ...parsedBody, + name: `${errorCode}`, + message: parsedBody.message || parsedBody.Message || errorCode, + $fault: "client", + $metadata: deserializeMetadata(output), + } as any; + } + const message = response.message || response.Message || errorCode; + response.message = message; + delete response.Message; + return Promise.reject(Object.assign(new Error(message), response)); +}; + export const deserializeAws_restJson1UntagResourceCommand = async ( output: __HttpResponse, context: __SerdeContext @@ -2210,6 +2689,23 @@ const deserializeAws_restJson1UpdateFlowCommandError = async ( return Promise.reject(Object.assign(new Error(message), response)); }; +const deserializeAws_restJson1AccessDeniedExceptionResponse = async ( + parsedOutput: any, + context: __SerdeContext +): Promise => { + const contents: AccessDeniedException = { + name: "AccessDeniedException", + $fault: "client", + $metadata: deserializeMetadata(parsedOutput), + message: undefined, + }; + const data: any = parsedOutput.body; + if (data.message !== undefined && data.message !== null) { + contents.message = __expectString(data.message); + } + return contents; +}; + const deserializeAws_restJson1ConflictExceptionResponse = async ( parsedOutput: any, context: __SerdeContext @@ -2312,6 +2808,23 @@ const deserializeAws_restJson1ServiceQuotaExceededExceptionResponse = async ( return contents; }; +const deserializeAws_restJson1ThrottlingExceptionResponse = async ( + parsedOutput: any, + context: __SerdeContext +): Promise => { + const contents: ThrottlingException = { + name: "ThrottlingException", + $fault: "client", + $metadata: deserializeMetadata(parsedOutput), + message: undefined, + }; + const data: any = parsedOutput.body; + if (data.message !== undefined && data.message !== null) { + contents.message = __expectString(data.message); + } + return contents; +}; + const deserializeAws_restJson1UnsupportedOperationExceptionResponse = async ( parsedOutput: any, context: __SerdeContext @@ -2379,6 +2892,13 @@ const serializeAws_restJson1AmplitudeSourceProperties = ( }; }; +const serializeAws_restJson1ApiKeyCredentials = (input: ApiKeyCredentials, context: __SerdeContext): any => { + return { + ...(input.apiKey !== undefined && input.apiKey !== null && { apiKey: input.apiKey }), + ...(input.apiSecretKey !== undefined && input.apiSecretKey !== null && { apiSecretKey: input.apiSecretKey }), + }; +}; + const serializeAws_restJson1BasicAuthCredentials = (input: BasicAuthCredentials, context: __SerdeContext): any => { return { ...(input.password !== undefined && input.password !== null && { password: input.password }), @@ -2396,6 +2916,8 @@ const serializeAws_restJson1ConnectorOAuthRequest = (input: ConnectorOAuthReques const serializeAws_restJson1ConnectorOperator = (input: ConnectorOperator, context: __SerdeContext): any => { return { ...(input.Amplitude !== undefined && input.Amplitude !== null && { Amplitude: input.Amplitude }), + ...(input.CustomConnector !== undefined && + input.CustomConnector !== null && { CustomConnector: input.CustomConnector }), ...(input.Datadog !== undefined && input.Datadog !== null && { Datadog: input.Datadog }), ...(input.Dynatrace !== undefined && input.Dynatrace !== null && { Dynatrace: input.Dynatrace }), ...(input.GoogleAnalytics !== undefined && @@ -2442,6 +2964,10 @@ const serializeAws_restJson1ConnectorProfileCredentials = ( input.Amplitude !== null && { Amplitude: serializeAws_restJson1AmplitudeConnectorProfileCredentials(input.Amplitude, context), }), + ...(input.CustomConnector !== undefined && + input.CustomConnector !== null && { + CustomConnector: serializeAws_restJson1CustomConnectorProfileCredentials(input.CustomConnector, context), + }), ...(input.Datadog !== undefined && input.Datadog !== null && { Datadog: serializeAws_restJson1DatadogConnectorProfileCredentials(input.Datadog, context), @@ -2528,6 +3054,10 @@ const serializeAws_restJson1ConnectorProfileProperties = ( input.Amplitude !== null && { Amplitude: serializeAws_restJson1AmplitudeConnectorProfileProperties(input.Amplitude, context), }), + ...(input.CustomConnector !== undefined && + input.CustomConnector !== null && { + CustomConnector: serializeAws_restJson1CustomConnectorProfileProperties(input.CustomConnector, context), + }), ...(input.Datadog !== undefined && input.Datadog !== null && { Datadog: serializeAws_restJson1DatadogConnectorProfileProperties(input.Datadog, context), @@ -2594,6 +3124,18 @@ const serializeAws_restJson1ConnectorProfileProperties = ( }; }; +const serializeAws_restJson1ConnectorProvisioningConfig = ( + input: ConnectorProvisioningConfig, + context: __SerdeContext +): any => { + return { + ...(input.lambda !== undefined && + input.lambda !== null && { + lambda: serializeAws_restJson1LambdaConnectorProvisioningConfig(input.lambda, context), + }), + }; +}; + const serializeAws_restJson1ConnectorTypeList = (input: (ConnectorType | string)[], context: __SerdeContext): any => { return input .filter((e: any) => e != null) @@ -2605,6 +3147,99 @@ const serializeAws_restJson1ConnectorTypeList = (input: (ConnectorType | string) }); }; +const serializeAws_restJson1CredentialsMap = (input: { [key: string]: string }, context: __SerdeContext): any => { + return Object.entries(input).reduce((acc: { [key: string]: any }, [key, value]: [string, any]) => { + if (value === null) { + return acc; + } + return { + ...acc, + [key]: value, + }; + }, {}); +}; + +const serializeAws_restJson1CustomAuthCredentials = (input: CustomAuthCredentials, context: __SerdeContext): any => { + return { + ...(input.credentialsMap !== undefined && + input.credentialsMap !== null && { + credentialsMap: serializeAws_restJson1CredentialsMap(input.credentialsMap, context), + }), + ...(input.customAuthenticationType !== undefined && + input.customAuthenticationType !== null && { customAuthenticationType: input.customAuthenticationType }), + }; +}; + +const serializeAws_restJson1CustomConnectorDestinationProperties = ( + input: CustomConnectorDestinationProperties, + context: __SerdeContext +): any => { + return { + ...(input.customProperties !== undefined && + input.customProperties !== null && { + customProperties: serializeAws_restJson1CustomProperties(input.customProperties, context), + }), + ...(input.entityName !== undefined && input.entityName !== null && { entityName: input.entityName }), + ...(input.errorHandlingConfig !== undefined && + input.errorHandlingConfig !== null && { + errorHandlingConfig: serializeAws_restJson1ErrorHandlingConfig(input.errorHandlingConfig, context), + }), + ...(input.idFieldNames !== undefined && + input.idFieldNames !== null && { + idFieldNames: serializeAws_restJson1IdFieldNameList(input.idFieldNames, context), + }), + ...(input.writeOperationType !== undefined && + input.writeOperationType !== null && { writeOperationType: input.writeOperationType }), + }; +}; + +const serializeAws_restJson1CustomConnectorProfileCredentials = ( + input: CustomConnectorProfileCredentials, + context: __SerdeContext +): any => { + return { + ...(input.apiKey !== undefined && + input.apiKey !== null && { apiKey: serializeAws_restJson1ApiKeyCredentials(input.apiKey, context) }), + ...(input.authenticationType !== undefined && + input.authenticationType !== null && { authenticationType: input.authenticationType }), + ...(input.basic !== undefined && + input.basic !== null && { basic: serializeAws_restJson1BasicAuthCredentials(input.basic, context) }), + ...(input.custom !== undefined && + input.custom !== null && { custom: serializeAws_restJson1CustomAuthCredentials(input.custom, context) }), + ...(input.oauth2 !== undefined && + input.oauth2 !== null && { oauth2: serializeAws_restJson1OAuth2Credentials(input.oauth2, context) }), + }; +}; + +const serializeAws_restJson1CustomConnectorProfileProperties = ( + input: CustomConnectorProfileProperties, + context: __SerdeContext +): any => { + return { + ...(input.oAuth2Properties !== undefined && + input.oAuth2Properties !== null && { + oAuth2Properties: serializeAws_restJson1OAuth2Properties(input.oAuth2Properties, context), + }), + ...(input.profileProperties !== undefined && + input.profileProperties !== null && { + profileProperties: serializeAws_restJson1ProfilePropertiesMap(input.profileProperties, context), + }), + }; +}; + +const serializeAws_restJson1CustomConnectorSourceProperties = ( + input: CustomConnectorSourceProperties, + context: __SerdeContext +): any => { + return { + ...(input.customProperties !== undefined && + input.customProperties !== null && { + customProperties: serializeAws_restJson1CustomProperties(input.customProperties, context), + }), + ...(input.entityName !== undefined && input.entityName !== null && { entityName: input.entityName }), + }; +}; + const serializeAws_restJson1CustomerProfilesDestinationProperties = ( input: CustomerProfilesDestinationProperties, context: __SerdeContext @@ -2616,6 +3251,18 @@ const serializeAws_restJson1CustomerProfilesDestinationProperties = ( }; }; +const serializeAws_restJson1CustomProperties = (input: { [key: string]: string }, context: __SerdeContext): any => { + return Object.entries(input).reduce((acc: { [key: string]: any }, [key, value]: [string, any]) => { + if (value === null) { + return acc; + } + return { + ...acc, + [key]: value, + }; + }, {}); +}; + const serializeAws_restJson1DatadogConnectorProfileCredentials = ( input: DatadogConnectorProfileCredentials, context: __SerdeContext @@ -2650,6 +3297,10 @@ const serializeAws_restJson1DestinationConnectorProperties = ( context: __SerdeContext ): any => { return { + ...(input.CustomConnector !== undefined && + input.CustomConnector !== null && { + CustomConnector: serializeAws_restJson1CustomConnectorDestinationProperties(input.CustomConnector, context), + }), ...(input.CustomerProfiles !== undefined && input.CustomerProfiles !== null && { CustomerProfiles: serializeAws_restJson1CustomerProfilesDestinationProperties(input.CustomerProfiles, context), @@ -2693,6 +3344,7 @@ const serializeAws_restJson1DestinationConnectorProperties = ( const serializeAws_restJson1DestinationFlowConfig = (input: DestinationFlowConfig, context: __SerdeContext): any => { return { + ...(input.apiVersion !== undefined && input.apiVersion !== null && { apiVersion: input.apiVersion }), ...(input.connectorProfileName !== undefined && input.connectorProfileName !== null && { connectorProfileName: input.connectorProfileName }), ...(input.connectorType !== undefined && input.connectorType !== null && { connectorType: input.connectorType }), @@ -2884,6 +3536,15 @@ const serializeAws_restJson1InforNexusSourceProperties = ( }; }; +const serializeAws_restJson1LambdaConnectorProvisioningConfig = ( + input: LambdaConnectorProvisioningConfig, + context: __SerdeContext +): any => { + return { + ...(input.lambdaArn !== undefined && input.lambdaArn !== null && { lambdaArn: input.lambdaArn }), + }; +}; + const serializeAws_restJson1LookoutMetricsDestinationProperties = ( input: LookoutMetricsDestinationProperties, context: __SerdeContext @@ -2924,6 +3585,27 @@ const serializeAws_restJson1MarketoSourceProperties = ( }; }; +const serializeAws_restJson1OAuth2Credentials = (input: OAuth2Credentials, context: __SerdeContext): any => { + return { + ...(input.accessToken !== undefined && input.accessToken !== null && { accessToken: input.accessToken }), + ...(input.clientId !== undefined && input.clientId !== null && { clientId: input.clientId }), + ...(input.clientSecret !== undefined && input.clientSecret !== null && { clientSecret: input.clientSecret }), + ...(input.oAuthRequest !== undefined && + input.oAuthRequest !== null && { + oAuthRequest: serializeAws_restJson1ConnectorOAuthRequest(input.oAuthRequest, context), + }), + ...(input.refreshToken !== undefined && input.refreshToken !== null && { refreshToken: input.refreshToken }), + }; +}; + +const serializeAws_restJson1OAuth2Properties = (input: OAuth2Properties, context: __SerdeContext): any => { + return { + ...(input.oAuth2GrantType !== undefined && + input.oAuth2GrantType !== null && { oAuth2GrantType: input.oAuth2GrantType }), + ...(input.tokenUrl !== undefined && input.tokenUrl !== null && { tokenUrl: input.tokenUrl }), + }; +}; + const serializeAws_restJson1OAuthCredentials = (input: OAuthCredentials, context: __SerdeContext): any => { return { ...(input.accessToken !== undefined && input.accessToken !== null && { accessToken: input.accessToken }), @@ -2964,6 +3646,18 @@ const serializeAws_restJson1PrefixConfig = (input: PrefixConfig, context: __Serd }; }; +const serializeAws_restJson1ProfilePropertiesMap = (input: { [key: string]: string }, context: __SerdeContext): any => { + return Object.entries(input).reduce((acc: { [key: string]: any }, [key, value]: [string, any]) => { + if (value === null) { + return acc; + } + return { + ...acc, + [key]: value, + }; + }, {}); +}; + const serializeAws_restJson1RedshiftConnectorProfileCredentials = ( input: RedshiftConnectorProfileCredentials, context: __SerdeContext @@ -3307,6 +4001,10 @@ const serializeAws_restJson1SourceConnectorProperties = ( input.Amplitude !== null && { Amplitude: serializeAws_restJson1AmplitudeSourceProperties(input.Amplitude, context), }), + ...(input.CustomConnector !== undefined && + input.CustomConnector !== null && { + CustomConnector: serializeAws_restJson1CustomConnectorSourceProperties(input.CustomConnector, context), + }), ...(input.Datadog !== undefined && input.Datadog !== null && { Datadog: serializeAws_restJson1DatadogSourceProperties(input.Datadog, context) }), ...(input.Dynatrace !== undefined && @@ -3363,6 +4061,7 @@ const serializeAws_restJson1SourceFields = (input: string[], context: __SerdeCon const serializeAws_restJson1SourceFlowConfig = (input: SourceFlowConfig, context: __SerdeContext): any => { return { + ...(input.apiVersion !== undefined && input.apiVersion !== null && { apiVersion: input.apiVersion }), ...(input.connectorProfileName !== undefined && input.connectorProfileName !== null && { connectorProfileName: input.connectorProfileName }), ...(input.connectorType !== undefined && input.connectorType !== null && { connectorType: input.connectorType }), @@ -3606,36 +4305,127 @@ const deserializeAws_restJson1AmplitudeConnectorProfileProperties = ( return {} as any; }; -const deserializeAws_restJson1AmplitudeMetadata = (output: any, context: __SerdeContext): AmplitudeMetadata => { - return {} as any; +const deserializeAws_restJson1AmplitudeMetadata = (output: any, context: __SerdeContext): AmplitudeMetadata => { + return {} as any; +}; + +const deserializeAws_restJson1AmplitudeSourceProperties = ( + output: any, + context: __SerdeContext +): AmplitudeSourceProperties => { + return { + object: __expectString(output.object), + } as any; +}; + +const deserializeAws_restJson1AuthCodeUrlList = (output: any, context: __SerdeContext): string[] => { + return (output || []) + .filter((e: any) => e != null) + .map((entry: any) => { + if (entry === null) { + return null as any; + } + return __expectString(entry) as any; + }); +}; + +const deserializeAws_restJson1AuthenticationConfig = (output: any, context: __SerdeContext): AuthenticationConfig => { + return { + customAuthConfigs: + output.customAuthConfigs !== undefined && output.customAuthConfigs !== null + ? deserializeAws_restJson1CustomAuthConfigList(output.customAuthConfigs, context) + : undefined, + isApiKeyAuthSupported: __expectBoolean(output.isApiKeyAuthSupported), + isBasicAuthSupported: __expectBoolean(output.isBasicAuthSupported), + isCustomAuthSupported: __expectBoolean(output.isCustomAuthSupported), + isOAuth2Supported: __expectBoolean(output.isOAuth2Supported), + oAuth2Defaults: + output.oAuth2Defaults !== undefined && output.oAuth2Defaults !== null + ? deserializeAws_restJson1OAuth2Defaults(output.oAuth2Defaults, context) + : undefined, + } as any; }; -const deserializeAws_restJson1AmplitudeSourceProperties = ( - output: any, - context: __SerdeContext -): AmplitudeSourceProperties => { +const deserializeAws_restJson1AuthParameter = (output: any, context: __SerdeContext): AuthParameter => { return { - object: __expectString(output.object), + connectorSuppliedValues: + output.connectorSuppliedValues !== undefined && output.connectorSuppliedValues !== null + ? deserializeAws_restJson1ConnectorSuppliedValueList(output.connectorSuppliedValues, context) + : undefined, + description: __expectString(output.description), + isRequired: __expectBoolean(output.isRequired), + isSensitiveField: __expectBoolean(output.isSensitiveField), + key: __expectString(output.key), + label: __expectString(output.label), } as any; }; +const deserializeAws_restJson1AuthParameterList = (output: any, context: __SerdeContext): AuthParameter[] => { + return (output || []) + .filter((e: any) => e != null) + .map((entry: any) => { + if (entry === null) { + return null as any; + } + return deserializeAws_restJson1AuthParameter(entry, context); + }); +}; + const deserializeAws_restJson1ConnectorConfiguration = ( output: any, context: __SerdeContext ): ConnectorConfiguration => { return { + authenticationConfig: + output.authenticationConfig !== undefined && output.authenticationConfig !== null + ? deserializeAws_restJson1AuthenticationConfig(output.authenticationConfig, context) + : undefined, canUseAsDestination: __expectBoolean(output.canUseAsDestination), canUseAsSource: __expectBoolean(output.canUseAsSource), + connectorArn: __expectString(output.connectorArn), + connectorDescription: __expectString(output.connectorDescription), + connectorLabel: __expectString(output.connectorLabel), connectorMetadata: output.connectorMetadata !== undefined && output.connectorMetadata !== null ? deserializeAws_restJson1ConnectorMetadata(output.connectorMetadata, context) : undefined, + connectorModes: + output.connectorModes !== undefined && output.connectorModes !== null + ? deserializeAws_restJson1ConnectorModeList(output.connectorModes, context) + : undefined, + connectorName: __expectString(output.connectorName), + connectorOwner: __expectString(output.connectorOwner), + connectorProvisioningConfig: + output.connectorProvisioningConfig !== undefined && output.connectorProvisioningConfig !== null + ? deserializeAws_restJson1ConnectorProvisioningConfig(output.connectorProvisioningConfig, context) + : undefined, + connectorProvisioningType: __expectString(output.connectorProvisioningType), + connectorRuntimeSettings: + output.connectorRuntimeSettings !== undefined && output.connectorRuntimeSettings !== null + ? deserializeAws_restJson1ConnectorRuntimeSettingList(output.connectorRuntimeSettings, context) + : undefined, + connectorType: __expectString(output.connectorType), + connectorVersion: __expectString(output.connectorVersion), isPrivateLinkEnabled: __expectBoolean(output.isPrivateLinkEnabled), isPrivateLinkEndpointUrlRequired: __expectBoolean(output.isPrivateLinkEndpointUrlRequired), + logoURL: __expectString(output.logoURL), + registeredAt: + output.registeredAt !== undefined && output.registeredAt !== null + ? __expectNonNull(__parseEpochTimestamp(__expectNumber(output.registeredAt))) + : undefined, + registeredBy: __expectString(output.registeredBy), + supportedApiVersions: + output.supportedApiVersions !== undefined && output.supportedApiVersions !== null + ? deserializeAws_restJson1SupportedApiVersionList(output.supportedApiVersions, context) + : undefined, supportedDestinationConnectors: output.supportedDestinationConnectors !== undefined && output.supportedDestinationConnectors !== null ? deserializeAws_restJson1ConnectorTypeList(output.supportedDestinationConnectors, context) : undefined, + supportedOperators: + output.supportedOperators !== undefined && output.supportedOperators !== null + ? deserializeAws_restJson1SupportedOperatorList(output.supportedOperators, context) + : undefined, supportedSchedulingFrequencies: output.supportedSchedulingFrequencies !== undefined && output.supportedSchedulingFrequencies !== null ? deserializeAws_restJson1SchedulingFrequencyTypeList(output.supportedSchedulingFrequencies, context) @@ -3644,6 +4434,10 @@ const deserializeAws_restJson1ConnectorConfiguration = ( output.supportedTriggerTypes !== undefined && output.supportedTriggerTypes !== null ? deserializeAws_restJson1TriggerTypeList(output.supportedTriggerTypes, context) : undefined, + supportedWriteOperations: + output.supportedWriteOperations !== undefined && output.supportedWriteOperations !== null + ? deserializeAws_restJson1SupportedWriteOperationList(output.supportedWriteOperations, context) + : undefined, } as any; }; @@ -3665,6 +4459,28 @@ const deserializeAws_restJson1ConnectorConfigurationsMap = ( ); }; +const deserializeAws_restJson1ConnectorDetail = (output: any, context: __SerdeContext): ConnectorDetail => { + return { + applicationType: __expectString(output.applicationType), + connectorDescription: __expectString(output.connectorDescription), + connectorLabel: __expectString(output.connectorLabel), + connectorModes: + output.connectorModes !== undefined && output.connectorModes !== null + ? deserializeAws_restJson1ConnectorModeList(output.connectorModes, context) + : undefined, + connectorName: __expectString(output.connectorName), + connectorOwner: __expectString(output.connectorOwner), + connectorProvisioningType: __expectString(output.connectorProvisioningType), + connectorType: __expectString(output.connectorType), + connectorVersion: __expectString(output.connectorVersion), + registeredAt: + output.registeredAt !== undefined && output.registeredAt !== null + ? __expectNonNull(__parseEpochTimestamp(__expectNumber(output.registeredAt))) + : undefined, + registeredBy: __expectString(output.registeredBy), + } as any; +}; + const deserializeAws_restJson1ConnectorEntity = (output: any, context: __SerdeContext): ConnectorEntity => { return { hasNestedEntities: __expectBoolean(output.hasNestedEntities), @@ -3675,13 +4491,21 @@ const deserializeAws_restJson1ConnectorEntity = (output: any, context: __SerdeCo const deserializeAws_restJson1ConnectorEntityField = (output: any, context: __SerdeContext): ConnectorEntityField => { return { + customProperties: + output.customProperties !== undefined && output.customProperties !== null + ? deserializeAws_restJson1CustomProperties(output.customProperties, context) + : undefined, + defaultValue: __expectString(output.defaultValue), description: __expectString(output.description), destinationProperties: output.destinationProperties !== undefined && output.destinationProperties !== null ? deserializeAws_restJson1DestinationFieldProperties(output.destinationProperties, context) : undefined, identifier: __expectString(output.identifier), + isDeprecated: __expectBoolean(output.isDeprecated), + isPrimaryKey: __expectBoolean(output.isPrimaryKey), label: __expectString(output.label), + parentIdentifier: __expectString(output.parentIdentifier), sourceProperties: output.sourceProperties !== undefined && output.sourceProperties !== null ? deserializeAws_restJson1SourceFieldProperties(output.sourceProperties, context) @@ -3733,6 +4557,17 @@ const deserializeAws_restJson1ConnectorEntityMap = ( }, {}); }; +const deserializeAws_restJson1ConnectorList = (output: any, context: __SerdeContext): ConnectorDetail[] => { + return (output || []) + .filter((e: any) => e != null) + .map((entry: any) => { + if (entry === null) { + return null as any; + } + return deserializeAws_restJson1ConnectorDetail(entry, context); + }); +}; + const deserializeAws_restJson1ConnectorMetadata = (output: any, context: __SerdeContext): ConnectorMetadata => { return { Amplitude: @@ -3822,9 +4657,21 @@ const deserializeAws_restJson1ConnectorMetadata = (output: any, context: __Serde } as any; }; +const deserializeAws_restJson1ConnectorModeList = (output: any, context: __SerdeContext): string[] => { + return (output || []) + .filter((e: any) => e != null) + .map((entry: any) => { + if (entry === null) { + return null as any; + } + return __expectString(entry) as any; + }); +}; + const deserializeAws_restJson1ConnectorOperator = (output: any, context: __SerdeContext): ConnectorOperator => { return { Amplitude: __expectString(output.Amplitude), + CustomConnector: __expectString(output.CustomConnector), Datadog: __expectString(output.Datadog), Dynatrace: __expectString(output.Dynatrace), GoogleAnalytics: __expectString(output.GoogleAnalytics), @@ -3845,6 +4692,7 @@ const deserializeAws_restJson1ConnectorOperator = (output: any, context: __Serde const deserializeAws_restJson1ConnectorProfile = (output: any, context: __SerdeContext): ConnectorProfile => { return { connectionMode: __expectString(output.connectionMode), + connectorLabel: __expectString(output.connectorLabel), connectorProfileArn: __expectString(output.connectorProfileArn), connectorProfileName: __expectString(output.connectorProfileName), connectorProfileProperties: @@ -3891,6 +4739,10 @@ const deserializeAws_restJson1ConnectorProfileProperties = ( output.Amplitude !== undefined && output.Amplitude !== null ? deserializeAws_restJson1AmplitudeConnectorProfileProperties(output.Amplitude, context) : undefined, + CustomConnector: + output.CustomConnector !== undefined && output.CustomConnector !== null + ? deserializeAws_restJson1CustomConnectorProfileProperties(output.CustomConnector, context) + : undefined, Datadog: output.Datadog !== undefined && output.Datadog !== null ? deserializeAws_restJson1DatadogConnectorProfileProperties(output.Datadog, context) @@ -3958,6 +4810,72 @@ const deserializeAws_restJson1ConnectorProfileProperties = ( } as any; }; +const deserializeAws_restJson1ConnectorProvisioningConfig = ( + output: any, + context: __SerdeContext +): ConnectorProvisioningConfig => { + return { + lambda: + output.lambda !== undefined && output.lambda !== null + ? deserializeAws_restJson1LambdaConnectorProvisioningConfig(output.lambda, context) + : undefined, + } as any; +}; + +const deserializeAws_restJson1ConnectorRuntimeSetting = ( + output: any, + context: __SerdeContext +): ConnectorRuntimeSetting => { + return { + connectorSuppliedValueOptions: + output.connectorSuppliedValueOptions !== undefined && output.connectorSuppliedValueOptions !== null + ? deserializeAws_restJson1ConnectorSuppliedValueOptionList(output.connectorSuppliedValueOptions, context) + : undefined, + dataType: __expectString(output.dataType), + description: __expectString(output.description), + isRequired: __expectBoolean(output.isRequired), + key: __expectString(output.key), + label: __expectString(output.label), + scope: __expectString(output.scope), + } as any; +}; + +const deserializeAws_restJson1ConnectorRuntimeSettingList = ( + output: any, + context: __SerdeContext +): ConnectorRuntimeSetting[] => { + return (output || []) + .filter((e: any) => e != null) + .map((entry: any) => { + if (entry === null) { + return null as any; + } + return deserializeAws_restJson1ConnectorRuntimeSetting(entry, context); + }); +}; + +const deserializeAws_restJson1ConnectorSuppliedValueList = (output: any, context: __SerdeContext): string[] => { + return (output || []) + .filter((e: any) => e != null) + .map((entry: any) => { + if (entry === null) { + return null as any; + } + return __expectString(entry) as any; + }); +}; + +const deserializeAws_restJson1ConnectorSuppliedValueOptionList = (output: any, context: __SerdeContext): string[] => { + return (output || []) + .filter((e: any) => e != null) + .map((entry: any) => { + if (entry === null) { + return null as any; + } + return __expectString(entry) as any; + }); +}; + const deserializeAws_restJson1ConnectorTypeList = ( output: any, context: __SerdeContext @@ -3972,6 +4890,78 @@ const deserializeAws_restJson1ConnectorTypeList = ( }); }; +const deserializeAws_restJson1CustomAuthConfig = (output: any, context: __SerdeContext): CustomAuthConfig => { + return { + authParameters: + output.authParameters !== undefined && output.authParameters !== null + ? deserializeAws_restJson1AuthParameterList(output.authParameters, context) + : undefined, + customAuthenticationType: __expectString(output.customAuthenticationType), + } as any; +}; + +const deserializeAws_restJson1CustomAuthConfigList = (output: any, context: __SerdeContext): CustomAuthConfig[] => { + return (output || []) + .filter((e: any) => e != null) + .map((entry: any) => { + if (entry === null) { + return null as any; + } + return deserializeAws_restJson1CustomAuthConfig(entry, context); + }); +}; + +const deserializeAws_restJson1CustomConnectorDestinationProperties = ( + output: any, + context: __SerdeContext +): CustomConnectorDestinationProperties => { + return { + customProperties: + output.customProperties !== undefined && output.customProperties !== null + ? deserializeAws_restJson1CustomProperties(output.customProperties, context) + : undefined, + entityName: __expectString(output.entityName), + errorHandlingConfig: + output.errorHandlingConfig !== undefined && output.errorHandlingConfig !== null + ? deserializeAws_restJson1ErrorHandlingConfig(output.errorHandlingConfig, context) + : undefined, + idFieldNames: + output.idFieldNames !== undefined && output.idFieldNames !== null + ? deserializeAws_restJson1IdFieldNameList(output.idFieldNames, context) + : undefined, + writeOperationType: __expectString(output.writeOperationType), + } as any; +}; + +const deserializeAws_restJson1CustomConnectorProfileProperties = ( + output: any, + context: __SerdeContext +): CustomConnectorProfileProperties => { + return { + oAuth2Properties: + output.oAuth2Properties !== undefined && output.oAuth2Properties !== null + ? deserializeAws_restJson1OAuth2Properties(output.oAuth2Properties, context) + : undefined, + profileProperties: + output.profileProperties !== undefined && output.profileProperties !== null + ? deserializeAws_restJson1ProfilePropertiesMap(output.profileProperties, context) + : undefined, + } as any; +}; + +const deserializeAws_restJson1CustomConnectorSourceProperties = ( + output: any, + context: __SerdeContext +): CustomConnectorSourceProperties => { + return { + customProperties: + output.customProperties !== undefined && output.customProperties !== null + ? deserializeAws_restJson1CustomProperties(output.customProperties, context) + : undefined, + entityName: __expectString(output.entityName), + } as any; +}; + const deserializeAws_restJson1CustomerProfilesDestinationProperties = ( output: any, context: __SerdeContext @@ -3989,6 +4979,18 @@ const deserializeAws_restJson1CustomerProfilesMetadata = ( return {} as any; }; +const deserializeAws_restJson1CustomProperties = (output: any, context: __SerdeContext): { [key: string]: string } => { + return Object.entries(output).reduce((acc: { [key: string]: string }, [key, value]: [string, any]) => { + if (value === null) { + return acc; + } + return { + ...acc, + [key]: __expectString(value) as any, + }; + }, {}); +}; + const deserializeAws_restJson1DatadogConnectorProfileProperties = ( output: any, context: __SerdeContext @@ -4016,6 +5018,10 @@ const deserializeAws_restJson1DestinationConnectorProperties = ( context: __SerdeContext ): DestinationConnectorProperties => { return { + CustomConnector: + output.CustomConnector !== undefined && output.CustomConnector !== null + ? deserializeAws_restJson1CustomConnectorDestinationProperties(output.CustomConnector, context) + : undefined, CustomerProfiles: output.CustomerProfiles !== undefined && output.CustomerProfiles !== null ? deserializeAws_restJson1CustomerProfilesDestinationProperties(output.CustomerProfiles, context) @@ -4065,6 +5071,7 @@ const deserializeAws_restJson1DestinationFieldProperties = ( ): DestinationFieldProperties => { return { isCreatable: __expectBoolean(output.isCreatable), + isDefaultedOnCreate: __expectBoolean(output.isDefaultedOnCreate), isNullable: __expectBoolean(output.isNullable), isUpdatable: __expectBoolean(output.isUpdatable), isUpsertable: __expectBoolean(output.isUpsertable), @@ -4077,6 +5084,7 @@ const deserializeAws_restJson1DestinationFieldProperties = ( const deserializeAws_restJson1DestinationFlowConfig = (output: any, context: __SerdeContext): DestinationFlowConfig => { return { + apiVersion: __expectString(output.apiVersion), connectorProfileName: __expectString(output.connectorProfileName), connectorType: __expectString(output.connectorType), destinationConnectorProperties: @@ -4206,15 +5214,25 @@ const deserializeAws_restJson1ExecutionResult = (output: any, context: __SerdeCo const deserializeAws_restJson1FieldTypeDetails = (output: any, context: __SerdeContext): FieldTypeDetails => { return { + fieldLengthRange: + output.fieldLengthRange !== undefined && output.fieldLengthRange !== null + ? deserializeAws_restJson1Range(output.fieldLengthRange, context) + : undefined, fieldType: __expectString(output.fieldType), + fieldValueRange: + output.fieldValueRange !== undefined && output.fieldValueRange !== null + ? deserializeAws_restJson1Range(output.fieldValueRange, context) + : undefined, filterOperators: output.filterOperators !== undefined && output.filterOperators !== null ? deserializeAws_restJson1FilterOperatorList(output.filterOperators, context) : undefined, + supportedDateFormat: __expectString(output.supportedDateFormat), supportedValues: output.supportedValues !== undefined && output.supportedValues !== null ? deserializeAws_restJson1SupportedValueList(output.supportedValues, context) : undefined, + valueRegexPattern: __expectString(output.valueRegexPattern), } as any; }; @@ -4237,6 +5255,7 @@ const deserializeAws_restJson1FlowDefinition = (output: any, context: __SerdeCon : undefined, createdBy: __expectString(output.createdBy), description: __expectString(output.description), + destinationConnectorLabel: __expectString(output.destinationConnectorLabel), destinationConnectorType: __expectString(output.destinationConnectorType), flowArn: __expectString(output.flowArn), flowName: __expectString(output.flowName), @@ -4250,6 +5269,7 @@ const deserializeAws_restJson1FlowDefinition = (output: any, context: __SerdeCon ? __expectNonNull(__parseEpochTimestamp(__expectNumber(output.lastUpdatedAt))) : undefined, lastUpdatedBy: __expectString(output.lastUpdatedBy), + sourceConnectorLabel: __expectString(output.sourceConnectorLabel), sourceConnectorType: __expectString(output.sourceConnectorType), tags: output.tags !== undefined && output.tags !== null @@ -4377,6 +5397,15 @@ const deserializeAws_restJson1InforNexusSourceProperties = ( } as any; }; +const deserializeAws_restJson1LambdaConnectorProvisioningConfig = ( + output: any, + context: __SerdeContext +): LambdaConnectorProvisioningConfig => { + return { + lambdaArn: __expectString(output.lambdaArn), + } as any; +}; + const deserializeAws_restJson1LookoutMetricsDestinationProperties = ( output: any, context: __SerdeContext @@ -4406,6 +5435,48 @@ const deserializeAws_restJson1MarketoSourceProperties = ( } as any; }; +const deserializeAws_restJson1OAuth2Defaults = (output: any, context: __SerdeContext): OAuth2Defaults => { + return { + authCodeUrls: + output.authCodeUrls !== undefined && output.authCodeUrls !== null + ? deserializeAws_restJson1AuthCodeUrlList(output.authCodeUrls, context) + : undefined, + oauth2GrantTypesSupported: + output.oauth2GrantTypesSupported !== undefined && output.oauth2GrantTypesSupported !== null + ? deserializeAws_restJson1OAuth2GrantTypeSupportedList(output.oauth2GrantTypesSupported, context) + : undefined, + oauthScopes: + output.oauthScopes !== undefined && output.oauthScopes !== null + ? deserializeAws_restJson1OAuthScopeList(output.oauthScopes, context) + : undefined, + tokenUrls: + output.tokenUrls !== undefined && output.tokenUrls !== null + ? deserializeAws_restJson1TokenUrlList(output.tokenUrls, context) + : undefined, + } as any; +}; + +const deserializeAws_restJson1OAuth2GrantTypeSupportedList = ( + output: any, + context: __SerdeContext +): (OAuth2GrantType | string)[] => { + return (output || []) + .filter((e: any) => e != null) + .map((entry: any) => { + if (entry === null) { + return null as any; + } + return __expectString(entry) as any; + }); +}; + +const deserializeAws_restJson1OAuth2Properties = (output: any, context: __SerdeContext): OAuth2Properties => { + return { + oAuth2GrantType: __expectString(output.oAuth2GrantType), + tokenUrl: __expectString(output.tokenUrl), + } as any; +}; + const deserializeAws_restJson1OAuthProperties = (output: any, context: __SerdeContext): OAuthProperties => { return { authCodeUrl: __expectString(output.authCodeUrl), @@ -4446,6 +5517,28 @@ const deserializeAws_restJson1PrivateConnectionProvisioningState = ( } as any; }; +const deserializeAws_restJson1ProfilePropertiesMap = ( + output: any, + context: __SerdeContext +): { [key: string]: string } => { + return Object.entries(output).reduce((acc: { [key: string]: string }, [key, value]: [string, any]) => { + if (value === null) { + return acc; + } + return { + ...acc, + [key]: __expectString(value) as any, + }; + }, {}); +}; + +const deserializeAws_restJson1Range = (output: any, context: __SerdeContext): Range => { + return { + maximum: __limitedParseDouble(output.maximum), + minimum: __limitedParseDouble(output.minimum), + } as any; +}; + const deserializeAws_restJson1RedshiftConnectorProfileProperties = ( output: any, context: __SerdeContext @@ -4768,6 +5861,10 @@ const deserializeAws_restJson1SourceConnectorProperties = ( output.Amplitude !== undefined && output.Amplitude !== null ? deserializeAws_restJson1AmplitudeSourceProperties(output.Amplitude, context) : undefined, + CustomConnector: + output.CustomConnector !== undefined && output.CustomConnector !== null + ? deserializeAws_restJson1CustomConnectorSourceProperties(output.CustomConnector, context) + : undefined, Datadog: output.Datadog !== undefined && output.Datadog !== null ? deserializeAws_restJson1DatadogSourceProperties(output.Datadog, context) @@ -4831,6 +5928,7 @@ const deserializeAws_restJson1SourceFieldProperties = (output: any, context: __S return { isQueryable: __expectBoolean(output.isQueryable), isRetrievable: __expectBoolean(output.isRetrievable), + isTimestampFieldForIncrementalQueries: __expectBoolean(output.isTimestampFieldForIncrementalQueries), } as any; }; @@ -4847,6 +5945,7 @@ const deserializeAws_restJson1SourceFields = (output: any, context: __SerdeConte const deserializeAws_restJson1SourceFlowConfig = (output: any, context: __SerdeContext): SourceFlowConfig => { return { + apiVersion: __expectString(output.apiVersion), connectorProfileName: __expectString(output.connectorProfileName), connectorType: __expectString(output.connectorType), incrementalPullConfig: @@ -4860,6 +5959,17 @@ const deserializeAws_restJson1SourceFlowConfig = (output: any, context: __SerdeC } as any; }; +const deserializeAws_restJson1SupportedApiVersionList = (output: any, context: __SerdeContext): string[] => { + return (output || []) + .filter((e: any) => e != null) + .map((entry: any) => { + if (entry === null) { + return null as any; + } + return __expectString(entry) as any; + }); +}; + const deserializeAws_restJson1SupportedFieldTypeDetails = ( output: any, context: __SerdeContext @@ -4872,6 +5982,20 @@ const deserializeAws_restJson1SupportedFieldTypeDetails = ( } as any; }; +const deserializeAws_restJson1SupportedOperatorList = ( + output: any, + context: __SerdeContext +): (Operators | string)[] => { + return (output || []) + .filter((e: any) => e != null) + .map((entry: any) => { + if (entry === null) { + return null as any; + } + return __expectString(entry) as any; + }); +}; + const deserializeAws_restJson1SupportedValueList = (output: any, context: __SerdeContext): string[] => { return (output || []) .filter((e: any) => e != null) @@ -4954,6 +6078,17 @@ const deserializeAws_restJson1Tasks = (output: any, context: __SerdeContext): Ta }); }; +const deserializeAws_restJson1TokenUrlList = (output: any, context: __SerdeContext): string[] => { + return (output || []) + .filter((e: any) => e != null) + .map((entry: any) => { + if (entry === null) { + return null as any; + } + return __expectString(entry) as any; + }); +}; + const deserializeAws_restJson1TrendmicroConnectorProfileProperties = ( output: any, context: __SerdeContext diff --git a/clients/client-athena/src/Athena.ts b/clients/client-athena/src/Athena.ts index 7b9790cdbf165..b304ffe44a6b7 100644 --- a/clients/client-athena/src/Athena.ts +++ b/clients/client-athena/src/Athena.ts @@ -688,6 +688,12 @@ export class Athena extends AthenaClient { * QueryExecutionId from the Athena query results location in * Amazon S3. For more information, see Query Results in the Amazon Athena User Guide. This request does not execute the query * but returns results. Use StartQueryExecution to run a query.

+ *

If the original query execution ran using an ResultConfiguration$ExpectedBucketOwner setting, the setting also + * applies to Amazon S3 read operations when GetQueryResults is + * called. If an expected bucket owner has been specified and the query results are in an + * Amazon S3 bucket whose owner account ID is different from the expected + * bucket owner, the GetQueryResults call fails with an Amazon S3 + * permissions error.

*

To stream query results successfully, the IAM principal with permission to call * GetQueryResults also must have permissions to the Amazon S3 * GetObject action for the Athena query results location.

diff --git a/clients/client-athena/src/commands/GetQueryResultsCommand.ts b/clients/client-athena/src/commands/GetQueryResultsCommand.ts index 5218572bcc33d..0295c32e76bf2 100644 --- a/clients/client-athena/src/commands/GetQueryResultsCommand.ts +++ b/clients/client-athena/src/commands/GetQueryResultsCommand.ts @@ -26,6 +26,12 @@ export interface GetQueryResultsCommandOutput extends GetQueryResultsOutput, __M * QueryExecutionId from the Athena query results location in * Amazon S3. For more information, see Query Results in the Amazon Athena User Guide. This request does not execute the query * but returns results. Use StartQueryExecution to run a query.

+ *

If the original query execution ran using an ResultConfiguration$ExpectedBucketOwner setting, the setting also + * applies to Amazon S3 read operations when GetQueryResults is + * called. If an expected bucket owner has been specified and the query results are in an + * Amazon S3 bucket whose owner account ID is different from the expected + * bucket owner, the GetQueryResults call fails with an Amazon S3 + * permissions error.

*

To stream query results successfully, the IAM principal with permission to call * GetQueryResults also must have permissions to the Amazon S3 * GetObject action for the Athena query results location.

diff --git a/clients/client-athena/src/models/models_0.ts b/clients/client-athena/src/models/models_0.ts index b5d2475aa53b7..836fd856c3e78 100644 --- a/clients/client-athena/src/models/models_0.ts +++ b/clients/client-athena/src/models/models_0.ts @@ -274,6 +274,21 @@ export interface ResultConfiguration { * also uses the location for storing query results specified in the workgroup. See WorkGroupConfiguration$EnforceWorkGroupConfiguration and Workgroup Settings Override Client-Side Settings.

*/ EncryptionConfiguration?: EncryptionConfiguration; + + /** + *

The Amazon Web Services account ID that you expect to be the owner of the Amazon S3 bucket specified by ResultConfiguration$OutputLocation. + * If set, Athena uses the value for ExpectedBucketOwner when it + * makes Amazon S3 calls to your specified output location. If the + * ExpectedBucketOwner + * Amazon Web Services account ID does not match the actual owner of the Amazon S3 + * bucket, the call fails with a permissions error.

+ *

This is a client-side setting. If workgroup settings override client-side settings, + * then the query uses the ExpectedBucketOwner setting that is specified for + * the workgroup, and also uses the location for storing query results specified in the + * workgroup. See WorkGroupConfiguration$EnforceWorkGroupConfiguration + * and Workgroup Settings Override Client-Side Settings.

+ */ + ExpectedBucketOwner?: string; } export namespace ResultConfiguration { @@ -2727,7 +2742,7 @@ export interface ResultConfigurationUpdates { * to null. If set to "false" or not set, and a value is present in the * OutputLocation in ResultConfigurationUpdates (the * client-side setting), the OutputLocation in the workgroup's - * ResultConfiguration will be updated with the new value. For more + * ResultConfiguration is updated with the new value. For more * information, see Workgroup Settings Override * Client-Side Settings.

*/ @@ -2744,11 +2759,36 @@ export interface ResultConfigurationUpdates { * and set to null. If set to "false" or not set, and a value is present in the * EncryptionConfiguration in ResultConfigurationUpdates (the * client-side setting), the EncryptionConfiguration in the workgroup's - * ResultConfiguration will be updated with the new value. For more + * ResultConfiguration is updated with the new value. For more * information, see Workgroup Settings Override * Client-Side Settings.

*/ RemoveEncryptionConfiguration?: boolean; + + /** + *

The Amazon Web Services account ID that you expect to be the owner of the Amazon S3 bucket specified by ResultConfiguration$OutputLocation. + * If set, Athena uses the value for ExpectedBucketOwner when it + * makes Amazon S3 calls to your specified output location. If the + * ExpectedBucketOwner + * Amazon Web Services account ID does not match the actual owner of the Amazon S3 + * bucket, the call fails with a permissions error.

+ * + *

If workgroup settings override client-side settings, then the query uses the + * ExpectedBucketOwner setting that is specified for the workgroup, and + * also uses the location for storing query results specified in the workgroup. See WorkGroupConfiguration$EnforceWorkGroupConfiguration and Workgroup Settings Override Client-Side Settings.

+ */ + ExpectedBucketOwner?: string; + + /** + *

If set to "true", removes the Amazon Web Services account ID previously specified for + * ResultConfiguration$ExpectedBucketOwner. If set to "false" or not + * set, and a value is present in the ExpectedBucketOwner in + * ResultConfigurationUpdates (the client-side setting), the + * ExpectedBucketOwner in the workgroup's ResultConfiguration + * is updated with the new value. For more information, see Workgroup Settings Override + * Client-Side Settings.

+ */ + RemoveExpectedBucketOwner?: boolean; } export namespace ResultConfigurationUpdates { diff --git a/clients/client-athena/src/protocols/Aws_json1_1.ts b/clients/client-athena/src/protocols/Aws_json1_1.ts index 076f749590709..0470c0882c8e9 100644 --- a/clients/client-athena/src/protocols/Aws_json1_1.ts +++ b/clients/client-athena/src/protocols/Aws_json1_1.ts @@ -3198,6 +3198,8 @@ const serializeAws_json1_1ResultConfiguration = (input: ResultConfiguration, con input.EncryptionConfiguration !== null && { EncryptionConfiguration: serializeAws_json1_1EncryptionConfiguration(input.EncryptionConfiguration, context), }), + ...(input.ExpectedBucketOwner !== undefined && + input.ExpectedBucketOwner !== null && { ExpectedBucketOwner: input.ExpectedBucketOwner }), ...(input.OutputLocation !== undefined && input.OutputLocation !== null && { OutputLocation: input.OutputLocation }), }; @@ -3212,12 +3214,16 @@ const serializeAws_json1_1ResultConfigurationUpdates = ( input.EncryptionConfiguration !== null && { EncryptionConfiguration: serializeAws_json1_1EncryptionConfiguration(input.EncryptionConfiguration, context), }), + ...(input.ExpectedBucketOwner !== undefined && + input.ExpectedBucketOwner !== null && { ExpectedBucketOwner: input.ExpectedBucketOwner }), ...(input.OutputLocation !== undefined && input.OutputLocation !== null && { OutputLocation: input.OutputLocation }), ...(input.RemoveEncryptionConfiguration !== undefined && input.RemoveEncryptionConfiguration !== null && { RemoveEncryptionConfiguration: input.RemoveEncryptionConfiguration, }), + ...(input.RemoveExpectedBucketOwner !== undefined && + input.RemoveExpectedBucketOwner !== null && { RemoveExpectedBucketOwner: input.RemoveExpectedBucketOwner }), ...(input.RemoveOutputLocation !== undefined && input.RemoveOutputLocation !== null && { RemoveOutputLocation: input.RemoveOutputLocation }), }; @@ -4016,6 +4022,7 @@ const deserializeAws_json1_1ResultConfiguration = (output: any, context: __Serde output.EncryptionConfiguration !== undefined && output.EncryptionConfiguration !== null ? deserializeAws_json1_1EncryptionConfiguration(output.EncryptionConfiguration, context) : undefined, + ExpectedBucketOwner: __expectString(output.ExpectedBucketOwner), OutputLocation: __expectString(output.OutputLocation), } as any; }; diff --git a/clients/client-comprehend/src/Comprehend.ts b/clients/client-comprehend/src/Comprehend.ts index 14991fb63f7c3..caaeb6c85e9df 100644 --- a/clients/client-comprehend/src/Comprehend.ts +++ b/clients/client-comprehend/src/Comprehend.ts @@ -65,6 +65,11 @@ import { DeleteEntityRecognizerCommandInput, DeleteEntityRecognizerCommandOutput, } from "./commands/DeleteEntityRecognizerCommand"; +import { + DeleteResourcePolicyCommand, + DeleteResourcePolicyCommandInput, + DeleteResourcePolicyCommandOutput, +} from "./commands/DeleteResourcePolicyCommand"; import { DescribeDocumentClassificationJobCommand, DescribeDocumentClassificationJobCommandInput, @@ -110,6 +115,11 @@ import { DescribePiiEntitiesDetectionJobCommandInput, DescribePiiEntitiesDetectionJobCommandOutput, } from "./commands/DescribePiiEntitiesDetectionJobCommand"; +import { + DescribeResourcePolicyCommand, + DescribeResourcePolicyCommandInput, + DescribeResourcePolicyCommandOutput, +} from "./commands/DescribeResourcePolicyCommand"; import { DescribeSentimentDetectionJobCommand, DescribeSentimentDetectionJobCommandInput, @@ -150,6 +160,7 @@ import { DetectSyntaxCommandInput, DetectSyntaxCommandOutput, } from "./commands/DetectSyntaxCommand"; +import { ImportModelCommand, ImportModelCommandInput, ImportModelCommandOutput } from "./commands/ImportModelCommand"; import { ListDocumentClassificationJobsCommand, ListDocumentClassificationJobsCommandInput, @@ -220,6 +231,11 @@ import { ListTopicsDetectionJobsCommandInput, ListTopicsDetectionJobsCommandOutput, } from "./commands/ListTopicsDetectionJobsCommand"; +import { + PutResourcePolicyCommand, + PutResourcePolicyCommandInput, + PutResourcePolicyCommandOutput, +} from "./commands/PutResourcePolicyCommand"; import { StartDocumentClassificationJobCommand, StartDocumentClassificationJobCommandInput, @@ -591,8 +607,7 @@ export class Comprehend extends ComprehendClient { /** *

Creates a model-specific endpoint for synchronous inference for a previously trained - * custom model - *

+ * custom model

*/ public createEndpoint( args: CreateEndpointCommandInput, @@ -766,6 +781,38 @@ export class Comprehend extends ComprehendClient { } } + /** + *

Deletes a resource-based policy that is attached to a custom model.

+ */ + public deleteResourcePolicy( + args: DeleteResourcePolicyCommandInput, + options?: __HttpHandlerOptions + ): Promise; + public deleteResourcePolicy( + args: DeleteResourcePolicyCommandInput, + cb: (err: any, data?: DeleteResourcePolicyCommandOutput) => void + ): void; + public deleteResourcePolicy( + args: DeleteResourcePolicyCommandInput, + options: __HttpHandlerOptions, + cb: (err: any, data?: DeleteResourcePolicyCommandOutput) => void + ): void; + public deleteResourcePolicy( + args: DeleteResourcePolicyCommandInput, + optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DeleteResourcePolicyCommandOutput) => void), + cb?: (err: any, data?: DeleteResourcePolicyCommandOutput) => void + ): Promise | void { + const command = new DeleteResourcePolicyCommand(args); + if (typeof optionsOrCb === "function") { + this.send(command, optionsOrCb); + } else if (typeof cb === "function") { + if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); + this.send(command, optionsOrCb || {}, cb); + } else { + return this.send(command, optionsOrCb); + } + } + /** *

Gets the properties associated with a document classification job. Use this operation to * get the status of a classification job.

@@ -1061,6 +1108,39 @@ export class Comprehend extends ComprehendClient { } } + /** + *

Gets the details of a resource-based policy that is attached to a custom model, including + * the JSON body of the policy.

+ */ + public describeResourcePolicy( + args: DescribeResourcePolicyCommandInput, + options?: __HttpHandlerOptions + ): Promise; + public describeResourcePolicy( + args: DescribeResourcePolicyCommandInput, + cb: (err: any, data?: DescribeResourcePolicyCommandOutput) => void + ): void; + public describeResourcePolicy( + args: DescribeResourcePolicyCommandInput, + options: __HttpHandlerOptions, + cb: (err: any, data?: DescribeResourcePolicyCommandOutput) => void + ): void; + public describeResourcePolicy( + args: DescribeResourcePolicyCommandInput, + optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeResourcePolicyCommandOutput) => void), + cb?: (err: any, data?: DescribeResourcePolicyCommandOutput) => void + ): Promise | void { + const command = new DescribeResourcePolicyCommand(args); + if (typeof optionsOrCb === "function") { + this.send(command, optionsOrCb); + } else if (typeof cb === "function") { + if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); + this.send(command, optionsOrCb || {}, cb); + } else { + return this.send(command, optionsOrCb); + } + } + /** *

Gets the properties associated with a sentiment detection job. Use this operation to get * the status of a detection job.

@@ -1321,6 +1401,37 @@ export class Comprehend extends ComprehendClient { } } + /** + *

Creates a new custom model that replicates a source custom model that you import. The + * source model can be in your AWS account or another one.

+ *

If the source model is in another AWS account, then it must have a resource-based policy + * that authorizes you to import it.

+ *

The source model must be in the same AWS region that you're using when you import. You + * can't import a model that's in a different region.

+ */ + public importModel(args: ImportModelCommandInput, options?: __HttpHandlerOptions): Promise; + public importModel(args: ImportModelCommandInput, cb: (err: any, data?: ImportModelCommandOutput) => void): void; + public importModel( + args: ImportModelCommandInput, + options: __HttpHandlerOptions, + cb: (err: any, data?: ImportModelCommandOutput) => void + ): void; + public importModel( + args: ImportModelCommandInput, + optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ImportModelCommandOutput) => void), + cb?: (err: any, data?: ImportModelCommandOutput) => void + ): Promise | void { + const command = new ImportModelCommand(args); + if (typeof optionsOrCb === "function") { + this.send(command, optionsOrCb); + } else if (typeof cb === "function") { + if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); + this.send(command, optionsOrCb || {}, cb); + } else { + return this.send(command, optionsOrCb); + } + } + /** *

Gets a list of the documentation classification jobs that you have submitted.

*/ @@ -1774,6 +1885,40 @@ export class Comprehend extends ComprehendClient { } } + /** + *

Attaches a resource-based policy to a custom model. You can use this policy to authorize + * an entity in another AWS account to import the custom model, which replicates it in Amazon + * Comprehend in their account.

+ */ + public putResourcePolicy( + args: PutResourcePolicyCommandInput, + options?: __HttpHandlerOptions + ): Promise; + public putResourcePolicy( + args: PutResourcePolicyCommandInput, + cb: (err: any, data?: PutResourcePolicyCommandOutput) => void + ): void; + public putResourcePolicy( + args: PutResourcePolicyCommandInput, + options: __HttpHandlerOptions, + cb: (err: any, data?: PutResourcePolicyCommandOutput) => void + ): void; + public putResourcePolicy( + args: PutResourcePolicyCommandInput, + optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: PutResourcePolicyCommandOutput) => void), + cb?: (err: any, data?: PutResourcePolicyCommandOutput) => void + ): Promise | void { + const command = new PutResourcePolicyCommand(args); + if (typeof optionsOrCb === "function") { + this.send(command, optionsOrCb); + } else if (typeof cb === "function") { + if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); + this.send(command, optionsOrCb || {}, cb); + } else { + return this.send(command, optionsOrCb); + } + } + /** *

Starts an asynchronous document classification job. Use the operation to track the progress of the * job.

diff --git a/clients/client-comprehend/src/ComprehendClient.ts b/clients/client-comprehend/src/ComprehendClient.ts index a3d9e876f472f..46d8ca4db2c8f 100644 --- a/clients/client-comprehend/src/ComprehendClient.ts +++ b/clients/client-comprehend/src/ComprehendClient.ts @@ -90,6 +90,10 @@ import { DeleteEntityRecognizerCommandInput, DeleteEntityRecognizerCommandOutput, } from "./commands/DeleteEntityRecognizerCommand"; +import { + DeleteResourcePolicyCommandInput, + DeleteResourcePolicyCommandOutput, +} from "./commands/DeleteResourcePolicyCommand"; import { DescribeDocumentClassificationJobCommandInput, DescribeDocumentClassificationJobCommandOutput, @@ -123,6 +127,10 @@ import { DescribePiiEntitiesDetectionJobCommandInput, DescribePiiEntitiesDetectionJobCommandOutput, } from "./commands/DescribePiiEntitiesDetectionJobCommand"; +import { + DescribeResourcePolicyCommandInput, + DescribeResourcePolicyCommandOutput, +} from "./commands/DescribeResourcePolicyCommand"; import { DescribeSentimentDetectionJobCommandInput, DescribeSentimentDetectionJobCommandOutput, @@ -140,6 +148,7 @@ import { DetectKeyPhrasesCommandInput, DetectKeyPhrasesCommandOutput } from "./c import { DetectPiiEntitiesCommandInput, DetectPiiEntitiesCommandOutput } from "./commands/DetectPiiEntitiesCommand"; import { DetectSentimentCommandInput, DetectSentimentCommandOutput } from "./commands/DetectSentimentCommand"; import { DetectSyntaxCommandInput, DetectSyntaxCommandOutput } from "./commands/DetectSyntaxCommand"; +import { ImportModelCommandInput, ImportModelCommandOutput } from "./commands/ImportModelCommand"; import { ListDocumentClassificationJobsCommandInput, ListDocumentClassificationJobsCommandOutput, @@ -193,6 +202,7 @@ import { ListTopicsDetectionJobsCommandInput, ListTopicsDetectionJobsCommandOutput, } from "./commands/ListTopicsDetectionJobsCommand"; +import { PutResourcePolicyCommandInput, PutResourcePolicyCommandOutput } from "./commands/PutResourcePolicyCommand"; import { StartDocumentClassificationJobCommandInput, StartDocumentClassificationJobCommandOutput, @@ -276,6 +286,7 @@ export type ServiceInputTypes = | DeleteDocumentClassifierCommandInput | DeleteEndpointCommandInput | DeleteEntityRecognizerCommandInput + | DeleteResourcePolicyCommandInput | DescribeDocumentClassificationJobCommandInput | DescribeDocumentClassifierCommandInput | DescribeDominantLanguageDetectionJobCommandInput @@ -285,6 +296,7 @@ export type ServiceInputTypes = | DescribeEventsDetectionJobCommandInput | DescribeKeyPhrasesDetectionJobCommandInput | DescribePiiEntitiesDetectionJobCommandInput + | DescribeResourcePolicyCommandInput | DescribeSentimentDetectionJobCommandInput | DescribeTopicsDetectionJobCommandInput | DetectDominantLanguageCommandInput @@ -293,6 +305,7 @@ export type ServiceInputTypes = | DetectPiiEntitiesCommandInput | DetectSentimentCommandInput | DetectSyntaxCommandInput + | ImportModelCommandInput | ListDocumentClassificationJobsCommandInput | ListDocumentClassifierSummariesCommandInput | ListDocumentClassifiersCommandInput @@ -307,6 +320,7 @@ export type ServiceInputTypes = | ListSentimentDetectionJobsCommandInput | ListTagsForResourceCommandInput | ListTopicsDetectionJobsCommandInput + | PutResourcePolicyCommandInput | StartDocumentClassificationJobCommandInput | StartDominantLanguageDetectionJobCommandInput | StartEntitiesDetectionJobCommandInput @@ -341,6 +355,7 @@ export type ServiceOutputTypes = | DeleteDocumentClassifierCommandOutput | DeleteEndpointCommandOutput | DeleteEntityRecognizerCommandOutput + | DeleteResourcePolicyCommandOutput | DescribeDocumentClassificationJobCommandOutput | DescribeDocumentClassifierCommandOutput | DescribeDominantLanguageDetectionJobCommandOutput @@ -350,6 +365,7 @@ export type ServiceOutputTypes = | DescribeEventsDetectionJobCommandOutput | DescribeKeyPhrasesDetectionJobCommandOutput | DescribePiiEntitiesDetectionJobCommandOutput + | DescribeResourcePolicyCommandOutput | DescribeSentimentDetectionJobCommandOutput | DescribeTopicsDetectionJobCommandOutput | DetectDominantLanguageCommandOutput @@ -358,6 +374,7 @@ export type ServiceOutputTypes = | DetectPiiEntitiesCommandOutput | DetectSentimentCommandOutput | DetectSyntaxCommandOutput + | ImportModelCommandOutput | ListDocumentClassificationJobsCommandOutput | ListDocumentClassifierSummariesCommandOutput | ListDocumentClassifiersCommandOutput @@ -372,6 +389,7 @@ export type ServiceOutputTypes = | ListSentimentDetectionJobsCommandOutput | ListTagsForResourceCommandOutput | ListTopicsDetectionJobsCommandOutput + | PutResourcePolicyCommandOutput | StartDocumentClassificationJobCommandOutput | StartDominantLanguageDetectionJobCommandOutput | StartEntitiesDetectionJobCommandOutput diff --git a/clients/client-comprehend/src/commands/CreateEndpointCommand.ts b/clients/client-comprehend/src/commands/CreateEndpointCommand.ts index e1626cd5b1f9b..794d06edeb294 100644 --- a/clients/client-comprehend/src/commands/CreateEndpointCommand.ts +++ b/clients/client-comprehend/src/commands/CreateEndpointCommand.ts @@ -23,8 +23,7 @@ export interface CreateEndpointCommandOutput extends CreateEndpointResponse, __M /** *

Creates a model-specific endpoint for synchronous inference for a previously trained - * custom model - *

+ * custom model

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-comprehend/src/commands/DeleteResourcePolicyCommand.ts b/clients/client-comprehend/src/commands/DeleteResourcePolicyCommand.ts new file mode 100644 index 0000000000000..4686f40d9d760 --- /dev/null +++ b/clients/client-comprehend/src/commands/DeleteResourcePolicyCommand.ts @@ -0,0 +1,95 @@ +import { getSerdePlugin } from "@aws-sdk/middleware-serde"; +import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@aws-sdk/protocol-http"; +import { Command as $Command } from "@aws-sdk/smithy-client"; +import { + FinalizeHandlerArguments, + Handler, + HandlerExecutionContext, + HttpHandlerOptions as __HttpHandlerOptions, + MetadataBearer as __MetadataBearer, + MiddlewareStack, + SerdeContext as __SerdeContext, +} from "@aws-sdk/types"; + +import { ComprehendClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ComprehendClient"; +import { DeleteResourcePolicyRequest, DeleteResourcePolicyResponse } from "../models/models_0"; +import { + deserializeAws_json1_1DeleteResourcePolicyCommand, + serializeAws_json1_1DeleteResourcePolicyCommand, +} from "../protocols/Aws_json1_1"; + +export interface DeleteResourcePolicyCommandInput extends DeleteResourcePolicyRequest {} +export interface DeleteResourcePolicyCommandOutput extends DeleteResourcePolicyResponse, __MetadataBearer {} + +/** + *

Deletes a resource-based policy that is attached to a custom model.

+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ComprehendClient, DeleteResourcePolicyCommand } from "@aws-sdk/client-comprehend"; // ES Modules import + * // const { ComprehendClient, DeleteResourcePolicyCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import + * const client = new ComprehendClient(config); + * const command = new DeleteResourcePolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteResourcePolicyCommandInput} for command's `input` shape. + * @see {@link DeleteResourcePolicyCommandOutput} for command's `response` shape. + * @see {@link ComprehendClientResolvedConfig | config} for ComprehendClient's `config` shape. + * + */ +export class DeleteResourcePolicyCommand extends $Command< + DeleteResourcePolicyCommandInput, + DeleteResourcePolicyCommandOutput, + ComprehendClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + constructor(readonly input: DeleteResourcePolicyCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStack, + configuration: ComprehendClientResolvedConfig, + options?: __HttpHandlerOptions + ): Handler { + this.middlewareStack.use(getSerdePlugin(configuration, this.serialize, this.deserialize)); + + const stack = clientStack.concat(this.middlewareStack); + + const { logger } = configuration; + const clientName = "ComprehendClient"; + const commandName = "DeleteResourcePolicyCommand"; + const handlerExecutionContext: HandlerExecutionContext = { + logger, + clientName, + commandName, + inputFilterSensitiveLog: DeleteResourcePolicyRequest.filterSensitiveLog, + outputFilterSensitiveLog: DeleteResourcePolicyResponse.filterSensitiveLog, + }; + const { requestHandler } = configuration; + return stack.resolve( + (request: FinalizeHandlerArguments) => + requestHandler.handle(request.request as __HttpRequest, options || {}), + handlerExecutionContext + ); + } + + private serialize(input: DeleteResourcePolicyCommandInput, context: __SerdeContext): Promise<__HttpRequest> { + return serializeAws_json1_1DeleteResourcePolicyCommand(input, context); + } + + private deserialize(output: __HttpResponse, context: __SerdeContext): Promise { + return deserializeAws_json1_1DeleteResourcePolicyCommand(output, context); + } + + // Start section: command_body_extra + // End section: command_body_extra +} diff --git a/clients/client-comprehend/src/commands/DescribeResourcePolicyCommand.ts b/clients/client-comprehend/src/commands/DescribeResourcePolicyCommand.ts new file mode 100644 index 0000000000000..c846bb56837fd --- /dev/null +++ b/clients/client-comprehend/src/commands/DescribeResourcePolicyCommand.ts @@ -0,0 +1,96 @@ +import { getSerdePlugin } from "@aws-sdk/middleware-serde"; +import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@aws-sdk/protocol-http"; +import { Command as $Command } from "@aws-sdk/smithy-client"; +import { + FinalizeHandlerArguments, + Handler, + HandlerExecutionContext, + HttpHandlerOptions as __HttpHandlerOptions, + MetadataBearer as __MetadataBearer, + MiddlewareStack, + SerdeContext as __SerdeContext, +} from "@aws-sdk/types"; + +import { ComprehendClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ComprehendClient"; +import { DescribeResourcePolicyRequest, DescribeResourcePolicyResponse } from "../models/models_0"; +import { + deserializeAws_json1_1DescribeResourcePolicyCommand, + serializeAws_json1_1DescribeResourcePolicyCommand, +} from "../protocols/Aws_json1_1"; + +export interface DescribeResourcePolicyCommandInput extends DescribeResourcePolicyRequest {} +export interface DescribeResourcePolicyCommandOutput extends DescribeResourcePolicyResponse, __MetadataBearer {} + +/** + *

Gets the details of a resource-based policy that is attached to a custom model, including + * the JSON body of the policy.

+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ComprehendClient, DescribeResourcePolicyCommand } from "@aws-sdk/client-comprehend"; // ES Modules import + * // const { ComprehendClient, DescribeResourcePolicyCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import + * const client = new ComprehendClient(config); + * const command = new DescribeResourcePolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeResourcePolicyCommandInput} for command's `input` shape. + * @see {@link DescribeResourcePolicyCommandOutput} for command's `response` shape. + * @see {@link ComprehendClientResolvedConfig | config} for ComprehendClient's `config` shape. + * + */ +export class DescribeResourcePolicyCommand extends $Command< + DescribeResourcePolicyCommandInput, + DescribeResourcePolicyCommandOutput, + ComprehendClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + constructor(readonly input: DescribeResourcePolicyCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStack, + configuration: ComprehendClientResolvedConfig, + options?: __HttpHandlerOptions + ): Handler { + this.middlewareStack.use(getSerdePlugin(configuration, this.serialize, this.deserialize)); + + const stack = clientStack.concat(this.middlewareStack); + + const { logger } = configuration; + const clientName = "ComprehendClient"; + const commandName = "DescribeResourcePolicyCommand"; + const handlerExecutionContext: HandlerExecutionContext = { + logger, + clientName, + commandName, + inputFilterSensitiveLog: DescribeResourcePolicyRequest.filterSensitiveLog, + outputFilterSensitiveLog: DescribeResourcePolicyResponse.filterSensitiveLog, + }; + const { requestHandler } = configuration; + return stack.resolve( + (request: FinalizeHandlerArguments) => + requestHandler.handle(request.request as __HttpRequest, options || {}), + handlerExecutionContext + ); + } + + private serialize(input: DescribeResourcePolicyCommandInput, context: __SerdeContext): Promise<__HttpRequest> { + return serializeAws_json1_1DescribeResourcePolicyCommand(input, context); + } + + private deserialize(output: __HttpResponse, context: __SerdeContext): Promise { + return deserializeAws_json1_1DescribeResourcePolicyCommand(output, context); + } + + // Start section: command_body_extra + // End section: command_body_extra +} diff --git a/clients/client-comprehend/src/commands/ImportModelCommand.ts b/clients/client-comprehend/src/commands/ImportModelCommand.ts new file mode 100644 index 0000000000000..88346e55a7e7d --- /dev/null +++ b/clients/client-comprehend/src/commands/ImportModelCommand.ts @@ -0,0 +1,100 @@ +import { getSerdePlugin } from "@aws-sdk/middleware-serde"; +import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@aws-sdk/protocol-http"; +import { Command as $Command } from "@aws-sdk/smithy-client"; +import { + FinalizeHandlerArguments, + Handler, + HandlerExecutionContext, + HttpHandlerOptions as __HttpHandlerOptions, + MetadataBearer as __MetadataBearer, + MiddlewareStack, + SerdeContext as __SerdeContext, +} from "@aws-sdk/types"; + +import { ComprehendClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ComprehendClient"; +import { ImportModelRequest, ImportModelResponse } from "../models/models_0"; +import { + deserializeAws_json1_1ImportModelCommand, + serializeAws_json1_1ImportModelCommand, +} from "../protocols/Aws_json1_1"; + +export interface ImportModelCommandInput extends ImportModelRequest {} +export interface ImportModelCommandOutput extends ImportModelResponse, __MetadataBearer {} + +/** + *

Creates a new custom model that replicates a source custom model that you import. The + * source model can be in your AWS account or another one.

+ *

If the source model is in another AWS account, then it must have a resource-based policy + * that authorizes you to import it.

+ *

The source model must be in the same AWS region that you're using when you import. You + * can't import a model that's in a different region.

+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ComprehendClient, ImportModelCommand } from "@aws-sdk/client-comprehend"; // ES Modules import + * // const { ComprehendClient, ImportModelCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import + * const client = new ComprehendClient(config); + * const command = new ImportModelCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ImportModelCommandInput} for command's `input` shape. + * @see {@link ImportModelCommandOutput} for command's `response` shape. + * @see {@link ComprehendClientResolvedConfig | config} for ComprehendClient's `config` shape. + * + */ +export class ImportModelCommand extends $Command< + ImportModelCommandInput, + ImportModelCommandOutput, + ComprehendClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + constructor(readonly input: ImportModelCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStack, + configuration: ComprehendClientResolvedConfig, + options?: __HttpHandlerOptions + ): Handler { + this.middlewareStack.use(getSerdePlugin(configuration, this.serialize, this.deserialize)); + + const stack = clientStack.concat(this.middlewareStack); + + const { logger } = configuration; + const clientName = "ComprehendClient"; + const commandName = "ImportModelCommand"; + const handlerExecutionContext: HandlerExecutionContext = { + logger, + clientName, + commandName, + inputFilterSensitiveLog: ImportModelRequest.filterSensitiveLog, + outputFilterSensitiveLog: ImportModelResponse.filterSensitiveLog, + }; + const { requestHandler } = configuration; + return stack.resolve( + (request: FinalizeHandlerArguments) => + requestHandler.handle(request.request as __HttpRequest, options || {}), + handlerExecutionContext + ); + } + + private serialize(input: ImportModelCommandInput, context: __SerdeContext): Promise<__HttpRequest> { + return serializeAws_json1_1ImportModelCommand(input, context); + } + + private deserialize(output: __HttpResponse, context: __SerdeContext): Promise { + return deserializeAws_json1_1ImportModelCommand(output, context); + } + + // Start section: command_body_extra + // End section: command_body_extra +} diff --git a/clients/client-comprehend/src/commands/PutResourcePolicyCommand.ts b/clients/client-comprehend/src/commands/PutResourcePolicyCommand.ts new file mode 100644 index 0000000000000..0ed9ad444504c --- /dev/null +++ b/clients/client-comprehend/src/commands/PutResourcePolicyCommand.ts @@ -0,0 +1,97 @@ +import { getSerdePlugin } from "@aws-sdk/middleware-serde"; +import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@aws-sdk/protocol-http"; +import { Command as $Command } from "@aws-sdk/smithy-client"; +import { + FinalizeHandlerArguments, + Handler, + HandlerExecutionContext, + HttpHandlerOptions as __HttpHandlerOptions, + MetadataBearer as __MetadataBearer, + MiddlewareStack, + SerdeContext as __SerdeContext, +} from "@aws-sdk/types"; + +import { ComprehendClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ComprehendClient"; +import { PutResourcePolicyRequest, PutResourcePolicyResponse } from "../models/models_0"; +import { + deserializeAws_json1_1PutResourcePolicyCommand, + serializeAws_json1_1PutResourcePolicyCommand, +} from "../protocols/Aws_json1_1"; + +export interface PutResourcePolicyCommandInput extends PutResourcePolicyRequest {} +export interface PutResourcePolicyCommandOutput extends PutResourcePolicyResponse, __MetadataBearer {} + +/** + *

Attaches a resource-based policy to a custom model. You can use this policy to authorize + * an entity in another AWS account to import the custom model, which replicates it in Amazon + * Comprehend in their account.

+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ComprehendClient, PutResourcePolicyCommand } from "@aws-sdk/client-comprehend"; // ES Modules import + * // const { ComprehendClient, PutResourcePolicyCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import + * const client = new ComprehendClient(config); + * const command = new PutResourcePolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutResourcePolicyCommandInput} for command's `input` shape. + * @see {@link PutResourcePolicyCommandOutput} for command's `response` shape. + * @see {@link ComprehendClientResolvedConfig | config} for ComprehendClient's `config` shape. + * + */ +export class PutResourcePolicyCommand extends $Command< + PutResourcePolicyCommandInput, + PutResourcePolicyCommandOutput, + ComprehendClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + constructor(readonly input: PutResourcePolicyCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStack, + configuration: ComprehendClientResolvedConfig, + options?: __HttpHandlerOptions + ): Handler { + this.middlewareStack.use(getSerdePlugin(configuration, this.serialize, this.deserialize)); + + const stack = clientStack.concat(this.middlewareStack); + + const { logger } = configuration; + const clientName = "ComprehendClient"; + const commandName = "PutResourcePolicyCommand"; + const handlerExecutionContext: HandlerExecutionContext = { + logger, + clientName, + commandName, + inputFilterSensitiveLog: PutResourcePolicyRequest.filterSensitiveLog, + outputFilterSensitiveLog: PutResourcePolicyResponse.filterSensitiveLog, + }; + const { requestHandler } = configuration; + return stack.resolve( + (request: FinalizeHandlerArguments) => + requestHandler.handle(request.request as __HttpRequest, options || {}), + handlerExecutionContext + ); + } + + private serialize(input: PutResourcePolicyCommandInput, context: __SerdeContext): Promise<__HttpRequest> { + return serializeAws_json1_1PutResourcePolicyCommand(input, context); + } + + private deserialize(output: __HttpResponse, context: __SerdeContext): Promise { + return deserializeAws_json1_1PutResourcePolicyCommand(output, context); + } + + // Start section: command_body_extra + // End section: command_body_extra +} diff --git a/clients/client-comprehend/src/commands/index.ts b/clients/client-comprehend/src/commands/index.ts index 7e14b2d38e049..93f36d3535145 100644 --- a/clients/client-comprehend/src/commands/index.ts +++ b/clients/client-comprehend/src/commands/index.ts @@ -11,6 +11,7 @@ export * from "./CreateEntityRecognizerCommand"; export * from "./DeleteDocumentClassifierCommand"; export * from "./DeleteEndpointCommand"; export * from "./DeleteEntityRecognizerCommand"; +export * from "./DeleteResourcePolicyCommand"; export * from "./DescribeDocumentClassificationJobCommand"; export * from "./DescribeDocumentClassifierCommand"; export * from "./DescribeDominantLanguageDetectionJobCommand"; @@ -20,6 +21,7 @@ export * from "./DescribeEntityRecognizerCommand"; export * from "./DescribeEventsDetectionJobCommand"; export * from "./DescribeKeyPhrasesDetectionJobCommand"; export * from "./DescribePiiEntitiesDetectionJobCommand"; +export * from "./DescribeResourcePolicyCommand"; export * from "./DescribeSentimentDetectionJobCommand"; export * from "./DescribeTopicsDetectionJobCommand"; export * from "./DetectDominantLanguageCommand"; @@ -28,6 +30,7 @@ export * from "./DetectKeyPhrasesCommand"; export * from "./DetectPiiEntitiesCommand"; export * from "./DetectSentimentCommand"; export * from "./DetectSyntaxCommand"; +export * from "./ImportModelCommand"; export * from "./ListDocumentClassificationJobsCommand"; export * from "./ListDocumentClassifierSummariesCommand"; export * from "./ListDocumentClassifiersCommand"; @@ -42,6 +45,7 @@ export * from "./ListPiiEntitiesDetectionJobsCommand"; export * from "./ListSentimentDetectionJobsCommand"; export * from "./ListTagsForResourceCommand"; export * from "./ListTopicsDetectionJobsCommand"; +export * from "./PutResourcePolicyCommand"; export * from "./StartDocumentClassificationJobCommand"; export * from "./StartDominantLanguageDetectionJobCommand"; export * from "./StartEntitiesDetectionJobCommand"; diff --git a/clients/client-comprehend/src/models/models_0.ts b/clients/client-comprehend/src/models/models_0.ts index 84a35024bf219..79ffc6af3d4df 100644 --- a/clients/client-comprehend/src/models/models_0.ts +++ b/clients/client-comprehend/src/models/models_0.ts @@ -22,8 +22,11 @@ export interface AugmentedManifestsListItem { S3Uri: string | undefined; /** - *

The purpose of the data you've provided in the augmented manifest. You can either train or test this data. If you don't specify, the default is train.

- *

TRAIN - all of the documents in the manifest will be used for training. If no test documents are provided, Amazon Comprehend will automatically reserve a portion of the training documents for testing.

+ *

The purpose of the data you've provided in the augmented manifest. You can either train or + * test this data. If you don't specify, the default is train.

+ *

TRAIN - all of the documents in the manifest will be used for training. If no test + * documents are provided, Amazon Comprehend will automatically reserve a portion of the training + * documents for testing.

*

TEST - all of the documents in the manifest will be used for testing.

*/ Split?: Split | string; @@ -41,26 +44,31 @@ export interface AugmentedManifestsListItem { AttributeNames: string[] | undefined; /** - *

The S3 prefix to the annotation files that are referred in the augmented manifest file.

+ *

The S3 prefix to the annotation files that are referred in the augmented manifest + * file.

*/ AnnotationDataS3Uri?: string; /** - *

The S3 prefix to the source files (PDFs) that are referred to in the augmented manifest file.

+ *

The S3 prefix to the source files (PDFs) that are referred to in the augmented manifest + * file.

*/ SourceDocumentsS3Uri?: string; /** - *

The type of augmented manifest. PlainTextDocument or SemiStructuredDocument. If you don't specify, the default is PlainTextDocument.

+ *

The type of augmented manifest. PlainTextDocument or SemiStructuredDocument. If you don't + * specify, the default is PlainTextDocument.

*
    *
  • *

    - * PLAIN_TEXT_DOCUMENT A document type that represents any unicode text that is encoded in UTF-8.

    + * PLAIN_TEXT_DOCUMENT A document type that represents any unicode text that + * is encoded in UTF-8.

    *
    • *
  • *

    - * SEMI_STRUCTURED_DOCUMENT A document type with positional and structural context, like a PDF. For training with Amazon Comprehend, only PDFs are supported. - * For inference, Amazon Comprehend support PDFs, DOCX and TXT.

    + * SEMI_STRUCTURED_DOCUMENT A document type with positional and structural + * context, like a PDF. For training with Amazon Comprehend, only PDFs are supported. For + * inference, Amazon Comprehend support PDFs, DOCX and TXT.

    *
    • *
*/ @@ -788,8 +796,8 @@ export namespace SyntaxToken { } /** - *

The result of calling the operation. The operation - * returns one object that is successfully processed by the operation.

+ *

The result of calling the operation. The + * operation returns one object that is successfully processed by the operation.

*/ export interface BatchDetectSyntaxItemResult { /** @@ -814,10 +822,10 @@ export namespace BatchDetectSyntaxItemResult { export interface BatchDetectSyntaxResponse { /** - *

A list of objects containing the results - * of the operation. The results are sorted in ascending order by the Index field - * and match the order of the documents in the input list. If all of the documents contain an - * error, the ResultList is empty.

+ *

A list of objects containing the + * results of the operation. The results are sorted in ascending order by the Index + * field and match the order of the documents in the input list. If all of the documents contain + * an error, the ResultList is empty.

*/ ResultList: BatchDetectSyntaxItemResult[] | undefined; @@ -1195,9 +1203,9 @@ export interface DocumentClassifierInputDataConfig { S3Uri?: string; /** - *

The Amazon S3 URI for the input data. - * The Amazon S3 bucket must be in the same AWS Region as the API endpoint that you are calling. - * The URI can point to a single input file or it can provide the prefix for a collection of input files.

+ *

The Amazon S3 URI for the input data. The Amazon S3 bucket must be in the same AWS Region + * as the API endpoint that you are calling. The URI can point to a single input file or it can + * provide the prefix for a collection of input files.

*/ TestS3Uri?: string; @@ -1360,9 +1368,10 @@ export interface CreateDocumentClassifierRequest { DocumentClassifierName: string | undefined; /** - *

The version name given to the newly created classifier. - * Version names can have a maximum of 256 characters. Alphanumeric characters, hyphens (-) and underscores (_) are allowed. - * The version name must be unique among all models with the same classifier name in the account/AWS Region.

+ *

The version name given to the newly created classifier. Version names can have a maximum + * of 256 characters. Alphanumeric characters, hyphens (-) and underscores (_) are allowed. The + * version name must be unique among all models with the same classifier name in the account/AWS + * Region.

*/ VersionName?: string; @@ -1454,6 +1463,24 @@ export interface CreateDocumentClassifierRequest { * */ ModelKmsKeyId?: string; + + /** + *

The resource-based policy to attach to your custom document classifier model. You can use + * this policy to allow another AWS account to import your custom model.

+ *

Provide your policy as a JSON body that you enter as a UTF-8 encoded string without line + * breaks. To provide valid JSON, enclose the attribute names and values in double quotes. If the + * JSON body is also enclosed in double quotes, then you must escape the double quotes that are + * inside the policy:

+ *

+ * "{\"attribute\": \"value\", \"attribute\": [\"value\"]}" + *

+ *

To avoid escaping quotes, you can use single quotes to enclose the policy and double + * quotes to enclose the JSON names and values:

+ *

+ * '{"attribute": "value", "attribute": ["value"]}' + *

+ */ + ModelPolicy?: string; } export namespace CreateDocumentClassifierRequest { @@ -1618,8 +1645,9 @@ export interface EntityRecognizerAnnotations { S3Uri: string | undefined; /** - *

This specifies the Amazon S3 location where the test annotations for an entity recognizer are located. - * The URI must be in the same AWS Region as the API endpoint that you are calling.

+ *

This specifies the Amazon S3 location where the test annotations for an entity recognizer + * are located. The URI must be in the same AWS Region as the API endpoint that you are + * calling.

*/ TestS3Uri?: string; } @@ -1655,17 +1683,18 @@ export interface EntityRecognizerDocuments { S3Uri: string | undefined; /** - *

Specifies the Amazon S3 location where the test documents for an entity recognizer are located. - * The URI must be in the same AWS Region as the API endpoint that you are calling.

+ *

Specifies the Amazon S3 location where the test documents for an entity recognizer are + * located. The URI must be in the same AWS Region as the API endpoint that you are + * calling.

*/ TestS3Uri?: string; /** - *

Specifies how the text in an input file should be processed. This is optional, and the default is ONE_DOC_PER_LINE. - * - * ONE_DOC_PER_FILE - Each file is considered a separate document. Use this option when you are processing large documents, such as newspaper articles or scientific papers. - * - * ONE_DOC_PER_LINE - Each line in a file is considered a separate document. Use this option when you are processing many short documents, such as text messages.

+ *

Specifies how the text in an input file should be processed. This is optional, and the + * default is ONE_DOC_PER_LINE. ONE_DOC_PER_FILE - Each file is considered a separate document. + * Use this option when you are processing large documents, such as newspaper articles or + * scientific papers. ONE_DOC_PER_LINE - Each line in a file is considered a separate document. + * Use this option when you are processing many short documents, such as text messages.

*/ InputFormat?: InputFormat | string; } @@ -1812,9 +1841,10 @@ export interface CreateEntityRecognizerRequest { RecognizerName: string | undefined; /** - *

The version name given to the newly created recognizer. - * Version names can be a maximum of 256 characters. Alphanumeric characters, hyphens (-) and underscores (_) are allowed. - * The version name must be unique among all models with the same recognizer name in the account/ AWS Region.

+ *

The version name given to the newly created recognizer. Version names can be a maximum of + * 256 characters. Alphanumeric characters, hyphens (-) and underscores (_) are allowed. The + * version name must be unique among all models with the same recognizer name in the account/ AWS + * Region.

*/ VersionName?: string; @@ -1893,6 +1923,24 @@ export interface CreateEntityRecognizerRequest { * */ ModelKmsKeyId?: string; + + /** + *

The JSON resource-based policy to attach to your custom entity recognizer model. You can + * use this policy to allow another AWS account to import your custom model.

+ *

Provide your JSON as a UTF-8 encoded string without line breaks. To provide valid JSON for + * your policy, enclose the attribute names and values in double quotes. If the JSON body is also + * enclosed in double quotes, then you must escape the double quotes that are inside the + * policy:

+ *

+ * "{\"attribute\": \"value\", \"attribute\": [\"value\"]}" + *

+ *

To avoid escaping quotes, you can use single quotes to enclose the policy and double + * quotes to enclose the JSON names and values:

+ *

+ * '{"attribute": "value", "attribute": ["value"]}' + *

+ */ + ModelPolicy?: string; } export namespace CreateEntityRecognizerRequest { @@ -2001,6 +2049,38 @@ export namespace DeleteEntityRecognizerResponse { }); } +export interface DeleteResourcePolicyRequest { + /** + *

The Amazon Resource Name (ARN) of the custom model version that has the policy to delete.

+ */ + ResourceArn: string | undefined; + + /** + *

The revision ID of the policy to delete.

+ */ + PolicyRevisionId?: string; +} + +export namespace DeleteResourcePolicyRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: DeleteResourcePolicyRequest): any => ({ + ...obj, + }); +} + +export interface DeleteResourcePolicyResponse {} + +export namespace DeleteResourcePolicyResponse { + /** + * @internal + */ + export const filterSensitiveLog = (obj: DeleteResourcePolicyResponse): any => ({ + ...obj, + }); +} + export interface DescribeDocumentClassificationJobRequest { /** *

The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its @@ -2042,11 +2122,13 @@ export interface DocumentReaderConfig { *

    *
  • *

    - * TEXTRACT_DETECT_DOCUMENT_TEXT - The service calls DetectDocumentText for PDF documents per page.

    + * TEXTRACT_DETECT_DOCUMENT_TEXT - The service calls DetectDocumentText + * for PDF documents per page.

    *
    • *
  • *

    - * TEXTRACT_ANALYZE_DOCUMENT - The service calls AnalyzeDocument for PDF documents per page.

    + * TEXTRACT_ANALYZE_DOCUMENT - The service calls AnalyzeDocument for PDF + * documents per page.

    *
    • *
*/ @@ -2057,12 +2139,13 @@ export interface DocumentReaderConfig { *
    *
  • *

    - * SERVICE_DEFAULT - use service defaults for Document reading. For Digital PDF it would mean using an internal parser instead of Textract APIs

    + * SERVICE_DEFAULT - use service defaults for Document reading. For + * Digital PDF it would mean using an internal parser instead of Textract APIs

    *
    • *
  • *

    - * FORCE_DOCUMENT_READ_ACTION - Always use specified action for DocumentReadAction, including Digital PDF. - *

    + * FORCE_DOCUMENT_READ_ACTION - Always use specified action for + * DocumentReadAction, including Digital PDF.

    *
    • *
*/ @@ -2117,9 +2200,11 @@ export interface InputDataConfig { InputFormat?: InputFormat | string; /** - *

The document reader config field applies only for InputDataConfig of StartEntitiesDetectionJob.

- *

Use DocumentReaderConfig to provide specifications about how you want your inference documents read. - * Currently it applies for PDF documents in StartEntitiesDetectionJob custom inference.

+ *

The document reader config field applies only for InputDataConfig of + * StartEntitiesDetectionJob.

+ *

Use DocumentReaderConfig to provide specifications about how you want your inference + * documents read. Currently it applies for PDF documents in StartEntitiesDetectionJob custom + * inference.

*/ DocumentReaderConfig?: DocumentReaderConfig; } @@ -2482,6 +2567,12 @@ export interface DocumentClassifierProperties { *

The version name that you assigned to the document classifier.

*/ VersionName?: string; + + /** + *

The Amazon Resource Name (ARN) of the source model. This model was imported from a + * different AWS account to create the document classifier model in your AWS account.

+ */ + SourceModelArn?: string; } export namespace DocumentClassifierProperties { @@ -2701,7 +2792,8 @@ export interface EndpointProperties { ModelArn?: string; /** - *

ARN of the new model to use for updating an existing endpoint. This ARN is going to be different from the model ARN when the update is in progress

+ *

ARN of the new model to use for updating an existing endpoint. This ARN is going to be + * different from the model ARN when the update is in progress

*/ DesiredModelArn?: string; @@ -2735,7 +2827,8 @@ export interface EndpointProperties { DataAccessRoleArn?: string; /** - *

Data access role ARN to use in case the new model is encrypted with a customer KMS key.

+ *

Data access role ARN to use in case the new model is encrypted with a customer KMS + * key.

*/ DesiredDataAccessRoleArn?: string; } @@ -3171,6 +3264,12 @@ export interface EntityRecognizerProperties { *

The version name you assigned to the entity recognizer.

*/ VersionName?: string; + + /** + *

The Amazon Resource Name (ARN) of the source model. This model was imported from a + * different AWS account to create the entity recognizer model in your AWS account.

+ */ + SourceModelArn?: string; } export namespace EntityRecognizerProperties { @@ -3656,6 +3755,54 @@ export namespace DescribePiiEntitiesDetectionJobResponse { }); } +export interface DescribeResourcePolicyRequest { + /** + *

The Amazon Resource Name (ARN) of the policy to describe.

+ */ + ResourceArn: string | undefined; +} + +export namespace DescribeResourcePolicyRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: DescribeResourcePolicyRequest): any => ({ + ...obj, + }); +} + +export interface DescribeResourcePolicyResponse { + /** + *

The JSON body of the resource-based policy.

+ */ + ResourcePolicy?: string; + + /** + *

The time at which the policy was created.

+ */ + CreationTime?: Date; + + /** + *

The time at which the policy was last modified.

+ */ + LastModifiedTime?: Date; + + /** + *

The revision ID of the policy. Each time you modify a policy, Amazon Comprehend assigns a + * new revision ID, and it deletes the prior version of the policy.

+ */ + PolicyRevisionId?: string; +} + +export namespace DescribeResourcePolicyResponse { + /** + * @internal + */ + export const filterSensitiveLog = (obj: DescribeResourcePolicyResponse): any => ({ + ...obj, + }); +} + export interface DescribeSentimentDetectionJobRequest { /** *

The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its @@ -4245,6 +4392,84 @@ export namespace DetectSyntaxResponse { }); } +export interface ImportModelRequest { + /** + *

The Amazon Resource Name (ARN) of the custom model to import.

+ */ + SourceModelArn: string | undefined; + + /** + *

The name to assign to the custom model that is created in Amazon Comprehend by this + * import.

+ */ + ModelName?: string; + + /** + *

The version name given to the custom model that is created by this import. Version names + * can have a maximum of 256 characters. Alphanumeric characters, hyphens (-) and underscores (_) + * are allowed. The version name must be unique among all models with the same classifier name in + * the account/AWS Region.

+ */ + VersionName?: string; + + /** + *

ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt + * trained custom models. The ModelKmsKeyId can be either of the following formats:

+ *
    + *
  • + *

    KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab" + *

    + *
    • + *
  • + *

    Amazon Resource Name (ARN) of a KMS Key: + * "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" + *

    + *
    • + *
+ */ + ModelKmsKeyId?: string; + + /** + *

The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that allows + * Amazon Comprehend to use Amazon Key Management Service (KMS) to encrypt or decrypt the custom + * model.

+ */ + DataAccessRoleArn?: string; + + /** + *

Tags to be associated with the custom model that is created by this import. A tag is a + * key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a + * tag with "Sales" as the key might be added to a resource to indicate its use by the sales + * department.

+ */ + Tags?: Tag[]; +} + +export namespace ImportModelRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: ImportModelRequest): any => ({ + ...obj, + }); +} + +export interface ImportModelResponse { + /** + *

The Amazon Resource Name (ARN) of the custom model being imported.

+ */ + ModelArn?: string; +} + +export namespace ImportModelResponse { + /** + * @internal + */ + export const filterSensitiveLog = (obj: ImportModelResponse): any => ({ + ...obj, + }); +} + /** *

The filter specified for the operation is invalid. Specify a different * filter.

@@ -4518,7 +4743,8 @@ export namespace ListDocumentClassifierSummariesResponse { /** *

Provides information for filtering a list of dominant language detection jobs. For more - * information, see the operation.

+ * information, see the + * operation.

*/ export interface DominantLanguageDetectionJobFilter { /** @@ -5433,6 +5659,62 @@ export namespace ListTopicsDetectionJobsResponse { }); } +export interface PutResourcePolicyRequest { + /** + *

The Amazon Resource Name (ARN) of the custom model to attach the policy to.

+ */ + ResourceArn: string | undefined; + + /** + *

The JSON resource-based policy to attach to your custom model. Provide your JSON as a + * UTF-8 encoded string without line breaks. To provide valid JSON for your policy, enclose the + * attribute names and values in double quotes. If the JSON body is also enclosed in double + * quotes, then you must escape the double quotes that are inside the policy:

+ *

+ * "{\"attribute\": \"value\", \"attribute\": [\"value\"]}" + *

+ *

To avoid escaping quotes, you can use single quotes to enclose the policy and double + * quotes to enclose the JSON names and values:

+ *

+ * '{"attribute": "value", "attribute": ["value"]}' + *

+ */ + ResourcePolicy: string | undefined; + + /** + *

The revision ID that Amazon Comprehend assigned to the policy that you are updating. If + * you are creating a new policy that has no prior version, don't use this parameter. Amazon + * Comprehend creates the revision ID for you.

+ */ + PolicyRevisionId?: string; +} + +export namespace PutResourcePolicyRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: PutResourcePolicyRequest): any => ({ + ...obj, + }); +} + +export interface PutResourcePolicyResponse { + /** + *

The revision ID of the policy. Each time you modify a policy, Amazon Comprehend assigns a + * new revision ID, and it deletes the prior version of the policy.

+ */ + PolicyRevisionId?: string; +} + +export namespace PutResourcePolicyResponse { + /** + * @internal + */ + export const filterSensitiveLog = (obj: PutResourcePolicyResponse): any => ({ + ...obj, + }); +} + export interface StartDocumentClassificationJobRequest { /** *

The identifier of the job.

diff --git a/clients/client-comprehend/src/protocols/Aws_json1_1.ts b/clients/client-comprehend/src/protocols/Aws_json1_1.ts index f1a804ddfb32c..ce980382c2175 100644 --- a/clients/client-comprehend/src/protocols/Aws_json1_1.ts +++ b/clients/client-comprehend/src/protocols/Aws_json1_1.ts @@ -58,6 +58,10 @@ import { DeleteEntityRecognizerCommandInput, DeleteEntityRecognizerCommandOutput, } from "../commands/DeleteEntityRecognizerCommand"; +import { + DeleteResourcePolicyCommandInput, + DeleteResourcePolicyCommandOutput, +} from "../commands/DeleteResourcePolicyCommand"; import { DescribeDocumentClassificationJobCommandInput, DescribeDocumentClassificationJobCommandOutput, @@ -91,6 +95,10 @@ import { DescribePiiEntitiesDetectionJobCommandInput, DescribePiiEntitiesDetectionJobCommandOutput, } from "../commands/DescribePiiEntitiesDetectionJobCommand"; +import { + DescribeResourcePolicyCommandInput, + DescribeResourcePolicyCommandOutput, +} from "../commands/DescribeResourcePolicyCommand"; import { DescribeSentimentDetectionJobCommandInput, DescribeSentimentDetectionJobCommandOutput, @@ -108,6 +116,7 @@ import { DetectKeyPhrasesCommandInput, DetectKeyPhrasesCommandOutput } from "../ import { DetectPiiEntitiesCommandInput, DetectPiiEntitiesCommandOutput } from "../commands/DetectPiiEntitiesCommand"; import { DetectSentimentCommandInput, DetectSentimentCommandOutput } from "../commands/DetectSentimentCommand"; import { DetectSyntaxCommandInput, DetectSyntaxCommandOutput } from "../commands/DetectSyntaxCommand"; +import { ImportModelCommandInput, ImportModelCommandOutput } from "../commands/ImportModelCommand"; import { ListDocumentClassificationJobsCommandInput, ListDocumentClassificationJobsCommandOutput, @@ -161,6 +170,7 @@ import { ListTopicsDetectionJobsCommandInput, ListTopicsDetectionJobsCommandOutput, } from "../commands/ListTopicsDetectionJobsCommand"; +import { PutResourcePolicyCommandInput, PutResourcePolicyCommandOutput } from "../commands/PutResourcePolicyCommand"; import { StartDocumentClassificationJobCommandInput, StartDocumentClassificationJobCommandOutput, @@ -266,6 +276,8 @@ import { DeleteEndpointResponse, DeleteEntityRecognizerRequest, DeleteEntityRecognizerResponse, + DeleteResourcePolicyRequest, + DeleteResourcePolicyResponse, DescribeDocumentClassificationJobRequest, DescribeDocumentClassificationJobResponse, DescribeDocumentClassifierRequest, @@ -284,6 +296,8 @@ import { DescribeKeyPhrasesDetectionJobResponse, DescribePiiEntitiesDetectionJobRequest, DescribePiiEntitiesDetectionJobResponse, + DescribeResourcePolicyRequest, + DescribeResourcePolicyResponse, DescribeSentimentDetectionJobRequest, DescribeSentimentDetectionJobResponse, DescribeTopicsDetectionJobRequest, @@ -334,6 +348,8 @@ import { EntityTypesListItem, EventsDetectionJobFilter, EventsDetectionJobProperties, + ImportModelRequest, + ImportModelResponse, InputDataConfig, InternalServerException, InvalidFilterException, @@ -378,6 +394,8 @@ import { PiiEntity, PiiEntityType, PiiOutputDataConfig, + PutResourcePolicyRequest, + PutResourcePolicyResponse, RedactionConfig, ResourceInUseException, ResourceLimitExceededException, @@ -605,6 +623,19 @@ export const serializeAws_json1_1DeleteEntityRecognizerCommand = async ( return buildHttpRpcRequest(context, headers, "/", undefined, body); }; +export const serializeAws_json1_1DeleteResourcePolicyCommand = async ( + input: DeleteResourcePolicyCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const headers: __HeaderBag = { + "content-type": "application/x-amz-json-1.1", + "x-amz-target": "Comprehend_20171127.DeleteResourcePolicy", + }; + let body: any; + body = JSON.stringify(serializeAws_json1_1DeleteResourcePolicyRequest(input, context)); + return buildHttpRpcRequest(context, headers, "/", undefined, body); +}; + export const serializeAws_json1_1DescribeDocumentClassificationJobCommand = async ( input: DescribeDocumentClassificationJobCommandInput, context: __SerdeContext @@ -722,6 +753,19 @@ export const serializeAws_json1_1DescribePiiEntitiesDetectionJobCommand = async return buildHttpRpcRequest(context, headers, "/", undefined, body); }; +export const serializeAws_json1_1DescribeResourcePolicyCommand = async ( + input: DescribeResourcePolicyCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const headers: __HeaderBag = { + "content-type": "application/x-amz-json-1.1", + "x-amz-target": "Comprehend_20171127.DescribeResourcePolicy", + }; + let body: any; + body = JSON.stringify(serializeAws_json1_1DescribeResourcePolicyRequest(input, context)); + return buildHttpRpcRequest(context, headers, "/", undefined, body); +}; + export const serializeAws_json1_1DescribeSentimentDetectionJobCommand = async ( input: DescribeSentimentDetectionJobCommandInput, context: __SerdeContext @@ -826,6 +870,19 @@ export const serializeAws_json1_1DetectSyntaxCommand = async ( return buildHttpRpcRequest(context, headers, "/", undefined, body); }; +export const serializeAws_json1_1ImportModelCommand = async ( + input: ImportModelCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const headers: __HeaderBag = { + "content-type": "application/x-amz-json-1.1", + "x-amz-target": "Comprehend_20171127.ImportModel", + }; + let body: any; + body = JSON.stringify(serializeAws_json1_1ImportModelRequest(input, context)); + return buildHttpRpcRequest(context, headers, "/", undefined, body); +}; + export const serializeAws_json1_1ListDocumentClassificationJobsCommand = async ( input: ListDocumentClassificationJobsCommandInput, context: __SerdeContext @@ -1008,6 +1065,19 @@ export const serializeAws_json1_1ListTopicsDetectionJobsCommand = async ( return buildHttpRpcRequest(context, headers, "/", undefined, body); }; +export const serializeAws_json1_1PutResourcePolicyCommand = async ( + input: PutResourcePolicyCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const headers: __HeaderBag = { + "content-type": "application/x-amz-json-1.1", + "x-amz-target": "Comprehend_20171127.PutResourcePolicy", + }; + let body: any; + body = JSON.stringify(serializeAws_json1_1PutResourcePolicyRequest(input, context)); + return buildHttpRpcRequest(context, headers, "/", undefined, body); +}; + export const serializeAws_json1_1StartDocumentClassificationJobCommand = async ( input: StartDocumentClassificationJobCommandInput, context: __SerdeContext @@ -2437,6 +2507,76 @@ const deserializeAws_json1_1DeleteEntityRecognizerCommandError = async ( return Promise.reject(Object.assign(new Error(message), response)); }; +export const deserializeAws_json1_1DeleteResourcePolicyCommand = async ( + output: __HttpResponse, + context: __SerdeContext +): Promise => { + if (output.statusCode >= 300) { + return deserializeAws_json1_1DeleteResourcePolicyCommandError(output, context); + } + const data: any = await parseBody(output.body, context); + let contents: any = {}; + contents = deserializeAws_json1_1DeleteResourcePolicyResponse(data, context); + const response: DeleteResourcePolicyCommandOutput = { + $metadata: deserializeMetadata(output), + ...contents, + }; + return Promise.resolve(response); +}; + +const deserializeAws_json1_1DeleteResourcePolicyCommandError = async ( + output: __HttpResponse, + context: __SerdeContext +): Promise => { + const parsedOutput: any = { + ...output, + body: await parseBody(output.body, context), + }; + let response: __SmithyException & __MetadataBearer & { [key: string]: any }; + let errorCode = "UnknownError"; + errorCode = loadRestJsonErrorCode(output, parsedOutput.body); + switch (errorCode) { + case "InternalServerException": + case "com.amazonaws.comprehend#InternalServerException": + response = { + ...(await deserializeAws_json1_1InternalServerExceptionResponse(parsedOutput, context)), + name: errorCode, + $metadata: deserializeMetadata(output), + }; + break; + case "InvalidRequestException": + case "com.amazonaws.comprehend#InvalidRequestException": + response = { + ...(await deserializeAws_json1_1InvalidRequestExceptionResponse(parsedOutput, context)), + name: errorCode, + $metadata: deserializeMetadata(output), + }; + break; + case "ResourceNotFoundException": + case "com.amazonaws.comprehend#ResourceNotFoundException": + response = { + ...(await deserializeAws_json1_1ResourceNotFoundExceptionResponse(parsedOutput, context)), + name: errorCode, + $metadata: deserializeMetadata(output), + }; + break; + default: + const parsedBody = parsedOutput.body; + errorCode = parsedBody.code || parsedBody.Code || errorCode; + response = { + ...parsedBody, + name: `${errorCode}`, + message: parsedBody.message || parsedBody.Message || errorCode, + $fault: "client", + $metadata: deserializeMetadata(output), + } as any; + } + const message = response.message || response.Message || errorCode; + response.message = message; + delete response.Message; + return Promise.reject(Object.assign(new Error(message), response)); +}; + export const deserializeAws_json1_1DescribeDocumentClassificationJobCommand = async ( output: __HttpResponse, context: __SerdeContext @@ -3139,6 +3279,76 @@ const deserializeAws_json1_1DescribePiiEntitiesDetectionJobCommandError = async return Promise.reject(Object.assign(new Error(message), response)); }; +export const deserializeAws_json1_1DescribeResourcePolicyCommand = async ( + output: __HttpResponse, + context: __SerdeContext +): Promise => { + if (output.statusCode >= 300) { + return deserializeAws_json1_1DescribeResourcePolicyCommandError(output, context); + } + const data: any = await parseBody(output.body, context); + let contents: any = {}; + contents = deserializeAws_json1_1DescribeResourcePolicyResponse(data, context); + const response: DescribeResourcePolicyCommandOutput = { + $metadata: deserializeMetadata(output), + ...contents, + }; + return Promise.resolve(response); +}; + +const deserializeAws_json1_1DescribeResourcePolicyCommandError = async ( + output: __HttpResponse, + context: __SerdeContext +): Promise => { + const parsedOutput: any = { + ...output, + body: await parseBody(output.body, context), + }; + let response: __SmithyException & __MetadataBearer & { [key: string]: any }; + let errorCode = "UnknownError"; + errorCode = loadRestJsonErrorCode(output, parsedOutput.body); + switch (errorCode) { + case "InternalServerException": + case "com.amazonaws.comprehend#InternalServerException": + response = { + ...(await deserializeAws_json1_1InternalServerExceptionResponse(parsedOutput, context)), + name: errorCode, + $metadata: deserializeMetadata(output), + }; + break; + case "InvalidRequestException": + case "com.amazonaws.comprehend#InvalidRequestException": + response = { + ...(await deserializeAws_json1_1InvalidRequestExceptionResponse(parsedOutput, context)), + name: errorCode, + $metadata: deserializeMetadata(output), + }; + break; + case "ResourceNotFoundException": + case "com.amazonaws.comprehend#ResourceNotFoundException": + response = { + ...(await deserializeAws_json1_1ResourceNotFoundExceptionResponse(parsedOutput, context)), + name: errorCode, + $metadata: deserializeMetadata(output), + }; + break; + default: + const parsedBody = parsedOutput.body; + errorCode = parsedBody.code || parsedBody.Code || errorCode; + response = { + ...parsedBody, + name: `${errorCode}`, + message: parsedBody.message || parsedBody.Message || errorCode, + $fault: "client", + $metadata: deserializeMetadata(output), + } as any; + } + const message = response.message || response.Message || errorCode; + response.message = message; + delete response.Message; + return Promise.reject(Object.assign(new Error(message), response)); +}; + export const deserializeAws_json1_1DescribeSentimentDetectionJobCommand = async ( output: __HttpResponse, context: __SerdeContext @@ -3763,6 +3973,124 @@ const deserializeAws_json1_1DetectSyntaxCommandError = async ( return Promise.reject(Object.assign(new Error(message), response)); }; +export const deserializeAws_json1_1ImportModelCommand = async ( + output: __HttpResponse, + context: __SerdeContext +): Promise => { + if (output.statusCode >= 300) { + return deserializeAws_json1_1ImportModelCommandError(output, context); + } + const data: any = await parseBody(output.body, context); + let contents: any = {}; + contents = deserializeAws_json1_1ImportModelResponse(data, context); + const response: ImportModelCommandOutput = { + $metadata: deserializeMetadata(output), + ...contents, + }; + return Promise.resolve(response); +}; + +const deserializeAws_json1_1ImportModelCommandError = async ( + output: __HttpResponse, + context: __SerdeContext +): Promise => { + const parsedOutput: any = { + ...output, + body: await parseBody(output.body, context), + }; + let response: __SmithyException & __MetadataBearer & { [key: string]: any }; + let errorCode = "UnknownError"; + errorCode = loadRestJsonErrorCode(output, parsedOutput.body); + switch (errorCode) { + case "InternalServerException": + case "com.amazonaws.comprehend#InternalServerException": + response = { + ...(await deserializeAws_json1_1InternalServerExceptionResponse(parsedOutput, context)), + name: errorCode, + $metadata: deserializeMetadata(output), + }; + break; + case "InvalidRequestException": + case "com.amazonaws.comprehend#InvalidRequestException": + response = { + ...(await deserializeAws_json1_1InvalidRequestExceptionResponse(parsedOutput, context)), + name: errorCode, + $metadata: deserializeMetadata(output), + }; + break; + case "KmsKeyValidationException": + case "com.amazonaws.comprehend#KmsKeyValidationException": + response = { + ...(await deserializeAws_json1_1KmsKeyValidationExceptionResponse(parsedOutput, context)), + name: errorCode, + $metadata: deserializeMetadata(output), + }; + break; + case "ResourceInUseException": + case "com.amazonaws.comprehend#ResourceInUseException": + response = { + ...(await deserializeAws_json1_1ResourceInUseExceptionResponse(parsedOutput, context)), + name: errorCode, + $metadata: deserializeMetadata(output), + }; + break; + case "ResourceLimitExceededException": + case "com.amazonaws.comprehend#ResourceLimitExceededException": + response = { + ...(await deserializeAws_json1_1ResourceLimitExceededExceptionResponse(parsedOutput, context)), + name: errorCode, + $metadata: deserializeMetadata(output), + }; + break; + case "ResourceNotFoundException": + case "com.amazonaws.comprehend#ResourceNotFoundException": + response = { + ...(await deserializeAws_json1_1ResourceNotFoundExceptionResponse(parsedOutput, context)), + name: errorCode, + $metadata: deserializeMetadata(output), + }; + break; + case "ResourceUnavailableException": + case "com.amazonaws.comprehend#ResourceUnavailableException": + response = { + ...(await deserializeAws_json1_1ResourceUnavailableExceptionResponse(parsedOutput, context)), + name: errorCode, + $metadata: deserializeMetadata(output), + }; + break; + case "TooManyRequestsException": + case "com.amazonaws.comprehend#TooManyRequestsException": + response = { + ...(await deserializeAws_json1_1TooManyRequestsExceptionResponse(parsedOutput, context)), + name: errorCode, + $metadata: deserializeMetadata(output), + }; + break; + case "TooManyTagsException": + case "com.amazonaws.comprehend#TooManyTagsException": + response = { + ...(await deserializeAws_json1_1TooManyTagsExceptionResponse(parsedOutput, context)), + name: errorCode, + $metadata: deserializeMetadata(output), + }; + break; + default: + const parsedBody = parsedOutput.body; + errorCode = parsedBody.code || parsedBody.Code || errorCode; + response = { + ...parsedBody, + name: `${errorCode}`, + message: parsedBody.message || parsedBody.Message || errorCode, + $fault: "client", + $metadata: deserializeMetadata(output), + } as any; + } + const message = response.message || response.Message || errorCode; + response.message = message; + delete response.Message; + return Promise.reject(Object.assign(new Error(message), response)); +}; + export const deserializeAws_json1_1ListDocumentClassificationJobsCommand = async ( output: __HttpResponse, context: __SerdeContext @@ -4823,6 +5151,76 @@ const deserializeAws_json1_1ListTopicsDetectionJobsCommandError = async ( return Promise.reject(Object.assign(new Error(message), response)); }; +export const deserializeAws_json1_1PutResourcePolicyCommand = async ( + output: __HttpResponse, + context: __SerdeContext +): Promise => { + if (output.statusCode >= 300) { + return deserializeAws_json1_1PutResourcePolicyCommandError(output, context); + } + const data: any = await parseBody(output.body, context); + let contents: any = {}; + contents = deserializeAws_json1_1PutResourcePolicyResponse(data, context); + const response: PutResourcePolicyCommandOutput = { + $metadata: deserializeMetadata(output), + ...contents, + }; + return Promise.resolve(response); +}; + +const deserializeAws_json1_1PutResourcePolicyCommandError = async ( + output: __HttpResponse, + context: __SerdeContext +): Promise => { + const parsedOutput: any = { + ...output, + body: await parseBody(output.body, context), + }; + let response: __SmithyException & __MetadataBearer & { [key: string]: any }; + let errorCode = "UnknownError"; + errorCode = loadRestJsonErrorCode(output, parsedOutput.body); + switch (errorCode) { + case "InternalServerException": + case "com.amazonaws.comprehend#InternalServerException": + response = { + ...(await deserializeAws_json1_1InternalServerExceptionResponse(parsedOutput, context)), + name: errorCode, + $metadata: deserializeMetadata(output), + }; + break; + case "InvalidRequestException": + case "com.amazonaws.comprehend#InvalidRequestException": + response = { + ...(await deserializeAws_json1_1InvalidRequestExceptionResponse(parsedOutput, context)), + name: errorCode, + $metadata: deserializeMetadata(output), + }; + break; + case "ResourceNotFoundException": + case "com.amazonaws.comprehend#ResourceNotFoundException": + response = { + ...(await deserializeAws_json1_1ResourceNotFoundExceptionResponse(parsedOutput, context)), + name: errorCode, + $metadata: deserializeMetadata(output), + }; + break; + default: + const parsedBody = parsedOutput.body; + errorCode = parsedBody.code || parsedBody.Code || errorCode; + response = { + ...parsedBody, + name: `${errorCode}`, + message: parsedBody.message || parsedBody.Message || errorCode, + $fault: "client", + $metadata: deserializeMetadata(output), + } as any; + } + const message = response.message || response.Message || errorCode; + response.message = message; + delete response.Message; + return Promise.reject(Object.assign(new Error(message), response)); +}; + export const deserializeAws_json1_1StartDocumentClassificationJobCommand = async ( output: __HttpResponse, context: __SerdeContext @@ -6751,6 +7149,7 @@ const serializeAws_json1_1CreateDocumentClassifierRequest = ( ...(input.LanguageCode !== undefined && input.LanguageCode !== null && { LanguageCode: input.LanguageCode }), ...(input.Mode !== undefined && input.Mode !== null && { Mode: input.Mode }), ...(input.ModelKmsKeyId !== undefined && input.ModelKmsKeyId !== null && { ModelKmsKeyId: input.ModelKmsKeyId }), + ...(input.ModelPolicy !== undefined && input.ModelPolicy !== null && { ModelPolicy: input.ModelPolicy }), ...(input.OutputDataConfig !== undefined && input.OutputDataConfig !== null && { OutputDataConfig: serializeAws_json1_1DocumentClassifierOutputDataConfig(input.OutputDataConfig, context), @@ -6791,6 +7190,7 @@ const serializeAws_json1_1CreateEntityRecognizerRequest = ( }), ...(input.LanguageCode !== undefined && input.LanguageCode !== null && { LanguageCode: input.LanguageCode }), ...(input.ModelKmsKeyId !== undefined && input.ModelKmsKeyId !== null && { ModelKmsKeyId: input.ModelKmsKeyId }), + ...(input.ModelPolicy !== undefined && input.ModelPolicy !== null && { ModelPolicy: input.ModelPolicy }), ...(input.RecognizerName !== undefined && input.RecognizerName !== null && { RecognizerName: input.RecognizerName }), ...(input.Tags !== undefined && input.Tags !== null && { Tags: serializeAws_json1_1TagList(input.Tags, context) }), @@ -6839,6 +7239,17 @@ const serializeAws_json1_1DeleteEntityRecognizerRequest = ( }; }; +const serializeAws_json1_1DeleteResourcePolicyRequest = ( + input: DeleteResourcePolicyRequest, + context: __SerdeContext +): any => { + return { + ...(input.PolicyRevisionId !== undefined && + input.PolicyRevisionId !== null && { PolicyRevisionId: input.PolicyRevisionId }), + ...(input.ResourceArn !== undefined && input.ResourceArn !== null && { ResourceArn: input.ResourceArn }), + }; +}; + const serializeAws_json1_1DescribeDocumentClassificationJobRequest = ( input: DescribeDocumentClassificationJobRequest, context: __SerdeContext @@ -6919,6 +7330,15 @@ const serializeAws_json1_1DescribePiiEntitiesDetectionJobRequest = ( }; }; +const serializeAws_json1_1DescribeResourcePolicyRequest = ( + input: DescribeResourcePolicyRequest, + context: __SerdeContext +): any => { + return { + ...(input.ResourceArn !== undefined && input.ResourceArn !== null && { ResourceArn: input.ResourceArn }), + }; +}; + const serializeAws_json1_1DescribeSentimentDetectionJobRequest = ( input: DescribeSentimentDetectionJobRequest, context: __SerdeContext @@ -7229,6 +7649,19 @@ const serializeAws_json1_1EventsDetectionJobFilter = ( }; }; +const serializeAws_json1_1ImportModelRequest = (input: ImportModelRequest, context: __SerdeContext): any => { + return { + ...(input.DataAccessRoleArn !== undefined && + input.DataAccessRoleArn !== null && { DataAccessRoleArn: input.DataAccessRoleArn }), + ...(input.ModelKmsKeyId !== undefined && input.ModelKmsKeyId !== null && { ModelKmsKeyId: input.ModelKmsKeyId }), + ...(input.ModelName !== undefined && input.ModelName !== null && { ModelName: input.ModelName }), + ...(input.SourceModelArn !== undefined && + input.SourceModelArn !== null && { SourceModelArn: input.SourceModelArn }), + ...(input.Tags !== undefined && input.Tags !== null && { Tags: serializeAws_json1_1TagList(input.Tags, context) }), + ...(input.VersionName !== undefined && input.VersionName !== null && { VersionName: input.VersionName }), + }; +}; + const serializeAws_json1_1InputDataConfig = (input: InputDataConfig, context: __SerdeContext): any => { return { ...(input.DocumentReaderConfig !== undefined && @@ -7460,6 +7893,19 @@ const serializeAws_json1_1PiiEntitiesDetectionJobFilter = ( }; }; +const serializeAws_json1_1PutResourcePolicyRequest = ( + input: PutResourcePolicyRequest, + context: __SerdeContext +): any => { + return { + ...(input.PolicyRevisionId !== undefined && + input.PolicyRevisionId !== null && { PolicyRevisionId: input.PolicyRevisionId }), + ...(input.ResourceArn !== undefined && input.ResourceArn !== null && { ResourceArn: input.ResourceArn }), + ...(input.ResourcePolicy !== undefined && + input.ResourcePolicy !== null && { ResourcePolicy: input.ResourcePolicy }), + }; +}; + const serializeAws_json1_1RedactionConfig = (input: RedactionConfig, context: __SerdeContext): any => { return { ...(input.MaskCharacter !== undefined && input.MaskCharacter !== null && { MaskCharacter: input.MaskCharacter }), @@ -8194,6 +8640,13 @@ const deserializeAws_json1_1DeleteEntityRecognizerResponse = ( return {} as any; }; +const deserializeAws_json1_1DeleteResourcePolicyResponse = ( + output: any, + context: __SerdeContext +): DeleteResourcePolicyResponse => { + return {} as any; +}; + const deserializeAws_json1_1DescribeDocumentClassificationJobResponse = ( output: any, context: __SerdeContext @@ -8306,6 +8759,24 @@ const deserializeAws_json1_1DescribePiiEntitiesDetectionJobResponse = ( } as any; }; +const deserializeAws_json1_1DescribeResourcePolicyResponse = ( + output: any, + context: __SerdeContext +): DescribeResourcePolicyResponse => { + return { + CreationTime: + output.CreationTime !== undefined && output.CreationTime !== null + ? __expectNonNull(__parseEpochTimestamp(__expectNumber(output.CreationTime))) + : undefined, + LastModifiedTime: + output.LastModifiedTime !== undefined && output.LastModifiedTime !== null + ? __expectNonNull(__parseEpochTimestamp(__expectNumber(output.LastModifiedTime))) + : undefined, + PolicyRevisionId: __expectString(output.PolicyRevisionId), + ResourcePolicy: __expectString(output.ResourcePolicy), + } as any; +}; + const deserializeAws_json1_1DescribeSentimentDetectionJobResponse = ( output: any, context: __SerdeContext @@ -8521,6 +8992,7 @@ const deserializeAws_json1_1DocumentClassifierProperties = ( output.OutputDataConfig !== undefined && output.OutputDataConfig !== null ? deserializeAws_json1_1DocumentClassifierOutputDataConfig(output.OutputDataConfig, context) : undefined, + SourceModelArn: __expectString(output.SourceModelArn), Status: __expectString(output.Status), SubmitTime: output.SubmitTime !== undefined && output.SubmitTime !== null @@ -8914,6 +9386,7 @@ const deserializeAws_json1_1EntityRecognizerProperties = ( output.RecognizerMetadata !== undefined && output.RecognizerMetadata !== null ? deserializeAws_json1_1EntityRecognizerMetadata(output.RecognizerMetadata, context) : undefined, + SourceModelArn: __expectString(output.SourceModelArn), Status: __expectString(output.Status), SubmitTime: output.SubmitTime !== undefined && output.SubmitTime !== null @@ -9057,6 +9530,12 @@ const deserializeAws_json1_1EventsDetectionJobPropertiesList = ( }); }; +const deserializeAws_json1_1ImportModelResponse = (output: any, context: __SerdeContext): ImportModelResponse => { + return { + ModelArn: __expectString(output.ModelArn), + } as any; +}; + const deserializeAws_json1_1InputDataConfig = (output: any, context: __SerdeContext): InputDataConfig => { return { DocumentReaderConfig: @@ -9626,6 +10105,15 @@ const deserializeAws_json1_1PiiOutputDataConfig = (output: any, context: __Serde } as any; }; +const deserializeAws_json1_1PutResourcePolicyResponse = ( + output: any, + context: __SerdeContext +): PutResourcePolicyResponse => { + return { + PolicyRevisionId: __expectString(output.PolicyRevisionId), + } as any; +}; + const deserializeAws_json1_1RedactionConfig = (output: any, context: __SerdeContext): RedactionConfig => { return { MaskCharacter: __expectString(output.MaskCharacter), diff --git a/clients/client-cost-explorer/src/CostExplorer.ts b/clients/client-cost-explorer/src/CostExplorer.ts index 90ccd07d08e61..d76ae172f1c9a 100644 --- a/clients/client-cost-explorer/src/CostExplorer.ts +++ b/clients/client-cost-explorer/src/CostExplorer.ts @@ -879,10 +879,6 @@ export class CostExplorer extends CostExplorerClient { *

* * - * - *

- * GetSavingsPlansCoverage doesn't support filtering by tags. GetSavingsPlansCoverage also doesn't support the OR operator between filter dimensions. For the full request syntax with supported parameters, see Examples.

- * *

To determine valid values for a dimension, use the GetDimensionValues operation.

*/ public getSavingsPlansCoverage( @@ -952,8 +948,6 @@ export class CostExplorer extends CostExplorerClient { *

Retrieves the Savings Plans utilization for your account across date ranges with daily or monthly granularity. Management account in an organization have access to member accounts. You can use GetDimensionValues in SAVINGS_PLANS to determine the possible dimension values.

* *

You cannot group by any dimension values for GetSavingsPlansUtilization.

- *

- * GetSavingsPlansUtilization doesn't support filtering by tags. GetSavingsPlansUtilization also doesn't support the OR operator between filter dimensions. For the full request syntax with supported parameters, see Examples.

* */ public getSavingsPlansUtilization( @@ -990,8 +984,6 @@ export class CostExplorer extends CostExplorerClient { * *

* GetSavingsPlanUtilizationDetails internally groups data by SavingsPlansArn.

- *

- * GetSavingsPlansUtilizationDetails doesn't support filtering by tags. GetSavingsPlansUtilizationDetails also doesn't support the OR operator between filter dimensions. For the full request syntax with supported parameters, see Examples.

* */ public getSavingsPlansUtilizationDetails( diff --git a/clients/client-cost-explorer/src/commands/GetSavingsPlansCoverageCommand.ts b/clients/client-cost-explorer/src/commands/GetSavingsPlansCoverageCommand.ts index d1f735f32f980..f77f964460775 100644 --- a/clients/client-cost-explorer/src/commands/GetSavingsPlansCoverageCommand.ts +++ b/clients/client-cost-explorer/src/commands/GetSavingsPlansCoverageCommand.ts @@ -45,10 +45,6 @@ export interface GetSavingsPlansCoverageCommandOutput extends GetSavingsPlansCov *

* * - * - *

- * GetSavingsPlansCoverage doesn't support filtering by tags. GetSavingsPlansCoverage also doesn't support the OR operator between filter dimensions. For the full request syntax with supported parameters, see Examples.

- * *

To determine valid values for a dimension, use the GetDimensionValues operation.

* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-cost-explorer/src/commands/GetSavingsPlansUtilizationCommand.ts b/clients/client-cost-explorer/src/commands/GetSavingsPlansUtilizationCommand.ts index 007877006ff04..c43a050393c8d 100644 --- a/clients/client-cost-explorer/src/commands/GetSavingsPlansUtilizationCommand.ts +++ b/clients/client-cost-explorer/src/commands/GetSavingsPlansUtilizationCommand.ts @@ -25,8 +25,6 @@ export interface GetSavingsPlansUtilizationCommandOutput extends GetSavingsPlans *

Retrieves the Savings Plans utilization for your account across date ranges with daily or monthly granularity. Management account in an organization have access to member accounts. You can use GetDimensionValues in SAVINGS_PLANS to determine the possible dimension values.

* *

You cannot group by any dimension values for GetSavingsPlansUtilization.

- *

- * GetSavingsPlansUtilization doesn't support filtering by tags. GetSavingsPlansUtilization also doesn't support the OR operator between filter dimensions. For the full request syntax with supported parameters, see Examples.

* * @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-cost-explorer/src/commands/GetSavingsPlansUtilizationDetailsCommand.ts b/clients/client-cost-explorer/src/commands/GetSavingsPlansUtilizationDetailsCommand.ts index 66df19bc51b94..1c2f2c82128f1 100644 --- a/clients/client-cost-explorer/src/commands/GetSavingsPlansUtilizationDetailsCommand.ts +++ b/clients/client-cost-explorer/src/commands/GetSavingsPlansUtilizationDetailsCommand.ts @@ -31,8 +31,6 @@ export interface GetSavingsPlansUtilizationDetailsCommandOutput * *

* GetSavingsPlanUtilizationDetails internally groups data by SavingsPlansArn.

- *

- * GetSavingsPlansUtilizationDetails doesn't support filtering by tags. GetSavingsPlansUtilizationDetails also doesn't support the OR operator between filter dimensions. For the full request syntax with supported parameters, see Examples.

* * @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-cost-explorer/src/models/models_0.ts b/clients/client-cost-explorer/src/models/models_0.ts index 650ea5b14c5dc..fa0f39d207268 100644 --- a/clients/client-cost-explorer/src/models/models_0.ts +++ b/clients/client-cost-explorer/src/models/models_0.ts @@ -243,6 +243,7 @@ export enum Dimension { DEPLOYMENT_OPTION = "DEPLOYMENT_OPTION", INSTANCE_TYPE = "INSTANCE_TYPE", INSTANCE_TYPE_FAMILY = "INSTANCE_TYPE_FAMILY", + INVOICING_ENTITY = "INVOICING_ENTITY", LEGAL_ENTITY_NAME = "LEGAL_ENTITY_NAME", LINKED_ACCOUNT = "LINKED_ACCOUNT", LINKED_ACCOUNT_NAME = "LINKED_ACCOUNT_NAME", @@ -4568,8 +4569,8 @@ export interface GetCostAndUsageRequest { * and get the costs that are associated with that account's usage of that service. You can nest Expression objects * to define any combination of dimension filters. For more information, see * Expression.

- *

The default values are EQUALS and CASE_SENSITIVE. Valid values for MatchOptions for Dimensions are EQUALS and CASE_SENSITIVE.

*

Valid values for MatchOptions for CostCategories and Tags are EQUALS, ABSENT, and CASE_SENSITIVE.

+ *

The default values are EQUALS and CASE_SENSITIVE. Valid values for MatchOptions for Dimensions are EQUALS and CASE_SENSITIVE.

*/ Filter?: Expression; @@ -4595,7 +4596,7 @@ export interface GetCostAndUsageRequest { /** *

You can group Amazon Web Services costs using up to two different groups, either dimensions, tag keys, * cost categories, or any two group by types.

- *

Valid values for the DIMENSION type are AZ, INSTANCE_TYPE, LEGAL_ENTITY_NAME, LINKED_ACCOUNT, + *

Valid values for the DIMENSION type are AZ, INSTANCE_TYPE, LEGAL_ENTITY_NAME, INVOICING_ENTITY, LINKED_ACCOUNT, * OPERATION, PLATFORM, PURCHASE_TYPE, SERVICE, * TENANCY, RECORD_TYPE, and USAGE_TYPE.

*

When you group by the TAG type and include a valid tag key, you get all tag values, including empty strings.

@@ -4639,8 +4640,8 @@ export interface GetCostAndUsageWithResourcesRequest { *

The GetCostAndUsageWithResources operation requires that you either group by or filter by a * ResourceId. It requires the Expression * "SERVICE = Amazon Elastic Compute Cloud - Compute" in the filter.

- *

The default values are EQUALS and CASE_SENSITIVE. Valid values for MatchOptions for Dimensions are EQUALS and CASE_SENSITIVE.

*

Valid values for MatchOptions for CostCategories and Tags are EQUALS, ABSENT, and CASE_SENSITIVE.

+ *

The default values are EQUALS and CASE_SENSITIVE. Valid values for MatchOptions for Dimensions are EQUALS and CASE_SENSITIVE.

*/ Filter: Expression | undefined; @@ -5022,7 +5023,7 @@ export interface GetDimensionValuesRequest { /** *

The name of the dimension. Each Dimension is available for a different Context. - * For more information, see Context. + * For more information, see Context. * *

*/ @@ -5040,12 +5041,30 @@ export interface GetDimensionValuesRequest { *

AZ - The Availability Zone. An example is us-east-1a.

* *
  • + *

    BILLING_ENTITY - The Amazon Web Services seller that your account is with. Possible values are the following:

    + *

    - Amazon Web Services(Amazon Web Services): The entity that sells Amazon Web Services services.

    + *

    - AISPL (Amazon Internet Services Pvt. Ltd.): The local Indian entity that is an acting reseller for Amazon Web Services services in India.

    + *

    - Amazon Web Services Marketplace: The entity that supports the sale of solutions built on Amazon Web Services by third-party software providers.

    + *
    • + *
  • + *

    CACHE_ENGINE - The Amazon ElastiCache operating system. Examples are Windows or Linux.

    + *
    • + *
  • + *

    DEPLOYMENT_OPTION - The scope of Amazon Relational Database Service deployments. Valid values are SingleAZ and MultiAZ.

    + *
    • + *
  • *

    DATABASE_ENGINE - The Amazon Relational Database Service database. Examples are Aurora or MySQL.

    *
    • *
  • *

    INSTANCE_TYPE - The type of Amazon EC2 instance. An example is m4.xlarge.

    *
    • *
  • + *

    INSTANCE_TYPE_FAMILY - A family of instance types optimized to fit different use cases. Examples are Compute Optimized (C4, C5, C6g, C7g etc.), Memory Optimization (R4, R5n, R5b, R6g etc).

    + *
    • + *
  • + *

    INVOICING_ENTITY - The name of the entity issuing the Amazon Web Services invoice.

    + *
    • + *
  • *

    LEGAL_ENTITY_NAME - The name of the organization that sells you Amazon Web Services services, such as Amazon Web Services.

    *
    • *
  • @@ -5066,9 +5085,21 @@ export interface GetDimensionValuesRequest { * Instances and Standard Reserved Instances.

    *
    • *
  • + *

    RESERVATION_ID - The unique identifier for an Amazon Web Services Reservation Instance.

    + *
    • + *
  • + *

    SAVINGS_PLAN_ARN - The unique identifier for your Savings Plans.

    + *
    • + *
  • + *

    SAVINGS_PLANS_TYPE - Type of Savings Plans (EC2 Instance or Compute).

    + *
    • + *
  • *

    SERVICE - The Amazon Web Services service such as Amazon DynamoDB.

    *
    • *
  • + *

    TENANCY - The tenancy of a resource. Examples are shared or dedicated.

    + *
    • + *
  • *

    USAGE_TYPE - The type of usage. An example is DataTransfer-In-Bytes. The response for the GetDimensionValues operation * includes a unit attribute. Examples include GB and Hrs.

    *
    • @@ -5140,7 +5171,7 @@ export interface GetDimensionValuesRequest { * field contains the Amazon Web Services ID of the member account.

    * *
  • - *

    SAVINGS_PLAN_ARN - The unique identifier for your Savings Plan

    + *

    SAVINGS_PLAN_ARN - The unique identifier for your Savings Plans.

    *
    • * */ @@ -5301,6 +5332,9 @@ export interface GetReservationCoverageRequest { *

    INSTANCE_TYPE

    * *
  • + *

    INVOICING_ENTITY

    + *
    • + *
  • *

    LINKED_ACCOUNT

    *
    • *
  • @@ -5370,7 +5404,8 @@ export interface GetReservationCoverageRequest { *

    * GetReservationCoverage uses the same * Expression object - * as the other operations, but only AND is supported among each dimension. You can nest only one level deep.

    + * as the other operations, but only AND is supported among each dimension. You can nest only one level deep. + * If there are multiple values for a dimension, they are OR'd together.

    *

    If you don't provide a SERVICE filter, Cost Explorer defaults to EC2.

    *

    Cost category is also supported.

    */ @@ -5638,7 +5673,7 @@ export interface GetReservationUtilizationRequest { * GetReservationUtilization uses the same * Expression object * as the other operations, but only AND is supported among each dimension, and nesting is supported up to - * only one level deep.

    + * only one level deep. If there are multiple values for a dimension, they are OR'd together.

    */ Filter?: Expression; @@ -5897,8 +5932,8 @@ export interface GetSavingsPlansCoverageRequest { *

    * GetSavingsPlansCoverage uses the same * Expression object - * as the other operations, but only AND is supported among each dimension.

    - *

    Cost category is supported. Tags are not supported.

    + * as the other operations, but only AND is supported among each dimension. If there are multiple values for a dimension, they are OR'd together.

    + *

    Cost category is also supported.

    */ Filter?: Expression; @@ -6073,7 +6108,6 @@ export interface GetSavingsPlansUtilizationDetailsRequest { * GetSavingsPlansUtilizationDetails uses the same * Expression object * as the other operations, but only AND is supported among each dimension.

    - *

    Filtering by tags isn't supported.

    */ Filter?: Expression; @@ -6198,7 +6232,6 @@ export interface GetSavingsPlansUtilizationRequest { * GetSavingsPlansUtilization uses the same * Expression object * as the other operations, but only AND is supported among each dimension.

    - *

    Filtering by tags isn't supported.

    */ Filter?: Expression; diff --git a/clients/client-dynamodb/src/DynamoDB.ts b/clients/client-dynamodb/src/DynamoDB.ts index c87840e009ba7..6258151ea0b5b 100644 --- a/clients/client-dynamodb/src/DynamoDB.ts +++ b/clients/client-dynamodb/src/DynamoDB.ts @@ -337,9 +337,11 @@ export class DynamoDB extends DynamoDBClient { /** *

    The BatchWriteItem operation puts or deletes multiple items in one or - * more tables. A single call to BatchWriteItem can write up to 16 MB of data, - * which can comprise as many as 25 put or delete requests. Individual items to be written - * can be as large as 400 KB.

    + * more tables. A single call to BatchWriteItem can transmit up to 16MB of + * data over the network, consisting of up to 25 item put or delete operations. While + * individual items can be up to 400 KB once stored, it's important to + * note that an item's representation might be greater than 400KB while being sent in + * DynamoDB's JSON format for the API call. For more details on this distinction, see Naming Rules and Data Types.

    * *

    * BatchWriteItem cannot update items. To update items, use the @@ -2274,8 +2276,8 @@ export class DynamoDB extends DynamoDBClient { *

    Updates the status for contributor insights for a specific table or index. CloudWatch * Contributor Insights for DynamoDB graphs display the partition key and (if applicable) * sort key of frequently accessed items and frequently throttled items in plaintext. If - * you require the use of AWS Key Management Service (KMS) to encrypt this table’s - * partition key and sort key data with an AWS managed key or customer managed key, you + * you require the use of Amazon Web Services Key Management Service (KMS) to encrypt this table’s + * partition key and sort key data with an Amazon Web Services managed key or customer managed key, you * should not enable CloudWatch Contributor Insights for DynamoDB for this table.

    */ public updateContributorInsights( diff --git a/clients/client-dynamodb/src/commands/BatchWriteItemCommand.ts b/clients/client-dynamodb/src/commands/BatchWriteItemCommand.ts index 56c366dfc7be6..574ac3dcc9e2b 100644 --- a/clients/client-dynamodb/src/commands/BatchWriteItemCommand.ts +++ b/clients/client-dynamodb/src/commands/BatchWriteItemCommand.ts @@ -23,9 +23,11 @@ export interface BatchWriteItemCommandOutput extends BatchWriteItemOutput, __Met /** *

    The BatchWriteItem operation puts or deletes multiple items in one or - * more tables. A single call to BatchWriteItem can write up to 16 MB of data, - * which can comprise as many as 25 put or delete requests. Individual items to be written - * can be as large as 400 KB.

    + * more tables. A single call to BatchWriteItem can transmit up to 16MB of + * data over the network, consisting of up to 25 item put or delete operations. While + * individual items can be up to 400 KB once stored, it's important to + * note that an item's representation might be greater than 400KB while being sent in + * DynamoDB's JSON format for the API call. For more details on this distinction, see Naming Rules and Data Types.

    * *

    * BatchWriteItem cannot update items. To update items, use the diff --git a/clients/client-dynamodb/src/commands/UpdateContributorInsightsCommand.ts b/clients/client-dynamodb/src/commands/UpdateContributorInsightsCommand.ts index edfcde0bde2c4..1ce6a9a2fbfc5 100644 --- a/clients/client-dynamodb/src/commands/UpdateContributorInsightsCommand.ts +++ b/clients/client-dynamodb/src/commands/UpdateContributorInsightsCommand.ts @@ -25,8 +25,8 @@ export interface UpdateContributorInsightsCommandOutput extends UpdateContributo *

    Updates the status for contributor insights for a specific table or index. CloudWatch * Contributor Insights for DynamoDB graphs display the partition key and (if applicable) * sort key of frequently accessed items and frequently throttled items in plaintext. If - * you require the use of AWS Key Management Service (KMS) to encrypt this table’s - * partition key and sort key data with an AWS managed key or customer managed key, you + * you require the use of Amazon Web Services Key Management Service (KMS) to encrypt this table’s + * partition key and sort key data with an Amazon Web Services managed key or customer managed key, you * should not enable CloudWatch Contributor Insights for DynamoDB for this table.

    * @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-dynamodb/src/models/models_0.ts b/clients/client-dynamodb/src/models/models_0.ts index c75399a5bc467..5e7887f13d1b2 100644 --- a/clients/client-dynamodb/src/models/models_0.ts +++ b/clients/client-dynamodb/src/models/models_0.ts @@ -1321,10 +1321,6 @@ export interface PointInTimeRecoveryDescription { *
      *
    • *

      - * ENABLING - Point in time recovery is being enabled.

      - *
      • - *
    • - *

      * ENABLED - Point in time recovery is enabled.

      *
      • *
    • diff --git a/clients/client-ec2/src/EC2.ts b/clients/client-ec2/src/EC2.ts index 042003f083c3d..e32cab19b6817 100644 --- a/clients/client-ec2/src/EC2.ts +++ b/clients/client-ec2/src/EC2.ts @@ -1948,6 +1948,11 @@ import { ImportVolumeCommandInput, ImportVolumeCommandOutput, } from "./commands/ImportVolumeCommand"; +import { + ListImagesInRecycleBinCommand, + ListImagesInRecycleBinCommandInput, + ListImagesInRecycleBinCommandOutput, +} from "./commands/ListImagesInRecycleBinCommand"; import { ListSnapshotsInRecycleBinCommand, ListSnapshotsInRecycleBinCommandInput, @@ -2406,6 +2411,11 @@ import { RestoreAddressToClassicCommandInput, RestoreAddressToClassicCommandOutput, } from "./commands/RestoreAddressToClassicCommand"; +import { + RestoreImageFromRecycleBinCommand, + RestoreImageFromRecycleBinCommandInput, + RestoreImageFromRecycleBinCommandOutput, +} from "./commands/RestoreImageFromRecycleBinCommand"; import { RestoreManagedPrefixListVersionCommand, RestoreManagedPrefixListVersionCommandInput, @@ -4893,6 +4903,12 @@ export class EC2 extends EC2Client { /** *

      Creates an Amazon EBS-backed AMI from an Amazon EBS-backed instance * that is either running or stopped.

      + * + *

      By default, Amazon EC2 shuts down and reboots the instance before creating the AMI to ensure that everything on + * the instance is stopped and in a consistent state during the creation process. If you're confident that your + * instance is in a consistent state appropriate for AMI creation, use the NoReboot + * parameter to prevent Amazon EC2 from shutting down and rebooting the instance.

      + *       * * * @@ -9253,10 +9269,18 @@ export class EC2 extends EC2Client { } /** - *

      Deregisters the specified AMI. After you deregister an AMI, it can't be used to launch - * new instances; however, it doesn't affect any instances that you've already launched - * from the AMI. You'll continue to incur usage costs for those instances until you - * terminate them.

      + *

      Deregisters the specified AMI. After you deregister an AMI, it can't be used to + * launch new instances.

      + * + * + *

      If you deregister an AMI that matches a Recycle Bin retention rule, the AMI is + * retained in the Recycle Bin for the specified retention period. For more information, + * see Recycle + * Bin in the Amazon Elastic Compute Cloud User Guide.

      + * + *

      When you deregister an AMI, it doesn't affect any instances that you've already + * launched from the AMI. You'll continue to incur usage costs for those instances until + * you terminate them.

      *

      When you deregister an Amazon EBS-backed AMI, it doesn't affect the snapshot that was * created for the root volume of the instance during the AMI creation process. When you * deregister an instance store-backed AMI, it doesn't affect the files that you uploaded @@ -14333,6 +14357,9 @@ export class EC2 extends EC2Client { *

      Discontinue faster launching for a Windows AMI, and clean up existing pre-provisioned snapshots. * When you disable faster launching, the AMI uses the standard launch process for each * instance. All pre-provisioned snapshots must be removed before you can enable faster launching again.

      + * + *

      To change these settings, you must own the AMI.

      + *       */ public disableFastLaunch( args: DisableFastLaunchCommandInput, @@ -15080,6 +15107,9 @@ export class EC2 extends EC2Client { * Then it creates a set of reserved snapshots that are used for subsequent launches. The * reserved snapshots are automatically replenished as they are used, depending on your * settings for launch frequency.

      + * + *

      To change these settings, you must own the AMI.

      + *       */ public enableFastLaunch( args: EnableFastLaunchCommandInput, @@ -16959,6 +16989,40 @@ export class EC2 extends EC2Client { } } + /** + *

      Lists one or more AMIs that are currently in the Recycle Bin. For more information, + * see Recycle + * Bin in the Amazon Elastic Compute Cloud User Guide.

      + */ + public listImagesInRecycleBin( + args: ListImagesInRecycleBinCommandInput, + options?: __HttpHandlerOptions + ): Promise; + public listImagesInRecycleBin( + args: ListImagesInRecycleBinCommandInput, + cb: (err: any, data?: ListImagesInRecycleBinCommandOutput) => void + ): void; + public listImagesInRecycleBin( + args: ListImagesInRecycleBinCommandInput, + options: __HttpHandlerOptions, + cb: (err: any, data?: ListImagesInRecycleBinCommandOutput) => void + ): void; + public listImagesInRecycleBin( + args: ListImagesInRecycleBinCommandInput, + optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListImagesInRecycleBinCommandOutput) => void), + cb?: (err: any, data?: ListImagesInRecycleBinCommandOutput) => void + ): Promise | void { + const command = new ListImagesInRecycleBinCommand(args); + if (typeof optionsOrCb === "function") { + this.send(command, optionsOrCb); + } else if (typeof cb === "function") { + if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); + this.send(command, optionsOrCb || {}, cb); + } else { + return this.send(command, optionsOrCb); + } + } + /** *

      Lists one or more snapshots that are currently in the Recycle Bin.

      */ @@ -20512,6 +20576,38 @@ export class EC2 extends EC2Client { } } + /** + *

      Restores an AMI from the Recycle Bin. For more information, see Recycle Bin in the Amazon Elastic Compute Cloud User Guide.

      + */ + public restoreImageFromRecycleBin( + args: RestoreImageFromRecycleBinCommandInput, + options?: __HttpHandlerOptions + ): Promise; + public restoreImageFromRecycleBin( + args: RestoreImageFromRecycleBinCommandInput, + cb: (err: any, data?: RestoreImageFromRecycleBinCommandOutput) => void + ): void; + public restoreImageFromRecycleBin( + args: RestoreImageFromRecycleBinCommandInput, + options: __HttpHandlerOptions, + cb: (err: any, data?: RestoreImageFromRecycleBinCommandOutput) => void + ): void; + public restoreImageFromRecycleBin( + args: RestoreImageFromRecycleBinCommandInput, + optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: RestoreImageFromRecycleBinCommandOutput) => void), + cb?: (err: any, data?: RestoreImageFromRecycleBinCommandOutput) => void + ): Promise | void { + const command = new RestoreImageFromRecycleBinCommand(args); + if (typeof optionsOrCb === "function") { + this.send(command, optionsOrCb); + } else if (typeof cb === "function") { + if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); + this.send(command, optionsOrCb || {}, cb); + } else { + return this.send(command, optionsOrCb); + } + } + /** *

      Restores the entries from a previous version of a managed prefix list to a new version of the prefix list.

      */ diff --git a/clients/client-ec2/src/EC2Client.ts b/clients/client-ec2/src/EC2Client.ts index 5f8f66df9891c..10b6cc22aa906 100644 --- a/clients/client-ec2/src/EC2Client.ts +++ b/clients/client-ec2/src/EC2Client.ts @@ -1377,6 +1377,10 @@ import { ImportInstanceCommandInput, ImportInstanceCommandOutput } from "./comma import { ImportKeyPairCommandInput, ImportKeyPairCommandOutput } from "./commands/ImportKeyPairCommand"; import { ImportSnapshotCommandInput, ImportSnapshotCommandOutput } from "./commands/ImportSnapshotCommand"; import { ImportVolumeCommandInput, ImportVolumeCommandOutput } from "./commands/ImportVolumeCommand"; +import { + ListImagesInRecycleBinCommandInput, + ListImagesInRecycleBinCommandOutput, +} from "./commands/ListImagesInRecycleBinCommand"; import { ListSnapshotsInRecycleBinCommandInput, ListSnapshotsInRecycleBinCommandOutput, @@ -1693,6 +1697,10 @@ import { RestoreAddressToClassicCommandInput, RestoreAddressToClassicCommandOutput, } from "./commands/RestoreAddressToClassicCommand"; +import { + RestoreImageFromRecycleBinCommandInput, + RestoreImageFromRecycleBinCommandOutput, +} from "./commands/RestoreImageFromRecycleBinCommand"; import { RestoreManagedPrefixListVersionCommandInput, RestoreManagedPrefixListVersionCommandOutput, @@ -2178,6 +2186,7 @@ export type ServiceInputTypes = | ImportKeyPairCommandInput | ImportSnapshotCommandInput | ImportVolumeCommandInput + | ListImagesInRecycleBinCommandInput | ListSnapshotsInRecycleBinCommandInput | ModifyAddressAttributeCommandInput | ModifyAvailabilityZoneGroupCommandInput @@ -2272,6 +2281,7 @@ export type ServiceInputTypes = | ResetNetworkInterfaceAttributeCommandInput | ResetSnapshotAttributeCommandInput | RestoreAddressToClassicCommandInput + | RestoreImageFromRecycleBinCommandInput | RestoreManagedPrefixListVersionCommandInput | RestoreSnapshotFromRecycleBinCommandInput | RestoreSnapshotTierCommandInput @@ -2699,6 +2709,7 @@ export type ServiceOutputTypes = | ImportKeyPairCommandOutput | ImportSnapshotCommandOutput | ImportVolumeCommandOutput + | ListImagesInRecycleBinCommandOutput | ListSnapshotsInRecycleBinCommandOutput | ModifyAddressAttributeCommandOutput | ModifyAvailabilityZoneGroupCommandOutput @@ -2793,6 +2804,7 @@ export type ServiceOutputTypes = | ResetNetworkInterfaceAttributeCommandOutput | ResetSnapshotAttributeCommandOutput | RestoreAddressToClassicCommandOutput + | RestoreImageFromRecycleBinCommandOutput | RestoreManagedPrefixListVersionCommandOutput | RestoreSnapshotFromRecycleBinCommandOutput | RestoreSnapshotTierCommandOutput diff --git a/clients/client-ec2/src/commands/CreateImageCommand.ts b/clients/client-ec2/src/commands/CreateImageCommand.ts index 6c6c8504f55e1..ec2b7bc9bb37c 100644 --- a/clients/client-ec2/src/commands/CreateImageCommand.ts +++ b/clients/client-ec2/src/commands/CreateImageCommand.ts @@ -21,6 +21,12 @@ export interface CreateImageCommandOutput extends CreateImageResult, __MetadataB /** *

      Creates an Amazon EBS-backed AMI from an Amazon EBS-backed instance * that is either running or stopped.

      + * + *

      By default, Amazon EC2 shuts down and reboots the instance before creating the AMI to ensure that everything on + * the instance is stopped and in a consistent state during the creation process. If you're confident that your + * instance is in a consistent state appropriate for AMI creation, use the NoReboot + * parameter to prevent Amazon EC2 from shutting down and rebooting the instance.

      + *       * * * diff --git a/clients/client-ec2/src/commands/DeregisterImageCommand.ts b/clients/client-ec2/src/commands/DeregisterImageCommand.ts index b76d2af31aca0..06c7ac9a8b844 100644 --- a/clients/client-ec2/src/commands/DeregisterImageCommand.ts +++ b/clients/client-ec2/src/commands/DeregisterImageCommand.ts @@ -19,10 +19,18 @@ export interface DeregisterImageCommandInput extends DeregisterImageRequest {} export interface DeregisterImageCommandOutput extends __MetadataBearer {} /** - *

      Deregisters the specified AMI. After you deregister an AMI, it can't be used to launch - * new instances; however, it doesn't affect any instances that you've already launched - * from the AMI. You'll continue to incur usage costs for those instances until you - * terminate them.

      + *

      Deregisters the specified AMI. After you deregister an AMI, it can't be used to + * launch new instances.

      + * + * + *

      If you deregister an AMI that matches a Recycle Bin retention rule, the AMI is + * retained in the Recycle Bin for the specified retention period. For more information, + * see Recycle + * Bin in the Amazon Elastic Compute Cloud User Guide.

      + * + *

      When you deregister an AMI, it doesn't affect any instances that you've already + * launched from the AMI. You'll continue to incur usage costs for those instances until + * you terminate them.

      *

      When you deregister an Amazon EBS-backed AMI, it doesn't affect the snapshot that was * created for the root volume of the instance during the AMI creation process. When you * deregister an instance store-backed AMI, it doesn't affect the files that you uploaded diff --git a/clients/client-ec2/src/commands/DisableFastLaunchCommand.ts b/clients/client-ec2/src/commands/DisableFastLaunchCommand.ts index 181a4bced7cbf..033de9ee1c1f2 100644 --- a/clients/client-ec2/src/commands/DisableFastLaunchCommand.ts +++ b/clients/client-ec2/src/commands/DisableFastLaunchCommand.ts @@ -25,6 +25,9 @@ export interface DisableFastLaunchCommandOutput extends DisableFastLaunchResult, *

      Discontinue faster launching for a Windows AMI, and clean up existing pre-provisioned snapshots. * When you disable faster launching, the AMI uses the standard launch process for each * instance. All pre-provisioned snapshots must be removed before you can enable faster launching again.

      + * + *

      To change these settings, you must own the AMI.

      + *       * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-ec2/src/commands/EnableFastLaunchCommand.ts b/clients/client-ec2/src/commands/EnableFastLaunchCommand.ts index 58b3684760e15..daa09124450b3 100644 --- a/clients/client-ec2/src/commands/EnableFastLaunchCommand.ts +++ b/clients/client-ec2/src/commands/EnableFastLaunchCommand.ts @@ -28,6 +28,9 @@ export interface EnableFastLaunchCommandOutput extends EnableFastLaunchResult, _ * Then it creates a set of reserved snapshots that are used for subsequent launches. The * reserved snapshots are automatically replenished as they are used, depending on your * settings for launch frequency.

      + * + *

      To change these settings, you must own the AMI.

      + *       * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-ec2/src/commands/ListImagesInRecycleBinCommand.ts b/clients/client-ec2/src/commands/ListImagesInRecycleBinCommand.ts new file mode 100644 index 0000000000000..0464145ee9c60 --- /dev/null +++ b/clients/client-ec2/src/commands/ListImagesInRecycleBinCommand.ts @@ -0,0 +1,97 @@ +import { getSerdePlugin } from "@aws-sdk/middleware-serde"; +import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@aws-sdk/protocol-http"; +import { Command as $Command } from "@aws-sdk/smithy-client"; +import { + FinalizeHandlerArguments, + Handler, + HandlerExecutionContext, + HttpHandlerOptions as __HttpHandlerOptions, + MetadataBearer as __MetadataBearer, + MiddlewareStack, + SerdeContext as __SerdeContext, +} from "@aws-sdk/types"; + +import { EC2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../EC2Client"; +import { ListImagesInRecycleBinRequest, ListImagesInRecycleBinResult } from "../models/models_5"; +import { + deserializeAws_ec2ListImagesInRecycleBinCommand, + serializeAws_ec2ListImagesInRecycleBinCommand, +} from "../protocols/Aws_ec2"; + +export interface ListImagesInRecycleBinCommandInput extends ListImagesInRecycleBinRequest {} +export interface ListImagesInRecycleBinCommandOutput extends ListImagesInRecycleBinResult, __MetadataBearer {} + +/** + *

      Lists one or more AMIs that are currently in the Recycle Bin. For more information, + * see Recycle + * Bin in the Amazon Elastic Compute Cloud User Guide.

      + * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, ListImagesInRecycleBinCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, ListImagesInRecycleBinCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new ListImagesInRecycleBinCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListImagesInRecycleBinCommandInput} for command's `input` shape. + * @see {@link ListImagesInRecycleBinCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for EC2Client's `config` shape. + * + */ +export class ListImagesInRecycleBinCommand extends $Command< + ListImagesInRecycleBinCommandInput, + ListImagesInRecycleBinCommandOutput, + EC2ClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + constructor(readonly input: ListImagesInRecycleBinCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStack, + configuration: EC2ClientResolvedConfig, + options?: __HttpHandlerOptions + ): Handler { + this.middlewareStack.use(getSerdePlugin(configuration, this.serialize, this.deserialize)); + + const stack = clientStack.concat(this.middlewareStack); + + const { logger } = configuration; + const clientName = "EC2Client"; + const commandName = "ListImagesInRecycleBinCommand"; + const handlerExecutionContext: HandlerExecutionContext = { + logger, + clientName, + commandName, + inputFilterSensitiveLog: ListImagesInRecycleBinRequest.filterSensitiveLog, + outputFilterSensitiveLog: ListImagesInRecycleBinResult.filterSensitiveLog, + }; + const { requestHandler } = configuration; + return stack.resolve( + (request: FinalizeHandlerArguments) => + requestHandler.handle(request.request as __HttpRequest, options || {}), + handlerExecutionContext + ); + } + + private serialize(input: ListImagesInRecycleBinCommandInput, context: __SerdeContext): Promise<__HttpRequest> { + return serializeAws_ec2ListImagesInRecycleBinCommand(input, context); + } + + private deserialize(output: __HttpResponse, context: __SerdeContext): Promise { + return deserializeAws_ec2ListImagesInRecycleBinCommand(output, context); + } + + // Start section: command_body_extra + // End section: command_body_extra +} diff --git a/clients/client-ec2/src/commands/ResetInstanceAttributeCommand.ts b/clients/client-ec2/src/commands/ResetInstanceAttributeCommand.ts index f831f45b99e8e..4e33827b291d3 100644 --- a/clients/client-ec2/src/commands/ResetInstanceAttributeCommand.ts +++ b/clients/client-ec2/src/commands/ResetInstanceAttributeCommand.ts @@ -12,7 +12,7 @@ import { } from "@aws-sdk/types"; import { EC2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../EC2Client"; -import { ResetInstanceAttributeRequest } from "../models/models_5"; +import { ResetInstanceAttributeRequest } from "../models/models_6"; import { deserializeAws_ec2ResetInstanceAttributeCommand, serializeAws_ec2ResetInstanceAttributeCommand, diff --git a/clients/client-ec2/src/commands/ResetNetworkInterfaceAttributeCommand.ts b/clients/client-ec2/src/commands/ResetNetworkInterfaceAttributeCommand.ts index bda919f32fc03..e2c5dbe816637 100644 --- a/clients/client-ec2/src/commands/ResetNetworkInterfaceAttributeCommand.ts +++ b/clients/client-ec2/src/commands/ResetNetworkInterfaceAttributeCommand.ts @@ -12,7 +12,7 @@ import { } from "@aws-sdk/types"; import { EC2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../EC2Client"; -import { ResetNetworkInterfaceAttributeRequest } from "../models/models_5"; +import { ResetNetworkInterfaceAttributeRequest } from "../models/models_6"; import { deserializeAws_ec2ResetNetworkInterfaceAttributeCommand, serializeAws_ec2ResetNetworkInterfaceAttributeCommand, diff --git a/clients/client-ec2/src/commands/ResetSnapshotAttributeCommand.ts b/clients/client-ec2/src/commands/ResetSnapshotAttributeCommand.ts index 4e66c6c327ba6..ffd195d8f98ce 100644 --- a/clients/client-ec2/src/commands/ResetSnapshotAttributeCommand.ts +++ b/clients/client-ec2/src/commands/ResetSnapshotAttributeCommand.ts @@ -12,7 +12,7 @@ import { } from "@aws-sdk/types"; import { EC2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../EC2Client"; -import { ResetSnapshotAttributeRequest } from "../models/models_5"; +import { ResetSnapshotAttributeRequest } from "../models/models_6"; import { deserializeAws_ec2ResetSnapshotAttributeCommand, serializeAws_ec2ResetSnapshotAttributeCommand, diff --git a/clients/client-ec2/src/commands/RestoreImageFromRecycleBinCommand.ts b/clients/client-ec2/src/commands/RestoreImageFromRecycleBinCommand.ts new file mode 100644 index 0000000000000..7d8367b59dc82 --- /dev/null +++ b/clients/client-ec2/src/commands/RestoreImageFromRecycleBinCommand.ts @@ -0,0 +1,98 @@ +import { getSerdePlugin } from "@aws-sdk/middleware-serde"; +import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@aws-sdk/protocol-http"; +import { Command as $Command } from "@aws-sdk/smithy-client"; +import { + FinalizeHandlerArguments, + Handler, + HandlerExecutionContext, + HttpHandlerOptions as __HttpHandlerOptions, + MetadataBearer as __MetadataBearer, + MiddlewareStack, + SerdeContext as __SerdeContext, +} from "@aws-sdk/types"; + +import { EC2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../EC2Client"; +import { RestoreImageFromRecycleBinRequest, RestoreImageFromRecycleBinResult } from "../models/models_6"; +import { + deserializeAws_ec2RestoreImageFromRecycleBinCommand, + serializeAws_ec2RestoreImageFromRecycleBinCommand, +} from "../protocols/Aws_ec2"; + +export interface RestoreImageFromRecycleBinCommandInput extends RestoreImageFromRecycleBinRequest {} +export interface RestoreImageFromRecycleBinCommandOutput extends RestoreImageFromRecycleBinResult, __MetadataBearer {} + +/** + *

      Restores an AMI from the Recycle Bin. For more information, see Recycle Bin in the Amazon Elastic Compute Cloud User Guide.

      + * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, RestoreImageFromRecycleBinCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, RestoreImageFromRecycleBinCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new RestoreImageFromRecycleBinCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RestoreImageFromRecycleBinCommandInput} for command's `input` shape. + * @see {@link RestoreImageFromRecycleBinCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for EC2Client's `config` shape. + * + */ +export class RestoreImageFromRecycleBinCommand extends $Command< + RestoreImageFromRecycleBinCommandInput, + RestoreImageFromRecycleBinCommandOutput, + EC2ClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + constructor(readonly input: RestoreImageFromRecycleBinCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStack, + configuration: EC2ClientResolvedConfig, + options?: __HttpHandlerOptions + ): Handler { + this.middlewareStack.use(getSerdePlugin(configuration, this.serialize, this.deserialize)); + + const stack = clientStack.concat(this.middlewareStack); + + const { logger } = configuration; + const clientName = "EC2Client"; + const commandName = "RestoreImageFromRecycleBinCommand"; + const handlerExecutionContext: HandlerExecutionContext = { + logger, + clientName, + commandName, + inputFilterSensitiveLog: RestoreImageFromRecycleBinRequest.filterSensitiveLog, + outputFilterSensitiveLog: RestoreImageFromRecycleBinResult.filterSensitiveLog, + }; + const { requestHandler } = configuration; + return stack.resolve( + (request: FinalizeHandlerArguments) => + requestHandler.handle(request.request as __HttpRequest, options || {}), + handlerExecutionContext + ); + } + + private serialize(input: RestoreImageFromRecycleBinCommandInput, context: __SerdeContext): Promise<__HttpRequest> { + return serializeAws_ec2RestoreImageFromRecycleBinCommand(input, context); + } + + private deserialize( + output: __HttpResponse, + context: __SerdeContext + ): Promise { + return deserializeAws_ec2RestoreImageFromRecycleBinCommand(output, context); + } + + // Start section: command_body_extra + // End section: command_body_extra +} diff --git a/clients/client-ec2/src/commands/index.ts b/clients/client-ec2/src/commands/index.ts index a14cd4a17593a..f3b96e9fe6048 100644 --- a/clients/client-ec2/src/commands/index.ts +++ b/clients/client-ec2/src/commands/index.ts @@ -398,6 +398,7 @@ export * from "./ImportInstanceCommand"; export * from "./ImportKeyPairCommand"; export * from "./ImportSnapshotCommand"; export * from "./ImportVolumeCommand"; +export * from "./ListImagesInRecycleBinCommand"; export * from "./ListSnapshotsInRecycleBinCommand"; export * from "./ModifyAddressAttributeCommand"; export * from "./ModifyAvailabilityZoneGroupCommand"; @@ -492,6 +493,7 @@ export * from "./ResetInstanceAttributeCommand"; export * from "./ResetNetworkInterfaceAttributeCommand"; export * from "./ResetSnapshotAttributeCommand"; export * from "./RestoreAddressToClassicCommand"; +export * from "./RestoreImageFromRecycleBinCommand"; export * from "./RestoreManagedPrefixListVersionCommand"; export * from "./RestoreSnapshotFromRecycleBinCommand"; export * from "./RestoreSnapshotTierCommand"; diff --git a/clients/client-ec2/src/models/models_0.ts b/clients/client-ec2/src/models/models_0.ts index 452a737bb57c5..4572aade215ab 100644 --- a/clients/client-ec2/src/models/models_0.ts +++ b/clients/client-ec2/src/models/models_0.ts @@ -7585,8 +7585,26 @@ export namespace ClientConnectOptions { }); } +/** + *

      Options for enabling a customizable text banner that will be displayed on + * Amazon Web Services provided clients when a VPN session is established.

      + */ export interface ClientLoginBannerOptions { + /** + *

      Enable or disable a customizable text banner that will be displayed on + * Amazon Web Services provided clients when a VPN session is established.

      + *

      Valid values: true | false + *

      + *

      Default value: false + *

      + */ Enabled?: boolean; + + /** + *

      Customizable text that will be displayed in a banner on Amazon Web Services provided + * clients when a VPN session is established. UTF-8 encoded characters only. Maximum of + * 1400 characters.

      + */ BannerText?: string; } @@ -7742,7 +7760,19 @@ export interface CreateClientVpnEndpointRequest { */ ClientConnectOptions?: ClientConnectOptions; + /** + *

      The maximum VPN session duration time in hours.

      + *

      Valid values: 8 | 10 | 12 | 24 + *

      + *

      Default value: 24 + *

      + */ SessionTimeoutHours?: number; + + /** + *

      Options for enabling a customizable text banner that will be displayed on + * Amazon Web Services provided clients when a VPN session is established.

      + */ ClientLoginBannerOptions?: ClientLoginBannerOptions; } diff --git a/clients/client-ec2/src/models/models_2.ts b/clients/client-ec2/src/models/models_2.ts index 997b9a0c21ea4..83379e2a05ebf 100644 --- a/clients/client-ec2/src/models/models_2.ts +++ b/clients/client-ec2/src/models/models_2.ts @@ -7907,8 +7907,23 @@ export namespace ClientConnectResponseOptions { }); } +/** + *

      Current state of options for customizable text banner that will be displayed on + * Amazon Web Services provided clients when a VPN session is established.

      + */ export interface ClientLoginBannerResponseOptions { + /** + *

      Current state of text banner feature.

      + *

      Valid values: true | false + *

      + */ Enabled?: boolean; + + /** + *

      Customizable text that will be displayed in a banner on Amazon Web Services provided + * clients when a VPN session is established. UTF-8 encoded + * characters only. Maximum of 1400 characters.

      + */ BannerText?: string; } @@ -8065,7 +8080,19 @@ export interface ClientVpnEndpoint { */ ClientConnectOptions?: ClientConnectResponseOptions; + /** + *

      The maximum VPN session duration time in hours.

      + *

      Valid values: 8 | 10 | 12 | 24 + *

      + *

      Default value: 24 + *

      + */ SessionTimeoutHours?: number; + + /** + *

      Options for enabling a customizable text banner that will be displayed on Amazon Web Services provided clients when a VPN session is + * established.

      + */ ClientLoginBannerOptions?: ClientLoginBannerResponseOptions; } diff --git a/clients/client-ec2/src/models/models_4.ts b/clients/client-ec2/src/models/models_4.ts index b4f9a7d761a15..5a3fdab8b7f6b 100644 --- a/clients/client-ec2/src/models/models_4.ts +++ b/clients/client-ec2/src/models/models_4.ts @@ -9450,7 +9450,7 @@ export interface EnableFastLaunchRequest { LaunchTemplate?: FastLaunchLaunchTemplateSpecificationRequest; /** - *

      The maximum number of parallel instances to launch for creating resources.

      + *

      The maximum number of parallel instances to launch for creating resources. Value must be 6 or greater.

      */ MaxParallelLaunches?: number; diff --git a/clients/client-ec2/src/models/models_5.ts b/clients/client-ec2/src/models/models_5.ts index 6c8c3d1bd7981..abf12d497c46a 100644 --- a/clients/client-ec2/src/models/models_5.ts +++ b/clients/client-ec2/src/models/models_5.ts @@ -3073,6 +3073,105 @@ export namespace ImportVolumeResult { }); } +export interface ListImagesInRecycleBinRequest { + /** + *

      The IDs of the AMIs to list. Omit this parameter to list all of the AMIs that + * are in the Recycle Bin. You can specify up to 20 IDs in a single request.

      + */ + ImageIds?: string[]; + + /** + *

      The token for the next page of results.

      + */ + NextToken?: string; + + /** + *

      The maximum number of results to return with a single call. + * To retrieve the remaining results, make another call with the returned nextToken value.

      + *

      If you do not specify a value for MaxResults, the request + * returns 1,000 items per page by default. For more information, see + * + * Pagination.

      + */ + MaxResults?: number; + + /** + *

      Checks whether you have the required permissions for the action, without actually making the request, + * and provides an error response. If you have the required permissions, the error response is + * DryRunOperation. Otherwise, it is UnauthorizedOperation.

      + */ + DryRun?: boolean; +} + +export namespace ListImagesInRecycleBinRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: ListImagesInRecycleBinRequest): any => ({ + ...obj, + }); +} + +/** + *

      Information about an AMI that is currently in the Recycle Bin.

      + */ +export interface ImageRecycleBinInfo { + /** + *

      The ID of the AMI.

      + */ + ImageId?: string; + + /** + *

      The name of the AMI.

      + */ + Name?: string; + + /** + *

      The description of the AMI.

      + */ + Description?: string; + + /** + *

      The date and time when the AMI entered the Recycle Bin.

      + */ + RecycleBinEnterTime?: Date; + + /** + *

      The date and time when the AMI is to be permanently deleted from the Recycle Bin.

      + */ + RecycleBinExitTime?: Date; +} + +export namespace ImageRecycleBinInfo { + /** + * @internal + */ + export const filterSensitiveLog = (obj: ImageRecycleBinInfo): any => ({ + ...obj, + }); +} + +export interface ListImagesInRecycleBinResult { + /** + *

      Information about the AMIs.

      + */ + Images?: ImageRecycleBinInfo[]; + + /** + *

      The token to use to retrieve the next page of results. This value is null when there are no more results to return.

      + */ + NextToken?: string; +} + +export namespace ListImagesInRecycleBinResult { + /** + * @internal + */ + export const filterSensitiveLog = (obj: ListImagesInRecycleBinResult): any => ({ + ...obj, + }); +} + export interface ListSnapshotsInRecycleBinRequest { /** *

      The maximum number of results to return with a single call. @@ -3524,7 +3623,19 @@ export interface ModifyClientVpnEndpointRequest { */ ClientConnectOptions?: ClientConnectOptions; + /** + *

      The maximum VPN session duration time in hours.

      + *

      Valid values: 8 | 10 | 12 | 24 + *

      + *

      Default value: 24 + *

      + */ SessionTimeoutHours?: number; + + /** + *

      Options for enabling a customizable text banner that will be displayed on + * Amazon Web Services provided clients when a VPN session is established.

      + */ ClientLoginBannerOptions?: ClientLoginBannerOptions; } @@ -9656,96 +9767,3 @@ export namespace ResetImageAttributeRequest { ...obj, }); } - -export interface ResetInstanceAttributeRequest { - /** - *

      The attribute to reset.

      - * - *

      You can only reset the following attributes: kernel | - * ramdisk | sourceDestCheck. To change an instance - * attribute, use ModifyInstanceAttribute.

      - *       - */ - Attribute: InstanceAttributeName | string | undefined; - - /** - *

      Checks whether you have the required permissions for the action, without actually making the request, - * and provides an error response. If you have the required permissions, the error response is DryRunOperation. - * Otherwise, it is UnauthorizedOperation.

      - */ - DryRun?: boolean; - - /** - *

      The ID of the instance.

      - */ - InstanceId: string | undefined; -} - -export namespace ResetInstanceAttributeRequest { - /** - * @internal - */ - export const filterSensitiveLog = (obj: ResetInstanceAttributeRequest): any => ({ - ...obj, - }); -} - -/** - *

      Contains the parameters for ResetNetworkInterfaceAttribute.

      - */ -export interface ResetNetworkInterfaceAttributeRequest { - /** - *

      Checks whether you have the required permissions for the action, without actually making the request, - * and provides an error response. If you have the required permissions, the error response is DryRunOperation. - * Otherwise, it is UnauthorizedOperation.

      - */ - DryRun?: boolean; - - /** - *

      The ID of the network interface.

      - */ - NetworkInterfaceId: string | undefined; - - /** - *

      The source/destination checking attribute. Resets the value to true.

      - */ - SourceDestCheck?: string; -} - -export namespace ResetNetworkInterfaceAttributeRequest { - /** - * @internal - */ - export const filterSensitiveLog = (obj: ResetNetworkInterfaceAttributeRequest): any => ({ - ...obj, - }); -} - -export interface ResetSnapshotAttributeRequest { - /** - *

      The attribute to reset. Currently, only the attribute for permission to create volumes can - * be reset.

      - */ - Attribute: SnapshotAttributeName | string | undefined; - - /** - *

      The ID of the snapshot.

      - */ - SnapshotId: string | undefined; - - /** - *

      Checks whether you have the required permissions for the action, without actually making the request, - * and provides an error response. If you have the required permissions, the error response is DryRunOperation. - * Otherwise, it is UnauthorizedOperation.

      - */ - DryRun?: boolean; -} - -export namespace ResetSnapshotAttributeRequest { - /** - * @internal - */ - export const filterSensitiveLog = (obj: ResetSnapshotAttributeRequest): any => ({ - ...obj, - }); -} diff --git a/clients/client-ec2/src/models/models_6.ts b/clients/client-ec2/src/models/models_6.ts index 4f239c5f091a0..5216a9ae2d131 100644 --- a/clients/client-ec2/src/models/models_6.ts +++ b/clients/client-ec2/src/models/models_6.ts @@ -25,6 +25,7 @@ import { import { ClientVpnConnectionStatus, Filter, TransitGatewayRoute } from "./models_2"; import { HttpTokensState, + InstanceAttributeName, InstanceMetadataEndpointState, InstanceMetadataProtocolState, InstanceMetadataTagsState, @@ -32,9 +33,106 @@ import { NetworkInsightsAccessScopeAnalysis, NetworkInsightsAnalysis, } from "./models_3"; -import { InstanceNetworkInterfaceSpecification, RunInstancesMonitoringEnabled } from "./models_4"; +import { + InstanceNetworkInterfaceSpecification, + RunInstancesMonitoringEnabled, + SnapshotAttributeName, +} from "./models_4"; import { CapacityReservationSpecification, InstanceMonitoring, Status } from "./models_5"; +export interface ResetInstanceAttributeRequest { + /** + *

      The attribute to reset.

      + * + *

      You can only reset the following attributes: kernel | + * ramdisk | sourceDestCheck. To change an instance + * attribute, use ModifyInstanceAttribute.

      + *       + */ + Attribute: InstanceAttributeName | string | undefined; + + /** + *

      Checks whether you have the required permissions for the action, without actually making the request, + * and provides an error response. If you have the required permissions, the error response is DryRunOperation. + * Otherwise, it is UnauthorizedOperation.

      + */ + DryRun?: boolean; + + /** + *

      The ID of the instance.

      + */ + InstanceId: string | undefined; +} + +export namespace ResetInstanceAttributeRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: ResetInstanceAttributeRequest): any => ({ + ...obj, + }); +} + +/** + *

      Contains the parameters for ResetNetworkInterfaceAttribute.

      + */ +export interface ResetNetworkInterfaceAttributeRequest { + /** + *

      Checks whether you have the required permissions for the action, without actually making the request, + * and provides an error response. If you have the required permissions, the error response is DryRunOperation. + * Otherwise, it is UnauthorizedOperation.

      + */ + DryRun?: boolean; + + /** + *

      The ID of the network interface.

      + */ + NetworkInterfaceId: string | undefined; + + /** + *

      The source/destination checking attribute. Resets the value to true.

      + */ + SourceDestCheck?: string; +} + +export namespace ResetNetworkInterfaceAttributeRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: ResetNetworkInterfaceAttributeRequest): any => ({ + ...obj, + }); +} + +export interface ResetSnapshotAttributeRequest { + /** + *

      The attribute to reset. Currently, only the attribute for permission to create volumes can + * be reset.

      + */ + Attribute: SnapshotAttributeName | string | undefined; + + /** + *

      The ID of the snapshot.

      + */ + SnapshotId: string | undefined; + + /** + *

      Checks whether you have the required permissions for the action, without actually making the request, + * and provides an error response. If you have the required permissions, the error response is DryRunOperation. + * Otherwise, it is UnauthorizedOperation.

      + */ + DryRun?: boolean; +} + +export namespace ResetSnapshotAttributeRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: ResetSnapshotAttributeRequest): any => ({ + ...obj, + }); +} + export interface RestoreAddressToClassicRequest { /** *

      Checks whether you have the required permissions for the action, without actually making the request, @@ -79,6 +177,45 @@ export namespace RestoreAddressToClassicResult { }); } +export interface RestoreImageFromRecycleBinRequest { + /** + *

      The ID of the AMI to restore.

      + */ + ImageId: string | undefined; + + /** + *

      Checks whether you have the required permissions for the action, without actually making the request, + * and provides an error response. If you have the required permissions, the error response is + * DryRunOperation. Otherwise, it is UnauthorizedOperation.

      + */ + DryRun?: boolean; +} + +export namespace RestoreImageFromRecycleBinRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: RestoreImageFromRecycleBinRequest): any => ({ + ...obj, + }); +} + +export interface RestoreImageFromRecycleBinResult { + /** + *

      Returns true if the request succeeds; otherwise, it returns an error.

      + */ + Return?: boolean; +} + +export namespace RestoreImageFromRecycleBinResult { + /** + * @internal + */ + export const filterSensitiveLog = (obj: RestoreImageFromRecycleBinResult): any => ({ + ...obj, + }); +} + export interface RestoreManagedPrefixListVersionRequest { /** *

      Checks whether you have the required permissions for the action, without actually making the request, diff --git a/clients/client-ec2/src/pagination/ListImagesInRecycleBinPaginator.ts b/clients/client-ec2/src/pagination/ListImagesInRecycleBinPaginator.ts new file mode 100644 index 0000000000000..3f2cb556ad7c4 --- /dev/null +++ b/clients/client-ec2/src/pagination/ListImagesInRecycleBinPaginator.ts @@ -0,0 +1,59 @@ +import { Paginator } from "@aws-sdk/types"; + +import { + ListImagesInRecycleBinCommand, + ListImagesInRecycleBinCommandInput, + ListImagesInRecycleBinCommandOutput, +} from "../commands/ListImagesInRecycleBinCommand"; +import { EC2 } from "../EC2"; +import { EC2Client } from "../EC2Client"; +import { EC2PaginationConfiguration } from "./Interfaces"; + +/** + * @private + */ +const makePagedClientRequest = async ( + client: EC2Client, + input: ListImagesInRecycleBinCommandInput, + ...args: any +): Promise => { + // @ts-ignore + return await client.send(new ListImagesInRecycleBinCommand(input), ...args); +}; +/** + * @private + */ +const makePagedRequest = async ( + client: EC2, + input: ListImagesInRecycleBinCommandInput, + ...args: any +): Promise => { + // @ts-ignore + return await client.listImagesInRecycleBin(input, ...args); +}; +export async function* paginateListImagesInRecycleBin( + config: EC2PaginationConfiguration, + input: ListImagesInRecycleBinCommandInput, + ...additionalArguments: any +): Paginator { + // ToDo: replace with actual type instead of typeof input.NextToken + let token: typeof input.NextToken | undefined = config.startingToken || undefined; + let hasNext = true; + let page: ListImagesInRecycleBinCommandOutput; + while (hasNext) { + input.NextToken = token; + input["MaxResults"] = config.pageSize; + if (config.client instanceof EC2) { + page = await makePagedRequest(config.client, input, ...additionalArguments); + } else if (config.client instanceof EC2Client) { + page = await makePagedClientRequest(config.client, input, ...additionalArguments); + } else { + throw new Error("Invalid client, expected EC2 | EC2Client"); + } + yield page; + token = page.NextToken; + hasNext = !!token; + } + // @ts-ignore + return undefined; +} diff --git a/clients/client-ec2/src/pagination/index.ts b/clients/client-ec2/src/pagination/index.ts index a5a0d59668781..14ec32e04379b 100644 --- a/clients/client-ec2/src/pagination/index.ts +++ b/clients/client-ec2/src/pagination/index.ts @@ -113,6 +113,7 @@ export * from "./GetTransitGatewayPrefixListReferencesPaginator"; export * from "./GetTransitGatewayRouteTableAssociationsPaginator"; export * from "./GetTransitGatewayRouteTablePropagationsPaginator"; export * from "./GetVpnConnectionDeviceTypesPaginator"; +export * from "./ListImagesInRecycleBinPaginator"; export * from "./ListSnapshotsInRecycleBinPaginator"; export * from "./SearchLocalGatewayRoutesPaginator"; export * from "./SearchTransitGatewayMulticastGroupsPaginator"; diff --git a/clients/client-ec2/src/protocols/Aws_ec2.ts b/clients/client-ec2/src/protocols/Aws_ec2.ts index 7e2502af99cda..3bdba54be147b 100644 --- a/clients/client-ec2/src/protocols/Aws_ec2.ts +++ b/clients/client-ec2/src/protocols/Aws_ec2.ts @@ -1351,6 +1351,10 @@ import { ImportInstanceCommandInput, ImportInstanceCommandOutput } from "../comm import { ImportKeyPairCommandInput, ImportKeyPairCommandOutput } from "../commands/ImportKeyPairCommand"; import { ImportSnapshotCommandInput, ImportSnapshotCommandOutput } from "../commands/ImportSnapshotCommand"; import { ImportVolumeCommandInput, ImportVolumeCommandOutput } from "../commands/ImportVolumeCommand"; +import { + ListImagesInRecycleBinCommandInput, + ListImagesInRecycleBinCommandOutput, +} from "../commands/ListImagesInRecycleBinCommand"; import { ListSnapshotsInRecycleBinCommandInput, ListSnapshotsInRecycleBinCommandOutput, @@ -1667,6 +1671,10 @@ import { RestoreAddressToClassicCommandInput, RestoreAddressToClassicCommandOutput, } from "../commands/RestoreAddressToClassicCommand"; +import { + RestoreImageFromRecycleBinCommandInput, + RestoreImageFromRecycleBinCommandOutput, +} from "../commands/RestoreImageFromRecycleBinCommand"; import { RestoreManagedPrefixListVersionCommandInput, RestoreManagedPrefixListVersionCommandOutput, @@ -3078,6 +3086,7 @@ import { GetVpnConnectionDeviceTypesRequest, GetVpnConnectionDeviceTypesResult, ImageDiskContainer, + ImageRecycleBinInfo, ImportClientVpnClientCertificateRevocationListRequest, ImportClientVpnClientCertificateRevocationListResult, ImportImageLicenseConfigurationRequest, @@ -3101,6 +3110,8 @@ import { IpamCidrAuthorizationContext, IpamResourceCidr, LaunchPermissionModifications, + ListImagesInRecycleBinRequest, + ListImagesInRecycleBinResult, ListSnapshotsInRecycleBinRequest, ListSnapshotsInRecycleBinResult, LoadPermissionModifications, @@ -3285,9 +3296,6 @@ import { ResetFpgaImageAttributeRequest, ResetFpgaImageAttributeResult, ResetImageAttributeRequest, - ResetInstanceAttributeRequest, - ResetNetworkInterfaceAttributeRequest, - ResetSnapshotAttributeRequest, SecurityGroupRuleRequest, SecurityGroupRuleUpdate, SnapshotDiskContainer, @@ -3322,8 +3330,13 @@ import { LaunchTemplateSpecification, LicenseConfigurationRequest, PrivateDnsNameOptionsRequest, + ResetInstanceAttributeRequest, + ResetNetworkInterfaceAttributeRequest, + ResetSnapshotAttributeRequest, RestoreAddressToClassicRequest, RestoreAddressToClassicResult, + RestoreImageFromRecycleBinRequest, + RestoreImageFromRecycleBinResult, RestoreManagedPrefixListVersionRequest, RestoreManagedPrefixListVersionResult, RestoreSnapshotFromRecycleBinRequest, @@ -9786,6 +9799,22 @@ export const serializeAws_ec2ImportVolumeCommand = async ( return buildHttpRpcRequest(context, headers, "/", undefined, body); }; +export const serializeAws_ec2ListImagesInRecycleBinCommand = async ( + input: ListImagesInRecycleBinCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const headers: __HeaderBag = { + "content-type": "application/x-www-form-urlencoded", + }; + let body: any; + body = buildFormUrlencodedString({ + ...serializeAws_ec2ListImagesInRecycleBinRequest(input, context), + Action: "ListImagesInRecycleBin", + Version: "2016-11-15", + }); + return buildHttpRpcRequest(context, headers, "/", undefined, body); +}; + export const serializeAws_ec2ListSnapshotsInRecycleBinCommand = async ( input: ListSnapshotsInRecycleBinCommandInput, context: __SerdeContext @@ -11290,6 +11319,22 @@ export const serializeAws_ec2RestoreAddressToClassicCommand = async ( return buildHttpRpcRequest(context, headers, "/", undefined, body); }; +export const serializeAws_ec2RestoreImageFromRecycleBinCommand = async ( + input: RestoreImageFromRecycleBinCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const headers: __HeaderBag = { + "content-type": "application/x-www-form-urlencoded", + }; + let body: any; + body = buildFormUrlencodedString({ + ...serializeAws_ec2RestoreImageFromRecycleBinRequest(input, context), + Action: "RestoreImageFromRecycleBin", + Version: "2016-11-15", + }); + return buildHttpRpcRequest(context, headers, "/", undefined, body); +}; + export const serializeAws_ec2RestoreManagedPrefixListVersionCommand = async ( input: RestoreManagedPrefixListVersionCommandInput, context: __SerdeContext @@ -29985,6 +30030,52 @@ const deserializeAws_ec2ImportVolumeCommandError = async ( return Promise.reject(Object.assign(new Error(message), response)); }; +export const deserializeAws_ec2ListImagesInRecycleBinCommand = async ( + output: __HttpResponse, + context: __SerdeContext +): Promise => { + if (output.statusCode >= 300) { + return deserializeAws_ec2ListImagesInRecycleBinCommandError(output, context); + } + const data: any = await parseBody(output.body, context); + let contents: any = {}; + contents = deserializeAws_ec2ListImagesInRecycleBinResult(data, context); + const response: ListImagesInRecycleBinCommandOutput = { + $metadata: deserializeMetadata(output), + ...contents, + }; + return Promise.resolve(response); +}; + +const deserializeAws_ec2ListImagesInRecycleBinCommandError = async ( + output: __HttpResponse, + context: __SerdeContext +): Promise => { + const parsedOutput: any = { + ...output, + body: await parseBody(output.body, context), + }; + let response: __SmithyException & __MetadataBearer & { [key: string]: any }; + let errorCode = "UnknownError"; + errorCode = loadEc2ErrorCode(output, parsedOutput.body); + switch (errorCode) { + default: + const parsedBody = parsedOutput.body; + errorCode = parsedBody.Errors.Error.code || parsedBody.Errors.Error.Code || errorCode; + response = { + ...parsedBody.Errors.Error, + name: `${errorCode}`, + message: parsedBody.Errors.Error.message || parsedBody.Errors.Error.Message || errorCode, + $fault: "client", + $metadata: deserializeMetadata(output), + } as any; + } + const message = response.message || response.Message || errorCode; + response.message = message; + delete response.Message; + return Promise.reject(Object.assign(new Error(message), response)); +}; + export const deserializeAws_ec2ListSnapshotsInRecycleBinCommand = async ( output: __HttpResponse, context: __SerdeContext @@ -34255,6 +34346,52 @@ const deserializeAws_ec2RestoreAddressToClassicCommandError = async ( return Promise.reject(Object.assign(new Error(message), response)); }; +export const deserializeAws_ec2RestoreImageFromRecycleBinCommand = async ( + output: __HttpResponse, + context: __SerdeContext +): Promise => { + if (output.statusCode >= 300) { + return deserializeAws_ec2RestoreImageFromRecycleBinCommandError(output, context); + } + const data: any = await parseBody(output.body, context); + let contents: any = {}; + contents = deserializeAws_ec2RestoreImageFromRecycleBinResult(data, context); + const response: RestoreImageFromRecycleBinCommandOutput = { + $metadata: deserializeMetadata(output), + ...contents, + }; + return Promise.resolve(response); +}; + +const deserializeAws_ec2RestoreImageFromRecycleBinCommandError = async ( + output: __HttpResponse, + context: __SerdeContext +): Promise => { + const parsedOutput: any = { + ...output, + body: await parseBody(output.body, context), + }; + let response: __SmithyException & __MetadataBearer & { [key: string]: any }; + let errorCode = "UnknownError"; + errorCode = loadEc2ErrorCode(output, parsedOutput.body); + switch (errorCode) { + default: + const parsedBody = parsedOutput.body; + errorCode = parsedBody.Errors.Error.code || parsedBody.Errors.Error.Code || errorCode; + response = { + ...parsedBody.Errors.Error, + name: `${errorCode}`, + message: parsedBody.Errors.Error.message || parsedBody.Errors.Error.Message || errorCode, + $fault: "client", + $metadata: deserializeMetadata(output), + } as any; + } + const message = response.message || response.Message || errorCode; + response.message = message; + delete response.Message; + return Promise.reject(Object.assign(new Error(message), response)); +}; + export const deserializeAws_ec2RestoreManagedPrefixListVersionCommand = async ( output: __HttpResponse, context: __SerdeContext @@ -49022,6 +49159,30 @@ const serializeAws_ec2LicenseSpecificationListRequest = ( return entries; }; +const serializeAws_ec2ListImagesInRecycleBinRequest = ( + input: ListImagesInRecycleBinRequest, + context: __SerdeContext +): any => { + const entries: any = {}; + if (input.ImageIds !== undefined && input.ImageIds !== null) { + const memberEntries = serializeAws_ec2ImageIdStringList(input.ImageIds, context); + Object.entries(memberEntries).forEach(([key, value]) => { + const loc = `ImageId.${key.substring(key.indexOf(".") + 1)}`; + entries[loc] = value; + }); + } + if (input.NextToken !== undefined && input.NextToken !== null) { + entries["NextToken"] = input.NextToken; + } + if (input.MaxResults !== undefined && input.MaxResults !== null) { + entries["MaxResults"] = input.MaxResults; + } + if (input.DryRun !== undefined && input.DryRun !== null) { + entries["DryRun"] = input.DryRun; + } + return entries; +}; + const serializeAws_ec2ListSnapshotsInRecycleBinRequest = ( input: ListSnapshotsInRecycleBinRequest, context: __SerdeContext @@ -53574,6 +53735,20 @@ const serializeAws_ec2RestoreAddressToClassicRequest = ( return entries; }; +const serializeAws_ec2RestoreImageFromRecycleBinRequest = ( + input: RestoreImageFromRecycleBinRequest, + context: __SerdeContext +): any => { + const entries: any = {}; + if (input.ImageId !== undefined && input.ImageId !== null) { + entries["ImageId"] = input.ImageId; + } + if (input.DryRun !== undefined && input.DryRun !== null) { + entries["DryRun"] = input.DryRun; + } + return entries; +}; + const serializeAws_ec2RestoreManagedPrefixListVersionRequest = ( input: RestoreManagedPrefixListVersionRequest, context: __SerdeContext @@ -68889,6 +69064,43 @@ const deserializeAws_ec2ImageList = (output: any, context: __SerdeContext): Imag }); }; +const deserializeAws_ec2ImageRecycleBinInfo = (output: any, context: __SerdeContext): ImageRecycleBinInfo => { + const contents: any = { + ImageId: undefined, + Name: undefined, + Description: undefined, + RecycleBinEnterTime: undefined, + RecycleBinExitTime: undefined, + }; + if (output["imageId"] !== undefined) { + contents.ImageId = __expectString(output["imageId"]); + } + if (output["name"] !== undefined) { + contents.Name = __expectString(output["name"]); + } + if (output["description"] !== undefined) { + contents.Description = __expectString(output["description"]); + } + if (output["recycleBinEnterTime"] !== undefined) { + contents.RecycleBinEnterTime = __expectNonNull(__parseRfc3339DateTime(output["recycleBinEnterTime"])); + } + if (output["recycleBinExitTime"] !== undefined) { + contents.RecycleBinExitTime = __expectNonNull(__parseRfc3339DateTime(output["recycleBinExitTime"])); + } + return contents; +}; + +const deserializeAws_ec2ImageRecycleBinInfoList = (output: any, context: __SerdeContext): ImageRecycleBinInfo[] => { + return (output || []) + .filter((e: any) => e != null) + .map((entry: any) => { + if (entry === null) { + return null as any; + } + return deserializeAws_ec2ImageRecycleBinInfo(entry, context); + }); +}; + const deserializeAws_ec2ImportClientVpnClientCertificateRevocationListResult = ( output: any, context: __SerdeContext @@ -73133,6 +73345,29 @@ const deserializeAws_ec2LicenseList = (output: any, context: __SerdeContext): Li }); }; +const deserializeAws_ec2ListImagesInRecycleBinResult = ( + output: any, + context: __SerdeContext +): ListImagesInRecycleBinResult => { + const contents: any = { + Images: undefined, + NextToken: undefined, + }; + if (output.imageSet === "") { + contents.Images = []; + } + if (output["imageSet"] !== undefined && output["imageSet"]["item"] !== undefined) { + contents.Images = deserializeAws_ec2ImageRecycleBinInfoList( + __getArrayIfSingleItem(output["imageSet"]["item"]), + context + ); + } + if (output["nextToken"] !== undefined) { + contents.NextToken = __expectString(output["nextToken"]); + } + return contents; +}; + const deserializeAws_ec2ListSnapshotsInRecycleBinResult = ( output: any, context: __SerdeContext @@ -77957,6 +78192,19 @@ const deserializeAws_ec2RestoreAddressToClassicResult = ( return contents; }; +const deserializeAws_ec2RestoreImageFromRecycleBinResult = ( + output: any, + context: __SerdeContext +): RestoreImageFromRecycleBinResult => { + const contents: any = { + Return: undefined, + }; + if (output["return"] !== undefined) { + contents.Return = __parseBoolean(output["return"]); + } + return contents; +}; + const deserializeAws_ec2RestoreManagedPrefixListVersionResult = ( output: any, context: __SerdeContext diff --git a/clients/client-elasticache/src/models/models_0.ts b/clients/client-elasticache/src/models/models_0.ts index 6adeeb124e81b..c8e68f92342d3 100644 --- a/clients/client-elasticache/src/models/models_0.ts +++ b/clients/client-elasticache/src/models/models_0.ts @@ -2415,7 +2415,7 @@ export interface CreateCacheClusterMessage { * on the cluster is performed. It is specified as a range in * the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum * maintenance window is a 60 minute period. - * Valid values for ddd are:

      + *

      */ PreferredMaintenanceWindow?: string; @@ -3588,8 +3588,7 @@ export interface CreateCacheParameterGroupMessage { * redis3.2 | * redis4.0 | * redis5.0 | - * redis6.0 | - * redis6.2 + * redis6.x *

      */ CacheParameterGroupFamily: string | undefined; @@ -3634,7 +3633,7 @@ export interface CacheParameterGroup { * redis3.2 | * redis4.0 | * redis5.0 | - * redis6.0 | + * redis6.x | *

      */ CacheParameterGroupFamily?: string; diff --git a/clients/client-elasticsearch-service/src/ElasticsearchService.ts b/clients/client-elasticsearch-service/src/ElasticsearchService.ts index 5afdebbad404b..38a340529d806 100644 --- a/clients/client-elasticsearch-service/src/ElasticsearchService.ts +++ b/clients/client-elasticsearch-service/src/ElasticsearchService.ts @@ -61,6 +61,11 @@ import { DescribeDomainAutoTunesCommandInput, DescribeDomainAutoTunesCommandOutput, } from "./commands/DescribeDomainAutoTunesCommand"; +import { + DescribeDomainChangeProgressCommand, + DescribeDomainChangeProgressCommandInput, + DescribeDomainChangeProgressCommandOutput, +} from "./commands/DescribeDomainChangeProgressCommand"; import { DescribeElasticsearchDomainCommand, DescribeElasticsearchDomainCommandInput, @@ -622,6 +627,39 @@ export class ElasticsearchService extends ElasticsearchServiceClient { } } + /** + *

      Returns information about the current blue/green deployment happening on a domain, including + * a change ID, status, and progress stages.

      + */ + public describeDomainChangeProgress( + args: DescribeDomainChangeProgressCommandInput, + options?: __HttpHandlerOptions + ): Promise; + public describeDomainChangeProgress( + args: DescribeDomainChangeProgressCommandInput, + cb: (err: any, data?: DescribeDomainChangeProgressCommandOutput) => void + ): void; + public describeDomainChangeProgress( + args: DescribeDomainChangeProgressCommandInput, + options: __HttpHandlerOptions, + cb: (err: any, data?: DescribeDomainChangeProgressCommandOutput) => void + ): void; + public describeDomainChangeProgress( + args: DescribeDomainChangeProgressCommandInput, + optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: DescribeDomainChangeProgressCommandOutput) => void), + cb?: (err: any, data?: DescribeDomainChangeProgressCommandOutput) => void + ): Promise | void { + const command = new DescribeDomainChangeProgressCommand(args); + if (typeof optionsOrCb === "function") { + this.send(command, optionsOrCb); + } else if (typeof cb === "function") { + if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); + this.send(command, optionsOrCb || {}, cb); + } else { + return this.send(command, optionsOrCb); + } + } + /** *

      Returns domain configuration information about the specified Elasticsearch domain, including the domain ID, domain endpoint, and domain ARN.

      */ diff --git a/clients/client-elasticsearch-service/src/ElasticsearchServiceClient.ts b/clients/client-elasticsearch-service/src/ElasticsearchServiceClient.ts index 8bd20d364a4a8..19e5f9cac75f4 100644 --- a/clients/client-elasticsearch-service/src/ElasticsearchServiceClient.ts +++ b/clients/client-elasticsearch-service/src/ElasticsearchServiceClient.ts @@ -90,6 +90,10 @@ import { DescribeDomainAutoTunesCommandInput, DescribeDomainAutoTunesCommandOutput, } from "./commands/DescribeDomainAutoTunesCommand"; +import { + DescribeDomainChangeProgressCommandInput, + DescribeDomainChangeProgressCommandOutput, +} from "./commands/DescribeDomainChangeProgressCommand"; import { DescribeElasticsearchDomainCommandInput, DescribeElasticsearchDomainCommandOutput, @@ -190,6 +194,7 @@ export type ServiceInputTypes = | DeleteOutboundCrossClusterSearchConnectionCommandInput | DeletePackageCommandInput | DescribeDomainAutoTunesCommandInput + | DescribeDomainChangeProgressCommandInput | DescribeElasticsearchDomainCommandInput | DescribeElasticsearchDomainConfigCommandInput | DescribeElasticsearchDomainsCommandInput @@ -232,6 +237,7 @@ export type ServiceOutputTypes = | DeleteOutboundCrossClusterSearchConnectionCommandOutput | DeletePackageCommandOutput | DescribeDomainAutoTunesCommandOutput + | DescribeDomainChangeProgressCommandOutput | DescribeElasticsearchDomainCommandOutput | DescribeElasticsearchDomainConfigCommandOutput | DescribeElasticsearchDomainsCommandOutput diff --git a/clients/client-elasticsearch-service/src/commands/DescribeDomainChangeProgressCommand.ts b/clients/client-elasticsearch-service/src/commands/DescribeDomainChangeProgressCommand.ts new file mode 100644 index 0000000000000..4bb75e9b76fd2 --- /dev/null +++ b/clients/client-elasticsearch-service/src/commands/DescribeDomainChangeProgressCommand.ts @@ -0,0 +1,105 @@ +import { getSerdePlugin } from "@aws-sdk/middleware-serde"; +import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@aws-sdk/protocol-http"; +import { Command as $Command } from "@aws-sdk/smithy-client"; +import { + FinalizeHandlerArguments, + Handler, + HandlerExecutionContext, + HttpHandlerOptions as __HttpHandlerOptions, + MetadataBearer as __MetadataBearer, + MiddlewareStack, + SerdeContext as __SerdeContext, +} from "@aws-sdk/types"; + +import { + ElasticsearchServiceClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes, +} from "../ElasticsearchServiceClient"; +import { DescribeDomainChangeProgressRequest, DescribeDomainChangeProgressResponse } from "../models/models_0"; +import { + deserializeAws_restJson1DescribeDomainChangeProgressCommand, + serializeAws_restJson1DescribeDomainChangeProgressCommand, +} from "../protocols/Aws_restJson1"; + +export interface DescribeDomainChangeProgressCommandInput extends DescribeDomainChangeProgressRequest {} +export interface DescribeDomainChangeProgressCommandOutput + extends DescribeDomainChangeProgressResponse, + __MetadataBearer {} + +/** + *

      Returns information about the current blue/green deployment happening on a domain, including + * a change ID, status, and progress stages.

      + * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticsearchServiceClient, DescribeDomainChangeProgressCommand } from "@aws-sdk/client-elasticsearch-service"; // ES Modules import + * // const { ElasticsearchServiceClient, DescribeDomainChangeProgressCommand } = require("@aws-sdk/client-elasticsearch-service"); // CommonJS import + * const client = new ElasticsearchServiceClient(config); + * const command = new DescribeDomainChangeProgressCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeDomainChangeProgressCommandInput} for command's `input` shape. + * @see {@link DescribeDomainChangeProgressCommandOutput} for command's `response` shape. + * @see {@link ElasticsearchServiceClientResolvedConfig | config} for ElasticsearchServiceClient's `config` shape. + * + */ +export class DescribeDomainChangeProgressCommand extends $Command< + DescribeDomainChangeProgressCommandInput, + DescribeDomainChangeProgressCommandOutput, + ElasticsearchServiceClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + constructor(readonly input: DescribeDomainChangeProgressCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStack, + configuration: ElasticsearchServiceClientResolvedConfig, + options?: __HttpHandlerOptions + ): Handler { + this.middlewareStack.use(getSerdePlugin(configuration, this.serialize, this.deserialize)); + + const stack = clientStack.concat(this.middlewareStack); + + const { logger } = configuration; + const clientName = "ElasticsearchServiceClient"; + const commandName = "DescribeDomainChangeProgressCommand"; + const handlerExecutionContext: HandlerExecutionContext = { + logger, + clientName, + commandName, + inputFilterSensitiveLog: DescribeDomainChangeProgressRequest.filterSensitiveLog, + outputFilterSensitiveLog: DescribeDomainChangeProgressResponse.filterSensitiveLog, + }; + const { requestHandler } = configuration; + return stack.resolve( + (request: FinalizeHandlerArguments) => + requestHandler.handle(request.request as __HttpRequest, options || {}), + handlerExecutionContext + ); + } + + private serialize(input: DescribeDomainChangeProgressCommandInput, context: __SerdeContext): Promise<__HttpRequest> { + return serializeAws_restJson1DescribeDomainChangeProgressCommand(input, context); + } + + private deserialize( + output: __HttpResponse, + context: __SerdeContext + ): Promise { + return deserializeAws_restJson1DescribeDomainChangeProgressCommand(output, context); + } + + // Start section: command_body_extra + // End section: command_body_extra +} diff --git a/clients/client-elasticsearch-service/src/commands/index.ts b/clients/client-elasticsearch-service/src/commands/index.ts index dc5a11c21f0c9..7399f4f9b6a15 100644 --- a/clients/client-elasticsearch-service/src/commands/index.ts +++ b/clients/client-elasticsearch-service/src/commands/index.ts @@ -11,6 +11,7 @@ export * from "./DeleteInboundCrossClusterSearchConnectionCommand"; export * from "./DeleteOutboundCrossClusterSearchConnectionCommand"; export * from "./DeletePackageCommand"; export * from "./DescribeDomainAutoTunesCommand"; +export * from "./DescribeDomainChangeProgressCommand"; export * from "./DescribeElasticsearchDomainCommand"; export * from "./DescribeElasticsearchDomainConfigCommand"; export * from "./DescribeElasticsearchDomainsCommand"; diff --git a/clients/client-elasticsearch-service/src/models/models_0.ts b/clients/client-elasticsearch-service/src/models/models_0.ts index 2f2b1fd86f5fb..2271b51c033db 100644 --- a/clients/client-elasticsearch-service/src/models/models_0.ts +++ b/clients/client-elasticsearch-service/src/models/models_0.ts @@ -1535,6 +1535,30 @@ export namespace AutoTuneOptionsOutput { }); } +/** + *

      Specifies change details of the domain configuration change.

      + */ +export interface ChangeProgressDetails { + /** + *

      The unique change identifier associated with a specific domain configuration change.

      + */ + ChangeId?: string; + + /** + *

      Contains an optional message associated with the domain configuration change.

      + */ + Message?: string; +} + +export namespace ChangeProgressDetails { + /** + * @internal + */ + export const filterSensitiveLog = (obj: ChangeProgressDetails): any => ({ + ...obj, + }); +} + /** *

      Options to specify the subnets and security groups for VPC endpoint. For more information, see VPC Endpoints for Amazon Elasticsearch Service Domains.

      */ @@ -1688,6 +1712,11 @@ export interface ElasticsearchDomainStatus { *

      The current status of the Elasticsearch domain's Auto-Tune options.

      */ AutoTuneOptions?: AutoTuneOptionsOutput; + + /** + *

      Specifies change details of the domain configuration change.

      + */ + ChangeProgressDetails?: ChangeProgressDetails; } export namespace ElasticsearchDomainStatus { @@ -2353,6 +2382,146 @@ export namespace DescribeDomainAutoTunesResponse { }); } +/** + *

      Container for the parameters to the DescribeDomainChangeProgress operation. Specifies the + * domain name and optional change specific identity for which you want progress information. + *

      + */ +export interface DescribeDomainChangeProgressRequest { + /** + *

      The domain you want to get the progress information about.

      + */ + DomainName: string | undefined; + + /** + *

      The specific change ID for which you want to get progress information. This is an optional parameter. + * If omitted, the service returns information about the most recent configuration change. + *

      + */ + ChangeId?: string; +} + +export namespace DescribeDomainChangeProgressRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: DescribeDomainChangeProgressRequest): any => ({ + ...obj, + }); +} + +/** + *

      A progress stage details of a specific domain configuration change.

      + */ +export interface ChangeProgressStage { + /** + *

      The name of the specific progress stage.

      + */ + Name?: string; + + /** + *

      The overall status of a specific progress stage.

      + */ + Status?: string; + + /** + *

      The description of the progress stage.

      + */ + Description?: string; + + /** + *

      The last updated timestamp of the progress stage.

      + */ + LastUpdated?: Date; +} + +export namespace ChangeProgressStage { + /** + * @internal + */ + export const filterSensitiveLog = (obj: ChangeProgressStage): any => ({ + ...obj, + }); +} + +export enum OverallChangeStatus { + COMPLETED = "COMPLETED", + FAILED = "FAILED", + PENDING = "PENDING", + PROCESSING = "PROCESSING", +} + +/** + *

      The progress details of a specific domain configuration change.

      + */ +export interface ChangeProgressStatusDetails { + /** + *

      The unique change identifier associated with a specific domain configuration change.

      + */ + ChangeId?: string; + + /** + *

      The time at which the configuration change is made on the domain.

      + */ + StartTime?: Date; + + /** + *

      The overall status of the domain configuration change. This field can take the following values: PENDING, PROCESSING, COMPLETED and FAILED

      + */ + Status?: OverallChangeStatus | string; + + /** + *

      The list of properties involved in the domain configuration change that are still in pending.

      + */ + PendingProperties?: string[]; + + /** + *

      The list of properties involved in the domain configuration change that are completed.

      + */ + CompletedProperties?: string[]; + + /** + *

      The total number of stages required for the configuration change.

      + */ + TotalNumberOfStages?: number; + + /** + *

      The specific stages that the domain is going through to perform the configuration change.

      + */ + ChangeProgressStages?: ChangeProgressStage[]; +} + +export namespace ChangeProgressStatusDetails { + /** + * @internal + */ + export const filterSensitiveLog = (obj: ChangeProgressStatusDetails): any => ({ + ...obj, + }); +} + +/** + *

      The result of a DescribeDomainChangeProgress request. Contains the progress information of + * the requested domain change. + *

      + */ +export interface DescribeDomainChangeProgressResponse { + /** + *

      Progress information for the configuration change that is requested in the DescribeDomainChangeProgress request. + *

      + */ + ChangeProgressStatus?: ChangeProgressStatusDetails; +} + +export namespace DescribeDomainChangeProgressResponse { + /** + * @internal + */ + export const filterSensitiveLog = (obj: DescribeDomainChangeProgressResponse): any => ({ + ...obj, + }); +} + /** *

      Container for the parameters to the DescribeElasticsearchDomain operation.

      */ @@ -2825,6 +2994,11 @@ export interface ElasticsearchDomainConfig { *

      Specifies AutoTuneOptions for the domain.

      */ AutoTuneOptions?: AutoTuneOptionsStatus; + + /** + *

      Specifies change details of the domain configuration change.

      + */ + ChangeProgressDetails?: ChangeProgressDetails; } export namespace ElasticsearchDomainConfig { @@ -5051,6 +5225,11 @@ export interface UpgradeElasticsearchDomainResponse { *

      */ PerformCheckOnly?: boolean; + + /** + *

      Specifies change details of the domain configuration change.

      + */ + ChangeProgressDetails?: ChangeProgressDetails; } export namespace UpgradeElasticsearchDomainResponse { diff --git a/clients/client-elasticsearch-service/src/protocols/Aws_restJson1.ts b/clients/client-elasticsearch-service/src/protocols/Aws_restJson1.ts index 4fa51aad6b359..f901d2b8d814f 100644 --- a/clients/client-elasticsearch-service/src/protocols/Aws_restJson1.ts +++ b/clients/client-elasticsearch-service/src/protocols/Aws_restJson1.ts @@ -59,6 +59,10 @@ import { DescribeDomainAutoTunesCommandInput, DescribeDomainAutoTunesCommandOutput, } from "../commands/DescribeDomainAutoTunesCommand"; +import { + DescribeDomainChangeProgressCommandInput, + DescribeDomainChangeProgressCommandOutput, +} from "../commands/DescribeDomainChangeProgressCommand"; import { DescribeElasticsearchDomainCommandInput, DescribeElasticsearchDomainCommandOutput, @@ -160,6 +164,9 @@ import { AutoTuneOptionsStatus, AutoTuneStatus, BaseException, + ChangeProgressDetails, + ChangeProgressStage, + ChangeProgressStatusDetails, CognitoOptions, CognitoOptionsStatus, ColdStorageOptions, @@ -676,6 +683,40 @@ export const serializeAws_restJson1DescribeDomainAutoTunesCommand = async ( }); }; +export const serializeAws_restJson1DescribeDomainChangeProgressCommand = async ( + input: DescribeDomainChangeProgressCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const { hostname, protocol = "https", port, path: basePath } = await context.endpoint(); + const headers: any = {}; + let resolvedPath = + `${basePath?.endsWith("/") ? basePath.slice(0, -1) : basePath || ""}` + + "/2015-01-01/es/domain/{DomainName}/progress"; + if (input.DomainName !== undefined) { + const labelValue: string = input.DomainName; + if (labelValue.length <= 0) { + throw new Error("Empty value provided for input HTTP label: DomainName."); + } + resolvedPath = resolvedPath.replace("{DomainName}", __extendedEncodeURIComponent(labelValue)); + } else { + throw new Error("No value provided for input HTTP label: DomainName."); + } + const query: any = { + ...(input.ChangeId !== undefined && { changeid: input.ChangeId }), + }; + let body: any; + return new __HttpRequest({ + protocol, + hostname, + port, + method: "GET", + headers, + path: resolvedPath, + query, + body, + }); +}; + export const serializeAws_restJson1DescribeElasticsearchDomainCommand = async ( input: DescribeElasticsearchDomainCommandInput, context: __SerdeContext @@ -2632,6 +2673,88 @@ const deserializeAws_restJson1DescribeDomainAutoTunesCommandError = async ( return Promise.reject(Object.assign(new Error(message), response)); }; +export const deserializeAws_restJson1DescribeDomainChangeProgressCommand = async ( + output: __HttpResponse, + context: __SerdeContext +): Promise => { + if (output.statusCode !== 200 && output.statusCode >= 300) { + return deserializeAws_restJson1DescribeDomainChangeProgressCommandError(output, context); + } + const contents: DescribeDomainChangeProgressCommandOutput = { + $metadata: deserializeMetadata(output), + ChangeProgressStatus: undefined, + }; + const data: { [key: string]: any } = __expectNonNull(__expectObject(await parseBody(output.body, context)), "body"); + if (data.ChangeProgressStatus !== undefined && data.ChangeProgressStatus !== null) { + contents.ChangeProgressStatus = deserializeAws_restJson1ChangeProgressStatusDetails( + data.ChangeProgressStatus, + context + ); + } + return Promise.resolve(contents); +}; + +const deserializeAws_restJson1DescribeDomainChangeProgressCommandError = async ( + output: __HttpResponse, + context: __SerdeContext +): Promise => { + const parsedOutput: any = { + ...output, + body: await parseBody(output.body, context), + }; + let response: __SmithyException & __MetadataBearer & { [key: string]: any }; + let errorCode = "UnknownError"; + errorCode = loadRestJsonErrorCode(output, parsedOutput.body); + switch (errorCode) { + case "BaseException": + case "com.amazonaws.elasticsearchservice#BaseException": + response = { + ...(await deserializeAws_restJson1BaseExceptionResponse(parsedOutput, context)), + name: errorCode, + $metadata: deserializeMetadata(output), + }; + break; + case "InternalException": + case "com.amazonaws.elasticsearchservice#InternalException": + response = { + ...(await deserializeAws_restJson1InternalExceptionResponse(parsedOutput, context)), + name: errorCode, + $metadata: deserializeMetadata(output), + }; + break; + case "ResourceNotFoundException": + case "com.amazonaws.elasticsearchservice#ResourceNotFoundException": + response = { + ...(await deserializeAws_restJson1ResourceNotFoundExceptionResponse(parsedOutput, context)), + name: errorCode, + $metadata: deserializeMetadata(output), + }; + break; + case "ValidationException": + case "com.amazonaws.elasticsearchservice#ValidationException": + response = { + ...(await deserializeAws_restJson1ValidationExceptionResponse(parsedOutput, context)), + name: errorCode, + $metadata: deserializeMetadata(output), + }; + break; + default: + const parsedBody = parsedOutput.body; + errorCode = parsedBody.code || parsedBody.Code || errorCode; + response = { + ...parsedBody, + name: `${errorCode}`, + message: parsedBody.message || parsedBody.Message || errorCode, + $fault: "client", + $metadata: deserializeMetadata(output), + } as any; + } + const message = response.message || response.Message || errorCode; + response.message = message; + delete response.Message; + return Promise.reject(Object.assign(new Error(message), response)); +}; + export const deserializeAws_restJson1DescribeElasticsearchDomainCommand = async ( output: __HttpResponse, context: __SerdeContext @@ -4850,11 +4973,15 @@ export const deserializeAws_restJson1UpgradeElasticsearchDomainCommand = async ( } const contents: UpgradeElasticsearchDomainCommandOutput = { $metadata: deserializeMetadata(output), + ChangeProgressDetails: undefined, DomainName: undefined, PerformCheckOnly: undefined, TargetVersion: undefined, }; const data: { [key: string]: any } = __expectNonNull(__expectObject(await parseBody(output.body, context)), "body"); + if (data.ChangeProgressDetails !== undefined && data.ChangeProgressDetails !== null) { + contents.ChangeProgressDetails = deserializeAws_restJson1ChangeProgressDetails(data.ChangeProgressDetails, context); + } if (data.DomainName !== undefined && data.DomainName !== null) { contents.DomainName = __expectString(data.DomainName); } @@ -5715,6 +5842,66 @@ const deserializeAws_restJson1AutoTuneStatus = (output: any, context: __SerdeCon } as any; }; +const deserializeAws_restJson1ChangeProgressDetails = (output: any, context: __SerdeContext): ChangeProgressDetails => { + return { + ChangeId: __expectString(output.ChangeId), + Message: __expectString(output.Message), + } as any; +}; + +const deserializeAws_restJson1ChangeProgressStage = (output: any, context: __SerdeContext): ChangeProgressStage => { + return { + Description: __expectString(output.Description), + LastUpdated: + output.LastUpdated !== undefined && output.LastUpdated !== null + ? __expectNonNull(__parseEpochTimestamp(__expectNumber(output.LastUpdated))) + : undefined, + Name: __expectString(output.Name), + Status: __expectString(output.Status), + } as any; +}; + +const deserializeAws_restJson1ChangeProgressStageList = ( + output: any, + context: __SerdeContext +): ChangeProgressStage[] => { + return (output || []) + .filter((e: any) => e != null) + .map((entry: any) => { + if (entry === null) { + return null as any; + } + return deserializeAws_restJson1ChangeProgressStage(entry, context); + }); +}; + +const deserializeAws_restJson1ChangeProgressStatusDetails = ( + output: any, + context: __SerdeContext +): ChangeProgressStatusDetails => { + return { + ChangeId: __expectString(output.ChangeId), + ChangeProgressStages: + output.ChangeProgressStages !== undefined && output.ChangeProgressStages !== null + ? deserializeAws_restJson1ChangeProgressStageList(output.ChangeProgressStages, context) + : undefined, + CompletedProperties: + output.CompletedProperties !== undefined && output.CompletedProperties !== null + ? deserializeAws_restJson1StringList(output.CompletedProperties, context) + : undefined, + PendingProperties: + output.PendingProperties !== undefined && output.PendingProperties !== null + ? deserializeAws_restJson1StringList(output.PendingProperties, context) + : undefined, + StartTime: + output.StartTime !== undefined && output.StartTime !== null + ? __expectNonNull(__parseEpochTimestamp(__expectNumber(output.StartTime))) + : undefined, + Status: __expectString(output.Status), + TotalNumberOfStages: __expectInt32(output.TotalNumberOfStages), + } as any; +}; + const deserializeAws_restJson1CognitoOptions = (output: any, context: __SerdeContext): CognitoOptions => { return { Enabled: __expectBoolean(output.Enabled), @@ -5951,6 +6138,10 @@ const deserializeAws_restJson1ElasticsearchDomainConfig = ( output.AutoTuneOptions !== undefined && output.AutoTuneOptions !== null ? deserializeAws_restJson1AutoTuneOptionsStatus(output.AutoTuneOptions, context) : undefined, + ChangeProgressDetails: + output.ChangeProgressDetails !== undefined && output.ChangeProgressDetails !== null + ? deserializeAws_restJson1ChangeProgressDetails(output.ChangeProgressDetails, context) + : undefined, CognitoOptions: output.CognitoOptions !== undefined && output.CognitoOptions !== null ? deserializeAws_restJson1CognitoOptionsStatus(output.CognitoOptions, context) @@ -6013,6 +6204,10 @@ const deserializeAws_restJson1ElasticsearchDomainStatus = ( output.AutoTuneOptions !== undefined && output.AutoTuneOptions !== null ? deserializeAws_restJson1AutoTuneOptionsOutput(output.AutoTuneOptions, context) : undefined, + ChangeProgressDetails: + output.ChangeProgressDetails !== undefined && output.ChangeProgressDetails !== null + ? deserializeAws_restJson1ChangeProgressDetails(output.ChangeProgressDetails, context) + : undefined, CognitoOptions: output.CognitoOptions !== undefined && output.CognitoOptions !== null ? deserializeAws_restJson1CognitoOptions(output.CognitoOptions, context) diff --git a/clients/client-emr/src/EMR.ts b/clients/client-emr/src/EMR.ts index 4ee7bd8689288..70eb9fd229119 100644 --- a/clients/client-emr/src/EMR.ts +++ b/clients/client-emr/src/EMR.ts @@ -331,6 +331,9 @@ export class EMR extends EMRClient { * step was running must have completed and run successfully.

      *

      You can only add steps to a cluster that is in one of the following states: STARTING, * BOOTSTRAPPING, RUNNING, or WAITING.

      + * + *

      The string values passed into HadoopJarStep object cannot exceed a total of 10240 characters.

      + *       */ public addJobFlowSteps( args: AddJobFlowStepsCommandInput, @@ -1482,7 +1485,10 @@ export class EMR extends EMRClient { } /** - *

      Creates or updates an auto-termination policy for an Amazon EMR cluster. An auto-termination policy defines the amount of idle time in seconds after which a cluster automatically terminates. For alternative cluster termination options, see Control cluster termination.

      + * + *

      Auto-termination is supported in Amazon EMR versions 5.30.0 and 6.1.0 and later. For more information, see Using an auto-termination policy.

      + *       + *

      Creates or updates an auto-termination policy for an Amazon EMR cluster. An auto-termination policy defines the amount of idle time in seconds after which a cluster automatically terminates. For alternative cluster termination options, see Control cluster termination.

      */ public putAutoTerminationPolicy( args: PutAutoTerminationPolicyCommandInput, @@ -1804,7 +1810,12 @@ export class EMR extends EMRClient { } /** - *

      Sets the Cluster$VisibleToAllUsers value for an EMR cluster. When true, IAM principals in the + * + *

      The SetVisibleToAllUsers parameter is no longer supported. Your cluster may be visible to all users in your account. + * To restrict cluster access using an IAM policy, see Identity and Access Management for EMR. + *

      + * + *

      Sets the Cluster$VisibleToAllUsers value for an EMR cluster. When true, IAM principals in the * Amazon Web Services account can perform EMR cluster actions that their IAM policies allow. When false, only the IAM principal that created the cluster and the Amazon Web Services account root user can perform EMR actions on the cluster, regardless of IAM permissions policies attached to other IAM principals.

      *

      This action works on running clusters. When you create a cluster, use the RunJobFlowInput$VisibleToAllUsers parameter.

      *

      For more information, see Understanding the EMR Cluster VisibleToAllUsers Setting in the Amazon EMRManagement Guide.

      diff --git a/clients/client-emr/src/commands/AddJobFlowStepsCommand.ts b/clients/client-emr/src/commands/AddJobFlowStepsCommand.ts index 39e2213acc464..e5cca00e0c1b7 100644 --- a/clients/client-emr/src/commands/AddJobFlowStepsCommand.ts +++ b/clients/client-emr/src/commands/AddJobFlowStepsCommand.ts @@ -39,6 +39,9 @@ export interface AddJobFlowStepsCommandOutput extends AddJobFlowStepsOutput, __M * step was running must have completed and run successfully.

      *

      You can only add steps to a cluster that is in one of the following states: STARTING, * BOOTSTRAPPING, RUNNING, or WAITING.

      + * + *

      The string values passed into HadoopJarStep object cannot exceed a total of 10240 characters.

      + *       * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-emr/src/commands/PutAutoTerminationPolicyCommand.ts b/clients/client-emr/src/commands/PutAutoTerminationPolicyCommand.ts index dea908876fcda..7886ad6d850ce 100644 --- a/clients/client-emr/src/commands/PutAutoTerminationPolicyCommand.ts +++ b/clients/client-emr/src/commands/PutAutoTerminationPolicyCommand.ts @@ -22,7 +22,10 @@ export interface PutAutoTerminationPolicyCommandInput extends PutAutoTermination export interface PutAutoTerminationPolicyCommandOutput extends PutAutoTerminationPolicyOutput, __MetadataBearer {} /** - *

      Creates or updates an auto-termination policy for an Amazon EMR cluster. An auto-termination policy defines the amount of idle time in seconds after which a cluster automatically terminates. For alternative cluster termination options, see Control cluster termination.

      + * + *

      Auto-termination is supported in Amazon EMR versions 5.30.0 and 6.1.0 and later. For more information, see Using an auto-termination policy.

      + *       + *

      Creates or updates an auto-termination policy for an Amazon EMR cluster. An auto-termination policy defines the amount of idle time in seconds after which a cluster automatically terminates. For alternative cluster termination options, see Control cluster termination.

      * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-emr/src/commands/SetVisibleToAllUsersCommand.ts b/clients/client-emr/src/commands/SetVisibleToAllUsersCommand.ts index e949e400b46dc..f7f3f42f58468 100644 --- a/clients/client-emr/src/commands/SetVisibleToAllUsersCommand.ts +++ b/clients/client-emr/src/commands/SetVisibleToAllUsersCommand.ts @@ -22,7 +22,12 @@ export interface SetVisibleToAllUsersCommandInput extends SetVisibleToAllUsersIn export interface SetVisibleToAllUsersCommandOutput extends __MetadataBearer {} /** - *

      Sets the Cluster$VisibleToAllUsers value for an EMR cluster. When true, IAM principals in the + * + *

      The SetVisibleToAllUsers parameter is no longer supported. Your cluster may be visible to all users in your account. + * To restrict cluster access using an IAM policy, see Identity and Access Management for EMR. + *

      + * + *

      Sets the Cluster$VisibleToAllUsers value for an EMR cluster. When true, IAM principals in the * Amazon Web Services account can perform EMR cluster actions that their IAM policies allow. When false, only the IAM principal that created the cluster and the Amazon Web Services account root user can perform EMR actions on the cluster, regardless of IAM permissions policies attached to other IAM principals.

      *

      This action works on running clusters. When you create a cluster, use the RunJobFlowInput$VisibleToAllUsers parameter.

      *

      For more information, see Understanding the EMR Cluster VisibleToAllUsers Setting in the Amazon EMRManagement Guide.

      diff --git a/clients/client-emr/src/models/models_0.ts b/clients/client-emr/src/models/models_0.ts index bff20e926e26a..67455c6c667bd 100644 --- a/clients/client-emr/src/models/models_0.ts +++ b/clients/client-emr/src/models/models_0.ts @@ -19,7 +19,7 @@ export enum InstanceFleetType { */ export interface VolumeSpecification { /** - *

      The volume type. Volume types supported are gp2, io1, standard.

      + *

      The volume type. Volume types supported are gp2, io1, and standard.

      */ VolumeType: string | undefined; @@ -193,6 +193,10 @@ export type SpotProvisioningTimeoutAction = "SWITCH_TO_ON_DEMAND" | "TERMINATE_C * later, excluding 5.0.x versions. Spot Instance allocation strategy is available in * Amazon EMR version 5.12.1 and later.

      * + * + *

      Spot Instances with a defined duration (also known as Spot blocks) are no longer available to new customers from July 1, 2021. For customers who have previously used the feature, we will continue to support Spot Instances with a defined duration until December 31, 2022. + *

      + *       */ export interface SpotProvisioningSpecification { /** @@ -221,6 +225,10 @@ export interface SpotProvisioningSpecification { * ID. At the end of the duration, Amazon EC2 marks the Spot Instance for termination and * provides a Spot Instance termination notice, which gives the instance a two-minute warning * before it terminates.

      + * + *

      Spot Instances with a defined duration (also known as Spot blocks) are no longer available to new customers from July 1, 2021. For customers who have previously used the feature, we will continue to support Spot Instances with a defined duration until December 31, 2022. + *

      + *       */ BlockDurationMinutes?: number; @@ -887,7 +895,7 @@ export namespace AddJobFlowStepsOutput { export interface Tag { /** *

      A user-defined key, which is the minimum required information for a valid tag. For more - * information, see Tag .

      + * information, see Tag.

      */ Key?: string; @@ -2199,7 +2207,7 @@ export interface InstanceGroupDetail { InstanceRunningCount: number | undefined; /** - *

      State of instance group. The following values are deprecated: STARTING, TERMINATED, and + *

      State of instance group. The following values are no longer supported: STARTING, TERMINATED, and * FAILED.

      */ State: InstanceGroupState | string | undefined; @@ -2502,7 +2510,7 @@ export interface JobFlowDetail { * Amazon Web Services account can perform EMR cluster actions that their IAM policies allow. When false, only the IAM principal that created the cluster and the Amazon Web Services account root user can perform EMR actions, regardless of IAM permissions policies attached to other IAM principals.

      *

      The default value is true if a value is not provided when creating a * cluster using the EMR API RunJobFlow command, the CLI - * create-cluster command, or the Amazon Web Services Management Console. IAM principals that are authorized to perform actions on the cluster can use the SetVisibleToAllUsers action to change the value on a running cluster. For more information, see Understanding the EMR Cluster VisibleToAllUsers Setting in the Amazon EMRManagement Guide.

      + * create-cluster command, or the Amazon Web Services Management Console.

      */ VisibleToAllUsers?: boolean; @@ -5712,8 +5720,7 @@ export interface Cluster { * Amazon Web Services account can perform EMR cluster actions on the cluster that their IAM policies allow. When false, only the IAM principal that created the cluster and the Amazon Web Services account root user can perform EMR actions, regardless of IAM permissions policies attached to other IAM principals.

      *

      The default value is true if a value is not provided when creating a * cluster using the EMR API RunJobFlow command, the CLI - * create-cluster command, or the Amazon Web Services Management Console. IAM principals that are - * allowed to perform actions on the cluster can use the SetVisibleToAllUsers action to change the value on a running cluster. For more information, see Understanding the EMR Cluster VisibleToAllUsers Setting in the Amazon EMRManagement Guide.

      + * create-cluster command, or the Amazon Web Services Management Console.

      */ VisibleToAllUsers?: boolean; @@ -6843,7 +6850,7 @@ export interface RunJobFlowInput { /** *

      Applies to Amazon EMR releases 4.0 and later. A case-insensitive list of applications * for Amazon EMR to install and configure when launching the cluster. For a list of - * applications available for each Amazon EMR release version, see the Amazon EMR Release + * applications available for each Amazon EMR release version, see the Amazon EMRRelease * Guide.

      */ Applications?: Application[]; @@ -6855,7 +6862,10 @@ export interface RunJobFlowInput { Configurations?: Configuration[]; /** - *

      Set this value to true so that IAM principals in the Amazon Web Services account associated with the cluster can perform EMR actions on the cluster that their IAM policies allow. This value defaults to true for clusters created using the EMR API or the CLI create-cluster command.

      + * + *

      The VisibleToAllUsers parameter is no longer supported. By default, the value is set to true. Setting it to false now has no effect.

      + *       + *

      Set this value to true so that IAM principals in the Amazon Web Services account associated with the cluster can perform EMR actions on the cluster that their IAM policies allow. This value defaults to true for clusters created using the EMR API or the CLI create-cluster command.

      *

      When set to false, only the IAM principal that created the cluster and the Amazon Web Services account root user can perform EMR actions for the cluster, regardless of the IAM permissions policies attached to other IAM principals. For more information, see Understanding the EMR Cluster VisibleToAllUsers Setting in the Amazon EMRManagement Guide.

      */ VisibleToAllUsers?: boolean; diff --git a/clients/client-fis/src/Fis.ts b/clients/client-fis/src/Fis.ts index 2f8fbfa3b4d86..9143edf30ef33 100644 --- a/clients/client-fis/src/Fis.ts +++ b/clients/client-fis/src/Fis.ts @@ -21,6 +21,11 @@ import { GetExperimentTemplateCommandInput, GetExperimentTemplateCommandOutput, } from "./commands/GetExperimentTemplateCommand"; +import { + GetTargetResourceTypeCommand, + GetTargetResourceTypeCommandInput, + GetTargetResourceTypeCommandOutput, +} from "./commands/GetTargetResourceTypeCommand"; import { ListActionsCommand, ListActionsCommandInput, ListActionsCommandOutput } from "./commands/ListActionsCommand"; import { ListExperimentsCommand, @@ -37,6 +42,11 @@ import { ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput, } from "./commands/ListTagsForResourceCommand"; +import { + ListTargetResourceTypesCommand, + ListTargetResourceTypesCommandInput, + ListTargetResourceTypesCommandOutput, +} from "./commands/ListTargetResourceTypesCommand"; import { StartExperimentCommand, StartExperimentCommandInput, @@ -241,6 +251,38 @@ export class Fis extends FisClient { } } + /** + *

      Gets information about the specified resource type.

      + */ + public getTargetResourceType( + args: GetTargetResourceTypeCommandInput, + options?: __HttpHandlerOptions + ): Promise; + public getTargetResourceType( + args: GetTargetResourceTypeCommandInput, + cb: (err: any, data?: GetTargetResourceTypeCommandOutput) => void + ): void; + public getTargetResourceType( + args: GetTargetResourceTypeCommandInput, + options: __HttpHandlerOptions, + cb: (err: any, data?: GetTargetResourceTypeCommandOutput) => void + ): void; + public getTargetResourceType( + args: GetTargetResourceTypeCommandInput, + optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetTargetResourceTypeCommandOutput) => void), + cb?: (err: any, data?: GetTargetResourceTypeCommandOutput) => void + ): Promise | void { + const command = new GetTargetResourceTypeCommand(args); + if (typeof optionsOrCb === "function") { + this.send(command, optionsOrCb); + } else if (typeof cb === "function") { + if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); + this.send(command, optionsOrCb || {}, cb); + } else { + return this.send(command, optionsOrCb); + } + } + /** *

      Lists the available FIS actions.

      */ @@ -363,6 +405,38 @@ export class Fis extends FisClient { } } + /** + *

      Lists the target resource types.

      + */ + public listTargetResourceTypes( + args: ListTargetResourceTypesCommandInput, + options?: __HttpHandlerOptions + ): Promise; + public listTargetResourceTypes( + args: ListTargetResourceTypesCommandInput, + cb: (err: any, data?: ListTargetResourceTypesCommandOutput) => void + ): void; + public listTargetResourceTypes( + args: ListTargetResourceTypesCommandInput, + options: __HttpHandlerOptions, + cb: (err: any, data?: ListTargetResourceTypesCommandOutput) => void + ): void; + public listTargetResourceTypes( + args: ListTargetResourceTypesCommandInput, + optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListTargetResourceTypesCommandOutput) => void), + cb?: (err: any, data?: ListTargetResourceTypesCommandOutput) => void + ): Promise | void { + const command = new ListTargetResourceTypesCommand(args); + if (typeof optionsOrCb === "function") { + this.send(command, optionsOrCb); + } else if (typeof cb === "function") { + if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`); + this.send(command, optionsOrCb || {}, cb); + } else { + return this.send(command, optionsOrCb); + } + } + /** *

      Starts running an experiment from the specified experiment template.

      */ diff --git a/clients/client-fis/src/FisClient.ts b/clients/client-fis/src/FisClient.ts index d224b3c729507..ec360623edfb8 100644 --- a/clients/client-fis/src/FisClient.ts +++ b/clients/client-fis/src/FisClient.ts @@ -64,6 +64,10 @@ import { GetExperimentTemplateCommandInput, GetExperimentTemplateCommandOutput, } from "./commands/GetExperimentTemplateCommand"; +import { + GetTargetResourceTypeCommandInput, + GetTargetResourceTypeCommandOutput, +} from "./commands/GetTargetResourceTypeCommand"; import { ListActionsCommandInput, ListActionsCommandOutput } from "./commands/ListActionsCommand"; import { ListExperimentsCommandInput, ListExperimentsCommandOutput } from "./commands/ListExperimentsCommand"; import { @@ -74,6 +78,10 @@ import { ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput, } from "./commands/ListTagsForResourceCommand"; +import { + ListTargetResourceTypesCommandInput, + ListTargetResourceTypesCommandOutput, +} from "./commands/ListTargetResourceTypesCommand"; import { StartExperimentCommandInput, StartExperimentCommandOutput } from "./commands/StartExperimentCommand"; import { StopExperimentCommandInput, StopExperimentCommandOutput } from "./commands/StopExperimentCommand"; import { TagResourceCommandInput, TagResourceCommandOutput } from "./commands/TagResourceCommand"; @@ -90,10 +98,12 @@ export type ServiceInputTypes = | GetActionCommandInput | GetExperimentCommandInput | GetExperimentTemplateCommandInput + | GetTargetResourceTypeCommandInput | ListActionsCommandInput | ListExperimentTemplatesCommandInput | ListExperimentsCommandInput | ListTagsForResourceCommandInput + | ListTargetResourceTypesCommandInput | StartExperimentCommandInput | StopExperimentCommandInput | TagResourceCommandInput @@ -106,10 +116,12 @@ export type ServiceOutputTypes = | GetActionCommandOutput | GetExperimentCommandOutput | GetExperimentTemplateCommandOutput + | GetTargetResourceTypeCommandOutput | ListActionsCommandOutput | ListExperimentTemplatesCommandOutput | ListExperimentsCommandOutput | ListTagsForResourceCommandOutput + | ListTargetResourceTypesCommandOutput | StartExperimentCommandOutput | StopExperimentCommandOutput | TagResourceCommandOutput diff --git a/clients/client-fis/src/commands/GetTargetResourceTypeCommand.ts b/clients/client-fis/src/commands/GetTargetResourceTypeCommand.ts new file mode 100644 index 0000000000000..1f6bae7397f13 --- /dev/null +++ b/clients/client-fis/src/commands/GetTargetResourceTypeCommand.ts @@ -0,0 +1,95 @@ +import { getSerdePlugin } from "@aws-sdk/middleware-serde"; +import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@aws-sdk/protocol-http"; +import { Command as $Command } from "@aws-sdk/smithy-client"; +import { + FinalizeHandlerArguments, + Handler, + HandlerExecutionContext, + HttpHandlerOptions as __HttpHandlerOptions, + MetadataBearer as __MetadataBearer, + MiddlewareStack, + SerdeContext as __SerdeContext, +} from "@aws-sdk/types"; + +import { FisClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../FisClient"; +import { GetTargetResourceTypeRequest, GetTargetResourceTypeResponse } from "../models/models_0"; +import { + deserializeAws_restJson1GetTargetResourceTypeCommand, + serializeAws_restJson1GetTargetResourceTypeCommand, +} from "../protocols/Aws_restJson1"; + +export interface GetTargetResourceTypeCommandInput extends GetTargetResourceTypeRequest {} +export interface GetTargetResourceTypeCommandOutput extends GetTargetResourceTypeResponse, __MetadataBearer {} + +/** + *

      Gets information about the specified resource type.

      + * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { FisClient, GetTargetResourceTypeCommand } from "@aws-sdk/client-fis"; // ES Modules import + * // const { FisClient, GetTargetResourceTypeCommand } = require("@aws-sdk/client-fis"); // CommonJS import + * const client = new FisClient(config); + * const command = new GetTargetResourceTypeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetTargetResourceTypeCommandInput} for command's `input` shape. + * @see {@link GetTargetResourceTypeCommandOutput} for command's `response` shape. + * @see {@link FisClientResolvedConfig | config} for FisClient's `config` shape. + * + */ +export class GetTargetResourceTypeCommand extends $Command< + GetTargetResourceTypeCommandInput, + GetTargetResourceTypeCommandOutput, + FisClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + constructor(readonly input: GetTargetResourceTypeCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStack, + configuration: FisClientResolvedConfig, + options?: __HttpHandlerOptions + ): Handler { + this.middlewareStack.use(getSerdePlugin(configuration, this.serialize, this.deserialize)); + + const stack = clientStack.concat(this.middlewareStack); + + const { logger } = configuration; + const clientName = "FisClient"; + const commandName = "GetTargetResourceTypeCommand"; + const handlerExecutionContext: HandlerExecutionContext = { + logger, + clientName, + commandName, + inputFilterSensitiveLog: GetTargetResourceTypeRequest.filterSensitiveLog, + outputFilterSensitiveLog: GetTargetResourceTypeResponse.filterSensitiveLog, + }; + const { requestHandler } = configuration; + return stack.resolve( + (request: FinalizeHandlerArguments) => + requestHandler.handle(request.request as __HttpRequest, options || {}), + handlerExecutionContext + ); + } + + private serialize(input: GetTargetResourceTypeCommandInput, context: __SerdeContext): Promise<__HttpRequest> { + return serializeAws_restJson1GetTargetResourceTypeCommand(input, context); + } + + private deserialize(output: __HttpResponse, context: __SerdeContext): Promise { + return deserializeAws_restJson1GetTargetResourceTypeCommand(output, context); + } + + // Start section: command_body_extra + // End section: command_body_extra +} diff --git a/clients/client-fis/src/commands/ListTargetResourceTypesCommand.ts b/clients/client-fis/src/commands/ListTargetResourceTypesCommand.ts new file mode 100644 index 0000000000000..d7bf8852c83b8 --- /dev/null +++ b/clients/client-fis/src/commands/ListTargetResourceTypesCommand.ts @@ -0,0 +1,95 @@ +import { getSerdePlugin } from "@aws-sdk/middleware-serde"; +import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@aws-sdk/protocol-http"; +import { Command as $Command } from "@aws-sdk/smithy-client"; +import { + FinalizeHandlerArguments, + Handler, + HandlerExecutionContext, + HttpHandlerOptions as __HttpHandlerOptions, + MetadataBearer as __MetadataBearer, + MiddlewareStack, + SerdeContext as __SerdeContext, +} from "@aws-sdk/types"; + +import { FisClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../FisClient"; +import { ListTargetResourceTypesRequest, ListTargetResourceTypesResponse } from "../models/models_0"; +import { + deserializeAws_restJson1ListTargetResourceTypesCommand, + serializeAws_restJson1ListTargetResourceTypesCommand, +} from "../protocols/Aws_restJson1"; + +export interface ListTargetResourceTypesCommandInput extends ListTargetResourceTypesRequest {} +export interface ListTargetResourceTypesCommandOutput extends ListTargetResourceTypesResponse, __MetadataBearer {} + +/** + *

      Lists the target resource types.

      + * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { FisClient, ListTargetResourceTypesCommand } from "@aws-sdk/client-fis"; // ES Modules import + * // const { FisClient, ListTargetResourceTypesCommand } = require("@aws-sdk/client-fis"); // CommonJS import + * const client = new FisClient(config); + * const command = new ListTargetResourceTypesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTargetResourceTypesCommandInput} for command's `input` shape. + * @see {@link ListTargetResourceTypesCommandOutput} for command's `response` shape. + * @see {@link FisClientResolvedConfig | config} for FisClient's `config` shape. + * + */ +export class ListTargetResourceTypesCommand extends $Command< + ListTargetResourceTypesCommandInput, + ListTargetResourceTypesCommandOutput, + FisClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + constructor(readonly input: ListTargetResourceTypesCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStack, + configuration: FisClientResolvedConfig, + options?: __HttpHandlerOptions + ): Handler { + this.middlewareStack.use(getSerdePlugin(configuration, this.serialize, this.deserialize)); + + const stack = clientStack.concat(this.middlewareStack); + + const { logger } = configuration; + const clientName = "FisClient"; + const commandName = "ListTargetResourceTypesCommand"; + const handlerExecutionContext: HandlerExecutionContext = { + logger, + clientName, + commandName, + inputFilterSensitiveLog: ListTargetResourceTypesRequest.filterSensitiveLog, + outputFilterSensitiveLog: ListTargetResourceTypesResponse.filterSensitiveLog, + }; + const { requestHandler } = configuration; + return stack.resolve( + (request: FinalizeHandlerArguments) => + requestHandler.handle(request.request as __HttpRequest, options || {}), + handlerExecutionContext + ); + } + + private serialize(input: ListTargetResourceTypesCommandInput, context: __SerdeContext): Promise<__HttpRequest> { + return serializeAws_restJson1ListTargetResourceTypesCommand(input, context); + } + + private deserialize(output: __HttpResponse, context: __SerdeContext): Promise { + return deserializeAws_restJson1ListTargetResourceTypesCommand(output, context); + } + + // Start section: command_body_extra + // End section: command_body_extra +} diff --git a/clients/client-fis/src/commands/index.ts b/clients/client-fis/src/commands/index.ts index 5b220f135cd8a..3f01988d0ceb6 100644 --- a/clients/client-fis/src/commands/index.ts +++ b/clients/client-fis/src/commands/index.ts @@ -3,10 +3,12 @@ export * from "./DeleteExperimentTemplateCommand"; export * from "./GetActionCommand"; export * from "./GetExperimentCommand"; export * from "./GetExperimentTemplateCommand"; +export * from "./GetTargetResourceTypeCommand"; export * from "./ListActionsCommand"; export * from "./ListExperimentTemplatesCommand"; export * from "./ListExperimentsCommand"; export * from "./ListTagsForResourceCommand"; +export * from "./ListTargetResourceTypesCommand"; export * from "./StartExperimentCommand"; export * from "./StopExperimentCommand"; export * from "./TagResourceCommand"; diff --git a/clients/client-fis/src/models/models_0.ts b/clients/client-fis/src/models/models_0.ts index 055da1aa0b32c..6292779558323 100644 --- a/clients/client-fis/src/models/models_0.ts +++ b/clients/client-fis/src/models/models_0.ts @@ -228,7 +228,7 @@ export namespace ExperimentTemplateTargetInputFilter { */ export interface CreateExperimentTemplateTargetInput { /** - *

      The Amazon Web Services resource type. The resource type must be supported for the specified action.

      + *

      The resource type. The resource type must be supported for the specified action.

      */ resourceType: string | undefined; @@ -264,6 +264,11 @@ export interface CreateExperimentTemplateTargetInput { *
    */ selectionMode: string | undefined; + + /** + *

    The resource type parameters.

    + */ + parameters?: { [key: string]: string }; } export namespace CreateExperimentTemplateTargetInput { @@ -436,6 +441,11 @@ export interface ExperimentTemplateTarget { *

    Scopes the identified resources to a specific count or percentage.

    */ selectionMode?: string; + + /** + *

    The resource type parameters.

    + */ + parameters?: { [key: string]: string }; } export namespace ExperimentTemplateTarget { @@ -780,6 +790,11 @@ export interface ExperimentTarget { *

    Scopes the identified resources to a specific count or percentage.

    */ selectionMode?: string; + + /** + *

    The resource type parameters.

    + */ + parameters?: { [key: string]: string }; } export namespace ExperimentTarget { @@ -1034,6 +1049,92 @@ export namespace GetExperimentTemplateResponse { }); } +export interface GetTargetResourceTypeRequest { + /** + *

    The resource type.

    + */ + resourceType: string | undefined; +} + +export namespace GetTargetResourceTypeRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: GetTargetResourceTypeRequest): any => ({ + ...obj, + }); +} + +/** + *

    Describes the parameters for a resource type. Use parameters to determine which tasks are + * identified during target resolution.

    + */ +export interface TargetResourceTypeParameter { + /** + *

    A description of the parameter.

    + */ + description?: string; + + /** + *

    Indicates whether the parameter is required.

    + */ + required?: boolean; +} + +export namespace TargetResourceTypeParameter { + /** + * @internal + */ + export const filterSensitiveLog = (obj: TargetResourceTypeParameter): any => ({ + ...obj, + }); +} + +/** + *

    Describes a resource type.

    + */ +export interface TargetResourceType { + /** + *

    The resource type.

    + */ + resourceType?: string; + + /** + *

    A description of the resource type.

    + */ + description?: string; + + /** + *

    The parameters for the resource type.

    + */ + parameters?: { [key: string]: TargetResourceTypeParameter }; +} + +export namespace TargetResourceType { + /** + * @internal + */ + export const filterSensitiveLog = (obj: TargetResourceType): any => ({ + ...obj, + }); +} + +export interface GetTargetResourceTypeResponse { + /** + *

    Information about the resource type.

    + */ + targetResourceType?: TargetResourceType; +} + +export namespace GetTargetResourceTypeResponse { + /** + * @internal + */ + export const filterSensitiveLog = (obj: GetTargetResourceTypeResponse): any => ({ + ...obj, + }); +} + export interface ListActionsRequest { /** *

    The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

    @@ -1192,6 +1293,72 @@ export namespace ListTagsForResourceResponse { }); } +export interface ListTargetResourceTypesRequest { + /** + *

    The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

    + */ + maxResults?: number; + + /** + *

    The token for the next page of results.

    + */ + nextToken?: string; +} + +export namespace ListTargetResourceTypesRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: ListTargetResourceTypesRequest): any => ({ + ...obj, + }); +} + +/** + *

    Describes a resource type.

    + */ +export interface TargetResourceTypeSummary { + /** + *

    The resource type.

    + */ + resourceType?: string; + + /** + *

    A description of the resource type.

    + */ + description?: string; +} + +export namespace TargetResourceTypeSummary { + /** + * @internal + */ + export const filterSensitiveLog = (obj: TargetResourceTypeSummary): any => ({ + ...obj, + }); +} + +export interface ListTargetResourceTypesResponse { + /** + *

    The target resource types.

    + */ + targetResourceTypes?: TargetResourceTypeSummary[]; + + /** + *

    The token to use to retrieve the next page of results. This value is null when there are no more results to return.

    + */ + nextToken?: string; +} + +export namespace ListTargetResourceTypesResponse { + /** + * @internal + */ + export const filterSensitiveLog = (obj: ListTargetResourceTypesResponse): any => ({ + ...obj, + }); +} + export interface StartExperimentRequest { /** *

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    @@ -1400,7 +1567,7 @@ export namespace UpdateExperimentTemplateStopConditionInput { */ export interface UpdateExperimentTemplateTargetInput { /** - *

    The Amazon Web Services resource type. The resource type must be supported for the specified action.

    + *

    The resource type. The resource type must be supported for the specified action.

    */ resourceType: string | undefined; @@ -1423,6 +1590,11 @@ export interface UpdateExperimentTemplateTargetInput { *

    Scopes the identified resources to a specific count or percentage.

    */ selectionMode: string | undefined; + + /** + *

    The resource type parameters.

    + */ + parameters?: { [key: string]: string }; } export namespace UpdateExperimentTemplateTargetInput { diff --git a/clients/client-fis/src/pagination/ListTargetResourceTypesPaginator.ts b/clients/client-fis/src/pagination/ListTargetResourceTypesPaginator.ts new file mode 100644 index 0000000000000..67dda8e1d1db9 --- /dev/null +++ b/clients/client-fis/src/pagination/ListTargetResourceTypesPaginator.ts @@ -0,0 +1,59 @@ +import { Paginator } from "@aws-sdk/types"; + +import { + ListTargetResourceTypesCommand, + ListTargetResourceTypesCommandInput, + ListTargetResourceTypesCommandOutput, +} from "../commands/ListTargetResourceTypesCommand"; +import { Fis } from "../Fis"; +import { FisClient } from "../FisClient"; +import { FisPaginationConfiguration } from "./Interfaces"; + +/** + * @private + */ +const makePagedClientRequest = async ( + client: FisClient, + input: ListTargetResourceTypesCommandInput, + ...args: any +): Promise => { + // @ts-ignore + return await client.send(new ListTargetResourceTypesCommand(input), ...args); +}; +/** + * @private + */ +const makePagedRequest = async ( + client: Fis, + input: ListTargetResourceTypesCommandInput, + ...args: any +): Promise => { + // @ts-ignore + return await client.listTargetResourceTypes(input, ...args); +}; +export async function* paginateListTargetResourceTypes( + config: FisPaginationConfiguration, + input: ListTargetResourceTypesCommandInput, + ...additionalArguments: any +): Paginator { + // ToDo: replace with actual type instead of typeof input.nextToken + let token: typeof input.nextToken | undefined = config.startingToken || undefined; + let hasNext = true; + let page: ListTargetResourceTypesCommandOutput; + while (hasNext) { + input.nextToken = token; + input["maxResults"] = config.pageSize; + if (config.client instanceof Fis) { + page = await makePagedRequest(config.client, input, ...additionalArguments); + } else if (config.client instanceof FisClient) { + page = await makePagedClientRequest(config.client, input, ...additionalArguments); + } else { + throw new Error("Invalid client, expected Fis | FisClient"); + } + yield page; + token = page.nextToken; + hasNext = !!token; + } + // @ts-ignore + return undefined; +} diff --git a/clients/client-fis/src/pagination/index.ts b/clients/client-fis/src/pagination/index.ts index b63c3f8d1838a..a92230b80cc80 100644 --- a/clients/client-fis/src/pagination/index.ts +++ b/clients/client-fis/src/pagination/index.ts @@ -2,3 +2,4 @@ export * from "./Interfaces"; export * from "./ListActionsPaginator"; export * from "./ListExperimentTemplatesPaginator"; export * from "./ListExperimentsPaginator"; +export * from "./ListTargetResourceTypesPaginator"; diff --git a/clients/client-fis/src/protocols/Aws_restJson1.ts b/clients/client-fis/src/protocols/Aws_restJson1.ts index c5fb76b88900c..d46275fc4986e 100644 --- a/clients/client-fis/src/protocols/Aws_restJson1.ts +++ b/clients/client-fis/src/protocols/Aws_restJson1.ts @@ -31,6 +31,10 @@ import { GetExperimentTemplateCommandInput, GetExperimentTemplateCommandOutput, } from "../commands/GetExperimentTemplateCommand"; +import { + GetTargetResourceTypeCommandInput, + GetTargetResourceTypeCommandOutput, +} from "../commands/GetTargetResourceTypeCommand"; import { ListActionsCommandInput, ListActionsCommandOutput } from "../commands/ListActionsCommand"; import { ListExperimentsCommandInput, ListExperimentsCommandOutput } from "../commands/ListExperimentsCommand"; import { @@ -41,6 +45,10 @@ import { ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput, } from "../commands/ListTagsForResourceCommand"; +import { + ListTargetResourceTypesCommandInput, + ListTargetResourceTypesCommandOutput, +} from "../commands/ListTargetResourceTypesCommand"; import { StartExperimentCommandInput, StartExperimentCommandOutput } from "../commands/StartExperimentCommand"; import { StopExperimentCommandInput, StopExperimentCommandOutput } from "../commands/StopExperimentCommand"; import { TagResourceCommandInput, TagResourceCommandOutput } from "../commands/TagResourceCommand"; @@ -75,6 +83,9 @@ import { ExperimentTemplateTargetInputFilter, ResourceNotFoundException, ServiceQuotaExceededException, + TargetResourceType, + TargetResourceTypeParameter, + TargetResourceTypeSummary, UpdateExperimentTemplateActionInputItem, UpdateExperimentTemplateStopConditionInput, UpdateExperimentTemplateTargetInput, @@ -237,6 +248,35 @@ export const serializeAws_restJson1GetExperimentTemplateCommand = async ( }); }; +export const serializeAws_restJson1GetTargetResourceTypeCommand = async ( + input: GetTargetResourceTypeCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const { hostname, protocol = "https", port, path: basePath } = await context.endpoint(); + const headers: any = {}; + let resolvedPath = + `${basePath?.endsWith("/") ? basePath.slice(0, -1) : basePath || ""}` + "/targetResourceTypes/{resourceType}"; + if (input.resourceType !== undefined) { + const labelValue: string = input.resourceType; + if (labelValue.length <= 0) { + throw new Error("Empty value provided for input HTTP label: resourceType."); + } + resolvedPath = resolvedPath.replace("{resourceType}", __extendedEncodeURIComponent(labelValue)); + } else { + throw new Error("No value provided for input HTTP label: resourceType."); + } + let body: any; + return new __HttpRequest({ + protocol, + hostname, + port, + method: "GET", + headers, + path: resolvedPath, + body, + }); +}; + export const serializeAws_restJson1ListActionsCommand = async ( input: ListActionsCommandInput, context: __SerdeContext @@ -337,6 +377,30 @@ export const serializeAws_restJson1ListTagsForResourceCommand = async ( }); }; +export const serializeAws_restJson1ListTargetResourceTypesCommand = async ( + input: ListTargetResourceTypesCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const { hostname, protocol = "https", port, path: basePath } = await context.endpoint(); + const headers: any = {}; + const resolvedPath = `${basePath?.endsWith("/") ? basePath.slice(0, -1) : basePath || ""}` + "/targetResourceTypes"; + const query: any = { + ...(input.maxResults !== undefined && { maxResults: input.maxResults.toString() }), + ...(input.nextToken !== undefined && { nextToken: input.nextToken }), + }; + let body: any; + return new __HttpRequest({ + protocol, + hostname, + port, + method: "GET", + headers, + path: resolvedPath, + query, + body, + }); +}; + export const serializeAws_restJson1StartExperimentCommand = async ( input: StartExperimentCommandInput, context: __SerdeContext @@ -838,6 +902,69 @@ const deserializeAws_restJson1GetExperimentTemplateCommandError = async ( return Promise.reject(Object.assign(new Error(message), response)); }; +export const deserializeAws_restJson1GetTargetResourceTypeCommand = async ( + output: __HttpResponse, + context: __SerdeContext +): Promise => { + if (output.statusCode !== 200 && output.statusCode >= 300) { + return deserializeAws_restJson1GetTargetResourceTypeCommandError(output, context); + } + const contents: GetTargetResourceTypeCommandOutput = { + $metadata: deserializeMetadata(output), + targetResourceType: undefined, + }; + const data: { [key: string]: any } = __expectNonNull(__expectObject(await parseBody(output.body, context)), "body"); + if (data.targetResourceType !== undefined && data.targetResourceType !== null) { + contents.targetResourceType = deserializeAws_restJson1TargetResourceType(data.targetResourceType, context); + } + return Promise.resolve(contents); +}; + +const deserializeAws_restJson1GetTargetResourceTypeCommandError = async ( + output: __HttpResponse, + context: __SerdeContext +): Promise => { + const parsedOutput: any = { + ...output, + body: await parseBody(output.body, context), + }; + let response: __SmithyException & __MetadataBearer & { [key: string]: any }; + let errorCode = "UnknownError"; + errorCode = loadRestJsonErrorCode(output, parsedOutput.body); + switch (errorCode) { + case "ResourceNotFoundException": + case "com.amazonaws.fis#ResourceNotFoundException": + response = { + ...(await deserializeAws_restJson1ResourceNotFoundExceptionResponse(parsedOutput, context)), + name: errorCode, + $metadata: deserializeMetadata(output), + }; + break; + case "ValidationException": + case "com.amazonaws.fis#ValidationException": + response = { + ...(await deserializeAws_restJson1ValidationExceptionResponse(parsedOutput, context)), + name: errorCode, + $metadata: deserializeMetadata(output), + }; + break; + default: + const parsedBody = parsedOutput.body; + errorCode = parsedBody.code || parsedBody.Code || errorCode; + response = { + ...parsedBody, + name: `${errorCode}`, + message: parsedBody.message || parsedBody.Message || errorCode, + $fault: "client", + $metadata: deserializeMetadata(output), + } as any; + } + const message = response.message || response.Message || errorCode; + response.message = message; + delete response.Message; + return Promise.reject(Object.assign(new Error(message), response)); +}; + export const deserializeAws_restJson1ListActionsCommand = async ( output: __HttpResponse, context: __SerdeContext @@ -1065,6 +1192,68 @@ const deserializeAws_restJson1ListTagsForResourceCommandError = async ( return Promise.reject(Object.assign(new Error(message), response)); }; +export const deserializeAws_restJson1ListTargetResourceTypesCommand = async ( + output: __HttpResponse, + context: __SerdeContext +): Promise => { + if (output.statusCode !== 200 && output.statusCode >= 300) { + return deserializeAws_restJson1ListTargetResourceTypesCommandError(output, context); + } + const contents: ListTargetResourceTypesCommandOutput = { + $metadata: deserializeMetadata(output), + nextToken: undefined, + targetResourceTypes: undefined, + }; + const data: { [key: string]: any } = __expectNonNull(__expectObject(await parseBody(output.body, context)), "body"); + if (data.nextToken !== undefined && data.nextToken !== null) { + contents.nextToken = __expectString(data.nextToken); + } + if (data.targetResourceTypes !== undefined && data.targetResourceTypes !== null) { + contents.targetResourceTypes = deserializeAws_restJson1TargetResourceTypeSummaryList( + data.targetResourceTypes, + context + ); + } + return Promise.resolve(contents); +}; + +const deserializeAws_restJson1ListTargetResourceTypesCommandError = async ( + output: __HttpResponse, + context: __SerdeContext +): Promise => { + const parsedOutput: any = { + ...output, + body: await parseBody(output.body, context), + }; + let response: __SmithyException & __MetadataBearer & { [key: string]: any }; + let errorCode = "UnknownError"; + errorCode = loadRestJsonErrorCode(output, parsedOutput.body); + switch (errorCode) { + case "ValidationException": + case "com.amazonaws.fis#ValidationException": + response = { + ...(await deserializeAws_restJson1ValidationExceptionResponse(parsedOutput, context)), + name: errorCode, + $metadata: deserializeMetadata(output), + }; + break; + default: + const parsedBody = parsedOutput.body; + errorCode = parsedBody.code || parsedBody.Code || errorCode; + response = { + ...parsedBody, + name: `${errorCode}`, + message: parsedBody.message || parsedBody.Message || errorCode, + $fault: "client", + $metadata: deserializeMetadata(output), + } as any; + } + const message = response.message || response.Message || errorCode; + response.message = message; + delete response.Message; + return Promise.reject(Object.assign(new Error(message), response)); +}; + export const deserializeAws_restJson1StartExperimentCommand = async ( output: __HttpResponse, context: __SerdeContext @@ -1502,6 +1691,10 @@ const serializeAws_restJson1CreateExperimentTemplateTargetInput = ( input.filters !== null && { filters: serializeAws_restJson1ExperimentTemplateTargetFilterInputList(input.filters, context), }), + ...(input.parameters !== undefined && + input.parameters !== null && { + parameters: serializeAws_restJson1ExperimentTemplateTargetParameterMap(input.parameters, context), + }), ...(input.resourceArns !== undefined && input.resourceArns !== null && { resourceArns: serializeAws_restJson1ResourceArnList(input.resourceArns, context), @@ -1610,6 +1803,21 @@ const serializeAws_restJson1ExperimentTemplateTargetInputFilter = ( }; }; +const serializeAws_restJson1ExperimentTemplateTargetParameterMap = ( + input: { [key: string]: string }, + context: __SerdeContext +): any => { + return Object.entries(input).reduce((acc: { [key: string]: any }, [key, value]: [string, any]) => { + if (value === null) { + return acc; + } + return { + ...acc, + [key]: value, + }; + }, {}); +}; + const serializeAws_restJson1ResourceArnList = (input: string[], context: __SerdeContext): any => { return input .filter((e: any) => e != null) @@ -1703,6 +1911,10 @@ const serializeAws_restJson1UpdateExperimentTemplateTargetInput = ( input.filters !== null && { filters: serializeAws_restJson1ExperimentTemplateTargetFilterInputList(input.filters, context), }), + ...(input.parameters !== undefined && + input.parameters !== null && { + parameters: serializeAws_restJson1ExperimentTemplateTargetParameterMap(input.parameters, context), + }), ...(input.resourceArns !== undefined && input.resourceArns !== null && { resourceArns: serializeAws_restJson1ResourceArnList(input.resourceArns, context), @@ -2018,6 +2230,10 @@ const deserializeAws_restJson1ExperimentTarget = (output: any, context: __SerdeC output.filters !== undefined && output.filters !== null ? deserializeAws_restJson1ExperimentTargetFilterList(output.filters, context) : undefined, + parameters: + output.parameters !== undefined && output.parameters !== null + ? deserializeAws_restJson1ExperimentTargetParameterMap(output.parameters, context) + : undefined, resourceArns: output.resourceArns !== undefined && output.resourceArns !== null ? deserializeAws_restJson1ResourceArnList(output.resourceArns, context) @@ -2084,6 +2300,21 @@ const deserializeAws_restJson1ExperimentTargetMap = ( }, {}); }; +const deserializeAws_restJson1ExperimentTargetParameterMap = ( + output: any, + context: __SerdeContext +): { [key: string]: string } => { + return Object.entries(output).reduce((acc: { [key: string]: string }, [key, value]: [string, any]) => { + if (value === null) { + return acc; + } + return { + ...acc, + [key]: __expectString(value) as any, + }; + }, {}); +}; + const deserializeAws_restJson1ExperimentTemplate = (output: any, context: __SerdeContext): ExperimentTemplate => { return { actions: @@ -2269,6 +2500,10 @@ const deserializeAws_restJson1ExperimentTemplateTarget = ( output.filters !== undefined && output.filters !== null ? deserializeAws_restJson1ExperimentTemplateTargetFilterList(output.filters, context) : undefined, + parameters: + output.parameters !== undefined && output.parameters !== null + ? deserializeAws_restJson1ExperimentTemplateTargetParameterMap(output.parameters, context) + : undefined, resourceArns: output.resourceArns !== undefined && output.resourceArns !== null ? deserializeAws_restJson1ResourceArnList(output.resourceArns, context) @@ -2341,6 +2576,21 @@ const deserializeAws_restJson1ExperimentTemplateTargetMap = ( ); }; +const deserializeAws_restJson1ExperimentTemplateTargetParameterMap = ( + output: any, + context: __SerdeContext +): { [key: string]: string } => { + return Object.entries(output).reduce((acc: { [key: string]: string }, [key, value]: [string, any]) => { + if (value === null) { + return acc; + } + return { + ...acc, + [key]: __expectString(value) as any, + }; + }, {}); +}; + const deserializeAws_restJson1ResourceArnList = (output: any, context: __SerdeContext): string[] => { return (output || []) .filter((e: any) => e != null) @@ -2364,6 +2614,69 @@ const deserializeAws_restJson1TagMap = (output: any, context: __SerdeContext): { }, {}); }; +const deserializeAws_restJson1TargetResourceType = (output: any, context: __SerdeContext): TargetResourceType => { + return { + description: __expectString(output.description), + parameters: + output.parameters !== undefined && output.parameters !== null + ? deserializeAws_restJson1TargetResourceTypeParameterMap(output.parameters, context) + : undefined, + resourceType: __expectString(output.resourceType), + } as any; +}; + +const deserializeAws_restJson1TargetResourceTypeParameter = ( + output: any, + context: __SerdeContext +): TargetResourceTypeParameter => { + return { + description: __expectString(output.description), + required: __expectBoolean(output.required), + } as any; +}; + +const deserializeAws_restJson1TargetResourceTypeParameterMap = ( + output: any, + context: __SerdeContext +): { [key: string]: TargetResourceTypeParameter } => { + return Object.entries(output).reduce( + (acc: { [key: string]: TargetResourceTypeParameter }, [key, value]: [string, any]) => { + if (value === null) { + return acc; + } + return { + ...acc, + [key]: deserializeAws_restJson1TargetResourceTypeParameter(value, context), + }; + }, + {} + ); +}; + +const deserializeAws_restJson1TargetResourceTypeSummary = ( + output: any, + context: __SerdeContext +): TargetResourceTypeSummary => { + return { + description: __expectString(output.description), + resourceType: __expectString(output.resourceType), + } as any; +}; + +const deserializeAws_restJson1TargetResourceTypeSummaryList = ( + output: any, + context: __SerdeContext +): TargetResourceTypeSummary[] => { + return (output || []) + .filter((e: any) => e != null) + .map((entry: any) => { + if (entry === null) { + return null as any; + } + return deserializeAws_restJson1TargetResourceTypeSummary(entry, context); + }); +}; + const deserializeMetadata = (output: __HttpResponse): __ResponseMetadata => ({ httpStatusCode: output.statusCode, requestId: output.headers["x-amzn-requestid"] ?? output.headers["x-amzn-request-id"], diff --git a/clients/client-glue/src/models/models_0.ts b/clients/client-glue/src/models/models_0.ts index d05098b9e5f01..58b38c6651798 100644 --- a/clients/client-glue/src/models/models_0.ts +++ b/clients/client-glue/src/models/models_0.ts @@ -3467,11 +3467,12 @@ export namespace CancelMLTaskRunResponse { export enum DataFormat { AVRO = "AVRO", JSON = "JSON", + PROTOBUF = "PROTOBUF", } export interface CheckSchemaVersionValidityInput { /** - *

    The data format of the schema definition. Currently AVRO and JSON are supported.

    + *

    The data format of the schema definition. Currently AVRO, JSON and PROTOBUF are supported.

    */ DataFormat: DataFormat | string | undefined; @@ -5218,7 +5219,7 @@ export interface CreateSchemaInput { SchemaName: string | undefined; /** - *

    The data format of the schema definition. Currently AVRO and JSON are supported.

    + *

    The data format of the schema definition. Currently AVRO, JSON and PROTOBUF are supported.

    */ DataFormat: DataFormat | string | undefined; @@ -5327,7 +5328,7 @@ export interface CreateSchemaResponse { Description?: string; /** - *

    The data format of the schema definition. Currently AVRO and JSON are supported.

    + *

    The data format of the schema definition. Currently AVRO, JSON and PROTOBUF are supported.

    */ DataFormat?: DataFormat | string; diff --git a/clients/client-glue/src/models/models_1.ts b/clients/client-glue/src/models/models_1.ts index 1358b5007dba1..869de64209962 100644 --- a/clients/client-glue/src/models/models_1.ts +++ b/clients/client-glue/src/models/models_1.ts @@ -2739,7 +2739,7 @@ export interface GetSchemaResponse { Description?: string; /** - *

    The data format of the schema definition. Currently AVRO and JSON are supported.

    + *

    The data format of the schema definition. Currently AVRO, JSON and PROTOBUF are supported.

    */ DataFormat?: DataFormat | string; @@ -2829,7 +2829,7 @@ export interface GetSchemaByDefinitionResponse { SchemaArn?: string; /** - *

    The data format of the schema definition. Currently only AVRO and JSON are supported.

    + *

    The data format of the schema definition. Currently AVRO, JSON and PROTOBUF are supported.

    */ DataFormat?: DataFormat | string; @@ -2923,7 +2923,7 @@ export interface GetSchemaVersionResponse { SchemaDefinition?: string; /** - *

    The data format of the schema definition. Currently AVRO and JSON are supported.

    + *

    The data format of the schema definition. Currently AVRO, JSON and PROTOBUF are supported.

    */ DataFormat?: DataFormat | string; diff --git a/clients/client-glue/src/protocols/Aws_json1_1.ts b/clients/client-glue/src/protocols/Aws_json1_1.ts index 1804a987df54b..da927b7a251f9 100644 --- a/clients/client-glue/src/protocols/Aws_json1_1.ts +++ b/clients/client-glue/src/protocols/Aws_json1_1.ts @@ -5289,6 +5289,14 @@ const deserializeAws_json1_1CreateRegistryCommandError = async ( $metadata: deserializeMetadata(output), }; break; + case "ConcurrentModificationException": + case "com.amazonaws.glue#ConcurrentModificationException": + response = { + ...(await deserializeAws_json1_1ConcurrentModificationExceptionResponse(parsedOutput, context)), + name: errorCode, + $metadata: deserializeMetadata(output), + }; + break; case "InternalServiceException": case "com.amazonaws.glue#InternalServiceException": response = { @@ -5375,6 +5383,14 @@ const deserializeAws_json1_1CreateSchemaCommandError = async ( $metadata: deserializeMetadata(output), }; break; + case "ConcurrentModificationException": + case "com.amazonaws.glue#ConcurrentModificationException": + response = { + ...(await deserializeAws_json1_1ConcurrentModificationExceptionResponse(parsedOutput, context)), + name: errorCode, + $metadata: deserializeMetadata(output), + }; + break; case "EntityNotFoundException": case "com.amazonaws.glue#EntityNotFoundException": response = { diff --git a/clients/client-iot/src/models/models_1.ts b/clients/client-iot/src/models/models_1.ts index b0f9ed4f66bad..2f97eb8d0d081 100644 --- a/clients/client-iot/src/models/models_1.ts +++ b/clients/client-iot/src/models/models_1.ts @@ -298,7 +298,10 @@ export namespace DeleteTopicRuleDestinationResponse { } export enum LogTargetType { + CLIENT_ID = "CLIENT_ID", DEFAULT = "DEFAULT", + PRINCIPAL_ID = "PRINCIPAL_ID", + SOURCE_IP = "SOURCE_IP", THING_GROUP = "THING_GROUP", } diff --git a/clients/client-lakeformation/src/models/models_0.ts b/clients/client-lakeformation/src/models/models_0.ts index 385519554a7db..ca7ead0a83f75 100644 --- a/clients/client-lakeformation/src/models/models_0.ts +++ b/clients/client-lakeformation/src/models/models_0.ts @@ -3502,7 +3502,7 @@ export interface UpdateTableObjectsRequest { /** *

    The transaction at which to do the write.

    */ - TransactionId: string | undefined; + TransactionId?: string; /** *

    A list of WriteOperation objects that define an object to add to or delete from the manifest for a governed table.

    diff --git a/clients/client-marketplace-metering/README.md b/clients/client-marketplace-metering/README.md index 35a87540804e1..80af0c0d853be 100644 --- a/clients/client-marketplace-metering/README.md +++ b/clients/client-marketplace-metering/README.md @@ -9,12 +9,12 @@ AWS SDK for JavaScript MarketplaceMetering Client for Node.js, Browser and React AWS Marketplace Metering Service -

    This reference provides descriptions of the low-level AWS Marketplace Metering -Service API.

    +

    This reference provides descriptions of the low-level AWS Marketplace Metering Service +API.

    AWS Marketplace sellers can use this API to submit usage data for custom usage dimensions.

    -

    For information on the permissions you need to use this API, see -AWS Marketing metering and entitlement API permissions in the AWS Marketplace Seller Guide. +

    For information on the permissions you need to use this API, see AWS Marketplace metering and entitlement API permissions in the +AWS Marketplace Seller Guide.

    Submitting Metering Records @@ -22,15 +22,15 @@ dimensions.

    • -MeterUsage- Submits the metering record for a Marketplace -product. MeterUsage is called from an EC2 instance or a container running on EKS -or ECS.

      +MeterUsage - Submits the metering record for an AWS +Marketplace product. MeterUsage is called from an EC2 instance or a +container running on EKS or ECS.

    • -BatchMeterUsage- Submits the metering record for a set of -customers. BatchMeterUsage is called from a software-as-a-service (SaaS) -application.

      +BatchMeterUsage - Submits the metering record for a set of +customers. BatchMeterUsage is called from a software-as-a-service +(SaaS) application.

    @@ -39,11 +39,15 @@ application.

    • -ResolveCustomer- Called by a SaaS application during the +ResolveCustomer - Called by a SaaS application during the registration process. When a buyer visits your website during the registration process, the buyer submits a Registration Token through the browser. The -Registration Token is resolved through this API to obtain a CustomerIdentifier -and Product Code.

      +Registration Token is resolved through this API to obtain a +CustomerIdentifier + +along with the CustomerAWSAccountId and +ProductCode.

      +

    @@ -51,20 +55,23 @@ and Product Code.

    • -

      Paid container software products sold through AWS Marketplace must -integrate with the AWS Marketplace Metering Service and call the RegisterUsage -operation for software entitlement and metering. Free and BYOL products for -Amazon ECS or Amazon EKS aren't required to call RegisterUsage, but you can do -so if you want to receive usage data in your seller reports. For more -information on using the RegisterUsage operation, see Container-Based Products.

      +

      Paid container software products sold through AWS Marketplace must integrate +with the AWS Marketplace Metering Service and call the +RegisterUsage operation for software entitlement and metering. +Free and BYOL products for Amazon ECS or Amazon EKS aren't required to call +RegisterUsage, but you can do so if you want to receive usage +data in your seller reports. For more information on using the +RegisterUsage operation, see Container-Based Products.

    -

    BatchMeterUsage API calls are captured by AWS CloudTrail. You can use Cloudtrail to -verify that the SaaS metering records that you sent are accurate by searching for -records with the eventName of BatchMeterUsage. You can also use CloudTrail to audit -records over time. For more information, see the -AWS CloudTrail User Guide -.

    +

    +BatchMeterUsage API calls are captured by AWS CloudTrail. You can use +Cloudtrail to verify that the SaaS metering records that you sent are accurate by +searching for records with the eventName of BatchMeterUsage. +You can also use CloudTrail to audit records over time. For more information, see the + +AWS CloudTrail User Guide. +

    ## Installing diff --git a/clients/client-marketplace-metering/src/MarketplaceMetering.ts b/clients/client-marketplace-metering/src/MarketplaceMetering.ts index f02da7ef0ed75..375df3bb82453 100644 --- a/clients/client-marketplace-metering/src/MarketplaceMetering.ts +++ b/clients/client-marketplace-metering/src/MarketplaceMetering.ts @@ -20,28 +20,28 @@ import { MarketplaceMeteringClient } from "./MarketplaceMeteringClient"; /** * AWS Marketplace Metering Service - *

    This reference provides descriptions of the low-level AWS Marketplace Metering - * Service API.

    + *

    This reference provides descriptions of the low-level AWS Marketplace Metering Service + * API.

    *

    AWS Marketplace sellers can use this API to submit usage data for custom usage * dimensions.

    - *

    For information on the permissions you need to use this API, see - * AWS Marketing metering and entitlement API permissions in the AWS Marketplace Seller Guide. - *

    + *

    For information on the permissions you need to use this API, see AWS Marketplace metering and entitlement API permissions in the + * AWS Marketplace Seller Guide. + *

    *

    * Submitting Metering Records *

    *
      *
    • *

      - * MeterUsage- Submits the metering record for a Marketplace - * product. MeterUsage is called from an EC2 instance or a container running on EKS - * or ECS.

      + * MeterUsage - Submits the metering record for an AWS + * Marketplace product. MeterUsage is called from an EC2 instance or a + * container running on EKS or ECS.

      *
      • *
    • *

      - * BatchMeterUsage- Submits the metering record for a set of - * customers. BatchMeterUsage is called from a software-as-a-service (SaaS) - * application.

      + * BatchMeterUsage - Submits the metering record for a set of + * customers. BatchMeterUsage is called from a software-as-a-service + * (SaaS) application.

      *
      • *
    *

    @@ -50,11 +50,14 @@ import { MarketplaceMeteringClient } from "./MarketplaceMeteringClient"; *

      *
    • *

      - * ResolveCustomer- Called by a SaaS application during the + * ResolveCustomer - Called by a SaaS application during the * registration process. When a buyer visits your website during the registration * process, the buyer submits a Registration Token through the browser. The - * Registration Token is resolved through this API to obtain a CustomerIdentifier - * and Product Code.

      + * Registration Token is resolved through this API to obtain a + * CustomerIdentifier + * + * along with the CustomerAWSAccountId and + * ProductCode.

      *
      • *
    *

    @@ -62,34 +65,53 @@ import { MarketplaceMeteringClient } from "./MarketplaceMeteringClient"; *

    *
      *
    • - *

      Paid container software products sold through AWS Marketplace must - * integrate with the AWS Marketplace Metering Service and call the RegisterUsage - * operation for software entitlement and metering. Free and BYOL products for - * Amazon ECS or Amazon EKS aren't required to call RegisterUsage, but you can do - * so if you want to receive usage data in your seller reports. For more - * information on using the RegisterUsage operation, see Container-Based Products.

      + *

      Paid container software products sold through AWS Marketplace must integrate + * with the AWS Marketplace Metering Service and call the + * RegisterUsage operation for software entitlement and metering. + * Free and BYOL products for Amazon ECS or Amazon EKS aren't required to call + * RegisterUsage, but you can do so if you want to receive usage + * data in your seller reports. For more information on using the + * RegisterUsage operation, see Container-Based Products.

      *
      • *
    - *

    BatchMeterUsage API calls are captured by AWS CloudTrail. You can use Cloudtrail to - * verify that the SaaS metering records that you sent are accurate by searching for - * records with the eventName of BatchMeterUsage. You can also use CloudTrail to audit - * records over time. For more information, see the - * AWS CloudTrail User Guide - * .

    + *

    + * BatchMeterUsage API calls are captured by AWS CloudTrail. You can use + * Cloudtrail to verify that the SaaS metering records that you sent are accurate by + * searching for records with the eventName of BatchMeterUsage. + * You can also use CloudTrail to audit records over time. For more information, see the + * + * AWS CloudTrail User Guide. + *

    */ export class MarketplaceMetering extends MarketplaceMeteringClient { /** - *

    BatchMeterUsage is called from a SaaS application listed on the AWS Marketplace to - * post metering records for a set of customers.

    - *

    For identical requests, the API is idempotent; requests can be retried with the - * same records or a subset of the input records.

    - *

    Every request to BatchMeterUsage is for one product. If you need to meter usage for - * multiple products, you must make multiple calls to BatchMeterUsage.

    - *

    BatchMeterUsage can process up to 25 UsageRecords at a time.

    - *

    A UsageRecord can optionally include multiple usage allocations, to provide customers - * with usagedata split into buckets by tags that you define (or allow the customer to - * define).

    - *

    BatchMeterUsage requests must be less than 1MB in size.

    + *

    + * BatchMeterUsage is called from a SaaS application listed on AWS + * Marketplace to post metering records for a set of customers.

    + *

    For identical requests, the API is idempotent; requests can be retried with the same + * records or a subset of the input records.

    + *

    Every request to BatchMeterUsage is for one product. If you need to meter + * usage for multiple products, you must make multiple calls to + * BatchMeterUsage.

    + *

    Usage records are expected to be submitted as quickly as possible after the event that + * is being recorded, and are not accepted more than 6 hours after the event.

    + *

    + * BatchMeterUsage can process up to 25 UsageRecords at a + * time.

    + *

    A UsageRecord can optionally include multiple usage allocations, to + * provide customers with usage data split into buckets by tags that you define (or allow + * the customer to define).

    + *

    + * BatchMeterUsage returns a list of UsageRecordResult objects, + * showing the result for each UsageRecord, as well as a list of + * UnprocessedRecords, indicating errors in the service side that you + * should retry.

    + *

    + * BatchMeterUsage requests must be less than 1MB in size.

    + * + *

    For an example of using BatchMeterUsage, see BatchMeterUsage code example in the AWS Marketplace Seller + * Guide.

    + *     */ public batchMeterUsage( args: BatchMeterUsageCommandInput, @@ -121,13 +143,17 @@ export class MarketplaceMetering extends MarketplaceMeteringClient { } /** - *

    API to emit metering records. For identical requests, the API is idempotent. It - * simply returns the metering record ID.

    - *

    MeterUsage is authenticated on the buyer's AWS account using credentials from the - * EC2 instance, ECS task, or EKS pod.

    - *

    MeterUsage can optionally include multiple usage allocations, to provide customers - * with usage data split into buckets by tags that you define (or allow the customer to - * define).

    + *

    API to emit metering records. For identical requests, the API is idempotent. It simply + * returns the metering record ID.

    + *

    + * MeterUsage is authenticated on the buyer's AWS account using credentials + * from the EC2 instance, ECS task, or EKS pod.

    + *

    + * MeterUsage can optionally include multiple usage allocations, to provide + * customers with usage data split into buckets by tags that you define (or allow the + * customer to define).

    + *

    Usage records are expected to be submitted as quickly as possible after the event that + * is being recorded, and are not accepted more than 6 hours after the event.

    */ public meterUsage(args: MeterUsageCommandInput, options?: __HttpHandlerOptions): Promise; public meterUsage(args: MeterUsageCommandInput, cb: (err: any, data?: MeterUsageCommandOutput) => void): void; @@ -153,43 +179,44 @@ export class MarketplaceMetering extends MarketplaceMeteringClient { } /** - *

    Paid container software products sold through AWS Marketplace must integrate with - * the AWS Marketplace Metering Service and call the RegisterUsage operation for software - * entitlement and metering. Free and BYOL products for Amazon ECS or Amazon EKS aren't - * required to call RegisterUsage, but you may choose to do so if you would like to receive - * usage data in your seller reports. The sections below explain the behavior of - * RegisterUsage. RegisterUsage performs two primary functions: metering and - * entitlement.

    - * + *

    Paid container software products sold through AWS Marketplace must integrate with the + * AWS Marketplace Metering Service and call the RegisterUsage operation for + * software entitlement and metering. Free and BYOL products for Amazon ECS or Amazon EKS + * aren't required to call RegisterUsage, but you may choose to do so if you + * would like to receive usage data in your seller reports. The sections below explain the + * behavior of RegisterUsage. RegisterUsage performs two primary + * functions: metering and entitlement.

    *
      *
    • *

      - * Entitlement: RegisterUsage allows you to verify that the - * customer running your paid software is subscribed to your product on AWS - * Marketplace, enabling you to guard against unauthorized use. Your container - * image that integrates with RegisterUsage is only required to guard against - * unauthorized use at container startup, as such a - * CustomerNotSubscribedException/PlatformNotSupportedException will only be thrown - * on the initial call to RegisterUsage. Subsequent calls from the same Amazon ECS - * task instance (e.g. task-id) or Amazon EKS pod will not throw a - * CustomerNotSubscribedException, even if the customer unsubscribes while the - * Amazon ECS task or Amazon EKS pod is still running.

      + * Entitlement: RegisterUsage allows you to + * verify that the customer running your paid software is subscribed to your + * product on AWS Marketplace, enabling you to guard against unauthorized use. Your + * container image that integrates with RegisterUsage is only required + * to guard against unauthorized use at container startup, as such a + * CustomerNotSubscribedException or + * PlatformNotSupportedException will only be thrown on the + * initial call to RegisterUsage. Subsequent calls from the same + * Amazon ECS task instance (e.g. task-id) or Amazon EKS pod will not throw a + * CustomerNotSubscribedException, even if the customer + * unsubscribes while the Amazon ECS task or Amazon EKS pod is still + * running.

      *
      • *
    • *

      - * Metering: RegisterUsage meters software use per ECS task, - * per hour, or per pod for Amazon EKS with usage prorated to the second. A minimum - * of 1 minute of usage applies to tasks that are short lived. For example, if a - * customer has a 10 node Amazon ECS or Amazon EKS cluster and a service configured - * as a Daemon Set, then Amazon ECS or Amazon EKS will launch a task on all 10 - * cluster nodes and the customer will be charged: (10 * hourly_rate). Metering for - * software use is automatically handled by the AWS Marketplace Metering Control - * Plane -- your software is not required to perform any metering specific actions, - * other than call RegisterUsage once for metering of software use to commence. The - * AWS Marketplace Metering Control Plane will also continue to bill customers for - * running ECS tasks and Amazon EKS pods, regardless of the customers subscription - * state, removing the need for your software to perform entitlement checks at - * runtime.

      + * Metering: RegisterUsage meters software use + * per ECS task, per hour, or per pod for Amazon EKS with usage prorated to the + * second. A minimum of 1 minute of usage applies to tasks that are short lived. + * For example, if a customer has a 10 node Amazon ECS or Amazon EKS cluster and a + * service configured as a Daemon Set, then Amazon ECS or Amazon EKS will launch a + * task on all 10 cluster nodes and the customer will be charged: (10 * + * hourly_rate). Metering for software use is automatically handled by the AWS + * Marketplace Metering Control Plane -- your software is not required to perform + * any metering specific actions, other than call RegisterUsage once + * for metering of software use to commence. The AWS Marketplace Metering Control + * Plane will also continue to bill customers for running ECS tasks and Amazon EKS + * pods, regardless of the customers subscription state, removing the need for your + * software to perform entitlement checks at runtime.

      *
      • *
    */ @@ -223,10 +250,20 @@ export class MarketplaceMetering extends MarketplaceMeteringClient { } /** - *

    ResolveCustomer is called by a SaaS application during the registration process. - * When a buyer visits your website during the registration process, the buyer submits a - * registration token through their browser. The registration token is resolved through - * this API to obtain a CustomerIdentifier and product code.

    + *

    + * ResolveCustomer is called by a SaaS application during the registration + * process. When a buyer visits your website during the registration process, the buyer + * submits a registration token through their browser. The registration token is resolved + * through this API to obtain a CustomerIdentifier + * along with the + * CustomerAWSAccountId and + * ProductCode.

    + * + *

    The API needs to called from the seller account id used to publish the SaaS + * application to successfully resolve the token.

    + *

    For an example of using ResolveCustomer, see ResolveCustomer code example in the AWS Marketplace Seller + * Guide.

    + *     */ public resolveCustomer( args: ResolveCustomerCommandInput, diff --git a/clients/client-marketplace-metering/src/MarketplaceMeteringClient.ts b/clients/client-marketplace-metering/src/MarketplaceMeteringClient.ts index 54083d3af8752..8ad08ca06c124 100644 --- a/clients/client-marketplace-metering/src/MarketplaceMeteringClient.ts +++ b/clients/client-marketplace-metering/src/MarketplaceMeteringClient.ts @@ -223,28 +223,28 @@ export interface MarketplaceMeteringClientResolvedConfig extends MarketplaceMete /** * AWS Marketplace Metering Service - *

    This reference provides descriptions of the low-level AWS Marketplace Metering - * Service API.

    + *

    This reference provides descriptions of the low-level AWS Marketplace Metering Service + * API.

    *

    AWS Marketplace sellers can use this API to submit usage data for custom usage * dimensions.

    - *

    For information on the permissions you need to use this API, see - * AWS Marketing metering and entitlement API permissions in the AWS Marketplace Seller Guide. - *

    + *

    For information on the permissions you need to use this API, see AWS Marketplace metering and entitlement API permissions in the + * AWS Marketplace Seller Guide. + *

    *

    * Submitting Metering Records *

    *
      *
    • *

      - * MeterUsage- Submits the metering record for a Marketplace - * product. MeterUsage is called from an EC2 instance or a container running on EKS - * or ECS.

      + * MeterUsage - Submits the metering record for an AWS + * Marketplace product. MeterUsage is called from an EC2 instance or a + * container running on EKS or ECS.

      *
      • *
    • *

      - * BatchMeterUsage- Submits the metering record for a set of - * customers. BatchMeterUsage is called from a software-as-a-service (SaaS) - * application.

      + * BatchMeterUsage - Submits the metering record for a set of + * customers. BatchMeterUsage is called from a software-as-a-service + * (SaaS) application.

      *
      • *
    *

    @@ -253,11 +253,14 @@ export interface MarketplaceMeteringClientResolvedConfig extends MarketplaceMete *

      *
    • *

      - * ResolveCustomer- Called by a SaaS application during the + * ResolveCustomer - Called by a SaaS application during the * registration process. When a buyer visits your website during the registration * process, the buyer submits a Registration Token through the browser. The - * Registration Token is resolved through this API to obtain a CustomerIdentifier - * and Product Code.

      + * Registration Token is resolved through this API to obtain a + * CustomerIdentifier + * + * along with the CustomerAWSAccountId and + * ProductCode.

      *
      • *
    *

    @@ -265,20 +268,23 @@ export interface MarketplaceMeteringClientResolvedConfig extends MarketplaceMete *

    *
      *
    • - *

      Paid container software products sold through AWS Marketplace must - * integrate with the AWS Marketplace Metering Service and call the RegisterUsage - * operation for software entitlement and metering. Free and BYOL products for - * Amazon ECS or Amazon EKS aren't required to call RegisterUsage, but you can do - * so if you want to receive usage data in your seller reports. For more - * information on using the RegisterUsage operation, see Container-Based Products.

      + *

      Paid container software products sold through AWS Marketplace must integrate + * with the AWS Marketplace Metering Service and call the + * RegisterUsage operation for software entitlement and metering. + * Free and BYOL products for Amazon ECS or Amazon EKS aren't required to call + * RegisterUsage, but you can do so if you want to receive usage + * data in your seller reports. For more information on using the + * RegisterUsage operation, see Container-Based Products.

      *
      • *
    - *

    BatchMeterUsage API calls are captured by AWS CloudTrail. You can use Cloudtrail to - * verify that the SaaS metering records that you sent are accurate by searching for - * records with the eventName of BatchMeterUsage. You can also use CloudTrail to audit - * records over time. For more information, see the - * AWS CloudTrail User Guide - * .

    + *

    + * BatchMeterUsage API calls are captured by AWS CloudTrail. You can use + * Cloudtrail to verify that the SaaS metering records that you sent are accurate by + * searching for records with the eventName of BatchMeterUsage. + * You can also use CloudTrail to audit records over time. For more information, see the + * + * AWS CloudTrail User Guide. + *

    */ export class MarketplaceMeteringClient extends __Client< __HttpHandlerOptions, diff --git a/clients/client-marketplace-metering/src/commands/BatchMeterUsageCommand.ts b/clients/client-marketplace-metering/src/commands/BatchMeterUsageCommand.ts index 7fd195c1f95de..dac5a1c56fe00 100644 --- a/clients/client-marketplace-metering/src/commands/BatchMeterUsageCommand.ts +++ b/clients/client-marketplace-metering/src/commands/BatchMeterUsageCommand.ts @@ -26,17 +26,33 @@ export interface BatchMeterUsageCommandInput extends BatchMeterUsageRequest {} export interface BatchMeterUsageCommandOutput extends BatchMeterUsageResult, __MetadataBearer {} /** - *

    BatchMeterUsage is called from a SaaS application listed on the AWS Marketplace to - * post metering records for a set of customers.

    - *

    For identical requests, the API is idempotent; requests can be retried with the - * same records or a subset of the input records.

    - *

    Every request to BatchMeterUsage is for one product. If you need to meter usage for - * multiple products, you must make multiple calls to BatchMeterUsage.

    - *

    BatchMeterUsage can process up to 25 UsageRecords at a time.

    - *

    A UsageRecord can optionally include multiple usage allocations, to provide customers - * with usagedata split into buckets by tags that you define (or allow the customer to - * define).

    - *

    BatchMeterUsage requests must be less than 1MB in size.

    + *

    + * BatchMeterUsage is called from a SaaS application listed on AWS + * Marketplace to post metering records for a set of customers.

    + *

    For identical requests, the API is idempotent; requests can be retried with the same + * records or a subset of the input records.

    + *

    Every request to BatchMeterUsage is for one product. If you need to meter + * usage for multiple products, you must make multiple calls to + * BatchMeterUsage.

    + *

    Usage records are expected to be submitted as quickly as possible after the event that + * is being recorded, and are not accepted more than 6 hours after the event.

    + *

    + * BatchMeterUsage can process up to 25 UsageRecords at a + * time.

    + *

    A UsageRecord can optionally include multiple usage allocations, to + * provide customers with usage data split into buckets by tags that you define (or allow + * the customer to define).

    + *

    + * BatchMeterUsage returns a list of UsageRecordResult objects, + * showing the result for each UsageRecord, as well as a list of + * UnprocessedRecords, indicating errors in the service side that you + * should retry.

    + *

    + * BatchMeterUsage requests must be less than 1MB in size.

    + * + *

    For an example of using BatchMeterUsage, see BatchMeterUsage code example in the AWS Marketplace Seller + * Guide.

    + *     * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-marketplace-metering/src/commands/MeterUsageCommand.ts b/clients/client-marketplace-metering/src/commands/MeterUsageCommand.ts index 91a72b03fcafa..eec29b7a6bdde 100644 --- a/clients/client-marketplace-metering/src/commands/MeterUsageCommand.ts +++ b/clients/client-marketplace-metering/src/commands/MeterUsageCommand.ts @@ -26,13 +26,17 @@ export interface MeterUsageCommandInput extends MeterUsageRequest {} export interface MeterUsageCommandOutput extends MeterUsageResult, __MetadataBearer {} /** - *

    API to emit metering records. For identical requests, the API is idempotent. It - * simply returns the metering record ID.

    - *

    MeterUsage is authenticated on the buyer's AWS account using credentials from the - * EC2 instance, ECS task, or EKS pod.

    - *

    MeterUsage can optionally include multiple usage allocations, to provide customers - * with usage data split into buckets by tags that you define (or allow the customer to - * define).

    + *

    API to emit metering records. For identical requests, the API is idempotent. It simply + * returns the metering record ID.

    + *

    + * MeterUsage is authenticated on the buyer's AWS account using credentials + * from the EC2 instance, ECS task, or EKS pod.

    + *

    + * MeterUsage can optionally include multiple usage allocations, to provide + * customers with usage data split into buckets by tags that you define (or allow the + * customer to define).

    + *

    Usage records are expected to be submitted as quickly as possible after the event that + * is being recorded, and are not accepted more than 6 hours after the event.

    * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-marketplace-metering/src/commands/RegisterUsageCommand.ts b/clients/client-marketplace-metering/src/commands/RegisterUsageCommand.ts index 070dd3d214773..0120bf82c3761 100644 --- a/clients/client-marketplace-metering/src/commands/RegisterUsageCommand.ts +++ b/clients/client-marketplace-metering/src/commands/RegisterUsageCommand.ts @@ -26,43 +26,44 @@ export interface RegisterUsageCommandInput extends RegisterUsageRequest {} export interface RegisterUsageCommandOutput extends RegisterUsageResult, __MetadataBearer {} /** - *

    Paid container software products sold through AWS Marketplace must integrate with - * the AWS Marketplace Metering Service and call the RegisterUsage operation for software - * entitlement and metering. Free and BYOL products for Amazon ECS or Amazon EKS aren't - * required to call RegisterUsage, but you may choose to do so if you would like to receive - * usage data in your seller reports. The sections below explain the behavior of - * RegisterUsage. RegisterUsage performs two primary functions: metering and - * entitlement.

    - * + *

    Paid container software products sold through AWS Marketplace must integrate with the + * AWS Marketplace Metering Service and call the RegisterUsage operation for + * software entitlement and metering. Free and BYOL products for Amazon ECS or Amazon EKS + * aren't required to call RegisterUsage, but you may choose to do so if you + * would like to receive usage data in your seller reports. The sections below explain the + * behavior of RegisterUsage. RegisterUsage performs two primary + * functions: metering and entitlement.

    *
      *
    • *

      - * Entitlement: RegisterUsage allows you to verify that the - * customer running your paid software is subscribed to your product on AWS - * Marketplace, enabling you to guard against unauthorized use. Your container - * image that integrates with RegisterUsage is only required to guard against - * unauthorized use at container startup, as such a - * CustomerNotSubscribedException/PlatformNotSupportedException will only be thrown - * on the initial call to RegisterUsage. Subsequent calls from the same Amazon ECS - * task instance (e.g. task-id) or Amazon EKS pod will not throw a - * CustomerNotSubscribedException, even if the customer unsubscribes while the - * Amazon ECS task or Amazon EKS pod is still running.

      + * Entitlement: RegisterUsage allows you to + * verify that the customer running your paid software is subscribed to your + * product on AWS Marketplace, enabling you to guard against unauthorized use. Your + * container image that integrates with RegisterUsage is only required + * to guard against unauthorized use at container startup, as such a + * CustomerNotSubscribedException or + * PlatformNotSupportedException will only be thrown on the + * initial call to RegisterUsage. Subsequent calls from the same + * Amazon ECS task instance (e.g. task-id) or Amazon EKS pod will not throw a + * CustomerNotSubscribedException, even if the customer + * unsubscribes while the Amazon ECS task or Amazon EKS pod is still + * running.

      *
      • *
    • *

      - * Metering: RegisterUsage meters software use per ECS task, - * per hour, or per pod for Amazon EKS with usage prorated to the second. A minimum - * of 1 minute of usage applies to tasks that are short lived. For example, if a - * customer has a 10 node Amazon ECS or Amazon EKS cluster and a service configured - * as a Daemon Set, then Amazon ECS or Amazon EKS will launch a task on all 10 - * cluster nodes and the customer will be charged: (10 * hourly_rate). Metering for - * software use is automatically handled by the AWS Marketplace Metering Control - * Plane -- your software is not required to perform any metering specific actions, - * other than call RegisterUsage once for metering of software use to commence. The - * AWS Marketplace Metering Control Plane will also continue to bill customers for - * running ECS tasks and Amazon EKS pods, regardless of the customers subscription - * state, removing the need for your software to perform entitlement checks at - * runtime.

      + * Metering: RegisterUsage meters software use + * per ECS task, per hour, or per pod for Amazon EKS with usage prorated to the + * second. A minimum of 1 minute of usage applies to tasks that are short lived. + * For example, if a customer has a 10 node Amazon ECS or Amazon EKS cluster and a + * service configured as a Daemon Set, then Amazon ECS or Amazon EKS will launch a + * task on all 10 cluster nodes and the customer will be charged: (10 * + * hourly_rate). Metering for software use is automatically handled by the AWS + * Marketplace Metering Control Plane -- your software is not required to perform + * any metering specific actions, other than call RegisterUsage once + * for metering of software use to commence. The AWS Marketplace Metering Control + * Plane will also continue to bill customers for running ECS tasks and Amazon EKS + * pods, regardless of the customers subscription state, removing the need for your + * software to perform entitlement checks at runtime.

      *
      • *
    * @example diff --git a/clients/client-marketplace-metering/src/commands/ResolveCustomerCommand.ts b/clients/client-marketplace-metering/src/commands/ResolveCustomerCommand.ts index 182f81a6e0dd3..66c9ff4602db8 100644 --- a/clients/client-marketplace-metering/src/commands/ResolveCustomerCommand.ts +++ b/clients/client-marketplace-metering/src/commands/ResolveCustomerCommand.ts @@ -26,10 +26,20 @@ export interface ResolveCustomerCommandInput extends ResolveCustomerRequest {} export interface ResolveCustomerCommandOutput extends ResolveCustomerResult, __MetadataBearer {} /** - *

    ResolveCustomer is called by a SaaS application during the registration process. - * When a buyer visits your website during the registration process, the buyer submits a - * registration token through their browser. The registration token is resolved through - * this API to obtain a CustomerIdentifier and product code.

    + *

    + * ResolveCustomer is called by a SaaS application during the registration + * process. When a buyer visits your website during the registration process, the buyer + * submits a registration token through their browser. The registration token is resolved + * through this API to obtain a CustomerIdentifier + * along with the + * CustomerAWSAccountId and + * ProductCode.

    + * + *

    The API needs to called from the seller account id used to publish the SaaS + * application to successfully resolve the token.

    + *

    For an example of using ResolveCustomer, see ResolveCustomer code example in the AWS Marketplace Seller + * Guide.

    + *     * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-marketplace-metering/src/models/models_0.ts b/clients/client-marketplace-metering/src/models/models_0.ts index a24994e96ee1a..900d4700b42d8 100644 --- a/clients/client-marketplace-metering/src/models/models_0.ts +++ b/clients/client-marketplace-metering/src/models/models_0.ts @@ -1,18 +1,19 @@ import { MetadataBearer as $MetadataBearer, SmithyException as __SmithyException } from "@aws-sdk/types"; /** - *

    Metadata assigned to an allocation. Each tag is made up of a key and a value.

    + *

    Metadata assigned to an allocation. Each tag is made up of a key and a + * value.

    */ export interface Tag { /** - *

    One part of a key-value pair that makes up a tag. A key is a label that acts like a - * category for the specific tag values.

    + *

    One part of a key-value pair that makes up a tag. A key is a + * label that acts like a category for the specific tag values.

    */ Key: string | undefined; /** - *

    One part of a key-value pair that makes up a tag. A value acts as a descriptor within - * a tag category (key). The value can be empty or null.

    + *

    One part of a key-value pair that makes up a tag. A value + * acts as a descriptor within a tag category (key). The value can be empty or null.

    */ Value: string | undefined; } @@ -28,7 +29,8 @@ export namespace Tag { /** *

    Usage allocations allow you to split usage into buckets by tags.

    - *

    Each UsageAllocation indicates the usage quantity for a specific set of tags.

    + *

    Each UsageAllocation indicates the usage quantity for a specific set of + * tags.

    */ export interface UsageAllocation { /** @@ -37,8 +39,8 @@ export interface UsageAllocation { AllocatedUsageQuantity: number | undefined; /** - *

    The set of tags that define the bucket of usage. For the bucket of items with no - * tags, this parameter can be left out.

    + *

    The set of tags that define the bucket of usage. For the bucket of items with no tags, + * this parameter can be left out.

    */ Tags?: Tag[]; } @@ -53,29 +55,29 @@ export namespace UsageAllocation { } /** - *

    A UsageRecord indicates a quantity of usage for a given product, customer, - * dimension and time.

    - *

    Multiple requests with the same UsageRecords as input will be deduplicated to - * prevent double charges.

    + *

    A UsageRecord indicates a quantity of usage for a given product, + * customer, dimension and time.

    + *

    Multiple requests with the same UsageRecords as input will be + * de-duplicated to prevent double charges.

    */ export interface UsageRecord { /** *

    Timestamp, in UTC, for which the usage is being reported.

    *

    Your application can meter usage for up to one hour in the past. Make sure the - * timestamp value is not before the start of the software usage.

    + * timestamp value is not before the start of the software usage.

    */ Timestamp: Date | undefined; /** - *

    The CustomerIdentifier is obtained through the ResolveCustomer operation and - * represents an individual buyer in your application.

    + *

    The CustomerIdentifier is obtained through the + * ResolveCustomer operation and represents an individual buyer in your + * application.

    */ CustomerIdentifier: string | undefined; /** - *

    During the process of registering a product on AWS Marketplace, up to eight - * dimensions are specified. These represent different units of value in your - * application.

    + *

    During the process of registering a product on AWS Marketplace, dimensions are + * specified. These represent different units of value in your application.

    */ Dimension: string | undefined; @@ -86,8 +88,9 @@ export interface UsageRecord { Quantity?: number; /** - *

    The set of UsageAllocations to submit. The sum of all UsageAllocation quantities - * must equal the Quantity of the UsageRecord.

    + *

    The set of UsageAllocations to submit. The sum of all + * UsageAllocation quantities must equal the Quantity of the + * UsageRecord.

    */ UsageAllocations?: UsageAllocation[]; } @@ -102,20 +105,19 @@ export namespace UsageRecord { } /** - *

    A BatchMeterUsageRequest contains UsageRecords, which indicate quantities of usage - * within your application.

    + *

    A BatchMeterUsageRequest contains UsageRecords, which + * indicate quantities of usage within your application.

    */ export interface BatchMeterUsageRequest { /** - *

    The set of UsageRecords to submit. BatchMeterUsage accepts up to 25 UsageRecords at - * a time.

    + *

    The set of UsageRecords to submit. BatchMeterUsage accepts + * up to 25 UsageRecords at a time.

    */ UsageRecords: UsageRecord[] | undefined; /** *

    Product code is used to uniquely identify a product in AWS Marketplace. The product - * code should be the same as the one used during the publishing of a new - * product.

    + * code should be the same as the one used during the publishing of a new product.

    */ ProductCode: string | undefined; } @@ -136,41 +138,58 @@ export enum UsageRecordResultStatus { } /** - *

    A UsageRecordResult indicates the status of a given UsageRecord processed by - * BatchMeterUsage.

    + *

    A UsageRecordResult indicates the status of a given + * UsageRecord processed by BatchMeterUsage.

    */ export interface UsageRecordResult { /** - *

    The UsageRecord that was part of the BatchMeterUsage request.

    + *

    The UsageRecord that was part of the BatchMeterUsage + * request.

    */ UsageRecord?: UsageRecord; /** - *

    The MeteringRecordId is a unique identifier for this metering event.

    + *

    The MeteringRecordId is a unique identifier for this metering + * event.

    */ MeteringRecordId?: string; /** - *

    The UsageRecordResult Status indicates the status of an individual UsageRecord - * processed by BatchMeterUsage.

    + *

    The UsageRecordResult + * Status indicates the status of an individual UsageRecord + * processed by BatchMeterUsage.

    *
      *
    • *

      - * Success- The UsageRecord was accepted and honored by - * BatchMeterUsage.

      + * Success- The UsageRecord was accepted and + * honored by BatchMeterUsage.

      *
      • *
    • *

      - * CustomerNotSubscribed- The CustomerIdentifier specified is - * not subscribed to your product. The UsageRecord was not honored. Future - * UsageRecords for this customer will fail until the customer subscribes to your - * product.

      + * CustomerNotSubscribed- The CustomerIdentifier + * specified is not able to use your product. The UsageRecord was not + * honored. There are three causes for this result:

      + *
        + *
      • + *

        The customer identifier is invalid.

        + *
        • + *
      • + *

        The customer identifier provided in the metering record does not have + * an active agreement or subscription with this product. Future + * UsageRecords for this customer will fail until the + * customer subscribes to your product.

        + *
        • + *
      • + *

        The customer's AWS account was suspended.

        + *
        • + *
      *
      • *
    • *

      - * DuplicateRecord- Indicates that the UsageRecord was invalid - * and not honored. A previously metered UsageRecord had the same customer, - * dimension, and time, but a different quantity.

      + * DuplicateRecord- Indicates that the + * UsageRecord was invalid and not honored. A previously metered + * UsageRecord had the same customer, dimension, and time, but a + * different quantity.

      *
      • *
    */ @@ -187,20 +206,22 @@ export namespace UsageRecordResult { } /** - *

    Contains the UsageRecords processed by BatchMeterUsage and any records that have - * failed due to transient error.

    + *

    Contains the UsageRecords processed by BatchMeterUsage and + * any records that have failed due to transient error.

    */ export interface BatchMeterUsageResult { /** - *

    Contains all UsageRecords processed by BatchMeterUsage. These records were either - * honored by AWS Marketplace Metering Service or were invalid.

    + *

    Contains all UsageRecords processed by BatchMeterUsage. + * These records were either honored by AWS Marketplace Metering Service or were invalid. + * Invalid records should be fixed before being resubmitted.

    */ Results?: UsageRecordResult[]; /** - *

    Contains all UsageRecords that were not processed by BatchMeterUsage. This is a - * list of UsageRecords. You can retry the failed request by making another BatchMeterUsage - * call with this list as input in the BatchMeterUsageRequest.

    + *

    Contains all UsageRecords that were not processed by + * BatchMeterUsage. This is a list of UsageRecords. You can + * retry the failed request by making another BatchMeterUsage call with this + * list as input in the BatchMeterUsageRequest.

    */ UnprocessedRecords?: UsageRecord[]; } @@ -234,7 +255,8 @@ export interface InternalServiceErrorException extends __SmithyException, $Metad } /** - *

    You have metered usage for a CustomerIdentifier that does not exist.

    + *

    You have metered usage for a CustomerIdentifier that does not + * exist.

    */ export interface InvalidCustomerIdentifierException extends __SmithyException, $MetadataBearer { name: "InvalidCustomerIdentifierException"; @@ -262,8 +284,8 @@ export interface InvalidTagException extends __SmithyException, $MetadataBearer } /** - *

    The usage allocation objects are invalid, or the number of allocations is greater - * than 500 for a single usage record.

    + *

    The usage allocation objects are invalid, or the number of allocations is greater than + * 500 for a single usage record.

    */ export interface InvalidUsageAllocationsException extends __SmithyException, $MetadataBearer { name: "InvalidUsageAllocationsException"; @@ -272,8 +294,8 @@ export interface InvalidUsageAllocationsException extends __SmithyException, $Me } /** - *

    The usage dimension does not match one of the UsageDimensions associated with - * products.

    + *

    The usage dimension does not match one of the UsageDimensions associated + * with products.

    */ export interface InvalidUsageDimensionException extends __SmithyException, $MetadataBearer { name: "InvalidUsageDimensionException"; @@ -291,7 +313,11 @@ export interface ThrottlingException extends __SmithyException, $MetadataBearer } /** - *

    The timestamp value passed in the meterUsage() is out of allowed range.

    + *

    The timestamp value passed in the UsageRecord is out of + * allowed range.

    + *

    For BatchMeterUsage, if any of the records are outside of the allowed + * range, the entire batch is not processed. You must remove invalid records and try + * again.

    */ export interface TimestampOutOfBoundsException extends __SmithyException, $MetadataBearer { name: "TimestampOutOfBoundsException"; @@ -310,9 +336,9 @@ export interface CustomerNotEntitledException extends __SmithyException, $Metada } /** - *

    A metering record has already been emitted by the same EC2 instance, ECS task, or - * EKS pod for the given {usageDimension, timestamp} with a different - * usageQuantity.

    + *

    A metering record has already been emitted by the same EC2 instance, ECS task, or EKS + * pod for the given {usageDimension, timestamp} with a different + * usageQuantity.

    */ export interface DuplicateRequestException extends __SmithyException, $MetadataBearer { name: "DuplicateRequestException"; @@ -334,15 +360,14 @@ export interface InvalidEndpointRegionException extends __SmithyException, $Meta export interface MeterUsageRequest { /** *

    Product code is used to uniquely identify a product in AWS Marketplace. The product - * code should be the same as the one used during the publishing of a new - * product.

    + * code should be the same as the one used during the publishing of a new product.

    */ ProductCode: string | undefined; /** - *

    Timestamp, in UTC, for which the usage is being reported. Your application can - * meter usage for up to one hour in the past. Make sure the timestamp value is not before - * the start of the software usage.

    + *

    Timestamp, in UTC, for which the usage is being reported. Your application can meter + * usage for up to one hour in the past. Make sure the timestamp value is not + * before the start of the software usage.

    */ Timestamp: Date | undefined; @@ -353,24 +378,24 @@ export interface MeterUsageRequest { UsageDimension: string | undefined; /** - *

    Consumption value for the hour. Defaults to 0 if not - * specified.

    + *

    Consumption value for the hour. Defaults to 0 if not specified.

    */ UsageQuantity?: number; /** - *

    Checks whether you have the permissions required for the action, but does not make - * the request. If you have the permissions, the request returns DryRunOperation; - * otherwise, it returns UnauthorizedException. Defaults to false if not - * specified.

    + *

    Checks whether you have the permissions required for the action, but does not make the + * request. If you have the permissions, the request returns DryRunOperation; + * otherwise, it returns UnauthorizedException. Defaults to false + * if not specified.

    */ DryRun?: boolean; /** - *

    The set of UsageAllocations to submit.

    - *

    The sum of all UsageAllocation quantities must equal the - * UsageQuantity of the MeterUsage request, and each UsageAllocation must have a - * unique set of tags (include no tags).

    + *

    The set of UsageAllocations to submit.

    + *

    The sum of all UsageAllocation quantities must equal the + * UsageQuantity of the MeterUsage request, and each + * UsageAllocation must have a unique set of tags (include no + * tags).

    */ UsageAllocations?: UsageAllocation[]; } @@ -410,9 +435,10 @@ export interface InvalidPublicKeyVersionException extends __SmithyException, $Me } /** - *

    RegisterUsage must be called in the same AWS Region the ECS task was launched in. - * This prevents a container from hardcoding a Region (e.g. withRegion(“us-east-1”) when - * calling RegisterUsage.

    + *

    + * RegisterUsage must be called in the same AWS Region the ECS task was + * launched in. This prevents a container from hardcoding a Region (e.g. + * withRegion(“us-east-1”) when calling RegisterUsage.

    */ export interface InvalidRegionException extends __SmithyException, $MetadataBearer { name: "InvalidRegionException"; @@ -433,8 +459,7 @@ export interface PlatformNotSupportedException extends __SmithyException, $Metad export interface RegisterUsageRequest { /** *

    Product code is used to uniquely identify a product in AWS Marketplace. The product - * code should be the same as the one used during the publishing of a new - * product.

    + * code should be the same as the one used during the publishing of a new product.

    */ ProductCode: string | undefined; @@ -444,8 +469,8 @@ export interface RegisterUsageRequest { PublicKeyVersion: number | undefined; /** - *

    (Optional) To scope down the registration to a specific running software instance - * and guard against replay attacks.

    + *

    (Optional) To scope down the registration to a specific running software instance and + * guard against replay attacks.

    */ Nonce?: string; } @@ -481,11 +506,11 @@ export namespace RegisterUsageResult { } /** - *

    The submitted registration token has expired. This can happen if the buyer's - * browser takes too long to redirect to your page, the buyer has resubmitted the - * registration token, or your application has held on to the registration token for too - * long. Your SaaS registration website should redeem this token as soon as it is submitted - * by the buyer's browser.

    + *

    The submitted registration token has expired. This can happen if the buyer's browser + * takes too long to redirect to your page, the buyer has resubmitted the registration + * token, or your application has held on to the registration token for too long. Your SaaS + * registration website should redeem this token as soon as it is submitted by the buyer's + * browser.

    */ export interface ExpiredTokenException extends __SmithyException, $MetadataBearer { name: "ExpiredTokenException"; @@ -503,13 +528,17 @@ export interface InvalidTokenException extends __SmithyException, $MetadataBeare } /** - *

    Contains input to the ResolveCustomer operation.

    + *

    Contains input to the ResolveCustomer operation.

    */ export interface ResolveCustomerRequest { /** - *

    When a buyer visits your website during the registration process, the buyer submits - * a registration token through the browser. The registration token is resolved to obtain a - * CustomerIdentifier and product code.

    + *

    When a buyer visits your website during the registration process, the buyer submits a + * registration token through the browser. The registration token is resolved to obtain a + * CustomerIdentifier + * along with the + * CustomerAWSAccountId + * and + * ProductCode.

    */ RegistrationToken: string | undefined; } @@ -524,23 +553,32 @@ export namespace ResolveCustomerRequest { } /** - *

    The result of the ResolveCustomer operation. Contains the CustomerIdentifier and - * product code.

    + *

    The result of the ResolveCustomer operation. Contains the + * CustomerIdentifier + * + * along with the CustomerAWSAccountId and + * ProductCode.

    */ export interface ResolveCustomerResult { /** - *

    The CustomerIdentifier is used to identify an individual customer in your - * application. Calls to BatchMeterUsage require CustomerIdentifiers for each - * UsageRecord.

    + *

    The CustomerIdentifier is used to identify an individual customer in your + * application. Calls to BatchMeterUsage require + * CustomerIdentifiers for each UsageRecord.

    */ CustomerIdentifier?: string; /** *

    The product code is returned to confirm that the buyer is registering for your - * product. Subsequent BatchMeterUsage calls should be made using this product + * product. Subsequent BatchMeterUsage calls should be made using this product * code.

    */ ProductCode?: string; + + /** + *

    The CustomerAWSAccountId provides the AWS account ID associated with the + * CustomerIdentifier for the individual customer.

    + */ + CustomerAWSAccountId?: string; } export namespace ResolveCustomerResult { diff --git a/clients/client-marketplace-metering/src/protocols/Aws_json1_1.ts b/clients/client-marketplace-metering/src/protocols/Aws_json1_1.ts index 3c11a069521a4..6a24dd02a8d09 100644 --- a/clients/client-marketplace-metering/src/protocols/Aws_json1_1.ts +++ b/clients/client-marketplace-metering/src/protocols/Aws_json1_1.ts @@ -1054,6 +1054,7 @@ const deserializeAws_json1_1RegisterUsageResult = (output: any, context: __Serde const deserializeAws_json1_1ResolveCustomerResult = (output: any, context: __SerdeContext): ResolveCustomerResult => { return { + CustomerAWSAccountId: __expectString(output.CustomerAWSAccountId), CustomerIdentifier: __expectString(output.CustomerIdentifier), ProductCode: __expectString(output.ProductCode), } as any; diff --git a/clients/client-personalize/src/Personalize.ts b/clients/client-personalize/src/Personalize.ts index 9090198778fcd..50aba19e68d58 100644 --- a/clients/client-personalize/src/Personalize.ts +++ b/clients/client-personalize/src/Personalize.ts @@ -869,7 +869,30 @@ export class Personalize extends PersonalizeClient { * request. *

    * + *

    + * Minimum recommendation requests per second + *

    * + *

    When you create a recommender, you can configure the recommender's minimum recommendation requests per second. The minimum recommendation requests per second + * (minRecommendationRequestsPerSecond) specifies the baseline recommendation request throughput provisioned by + * Amazon Personalize. The default minRecommendationRequestsPerSecond is 1. A recommendation request is a single GetRecommendations operation. + * Request throughput is measured in requests per second and Amazon Personalize uses your requests per second to derive + * your requests per hour and the price of your recommender usage. + *

    + *

    + * If your requests per second increases beyond + * minRecommendationRequestsPerSecond, Amazon Personalize auto-scales the provisioned capacity up and down, + * but never below minRecommendationRequestsPerSecond. + * There's a short time delay while the capacity is increased that might cause loss of + * requests.

    + *

    + * Your bill is the greater of either the minimum requests per hour (based on minRecommendationRequestsPerSecond) + * or the actual number of requests. The actual request throughput used is calculated as the average requests/second within a one-hour window. + * + * We recommend starting with the default minRecommendationRequestsPerSecond, track + * your usage using Amazon CloudWatch metrics, and then increase the minRecommendationRequestsPerSecond + * as necessary. + *

    * *

    * Status diff --git a/clients/client-personalize/src/commands/CreateRecommenderCommand.ts b/clients/client-personalize/src/commands/CreateRecommenderCommand.ts index d9f92ab21b30b..2db6073f60697 100644 --- a/clients/client-personalize/src/commands/CreateRecommenderCommand.ts +++ b/clients/client-personalize/src/commands/CreateRecommenderCommand.ts @@ -28,7 +28,30 @@ export interface CreateRecommenderCommandOutput extends CreateRecommenderRespons * request. *

    * + *

    + * Minimum recommendation requests per second + *

    + * + *

    When you create a recommender, you can configure the recommender's minimum recommendation requests per second. The minimum recommendation requests per second + * (minRecommendationRequestsPerSecond) specifies the baseline recommendation request throughput provisioned by + * Amazon Personalize. The default minRecommendationRequestsPerSecond is 1. A recommendation request is a single GetRecommendations operation. + * Request throughput is measured in requests per second and Amazon Personalize uses your requests per second to derive + * your requests per hour and the price of your recommender usage. + *

    + *

    + * If your requests per second increases beyond + * minRecommendationRequestsPerSecond, Amazon Personalize auto-scales the provisioned capacity up and down, + * but never below minRecommendationRequestsPerSecond. + * There's a short time delay while the capacity is increased that might cause loss of + * requests.

    + *

    + * Your bill is the greater of either the minimum requests per hour (based on minRecommendationRequestsPerSecond) + * or the actual number of requests. The actual request throughput used is calculated as the average requests/second within a one-hour window. * + * We recommend starting with the default minRecommendationRequestsPerSecond, track + * your usage using Amazon CloudWatch metrics, and then increase the minRecommendationRequestsPerSecond + * as necessary. + *

    * *

    * Status diff --git a/clients/client-personalize/src/models/models_0.ts b/clients/client-personalize/src/models/models_0.ts index 8a7ce6feff4ce..ff832087ea813 100644 --- a/clients/client-personalize/src/models/models_0.ts +++ b/clients/client-personalize/src/models/models_0.ts @@ -257,7 +257,7 @@ export interface S3DataConfig { /** *

    The Amazon Resource Name (ARN) of the Key Management Service (KMS) key that Amazon Personalize uses to - * encrypt or decrypt the input and output files of a batch inference job.

    + * encrypt or decrypt the input and output files.

    */ kmsKeyArn?: string; } @@ -971,6 +971,12 @@ export interface RecommenderConfig { * (not popular items or similar items).

    */ itemExplorationConfig?: { [key: string]: string }; + + /** + *

    Specifies the requested minimum provisioned recommendation requests per second that + * Amazon Personalize will support.

    + */ + minRecommendationRequestsPerSecond?: number; } export namespace RecommenderConfig { @@ -2958,7 +2964,7 @@ export namespace DescribeRecommenderRequest { /** *

    Provides a summary of the properties of a recommender update. For a complete listing, call the - * DescribeRecommender API.

    + * DescribeRecommender API operation.

    */ export interface RecommenderUpdateSummary { /** diff --git a/clients/client-personalize/src/protocols/Aws_json1_1.ts b/clients/client-personalize/src/protocols/Aws_json1_1.ts index 24526462cb14c..3f3b08279d953 100644 --- a/clients/client-personalize/src/protocols/Aws_json1_1.ts +++ b/clients/client-personalize/src/protocols/Aws_json1_1.ts @@ -5625,6 +5625,10 @@ const serializeAws_json1_1RecommenderConfig = (input: RecommenderConfig, context input.itemExplorationConfig !== null && { itemExplorationConfig: serializeAws_json1_1HyperParameters(input.itemExplorationConfig, context), }), + ...(input.minRecommendationRequestsPerSecond !== undefined && + input.minRecommendationRequestsPerSecond !== null && { + minRecommendationRequestsPerSecond: input.minRecommendationRequestsPerSecond, + }), }; }; @@ -7256,6 +7260,7 @@ const deserializeAws_json1_1RecommenderConfig = (output: any, context: __SerdeCo output.itemExplorationConfig !== undefined && output.itemExplorationConfig !== null ? deserializeAws_json1_1HyperParameters(output.itemExplorationConfig, context) : undefined, + minRecommendationRequestsPerSecond: __expectInt32(output.minRecommendationRequestsPerSecond), } as any; }; diff --git a/clients/client-rbin/README.md b/clients/client-rbin/README.md index adf9545bf1140..40ac5ae4fe83e 100644 --- a/clients/client-rbin/README.md +++ b/clients/client-rbin/README.md @@ -10,17 +10,17 @@ AWS SDK for JavaScript Rbin Client for Node.js, Browser and React Native.

    This is the Recycle Bin API Reference. This documentation provides descriptions and syntax for each of the actions and data types in Recycle Bin.

    -

    Recycle Bin is a snapshot recovery feature that enables you to restore accidentally -deleted snapshots. When using Recycle Bin, if your snapshots are deleted, they are retained -in the Recycle Bin for a time period that you specify.

    - -

    You can restore a snapshot from the Recycle Bin at any time before its retention period -expires. After you restore a snapshot from the Recycle Bin, the snapshot is removed from the -Recycle Bin, and you can then use it in the same way you use any other snapshot in your -account. If the retention period expires and the snapshot is not restored, the snapshot is -permanently deleted from the Recycle Bin and is no longer available for recovery. For more +

    Recycle Bin is a resource recovery feature that enables you to restore accidentally +deleted snapshots and EBS-backed AMIs. When using Recycle Bin, if your resources are +deleted, they are retained in the Recycle Bin for a time period that you specify.

    + +

    You can restore a resource from the Recycle Bin at any time before its retention period +expires. After you restore a resource from the Recycle Bin, the resource is removed from the +Recycle Bin, and you can then use it in the same way you use any other resource of that type +in your account. If the retention period expires and the resource is not restored, the resource +is permanently deleted from the Recycle Bin and is no longer available for recovery. For more information about Recycle Bin, see -Recycle Bin in the Amazon EC2 User Guide.

    +Recycle Bin in the Amazon Elastic Compute Cloud User Guide.

    ## Installing diff --git a/clients/client-rbin/src/Rbin.ts b/clients/client-rbin/src/Rbin.ts index e5d04c03cfef9..de610a9be6ec9 100644 --- a/clients/client-rbin/src/Rbin.ts +++ b/clients/client-rbin/src/Rbin.ts @@ -22,22 +22,22 @@ import { RbinClient } from "./RbinClient"; *

    This is the Recycle Bin API Reference. This documentation provides * descriptions and syntax for each of the actions and data types in Recycle Bin.

    * - *

    Recycle Bin is a snapshot recovery feature that enables you to restore accidentally - * deleted snapshots. When using Recycle Bin, if your snapshots are deleted, they are retained - * in the Recycle Bin for a time period that you specify.

    + *

    Recycle Bin is a resource recovery feature that enables you to restore accidentally + * deleted snapshots and EBS-backed AMIs. When using Recycle Bin, if your resources are + * deleted, they are retained in the Recycle Bin for a time period that you specify.

    * - *

    You can restore a snapshot from the Recycle Bin at any time before its retention period - * expires. After you restore a snapshot from the Recycle Bin, the snapshot is removed from the - * Recycle Bin, and you can then use it in the same way you use any other snapshot in your - * account. If the retention period expires and the snapshot is not restored, the snapshot is - * permanently deleted from the Recycle Bin and is no longer available for recovery. For more + *

    You can restore a resource from the Recycle Bin at any time before its retention period + * expires. After you restore a resource from the Recycle Bin, the resource is removed from the + * Recycle Bin, and you can then use it in the same way you use any other resource of that type + * in your account. If the retention period expires and the resource is not restored, the resource + * is permanently deleted from the Recycle Bin and is no longer available for recovery. For more * information about Recycle Bin, see - * Recycle Bin in the Amazon EC2 User Guide.

    + * Recycle Bin in the Amazon Elastic Compute Cloud User Guide.

    */ export class Rbin extends RbinClient { /** *

    Creates a Recycle Bin retention rule. For more information, see - * Create Recycle Bin retention rules in the Amazon EC2 User Guide.

    + * Create Recycle Bin retention rules in the Amazon Elastic Compute Cloud User Guide.

    */ public createRule(args: CreateRuleCommandInput, options?: __HttpHandlerOptions): Promise; public createRule(args: CreateRuleCommandInput, cb: (err: any, data?: CreateRuleCommandOutput) => void): void; @@ -64,7 +64,7 @@ export class Rbin extends RbinClient { /** *

    Deletes a Recycle Bin retention rule. For more information, see - * Delete Recycle Bin retention rules in the Amazon EC2 User Guide.

    + * Delete Recycle Bin retention rules in the Amazon Elastic Compute Cloud User Guide.

    */ public deleteRule(args: DeleteRuleCommandInput, options?: __HttpHandlerOptions): Promise; public deleteRule(args: DeleteRuleCommandInput, cb: (err: any, data?: DeleteRuleCommandOutput) => void): void; @@ -142,7 +142,7 @@ export class Rbin extends RbinClient { } /** - *

    Lists the tags assigned a specific resource.

    + *

    Lists the tags assigned to a retention rule.

    */ public listTagsForResource( args: ListTagsForResourceCommandInput, @@ -174,7 +174,7 @@ export class Rbin extends RbinClient { } /** - *

    Assigns tags to the specified resource.

    + *

    Assigns tags to the specified retention rule.

    */ public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise; public tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void; @@ -200,7 +200,7 @@ export class Rbin extends RbinClient { } /** - *

    Unassigns a tag from a resource.

    + *

    Unassigns a tag from a retention rule.

    */ public untagResource( args: UntagResourceCommandInput, @@ -233,7 +233,7 @@ export class Rbin extends RbinClient { /** *

    Updates an existing Recycle Bin retention rule. For more information, see - * Update Recycle Bin retention rules in the Amazon EC2 User Guide.

    + * Update Recycle Bin retention rules in the Amazon Elastic Compute Cloud User Guide.

    */ public updateRule(args: UpdateRuleCommandInput, options?: __HttpHandlerOptions): Promise; public updateRule(args: UpdateRuleCommandInput, cb: (err: any, data?: UpdateRuleCommandOutput) => void): void; diff --git a/clients/client-rbin/src/RbinClient.ts b/clients/client-rbin/src/RbinClient.ts index 61bb934762163..6ec57c864911f 100644 --- a/clients/client-rbin/src/RbinClient.ts +++ b/clients/client-rbin/src/RbinClient.ts @@ -240,17 +240,17 @@ export interface RbinClientResolvedConfig extends RbinClientResolvedConfigType { *

    This is the Recycle Bin API Reference. This documentation provides * descriptions and syntax for each of the actions and data types in Recycle Bin.

    * - *

    Recycle Bin is a snapshot recovery feature that enables you to restore accidentally - * deleted snapshots. When using Recycle Bin, if your snapshots are deleted, they are retained - * in the Recycle Bin for a time period that you specify.

    + *

    Recycle Bin is a resource recovery feature that enables you to restore accidentally + * deleted snapshots and EBS-backed AMIs. When using Recycle Bin, if your resources are + * deleted, they are retained in the Recycle Bin for a time period that you specify.

    * - *

    You can restore a snapshot from the Recycle Bin at any time before its retention period - * expires. After you restore a snapshot from the Recycle Bin, the snapshot is removed from the - * Recycle Bin, and you can then use it in the same way you use any other snapshot in your - * account. If the retention period expires and the snapshot is not restored, the snapshot is - * permanently deleted from the Recycle Bin and is no longer available for recovery. For more + *

    You can restore a resource from the Recycle Bin at any time before its retention period + * expires. After you restore a resource from the Recycle Bin, the resource is removed from the + * Recycle Bin, and you can then use it in the same way you use any other resource of that type + * in your account. If the retention period expires and the resource is not restored, the resource + * is permanently deleted from the Recycle Bin and is no longer available for recovery. For more * information about Recycle Bin, see - * Recycle Bin in the Amazon EC2 User Guide.

    + * Recycle Bin in the Amazon Elastic Compute Cloud User Guide.

    */ export class RbinClient extends __Client< __HttpHandlerOptions, diff --git a/clients/client-rbin/src/commands/CreateRuleCommand.ts b/clients/client-rbin/src/commands/CreateRuleCommand.ts index 12d0767af4a3d..b199efab60957 100644 --- a/clients/client-rbin/src/commands/CreateRuleCommand.ts +++ b/clients/client-rbin/src/commands/CreateRuleCommand.ts @@ -23,7 +23,7 @@ export interface CreateRuleCommandOutput extends CreateRuleResponse, __MetadataB /** *

    Creates a Recycle Bin retention rule. For more information, see - * Create Recycle Bin retention rules in the Amazon EC2 User Guide.

    + * Create Recycle Bin retention rules in the Amazon Elastic Compute Cloud User Guide.

    * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-rbin/src/commands/DeleteRuleCommand.ts b/clients/client-rbin/src/commands/DeleteRuleCommand.ts index c7cf5bb3ebc68..d559eb8252963 100644 --- a/clients/client-rbin/src/commands/DeleteRuleCommand.ts +++ b/clients/client-rbin/src/commands/DeleteRuleCommand.ts @@ -23,7 +23,7 @@ export interface DeleteRuleCommandOutput extends DeleteRuleResponse, __MetadataB /** *

    Deletes a Recycle Bin retention rule. For more information, see - * Delete Recycle Bin retention rules in the Amazon EC2 User Guide.

    + * Delete Recycle Bin retention rules in the Amazon Elastic Compute Cloud User Guide.

    * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-rbin/src/commands/ListTagsForResourceCommand.ts b/clients/client-rbin/src/commands/ListTagsForResourceCommand.ts index 5dbe71fa4f752..c3f2584c6a202 100644 --- a/clients/client-rbin/src/commands/ListTagsForResourceCommand.ts +++ b/clients/client-rbin/src/commands/ListTagsForResourceCommand.ts @@ -22,7 +22,7 @@ export interface ListTagsForResourceCommandInput extends ListTagsForResourceRequ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceResponse, __MetadataBearer {} /** - *

    Lists the tags assigned a specific resource.

    + *

    Lists the tags assigned to a retention rule.

    * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-rbin/src/commands/TagResourceCommand.ts b/clients/client-rbin/src/commands/TagResourceCommand.ts index 689ab4f9a5613..108b2bb59b014 100644 --- a/clients/client-rbin/src/commands/TagResourceCommand.ts +++ b/clients/client-rbin/src/commands/TagResourceCommand.ts @@ -22,7 +22,7 @@ export interface TagResourceCommandInput extends TagResourceRequest {} export interface TagResourceCommandOutput extends TagResourceResponse, __MetadataBearer {} /** - *

    Assigns tags to the specified resource.

    + *

    Assigns tags to the specified retention rule.

    * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-rbin/src/commands/UntagResourceCommand.ts b/clients/client-rbin/src/commands/UntagResourceCommand.ts index 017ba5d5dfb9c..9d7755ea78cec 100644 --- a/clients/client-rbin/src/commands/UntagResourceCommand.ts +++ b/clients/client-rbin/src/commands/UntagResourceCommand.ts @@ -22,7 +22,7 @@ export interface UntagResourceCommandInput extends UntagResourceRequest {} export interface UntagResourceCommandOutput extends UntagResourceResponse, __MetadataBearer {} /** - *

    Unassigns a tag from a resource.

    + *

    Unassigns a tag from a retention rule.

    * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-rbin/src/commands/UpdateRuleCommand.ts b/clients/client-rbin/src/commands/UpdateRuleCommand.ts index 01dac4877c1e3..b395de8e2b8e0 100644 --- a/clients/client-rbin/src/commands/UpdateRuleCommand.ts +++ b/clients/client-rbin/src/commands/UpdateRuleCommand.ts @@ -23,7 +23,7 @@ export interface UpdateRuleCommandOutput extends UpdateRuleResponse, __MetadataB /** *

    Updates an existing Recycle Bin retention rule. For more information, see - * Update Recycle Bin retention rules in the Amazon EC2 User Guide.

    + * Update Recycle Bin retention rules in the Amazon Elastic Compute Cloud User Guide.

    * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-rbin/src/models/models_0.ts b/clients/client-rbin/src/models/models_0.ts index e00b6a676f00e..552acf4981758 100644 --- a/clients/client-rbin/src/models/models_0.ts +++ b/clients/client-rbin/src/models/models_0.ts @@ -1,7 +1,8 @@ import { MetadataBearer as $MetadataBearer, SmithyException as __SmithyException } from "@aws-sdk/types"; /** - *

    Information about a resource tag used to identify resources that are to be retained by a Recycle Bin retention rule.

    + *

    Information about the resource tags used to identify resources that are retained by the retention + * rule.

    */ export interface ResourceTag { /** @@ -26,6 +27,7 @@ export namespace ResourceTag { export enum ResourceType { EBS_SNAPSHOT = "EBS_SNAPSHOT", + EC2_IMAGE = "EC2_IMAGE", } export enum RetentionPeriodUnit { @@ -33,7 +35,7 @@ export enum RetentionPeriodUnit { } /** - *

    Information about the retention period for which a retention rule is to retain resources.

    + *

    Information about the retention period for which the retention rule is to retain resources.

    */ export interface RetentionPeriod { /** @@ -59,7 +61,7 @@ export namespace RetentionPeriod { } /** - *

    Information about the tags assigned to a Recycle Bin retention rule.

    + *

    Information about the tags to assign to the retention rule.

    */ export interface Tag { /** @@ -89,7 +91,7 @@ export interface CreateRuleRequest { RetentionPeriod: RetentionPeriod | undefined; /** - *

    A brief description for the retention rule.

    + *

    The retention rule description.

    */ Description?: string; @@ -99,18 +101,21 @@ export interface CreateRuleRequest { Tags?: Tag[]; /** - *

    The resource type to be retained by the retention rule. Currently, only Amazon EBS snapshots are - * supported.

    + *

    The resource type to be retained by the retention rule. Currently, only Amazon EBS snapshots + * and EBS-backed AMIs are supported. To retain snapshots, specify EBS_SNAPSHOT. To + * retain EBS-backed AMIs, specify EC2_IMAGE.

    */ ResourceType: ResourceType | string | undefined; /** - *

    Information about the resource tags to use to identify resources that are to be retained - * by the retention rule. The retention rule retains only deleted snapshots that have one or more - * of the specified tag key and value pairs. If a snapshot is deleted, but it does not have - * any of the specified tag key and value pairs, it is immediately deleted without being retained - * by the retention rule.

    + *

    Specifies the resource tags to use to identify resources that are to be retained by a + * tag-level retention rule. For tag-level retention rules, only deleted resources, of the specified resource type, that + * have one or more of the specified tag key and value pairs are retained. If a resource is deleted, but it does not have + * any of the specified tag key and value pairs, it is immediately deleted without being retained by the retention rule.

    *

    You can add the same tag key and value pair to a maximum or five retention rules.

    + *

    To create a Region-level retention rule, omit this parameter. A Region-level retention rule + * does not have any resource tags specified. It retains all deleted resources of the specified + * resource type in the Region in which the rule is created, even if the resources are not tagged.

    */ ResourceTags?: ResourceTag[]; } @@ -131,12 +136,12 @@ export enum RuleStatus { export interface CreateRuleResponse { /** - *

    The unique identifier of the retention rule.

    + *

    The unique ID of the retention rule.

    */ Identifier?: string; /** - *

    Information about the retention period for which a retention rule is to retain resources.

    + *

    Information about the retention period for which the retention rule is to retain resources.

    */ RetentionPeriod?: RetentionPeriod; @@ -146,7 +151,7 @@ export interface CreateRuleResponse { Description?: string; /** - *

    The tags assigned to the retention rule.

    + *

    Information about the tags assigned to the retention rule.

    */ Tags?: Tag[]; @@ -162,7 +167,8 @@ export interface CreateRuleResponse { ResourceTags?: ResourceTag[]; /** - *

    The state of the retention rule. Only retention rules that are in the available state retain snapshots.

    + *

    The state of the retention rule. Only retention rules that are in the available + * state retain resources.

    */ Status?: RuleStatus | string; } @@ -222,7 +228,7 @@ export interface ValidationException extends __SmithyException, $MetadataBearer export interface DeleteRuleRequest { /** - *

    The unique ID of the retention rule to delete.

    + *

    The unique ID of the retention rule.

    */ Identifier: string | undefined; } @@ -287,27 +293,29 @@ export interface GetRuleResponse { Identifier?: string; /** - *

    The description assigned to the retention rule.

    + *

    The retention rule description.

    */ Description?: string; /** - *

    The resource type retained by the retention rule. Currently, only Amazon EBS snapshots are supported.

    + *

    The resource type retained by the retention rule.

    */ ResourceType?: ResourceType | string; /** - *

    Information about the period for which the retention rule retains resources.

    + *

    Information about the retention period for which the retention rule is to retain resources.

    */ RetentionPeriod?: RetentionPeriod; /** - *

    The resource tags used to identify resources that are to be retained by the retention rule.

    + *

    Information about the resource tags used to identify resources that are retained by the retention + * rule.

    */ ResourceTags?: ResourceTag[]; /** - *

    The state of the retention rule. Only retention rules that are in the available state retain snapshots.

    + *

    The state of the retention rule. Only retention rules that are in the available + * state retain resources.

    */ Status?: RuleStatus | string; } @@ -323,23 +331,28 @@ export namespace GetRuleResponse { export interface ListRulesRequest { /** - *

    The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error.

    + *

    The maximum number of results to return with a single call. + * To retrieve the remaining results, make another call with the returned NextToken value.

    */ MaxResults?: number; /** - *

    The token to use to retrieve the next page of results.

    + *

    The token for the next page of results.

    */ NextToken?: string; /** - *

    The resource type retained by the retention rule. Only retention rules that retain the specified resource type - * are listed.

    + *

    The resource type retained by the retention rule. Only retention rules that retain + * the specified resource type are listed. Currently, only Amazon EBS snapshots and EBS-backed + * AMIs are supported. To list retention rules that retain snapshots, specify + * EBS_SNAPSHOT. To list retention rules that retain EBS-backed AMIs, specify + * EC2_IMAGE.

    */ ResourceType: ResourceType | string | undefined; /** - *

    The tags used to identify resources that are to be retained by the retention rule.

    + *

    Information about the resource tags used to identify resources that are retained by the retention + * rule.

    */ ResourceTags?: ResourceTag[]; } @@ -363,12 +376,12 @@ export interface RuleSummary { Identifier?: string; /** - *

    The description for the retention rule.

    + *

    The retention rule description.

    */ Description?: string; /** - *

    Information about the retention period for which the retention rule retains resources

    + *

    Information about the retention period for which the retention rule is to retain resources.

    */ RetentionPeriod?: RetentionPeriod; } @@ -405,7 +418,7 @@ export namespace ListRulesResponse { export interface ListTagsForResourceRequest { /** - *

    The Amazon Resource Name (ARN) of the resource for which to list the tags.

    + *

    The Amazon Resource Name (ARN) of the retention rule.

    */ ResourceArn: string | undefined; } @@ -421,7 +434,7 @@ export namespace ListTagsForResourceRequest { export interface ListTagsForResourceResponse { /** - *

    Information about the tags assigned to the resource.

    + *

    Information about the tags assigned to the retention rule.

    */ Tags?: Tag[]; } @@ -437,12 +450,12 @@ export namespace ListTagsForResourceResponse { export interface TagResourceRequest { /** - *

    The Amazon Resource Name (ARN) of the resource to which to assign the tags.

    + *

    The Amazon Resource Name (ARN) of the retention rule.

    */ ResourceArn: string | undefined; /** - *

    Information about the tags to assign to the resource.

    + *

    Information about the tags to assign to the retention rule.

    */ Tags: Tag[] | undefined; } @@ -469,12 +482,12 @@ export namespace TagResourceResponse { export interface UntagResourceRequest { /** - *

    The Amazon Resource Name (ARN) of the resource from which to unassign the tags.

    + *

    The Amazon Resource Name (ARN) of the retention rule.

    */ ResourceArn: string | undefined; /** - *

    Information about the tags to unassign from the resource.

    + *

    The tag keys of the tags to unassign. All tags that have the specified tag key are unassigned.

    */ TagKeys: string[] | undefined; } @@ -501,7 +514,7 @@ export namespace UntagResourceResponse { export interface UpdateRuleRequest { /** - *

    The unique ID of the retention rule to update.

    + *

    The unique ID of the retention rule.

    */ Identifier: string | undefined; @@ -516,17 +529,21 @@ export interface UpdateRuleRequest { Description?: string; /** - *

    The resource type to be retained by the retention rule. Currently, only Amazon EBS snapshots are supported.

    + *

    The resource type to be retained by the retention rule. Currently, only Amazon EBS snapshots + * and EBS-backed AMIs are supported. To retain snapshots, specify EBS_SNAPSHOT. To + * retain EBS-backed AMIs, specify EC2_IMAGE.

    */ ResourceType?: ResourceType | string; /** - *

    Information about the resource tags to use to identify resources that are to be retained - * by the retention rule. The retention rule retains only deleted snapshots that have one or more - * of the specified tag key and value pairs. If a snapshot is deleted, but it does not have - * any of the specified tag key and value pairs, it is immediately deleted without being retained - * by the retention rule.

    + *

    Specifies the resource tags to use to identify resources that are to be retained by a + * tag-level retention rule. For tag-level retention rules, only deleted resources, of the specified resource type, that + * have one or more of the specified tag key and value pairs are retained. If a resource is deleted, but it does not have + * any of the specified tag key and value pairs, it is immediately deleted without being retained by the retention rule.

    *

    You can add the same tag key and value pair to a maximum or five retention rules.

    + *

    To create a Region-level retention rule, omit this parameter. A Region-level retention rule + * does not have any resource tags specified. It retains all deleted resources of the specified + * resource type in the Region in which the rule is created, even if the resources are not tagged.

    */ ResourceTags?: ResourceTag[]; } @@ -547,7 +564,7 @@ export interface UpdateRuleResponse { Identifier?: string; /** - *

    Information about the retention period for which a retention rule is to retain resources.

    + *

    Information about the retention period for which the retention rule is to retain resources.

    */ RetentionPeriod?: RetentionPeriod; @@ -568,7 +585,8 @@ export interface UpdateRuleResponse { ResourceTags?: ResourceTag[]; /** - *

    The state of the retention rule. Only retention rules that are in the available state retain snapshots.

    + *

    The state of the retention rule. Only retention rules that are in the available + * state retain resources.

    */ Status?: RuleStatus | string; } diff --git a/clients/client-rds/src/RDS.ts b/clients/client-rds/src/RDS.ts index e4d5a2422e02f..0ead44368eb81 100644 --- a/clients/client-rds/src/RDS.ts +++ b/clients/client-rds/src/RDS.ts @@ -1336,8 +1336,15 @@ export class RDS extends RDSClient { /** *

    Creates a custom DB engine version (CEV). A CEV is a binary volume snapshot of a database engine and specific - * AMI. The only supported engine is Oracle Database 19c Enterprise Edition with the January 2021 or later - * RU/RUR.

    + * AMI. The supported engines are the following:

    + *
      + *
    • + *

      Oracle Database 12.1 Enterprise Edition with the January 2021 or later RU/RUR

      + *
      • + *
    • + *

      Oracle Database 19c Enterprise Edition with the January 2021 or later RU/RUR

      + *
      • + *
    *

    Amazon RDS, which is a fully managed service, supplies the Amazon Machine Image (AMI) and database software. * The Amazon RDS database software is preinstalled, so you need only select a DB engine and version, and create * your database. With Amazon RDS Custom for Oracle, you upload your database installation files in Amazon S3.

    diff --git a/clients/client-rds/src/commands/CreateCustomDBEngineVersionCommand.ts b/clients/client-rds/src/commands/CreateCustomDBEngineVersionCommand.ts index b96e939659959..6c0b5cbe7c92a 100644 --- a/clients/client-rds/src/commands/CreateCustomDBEngineVersionCommand.ts +++ b/clients/client-rds/src/commands/CreateCustomDBEngineVersionCommand.ts @@ -23,8 +23,15 @@ export interface CreateCustomDBEngineVersionCommandOutput extends DBEngineVersio /** *

    Creates a custom DB engine version (CEV). A CEV is a binary volume snapshot of a database engine and specific - * AMI. The only supported engine is Oracle Database 19c Enterprise Edition with the January 2021 or later - * RU/RUR.

    + * AMI. The supported engines are the following:

    + *
      + *
    • + *

      Oracle Database 12.1 Enterprise Edition with the January 2021 or later RU/RUR

      + *
      • + *
    • + *

      Oracle Database 19c Enterprise Edition with the January 2021 or later RU/RUR

      + *
      • + *
    *

    Amazon RDS, which is a fully managed service, supplies the Amazon Machine Image (AMI) and database software. * The Amazon RDS database software is preinstalled, so you need only select a DB engine and version, and create * your database. With Amazon RDS Custom for Oracle, you upload your database installation files in Amazon S3.

    diff --git a/clients/client-rds/src/models/models_0.ts b/clients/client-rds/src/models/models_0.ts index ca937b0df5f8c..9be54ebdf76ce 100644 --- a/clients/client-rds/src/models/models_0.ts +++ b/clients/client-rds/src/models/models_0.ts @@ -3429,7 +3429,7 @@ export interface CreateDBClusterMessage { *

    A DB subnet group to associate with this DB cluster.

    *

    This setting is required to create a Multi-AZ DB cluster.

    *

    Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.

    - *

    Example: mySubnetgroup + *

    Example: mydbsubnetgroup *

    *

    Valid for: Aurora DB clusters and Multi-AZ DB clusters

    */ @@ -5764,7 +5764,9 @@ export interface CreateDBInstanceMessage { /** *

    A DB subnet group to associate with this DB instance.

    - *

    If there is no DB subnet group, then it is a non-VPC DB instance.

    + *

    Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.

    + *

    Example: mydbsubnetgroup + *

    */ DBSubnetGroupName?: string; @@ -7655,7 +7657,7 @@ export interface CreateDBInstanceReadReplicaMessage { * *
    • * - *

    Example: mySubnetgroup + *

    Example: mydbsubnetgroup *

    */ DBSubnetGroupName?: string; @@ -8812,8 +8814,19 @@ export namespace CreateDBSnapshotResult { export interface CreateDBSubnetGroupMessage { /** *

    The name for the DB subnet group. This value is stored as a lowercase string.

    - *

    Constraints: Must contain no more than 255 letters, numbers, periods, underscores, spaces, or hyphens. Must not be default.

    - *

    Example: mySubnetgroup + *

    Constraints:

    + *
      + *
    • + *

      Must contain no more than 255 letters, numbers, periods, underscores, spaces, or hyphens.

      + *
      • + *
    • + *

      Must not be default.

      + *
      • + *
    • + *

      First character must be a letter.

      + *
      • + *
    + *

    Example: mydbsubnetgroup *

    */ DBSubnetGroupName: string | undefined; @@ -9015,7 +9028,7 @@ export interface EventSubscriptionQuotaExceededFault extends __SmithyException, } /** - *

    SNS has responded that there is a problem with the SND topic specified.

    + *

    SNS has responded that there is a problem with the SNS topic specified.

    */ export interface SNSInvalidTopicFault extends __SmithyException, $MetadataBearer { name: "SNSInvalidTopicFault"; @@ -10333,9 +10346,8 @@ export interface DeleteDBSubnetGroupMessage { * *

    You can't delete the default subnet group.

    *     - *

    Constraints:

    *

    Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.

    - *

    Example: mySubnetgroup + *

    Example: mydbsubnetgroup *

    */ DBSubnetGroupName: string | undefined; diff --git a/clients/client-rds/src/models/models_1.ts b/clients/client-rds/src/models/models_1.ts index c79ec4ec47488..31540e170833f 100644 --- a/clients/client-rds/src/models/models_1.ts +++ b/clients/client-rds/src/models/models_1.ts @@ -4398,7 +4398,7 @@ export interface ModifyDBInstanceMessage { * unless you enable ApplyImmediately.

    *

    This parameter doesn't apply to RDS Custom.

    *

    Constraints: If supplied, must match the name of an existing DBSubnetGroup.

    - *

    Example: mySubnetGroup + *

    Example: mydbsubnetgroup *

    */ DBSubnetGroupName?: string; @@ -5580,7 +5580,7 @@ export interface ModifyDBSubnetGroupMessage { * You can't modify the default subnet group. *

    *

    Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.

    - *

    Example: mySubnetgroup + *

    Example: mydbsubnetgroup *

    */ DBSubnetGroupName: string | undefined; @@ -6674,10 +6674,9 @@ export interface RestoreDBClusterFromS3Message { /** *

    A DB subnet group to associate with the restored DB cluster.

    - *

    Constraints: If supplied, must match the name of an existing DBSubnetGroup. - *

    - *

    Example: mySubnetgroup - *

    + *

    Constraints: If supplied, must match the name of an existing DBSubnetGroup.

    + *

    Example: mydbsubnetgroup + *

    */ DBSubnetGroupName?: string; @@ -7103,7 +7102,7 @@ export interface RestoreDBClusterFromSnapshotMessage { /** *

    The name of the DB subnet group to use for the new DB cluster.

    *

    Constraints: If supplied, must match the name of an existing DB subnet group.

    - *

    Example: mySubnetgroup + *

    Example: mydbsubnetgroup *

    *

    Valid for: Aurora DB clusters and Multi-AZ DB clusters

    */ @@ -7477,7 +7476,7 @@ export interface RestoreDBClusterToPointInTimeMessage { /** *

    The DB subnet group name to use for the new DB cluster.

    *

    Constraints: If supplied, must match the name of an existing DBSubnetGroup.

    - *

    Example: mySubnetgroup + *

    Example: mydbsubnetgroup *

    *

    Valid for: Aurora DB clusters and Multi-AZ DB clusters

    */ @@ -7812,7 +7811,7 @@ export interface RestoreDBInstanceFromDBSnapshotMessage { /** *

    The DB subnet group name to use for the new instance.

    *

    Constraints: If supplied, must match the name of an existing DBSubnetGroup.

    - *

    Example: mySubnetgroup + *

    Example: mydbsubnetgroup *

    */ DBSubnetGroupName?: string; @@ -8007,7 +8006,12 @@ export interface RestoreDBInstanceFromDBSnapshotMessage { Domain?: string; /** - *

    A value that indicates whether to copy all tags from the restored DB instance to snapshots of the DB instance. By default, tags are not copied.

    + *

    A value that indicates whether to copy all tags from the restored DB instance to snapshots of the DB instance.

    + *

    In most cases, tags aren't copied by default. However, when you restore a DB instance from a DB snapshot, RDS checks whether you + * specify new tags. If yes, the new tags are added to the restored DB instance. If there are no new tags, RDS looks for the tags from + * the source DB instance for the DB snapshot, and then adds those tags to the restored DB instance.

    + *

    For more information, see + * Copying tags to DB instance snapshots in the Amazon RDS User Guide.

    */ CopyTagsToSnapshot?: boolean; @@ -8113,8 +8117,7 @@ export interface RestoreDBInstanceFromDBSnapshotMessage { * *

    For the list of permissions required for the IAM role, see * - * Configure IAM and your VPC in the Amazon Relational Database Service - * User Guide.

    + * Configure IAM and your VPC in the Amazon RDS User Guide.

    *

    This setting is required for RDS Custom.

    */ CustomIamInstanceProfile?: string; @@ -8285,6 +8288,9 @@ export interface RestoreDBInstanceFromS3Message { /** *

    A DB subnet group to associate with this DB instance.

    + *

    Constraints: If supplied, must match the name of an existing DBSubnetGroup.

    + *

    Example: mydbsubnetgroup + *

    */ DBSubnetGroupName?: string; @@ -8747,7 +8753,7 @@ export interface RestoreDBInstanceToPointInTimeMessage { /** *

    The DB subnet group name to use for the new instance.

    *

    Constraints: If supplied, must match the name of an existing DBSubnetGroup.

    - *

    Example: mySubnetgroup + *

    Example: mydbsubnetgroup *

    */ DBSubnetGroupName?: string; diff --git a/clients/client-robomaker/src/RoboMaker.ts b/clients/client-robomaker/src/RoboMaker.ts index 700e82457d8ec..1d88483c6846d 100644 --- a/clients/client-robomaker/src/RoboMaker.ts +++ b/clients/client-robomaker/src/RoboMaker.ts @@ -324,7 +324,12 @@ export class RoboMaker extends RoboMakerClient { } /** + * @deprecated + * *

    Cancels the specified deployment job.

    + * + *

    This API will no longer be supported as of May 2, 2022. Use it to remove resources that were created for Deployment Service.

    + *     */ public cancelDeploymentJob( args: CancelDeploymentJobCommandInput, @@ -485,7 +490,12 @@ export class RoboMaker extends RoboMakerClient { } /** + * @deprecated + * *

    Deploys a specific version of a robot application to robots in a fleet.

    + * + *

    This API is no longer supported and will throw an error if used.

    + *     *

    The robot application must have a numbered applicationVersion for * consistency reasons. To create a new version, use * CreateRobotApplicationVersion or see Creating a Robot Application Version.

    @@ -524,7 +534,12 @@ export class RoboMaker extends RoboMakerClient { } /** + * @deprecated + * *

    Creates a fleet, a logical group of robots running the same robot application.

    + * + *

    This API is no longer supported and will throw an error if used.

    + *     */ public createFleet(args: CreateFleetCommandInput, options?: __HttpHandlerOptions): Promise; public createFleet(args: CreateFleetCommandInput, cb: (err: any, data?: CreateFleetCommandOutput) => void): void; @@ -550,7 +565,12 @@ export class RoboMaker extends RoboMakerClient { } /** + * @deprecated + * *

    Creates a robot.

    + * + *

    This API is no longer supported and will throw an error if used.

    + *     */ public createRobot(args: CreateRobotCommandInput, options?: __HttpHandlerOptions): Promise; public createRobot(args: CreateRobotCommandInput, cb: (err: any, data?: CreateRobotCommandOutput) => void): void; @@ -836,7 +856,12 @@ export class RoboMaker extends RoboMakerClient { } /** + * @deprecated + * *

    Deletes a fleet.

    + * + *

    This API will no longer be supported as of May 2, 2022. Use it to remove resources that were created for Deployment Service.

    + *     */ public deleteFleet(args: DeleteFleetCommandInput, options?: __HttpHandlerOptions): Promise; public deleteFleet(args: DeleteFleetCommandInput, cb: (err: any, data?: DeleteFleetCommandOutput) => void): void; @@ -862,7 +887,12 @@ export class RoboMaker extends RoboMakerClient { } /** + * @deprecated + * *

    Deletes a robot.

    + * + *

    This API will no longer be supported as of May 2, 2022. Use it to remove resources that were created for Deployment Service.

    + *     */ public deleteRobot(args: DeleteRobotCommandInput, options?: __HttpHandlerOptions): Promise; public deleteRobot(args: DeleteRobotCommandInput, cb: (err: any, data?: DeleteRobotCommandOutput) => void): void; @@ -984,7 +1014,12 @@ export class RoboMaker extends RoboMakerClient { } /** + * @deprecated + * *

    Deregisters a robot.

    + * + *

    This API will no longer be supported as of May 2, 2022. Use it to remove resources that were created for Deployment Service.

    + *     */ public deregisterRobot( args: DeregisterRobotCommandInput, @@ -1016,7 +1051,12 @@ export class RoboMaker extends RoboMakerClient { } /** + * @deprecated + * *

    Describes a deployment job.

    + * + *

    This API will no longer be supported as of May 2, 2022. Use it to remove resources that were created for Deployment Service.

    + *     */ public describeDeploymentJob( args: DescribeDeploymentJobCommandInput, @@ -1048,7 +1088,12 @@ export class RoboMaker extends RoboMakerClient { } /** + * @deprecated + * *

    Describes a fleet.

    + * + *

    This API will no longer be supported as of May 2, 2022. Use it to remove resources that were created for Deployment Service.

    + *     */ public describeFleet( args: DescribeFleetCommandInput, @@ -1080,7 +1125,12 @@ export class RoboMaker extends RoboMakerClient { } /** + * @deprecated + * *

    Describes a robot.

    + * + *

    This API will no longer be supported as of May 2, 2022. Use it to remove resources that were created for Deployment Service.

    + *     */ public describeRobot( args: DescribeRobotCommandInput, @@ -1400,8 +1450,12 @@ export class RoboMaker extends RoboMakerClient { } /** - *

    Returns a list of deployment jobs for a fleet. You can optionally provide filters to - * retrieve specific deployment jobs.

    + * @deprecated + * + *

    Returns a list of deployment jobs for a fleet. You can optionally provide filters to retrieve specific deployment jobs.

    + * + *

    This API will no longer be supported as of May 2, 2022. Use it to remove resources that were created for Deployment Service.

    + *     */ public listDeploymentJobs( args: ListDeploymentJobsCommandInput, @@ -1433,8 +1487,12 @@ export class RoboMaker extends RoboMakerClient { } /** - *

    Returns a list of fleets. You can optionally provide filters to retrieve specific - * fleets.

    + * @deprecated + * + *

    Returns a list of fleets. You can optionally provide filters to retrieve specific fleets.

    + * + *

    This API will no longer be supported as of May 2, 2022. Use it to remove resources that were created for Deployment Service.

    + *     */ public listFleets(args: ListFleetsCommandInput, options?: __HttpHandlerOptions): Promise; public listFleets(args: ListFleetsCommandInput, cb: (err: any, data?: ListFleetsCommandOutput) => void): void; @@ -1493,8 +1551,12 @@ export class RoboMaker extends RoboMakerClient { } /** - *

    Returns a list of robots. You can optionally provide filters to retrieve specific - * robots.

    + * @deprecated + * + *

    Returns a list of robots. You can optionally provide filters to retrieve specific robots.

    + * + *

    This API will no longer be supported as of May 2, 2022. Use it to remove resources that were created for Deployment Service.

    + *     */ public listRobots(args: ListRobotsCommandInput, options?: __HttpHandlerOptions): Promise; public listRobots(args: ListRobotsCommandInput, cb: (err: any, data?: ListRobotsCommandOutput) => void): void; @@ -1773,7 +1835,12 @@ export class RoboMaker extends RoboMakerClient { } /** + * @deprecated + * *

    Registers a robot with a fleet.

    + * + *

    This API is no longer supported and will throw an error if used.

    + *     */ public registerRobot( args: RegisterRobotCommandInput, @@ -1870,8 +1937,12 @@ export class RoboMaker extends RoboMakerClient { } /** - *

    Syncrhonizes robots in a fleet to the latest deployment. This is helpful if robots were - * added after a deployment.

    + * @deprecated + * + *

    Syncrhonizes robots in a fleet to the latest deployment. This is helpful if robots were added after a deployment.

    + * + *

    This API will no longer be supported as of May 2, 2022. Use it to remove resources that were created for Deployment Service.

    + *     */ public syncDeploymentJob( args: SyncDeploymentJobCommandInput, diff --git a/clients/client-robomaker/src/commands/CancelDeploymentJobCommand.ts b/clients/client-robomaker/src/commands/CancelDeploymentJobCommand.ts index a527722d9c7ad..0a8e62790b36a 100644 --- a/clients/client-robomaker/src/commands/CancelDeploymentJobCommand.ts +++ b/clients/client-robomaker/src/commands/CancelDeploymentJobCommand.ts @@ -22,7 +22,12 @@ export interface CancelDeploymentJobCommandInput extends CancelDeploymentJobRequ export interface CancelDeploymentJobCommandOutput extends CancelDeploymentJobResponse, __MetadataBearer {} /** + * @deprecated + * *

    Cancels the specified deployment job.

    + * + *

    This API will no longer be supported as of May 2, 2022. Use it to remove resources that were created for Deployment Service.

    + *     * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-robomaker/src/commands/CreateDeploymentJobCommand.ts b/clients/client-robomaker/src/commands/CreateDeploymentJobCommand.ts index d03ce3a605cc5..5db0401b924f8 100644 --- a/clients/client-robomaker/src/commands/CreateDeploymentJobCommand.ts +++ b/clients/client-robomaker/src/commands/CreateDeploymentJobCommand.ts @@ -22,7 +22,12 @@ export interface CreateDeploymentJobCommandInput extends CreateDeploymentJobRequ export interface CreateDeploymentJobCommandOutput extends CreateDeploymentJobResponse, __MetadataBearer {} /** + * @deprecated + * *

    Deploys a specific version of a robot application to robots in a fleet.

    + * + *

    This API is no longer supported and will throw an error if used.

    + *     *

    The robot application must have a numbered applicationVersion for * consistency reasons. To create a new version, use * CreateRobotApplicationVersion or see Creating a Robot Application Version.

    diff --git a/clients/client-robomaker/src/commands/CreateFleetCommand.ts b/clients/client-robomaker/src/commands/CreateFleetCommand.ts index 0693288d898b3..710d54c74d4a1 100644 --- a/clients/client-robomaker/src/commands/CreateFleetCommand.ts +++ b/clients/client-robomaker/src/commands/CreateFleetCommand.ts @@ -22,7 +22,12 @@ export interface CreateFleetCommandInput extends CreateFleetRequest {} export interface CreateFleetCommandOutput extends CreateFleetResponse, __MetadataBearer {} /** + * @deprecated + * *

    Creates a fleet, a logical group of robots running the same robot application.

    + * + *

    This API is no longer supported and will throw an error if used.

    + *     * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-robomaker/src/commands/CreateRobotCommand.ts b/clients/client-robomaker/src/commands/CreateRobotCommand.ts index 5911782bc93f1..2394a1c48d547 100644 --- a/clients/client-robomaker/src/commands/CreateRobotCommand.ts +++ b/clients/client-robomaker/src/commands/CreateRobotCommand.ts @@ -22,7 +22,12 @@ export interface CreateRobotCommandInput extends CreateRobotRequest {} export interface CreateRobotCommandOutput extends CreateRobotResponse, __MetadataBearer {} /** + * @deprecated + * *

    Creates a robot.

    + * + *

    This API is no longer supported and will throw an error if used.

    + *     * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-robomaker/src/commands/DeleteFleetCommand.ts b/clients/client-robomaker/src/commands/DeleteFleetCommand.ts index fec023d54ff11..c850630f51289 100644 --- a/clients/client-robomaker/src/commands/DeleteFleetCommand.ts +++ b/clients/client-robomaker/src/commands/DeleteFleetCommand.ts @@ -22,7 +22,12 @@ export interface DeleteFleetCommandInput extends DeleteFleetRequest {} export interface DeleteFleetCommandOutput extends DeleteFleetResponse, __MetadataBearer {} /** + * @deprecated + * *

    Deletes a fleet.

    + * + *

    This API will no longer be supported as of May 2, 2022. Use it to remove resources that were created for Deployment Service.

    + *     * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-robomaker/src/commands/DeleteRobotCommand.ts b/clients/client-robomaker/src/commands/DeleteRobotCommand.ts index 025a30cde0e11..a248571d43dd5 100644 --- a/clients/client-robomaker/src/commands/DeleteRobotCommand.ts +++ b/clients/client-robomaker/src/commands/DeleteRobotCommand.ts @@ -22,7 +22,12 @@ export interface DeleteRobotCommandInput extends DeleteRobotRequest {} export interface DeleteRobotCommandOutput extends DeleteRobotResponse, __MetadataBearer {} /** + * @deprecated + * *

    Deletes a robot.

    + * + *

    This API will no longer be supported as of May 2, 2022. Use it to remove resources that were created for Deployment Service.

    + *     * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-robomaker/src/commands/DeregisterRobotCommand.ts b/clients/client-robomaker/src/commands/DeregisterRobotCommand.ts index c366011aac751..0e137222f4476 100644 --- a/clients/client-robomaker/src/commands/DeregisterRobotCommand.ts +++ b/clients/client-robomaker/src/commands/DeregisterRobotCommand.ts @@ -22,7 +22,12 @@ export interface DeregisterRobotCommandInput extends DeregisterRobotRequest {} export interface DeregisterRobotCommandOutput extends DeregisterRobotResponse, __MetadataBearer {} /** + * @deprecated + * *

    Deregisters a robot.

    + * + *

    This API will no longer be supported as of May 2, 2022. Use it to remove resources that were created for Deployment Service.

    + *     * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-robomaker/src/commands/DescribeDeploymentJobCommand.ts b/clients/client-robomaker/src/commands/DescribeDeploymentJobCommand.ts index c7d13aad8dbc3..417948981101a 100644 --- a/clients/client-robomaker/src/commands/DescribeDeploymentJobCommand.ts +++ b/clients/client-robomaker/src/commands/DescribeDeploymentJobCommand.ts @@ -22,7 +22,12 @@ export interface DescribeDeploymentJobCommandInput extends DescribeDeploymentJob export interface DescribeDeploymentJobCommandOutput extends DescribeDeploymentJobResponse, __MetadataBearer {} /** + * @deprecated + * *

    Describes a deployment job.

    + * + *

    This API will no longer be supported as of May 2, 2022. Use it to remove resources that were created for Deployment Service.

    + *     * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-robomaker/src/commands/DescribeFleetCommand.ts b/clients/client-robomaker/src/commands/DescribeFleetCommand.ts index b1c3a27a6b590..68de227fa1bd8 100644 --- a/clients/client-robomaker/src/commands/DescribeFleetCommand.ts +++ b/clients/client-robomaker/src/commands/DescribeFleetCommand.ts @@ -22,7 +22,12 @@ export interface DescribeFleetCommandInput extends DescribeFleetRequest {} export interface DescribeFleetCommandOutput extends DescribeFleetResponse, __MetadataBearer {} /** + * @deprecated + * *

    Describes a fleet.

    + * + *

    This API will no longer be supported as of May 2, 2022. Use it to remove resources that were created for Deployment Service.

    + *     * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-robomaker/src/commands/DescribeRobotCommand.ts b/clients/client-robomaker/src/commands/DescribeRobotCommand.ts index 9d06ba5e85520..1bea9841407cf 100644 --- a/clients/client-robomaker/src/commands/DescribeRobotCommand.ts +++ b/clients/client-robomaker/src/commands/DescribeRobotCommand.ts @@ -22,7 +22,12 @@ export interface DescribeRobotCommandInput extends DescribeRobotRequest {} export interface DescribeRobotCommandOutput extends DescribeRobotResponse, __MetadataBearer {} /** + * @deprecated + * *

    Describes a robot.

    + * + *

    This API will no longer be supported as of May 2, 2022. Use it to remove resources that were created for Deployment Service.

    + *     * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-robomaker/src/commands/ListDeploymentJobsCommand.ts b/clients/client-robomaker/src/commands/ListDeploymentJobsCommand.ts index b026fb8fbaca4..84e9a1ca18bbf 100644 --- a/clients/client-robomaker/src/commands/ListDeploymentJobsCommand.ts +++ b/clients/client-robomaker/src/commands/ListDeploymentJobsCommand.ts @@ -22,8 +22,12 @@ export interface ListDeploymentJobsCommandInput extends ListDeploymentJobsReques export interface ListDeploymentJobsCommandOutput extends ListDeploymentJobsResponse, __MetadataBearer {} /** - *

    Returns a list of deployment jobs for a fleet. You can optionally provide filters to - * retrieve specific deployment jobs.

    + * @deprecated + * + *

    Returns a list of deployment jobs for a fleet. You can optionally provide filters to retrieve specific deployment jobs.

    + * + *

    This API will no longer be supported as of May 2, 2022. Use it to remove resources that were created for Deployment Service.

    + *     * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-robomaker/src/commands/ListFleetsCommand.ts b/clients/client-robomaker/src/commands/ListFleetsCommand.ts index 1ea40da76e6a6..29758294f98d8 100644 --- a/clients/client-robomaker/src/commands/ListFleetsCommand.ts +++ b/clients/client-robomaker/src/commands/ListFleetsCommand.ts @@ -22,8 +22,12 @@ export interface ListFleetsCommandInput extends ListFleetsRequest {} export interface ListFleetsCommandOutput extends ListFleetsResponse, __MetadataBearer {} /** - *

    Returns a list of fleets. You can optionally provide filters to retrieve specific - * fleets.

    + * @deprecated + * + *

    Returns a list of fleets. You can optionally provide filters to retrieve specific fleets.

    + * + *

    This API will no longer be supported as of May 2, 2022. Use it to remove resources that were created for Deployment Service.

    + *     * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-robomaker/src/commands/ListRobotsCommand.ts b/clients/client-robomaker/src/commands/ListRobotsCommand.ts index a430911e16d07..3efda01eebef8 100644 --- a/clients/client-robomaker/src/commands/ListRobotsCommand.ts +++ b/clients/client-robomaker/src/commands/ListRobotsCommand.ts @@ -22,8 +22,12 @@ export interface ListRobotsCommandInput extends ListRobotsRequest {} export interface ListRobotsCommandOutput extends ListRobotsResponse, __MetadataBearer {} /** - *

    Returns a list of robots. You can optionally provide filters to retrieve specific - * robots.

    + * @deprecated + * + *

    Returns a list of robots. You can optionally provide filters to retrieve specific robots.

    + * + *

    This API will no longer be supported as of May 2, 2022. Use it to remove resources that were created for Deployment Service.

    + *     * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-robomaker/src/commands/RegisterRobotCommand.ts b/clients/client-robomaker/src/commands/RegisterRobotCommand.ts index 0d3f7585d210b..c0bccd78801e5 100644 --- a/clients/client-robomaker/src/commands/RegisterRobotCommand.ts +++ b/clients/client-robomaker/src/commands/RegisterRobotCommand.ts @@ -22,7 +22,12 @@ export interface RegisterRobotCommandInput extends RegisterRobotRequest {} export interface RegisterRobotCommandOutput extends RegisterRobotResponse, __MetadataBearer {} /** + * @deprecated + * *

    Registers a robot with a fleet.

    + * + *

    This API is no longer supported and will throw an error if used.

    + *     * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-robomaker/src/commands/SyncDeploymentJobCommand.ts b/clients/client-robomaker/src/commands/SyncDeploymentJobCommand.ts index de4c341f5bdbd..af09b4f7d786b 100644 --- a/clients/client-robomaker/src/commands/SyncDeploymentJobCommand.ts +++ b/clients/client-robomaker/src/commands/SyncDeploymentJobCommand.ts @@ -22,8 +22,12 @@ export interface SyncDeploymentJobCommandInput extends SyncDeploymentJobRequest export interface SyncDeploymentJobCommandOutput extends SyncDeploymentJobResponse, __MetadataBearer {} /** - *

    Syncrhonizes robots in a fleet to the latest deployment. This is helpful if robots were - * added after a deployment.

    + * @deprecated + * + *

    Syncrhonizes robots in a fleet to the latest deployment. This is helpful if robots were added after a deployment.

    + * + *

    This API will no longer be supported as of May 2, 2022. Use it to remove resources that were created for Deployment Service.

    + *     * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/codegen/sdk-codegen/aws-models/appflow.json b/codegen/sdk-codegen/aws-models/appflow.json index a29bb13ff7c3e..c3103aea9f9b2 100644 --- a/codegen/sdk-codegen/aws-models/appflow.json +++ b/codegen/sdk-codegen/aws-models/appflow.json @@ -39,6 +39,19 @@ "smithy.api#pattern": "^arn:aws:.*:.*:[0-9]+:" } }, + "com.amazonaws.appflow#AccessDeniedException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.appflow#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

    AppFlow/Requester has invalid or missing permissions.

    ", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, "com.amazonaws.appflow#AccessKeyId": { "type": "string", "traits": { @@ -55,7 +68,7 @@ "traits": { "smithy.api#length": { "min": 0, - "max": 512 + "max": 2048 }, "smithy.api#pattern": "^\\S+$", "smithy.api#sensitive": {} @@ -169,7 +182,29 @@ "min": 0, "max": 256 }, - "smithy.api#pattern": "^\\S+$" + "smithy.api#pattern": "^\\S+$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.appflow#ApiKeyCredentials": { + "type": "structure", + "members": { + "apiKey": { + "target": "com.amazonaws.appflow#ApiKey", + "traits": { + "smithy.api#documentation": "

    The API key required for API key authentication.

    ", + "smithy.api#required": {} + } + }, + "apiSecretKey": { + "target": "com.amazonaws.appflow#ApiSecretKey", + "traits": { + "smithy.api#documentation": "

    The API secret key required for API key authentication.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    The API key credentials required for API key authentication.

    " } }, "com.amazonaws.appflow#ApiSecretKey": { @@ -193,6 +228,16 @@ "smithy.api#pattern": "^\\S+$" } }, + "com.amazonaws.appflow#ApiVersion": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^\\S+$" + } + }, "com.amazonaws.appflow#ApplicationHostUrl": { "type": "string", "traits": { @@ -223,6 +268,16 @@ "smithy.api#pattern": "^\\S+$" } }, + "com.amazonaws.appflow#ApplicationType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 512 + }, + "smithy.api#pattern": "^\\S+$" + } + }, "com.amazonaws.appflow#AuthCode": { "type": "string", "traits": { @@ -243,6 +298,129 @@ "smithy.api#pattern": "^(https?)://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]$" } }, + "com.amazonaws.appflow#AuthCodeUrlList": { + "type": "list", + "member": { + "target": "com.amazonaws.appflow#AuthCodeUrl" + } + }, + "com.amazonaws.appflow#AuthParameter": { + "type": "structure", + "members": { + "key": { + "target": "com.amazonaws.appflow#Key", + "traits": { + "smithy.api#documentation": "

    The authentication key required to authenticate with the connector.

    " + } + }, + "isRequired": { + "target": "com.amazonaws.appflow#Boolean", + "traits": { + "smithy.api#documentation": "

    Indicates whether this authentication parameter is required.

    " + } + }, + "label": { + "target": "com.amazonaws.appflow#Label", + "traits": { + "smithy.api#documentation": "

    Label used for authentication parameter.

    " + } + }, + "description": { + "target": "com.amazonaws.appflow#Description", + "traits": { + "smithy.api#documentation": "

    A description about the authentication parameter.

    " + } + }, + "isSensitiveField": { + "target": "com.amazonaws.appflow#Boolean", + "traits": { + "smithy.api#documentation": "

    Indicates whether this authentication parameter is a sensitive field.

    " + } + }, + "connectorSuppliedValues": { + "target": "com.amazonaws.appflow#ConnectorSuppliedValueList", + "traits": { + "smithy.api#documentation": "

    Contains default values for this authentication parameter that are supplied by the\n connector.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Information about required authentication parameters.

    " + } + }, + "com.amazonaws.appflow#AuthParameterList": { + "type": "list", + "member": { + "target": "com.amazonaws.appflow#AuthParameter" + } + }, + "com.amazonaws.appflow#AuthenticationConfig": { + "type": "structure", + "members": { + "isBasicAuthSupported": { + "target": "com.amazonaws.appflow#Boolean", + "traits": { + "smithy.api#documentation": "

    Indicates whether basic authentication is supported by the connector.

    " + } + }, + "isApiKeyAuthSupported": { + "target": "com.amazonaws.appflow#Boolean", + "traits": { + "smithy.api#documentation": "

    Indicates whether API key authentication is supported by the connector

    " + } + }, + "isOAuth2Supported": { + "target": "com.amazonaws.appflow#Boolean", + "traits": { + "smithy.api#documentation": "

    Indicates whether OAuth 2.0 authentication is supported by the connector.

    " + } + }, + "isCustomAuthSupported": { + "target": "com.amazonaws.appflow#Boolean", + "traits": { + "smithy.api#documentation": "

    Indicates whether custom authentication is supported by the connector

    " + } + }, + "oAuth2Defaults": { + "target": "com.amazonaws.appflow#OAuth2Defaults", + "traits": { + "smithy.api#documentation": "

    Contains the default values required for OAuth 2.0 authentication.

    " + } + }, + "customAuthConfigs": { + "target": "com.amazonaws.appflow#CustomAuthConfigList", + "traits": { + "smithy.api#documentation": "

    Contains information required for custom authentication.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Contains information about the authentication config that the connector supports.

    " + } + }, + "com.amazonaws.appflow#AuthenticationType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "OAUTH2", + "name": "OAUTH2" + }, + { + "value": "APIKEY", + "name": "APIKEY" + }, + { + "value": "BASIC", + "name": "BASIC" + }, + { + "value": "CUSTOM", + "name": "CUSTOM" + } + ] + } + }, "com.amazonaws.appflow#BasicAuthCredentials": { "type": "structure", "members": { @@ -421,6 +599,114 @@ "traits": { "smithy.api#documentation": "

    Specifies connector-specific metadata such as oAuthScopes,\n supportedRegions, privateLinkServiceUrl, and so on.

    " } + }, + "connectorType": { + "target": "com.amazonaws.appflow#ConnectorType", + "traits": { + "smithy.api#documentation": "

    The connector type.

    " + } + }, + "connectorLabel": { + "target": "com.amazonaws.appflow#ConnectorLabel", + "traits": { + "smithy.api#documentation": "

    The label used for registering the connector.

    " + } + }, + "connectorDescription": { + "target": "com.amazonaws.appflow#ConnectorDescription", + "traits": { + "smithy.api#documentation": "

    A description about the connector.

    " + } + }, + "connectorOwner": { + "target": "com.amazonaws.appflow#ConnectorOwner", + "traits": { + "smithy.api#documentation": "

    The owner who developed the connector.

    " + } + }, + "connectorName": { + "target": "com.amazonaws.appflow#ConnectorName", + "traits": { + "smithy.api#documentation": "

    The connector name.

    " + } + }, + "connectorVersion": { + "target": "com.amazonaws.appflow#ConnectorVersion", + "traits": { + "smithy.api#documentation": "

    The connector version.

    " + } + }, + "connectorArn": { + "target": "com.amazonaws.appflow#ARN", + "traits": { + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) for the registered connector.

    " + } + }, + "connectorModes": { + "target": "com.amazonaws.appflow#ConnectorModeList", + "traits": { + "smithy.api#documentation": "

    The connection modes that the connector supports.

    " + } + }, + "authenticationConfig": { + "target": "com.amazonaws.appflow#AuthenticationConfig", + "traits": { + "smithy.api#documentation": "

    The authentication config required for the connector.

    " + } + }, + "connectorRuntimeSettings": { + "target": "com.amazonaws.appflow#ConnectorRuntimeSettingList", + "traits": { + "smithy.api#documentation": "

    The required connector runtime settings.

    " + } + }, + "supportedApiVersions": { + "target": "com.amazonaws.appflow#SupportedApiVersionList", + "traits": { + "smithy.api#documentation": "

    A list of API versions that are supported by the connector.

    " + } + }, + "supportedOperators": { + "target": "com.amazonaws.appflow#SupportedOperatorList", + "traits": { + "smithy.api#documentation": "

    A list of operators supported by the connector.

    " + } + }, + "supportedWriteOperations": { + "target": "com.amazonaws.appflow#SupportedWriteOperationList", + "traits": { + "smithy.api#documentation": "

    A list of write operations supported by the connector.

    " + } + }, + "connectorProvisioningType": { + "target": "com.amazonaws.appflow#ConnectorProvisioningType", + "traits": { + "smithy.api#documentation": "

    The provisioning type used to register the connector.

    " + } + }, + "connectorProvisioningConfig": { + "target": "com.amazonaws.appflow#ConnectorProvisioningConfig", + "traits": { + "smithy.api#documentation": "

    The configuration required for registering the connector.

    " + } + }, + "logoURL": { + "target": "com.amazonaws.appflow#LogoURL", + "traits": { + "smithy.api#documentation": "

    Logo URL of the connector.

    " + } + }, + "registeredAt": { + "target": "com.amazonaws.appflow#Date", + "traits": { + "smithy.api#documentation": "

    The date on which the connector was registered.

    " + } + }, + "registeredBy": { + "target": "com.amazonaws.appflow#RegisteredBy", + "traits": { + "smithy.api#documentation": "

    Information about who registered the connector.

    " + } } }, "traits": { @@ -436,6 +722,90 @@ "target": "com.amazonaws.appflow#ConnectorConfiguration" } }, + "com.amazonaws.appflow#ConnectorDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2048 + }, + "smithy.api#pattern": "^[\\w!@#\\-.?,\\s]*$" + } + }, + "com.amazonaws.appflow#ConnectorDetail": { + "type": "structure", + "members": { + "connectorDescription": { + "target": "com.amazonaws.appflow#ConnectorDescription", + "traits": { + "smithy.api#documentation": "

    A description about the registered connector.

    " + } + }, + "connectorName": { + "target": "com.amazonaws.appflow#ConnectorName", + "traits": { + "smithy.api#documentation": "

    The name of the connector.

    " + } + }, + "connectorOwner": { + "target": "com.amazonaws.appflow#ConnectorOwner", + "traits": { + "smithy.api#documentation": "

    The owner of the connector.

    " + } + }, + "connectorVersion": { + "target": "com.amazonaws.appflow#ConnectorVersion", + "traits": { + "smithy.api#documentation": "

    The connector version.

    " + } + }, + "applicationType": { + "target": "com.amazonaws.appflow#ApplicationType", + "traits": { + "smithy.api#documentation": "

    The application type of the connector.

    " + } + }, + "connectorType": { + "target": "com.amazonaws.appflow#ConnectorType", + "traits": { + "smithy.api#documentation": "

    The connector type.

    " + } + }, + "connectorLabel": { + "target": "com.amazonaws.appflow#ConnectorLabel", + "traits": { + "smithy.api#documentation": "

    A label used for the connector.

    " + } + }, + "registeredAt": { + "target": "com.amazonaws.appflow#Date", + "traits": { + "smithy.api#documentation": "

    The time at which the connector was registered.

    " + } + }, + "registeredBy": { + "target": "com.amazonaws.appflow#RegisteredBy", + "traits": { + "smithy.api#documentation": "

    The user who registered the connector.

    " + } + }, + "connectorProvisioningType": { + "target": "com.amazonaws.appflow#ConnectorProvisioningType", + "traits": { + "smithy.api#documentation": "

    The provisioning type that the connector uses.

    " + } + }, + "connectorModes": { + "target": "com.amazonaws.appflow#ConnectorModeList", + "traits": { + "smithy.api#documentation": "

    The connection mode that the connector supports.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Information about the registered connector.

    " + } + }, "com.amazonaws.appflow#ConnectorEntity": { "type": "structure", "members": { @@ -473,26 +843,50 @@ "smithy.api#required": {} } }, + "parentIdentifier": { + "target": "com.amazonaws.appflow#Identifier", + "traits": { + "smithy.api#documentation": "

    The parent identifier of the connector field.

    " + } + }, "label": { "target": "com.amazonaws.appflow#Label", "traits": { "smithy.api#documentation": "

    The label applied to a connector entity field.

    " } }, - "supportedFieldTypeDetails": { - "target": "com.amazonaws.appflow#SupportedFieldTypeDetails", + "isPrimaryKey": { + "target": "com.amazonaws.appflow#Boolean", "traits": { - "smithy.api#documentation": "

    Contains details regarding the supported FieldType, including the\n corresponding filterOperators and supportedValues.

    " + "smithy.api#documentation": "

    Booelan value that indicates whether this field can be used as a primary key.

    " } }, - "description": { - "target": "com.amazonaws.appflow#Description", + "defaultValue": { + "target": "com.amazonaws.appflow#String", "traits": { - "smithy.api#documentation": "

    A description of the connector entity field.

    " + "smithy.api#documentation": "

    Default value that can be assigned to this field.

    " } }, - "sourceProperties": { - "target": "com.amazonaws.appflow#SourceFieldProperties", + "isDeprecated": { + "target": "com.amazonaws.appflow#Boolean", + "traits": { + "smithy.api#documentation": "

    Booelan value that indicates whether this field is deprecated or not.

    " + } + }, + "supportedFieldTypeDetails": { + "target": "com.amazonaws.appflow#SupportedFieldTypeDetails", + "traits": { + "smithy.api#documentation": "

    Contains details regarding the supported FieldType, including the\n corresponding filterOperators and supportedValues.

    " + } + }, + "description": { + "target": "com.amazonaws.appflow#Description", + "traits": { + "smithy.api#documentation": "

    A description of the connector entity field.

    " + } + }, + "sourceProperties": { + "target": "com.amazonaws.appflow#SourceFieldProperties", "traits": { "smithy.api#documentation": "

    The properties that can be applied to a field when the connector is being used as a\n source.

    " } @@ -502,6 +896,12 @@ "traits": { "smithy.api#documentation": "

    The properties applied to a field when the connector is being used as a destination.\n

    " } + }, + "customProperties": { + "target": "com.amazonaws.appflow#CustomProperties", + "traits": { + "smithy.api#documentation": "

    A map that has specific properties related to the ConnectorEntityField.

    " + } } }, "traits": { @@ -529,6 +929,22 @@ "target": "com.amazonaws.appflow#ConnectorEntityList" } }, + "com.amazonaws.appflow#ConnectorLabel": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^[a-zA-Z0-9][\\w!@#.-]+$" + } + }, + "com.amazonaws.appflow#ConnectorList": { + "type": "list", + "member": { + "target": "com.amazonaws.appflow#ConnectorDetail" + } + }, "com.amazonaws.appflow#ConnectorMetadata": { "type": "structure", "members": { @@ -660,6 +1076,32 @@ "smithy.api#documentation": "

    A structure to specify connector-specific metadata such as oAuthScopes,\n supportedRegions, privateLinkServiceUrl, and so on.

    " } }, + "com.amazonaws.appflow#ConnectorMode": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^\\S+$" + } + }, + "com.amazonaws.appflow#ConnectorModeList": { + "type": "list", + "member": { + "target": "com.amazonaws.appflow#ConnectorMode" + } + }, + "com.amazonaws.appflow#ConnectorName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": ".*" + } + }, "com.amazonaws.appflow#ConnectorOAuthRequest": { "type": "structure", "members": { @@ -772,12 +1214,28 @@ "traits": { "smithy.api#documentation": "

    The operation to be performed on the provided SAPOData source fields.

    " } + }, + "CustomConnector": { + "target": "com.amazonaws.appflow#Operator", + "traits": { + "smithy.api#documentation": "

    Operators supported by the custom connector.

    " + } } }, "traits": { "smithy.api#documentation": "

    The operation to be performed on the provided source fields.

    " } }, + "com.amazonaws.appflow#ConnectorOwner": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": ".*" + } + }, "com.amazonaws.appflow#ConnectorProfile": { "type": "structure", "members": { @@ -799,6 +1257,12 @@ "smithy.api#documentation": "

    The type of connector, such as Salesforce, Amplitude, and so on.

    " } }, + "connectorLabel": { + "target": "com.amazonaws.appflow#ConnectorLabel", + "traits": { + "smithy.api#documentation": "

    The label for the connector profile being created.

    " + } + }, "connectionMode": { "target": "com.amazonaws.appflow#ConnectionMode", "traits": { @@ -847,7 +1311,7 @@ "min": 0, "max": 512 }, - "smithy.api#pattern": "^arn:aws:kms:.*:[0-9]+:" + "smithy.api#pattern": "^arn:aws:appflow:.*:[0-9]+:" } }, "com.amazonaws.appflow#ConnectorProfileConfig": { @@ -973,6 +1437,9 @@ }, "SAPOData": { "target": "com.amazonaws.appflow#SAPODataConnectorProfileCredentials" + }, + "CustomConnector": { + "target": "com.amazonaws.appflow#CustomConnectorProfileCredentials" } }, "traits": { @@ -1108,12 +1575,120 @@ }, "SAPOData": { "target": "com.amazonaws.appflow#SAPODataConnectorProfileProperties" + }, + "CustomConnector": { + "target": "com.amazonaws.appflow#CustomConnectorProfileProperties", + "traits": { + "smithy.api#documentation": "

    The properties required by the custom connector.

    " + } } }, "traits": { "smithy.api#documentation": "

    The connector-specific profile properties required by each connector.

    " } }, + "com.amazonaws.appflow#ConnectorProvisioningConfig": { + "type": "structure", + "members": { + "lambda": { + "target": "com.amazonaws.appflow#LambdaConnectorProvisioningConfig", + "traits": { + "smithy.api#documentation": "

    Contains information about the configuration of the lambda which is being registered as\n the connector.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Contains information about the configuration of the connector being registered.

    " + } + }, + "com.amazonaws.appflow#ConnectorProvisioningType": { + "type": "string", + "traits": { + "smithy.api#documentation": "

    The type of provisioning that the connector supports, such as Lambda.

    ", + "smithy.api#enum": [ + { + "value": "LAMBDA", + "name": "LAMBDA" + } + ] + } + }, + "com.amazonaws.appflow#ConnectorRuntimeSetting": { + "type": "structure", + "members": { + "key": { + "target": "com.amazonaws.appflow#Key", + "traits": { + "smithy.api#documentation": "

    Contains value information about the connector runtime setting.

    " + } + }, + "dataType": { + "target": "com.amazonaws.appflow#ConnectorRuntimeSettingDataType", + "traits": { + "smithy.api#documentation": "

    Data type of the connector runtime setting.

    " + } + }, + "isRequired": { + "target": "com.amazonaws.appflow#Boolean", + "traits": { + "smithy.api#documentation": "

    Indicates whether this connector runtime setting is required.

    " + } + }, + "label": { + "target": "com.amazonaws.appflow#Label", + "traits": { + "smithy.api#documentation": "

    A label used for connector runtime setting.

    " + } + }, + "description": { + "target": "com.amazonaws.appflow#Description", + "traits": { + "smithy.api#documentation": "

    A description about the connector runtime setting.

    " + } + }, + "scope": { + "target": "com.amazonaws.appflow#ConnectorRuntimeSettingScope", + "traits": { + "smithy.api#documentation": "

    Indicates the scope of the connector runtime setting.

    " + } + }, + "connectorSuppliedValueOptions": { + "target": "com.amazonaws.appflow#ConnectorSuppliedValueOptionList", + "traits": { + "smithy.api#documentation": "

    Contains default values for the connector runtime setting that are supplied by the\n connector.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Contains information about the connector runtime settings that are required for flow\n execution.

    " + } + }, + "com.amazonaws.appflow#ConnectorRuntimeSettingDataType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^\\S+$" + } + }, + "com.amazonaws.appflow#ConnectorRuntimeSettingList": { + "type": "list", + "member": { + "target": "com.amazonaws.appflow#ConnectorRuntimeSetting" + } + }, + "com.amazonaws.appflow#ConnectorRuntimeSettingScope": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^\\S+$" + } + }, "com.amazonaws.appflow#ConnectorServerException": { "type": "structure", "members": { @@ -1127,6 +1702,28 @@ "smithy.api#httpError": 400 } }, + "com.amazonaws.appflow#ConnectorSuppliedValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^\\S+$" + } + }, + "com.amazonaws.appflow#ConnectorSuppliedValueList": { + "type": "list", + "member": { + "target": "com.amazonaws.appflow#ConnectorSuppliedValue" + } + }, + "com.amazonaws.appflow#ConnectorSuppliedValueOptionList": { + "type": "list", + "member": { + "target": "com.amazonaws.appflow#ConnectorSuppliedValue" + } + }, "com.amazonaws.appflow#ConnectorType": { "type": "string", "traits": { @@ -1218,6 +1815,10 @@ { "value": "SAPOData", "name": "SAPODATA" + }, + { + "value": "CustomConnector", + "name": "CUSTOMCONNECTOR" } ] } @@ -1234,6 +1835,16 @@ } } }, + "com.amazonaws.appflow#ConnectorVersion": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^\\S+$" + } + }, "com.amazonaws.appflow#CreateConnectorProfile": { "type": "operation", "input": { @@ -1260,7 +1871,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Creates a new connector profile associated with your Amazon Web Services account. There is a soft quota\n of 100 connector profiles per Amazon Web Services account. If you need more connector profiles than this quota\n allows, you can submit a request to the Amazon AppFlow team through the Amazon AppFlow support\n channel.

    ", + "smithy.api#documentation": "

    Creates a new connector profile associated with your Amazon Web Services account. There\n is a soft quota of 100 connector profiles per Amazon Web Services account. If you need more\n connector profiles than this quota allows, you can submit a request to the Amazon AppFlow team\n through the Amazon AppFlow support channel.

    ", "smithy.api#http": { "method": "POST", "uri": "/create-connector-profile", @@ -1291,154 +1902,405 @@ "smithy.api#required": {} } }, + "connectorLabel": { + "target": "com.amazonaws.appflow#ConnectorLabel", + "traits": { + "smithy.api#documentation": "

    The label of the connector. The label is unique for each\n ConnectorRegistration in your Amazon Web Services account. Only needed if\n calling for CUSTOMCONNECTOR connector type/.

    " + } + }, "connectionMode": { "target": "com.amazonaws.appflow#ConnectionMode", "traits": { - "smithy.api#documentation": "

    Indicates the connection mode and specifies whether it is public or private. Private\n flows use Amazon Web Services PrivateLink to route data over Amazon Web Services infrastructure without exposing it to the\n public internet.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    Indicates the connection mode and specifies whether it is public or private. Private\n flows use Amazon Web Services PrivateLink to route data over Amazon Web Services infrastructure\n without exposing it to the public internet.

    ", + "smithy.api#required": {} + } + }, + "connectorProfileConfig": { + "target": "com.amazonaws.appflow#ConnectorProfileConfig", + "traits": { + "smithy.api#documentation": "

    Defines the connector-specific configuration and credentials.

    ", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.appflow#CreateConnectorProfileResponse": { + "type": "structure", + "members": { + "connectorProfileArn": { + "target": "com.amazonaws.appflow#ConnectorProfileArn", + "traits": { + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the connector profile.

    " + } + } + } + }, + "com.amazonaws.appflow#CreateFlow": { + "type": "operation", + "input": { + "target": "com.amazonaws.appflow#CreateFlowRequest" + }, + "output": { + "target": "com.amazonaws.appflow#CreateFlowResponse" + }, + "errors": [ + { + "target": "com.amazonaws.appflow#ConflictException" + }, + { + "target": "com.amazonaws.appflow#ConnectorAuthenticationException" + }, + { + "target": "com.amazonaws.appflow#ConnectorServerException" + }, + { + "target": "com.amazonaws.appflow#InternalServerException" + }, + { + "target": "com.amazonaws.appflow#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.appflow#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.appflow#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

    Enables your application to create a new flow using Amazon AppFlow. You must create a\n connector profile before calling this API. Please note that the Request Syntax below shows\n syntax for multiple destinations, however, you can only transfer data to one item in this list\n at a time. Amazon AppFlow does not currently support flows to multiple destinations at once.

    ", + "smithy.api#http": { + "method": "POST", + "uri": "/create-flow", + "code": 200 + } + } + }, + "com.amazonaws.appflow#CreateFlowRequest": { + "type": "structure", + "members": { + "flowName": { + "target": "com.amazonaws.appflow#FlowName", + "traits": { + "smithy.api#documentation": "

    The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens\n (-) only.

    ", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.appflow#FlowDescription", + "traits": { + "smithy.api#documentation": "

    A description of the flow you want to create.

    " + } + }, + "kmsArn": { + "target": "com.amazonaws.appflow#KMSArn", + "traits": { + "smithy.api#documentation": "

    The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you provide for\n encryption. This is required if you do not want to use the Amazon AppFlow-managed KMS key. If\n you don't provide anything here, Amazon AppFlow uses the Amazon AppFlow-managed KMS key.\n

    " + } + }, + "triggerConfig": { + "target": "com.amazonaws.appflow#TriggerConfig", + "traits": { + "smithy.api#documentation": "

    The trigger settings that determine how and when the flow runs.

    ", + "smithy.api#required": {} + } + }, + "sourceFlowConfig": { + "target": "com.amazonaws.appflow#SourceFlowConfig", + "traits": { + "smithy.api#documentation": "

    The configuration that controls how Amazon AppFlow retrieves data from the source\n connector.

    ", + "smithy.api#required": {} + } + }, + "destinationFlowConfigList": { + "target": "com.amazonaws.appflow#DestinationFlowConfigList", + "traits": { + "smithy.api#documentation": "

    The configuration that controls how Amazon AppFlow places data in the destination\n connector.

    ", + "smithy.api#required": {} + } + }, + "tasks": { + "target": "com.amazonaws.appflow#Tasks", + "traits": { + "smithy.api#documentation": "

    A list of tasks that Amazon AppFlow performs while transferring the data in the flow run.\n

    ", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.appflow#TagMap", + "traits": { + "smithy.api#documentation": "

    The tags used to organize, track, or control access for your flow.

    " + } + } + } + }, + "com.amazonaws.appflow#CreateFlowResponse": { + "type": "structure", + "members": { + "flowArn": { + "target": "com.amazonaws.appflow#FlowArn", + "traits": { + "smithy.api#documentation": "

    The flow's Amazon Resource Name (ARN).

    " + } + }, + "flowStatus": { + "target": "com.amazonaws.appflow#FlowStatus", + "traits": { + "smithy.api#documentation": "

    Indicates the current status of the flow.

    " + } + } + } + }, + "com.amazonaws.appflow#CreatedBy": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^\\S+$" + } + }, + "com.amazonaws.appflow#CredentialsMap": { + "type": "map", + "key": { + "target": "com.amazonaws.appflow#CredentialsMapKey" + }, + "value": { + "target": "com.amazonaws.appflow#CredentialsMapValue" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.appflow#CredentialsMapKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[\\w]+$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.appflow#CredentialsMapValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2048 + }, + "smithy.api#pattern": "^\\S+$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.appflow#CustomAuthConfig": { + "type": "structure", + "members": { + "customAuthenticationType": { + "target": "com.amazonaws.appflow#CustomAuthenticationType", + "traits": { + "smithy.api#documentation": "

    The authentication type that the custom connector uses.

    " } }, - "connectorProfileConfig": { - "target": "com.amazonaws.appflow#ConnectorProfileConfig", + "authParameters": { + "target": "com.amazonaws.appflow#AuthParameterList", "traits": { - "smithy.api#documentation": "

    Defines the connector-specific configuration and credentials.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    Information about authentication parameters required for authentication.

    " } } + }, + "traits": { + "smithy.api#documentation": "

    Configuration information required for custom authentication.

    " } }, - "com.amazonaws.appflow#CreateConnectorProfileResponse": { + "com.amazonaws.appflow#CustomAuthConfigList": { + "type": "list", + "member": { + "target": "com.amazonaws.appflow#CustomAuthConfig" + } + }, + "com.amazonaws.appflow#CustomAuthCredentials": { "type": "structure", "members": { - "connectorProfileArn": { - "target": "com.amazonaws.appflow#ConnectorProfileArn", + "customAuthenticationType": { + "target": "com.amazonaws.appflow#CustomAuthenticationType", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the connector profile.

    " + "smithy.api#documentation": "

    The custom authentication type that the connector uses.

    ", + "smithy.api#required": {} + } + }, + "credentialsMap": { + "target": "com.amazonaws.appflow#CredentialsMap", + "traits": { + "smithy.api#documentation": "

    A map that holds custom authentication credentials.

    " } } + }, + "traits": { + "smithy.api#documentation": "

    The custom credentials required for custom authentication.

    " } }, - "com.amazonaws.appflow#CreateFlow": { - "type": "operation", - "input": { - "target": "com.amazonaws.appflow#CreateFlowRequest" - }, - "output": { - "target": "com.amazonaws.appflow#CreateFlowResponse" - }, - "errors": [ - { - "target": "com.amazonaws.appflow#ConflictException" - }, - { - "target": "com.amazonaws.appflow#ConnectorAuthenticationException" - }, - { - "target": "com.amazonaws.appflow#ConnectorServerException" - }, - { - "target": "com.amazonaws.appflow#InternalServerException" - }, - { - "target": "com.amazonaws.appflow#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.appflow#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.appflow#ValidationException" - } - ], + "com.amazonaws.appflow#CustomAuthenticationType": { + "type": "string", "traits": { - "smithy.api#documentation": "

    Enables your application to create a new flow using Amazon AppFlow. You must create a\n connector profile before calling this API. Please note that the Request Syntax below shows\n syntax for multiple destinations, however, you can only transfer data to one item in this list\n at a time. Amazon AppFlow does not currently support flows to multiple destinations at once.

    ", - "smithy.api#http": { - "method": "POST", - "uri": "/create-flow", - "code": 200 - } + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^\\S+$" } }, - "com.amazonaws.appflow#CreateFlowRequest": { + "com.amazonaws.appflow#CustomConnectorDestinationProperties": { "type": "structure", "members": { - "flowName": { - "target": "com.amazonaws.appflow#FlowName", + "entityName": { + "target": "com.amazonaws.appflow#EntityName", "traits": { - "smithy.api#documentation": "

    The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens\n (-) only.

    ", + "smithy.api#documentation": "

    The entity specified in the custom connector as a destination in the flow.

    ", "smithy.api#required": {} } }, - "description": { - "target": "com.amazonaws.appflow#FlowDescription", + "errorHandlingConfig": { + "target": "com.amazonaws.appflow#ErrorHandlingConfig", "traits": { - "smithy.api#documentation": "

    A description of the flow you want to create.

    " + "smithy.api#documentation": "

    The settings that determine how Amazon AppFlow handles an error when placing data in the\n custom connector as destination.

    " } }, - "kmsArn": { - "target": "com.amazonaws.appflow#KMSArn", + "writeOperationType": { + "target": "com.amazonaws.appflow#WriteOperationType", "traits": { - "smithy.api#documentation": "

    The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you provide for\n encryption. This is required if you do not want to use the Amazon AppFlow-managed KMS key. If\n you don't provide anything here, Amazon AppFlow uses the Amazon AppFlow-managed KMS key.\n

    " + "smithy.api#documentation": "

    Specifies the type of write operation to be performed in the custom connector when it's\n used as destination.

    " } }, - "triggerConfig": { - "target": "com.amazonaws.appflow#TriggerConfig", + "idFieldNames": { + "target": "com.amazonaws.appflow#IdFieldNameList", "traits": { - "smithy.api#documentation": "

    The trigger settings that determine how and when the flow runs.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The name of the field that Amazon AppFlow uses as an ID when performing a write operation\n such as update, delete, or upsert.

    " } }, - "sourceFlowConfig": { - "target": "com.amazonaws.appflow#SourceFlowConfig", + "customProperties": { + "target": "com.amazonaws.appflow#CustomProperties", "traits": { - "smithy.api#documentation": "

    The configuration that controls how Amazon AppFlow retrieves data from the source\n connector.

    ", + "smithy.api#documentation": "

    The custom properties that are specific to the connector when it's used as a destination\n in the flow.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    The properties that are applied when the custom connector is being used as a\n destination.

    " + } + }, + "com.amazonaws.appflow#CustomConnectorProfileCredentials": { + "type": "structure", + "members": { + "authenticationType": { + "target": "com.amazonaws.appflow#AuthenticationType", + "traits": { + "smithy.api#documentation": "

    The authentication type that the custom connector uses for authenticating while creating a\n connector profile.

    ", "smithy.api#required": {} } }, - "destinationFlowConfigList": { - "target": "com.amazonaws.appflow#DestinationFlowConfigList", + "basic": { + "target": "com.amazonaws.appflow#BasicAuthCredentials", "traits": { - "smithy.api#documentation": "

    The configuration that controls how Amazon AppFlow places data in the destination\n connector.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The basic credentials that are required for the authentication of the user.

    " } }, - "tasks": { - "target": "com.amazonaws.appflow#Tasks", + "oauth2": { + "target": "com.amazonaws.appflow#OAuth2Credentials", "traits": { - "smithy.api#documentation": "

    A list of tasks that Amazon AppFlow performs while transferring the data in the flow run.\n

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The OAuth 2.0 credentials required for the authentication of the user.

    " } }, - "tags": { - "target": "com.amazonaws.appflow#TagMap", + "apiKey": { + "target": "com.amazonaws.appflow#ApiKeyCredentials", "traits": { - "smithy.api#documentation": "

    The tags used to organize, track, or control access for your flow.

    " + "smithy.api#documentation": "

    The API keys required for the authentication of the user.

    " + } + }, + "custom": { + "target": "com.amazonaws.appflow#CustomAuthCredentials", + "traits": { + "smithy.api#documentation": "

    If the connector uses the custom authentication mechanism, this holds the required\n credentials.

    " } } + }, + "traits": { + "smithy.api#documentation": "

    The connector-specific profile credentials that are required when using the custom\n connector.

    " } }, - "com.amazonaws.appflow#CreateFlowResponse": { + "com.amazonaws.appflow#CustomConnectorProfileProperties": { "type": "structure", "members": { - "flowArn": { - "target": "com.amazonaws.appflow#FlowArn", + "profileProperties": { + "target": "com.amazonaws.appflow#ProfilePropertiesMap", "traits": { - "smithy.api#documentation": "

    The flow's Amazon Resource Name (ARN).

    " + "smithy.api#documentation": "

    A map of properties that are required to create a profile for the custom connector.

    " } }, - "flowStatus": { - "target": "com.amazonaws.appflow#FlowStatus", + "oAuth2Properties": { + "target": "com.amazonaws.appflow#OAuth2Properties" + } + }, + "traits": { + "smithy.api#documentation": "

    The profile properties required by the custom connector.

    " + } + }, + "com.amazonaws.appflow#CustomConnectorSourceProperties": { + "type": "structure", + "members": { + "entityName": { + "target": "com.amazonaws.appflow#EntityName", "traits": { - "smithy.api#documentation": "

    Indicates the current status of the flow.

    " + "smithy.api#documentation": "

    The entity specified in the custom connector as a source in the flow.

    ", + "smithy.api#required": {} + } + }, + "customProperties": { + "target": "com.amazonaws.appflow#CustomProperties", + "traits": { + "smithy.api#documentation": "

    Custom properties that are required to use the custom connector as a source.

    " } } + }, + "traits": { + "smithy.api#documentation": "

    The properties that are applied when the custom connector is being used as a\n source.

    " } }, - "com.amazonaws.appflow#CreatedBy": { + "com.amazonaws.appflow#CustomProperties": { + "type": "map", + "key": { + "target": "com.amazonaws.appflow#CustomPropertyKey" + }, + "value": { + "target": "com.amazonaws.appflow#CustomPropertyValue" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.appflow#CustomPropertyKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[\\w]+$" + } + }, + "com.amazonaws.appflow#CustomPropertyValue": { "type": "string", "traits": { "smithy.api#length": { "min": 0, - "max": 256 + "max": 2048 }, "smithy.api#pattern": "^\\S+$" } @@ -1735,6 +2597,34 @@ "type": "structure", "members": {} }, + "com.amazonaws.appflow#DescribeConnector": { + "type": "operation", + "input": { + "target": "com.amazonaws.appflow#DescribeConnectorRequest" + }, + "output": { + "target": "com.amazonaws.appflow#DescribeConnectorResponse" + }, + "errors": [ + { + "target": "com.amazonaws.appflow#InternalServerException" + }, + { + "target": "com.amazonaws.appflow#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.appflow#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

    Describes the given custom connector registered in your Amazon Web Services account. This\n API can be used for custom connectors that are registered in your account and also for Amazon\n authored connectors.

    ", + "smithy.api#http": { + "method": "POST", + "uri": "/describe-connector", + "code": 200 + } + } + }, "com.amazonaws.appflow#DescribeConnectorEntity": { "type": "operation", "input": { @@ -1773,7 +2663,7 @@ "type": "structure", "members": { "connectorEntityName": { - "target": "com.amazonaws.appflow#Name", + "target": "com.amazonaws.appflow#EntityName", "traits": { "smithy.api#documentation": "

    The entity name for that connector.

    ", "smithy.api#required": {} @@ -1790,6 +2680,12 @@ "traits": { "smithy.api#documentation": "

    The name of the connector profile. The name is unique for each\n ConnectorProfile in the Amazon Web Services account.

    " } + }, + "apiVersion": { + "target": "com.amazonaws.appflow#ApiVersion", + "traits": { + "smithy.api#documentation": "

    The version of the API that's used by the connector.

    " + } } } }, @@ -1850,6 +2746,12 @@ "smithy.api#documentation": "

    The type of connector, such as Salesforce, Amplitude, and so on.

    " } }, + "connectorLabel": { + "target": "com.amazonaws.appflow#ConnectorLabel", + "traits": { + "smithy.api#documentation": "

    The name of the connector. The name is unique for each ConnectorRegistration\n in your Amazon Web Services account. Only needed if calling for CUSTOMCONNECTOR connector\n type/.

    " + } + }, "maxResults": { "target": "com.amazonaws.appflow#MaxResults", "traits": { @@ -1881,6 +2783,35 @@ } } }, + "com.amazonaws.appflow#DescribeConnectorRequest": { + "type": "structure", + "members": { + "connectorType": { + "target": "com.amazonaws.appflow#ConnectorType", + "traits": { + "smithy.api#documentation": "

    The connector type, such as CUSTOMCONNECTOR, Saleforce, Marketo. Please choose\n CUSTOMCONNECTOR for Lambda based custom connectors.

    ", + "smithy.api#required": {} + } + }, + "connectorLabel": { + "target": "com.amazonaws.appflow#ConnectorLabel", + "traits": { + "smithy.api#documentation": "

    The label of the connector. The label is unique for each\n ConnectorRegistration in your Amazon Web Services account. Only needed if\n calling for CUSTOMCONNECTOR connector type/.

    " + } + } + } + }, + "com.amazonaws.appflow#DescribeConnectorResponse": { + "type": "structure", + "members": { + "connectorConfiguration": { + "target": "com.amazonaws.appflow#ConnectorConfiguration", + "traits": { + "smithy.api#documentation": "

    Configuration info of all the connectors that the user requested.

    " + } + } + } + }, "com.amazonaws.appflow#DescribeConnectors": { "type": "operation", "input": { @@ -1906,7 +2837,8 @@ }, "smithy.api#paginated": { "inputToken": "nextToken", - "outputToken": "nextToken" + "outputToken": "nextToken", + "pageSize": "maxResults" } } }, @@ -1919,6 +2851,12 @@ "smithy.api#documentation": "

    The type of connector, such as Salesforce, Amplitude, and so on.

    " } }, + "maxResults": { + "target": "com.amazonaws.appflow#MaxResults", + "traits": { + "smithy.api#documentation": "

    The maximum number of items that should be returned in the result set. The default is\n 20.

    " + } + }, "nextToken": { "target": "com.amazonaws.appflow#NextToken", "traits": { @@ -1936,6 +2874,12 @@ "smithy.api#documentation": "

    The configuration that is applied to the connectors used in the flow.

    " } }, + "connectors": { + "target": "com.amazonaws.appflow#ConnectorList", + "traits": { + "smithy.api#documentation": "

    Information about the connectors supported in Amazon AppFlow.

    " + } + }, "nextToken": { "target": "com.amazonaws.appflow#NextToken", "traits": { @@ -2228,6 +3172,12 @@ "traits": { "smithy.api#documentation": "

    The properties required to query Zendesk.

    " } + }, + "CustomConnector": { + "target": "com.amazonaws.appflow#CustomConnectorDestinationProperties", + "traits": { + "smithy.api#documentation": "

    The properties that are required to query the custom Connector.

    " + } } }, "traits": { @@ -2271,6 +3221,12 @@ "smithy.api#documentation": "

    Specifies whether the field can be updated during an UPDATE or\n UPSERT write operation.

    " } }, + "isDefaultedOnCreate": { + "target": "com.amazonaws.appflow#Boolean", + "traits": { + "smithy.api#documentation": "

    Specifies whether the field can use the default value during a Create operation.

    " + } + }, "supportedWriteOperations": { "target": "com.amazonaws.appflow#SupportedWriteOperationList", "traits": { @@ -2292,6 +3248,12 @@ "smithy.api#required": {} } }, + "apiVersion": { + "target": "com.amazonaws.appflow#ApiVersion", + "traits": { + "smithy.api#documentation": "

    The API version that the destination connector uses.

    " + } + }, "connectorProfileName": { "target": "com.amazonaws.appflow#ConnectorProfileName", "traits": { @@ -2336,6 +3298,9 @@ "smithy.api#pattern": "^\\S+$" } }, + "com.amazonaws.appflow#Double": { + "type": "double" + }, "com.amazonaws.appflow#DynatraceConnectorOperator": { "type": "string", "traits": { @@ -2465,6 +3430,16 @@ "smithy.api#pattern": "^[\\s\\w/!@#+=.-]*$" } }, + "com.amazonaws.appflow#EntityName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + }, + "smithy.api#pattern": "^\\S+$" + } + }, "com.amazonaws.appflow#ErrorHandlingConfig": { "type": "structure", "members": { @@ -2706,17 +3681,41 @@ "smithy.api#required": {} } }, - "filterOperators": { - "target": "com.amazonaws.appflow#FilterOperatorList", + "filterOperators": { + "target": "com.amazonaws.appflow#FilterOperatorList", + "traits": { + "smithy.api#documentation": "

    The list of operators supported by a field.

    ", + "smithy.api#required": {} + } + }, + "supportedValues": { + "target": "com.amazonaws.appflow#SupportedValueList", + "traits": { + "smithy.api#documentation": "

    The list of values that a field can contain. For example, a Boolean\n fieldType can have two values: \"true\" and \"false\".

    " + } + }, + "valueRegexPattern": { + "target": "com.amazonaws.appflow#String", + "traits": { + "smithy.api#documentation": "

    The regular expression pattern for the field name.

    " + } + }, + "supportedDateFormat": { + "target": "com.amazonaws.appflow#String", + "traits": { + "smithy.api#documentation": "

    The date format that the field supports.

    " + } + }, + "fieldValueRange": { + "target": "com.amazonaws.appflow#Range", "traits": { - "smithy.api#documentation": "

    The list of operators supported by a field.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The range of values this field can hold.

    " } }, - "supportedValues": { - "target": "com.amazonaws.appflow#SupportedValueList", + "fieldLengthRange": { + "target": "com.amazonaws.appflow#Range", "traits": { - "smithy.api#documentation": "

    The list of values that a field can contain. For example, a Boolean\n fieldType can have two values: \"true\" and \"false\".

    " + "smithy.api#documentation": "

    This is the allowable length range for this field's value.

    " } } }, @@ -2792,12 +3791,24 @@ "smithy.api#documentation": "

    Specifies the source connector type, such as Salesforce, Amazon S3, Amplitude, and so on.\n

    " } }, + "sourceConnectorLabel": { + "target": "com.amazonaws.appflow#ConnectorLabel", + "traits": { + "smithy.api#documentation": "

    The label of the source connector in the flow.

    " + } + }, "destinationConnectorType": { "target": "com.amazonaws.appflow#ConnectorType", "traits": { "smithy.api#documentation": "

    Specifies the destination connector type, such as Salesforce, Amazon S3, Amplitude, and\n so on.

    " } }, + "destinationConnectorLabel": { + "target": "com.amazonaws.appflow#ConnectorLabel", + "traits": { + "smithy.api#documentation": "

    The label of the destination connector in the flow.

    " + } + }, "triggerType": { "target": "com.amazonaws.appflow#TriggerType", "traits": { @@ -3089,8 +4100,7 @@ "traits": { "smithy.api#documentation": "

    A list of field names that can be used as an ID field when performing a write operation.\n

    ", "smithy.api#length": { - "min": 0, - "max": 1 + "min": 0 } } }, @@ -3311,6 +4321,21 @@ "smithy.api#pattern": ".*" } }, + "com.amazonaws.appflow#LambdaConnectorProvisioningConfig": { + "type": "structure", + "members": { + "lambdaArn": { + "target": "com.amazonaws.appflow#ARN", + "traits": { + "smithy.api#documentation": "

    Lambda ARN of the connector being registered.

    ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

    Contains information about the configuration of the lambda which is being registered as\n the connector.

    " + } + }, "com.amazonaws.appflow#ListConnectorEntities": { "type": "operation", "input": { @@ -3351,7 +4376,7 @@ "connectorProfileName": { "target": "com.amazonaws.appflow#ConnectorProfileName", "traits": { - "smithy.api#documentation": "

    The name of the connector profile. The name is unique for each\n ConnectorProfile in the Amazon Web Services account, and is used to query the downstream\n connector.

    " + "smithy.api#documentation": "

    The name of the connector profile. The name is unique for each\n ConnectorProfile in the Amazon Web Services account, and is used to query the\n downstream connector.

    " } }, "connectorType": { @@ -3365,6 +4390,12 @@ "traits": { "smithy.api#documentation": "

    This optional parameter is specific to connector implementation. Some connectors support\n multiple levels or categories of entities. You can find out the list of roots for such\n providers by sending a request without the entitiesPath parameter. If the\n connector supports entities at different roots, this initial request returns the list of\n roots. Otherwise, this request returns all entities supported by the provider.

    " } + }, + "apiVersion": { + "target": "com.amazonaws.appflow#ApiVersion", + "traits": { + "smithy.api#documentation": "

    The version of the API that's used by the connector.

    " + } } } }, @@ -3380,6 +4411,70 @@ } } }, + "com.amazonaws.appflow#ListConnectors": { + "type": "operation", + "input": { + "target": "com.amazonaws.appflow#ListConnectorsRequest" + }, + "output": { + "target": "com.amazonaws.appflow#ListConnectorsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.appflow#InternalServerException" + }, + { + "target": "com.amazonaws.appflow#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

    Returns the list of all registered custom connectors in your Amazon Web Services account.\n This API lists only custom connectors registered in this account, not the Amazon Web Services\n authored connectors.

    ", + "smithy.api#http": { + "method": "POST", + "uri": "/list-connectors", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.appflow#ListConnectorsRequest": { + "type": "structure", + "members": { + "maxResults": { + "target": "com.amazonaws.appflow#MaxResults", + "traits": { + "smithy.api#documentation": "

    Specifies the maximum number of items that should be returned in the result set. The\n default for maxResults is 20 (for all paginated API operations).

    " + } + }, + "nextToken": { + "target": "com.amazonaws.appflow#NextToken", + "traits": { + "smithy.api#documentation": "

    The pagination token for the next page of data.

    " + } + } + } + }, + "com.amazonaws.appflow#ListConnectorsResponse": { + "type": "structure", + "members": { + "connectors": { + "target": "com.amazonaws.appflow#ConnectorList", + "traits": { + "smithy.api#documentation": "

    Contains information about the connectors supported by Amazon AppFlow.

    " + } + }, + "nextToken": { + "target": "com.amazonaws.appflow#NextToken", + "traits": { + "smithy.api#documentation": "

    The pagination token for the next page of data. If nextToken=null, this means that all\n records have been fetched.

    " + } + } + } + }, "com.amazonaws.appflow#ListFlows": { "type": "operation", "input": { @@ -3496,6 +4591,16 @@ } } }, + "com.amazonaws.appflow#LogoURL": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^(https?|ftp|file)://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]$" + } + }, "com.amazonaws.appflow#LogonLanguage": { "type": "string", "traits": { @@ -3701,6 +4806,116 @@ "smithy.api#pattern": "^\\S+$" } }, + "com.amazonaws.appflow#OAuth2Credentials": { + "type": "structure", + "members": { + "clientId": { + "target": "com.amazonaws.appflow#ClientId", + "traits": { + "smithy.api#documentation": "

    The identifier for the desired client.

    " + } + }, + "clientSecret": { + "target": "com.amazonaws.appflow#ClientSecret", + "traits": { + "smithy.api#documentation": "

    The client secret used by the OAuth client to authenticate to the authorization\n server.

    " + } + }, + "accessToken": { + "target": "com.amazonaws.appflow#AccessToken", + "traits": { + "smithy.api#documentation": "

    The access token used to access the connector on your behalf.

    " + } + }, + "refreshToken": { + "target": "com.amazonaws.appflow#RefreshToken", + "traits": { + "smithy.api#documentation": "

    The refresh token used to refresh an expired access token.

    " + } + }, + "oAuthRequest": { + "target": "com.amazonaws.appflow#ConnectorOAuthRequest" + } + }, + "traits": { + "smithy.api#documentation": "

    The OAuth 2.0 credentials required for OAuth 2.0 authentication.

    " + } + }, + "com.amazonaws.appflow#OAuth2Defaults": { + "type": "structure", + "members": { + "oauthScopes": { + "target": "com.amazonaws.appflow#OAuthScopeList", + "traits": { + "smithy.api#documentation": "

    OAuth 2.0 scopes that the connector supports.

    " + } + }, + "tokenUrls": { + "target": "com.amazonaws.appflow#TokenUrlList", + "traits": { + "smithy.api#documentation": "

    Token URLs that can be used for OAuth 2.0 authentication.

    " + } + }, + "authCodeUrls": { + "target": "com.amazonaws.appflow#AuthCodeUrlList", + "traits": { + "smithy.api#documentation": "

    Auth code URLs that can be used for OAuth 2.0 authentication.

    " + } + }, + "oauth2GrantTypesSupported": { + "target": "com.amazonaws.appflow#OAuth2GrantTypeSupportedList", + "traits": { + "smithy.api#documentation": "

    OAuth 2.0 grant types supported by the connector.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Contains the default values required for OAuth 2.0 authentication.

    " + } + }, + "com.amazonaws.appflow#OAuth2GrantType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "CLIENT_CREDENTIALS", + "name": "CLIENT_CREDENTIALS" + }, + { + "value": "AUTHORIZATION_CODE", + "name": "AUTHORIZATION_CODE" + } + ] + } + }, + "com.amazonaws.appflow#OAuth2GrantTypeSupportedList": { + "type": "list", + "member": { + "target": "com.amazonaws.appflow#OAuth2GrantType" + } + }, + "com.amazonaws.appflow#OAuth2Properties": { + "type": "structure", + "members": { + "tokenUrl": { + "target": "com.amazonaws.appflow#TokenUrl", + "traits": { + "smithy.api#documentation": "

    The token URL required for OAuth 2.0 authentication.

    ", + "smithy.api#required": {} + } + }, + "oAuth2GrantType": { + "target": "com.amazonaws.appflow#OAuth2GrantType", + "traits": { + "smithy.api#documentation": "

    The OAuth 2.0 grant type used by connector for OAuth 2.0 authentication.

    ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

    The OAuth 2.0 properties required for OAuth 2.0 authentication.

    " + } + }, "com.amazonaws.appflow#OAuthCredentials": { "type": "structure", "members": { @@ -3747,14 +4962,14 @@ "tokenUrl": { "target": "com.amazonaws.appflow#TokenUrl", "traits": { - "smithy.api#documentation": "

    The token url required to fetch access/refresh tokens using authorization code and also to refresh expired\n access token using refresh token.

    ", + "smithy.api#documentation": "

    The token url required to fetch access/refresh tokens using authorization code and also\n to refresh expired access token using refresh token.

    ", "smithy.api#required": {} } }, "authCodeUrl": { "target": "com.amazonaws.appflow#AuthCodeUrl", "traits": { - "smithy.api#documentation": "

    The authorization code url required to redirect to SAP Login Page to fetch authorization code for OAuth type\n authentication.

    ", + "smithy.api#documentation": "

    The authorization code url required to redirect to SAP Login Page to fetch authorization\n code for OAuth type authentication.

    ", "smithy.api#required": {} } }, @@ -3777,7 +4992,7 @@ "min": 0, "max": 128 }, - "smithy.api#pattern": "^[/\\w]*$" + "smithy.api#pattern": "^\\S+$" } }, "com.amazonaws.appflow#OAuthScopeList": { @@ -3942,24 +5157,115 @@ "name": "MASK_LENGTH" }, { - "value": "TRUNCATE_LENGTH", - "name": "TRUNCATE_LENGTH" + "value": "TRUNCATE_LENGTH", + "name": "TRUNCATE_LENGTH" + }, + { + "value": "MATH_OPERATION_FIELDS_ORDER", + "name": "MATH_OPERATION_FIELDS_ORDER" + }, + { + "value": "CONCAT_FORMAT", + "name": "CONCAT_FORMAT" + }, + { + "value": "SUBFIELD_CATEGORY_MAP", + "name": "SUBFIELD_CATEGORY_MAP" + }, + { + "value": "EXCLUDE_SOURCE_FIELDS_LIST", + "name": "EXCLUDE_SOURCE_FIELDS_LIST" + } + ] + } + }, + "com.amazonaws.appflow#Operators": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "PROJECTION", + "name": "PROJECTION" + }, + { + "value": "LESS_THAN", + "name": "LESS_THAN" + }, + { + "value": "GREATER_THAN", + "name": "GREATER_THAN" + }, + { + "value": "CONTAINS", + "name": "CONTAINS" + }, + { + "value": "BETWEEN", + "name": "BETWEEN" + }, + { + "value": "LESS_THAN_OR_EQUAL_TO", + "name": "LESS_THAN_OR_EQUAL_TO" + }, + { + "value": "GREATER_THAN_OR_EQUAL_TO", + "name": "GREATER_THAN_OR_EQUAL_TO" + }, + { + "value": "EQUAL_TO", + "name": "EQUAL_TO" + }, + { + "value": "NOT_EQUAL_TO", + "name": "NOT_EQUAL_TO" + }, + { + "value": "ADDITION", + "name": "ADDITION" + }, + { + "value": "MULTIPLICATION", + "name": "MULTIPLICATION" + }, + { + "value": "DIVISION", + "name": "DIVISION" + }, + { + "value": "SUBTRACTION", + "name": "SUBTRACTION" + }, + { + "value": "MASK_ALL", + "name": "MASK_ALL" + }, + { + "value": "MASK_FIRST_N", + "name": "MASK_FIRST_N" + }, + { + "value": "MASK_LAST_N", + "name": "MASK_LAST_N" + }, + { + "value": "VALIDATE_NON_NULL", + "name": "VALIDATE_NON_NULL" }, { - "value": "MATH_OPERATION_FIELDS_ORDER", - "name": "MATH_OPERATION_FIELDS_ORDER" + "value": "VALIDATE_NON_ZERO", + "name": "VALIDATE_NON_ZERO" }, { - "value": "CONCAT_FORMAT", - "name": "CONCAT_FORMAT" + "value": "VALIDATE_NON_NEGATIVE", + "name": "VALIDATE_NON_NEGATIVE" }, { - "value": "SUBFIELD_CATEGORY_MAP", - "name": "SUBFIELD_CATEGORY_MAP" + "value": "VALIDATE_NUMERIC", + "name": "VALIDATE_NUMERIC" }, { - "value": "EXCLUDE_SOURCE_FIELDS_LIST", - "name": "EXCLUDE_SOURCE_FIELDS_LIST" + "value": "NO_OP", + "name": "NO_OP" } ] } @@ -4142,6 +5448,41 @@ "smithy.api#pattern": "^$|com.amazonaws.vpce.[\\w/!:@#.\\-]+$" } }, + "com.amazonaws.appflow#ProfilePropertiesMap": { + "type": "map", + "key": { + "target": "com.amazonaws.appflow#ProfilePropertyKey" + }, + "value": { + "target": "com.amazonaws.appflow#ProfilePropertyValue" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.appflow#ProfilePropertyKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[\\w]+$" + } + }, + "com.amazonaws.appflow#ProfilePropertyValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2048 + }, + "smithy.api#pattern": "^\\S+$" + } + }, "com.amazonaws.appflow#Property": { "type": "string", "traits": { @@ -4152,6 +5493,26 @@ "smithy.api#pattern": "^.+$" } }, + "com.amazonaws.appflow#Range": { + "type": "structure", + "members": { + "maximum": { + "target": "com.amazonaws.appflow#Double", + "traits": { + "smithy.api#documentation": "

    Maximum value supported by the field.

    " + } + }, + "minimum": { + "target": "com.amazonaws.appflow#Double", + "traits": { + "smithy.api#documentation": "

    Minimum value supported by the field.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    The range of values that the property supports.

    " + } + }, "com.amazonaws.appflow#RedirectUri": { "type": "string", "traits": { @@ -4265,7 +5626,7 @@ "traits": { "smithy.api#length": { "min": 0, - "max": 512 + "max": 1024 }, "smithy.api#pattern": "^\\S+$" } @@ -4286,6 +5647,102 @@ "target": "com.amazonaws.appflow#Region" } }, + "com.amazonaws.appflow#RegisterConnector": { + "type": "operation", + "input": { + "target": "com.amazonaws.appflow#RegisterConnectorRequest" + }, + "output": { + "target": "com.amazonaws.appflow#RegisterConnectorResponse" + }, + "errors": [ + { + "target": "com.amazonaws.appflow#AccessDeniedException" + }, + { + "target": "com.amazonaws.appflow#ConflictException" + }, + { + "target": "com.amazonaws.appflow#ConnectorAuthenticationException" + }, + { + "target": "com.amazonaws.appflow#ConnectorServerException" + }, + { + "target": "com.amazonaws.appflow#InternalServerException" + }, + { + "target": "com.amazonaws.appflow#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.appflow#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.appflow#ThrottlingException" + }, + { + "target": "com.amazonaws.appflow#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

    Registers a new connector with your Amazon Web Services account. Before you can register\n the connector, you must deploy lambda in your account.

    ", + "smithy.api#http": { + "method": "POST", + "uri": "/register-connector", + "code": 200 + } + } + }, + "com.amazonaws.appflow#RegisterConnectorRequest": { + "type": "structure", + "members": { + "connectorLabel": { + "target": "com.amazonaws.appflow#ConnectorLabel", + "traits": { + "smithy.api#documentation": "

    The name of the connector. The name is unique for each ConnectorRegistration\n in your Amazon Web Services account.

    " + } + }, + "description": { + "target": "com.amazonaws.appflow#Description", + "traits": { + "smithy.api#documentation": "

    A description about the connector that's being registered.

    " + } + }, + "connectorProvisioningType": { + "target": "com.amazonaws.appflow#ConnectorProvisioningType", + "traits": { + "smithy.api#documentation": "

    The provisioning type of the connector. Currently the only supported value is LAMBDA.\n

    " + } + }, + "connectorProvisioningConfig": { + "target": "com.amazonaws.appflow#ConnectorProvisioningConfig", + "traits": { + "smithy.api#documentation": "

    The provisioning type of the connector. Currently the only supported value is\n LAMBDA.

    " + } + } + } + }, + "com.amazonaws.appflow#RegisterConnectorResponse": { + "type": "structure", + "members": { + "connectorArn": { + "target": "com.amazonaws.appflow#ARN", + "traits": { + "smithy.api#documentation": "

    The ARN of the connector being registered.

    " + } + } + } + }, + "com.amazonaws.appflow#RegisteredBy": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 512 + }, + "smithy.api#pattern": "^\\S+$" + } + }, "com.amazonaws.appflow#ResourceNotFoundException": { "type": "structure", "members": { @@ -4909,6 +6366,21 @@ }, "com.amazonaws.appflow#SandstoneConfigurationServiceLambda": { "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "Appflow", + "arnNamespace": "appflow", + "cloudFormationName": "Appflow", + "cloudTrailEventSource": "appflow.amazonaws.com", + "endpointPrefix": "appflow" + }, + "aws.auth#sigv4": { + "name": "appflow" + }, + "aws.protocols#restJson1": {}, + "smithy.api#documentation": "

    Welcome to the Amazon AppFlow API reference. This guide is for developers who need\n detailed information about the Amazon AppFlow API operations, data types, and errors.

    \n\n

    Amazon AppFlow is a fully managed integration service that enables you to securely\n transfer data between software as a service (SaaS) applications like Salesforce, Marketo,\n Slack, and ServiceNow, and Amazon Web Services like Amazon S3 and Amazon Redshift.

    \n\n\n\n

    Use the following links to get started on the Amazon AppFlow API:

    \n\n
      \n
    • \n

      \n Actions: An alphabetical list of all Amazon AppFlow API operations.

      \n
      • \n
    • \n

      \n Data\n types: An alphabetical list of all Amazon AppFlow data types.

      \n
      • \n
    • \n

      \n Common parameters: Parameters that all Query operations can use.

      \n
      • \n
    • \n

      \n Common\n errors: Client and server errors that all operations can return.

      \n
      • \n
    \n\n

    If you're new to Amazon AppFlow, we recommend that you review the Amazon AppFlow User\n Guide.

    \n

    Amazon AppFlow API users can use vendor-specific mechanisms for OAuth, and include\n applicable OAuth attributes (such as auth-code and redirecturi) with\n the connector-specific ConnectorProfileProperties when creating a new connector\n profile using Amazon AppFlow API operations. For example, Salesforce users can refer to the\n \n Authorize Apps with OAuth\n documentation.

    ", + "smithy.api#title": "Amazon Appflow" + }, "version": "2020-08-23", "operations": [ { @@ -4923,6 +6395,9 @@ { "target": "com.amazonaws.appflow#DeleteFlow" }, + { + "target": "com.amazonaws.appflow#DescribeConnector" + }, { "target": "com.amazonaws.appflow#DescribeConnectorEntity" }, @@ -4941,12 +6416,18 @@ { "target": "com.amazonaws.appflow#ListConnectorEntities" }, + { + "target": "com.amazonaws.appflow#ListConnectors" + }, { "target": "com.amazonaws.appflow#ListFlows" }, { "target": "com.amazonaws.appflow#ListTagsForResource" }, + { + "target": "com.amazonaws.appflow#RegisterConnector" + }, { "target": "com.amazonaws.appflow#StartFlow" }, @@ -4956,6 +6437,9 @@ { "target": "com.amazonaws.appflow#TagResource" }, + { + "target": "com.amazonaws.appflow#UnregisterConnector" + }, { "target": "com.amazonaws.appflow#UntagResource" }, @@ -4965,22 +6449,7 @@ { "target": "com.amazonaws.appflow#UpdateFlow" } - ], - "traits": { - "aws.api#service": { - "sdkId": "Appflow", - "arnNamespace": "appflow", - "cloudFormationName": "Appflow", - "cloudTrailEventSource": "appflow.amazonaws.com", - "endpointPrefix": "appflow" - }, - "aws.auth#sigv4": { - "name": "appflow" - }, - "aws.protocols#restJson1": {}, - "smithy.api#documentation": "

    Welcome to the Amazon AppFlow API reference. This guide is for developers who need\n detailed information about the Amazon AppFlow API operations, data types, and errors.

    \n\n

    Amazon AppFlow is a fully managed integration service that enables you to securely\n transfer data between software as a service (SaaS) applications like Salesforce, Marketo,\n Slack, and ServiceNow, and Amazon Web Services like Amazon S3 and Amazon Redshift.

    \n\n\n\n

    Use the following links to get started on the Amazon AppFlow API:

    \n\n
      \n
    • \n

      \n Actions: An alphabetical list of all Amazon AppFlow API operations.

      \n
      • \n
    • \n

      \n Data\n types: An alphabetical list of all Amazon AppFlow data types.

      \n
      • \n
    • \n

      \n Common parameters: Parameters that all Query operations can use.

      \n
      • \n
    • \n

      \n Common\n errors: Client and server errors that all operations can return.

      \n
      • \n
    \n\n

    If you're new to Amazon AppFlow, we recommend that you review the Amazon AppFlow User\n Guide.

    \n

    Amazon AppFlow API users can use vendor-specific mechanisms for OAuth, and include\n applicable OAuth attributes (such as auth-code and redirecturi) with\n the connector-specific ConnectorProfileProperties when creating a new connector\n profile using Amazon AppFlow API operations. For example, Salesforce users can refer to the\n \n Authorize Apps with OAuth\n documentation.

    ", - "smithy.api#title": "Amazon Appflow" - } + ] }, "com.amazonaws.appflow#ScheduleExpression": { "type": "string", @@ -5744,6 +7213,9 @@ }, "SAPOData": { "target": "com.amazonaws.appflow#SAPODataSourceProperties" + }, + "CustomConnector": { + "target": "com.amazonaws.appflow#CustomConnectorSourceProperties" } }, "traits": { @@ -5764,6 +7236,12 @@ "traits": { "smithy.api#documentation": "

    Indicates if the field can be queried.

    " } + }, + "isTimestampFieldForIncrementalQueries": { + "target": "com.amazonaws.appflow#Boolean", + "traits": { + "smithy.api#documentation": "

    Indicates if this timestamp field can be used for incremental queries.

    " + } } }, "traits": { @@ -5786,6 +7264,12 @@ "smithy.api#required": {} } }, + "apiVersion": { + "target": "com.amazonaws.appflow#ApiVersion", + "traits": { + "smithy.api#documentation": "

    The API version of the connector when it's used as a source in the flow.

    " + } + }, "connectorProfileName": { "target": "com.amazonaws.appflow#ConnectorProfileName", "traits": { @@ -5956,6 +7440,22 @@ "smithy.api#pattern": ".*" } }, + "com.amazonaws.appflow#SupportedApiVersion": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^\\S+$" + } + }, + "com.amazonaws.appflow#SupportedApiVersionList": { + "type": "list", + "member": { + "target": "com.amazonaws.appflow#SupportedApiVersion" + } + }, "com.amazonaws.appflow#SupportedFieldTypeDetails": { "type": "structure", "members": { @@ -5971,6 +7471,12 @@ "smithy.api#documentation": "

    Contains details regarding all the supported FieldTypes and their\n corresponding filterOperators and supportedValues.

    " } }, + "com.amazonaws.appflow#SupportedOperatorList": { + "type": "list", + "member": { + "target": "com.amazonaws.appflow#Operators" + } + }, "com.amazonaws.appflow#SupportedValueList": { "type": "list", "member": { @@ -6176,6 +7682,19 @@ "target": "com.amazonaws.appflow#Task" } }, + "com.amazonaws.appflow#ThrottlingException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.appflow#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

    API calls have exceeded the maximum allowed API request rate per account and per Region.\n

    ", + "smithy.api#error": "client", + "smithy.api#httpError": 429 + } + }, "com.amazonaws.appflow#Timezone": { "type": "string", "traits": { @@ -6196,6 +7715,12 @@ "smithy.api#pattern": "^(https?)://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]$" } }, + "com.amazonaws.appflow#TokenUrlList": { + "type": "list", + "member": { + "target": "com.amazonaws.appflow#TokenUrl" + } + }, "com.amazonaws.appflow#TrendmicroConnectorOperator": { "type": "string", "traits": { @@ -6363,6 +7888,56 @@ "target": "com.amazonaws.appflow#TriggerType" } }, + "com.amazonaws.appflow#UnregisterConnector": { + "type": "operation", + "input": { + "target": "com.amazonaws.appflow#UnregisterConnectorRequest" + }, + "output": { + "target": "com.amazonaws.appflow#UnregisterConnectorResponse" + }, + "errors": [ + { + "target": "com.amazonaws.appflow#ConflictException" + }, + { + "target": "com.amazonaws.appflow#InternalServerException" + }, + { + "target": "com.amazonaws.appflow#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

    Unregisters the custom connector registered in your account that matches the\n connectorLabel provided in the request.

    ", + "smithy.api#http": { + "method": "POST", + "uri": "/unregister-connector", + "code": 200 + } + } + }, + "com.amazonaws.appflow#UnregisterConnectorRequest": { + "type": "structure", + "members": { + "connectorLabel": { + "target": "com.amazonaws.appflow#ConnectorLabel", + "traits": { + "smithy.api#documentation": "

    The label of the connector. The label is unique for each\n ConnectorRegistration in your Amazon Web Services account.

    ", + "smithy.api#required": {} + } + }, + "forceDelete": { + "target": "com.amazonaws.appflow#Boolean", + "traits": { + "smithy.api#documentation": "

    Indicates whether Amazon AppFlow should unregister the connector, even if it is currently\n in use in one or more connector profiles. The default value is false.

    " + } + } + } + }, + "com.amazonaws.appflow#UnregisterConnectorResponse": { + "type": "structure", + "members": {} + }, "com.amazonaws.appflow#UnsupportedOperationException": { "type": "structure", "members": { @@ -6907,6 +8482,10 @@ { "value": "UPDATE", "name": "UPDATE" + }, + { + "value": "DELETE", + "name": "DELETE" } ] } diff --git a/codegen/sdk-codegen/aws-models/athena.json b/codegen/sdk-codegen/aws-models/athena.json index 604b62c72ba87..7781e7a6bd535 100644 --- a/codegen/sdk-codegen/aws-models/athena.json +++ b/codegen/sdk-codegen/aws-models/athena.json @@ -1353,7 +1353,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Streams the results of a single query execution specified by\n QueryExecutionId from the Athena query results location in\n Amazon S3. For more information, see Query Results in the Amazon Athena User Guide. This request does not execute the query\n but returns results. Use StartQueryExecution to run a query.

    \n

    To stream query results successfully, the IAM principal with permission to call\n GetQueryResults also must have permissions to the Amazon S3\n GetObject action for the Athena query results location.

    \n \n

    IAM principals with permission to the Amazon S3\n GetObject action for the query results location are able to retrieve\n query results from Amazon S3 even if permission to the\n GetQueryResults action is denied. To restrict user or role access,\n ensure that Amazon S3 permissions to the Athena query location\n are denied.

    \n     ", + "smithy.api#documentation": "

    Streams the results of a single query execution specified by\n QueryExecutionId from the Athena query results location in\n Amazon S3. For more information, see Query Results in the Amazon Athena User Guide. This request does not execute the query\n but returns results. Use StartQueryExecution to run a query.

    \n

    If the original query execution ran using an ResultConfiguration$ExpectedBucketOwner setting, the setting also\n applies to Amazon S3 read operations when GetQueryResults is\n called. If an expected bucket owner has been specified and the query results are in an\n Amazon S3 bucket whose owner account ID is different from the expected\n bucket owner, the GetQueryResults call fails with an Amazon S3\n permissions error.

    \n

    To stream query results successfully, the IAM principal with permission to call\n GetQueryResults also must have permissions to the Amazon S3\n GetObject action for the Athena query results location.

    \n \n

    IAM principals with permission to the Amazon S3\n GetObject action for the query results location are able to retrieve\n query results from Amazon S3 even if permission to the\n GetQueryResults action is denied. To restrict user or role access,\n ensure that Amazon S3 permissions to the Athena query location\n are denied.

    \n     ", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -2690,6 +2690,12 @@ "traits": { "smithy.api#documentation": "

    If query results are encrypted in Amazon S3, indicates the encryption option\n used (for example, SSE-KMS or CSE-KMS) and key information.\n This is a client-side setting. If workgroup settings override client-side settings, then\n the query uses the encryption configuration that is specified for the workgroup, and\n also uses the location for storing query results specified in the workgroup. See WorkGroupConfiguration$EnforceWorkGroupConfiguration and Workgroup Settings Override Client-Side Settings.

    " } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.athena#String", + "traits": { + "smithy.api#documentation": "

    The Amazon Web Services account ID that you expect to be the owner of the Amazon S3 bucket specified by ResultConfiguration$OutputLocation.\n If set, Athena uses the value for ExpectedBucketOwner when it\n makes Amazon S3 calls to your specified output location. If the\n ExpectedBucketOwner\n Amazon Web Services account ID does not match the actual owner of the Amazon S3\n bucket, the call fails with a permissions error.

    \n

    This is a client-side setting. If workgroup settings override client-side settings,\n then the query uses the ExpectedBucketOwner setting that is specified for\n the workgroup, and also uses the location for storing query results specified in the\n workgroup. See WorkGroupConfiguration$EnforceWorkGroupConfiguration\n and Workgroup Settings Override Client-Side Settings.

    " + } } }, "traits": { @@ -2708,7 +2714,7 @@ "RemoveOutputLocation": { "target": "com.amazonaws.athena#BoxedBoolean", "traits": { - "smithy.api#documentation": "

    If set to \"true\", indicates that the previously-specified query results location (also\n known as a client-side setting) for queries in this workgroup should be ignored and set\n to null. If set to \"false\" or not set, and a value is present in the\n OutputLocation in ResultConfigurationUpdates (the\n client-side setting), the OutputLocation in the workgroup's\n ResultConfiguration will be updated with the new value. For more\n information, see Workgroup Settings Override\n Client-Side Settings.

    " + "smithy.api#documentation": "

    If set to \"true\", indicates that the previously-specified query results location (also\n known as a client-side setting) for queries in this workgroup should be ignored and set\n to null. If set to \"false\" or not set, and a value is present in the\n OutputLocation in ResultConfigurationUpdates (the\n client-side setting), the OutputLocation in the workgroup's\n ResultConfiguration is updated with the new value. For more\n information, see Workgroup Settings Override\n Client-Side Settings.

    " } }, "EncryptionConfiguration": { @@ -2720,7 +2726,19 @@ "RemoveEncryptionConfiguration": { "target": "com.amazonaws.athena#BoxedBoolean", "traits": { - "smithy.api#documentation": "

    If set to \"true\", indicates that the previously-specified encryption configuration\n (also known as the client-side setting) for queries in this workgroup should be ignored\n and set to null. If set to \"false\" or not set, and a value is present in the\n EncryptionConfiguration in ResultConfigurationUpdates (the\n client-side setting), the EncryptionConfiguration in the workgroup's\n ResultConfiguration will be updated with the new value. For more\n information, see Workgroup Settings Override\n Client-Side Settings.

    " + "smithy.api#documentation": "

    If set to \"true\", indicates that the previously-specified encryption configuration\n (also known as the client-side setting) for queries in this workgroup should be ignored\n and set to null. If set to \"false\" or not set, and a value is present in the\n EncryptionConfiguration in ResultConfigurationUpdates (the\n client-side setting), the EncryptionConfiguration in the workgroup's\n ResultConfiguration is updated with the new value. For more\n information, see Workgroup Settings Override\n Client-Side Settings.

    " + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.athena#String", + "traits": { + "smithy.api#documentation": "

    The Amazon Web Services account ID that you expect to be the owner of the Amazon S3 bucket specified by ResultConfiguration$OutputLocation.\n If set, Athena uses the value for ExpectedBucketOwner when it\n makes Amazon S3 calls to your specified output location. If the\n ExpectedBucketOwner\n Amazon Web Services account ID does not match the actual owner of the Amazon S3\n bucket, the call fails with a permissions error.

    \n\n

    If workgroup settings override client-side settings, then the query uses the\n ExpectedBucketOwner setting that is specified for the workgroup, and\n also uses the location for storing query results specified in the workgroup. See WorkGroupConfiguration$EnforceWorkGroupConfiguration and Workgroup Settings Override Client-Side Settings.

    " + } + }, + "RemoveExpectedBucketOwner": { + "target": "com.amazonaws.athena#BoxedBoolean", + "traits": { + "smithy.api#documentation": "

    If set to \"true\", removes the Amazon Web Services account ID previously specified for\n ResultConfiguration$ExpectedBucketOwner. If set to \"false\" or not\n set, and a value is present in the ExpectedBucketOwner in\n ResultConfigurationUpdates (the client-side setting), the\n ExpectedBucketOwner in the workgroup's ResultConfiguration\n is updated with the new value. For more information, see Workgroup Settings Override\n Client-Side Settings.

    " } } }, diff --git a/codegen/sdk-codegen/aws-models/comprehend.json b/codegen/sdk-codegen/aws-models/comprehend.json index 0e7b66c68bb69..66d5408aa7651 100644 --- a/codegen/sdk-codegen/aws-models/comprehend.json +++ b/codegen/sdk-codegen/aws-models/comprehend.json @@ -76,7 +76,7 @@ "Split": { "target": "com.amazonaws.comprehend#Split", "traits": { - "smithy.api#documentation": "

    The purpose of the data you've provided in the augmented manifest. You can either train or test this data. If you don't specify, the default is train.

    \n

    TRAIN - all of the documents in the manifest will be used for training. If no test documents are provided, Amazon Comprehend will automatically reserve a portion of the training documents for testing.

    \n

    TEST - all of the documents in the manifest will be used for testing.

    " + "smithy.api#documentation": "

    The purpose of the data you've provided in the augmented manifest. You can either train or\n test this data. If you don't specify, the default is train.

    \n

    TRAIN - all of the documents in the manifest will be used for training. If no test\n documents are provided, Amazon Comprehend will automatically reserve a portion of the training\n documents for testing.

    \n

    TEST - all of the documents in the manifest will be used for testing.

    " } }, "AttributeNames": { @@ -89,19 +89,19 @@ "AnnotationDataS3Uri": { "target": "com.amazonaws.comprehend#S3Uri", "traits": { - "smithy.api#documentation": "

    The S3 prefix to the annotation files that are referred in the augmented manifest file.

    " + "smithy.api#documentation": "

    The S3 prefix to the annotation files that are referred in the augmented manifest\n file.

    " } }, "SourceDocumentsS3Uri": { "target": "com.amazonaws.comprehend#S3Uri", "traits": { - "smithy.api#documentation": "

    The S3 prefix to the source files (PDFs) that are referred to in the augmented manifest file.

    " + "smithy.api#documentation": "

    The S3 prefix to the source files (PDFs) that are referred to in the augmented manifest\n file.

    " } }, "DocumentType": { "target": "com.amazonaws.comprehend#AugmentedManifestsDocumentTypeFormat", "traits": { - "smithy.api#documentation": "

    The type of augmented manifest. PlainTextDocument or SemiStructuredDocument. If you don't specify, the default is PlainTextDocument.

    \n
      \n
    • \n

      \n PLAIN_TEXT_DOCUMENT A document type that represents any unicode text that is encoded in UTF-8.

      \n
      • \n
    • \n

      \n SEMI_STRUCTURED_DOCUMENT A document type with positional and structural context, like a PDF. For training with Amazon Comprehend, only PDFs are supported. \n For inference, Amazon Comprehend support PDFs, DOCX and TXT.

      \n
      • \n
    " + "smithy.api#documentation": "

    The type of augmented manifest. PlainTextDocument or SemiStructuredDocument. If you don't\n specify, the default is PlainTextDocument.

    \n
      \n
    • \n

      \n PLAIN_TEXT_DOCUMENT A document type that represents any unicode text that\n is encoded in UTF-8.

      \n
      • \n
    • \n

      \n SEMI_STRUCTURED_DOCUMENT A document type with positional and structural\n context, like a PDF. For training with Amazon Comprehend, only PDFs are supported. For\n inference, Amazon Comprehend support PDFs, DOCX and TXT.

      \n
      • \n
    " } } }, @@ -511,7 +511,7 @@ } }, "traits": { - "smithy.api#documentation": "

    The result of calling the operation. The operation\n returns one object that is successfully processed by the operation.

    " + "smithy.api#documentation": "

    The result of calling the operation. The\n operation returns one object that is successfully processed by the operation.

    " } }, "com.amazonaws.comprehend#BatchDetectSyntaxRequest": { @@ -539,7 +539,7 @@ "ResultList": { "target": "com.amazonaws.comprehend#ListOfDetectSyntaxResult", "traits": { - "smithy.api#documentation": "

    A list of objects containing the results\n of the operation. The results are sorted in ascending order by the Index field\n and match the order of the documents in the input list. If all of the documents contain an\n error, the ResultList is empty.

    ", + "smithy.api#documentation": "

    A list of objects containing the\n results of the operation. The results are sorted in ascending order by the Index\n field and match the order of the documents in the input list. If all of the documents contain\n an error, the ResultList is empty.

    ", "smithy.api#required": {} } }, @@ -816,6 +816,21 @@ }, "com.amazonaws.comprehend#Comprehend_20171127": { "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "Comprehend", + "arnNamespace": "comprehend", + "cloudFormationName": "Comprehend", + "cloudTrailEventSource": "comprehend.amazonaws.com", + "endpointPrefix": "comprehend" + }, + "aws.auth#sigv4": { + "name": "comprehend" + }, + "aws.protocols#awsJson1_1": {}, + "smithy.api#documentation": "

    Amazon Comprehend is an AWS service for gaining insight into the content of documents.\n Use these actions to determine the topics contained in your documents, the topics they\n discuss, the predominant sentiment expressed in them, the predominant language used, and\n more.

    ", + "smithy.api#title": "Amazon Comprehend" + }, "version": "2017-11-27", "operations": [ { @@ -857,6 +872,9 @@ { "target": "com.amazonaws.comprehend#DeleteEntityRecognizer" }, + { + "target": "com.amazonaws.comprehend#DeleteResourcePolicy" + }, { "target": "com.amazonaws.comprehend#DescribeDocumentClassificationJob" }, @@ -884,6 +902,9 @@ { "target": "com.amazonaws.comprehend#DescribePiiEntitiesDetectionJob" }, + { + "target": "com.amazonaws.comprehend#DescribeResourcePolicy" + }, { "target": "com.amazonaws.comprehend#DescribeSentimentDetectionJob" }, @@ -908,6 +929,9 @@ { "target": "com.amazonaws.comprehend#DetectSyntax" }, + { + "target": "com.amazonaws.comprehend#ImportModel" + }, { "target": "com.amazonaws.comprehend#ListDocumentClassificationJobs" }, @@ -950,6 +974,9 @@ { "target": "com.amazonaws.comprehend#ListTopicsDetectionJobs" }, + { + "target": "com.amazonaws.comprehend#PutResourcePolicy" + }, { "target": "com.amazonaws.comprehend#StartDocumentClassificationJob" }, @@ -1007,22 +1034,7 @@ { "target": "com.amazonaws.comprehend#UpdateEndpoint" } - ], - "traits": { - "aws.api#service": { - "sdkId": "Comprehend", - "arnNamespace": "comprehend", - "cloudFormationName": "Comprehend", - "cloudTrailEventSource": "comprehend.amazonaws.com", - "endpointPrefix": "comprehend" - }, - "aws.auth#sigv4": { - "name": "comprehend" - }, - "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "

    Amazon Comprehend is an AWS service for gaining insight into the content of documents.\n Use these actions to determine the topics contained in your documents, the topics they\n discuss, the predominant sentiment expressed in them, the predominant language used, and\n more.

    ", - "smithy.api#title": "Amazon Comprehend" - } + ] }, "com.amazonaws.comprehend#ConcurrentModificationException": { "type": "structure", @@ -1144,7 +1156,7 @@ "VersionName": { "target": "com.amazonaws.comprehend#VersionName", "traits": { - "smithy.api#documentation": "

    The version name given to the newly created classifier. \n Version names can have a maximum of 256 characters. Alphanumeric characters, hyphens (-) and underscores (_) are allowed. \n The version name must be unique among all models with the same classifier name in the account/AWS Region.

    " + "smithy.api#documentation": "

    The version name given to the newly created classifier. Version names can have a maximum\n of 256 characters. Alphanumeric characters, hyphens (-) and underscores (_) are allowed. The\n version name must be unique among all models with the same classifier name in the account/AWS\n Region.

    " } }, "DataAccessRoleArn": { @@ -1210,6 +1222,12 @@ "traits": { "smithy.api#documentation": "

    ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt\n trained custom models. The ModelKmsKeyId can be either of the following formats:

    \n
      \n
    • \n

      KMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n

      \n
      • \n
    • \n

      Amazon Resource Name (ARN) of a KMS Key:\n \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"\n

      \n
      • \n
    " } + }, + "ModelPolicy": { + "target": "com.amazonaws.comprehend#Policy", + "traits": { + "smithy.api#documentation": "

    The resource-based policy to attach to your custom document classifier model. You can use\n this policy to allow another AWS account to import your custom model.

    \n

    Provide your policy as a JSON body that you enter as a UTF-8 encoded string without line\n breaks. To provide valid JSON, enclose the attribute names and values in double quotes. If the\n JSON body is also enclosed in double quotes, then you must escape the double quotes that are\n inside the policy:

    \n

    \n \"{\\\"attribute\\\": \\\"value\\\", \\\"attribute\\\": [\\\"value\\\"]}\"\n

    \n

    To avoid escaping quotes, you can use single quotes to enclose the policy and double\n quotes to enclose the JSON names and values:

    \n

    \n '{\"attribute\": \"value\", \"attribute\": [\"value\"]}'\n

    " + } } } }, @@ -1259,7 +1277,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Creates a model-specific endpoint for synchronous inference for a previously trained\n custom model\n

    " + "smithy.api#documentation": "

    Creates a model-specific endpoint for synchronous inference for a previously trained\n custom model

    " } }, "com.amazonaws.comprehend#CreateEndpointRequest": { @@ -1369,7 +1387,7 @@ "VersionName": { "target": "com.amazonaws.comprehend#VersionName", "traits": { - "smithy.api#documentation": "

    The version name given to the newly created recognizer. \n Version names can be a maximum of 256 characters. Alphanumeric characters, hyphens (-) and underscores (_) are allowed. \n The version name must be unique among all models with the same recognizer name in the account/ AWS Region.

    " + "smithy.api#documentation": "

    The version name given to the newly created recognizer. Version names can be a maximum of\n 256 characters. Alphanumeric characters, hyphens (-) and underscores (_) are allowed. The\n version name must be unique among all models with the same recognizer name in the account/ AWS\n Region.

    " } }, "DataAccessRoleArn": { @@ -1423,6 +1441,12 @@ "traits": { "smithy.api#documentation": "

    ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt\n trained custom models. The ModelKmsKeyId can be either of the following formats

    \n
      \n
    • \n

      KMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n

      \n
      • \n
    • \n

      Amazon Resource Name (ARN) of a KMS Key:\n \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"\n

      \n
      • \n
    " } + }, + "ModelPolicy": { + "target": "com.amazonaws.comprehend#Policy", + "traits": { + "smithy.api#documentation": "

    The JSON resource-based policy to attach to your custom entity recognizer model. You can\n use this policy to allow another AWS account to import your custom model.

    \n

    Provide your JSON as a UTF-8 encoded string without line breaks. To provide valid JSON for\n your policy, enclose the attribute names and values in double quotes. If the JSON body is also\n enclosed in double quotes, then you must escape the double quotes that are inside the\n policy:

    \n

    \n \"{\\\"attribute\\\": \\\"value\\\", \\\"attribute\\\": [\\\"value\\\"]}\"\n

    \n

    To avoid escaping quotes, you can use single quotes to enclose the policy and double\n quotes to enclose the JSON names and values:

    \n

    \n '{\"attribute\": \"value\", \"attribute\": [\"value\"]}'\n

    " + } } } }, @@ -1596,6 +1620,51 @@ "type": "structure", "members": {} }, + "com.amazonaws.comprehend#DeleteResourcePolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.comprehend#DeleteResourcePolicyRequest" + }, + "output": { + "target": "com.amazonaws.comprehend#DeleteResourcePolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.comprehend#InternalServerException" + }, + { + "target": "com.amazonaws.comprehend#InvalidRequestException" + }, + { + "target": "com.amazonaws.comprehend#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

    Deletes a resource-based policy that is attached to a custom model.

    " + } + }, + "com.amazonaws.comprehend#DeleteResourcePolicyRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.comprehend#ComprehendModelArn", + "traits": { + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the custom model version that has the policy to delete.

    ", + "smithy.api#required": {} + } + }, + "PolicyRevisionId": { + "target": "com.amazonaws.comprehend#PolicyRevisionId", + "traits": { + "smithy.api#documentation": "

    The revision ID of the policy to delete.

    " + } + } + } + }, + "com.amazonaws.comprehend#DeleteResourcePolicyResponse": { + "type": "structure", + "members": {} + }, "com.amazonaws.comprehend#DescribeDocumentClassificationJob": { "type": "operation", "input": { @@ -2034,6 +2103,70 @@ } } }, + "com.amazonaws.comprehend#DescribeResourcePolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.comprehend#DescribeResourcePolicyRequest" + }, + "output": { + "target": "com.amazonaws.comprehend#DescribeResourcePolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.comprehend#InternalServerException" + }, + { + "target": "com.amazonaws.comprehend#InvalidRequestException" + }, + { + "target": "com.amazonaws.comprehend#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

    Gets the details of a resource-based policy that is attached to a custom model, including\n the JSON body of the policy.

    " + } + }, + "com.amazonaws.comprehend#DescribeResourcePolicyRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.comprehend#ComprehendModelArn", + "traits": { + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the policy to describe.

    ", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.comprehend#DescribeResourcePolicyResponse": { + "type": "structure", + "members": { + "ResourcePolicy": { + "target": "com.amazonaws.comprehend#Policy", + "traits": { + "smithy.api#documentation": "

    The JSON body of the resource-based policy.

    " + } + }, + "CreationTime": { + "target": "com.amazonaws.comprehend#Timestamp", + "traits": { + "smithy.api#documentation": "

    The time at which the policy was created.

    " + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.comprehend#Timestamp", + "traits": { + "smithy.api#documentation": "

    The time at which the policy was last modified.

    " + } + }, + "PolicyRevisionId": { + "target": "com.amazonaws.comprehend#PolicyRevisionId", + "traits": { + "smithy.api#documentation": "

    The revision ID of the policy. Each time you modify a policy, Amazon Comprehend assigns a\n new revision ID, and it deletes the prior version of the policy.

    " + } + } + } + }, "com.amazonaws.comprehend#DescribeSentimentDetectionJob": { "type": "operation", "input": { @@ -2722,7 +2855,7 @@ "TestS3Uri": { "target": "com.amazonaws.comprehend#S3Uri", "traits": { - "smithy.api#documentation": "

    The Amazon S3 URI for the input data. \n The Amazon S3 bucket must be in the same AWS Region as the API endpoint that you are calling.\n The URI can point to a single input file or it can provide the prefix for a collection of input files.

    " + "smithy.api#documentation": "

    The Amazon S3 URI for the input data. The Amazon S3 bucket must be in the same AWS Region\n as the API endpoint that you are calling. The URI can point to a single input file or it can\n provide the prefix for a collection of input files.

    " } }, "LabelDelimiter": { @@ -2881,6 +3014,12 @@ "traits": { "smithy.api#documentation": "

    The version name that you assigned to the document classifier.

    " } + }, + "SourceModelArn": { + "target": "com.amazonaws.comprehend#DocumentClassifierArn", + "traits": { + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the source model. This model was imported from a\n different AWS account to create the document classifier model in your AWS account.

    " + } } }, "traits": { @@ -2975,7 +3114,7 @@ "com.amazonaws.comprehend#DocumentReadFeatureTypes": { "type": "string", "traits": { - "smithy.api#documentation": "

    A list of the types of analyses to perform. This field specifies what feature types need to be extracted from the document where entity recognition is \n expected.

    \n \n
      \n
    • \n

      \n TABLES - Add TABLES to the list to return information about the tables\n that are detected in the input document.

      \n
      • \n
    • \n

      \n FORMS - Add FORMS to return detected form data.

      \n
      • \n
    ", + "smithy.api#documentation": "

    A list of the types of analyses to perform. This field specifies what feature types\n need to be extracted from the document where entity recognition is expected.

    \n\n
      \n
    • \n

      \n TABLES - Add TABLES to the list to return information about the tables\n that are detected in the input document.

      \n
      • \n
    • \n

      \n FORMS - Add FORMS to return detected form data.

      \n
      • \n
    ", "smithy.api#enum": [ { "value": "TABLES", @@ -3009,14 +3148,14 @@ "DocumentReadAction": { "target": "com.amazonaws.comprehend#DocumentReadAction", "traits": { - "smithy.api#documentation": "

    This enum field will start with two values which will apply to PDFs:

    \n
      \n
    • \n

      \n TEXTRACT_DETECT_DOCUMENT_TEXT - The service calls DetectDocumentText for PDF documents per page.

      \n
      • \n
    • \n

      \n TEXTRACT_ANALYZE_DOCUMENT - The service calls AnalyzeDocument for PDF documents per page.

      \n
      • \n
    ", + "smithy.api#documentation": "

    This enum field will start with two values which will apply to PDFs:

    \n
      \n
    • \n

      \n TEXTRACT_DETECT_DOCUMENT_TEXT - The service calls DetectDocumentText\n for PDF documents per page.

      \n
      • \n
    • \n

      \n TEXTRACT_ANALYZE_DOCUMENT - The service calls AnalyzeDocument for PDF\n documents per page.

      \n
      • \n
    ", "smithy.api#required": {} } }, "DocumentReadMode": { "target": "com.amazonaws.comprehend#DocumentReadMode", "traits": { - "smithy.api#documentation": "

    This enum field provides two values:

    \n
      \n
    • \n

      \n SERVICE_DEFAULT - use service defaults for Document reading. For Digital PDF it would mean using an internal parser instead of Textract APIs

      \n
      • \n
    • \n

      \n FORCE_DOCUMENT_READ_ACTION - Always use specified action for DocumentReadAction, including Digital PDF.\n

      \n
      • \n
    " + "smithy.api#documentation": "

    This enum field provides two values:

    \n
      \n
    • \n

      \n SERVICE_DEFAULT - use service defaults for Document reading. For\n Digital PDF it would mean using an internal parser instead of Textract APIs

      \n
      • \n
    • \n

      \n FORCE_DOCUMENT_READ_ACTION - Always use specified action for\n DocumentReadAction, including Digital PDF.

      \n
      • \n
    " } }, "FeatureTypes": { @@ -3079,7 +3218,7 @@ } }, "traits": { - "smithy.api#documentation": "

    Provides information for filtering a list of dominant language detection jobs. For more\n information, see the operation.

    " + "smithy.api#documentation": "

    Provides information for filtering a list of dominant language detection jobs. For more\n information, see the \n operation.

    " } }, "com.amazonaws.comprehend#DominantLanguageDetectionJobProperties": { @@ -3236,7 +3375,7 @@ "DesiredModelArn": { "target": "com.amazonaws.comprehend#ComprehendModelArn", "traits": { - "smithy.api#documentation": "

    ARN of the new model to use for updating an existing endpoint. This ARN is going to be different from the model ARN when the update is in progress

    " + "smithy.api#documentation": "

    ARN of the new model to use for updating an existing endpoint. This ARN is going to be\n different from the model ARN when the update is in progress

    " } }, "DesiredInferenceUnits": { @@ -3272,7 +3411,7 @@ "DesiredDataAccessRoleArn": { "target": "com.amazonaws.comprehend#IamRoleArn", "traits": { - "smithy.api#documentation": "

    Data access role ARN to use in case the new model is encrypted with a customer KMS key.

    " + "smithy.api#documentation": "

    Data access role ARN to use in case the new model is encrypted with a customer KMS\n key.

    " } } }, @@ -3514,7 +3653,7 @@ "TestS3Uri": { "target": "com.amazonaws.comprehend#S3Uri", "traits": { - "smithy.api#documentation": "

    This specifies the Amazon S3 location where the test annotations for an entity recognizer are located. \n The URI must be in the same AWS Region as the API endpoint that you are calling.

    " + "smithy.api#documentation": "

    This specifies the Amazon S3 location where the test annotations for an entity recognizer\n are located. The URI must be in the same AWS Region as the API endpoint that you are\n calling.

    " } } }, @@ -3566,13 +3705,13 @@ "TestS3Uri": { "target": "com.amazonaws.comprehend#S3Uri", "traits": { - "smithy.api#documentation": "

    Specifies the Amazon S3 location where the test documents for an entity recognizer are located. \n The URI must be in the same AWS Region as the API endpoint that you are calling.

    " + "smithy.api#documentation": "

    Specifies the Amazon S3 location where the test documents for an entity recognizer are\n located. The URI must be in the same AWS Region as the API endpoint that you are\n calling.

    " } }, "InputFormat": { "target": "com.amazonaws.comprehend#InputFormat", "traits": { - "smithy.api#documentation": "

    Specifies how the text in an input file should be processed. This is optional, and the default is ONE_DOC_PER_LINE.\n \n ONE_DOC_PER_FILE - Each file is considered a separate document. Use this option when you are processing large documents, such as newspaper articles or scientific papers.\n \n ONE_DOC_PER_LINE - Each line in a file is considered a separate document. Use this option when you are processing many short documents, such as text messages.

    " + "smithy.api#documentation": "

    Specifies how the text in an input file should be processed. This is optional, and the\n default is ONE_DOC_PER_LINE. ONE_DOC_PER_FILE - Each file is considered a separate document.\n Use this option when you are processing large documents, such as newspaper articles or\n scientific papers. ONE_DOC_PER_LINE - Each line in a file is considered a separate document.\n Use this option when you are processing many short documents, such as text messages.

    " } } }, @@ -3865,6 +4004,12 @@ "traits": { "smithy.api#documentation": "

    The version name you assigned to the entity recognizer.

    " } + }, + "SourceModelArn": { + "target": "com.amazonaws.comprehend#EntityRecognizerArn", + "traits": { + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the source model. This model was imported from a\n different AWS account to create the entity recognizer model in your AWS account.

    " + } } }, "traits": { @@ -3971,7 +4116,7 @@ "min": 0, "max": 64 }, - "smithy.api#pattern": "^(?:(?!\\\\n+|\\\\t+|\\\\r+|[\\r\\t\\n,]).)+$" + "smithy.api#pattern": "^(?![^\\n\\r\\t,]*\\\\n|\\\\r|\\\\t)[^\\n\\r\\t,]+$" } }, "com.amazonaws.comprehend#EntityTypesEvaluationMetrics": { @@ -4165,6 +4310,100 @@ "smithy.api#pattern": "^arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+$" } }, + "com.amazonaws.comprehend#ImportModel": { + "type": "operation", + "input": { + "target": "com.amazonaws.comprehend#ImportModelRequest" + }, + "output": { + "target": "com.amazonaws.comprehend#ImportModelResponse" + }, + "errors": [ + { + "target": "com.amazonaws.comprehend#InternalServerException" + }, + { + "target": "com.amazonaws.comprehend#InvalidRequestException" + }, + { + "target": "com.amazonaws.comprehend#KmsKeyValidationException" + }, + { + "target": "com.amazonaws.comprehend#ResourceInUseException" + }, + { + "target": "com.amazonaws.comprehend#ResourceLimitExceededException" + }, + { + "target": "com.amazonaws.comprehend#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.comprehend#ResourceUnavailableException" + }, + { + "target": "com.amazonaws.comprehend#TooManyRequestsException" + }, + { + "target": "com.amazonaws.comprehend#TooManyTagsException" + } + ], + "traits": { + "smithy.api#documentation": "

    Creates a new custom model that replicates a source custom model that you import. The\n source model can be in your AWS account or another one.

    \n

    If the source model is in another AWS account, then it must have a resource-based policy\n that authorizes you to import it.

    \n

    The source model must be in the same AWS region that you're using when you import. You\n can't import a model that's in a different region.

    " + } + }, + "com.amazonaws.comprehend#ImportModelRequest": { + "type": "structure", + "members": { + "SourceModelArn": { + "target": "com.amazonaws.comprehend#ComprehendModelArn", + "traits": { + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the custom model to import.

    ", + "smithy.api#required": {} + } + }, + "ModelName": { + "target": "com.amazonaws.comprehend#ComprehendArnName", + "traits": { + "smithy.api#documentation": "

    The name to assign to the custom model that is created in Amazon Comprehend by this\n import.

    " + } + }, + "VersionName": { + "target": "com.amazonaws.comprehend#VersionName", + "traits": { + "smithy.api#documentation": "

    The version name given to the custom model that is created by this import. Version names\n can have a maximum of 256 characters. Alphanumeric characters, hyphens (-) and underscores (_)\n are allowed. The version name must be unique among all models with the same classifier name in\n the account/AWS Region.

    " + } + }, + "ModelKmsKeyId": { + "target": "com.amazonaws.comprehend#KmsKeyId", + "traits": { + "smithy.api#documentation": "

    ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt\n trained custom models. The ModelKmsKeyId can be either of the following formats:

    \n
      \n
    • \n

      KMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n

      \n
      • \n
    • \n

      Amazon Resource Name (ARN) of a KMS Key:\n \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"\n

      \n
      • \n
    " + } + }, + "DataAccessRoleArn": { + "target": "com.amazonaws.comprehend#IamRoleArn", + "traits": { + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that allows\n Amazon Comprehend to use Amazon Key Management Service (KMS) to encrypt or decrypt the custom\n model.

    " + } + }, + "Tags": { + "target": "com.amazonaws.comprehend#TagList", + "traits": { + "smithy.api#documentation": "

    Tags to be associated with the custom model that is created by this import. A tag is a\n key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a\n tag with \"Sales\" as the key might be added to a resource to indicate its use by the sales\n department.

    " + } + } + } + }, + "com.amazonaws.comprehend#ImportModelResponse": { + "type": "structure", + "members": { + "ModelArn": { + "target": "com.amazonaws.comprehend#ComprehendModelArn", + "traits": { + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the custom model being imported.

    " + } + } + } + }, "com.amazonaws.comprehend#InferenceUnitsInteger": { "type": "integer", "traits": { @@ -4193,7 +4432,7 @@ "DocumentReaderConfig": { "target": "com.amazonaws.comprehend#DocumentReaderConfig", "traits": { - "smithy.api#documentation": "

    The document reader config field applies only for InputDataConfig of StartEntitiesDetectionJob.

    \n

    Use DocumentReaderConfig to provide specifications about how you want your inference documents read.\n Currently it applies for PDF documents in StartEntitiesDetectionJob custom inference.

    " + "smithy.api#documentation": "

    The document reader config field applies only for InputDataConfig of\n StartEntitiesDetectionJob.

    \n

    Use DocumentReaderConfig to provide specifications about how you want your inference\n documents read. Currently it applies for PDF documents in StartEntitiesDetectionJob custom\n inference.

    " } } }, @@ -6100,6 +6339,85 @@ "smithy.api#documentation": "

    Provides configuration parameters for the output of PII entity detection jobs.

    " } }, + "com.amazonaws.comprehend#Policy": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 20000 + }, + "smithy.api#pattern": "^[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+$" + } + }, + "com.amazonaws.comprehend#PolicyRevisionId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 64 + }, + "smithy.api#pattern": "^[0-9A-Fa-f]+$" + } + }, + "com.amazonaws.comprehend#PutResourcePolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.comprehend#PutResourcePolicyRequest" + }, + "output": { + "target": "com.amazonaws.comprehend#PutResourcePolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.comprehend#InternalServerException" + }, + { + "target": "com.amazonaws.comprehend#InvalidRequestException" + }, + { + "target": "com.amazonaws.comprehend#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

    Attaches a resource-based policy to a custom model. You can use this policy to authorize\n an entity in another AWS account to import the custom model, which replicates it in Amazon\n Comprehend in their account.

    " + } + }, + "com.amazonaws.comprehend#PutResourcePolicyRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.comprehend#ComprehendModelArn", + "traits": { + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the custom model to attach the policy to.

    ", + "smithy.api#required": {} + } + }, + "ResourcePolicy": { + "target": "com.amazonaws.comprehend#Policy", + "traits": { + "smithy.api#documentation": "

    The JSON resource-based policy to attach to your custom model. Provide your JSON as a\n UTF-8 encoded string without line breaks. To provide valid JSON for your policy, enclose the\n attribute names and values in double quotes. If the JSON body is also enclosed in double\n quotes, then you must escape the double quotes that are inside the policy:

    \n

    \n \"{\\\"attribute\\\": \\\"value\\\", \\\"attribute\\\": [\\\"value\\\"]}\"\n

    \n

    To avoid escaping quotes, you can use single quotes to enclose the policy and double\n quotes to enclose the JSON names and values:

    \n

    \n '{\"attribute\": \"value\", \"attribute\": [\"value\"]}'\n

    ", + "smithy.api#required": {} + } + }, + "PolicyRevisionId": { + "target": "com.amazonaws.comprehend#PolicyRevisionId", + "traits": { + "smithy.api#documentation": "

    The revision ID that Amazon Comprehend assigned to the policy that you are updating. If\n you are creating a new policy that has no prior version, don't use this parameter. Amazon\n Comprehend creates the revision ID for you.

    " + } + } + } + }, + "com.amazonaws.comprehend#PutResourcePolicyResponse": { + "type": "structure", + "members": { + "PolicyRevisionId": { + "target": "com.amazonaws.comprehend#PolicyRevisionId", + "traits": { + "smithy.api#documentation": "

    The revision ID of the policy. Each time you modify a policy, Amazon Comprehend assigns a\n new revision ID, and it deletes the prior version of the policy.

    " + } + } + } + }, "com.amazonaws.comprehend#RedactionConfig": { "type": "structure", "members": { diff --git a/codegen/sdk-codegen/aws-models/cost-explorer.json b/codegen/sdk-codegen/aws-models/cost-explorer.json index 5321d6f0def83..284808505d469 100644 --- a/codegen/sdk-codegen/aws-models/cost-explorer.json +++ b/codegen/sdk-codegen/aws-models/cost-explorer.json @@ -1620,6 +1620,10 @@ "value": "LEGAL_ENTITY_NAME", "name": "LEGAL_ENTITY_NAME" }, + { + "value": "INVOICING_ENTITY", + "name": "INVOICING_ENTITY" + }, { "value": "DEPLOYMENT_OPTION", "name": "DEPLOYMENT_OPTION" @@ -2502,7 +2506,7 @@ "Filter": { "target": "com.amazonaws.costexplorer#Expression", "traits": { - "smithy.api#documentation": "

    Filters Amazon Web Services costs by different dimensions. For example, you can specify SERVICE and LINKED_ACCOUNT \n\t\t\tand get the costs that are associated with that account's usage of that service. You can nest Expression objects \n\t\t\tto define any combination of dimension filters. For more information, see \n\t\t\tExpression.

    \n\t

    The default values are EQUALS and CASE_SENSITIVE. Valid values for MatchOptions for Dimensions are EQUALS and CASE_SENSITIVE.

    \n\t

    Valid values for MatchOptions for CostCategories and Tags are EQUALS, ABSENT, and CASE_SENSITIVE.

    " + "smithy.api#documentation": "

    Filters Amazon Web Services costs by different dimensions. For example, you can specify SERVICE and LINKED_ACCOUNT \n\t\t\tand get the costs that are associated with that account's usage of that service. You can nest Expression objects \n\t\t\tto define any combination of dimension filters. For more information, see \n\t\t\tExpression.

    \n\t

    Valid values for MatchOptions for CostCategories and Tags are EQUALS, ABSENT, and CASE_SENSITIVE.

    \n\t

    The default values are EQUALS and CASE_SENSITIVE. Valid values for MatchOptions for Dimensions are EQUALS and CASE_SENSITIVE.

    " } }, "Metrics": { @@ -2515,7 +2519,7 @@ "GroupBy": { "target": "com.amazonaws.costexplorer#GroupDefinitions", "traits": { - "smithy.api#documentation": "

    You can group Amazon Web Services costs using up to two different groups, either dimensions, tag keys,\n cost categories, or any two group by types.

    \n\t

    Valid values for the DIMENSION type are AZ, INSTANCE_TYPE, LEGAL_ENTITY_NAME, LINKED_ACCOUNT, \n\t\t\tOPERATION, PLATFORM, PURCHASE_TYPE, SERVICE,\n\t\t TENANCY, RECORD_TYPE, and USAGE_TYPE.

    \n\t

    When you group by the TAG type and include a valid tag key, you get all tag values, including empty strings.

    " + "smithy.api#documentation": "

    You can group Amazon Web Services costs using up to two different groups, either dimensions, tag keys,\n cost categories, or any two group by types.

    \n\t

    Valid values for the DIMENSION type are AZ, INSTANCE_TYPE, LEGAL_ENTITY_NAME, INVOICING_ENTITY, LINKED_ACCOUNT, \n\t\t\tOPERATION, PLATFORM, PURCHASE_TYPE, SERVICE,\n\t\t TENANCY, RECORD_TYPE, and USAGE_TYPE.

    \n\t

    When you group by the TAG type and include a valid tag key, you get all tag values, including empty strings.

    " } }, "NextPageToken": { @@ -2604,7 +2608,7 @@ "Filter": { "target": "com.amazonaws.costexplorer#Expression", "traits": { - "smithy.api#documentation": "

    Filters Amazon Web Services costs by different dimensions. For example, you can specify\n SERVICE and LINKED_ACCOUNT and get the costs that are associated\n with that account's usage of that service. You can nest Expression objects to\n define any combination of dimension filters. For more information, see Expression.

    \n

    The GetCostAndUsageWithResources operation requires that you either group by or filter by a\n ResourceId. It requires the Expression \n \"SERVICE = Amazon Elastic Compute Cloud - Compute\" in the filter.

    \n

    The default values are EQUALS and CASE_SENSITIVE. Valid values for MatchOptions for Dimensions are EQUALS and CASE_SENSITIVE.

    \n

    Valid values for MatchOptions for CostCategories and Tags are EQUALS, ABSENT, and CASE_SENSITIVE.

    ", + "smithy.api#documentation": "

    Filters Amazon Web Services costs by different dimensions. For example, you can specify\n SERVICE and LINKED_ACCOUNT and get the costs that are associated\n with that account's usage of that service. You can nest Expression objects to\n define any combination of dimension filters. For more information, see Expression.

    \n

    The GetCostAndUsageWithResources operation requires that you either group by or filter by a\n ResourceId. It requires the Expression \n \"SERVICE = Amazon Elastic Compute Cloud - Compute\" in the filter.

    \n

    Valid values for MatchOptions for CostCategories and Tags are EQUALS, ABSENT, and CASE_SENSITIVE.

    \n

    The default values are EQUALS and CASE_SENSITIVE. Valid values for MatchOptions for Dimensions are EQUALS and CASE_SENSITIVE.

    ", "smithy.api#required": {} } }, @@ -2887,14 +2891,14 @@ "Dimension": { "target": "com.amazonaws.costexplorer#Dimension", "traits": { - "smithy.api#documentation": "

    The name of the dimension. Each Dimension is available for a different Context. \n\t\t For more information, see Context. \n\t\t\t\n\t\t

    ", + "smithy.api#documentation": "

    The name of the dimension. Each Dimension is available for a different Context. \n\t\t\tFor more information, see Context. \n\t\t\t\n\t\t

    ", "smithy.api#required": {} } }, "Context": { "target": "com.amazonaws.costexplorer#Context", "traits": { - "smithy.api#documentation": "

    The context for the call to GetDimensionValues. This can be RESERVATIONS or COST_AND_USAGE. \n\t\t\tThe default value is COST_AND_USAGE. If the context is set to RESERVATIONS, the resulting dimension values \n\t\t\tcan be used in the GetReservationUtilization operation. If the context is set to COST_AND_USAGE, \n\t\t\tthe resulting dimension values can be used in the GetCostAndUsage operation.

    \n\t\t

    If you set the context to COST_AND_USAGE, you can use the following \n dimensions for searching:

    \n
      \n
    • \n

      AZ - The Availability Zone. An example is us-east-1a.

      \n
      • \n
    • \n

      DATABASE_ENGINE - The Amazon Relational Database Service database. Examples are Aurora or MySQL.

      \n
      • \n
    • \n

      INSTANCE_TYPE - The type of Amazon EC2 instance. An example is m4.xlarge.

      \n
      • \n
    • \n

      LEGAL_ENTITY_NAME - The name of the organization that sells you Amazon Web Services services, such as Amazon Web Services.

      \n
      • \n
    • \n

      LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value \n field contains the Amazon Web Services ID of the member account.

      \n
      • \n
    • \n

      OPERATING_SYSTEM - The operating system. Examples are Windows or Linux.

      \n
      • \n
    • \n

      OPERATION - The action performed. Examples include RunInstance and CreateBucket.

      \n
      • \n
    • \n

      PLATFORM - The Amazon EC2 operating system. Examples are Windows or Linux.

      \n
      • \n
    • \n

      PURCHASE_TYPE - The reservation type of the purchase to which this usage is related. Examples include On-Demand \n Instances and Standard Reserved Instances.

      \n
      • \n
    • \n

      SERVICE - The Amazon Web Services service such as Amazon DynamoDB.

      \n
      • \n
    • \n

      USAGE_TYPE - The type of usage. An example is DataTransfer-In-Bytes. The response for the GetDimensionValues operation\n includes a unit attribute. Examples include GB and Hrs.

      \n
      • \n
    • \n

      USAGE_TYPE_GROUP - The grouping of common usage types. An example is Amazon EC2: CloudWatch – Alarms. The response for this \n operation includes a unit attribute.

      \n
      • \n
    • \n

      REGION - The Amazon Web Services Region.

      \n
      • \n
    • \n

      RECORD_TYPE - The different types of charges such as RI fees, usage costs, tax refunds, and credits.

      \n
      • \n
    • \n

      RESOURCE_ID - The unique identifier of the resource. ResourceId is an opt-in feature only available for last 14 days for EC2-Compute Service.

      \n
      • \n
    \n

    If you set the context to RESERVATIONS, you can use the following \n dimensions for searching:

    \n
      \n
    • \n

      AZ - The Availability Zone. An example is us-east-1a.

      \n
      • \n
    • \n

      CACHE_ENGINE - The Amazon ElastiCache operating system. Examples are Windows or Linux.

      \n
      • \n
    • \n

      DEPLOYMENT_OPTION - The scope of Amazon Relational Database Service deployments. Valid values are SingleAZ and MultiAZ.

      \n
      • \n
    • \n

      INSTANCE_TYPE - The type of Amazon EC2 instance. An example is m4.xlarge.

      \n
      • \n
    • \n

      LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value \n field contains the Amazon Web Services ID of the member account.

      \n
      • \n
    • \n

      PLATFORM - The Amazon EC2 operating system. Examples are Windows or Linux.

      \n
      • \n
    • \n

      REGION - The Amazon Web Services Region.

      \n
      • \n
    • \n

      SCOPE (Utilization only) - The scope of a Reserved Instance (RI). Values are regional or a single Availability Zone.

      \n
      • \n
    • \n

      TAG (Coverage only) - The tags that are associated with a Reserved Instance (RI).

      \n
      • \n
    • \n

      TENANCY - The tenancy of a resource. Examples are shared or dedicated.

      \n
      • \n
    \n

    If you set the context to SAVINGS_PLANS, you can use the following dimensions for searching:

    \n
      \n
    • \n

      SAVINGS_PLANS_TYPE - Type of Savings Plans (EC2 Instance or Compute)

      \n
      • \n
    • \n

      PAYMENT_OPTION - Payment option for the given Savings Plans (for example, All Upfront)

      \n
      • \n
    • \n

      REGION - The Amazon Web Services Region.

      \n
      • \n
    • \n

      INSTANCE_TYPE_FAMILY - The family of instances (For example, m5)

      \n
      • \n
    • \n

      LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value \n field contains the Amazon Web Services ID of the member account.

      \n
      • \n
    • \n

      SAVINGS_PLAN_ARN - The unique identifier for your Savings Plan

      \n
      • \n
    " + "smithy.api#documentation": "

    The context for the call to GetDimensionValues. This can be RESERVATIONS or COST_AND_USAGE. \n\t\t\tThe default value is COST_AND_USAGE. If the context is set to RESERVATIONS, the resulting dimension values \n\t\t\tcan be used in the GetReservationUtilization operation. If the context is set to COST_AND_USAGE, \n\t\t\tthe resulting dimension values can be used in the GetCostAndUsage operation.

    \n\t\t

    If you set the context to COST_AND_USAGE, you can use the following \n dimensions for searching:

    \n
      \n
    • \n

      AZ - The Availability Zone. An example is us-east-1a.

      \n
      • \n
    • \n

      BILLING_ENTITY - The Amazon Web Services seller that your account is with. Possible values are the following:

      \n

      - Amazon Web Services(Amazon Web Services): The entity that sells Amazon Web Services services.

      \n

      - AISPL (Amazon Internet Services Pvt. Ltd.): The local Indian entity that is an acting reseller for Amazon Web Services services in India.

      \n

      - Amazon Web Services Marketplace: The entity that supports the sale of solutions built on Amazon Web Services by third-party software providers.

      \n
      • \n
    • \n

      CACHE_ENGINE - The Amazon ElastiCache operating system. Examples are Windows or Linux.

      \n
      • \n
    • \n

      DEPLOYMENT_OPTION - The scope of Amazon Relational Database Service deployments. Valid values are SingleAZ and MultiAZ.

      \n
      • \n
    • \n

      DATABASE_ENGINE - The Amazon Relational Database Service database. Examples are Aurora or MySQL.

      \n
      • \n
    • \n

      INSTANCE_TYPE - The type of Amazon EC2 instance. An example is m4.xlarge.

      \n
      • \n
    • \n

      INSTANCE_TYPE_FAMILY - A family of instance types optimized to fit different use cases. Examples are Compute Optimized (C4, C5, C6g, C7g etc.), Memory Optimization (R4, R5n, R5b, R6g etc).

      \n
      • \n
    • \n

      INVOICING_ENTITY - The name of the entity issuing the Amazon Web Services invoice.

      \n
      • \n
    • \n

      LEGAL_ENTITY_NAME - The name of the organization that sells you Amazon Web Services services, such as Amazon Web Services.

      \n
      • \n
    • \n

      LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value \n field contains the Amazon Web Services ID of the member account.

      \n
      • \n
    • \n

      OPERATING_SYSTEM - The operating system. Examples are Windows or Linux.

      \n
      • \n
    • \n

      OPERATION - The action performed. Examples include RunInstance and CreateBucket.

      \n
      • \n
    • \n

      PLATFORM - The Amazon EC2 operating system. Examples are Windows or Linux.

      \n
      • \n
    • \n

      PURCHASE_TYPE - The reservation type of the purchase to which this usage is related. Examples include On-Demand \n Instances and Standard Reserved Instances.

      \n
      • \n
    • \n

      RESERVATION_ID - The unique identifier for an Amazon Web Services Reservation Instance.

      \n
      • \n
    • \n

      SAVINGS_PLAN_ARN - The unique identifier for your Savings Plans.

      \n
      • \n
    • \n

      SAVINGS_PLANS_TYPE - Type of Savings Plans (EC2 Instance or Compute).

      \n
      • \n
    • \n

      SERVICE - The Amazon Web Services service such as Amazon DynamoDB.

      \n
      • \n
    • \n

      TENANCY - The tenancy of a resource. Examples are shared or dedicated.

      \n
      • \n
    • \n

      USAGE_TYPE - The type of usage. An example is DataTransfer-In-Bytes. The response for the GetDimensionValues operation\n includes a unit attribute. Examples include GB and Hrs.

      \n
      • \n
    • \n

      USAGE_TYPE_GROUP - The grouping of common usage types. An example is Amazon EC2: CloudWatch – Alarms. The response for this \n operation includes a unit attribute.

      \n
      • \n
    • \n

      REGION - The Amazon Web Services Region.

      \n
      • \n
    • \n

      RECORD_TYPE - The different types of charges such as RI fees, usage costs, tax refunds, and credits.

      \n
      • \n
    • \n

      RESOURCE_ID - The unique identifier of the resource. ResourceId is an opt-in feature only available for last 14 days for EC2-Compute Service.

      \n
      • \n
    \n

    If you set the context to RESERVATIONS, you can use the following \n dimensions for searching:

    \n
      \n
    • \n

      AZ - The Availability Zone. An example is us-east-1a.

      \n
      • \n
    • \n

      CACHE_ENGINE - The Amazon ElastiCache operating system. Examples are Windows or Linux.

      \n
      • \n
    • \n

      DEPLOYMENT_OPTION - The scope of Amazon Relational Database Service deployments. Valid values are SingleAZ and MultiAZ.

      \n
      • \n
    • \n

      INSTANCE_TYPE - The type of Amazon EC2 instance. An example is m4.xlarge.

      \n
      • \n
    • \n

      LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value \n field contains the Amazon Web Services ID of the member account.

      \n
      • \n
    • \n

      PLATFORM - The Amazon EC2 operating system. Examples are Windows or Linux.

      \n
      • \n
    • \n

      REGION - The Amazon Web Services Region.

      \n
      • \n
    • \n

      SCOPE (Utilization only) - The scope of a Reserved Instance (RI). Values are regional or a single Availability Zone.

      \n
      • \n
    • \n

      TAG (Coverage only) - The tags that are associated with a Reserved Instance (RI).

      \n
      • \n
    • \n

      TENANCY - The tenancy of a resource. Examples are shared or dedicated.

      \n
      • \n
    \n

    If you set the context to SAVINGS_PLANS, you can use the following dimensions for searching:

    \n
      \n
    • \n

      SAVINGS_PLANS_TYPE - Type of Savings Plans (EC2 Instance or Compute)

      \n
      • \n
    • \n

      PAYMENT_OPTION - Payment option for the given Savings Plans (for example, All Upfront)

      \n
      • \n
    • \n

      REGION - The Amazon Web Services Region.

      \n
      • \n
    • \n

      INSTANCE_TYPE_FAMILY - The family of instances (For example, m5)

      \n
      • \n
    • \n

      LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value \n field contains the Amazon Web Services ID of the member account.

      \n
      • \n
    • \n

      SAVINGS_PLAN_ARN - The unique identifier for your Savings Plans.

      \n
      • \n
    " } }, "Filter": { @@ -2988,7 +2992,7 @@ "GroupBy": { "target": "com.amazonaws.costexplorer#GroupDefinitions", "traits": { - "smithy.api#documentation": "

    You can group the data by the following attributes:

    \n\t\t
      \n
    • \n

      AZ

      \n
      • \n
    • \n

      CACHE_ENGINE

      \n
      • \n
    • \n

      DATABASE_ENGINE

      \n
      • \n
    • \n

      DEPLOYMENT_OPTION

      \n
      • \n
    • \n

      INSTANCE_TYPE

      \n
      • \n
    • \n

      LINKED_ACCOUNT

      \n
      • \n
    • \n

      OPERATING_SYSTEM

      \n
      • \n
    • \n

      PLATFORM

      \n
      • \n
    • \n

      REGION

      \n
      • \n
    • \n

      TENANCY

      \n
      • \n
    " + "smithy.api#documentation": "

    You can group the data by the following attributes:

    \n\t\t
      \n
    • \n

      AZ

      \n
      • \n
    • \n

      CACHE_ENGINE

      \n
      • \n
    • \n

      DATABASE_ENGINE

      \n
      • \n
    • \n

      DEPLOYMENT_OPTION

      \n
      • \n
    • \n

      INSTANCE_TYPE

      \n
      • \n
    • \n

      INVOICING_ENTITY

      \n
      • \n
    • \n

      LINKED_ACCOUNT

      \n
      • \n
    • \n

      OPERATING_SYSTEM

      \n
      • \n
    • \n

      PLATFORM

      \n
      • \n
    • \n

      REGION

      \n
      • \n
    • \n

      TENANCY

      \n
      • \n
    " } }, "Granularity": { @@ -3000,7 +3004,7 @@ "Filter": { "target": "com.amazonaws.costexplorer#Expression", "traits": { - "smithy.api#documentation": "

    Filters utilization data by dimensions. You can filter by the following dimensions:

    \n\t\t
      \n
    • \n

      AZ

      \n
      • \n
    • \n

      CACHE_ENGINE

      \n
      • \n
    • \n

      DATABASE_ENGINE

      \n
      • \n
    • \n

      DEPLOYMENT_OPTION

      \n
      • \n
    • \n

      INSTANCE_TYPE

      \n
      • \n
    • \n

      LINKED_ACCOUNT

      \n
      • \n
    • \n

      OPERATING_SYSTEM

      \n
      • \n
    • \n

      PLATFORM

      \n
      • \n
    • \n

      REGION

      \n
      • \n
    • \n

      SERVICE

      \n
      • \n
    • \n

      TAG

      \n
      • \n
    • \n

      TENANCY

      \n
      • \n
    \n\t\t

    \n GetReservationCoverage uses the same \n\t\t\tExpression object \n\t\t\tas the other operations, but only AND is supported among each dimension. You can nest only one level deep.

    \n\t\t

    If you don't provide a SERVICE filter, Cost Explorer defaults to EC2.

    \n\t

    Cost category is also supported.

    " + "smithy.api#documentation": "

    Filters utilization data by dimensions. You can filter by the following dimensions:

    \n\t\t
      \n
    • \n

      AZ

      \n
      • \n
    • \n

      CACHE_ENGINE

      \n
      • \n
    • \n

      DATABASE_ENGINE

      \n
      • \n
    • \n

      DEPLOYMENT_OPTION

      \n
      • \n
    • \n

      INSTANCE_TYPE

      \n
      • \n
    • \n

      LINKED_ACCOUNT

      \n
      • \n
    • \n

      OPERATING_SYSTEM

      \n
      • \n
    • \n

      PLATFORM

      \n
      • \n
    • \n

      REGION

      \n
      • \n
    • \n

      SERVICE

      \n
      • \n
    • \n

      TAG

      \n
      • \n
    • \n

      TENANCY

      \n
      • \n
    \n\t\t

    \n GetReservationCoverage uses the same \n\t\t\tExpression object \n\t\t\tas the other operations, but only AND is supported among each dimension. You can nest only one level deep. \n\t\t\tIf there are multiple values for a dimension, they are OR'd together.

    \n\t\t

    If you don't provide a SERVICE filter, Cost Explorer defaults to EC2.

    \n\t

    Cost category is also supported.

    " } }, "Metrics": { @@ -3214,7 +3218,7 @@ "Filter": { "target": "com.amazonaws.costexplorer#Expression", "traits": { - "smithy.api#documentation": "

    Filters utilization data by dimensions. You can filter by the following dimensions:

    \n\t\t
      \n
    • \n

      AZ

      \n
      • \n
    • \n

      CACHE_ENGINE

      \n
      • \n
    • \n

      DEPLOYMENT_OPTION

      \n
      • \n
    • \n

      INSTANCE_TYPE

      \n
      • \n
    • \n

      LINKED_ACCOUNT

      \n
      • \n
    • \n

      OPERATING_SYSTEM

      \n
      • \n
    • \n

      PLATFORM

      \n
      • \n
    • \n

      REGION

      \n
      • \n
    • \n

      SERVICE

      \n
      • \n
    • \n

      SCOPE

      \n
      • \n
    • \n

      TENANCY

      \n
      • \n
    \n\t\t

    \n GetReservationUtilization uses the same \n\t\t\tExpression object \n\t\t\tas the other operations, but only AND is supported among each dimension, and nesting is supported up to \n\t\t\tonly one level deep.

    " + "smithy.api#documentation": "

    Filters utilization data by dimensions. You can filter by the following dimensions:

    \n\t\t
      \n
    • \n

      AZ

      \n
      • \n
    • \n

      CACHE_ENGINE

      \n
      • \n
    • \n

      DEPLOYMENT_OPTION

      \n
      • \n
    • \n

      INSTANCE_TYPE

      \n
      • \n
    • \n

      LINKED_ACCOUNT

      \n
      • \n
    • \n

      OPERATING_SYSTEM

      \n
      • \n
    • \n

      PLATFORM

      \n
      • \n
    • \n

      REGION

      \n
      • \n
    • \n

      SERVICE

      \n
      • \n
    • \n

      SCOPE

      \n
      • \n
    • \n

      TENANCY

      \n
      • \n
    \n\t\t

    \n GetReservationUtilization uses the same \n\t\t\tExpression object \n\t\t\tas the other operations, but only AND is supported among each dimension, and nesting is supported up to \n\t\t\tonly one level deep. If there are multiple values for a dimension, they are OR'd together.

    " } }, "SortBy": { @@ -3370,7 +3374,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Retrieves the Savings Plans covered for your account. This enables you to see how much of your cost is covered by a Savings Plan. An organization’s management account can see the coverage of the associated member accounts. This supports dimensions, Cost Categories, and nested expressions. For any time period, you can filter data for Savings Plans usage with the following dimensions:

    \n\t
      \n
    • \n

      \n LINKED_ACCOUNT\n

      \n
      • \n
    • \n

      \n REGION\n

      \n
      • \n
    • \n

      \n SERVICE\n

      \n
      • \n
    • \n

      \n INSTANCE_FAMILY\n

      \n
      • \n
    \n \n

    \n GetSavingsPlansCoverage doesn't support filtering by tags. GetSavingsPlansCoverage also doesn't support the OR operator between filter dimensions. For the full request syntax with supported parameters, see Examples.

    \n     \n\t

    To determine valid values for a dimension, use the GetDimensionValues operation.

    ", + "smithy.api#documentation": "

    Retrieves the Savings Plans covered for your account. This enables you to see how much of your cost is covered by a Savings Plan. An organization’s management account can see the coverage of the associated member accounts. This supports dimensions, Cost Categories, and nested expressions. For any time period, you can filter data for Savings Plans usage with the following dimensions:

    \n\t
      \n
    • \n

      \n LINKED_ACCOUNT\n

      \n
      • \n
    • \n

      \n REGION\n

      \n
      • \n
    • \n

      \n SERVICE\n

      \n
      • \n
    • \n

      \n INSTANCE_FAMILY\n

      \n
      • \n
    \n\t

    To determine valid values for a dimension, use the GetDimensionValues operation.

    ", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -3403,7 +3407,7 @@ "Filter": { "target": "com.amazonaws.costexplorer#Expression", "traits": { - "smithy.api#documentation": "

    Filters Savings Plans coverage data by dimensions. You can filter data for Savings Plans usage with the following dimensions:

    \n
      \n
    • \n

      \n LINKED_ACCOUNT\n

      \n
      • \n
    • \n

      \n REGION\n

      \n
      • \n
    • \n

      \n SERVICE\n

      \n
      • \n
    • \n

      \n INSTANCE_FAMILY\n

      \n
      • \n
    \n

    \n GetSavingsPlansCoverage uses the same \n Expression object \n as the other operations, but only AND is supported among each dimension.

    \n

    Cost category is supported. Tags are not supported.

    " + "smithy.api#documentation": "

    Filters Savings Plans coverage data by dimensions. You can filter data for Savings Plans usage with the following dimensions:

    \n
      \n
    • \n

      \n LINKED_ACCOUNT\n

      \n
      • \n
    • \n

      \n REGION\n

      \n
      • \n
    • \n

      \n SERVICE\n

      \n
      • \n
    • \n

      \n INSTANCE_FAMILY\n

      \n
      • \n
    \n

    \n GetSavingsPlansCoverage uses the same \n Expression object \n as the other operations, but only AND is supported among each dimension. If there are multiple values for a dimension, they are OR'd together.

    \n

    Cost category is also supported.

    " } }, "Metrics": { @@ -3568,7 +3572,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Retrieves the Savings Plans utilization for your account across date ranges with daily or monthly granularity. Management account in an organization have access to member accounts. You can use GetDimensionValues in SAVINGS_PLANS to determine the possible dimension values.

    \n\t \n

    You cannot group by any dimension values for GetSavingsPlansUtilization.

    \n

    \n GetSavingsPlansUtilization doesn't support filtering by tags. GetSavingsPlansUtilization also doesn't support the OR operator between filter dimensions. For the full request syntax with supported parameters, see Examples.

    \n     " + "smithy.api#documentation": "

    Retrieves the Savings Plans utilization for your account across date ranges with daily or monthly granularity. Management account in an organization have access to member accounts. You can use GetDimensionValues in SAVINGS_PLANS to determine the possible dimension values.

    \n\t \n

    You cannot group by any dimension values for GetSavingsPlansUtilization.

    \n     " } }, "com.amazonaws.costexplorer#GetSavingsPlansUtilizationDetails": { @@ -3591,7 +3595,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Retrieves attribute data along with aggregate utilization and savings data for a given time period. This doesn't support granular or grouped data (daily/monthly) in response. You can't retrieve data by dates in a single response similar to GetSavingsPlanUtilization, but you have the option to make multiple calls to GetSavingsPlanUtilizationDetails by providing individual dates. You can use GetDimensionValues in SAVINGS_PLANS to determine the possible dimension values.

    \n\t \n

    \n GetSavingsPlanUtilizationDetails internally groups data by SavingsPlansArn.

    \n\t

    \n GetSavingsPlansUtilizationDetails doesn't support filtering by tags. GetSavingsPlansUtilizationDetails also doesn't support the OR operator between filter dimensions. For the full request syntax with supported parameters, see Examples.

    \n     ", + "smithy.api#documentation": "

    Retrieves attribute data along with aggregate utilization and savings data for a given time period. This doesn't support granular or grouped data (daily/monthly) in response. You can't retrieve data by dates in a single response similar to GetSavingsPlanUtilization, but you have the option to make multiple calls to GetSavingsPlanUtilizationDetails by providing individual dates. You can use GetDimensionValues in SAVINGS_PLANS to determine the possible dimension values.

    \n\t \n

    \n GetSavingsPlanUtilizationDetails internally groups data by SavingsPlansArn.

    \n     ", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -3612,7 +3616,7 @@ "Filter": { "target": "com.amazonaws.costexplorer#Expression", "traits": { - "smithy.api#documentation": "

    Filters Savings Plans utilization coverage data for active Savings Plans dimensions. You can filter data with the following dimensions:

    \n
      \n
    • \n

      \n LINKED_ACCOUNT\n

      \n
      • \n
    • \n

      \n SAVINGS_PLAN_ARN\n

      \n
      • \n
    • \n

      \n REGION\n

      \n
      • \n
    • \n

      \n PAYMENT_OPTION\n

      \n
      • \n
    • \n

      \n INSTANCE_TYPE_FAMILY\n

      \n
      • \n
    \n

    \n GetSavingsPlansUtilizationDetails uses the same \n Expression object \n as the other operations, but only AND is supported among each dimension.

    \n

    Filtering by tags isn't supported.

    " + "smithy.api#documentation": "

    Filters Savings Plans utilization coverage data for active Savings Plans dimensions. You can filter data with the following dimensions:

    \n
      \n
    • \n

      \n LINKED_ACCOUNT\n

      \n
      • \n
    • \n

      \n SAVINGS_PLAN_ARN\n

      \n
      • \n
    • \n

      \n REGION\n

      \n
      • \n
    • \n

      \n PAYMENT_OPTION\n

      \n
      • \n
    • \n

      \n INSTANCE_TYPE_FAMILY\n

      \n
      • \n
    \n

    \n GetSavingsPlansUtilizationDetails uses the same \n Expression object \n as the other operations, but only AND is supported among each dimension.

    " } }, "DataType": { @@ -3691,7 +3695,7 @@ "Filter": { "target": "com.amazonaws.costexplorer#Expression", "traits": { - "smithy.api#documentation": "

    Filters Savings Plans utilization coverage data for active Savings Plans dimensions. You can filter data with the following dimensions:

    \n
      \n
    • \n

      \n LINKED_ACCOUNT\n

      \n
      • \n
    • \n

      \n SAVINGS_PLAN_ARN\n

      \n
      • \n
    • \n

      \n SAVINGS_PLANS_TYPE\n

      \n
      • \n
    • \n

      \n REGION\n

      \n
      • \n
    • \n

      \n PAYMENT_OPTION\n

      \n
      • \n
    • \n

      \n INSTANCE_TYPE_FAMILY\n

      \n
      • \n
    \n

    \n GetSavingsPlansUtilization uses the same \n Expression object \n as the other operations, but only AND is supported among each dimension.

    \n

    Filtering by tags isn't supported.

    " + "smithy.api#documentation": "

    Filters Savings Plans utilization coverage data for active Savings Plans dimensions. You can filter data with the following dimensions:

    \n
      \n
    • \n

      \n LINKED_ACCOUNT\n

      \n
      • \n
    • \n

      \n SAVINGS_PLAN_ARN\n

      \n
      • \n
    • \n

      \n SAVINGS_PLANS_TYPE\n

      \n
      • \n
    • \n

      \n REGION\n

      \n
      • \n
    • \n

      \n PAYMENT_OPTION\n

      \n
      • \n
    • \n

      \n INSTANCE_TYPE_FAMILY\n

      \n
      • \n
    \n

    \n GetSavingsPlansUtilization uses the same \n Expression object \n as the other operations, but only AND is supported among each dimension.

    " } }, "SortBy": { diff --git a/codegen/sdk-codegen/aws-models/dynamodb.json b/codegen/sdk-codegen/aws-models/dynamodb.json index 416e040f58a8d..477b536d64851 100644 --- a/codegen/sdk-codegen/aws-models/dynamodb.json +++ b/codegen/sdk-codegen/aws-models/dynamodb.json @@ -1041,7 +1041,7 @@ "aws.api#clientDiscoveredEndpoint": { "required": false }, - "smithy.api#documentation": "

    The BatchWriteItem operation puts or deletes multiple items in one or\n more tables. A single call to BatchWriteItem can write up to 16 MB of data,\n which can comprise as many as 25 put or delete requests. Individual items to be written\n can be as large as 400 KB.

    \n \n

    \n BatchWriteItem cannot update items. To update items, use the\n UpdateItem action.

    \n     \n

    The individual PutItem and DeleteItem operations specified\n in BatchWriteItem are atomic; however BatchWriteItem as a\n whole is not. If any requested operations fail because the table's provisioned\n throughput is exceeded or an internal processing failure occurs, the failed operations\n are returned in the UnprocessedItems response parameter. You can\n investigate and optionally resend the requests. Typically, you would call\n BatchWriteItem in a loop. Each iteration would check for unprocessed\n items and submit a new BatchWriteItem request with those unprocessed items\n until all items have been processed.

    \n

    If none of the items can be processed due to insufficient\n provisioned throughput on all of the tables in the request, then\n BatchWriteItem returns a\n ProvisionedThroughputExceededException.

    \n \n

    If DynamoDB returns any unprocessed items, you should retry the batch operation on\n those items. However, we strongly recommend that you use an exponential\n backoff algorithm. If you retry the batch operation immediately, the\n underlying read or write requests can still fail due to throttling on the individual\n tables. If you delay the batch operation using exponential backoff, the individual\n requests in the batch are much more likely to succeed.

    \n

    For more information, see Batch Operations and Error Handling in the Amazon DynamoDB\n Developer Guide.

    \n     \n\n

    With BatchWriteItem, you can efficiently write or delete large amounts of\n data, such as from Amazon EMR, or copy data from another database into DynamoDB. In\n order to improve performance with these large-scale operations,\n BatchWriteItem does not behave in the same way as individual\n PutItem and DeleteItem calls would. For example, you\n cannot specify conditions on individual put and delete requests, and\n BatchWriteItem does not return deleted items in the response.

    \n

    If you use a programming language that supports concurrency, you can use threads to\n write items in parallel. Your application must include the necessary logic to manage the\n threads. With languages that don't support threading, you must update or delete the\n specified items one at a time. In both situations, BatchWriteItem performs\n the specified put and delete operations in parallel, giving you the power of the thread\n pool approach without having to introduce complexity into your application.

    \n

    Parallel processing reduces latency, but each specified put and delete request\n consumes the same number of write capacity units whether it is processed in parallel or\n not. Delete operations on nonexistent items consume one write capacity unit.

    \n

    If one or more of the following is true, DynamoDB rejects the entire batch write\n operation:

    \n
      \n
    • \n

      One or more tables specified in the BatchWriteItem request does\n not exist.

      \n
      • \n
    • \n

      Primary key attributes specified on an item in the request do not match those\n in the corresponding table's primary key schema.

      \n
      • \n
    • \n

      You try to perform multiple operations on the same item in the same\n BatchWriteItem request. For example, you cannot put and delete\n the same item in the same BatchWriteItem request.

      \n
      • \n
    • \n

      Your request contains at least two items with identical hash and range keys\n (which essentially is two put operations).

      \n
      • \n
    • \n

      There are more than 25 requests in the batch.

      \n
      • \n
    • \n

      Any individual item in a batch exceeds 400 KB.

      \n
      • \n
    • \n

      The total request size exceeds 16 MB.

      \n
      • \n
    " + "smithy.api#documentation": "

    The BatchWriteItem operation puts or deletes multiple items in one or\n more tables. A single call to BatchWriteItem can transmit up to 16MB of \n data over the network, consisting of up to 25 item put or delete operations. While \n individual items can be up to 400 KB once stored, it's important to \n note that an item's representation might be greater than 400KB while being sent in \n DynamoDB's JSON format for the API call. For more details on this distinction, see Naming Rules and Data Types.

    \n \n

    \n BatchWriteItem cannot update items. To update items, use the\n UpdateItem action.

    \n     \n

    The individual PutItem and DeleteItem operations specified\n in BatchWriteItem are atomic; however BatchWriteItem as a\n whole is not. If any requested operations fail because the table's provisioned\n throughput is exceeded or an internal processing failure occurs, the failed operations\n are returned in the UnprocessedItems response parameter. You can\n investigate and optionally resend the requests. Typically, you would call\n BatchWriteItem in a loop. Each iteration would check for unprocessed\n items and submit a new BatchWriteItem request with those unprocessed items\n until all items have been processed.

    \n

    If none of the items can be processed due to insufficient\n provisioned throughput on all of the tables in the request, then\n BatchWriteItem returns a\n ProvisionedThroughputExceededException.

    \n \n

    If DynamoDB returns any unprocessed items, you should retry the batch operation on\n those items. However, we strongly recommend that you use an exponential\n backoff algorithm. If you retry the batch operation immediately, the\n underlying read or write requests can still fail due to throttling on the individual\n tables. If you delay the batch operation using exponential backoff, the individual\n requests in the batch are much more likely to succeed.

    \n

    For more information, see Batch Operations and Error Handling in the Amazon DynamoDB\n Developer Guide.

    \n     \n\n

    With BatchWriteItem, you can efficiently write or delete large amounts of\n data, such as from Amazon EMR, or copy data from another database into DynamoDB. In\n order to improve performance with these large-scale operations,\n BatchWriteItem does not behave in the same way as individual\n PutItem and DeleteItem calls would. For example, you\n cannot specify conditions on individual put and delete requests, and\n BatchWriteItem does not return deleted items in the response.

    \n

    If you use a programming language that supports concurrency, you can use threads to\n write items in parallel. Your application must include the necessary logic to manage the\n threads. With languages that don't support threading, you must update or delete the\n specified items one at a time. In both situations, BatchWriteItem performs\n the specified put and delete operations in parallel, giving you the power of the thread\n pool approach without having to introduce complexity into your application.

    \n

    Parallel processing reduces latency, but each specified put and delete request\n consumes the same number of write capacity units whether it is processed in parallel or\n not. Delete operations on nonexistent items consume one write capacity unit.

    \n

    If one or more of the following is true, DynamoDB rejects the entire batch write\n operation:

    \n
      \n
    • \n

      One or more tables specified in the BatchWriteItem request does\n not exist.

      \n
      • \n
    • \n

      Primary key attributes specified on an item in the request do not match those\n in the corresponding table's primary key schema.

      \n
      • \n
    • \n

      You try to perform multiple operations on the same item in the same\n BatchWriteItem request. For example, you cannot put and delete\n the same item in the same BatchWriteItem request.

      \n
      • \n
    • \n

      Your request contains at least two items with identical hash and range keys\n (which essentially is two put operations).

      \n
      • \n
    • \n

      There are more than 25 requests in the batch.

      \n
      • \n
    • \n

      Any individual item in a batch exceeds 400 KB.

      \n
      • \n
    • \n

      The total request size exceeds 16 MB.

      \n
      • \n
    " } }, "com.amazonaws.dynamodb#BatchWriteItemInput": { @@ -5535,7 +5535,7 @@ "PointInTimeRecoveryStatus": { "target": "com.amazonaws.dynamodb#PointInTimeRecoveryStatus", "traits": { - "smithy.api#documentation": "

    The current state of point in time recovery:

    \n
      \n
    • \n

      \n ENABLING - Point in time recovery is being enabled.

      \n
      • \n
    • \n

      \n ENABLED - Point in time recovery is enabled.

      \n
      • \n
    • \n

      \n DISABLED - Point in time recovery is disabled.

      \n
      • \n
    " + "smithy.api#documentation": "

    The current state of point in time recovery:

    \n
      \n
    • \n

      \n ENABLED - Point in time recovery is enabled.

      \n
      • \n
    • \n

      \n DISABLED - Point in time recovery is disabled.

      \n
      • \n
    " } }, "EarliestRestorableDateTime": { @@ -8636,7 +8636,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Updates the status for contributor insights for a specific table or index. CloudWatch\n Contributor Insights for DynamoDB graphs display the partition key and (if applicable)\n sort key of frequently accessed items and frequently throttled items in plaintext. If\n you require the use of AWS Key Management Service (KMS) to encrypt this table’s\n partition key and sort key data with an AWS managed key or customer managed key, you\n should not enable CloudWatch Contributor Insights for DynamoDB for this table.

    " + "smithy.api#documentation": "

    Updates the status for contributor insights for a specific table or index. CloudWatch\n Contributor Insights for DynamoDB graphs display the partition key and (if applicable)\n sort key of frequently accessed items and frequently throttled items in plaintext. If\n you require the use of Amazon Web Services Key Management Service (KMS) to encrypt this table’s\n partition key and sort key data with an Amazon Web Services managed key or customer managed key, you\n should not enable CloudWatch Contributor Insights for DynamoDB for this table.

    " } }, "com.amazonaws.dynamodb#UpdateContributorInsightsInput": { diff --git a/codegen/sdk-codegen/aws-models/ec2.json b/codegen/sdk-codegen/aws-models/ec2.json index aa43116d61b71..11e5b7ec146e2 100644 --- a/codegen/sdk-codegen/aws-models/ec2.json +++ b/codegen/sdk-codegen/aws-models/ec2.json @@ -2808,6 +2808,9 @@ { "target": "com.amazonaws.ec2#ImportVolume" }, + { + "target": "com.amazonaws.ec2#ListImagesInRecycleBin" + }, { "target": "com.amazonaws.ec2#ListSnapshotsInRecycleBin" }, @@ -3090,6 +3093,9 @@ { "target": "com.amazonaws.ec2#RestoreAddressToClassic" }, + { + "target": "com.amazonaws.ec2#RestoreImageFromRecycleBin" + }, { "target": "com.amazonaws.ec2#RestoreManagedPrefixListVersion" }, @@ -8199,11 +8205,20 @@ "type": "structure", "members": { "Enabled": { - "target": "com.amazonaws.ec2#Boolean" + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

    Enable or disable a customizable text banner that will be displayed on\n\t\t\tAmazon Web Services provided clients when a VPN session is established.

    \n\t\t

    Valid values: true | false\n

    \n\t\t

    Default value: false\n

    " + } }, "BannerText": { - "target": "com.amazonaws.ec2#String" + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

    Customizable text that will be displayed in a banner on Amazon Web Services provided\n\t\t\tclients when a VPN session is established. UTF-8 encoded characters only. Maximum of\n\t\t\t1400 characters.

    " + } } + }, + "traits": { + "smithy.api#documentation": "

    Options for enabling a customizable text banner that will be displayed on\n\t\t\tAmazon Web Services provided clients when a VPN session is established.

    " } }, "com.amazonaws.ec2#ClientLoginBannerResponseOptions": { @@ -8213,6 +8228,7 @@ "target": "com.amazonaws.ec2#Boolean", "traits": { "aws.protocols#ec2QueryName": "Enabled", + "smithy.api#documentation": "

    Current state of text banner feature.

    \n\t\t

    Valid values: true | false\n

    ", "smithy.api#xmlName": "enabled" } }, @@ -8220,9 +8236,13 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "BannerText", + "smithy.api#documentation": "

    Customizable text that will be displayed in a banner on Amazon Web Services provided\n\t\t\tclients when a VPN session is established. UTF-8 encoded\n\t\t\tcharacters only. Maximum of 1400 characters.

    ", "smithy.api#xmlName": "bannerText" } } + }, + "traits": { + "smithy.api#documentation": "

    Current state of options for customizable text banner that will be displayed on\n\t\t\tAmazon Web Services provided clients when a VPN session is established.

    " } }, "com.amazonaws.ec2#ClientVpnAssociationId": { @@ -8735,6 +8755,7 @@ "target": "com.amazonaws.ec2#Integer", "traits": { "aws.protocols#ec2QueryName": "SessionTimeoutHours", + "smithy.api#documentation": "

    The maximum VPN session duration time in hours.

    \n\t\t

    Valid values: 8 | 10 | 12 | 24\n

    \n\t\t

    Default value: 24\n

    ", "smithy.api#xmlName": "sessionTimeoutHours" } }, @@ -8742,6 +8763,7 @@ "target": "com.amazonaws.ec2#ClientLoginBannerResponseOptions", "traits": { "aws.protocols#ec2QueryName": "ClientLoginBannerOptions", + "smithy.api#documentation": "

    Options for enabling a customizable text banner that will be displayed on Amazon Web Services provided clients when a VPN session is\n\t\t\testablished.

    ", "smithy.api#xmlName": "clientLoginBannerOptions" } } @@ -10306,10 +10328,16 @@ } }, "SessionTimeoutHours": { - "target": "com.amazonaws.ec2#Integer" + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

    The maximum VPN session duration time in hours.

    \n\t\t

    Valid values: 8 | 10 | 12 | 24\n

    \n\t\t

    Default value: 24\n

    " + } }, "ClientLoginBannerOptions": { - "target": "com.amazonaws.ec2#ClientLoginBannerOptions" + "target": "com.amazonaws.ec2#ClientLoginBannerOptions", + "traits": { + "smithy.api#documentation": "

    Options for enabling a customizable text banner that will be displayed on\n\t\t\tAmazon Web Services provided clients when a VPN session is established.

    " + } } } }, @@ -11158,7 +11186,7 @@ "target": "com.amazonaws.ec2#CreateImageResult" }, "traits": { - "smithy.api#documentation": "

    Creates an Amazon EBS-backed AMI from an Amazon EBS-backed instance \n \tthat is either running or stopped.

    \n \n \n \n \t\n \t

    If you customized your instance with instance store volumes or Amazon EBS volumes in addition to the root device volume, the \n \tnew AMI contains block device mapping information for those volumes. When you launch an instance from this new AMI, \n \tthe instance automatically launches with those additional volumes.

    \n \t

    For more information, see Creating Amazon EBS-Backed Linux AMIs \n\t\t\t\tin the Amazon Elastic Compute Cloud User Guide.

    " + "smithy.api#documentation": "

    Creates an Amazon EBS-backed AMI from an Amazon EBS-backed instance \n \tthat is either running or stopped.

    \n \n

    By default, Amazon EC2 shuts down and reboots the instance before creating the AMI to ensure that everything on \n the instance is stopped and in a consistent state during the creation process. If you're confident that your \n instance is in a consistent state appropriate for AMI creation, use the NoReboot \n parameter to prevent Amazon EC2 from shutting down and rebooting the instance.

    \n     \n \n \n \n \t\n \t

    If you customized your instance with instance store volumes or Amazon EBS volumes in addition to the root device volume, the \n \tnew AMI contains block device mapping information for those volumes. When you launch an instance from this new AMI, \n \tthe instance automatically launches with those additional volumes.

    \n \t

    For more information, see Creating Amazon EBS-Backed Linux AMIs \n\t\t\t\tin the Amazon Elastic Compute Cloud User Guide.

    " } }, "com.amazonaws.ec2#CreateImageRequest": { @@ -18756,7 +18784,7 @@ "target": "com.amazonaws.ec2#DeregisterImageRequest" }, "traits": { - "smithy.api#documentation": "

    Deregisters the specified AMI. After you deregister an AMI, it can't be used to launch\n\t\t\tnew instances; however, it doesn't affect any instances that you've already launched\n\t\t\tfrom the AMI. You'll continue to incur usage costs for those instances until you\n\t\t\tterminate them.

    \n \t

    When you deregister an Amazon EBS-backed AMI, it doesn't affect the snapshot that was\n\t\t\tcreated for the root volume of the instance during the AMI creation process. When you\n\t\t\tderegister an instance store-backed AMI, it doesn't affect the files that you uploaded\n\t\t\tto Amazon S3 when you created the AMI.

    " + "smithy.api#documentation": "

    Deregisters the specified AMI. After you deregister an AMI, it can't be used to \n launch new instances.

    \n \n \n

    If you deregister an AMI that matches a Recycle Bin retention rule, the AMI is \n retained in the Recycle Bin for the specified retention period. For more information, \n see Recycle\n Bin in the Amazon Elastic Compute Cloud User Guide.

    \n \n

    When you deregister an AMI, it doesn't affect any instances that you've already \n launched from the AMI. You'll continue to incur usage costs for those instances until \n you terminate them.

    \n \t

    When you deregister an Amazon EBS-backed AMI, it doesn't affect the snapshot that was\n\t\t\tcreated for the root volume of the instance during the AMI creation process. When you\n\t\t\tderegister an instance store-backed AMI, it doesn't affect the files that you uploaded\n\t\t\tto Amazon S3 when you created the AMI.

    " } }, "com.amazonaws.ec2#DeregisterImageRequest": { @@ -30875,7 +30903,7 @@ "target": "com.amazonaws.ec2#DisableFastLaunchResult" }, "traits": { - "smithy.api#documentation": "

    Discontinue faster launching for a Windows AMI, and clean up existing pre-provisioned snapshots. \n\t\t\tWhen you disable faster launching, the AMI uses the standard launch process for each \n\t\t\tinstance. All pre-provisioned snapshots must be removed before you can enable faster launching again.

    " + "smithy.api#documentation": "

    Discontinue faster launching for a Windows AMI, and clean up existing pre-provisioned snapshots. \n\t\t\tWhen you disable faster launching, the AMI uses the standard launch process for each \n\t\t\tinstance. All pre-provisioned snapshots must be removed before you can enable faster launching again.

    \n\t\t \n\t\t\t

    To change these settings, you must own the AMI.

    \n\t\t     " } }, "com.amazonaws.ec2#DisableFastLaunchRequest": { @@ -33137,7 +33165,7 @@ "target": "com.amazonaws.ec2#EnableFastLaunchResult" }, "traits": { - "smithy.api#documentation": "

    When you enable faster launching for a Windows AMI, images are pre-provisioned, \n\t\t\tusing snapshots to launch instances up to 65% faster. To create the optimized Windows \n\t\t\timage, Amazon EC2 launches an instance and runs through Sysprep steps, rebooting as required. \n\t\t\tThen it creates a set of reserved snapshots that are used for subsequent launches. The \n\t\t\treserved snapshots are automatically replenished as they are used, depending on your \n\t\t\tsettings for launch frequency.

    " + "smithy.api#documentation": "

    When you enable faster launching for a Windows AMI, images are pre-provisioned, \n\t\t\tusing snapshots to launch instances up to 65% faster. To create the optimized Windows \n\t\t\timage, Amazon EC2 launches an instance and runs through Sysprep steps, rebooting as required. \n\t\t\tThen it creates a set of reserved snapshots that are used for subsequent launches. The \n\t\t\treserved snapshots are automatically replenished as they are used, depending on your \n\t\t\tsettings for launch frequency.

    \n\t\t \n\t\t\t

    To change these settings, you must own the AMI.

    \n\t\t     " } }, "com.amazonaws.ec2#EnableFastLaunchRequest": { @@ -33171,7 +33199,7 @@ "MaxParallelLaunches": { "target": "com.amazonaws.ec2#Integer", "traits": { - "smithy.api#documentation": "

    The maximum number of parallel instances to launch for creating resources.

    " + "smithy.api#documentation": "

    The maximum number of parallel instances to launch for creating resources. Value must be 6 or greater.

    " } }, "DryRun": { @@ -40801,6 +40829,63 @@ } } }, + "com.amazonaws.ec2#ImageRecycleBinInfo": { + "type": "structure", + "members": { + "ImageId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ImageId", + "smithy.api#documentation": "

    The ID of the AMI.

    ", + "smithy.api#xmlName": "imageId" + } + }, + "Name": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Name", + "smithy.api#documentation": "

    The name of the AMI.

    ", + "smithy.api#xmlName": "name" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

    The description of the AMI.

    ", + "smithy.api#xmlName": "description" + } + }, + "RecycleBinEnterTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "RecycleBinEnterTime", + "smithy.api#documentation": "

    The date and time when the AMI entered the Recycle Bin.

    ", + "smithy.api#xmlName": "recycleBinEnterTime" + } + }, + "RecycleBinExitTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "RecycleBinExitTime", + "smithy.api#documentation": "

    The date and time when the AMI is to be permanently deleted from the Recycle Bin.

    ", + "smithy.api#xmlName": "recycleBinExitTime" + } + } + }, + "traits": { + "smithy.api#documentation": "

    Information about an AMI that is currently in the Recycle Bin.

    " + } + }, + "com.amazonaws.ec2#ImageRecycleBinInfoList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ImageRecycleBinInfo", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, "com.amazonaws.ec2#ImageState": { "type": "string", "traits": { @@ -51387,6 +51472,85 @@ } } }, + "com.amazonaws.ec2#ListImagesInRecycleBin": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ListImagesInRecycleBinRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ListImagesInRecycleBinResult" + }, + "traits": { + "smithy.api#documentation": "

    Lists one or more AMIs that are currently in the Recycle Bin. For more information, \n see Recycle\n Bin in the Amazon Elastic Compute Cloud User Guide.

    ", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Images", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#ListImagesInRecycleBinMaxResults": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.ec2#ListImagesInRecycleBinRequest": { + "type": "structure", + "members": { + "ImageIds": { + "target": "com.amazonaws.ec2#ImageIdStringList", + "traits": { + "smithy.api#documentation": "

    The IDs of the AMIs to list. Omit this parameter to list all of the AMIs that \n are in the Recycle Bin. You can specify up to 20 IDs in a single request.

    ", + "smithy.api#xmlName": "ImageId" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

    The token for the next page of results.

    " + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#ListImagesInRecycleBinMaxResults", + "traits": { + "smithy.api#documentation": "

    The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

    \n

    If you do not specify a value for MaxResults, the request \n returns 1,000 items per page by default. For more information, see \n \n Pagination.

    " + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

    Checks whether you have the required permissions for the action, without actually making the request, \n\t\t\tand provides an error response. If you have the required permissions, the error response is \n\t\t\tDryRunOperation. Otherwise, it is UnauthorizedOperation.

    " + } + } + } + }, + "com.amazonaws.ec2#ListImagesInRecycleBinResult": { + "type": "structure", + "members": { + "Images": { + "target": "com.amazonaws.ec2#ImageRecycleBinInfoList", + "traits": { + "aws.protocols#ec2QueryName": "ImageSet", + "smithy.api#documentation": "

    Information about the AMIs.

    ", + "smithy.api#xmlName": "imageSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "

    The token to use to retrieve the next page of results. This value is null when there are no more results to return.

    ", + "smithy.api#xmlName": "nextToken" + } + } + } + }, "com.amazonaws.ec2#ListSnapshotsInRecycleBin": { "type": "operation", "input": { @@ -52964,10 +53128,16 @@ } }, "SessionTimeoutHours": { - "target": "com.amazonaws.ec2#Integer" + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

    The maximum VPN session duration time in hours.

    \n\t\t

    Valid values: 8 | 10 | 12 | 24\n

    \n\t\t

    Default value: 24\n

    " + } }, "ClientLoginBannerOptions": { - "target": "com.amazonaws.ec2#ClientLoginBannerOptions" + "target": "com.amazonaws.ec2#ClientLoginBannerOptions", + "traits": { + "smithy.api#documentation": "

    Options for enabling a customizable text banner that will be displayed on\n\t\t\tAmazon Web Services provided clients when a VPN session is established.

    " + } } } }, @@ -65570,6 +65740,49 @@ } } }, + "com.amazonaws.ec2#RestoreImageFromRecycleBin": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#RestoreImageFromRecycleBinRequest" + }, + "output": { + "target": "com.amazonaws.ec2#RestoreImageFromRecycleBinResult" + }, + "traits": { + "smithy.api#documentation": "

    Restores an AMI from the Recycle Bin. For more information, see Recycle Bin in the Amazon Elastic Compute Cloud User Guide.

    " + } + }, + "com.amazonaws.ec2#RestoreImageFromRecycleBinRequest": { + "type": "structure", + "members": { + "ImageId": { + "target": "com.amazonaws.ec2#ImageId", + "traits": { + "smithy.api#documentation": "

    The ID of the AMI to restore.

    ", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

    Checks whether you have the required permissions for the action, without actually making the request, \n\t\t\tand provides an error response. If you have the required permissions, the error response is \n\t\t\tDryRunOperation. Otherwise, it is UnauthorizedOperation.

    " + } + } + } + }, + "com.amazonaws.ec2#RestoreImageFromRecycleBinResult": { + "type": "structure", + "members": { + "Return": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Return", + "smithy.api#documentation": "

    Returns true if the request succeeds; otherwise, it returns an error.

    ", + "smithy.api#xmlName": "return" + } + } + } + }, "com.amazonaws.ec2#RestoreManagedPrefixListVersion": { "type": "operation", "input": { diff --git a/codegen/sdk-codegen/aws-models/elasticache.json b/codegen/sdk-codegen/aws-models/elasticache.json index 8ab7a9b6216ba..e241ff4906228 100644 --- a/codegen/sdk-codegen/aws-models/elasticache.json +++ b/codegen/sdk-codegen/aws-models/elasticache.json @@ -1281,7 +1281,7 @@ "CacheParameterGroupFamily": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

    The name of the cache parameter group family that this cache parameter group is compatible with.

    \n

    Valid values are: \n memcached1.4 | \n memcached1.5 | \n memcached1.6 | \n redis2.6 | \n redis2.8 |\n redis3.2 |\n redis4.0 |\n redis5.0 | \n redis6.0 | \n

    " + "smithy.api#documentation": "

    The name of the cache parameter group family that this cache parameter group is compatible with.

    \n

    Valid values are: \n memcached1.4 | \n memcached1.5 | \n memcached1.6 | \n redis2.6 | \n redis2.8 |\n redis3.2 |\n redis4.0 |\n redis5.0 | \n redis6.x | \n

    " } }, "Description": { @@ -2141,7 +2141,7 @@ "PreferredMaintenanceWindow": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

    Specifies the weekly time range during which maintenance\n on the cluster is performed. It is specified as a range in\n the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum\n maintenance window is a 60 minute period.\n Valid values for ddd are:

    " + "smithy.api#documentation": "

    Specifies the weekly time range during which maintenance\n on the cluster is performed. It is specified as a range in\n the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum\n maintenance window is a 60 minute period.\n

    " } }, "Port": { @@ -2262,7 +2262,7 @@ "CacheParameterGroupFamily": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

    The name of the cache parameter group family that the cache parameter group can be used with.

    \n

    Valid values are: \n memcached1.4 | \n memcached1.5 | \n memcached1.6 | \n redis2.6 | \n redis2.8 |\n redis3.2 |\n redis4.0 |\n redis5.0 | \n redis6.0 | \n redis6.2\n

    ", + "smithy.api#documentation": "

    The name of the cache parameter group family that the cache parameter group can be used with.

    \n

    Valid values are: \n memcached1.4 | \n memcached1.5 | \n memcached1.6 | \n redis2.6 | \n redis2.8 |\n redis3.2 |\n redis4.0 |\n redis5.0 | \n redis6.x \n

    ", "smithy.api#required": {} } }, diff --git a/codegen/sdk-codegen/aws-models/elasticsearch-service.json b/codegen/sdk-codegen/aws-models/elasticsearch-service.json index 96ea152b2eefd..b29753ff4deb2 100644 --- a/codegen/sdk-codegen/aws-models/elasticsearch-service.json +++ b/codegen/sdk-codegen/aws-models/elasticsearch-service.json @@ -400,6 +400,9 @@ { "target": "com.amazonaws.elasticsearchservice#DescribeDomainAutoTunes" }, + { + "target": "com.amazonaws.elasticsearchservice#DescribeDomainChangeProgress" + }, { "target": "com.amazonaws.elasticsearchservice#DescribeElasticsearchDomain" }, @@ -934,6 +937,135 @@ "smithy.api#documentation": "

    The result of a CancelElasticsearchServiceSoftwareUpdate operation. Contains the status of the update.

    " } }, + "com.amazonaws.elasticsearchservice#ChangeProgressDetails": { + "type": "structure", + "members": { + "ChangeId": { + "target": "com.amazonaws.elasticsearchservice#GUID", + "traits": { + "smithy.api#documentation": "

    The unique change identifier associated with a specific domain configuration change.

    " + } + }, + "Message": { + "target": "com.amazonaws.elasticsearchservice#Message", + "traits": { + "smithy.api#documentation": "

    Contains an optional message associated with the domain configuration change.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Specifies change details of the domain configuration change.

    " + } + }, + "com.amazonaws.elasticsearchservice#ChangeProgressStage": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.elasticsearchservice#ChangeProgressStageName", + "traits": { + "smithy.api#documentation": "

    The name of the specific progress stage.

    " + } + }, + "Status": { + "target": "com.amazonaws.elasticsearchservice#ChangeProgressStageStatus", + "traits": { + "smithy.api#documentation": "

    The overall status of a specific progress stage.

    " + } + }, + "Description": { + "target": "com.amazonaws.elasticsearchservice#Description", + "traits": { + "smithy.api#documentation": "

    The description of the progress stage.

    " + } + }, + "LastUpdated": { + "target": "com.amazonaws.elasticsearchservice#LastUpdated", + "traits": { + "smithy.api#documentation": "

    The last updated timestamp of the progress stage.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    A progress stage details of a specific domain configuration change.

    " + } + }, + "com.amazonaws.elasticsearchservice#ChangeProgressStageList": { + "type": "list", + "member": { + "target": "com.amazonaws.elasticsearchservice#ChangeProgressStage" + }, + "traits": { + "smithy.api#documentation": "

    The list of progress stages of a specific domain configuration change.

    " + } + }, + "com.amazonaws.elasticsearchservice#ChangeProgressStageName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + } + } + }, + "com.amazonaws.elasticsearchservice#ChangeProgressStageStatus": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, + "com.amazonaws.elasticsearchservice#ChangeProgressStatusDetails": { + "type": "structure", + "members": { + "ChangeId": { + "target": "com.amazonaws.elasticsearchservice#GUID", + "traits": { + "smithy.api#documentation": "

    The unique change identifier associated with a specific domain configuration change.

    " + } + }, + "StartTime": { + "target": "com.amazonaws.elasticsearchservice#UpdateTimestamp", + "traits": { + "smithy.api#documentation": "

    The time at which the configuration change is made on the domain.

    " + } + }, + "Status": { + "target": "com.amazonaws.elasticsearchservice#OverallChangeStatus", + "traits": { + "smithy.api#documentation": "

    The overall status of the domain configuration change. This field can take the following values: PENDING, PROCESSING, COMPLETED and FAILED

    " + } + }, + "PendingProperties": { + "target": "com.amazonaws.elasticsearchservice#StringList", + "traits": { + "smithy.api#documentation": "

    The list of properties involved in the domain configuration change that are still in pending.

    " + } + }, + "CompletedProperties": { + "target": "com.amazonaws.elasticsearchservice#StringList", + "traits": { + "smithy.api#documentation": "

    The list of properties involved in the domain configuration change that are completed.

    " + } + }, + "TotalNumberOfStages": { + "target": "com.amazonaws.elasticsearchservice#TotalNumberOfStages", + "traits": { + "smithy.api#documentation": "

    The total number of stages required for the configuration change.

    " + } + }, + "ChangeProgressStages": { + "target": "com.amazonaws.elasticsearchservice#ChangeProgressStageList", + "traits": { + "smithy.api#documentation": "

    The specific stages that the domain is going through to perform the configuration change.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    The progress details of a specific domain configuration change.

    " + } + }, "com.amazonaws.elasticsearchservice#CloudWatchLogsLogGroupArn": { "type": "string", "traits": { @@ -1801,6 +1933,74 @@ "smithy.api#documentation": "

    The result of DescribeDomainAutoTunes request. See the Developer Guide for more information.

    " } }, + "com.amazonaws.elasticsearchservice#DescribeDomainChangeProgress": { + "type": "operation", + "input": { + "target": "com.amazonaws.elasticsearchservice#DescribeDomainChangeProgressRequest" + }, + "output": { + "target": "com.amazonaws.elasticsearchservice#DescribeDomainChangeProgressResponse" + }, + "errors": [ + { + "target": "com.amazonaws.elasticsearchservice#BaseException" + }, + { + "target": "com.amazonaws.elasticsearchservice#InternalException" + }, + { + "target": "com.amazonaws.elasticsearchservice#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.elasticsearchservice#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

    Returns information about the current blue/green deployment happening on a domain, including\n a change ID, status, and progress stages.

    ", + "smithy.api#http": { + "method": "GET", + "uri": "/2015-01-01/es/domain/{DomainName}/progress", + "code": 200 + } + } + }, + "com.amazonaws.elasticsearchservice#DescribeDomainChangeProgressRequest": { + "type": "structure", + "members": { + "DomainName": { + "target": "com.amazonaws.elasticsearchservice#DomainName", + "traits": { + "smithy.api#documentation": "

    The domain you want to get the progress information about.

    ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ChangeId": { + "target": "com.amazonaws.elasticsearchservice#GUID", + "traits": { + "smithy.api#documentation": "

    The specific change ID for which you want to get progress information. This is an optional parameter.\n If omitted, the service returns information about the most recent configuration change.\n

    ", + "smithy.api#httpQuery": "changeid" + } + } + }, + "traits": { + "smithy.api#documentation": "

    Container for the parameters to the DescribeDomainChangeProgress operation. Specifies the\n domain name and optional change specific identity for which you want progress information.\n

    " + } + }, + "com.amazonaws.elasticsearchservice#DescribeDomainChangeProgressResponse": { + "type": "structure", + "members": { + "ChangeProgressStatus": { + "target": "com.amazonaws.elasticsearchservice#ChangeProgressStatusDetails", + "traits": { + "smithy.api#documentation": "

    Progress information for the configuration change that is requested in the DescribeDomainChangeProgress request.\n

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    The result of a DescribeDomainChangeProgress request. Contains the progress information of\n the requested domain change.\n

    " + } + }, "com.amazonaws.elasticsearchservice#DescribeElasticsearchDomain": { "type": "operation", "input": { @@ -2526,6 +2726,9 @@ "smithy.api#documentation": "

    Container for results from DescribeReservedElasticsearchInstances

    " } }, + "com.amazonaws.elasticsearchservice#Description": { + "type": "string" + }, "com.amazonaws.elasticsearchservice#DisableTimestamp": { "type": "timestamp" }, @@ -3404,6 +3607,12 @@ "traits": { "smithy.api#documentation": "

    Specifies AutoTuneOptions for the domain.

    " } + }, + "ChangeProgressDetails": { + "target": "com.amazonaws.elasticsearchservice#ChangeProgressDetails", + "traits": { + "smithy.api#documentation": "

    Specifies change details of the domain configuration change.

    " + } } }, "traits": { @@ -3557,6 +3766,12 @@ "traits": { "smithy.api#documentation": "

    The current status of the Elasticsearch domain's Auto-Tune options.

    " } + }, + "ChangeProgressDetails": { + "target": "com.amazonaws.elasticsearchservice#ChangeProgressDetails", + "traits": { + "smithy.api#documentation": "

    Specifies change details of the domain configuration change.

    " + } } }, "traits": { @@ -5116,6 +5331,30 @@ "target": "com.amazonaws.elasticsearchservice#OutboundCrossClusterSearchConnection" } }, + "com.amazonaws.elasticsearchservice#OverallChangeStatus": { + "type": "string", + "traits": { + "smithy.api#documentation": "

    The overall status value of the domain configuration change.

    ", + "smithy.api#enum": [ + { + "value": "PENDING", + "name": "PENDING" + }, + { + "value": "PROCESSING", + "name": "PROCESSING" + }, + { + "value": "COMPLETED", + "name": "COMPLETED" + }, + { + "value": "FAILED", + "name": "FAILED" + } + ] + } + }, "com.amazonaws.elasticsearchservice#OwnerId": { "type": "string", "traits": { @@ -6322,6 +6561,9 @@ ] } }, + "com.amazonaws.elasticsearchservice#TotalNumberOfStages": { + "type": "integer" + }, "com.amazonaws.elasticsearchservice#UIntValue": { "type": "integer", "traits": { @@ -6656,6 +6898,9 @@ "traits": { "smithy.api#documentation": "

    \n This flag, when set to True, indicates that an Upgrade Eligibility Check needs to be performed.\n This will not actually perform the Upgrade.\n

    " } + }, + "ChangeProgressDetails": { + "target": "com.amazonaws.elasticsearchservice#ChangeProgressDetails" } }, "traits": { diff --git a/codegen/sdk-codegen/aws-models/emr.json b/codegen/sdk-codegen/aws-models/emr.json index a07711477b264..ce4db127c9994 100644 --- a/codegen/sdk-codegen/aws-models/emr.json +++ b/codegen/sdk-codegen/aws-models/emr.json @@ -193,7 +193,7 @@ } ], "traits": { - "smithy.api#documentation": "

    AddJobFlowSteps adds new steps to a running cluster. A maximum of 256 steps are allowed\n in each job flow.

    \n

    If your cluster is long-running (such as a Hive data warehouse) or complex, you may\n require more than 256 steps to process your data. You can bypass the 256-step limitation in\n various ways, including using SSH to connect to the master node and submitting queries\n directly to the software running on the master node, such as Hive and Hadoop. For more\n information on how to do this, see Add More than 256 Steps to a\n Cluster in the Amazon EMR Management Guide.

    \n

    A step specifies the location of a JAR file stored either on the master node of the\n cluster or in Amazon S3. Each step is performed by the main function of the main class of\n the JAR file. The main class can be specified either in the manifest of the JAR or by using\n the MainFunction parameter of the step.

    \n

    Amazon EMR executes each step in the order listed. For a step to be considered complete,\n the main function must exit with a zero exit code and all Hadoop jobs started while the\n step was running must have completed and run successfully.

    \n

    You can only add steps to a cluster that is in one of the following states: STARTING,\n BOOTSTRAPPING, RUNNING, or WAITING.

    " + "smithy.api#documentation": "

    AddJobFlowSteps adds new steps to a running cluster. A maximum of 256 steps are allowed\n in each job flow.

    \n

    If your cluster is long-running (such as a Hive data warehouse) or complex, you may\n require more than 256 steps to process your data. You can bypass the 256-step limitation in\n various ways, including using SSH to connect to the master node and submitting queries\n directly to the software running on the master node, such as Hive and Hadoop. For more\n information on how to do this, see Add More than 256 Steps to a\n Cluster in the Amazon EMR Management Guide.

    \n

    A step specifies the location of a JAR file stored either on the master node of the\n cluster or in Amazon S3. Each step is performed by the main function of the main class of\n the JAR file. The main class can be specified either in the manifest of the JAR or by using\n the MainFunction parameter of the step.

    \n

    Amazon EMR executes each step in the order listed. For a step to be considered complete,\n the main function must exit with a zero exit code and all Hadoop jobs started while the\n step was running must have completed and run successfully.

    \n

    You can only add steps to a cluster that is in one of the following states: STARTING,\n BOOTSTRAPPING, RUNNING, or WAITING.

    \n \n

    The string values passed into HadoopJarStep object cannot exceed a total of 10240 characters.

    \n     " } }, "com.amazonaws.emr#AddJobFlowStepsInput": { @@ -885,7 +885,7 @@ "VisibleToAllUsers": { "target": "com.amazonaws.emr#Boolean", "traits": { - "smithy.api#documentation": "

    Indicates whether the cluster is visible to IAM principals in the Amazon Web Services account associated\n with the cluster. When true, IAM principals in the\n Amazon Web Services account can perform EMR cluster actions on the cluster that their IAM policies allow. When false, only the IAM principal that created the cluster and the Amazon Web Services account root user can perform EMR actions, regardless of IAM permissions policies attached to other IAM principals.

    \n

    The default value is true if a value is not provided when creating a\n cluster using the EMR API RunJobFlow command, the CLI\n create-cluster command, or the Amazon Web Services Management Console. IAM principals that are\n allowed to perform actions on the cluster can use the SetVisibleToAllUsers action to change the value on a running cluster. For more information, see Understanding the EMR Cluster VisibleToAllUsers Setting in the Amazon EMRManagement Guide.

    " + "smithy.api#documentation": "

    Indicates whether the cluster is visible to IAM principals in the Amazon Web Services account associated\n with the cluster. When true, IAM principals in the\n Amazon Web Services account can perform EMR cluster actions on the cluster that their IAM policies allow. When false, only the IAM principal that created the cluster and the Amazon Web Services account root user can perform EMR actions, regardless of IAM permissions policies attached to other IAM principals.

    \n

    The default value is true if a value is not provided when creating a\n cluster using the EMR API RunJobFlow command, the CLI\n create-cluster command, or the Amazon Web Services Management Console.

    " } }, "Applications": { @@ -2386,6 +2386,24 @@ }, "com.amazonaws.emr#ElasticMapReduce": { "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "EMR", + "arnNamespace": "elasticmapreduce", + "cloudFormationName": "EMR", + "cloudTrailEventSource": "emr.amazonaws.com", + "endpointPrefix": "elasticmapreduce" + }, + "aws.auth#sigv4": { + "name": "elasticmapreduce" + }, + "aws.protocols#awsJson1_1": {}, + "smithy.api#documentation": "

    Amazon EMR is a web service that makes it easier to process large amounts of data\n efficiently. Amazon EMR uses Hadoop processing combined with several Amazon Web Services services to do\n tasks such as web indexing, data mining, log file analysis, machine learning, scientific\n simulation, and data warehouse management.

    ", + "smithy.api#title": "Amazon EMR", + "smithy.api#xmlNamespace": { + "uri": "http://elasticmapreduce.amazonaws.com/doc/2009-03-31" + } + }, "version": "2009-03-31", "operations": [ { @@ -2544,25 +2562,7 @@ { "target": "com.amazonaws.emr#UpdateStudioSessionMapping" } - ], - "traits": { - "aws.api#service": { - "sdkId": "EMR", - "arnNamespace": "elasticmapreduce", - "cloudFormationName": "EMR", - "cloudTrailEventSource": "emr.amazonaws.com", - "endpointPrefix": "elasticmapreduce" - }, - "aws.auth#sigv4": { - "name": "elasticmapreduce" - }, - "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "

    Amazon EMR is a web service that makes it easier to process large amounts of data\n efficiently. Amazon EMR uses Hadoop processing combined with several Amazon Web Services services to do\n tasks such as web indexing, data mining, log file analysis, machine learning, scientific\n simulation, and data warehouse management.

    ", - "smithy.api#title": "Amazon EMR", - "smithy.api#xmlNamespace": { - "uri": "http://elasticmapreduce.amazonaws.com/doc/2009-03-31" - } - } + ] }, "com.amazonaws.emr#ErrorCode": { "type": "string", @@ -3566,7 +3566,7 @@ "State": { "target": "com.amazonaws.emr#InstanceGroupState", "traits": { - "smithy.api#documentation": "

    State of instance group. The following values are deprecated: STARTING, TERMINATED, and\n FAILED.

    ", + "smithy.api#documentation": "

    State of instance group. The following values are no longer supported: STARTING, TERMINATED, and\n FAILED.

    ", "smithy.api#required": {} } }, @@ -4289,7 +4289,7 @@ "VisibleToAllUsers": { "target": "com.amazonaws.emr#Boolean", "traits": { - "smithy.api#documentation": "

    Indicates whether the cluster is visible to IAM principals in the Amazon Web Services account associated\n with the cluster. When true, IAM principals in the\n Amazon Web Services account can perform EMR cluster actions that their IAM policies allow. When false, only the IAM principal that created the cluster and the Amazon Web Services account root user can perform EMR actions, regardless of IAM permissions policies attached to other IAM principals.

    \n

    The default value is true if a value is not provided when creating a\n cluster using the EMR API RunJobFlow command, the CLI\n create-cluster command, or the Amazon Web Services Management Console. IAM principals that are authorized to perform actions on the cluster can use the SetVisibleToAllUsers action to change the value on a running cluster. For more information, see Understanding the EMR Cluster VisibleToAllUsers Setting in the Amazon EMRManagement Guide.

    " + "smithy.api#documentation": "

    Indicates whether the cluster is visible to IAM principals in the Amazon Web Services account associated\n with the cluster. When true, IAM principals in the\n Amazon Web Services account can perform EMR cluster actions that their IAM policies allow. When false, only the IAM principal that created the cluster and the Amazon Web Services account root user can perform EMR actions, regardless of IAM permissions policies attached to other IAM principals.

    \n

    The default value is true if a value is not provided when creating a\n cluster using the EMR API RunJobFlow command, the CLI\n create-cluster command, or the Amazon Web Services Management Console.

    " } }, "JobFlowRole": { @@ -6104,7 +6104,7 @@ "target": "com.amazonaws.emr#PutAutoTerminationPolicyOutput" }, "traits": { - "smithy.api#documentation": "

    Creates or updates an auto-termination policy for an Amazon EMR cluster. An auto-termination policy defines the amount of idle time in seconds after which a cluster automatically terminates. For alternative cluster termination options, see Control cluster termination.

    " + "smithy.api#documentation": "\n

    Auto-termination is supported in Amazon EMR versions 5.30.0 and 6.1.0 and later. For more information, see Using an auto-termination policy.

    \n     \n

    Creates or updates an auto-termination policy for an Amazon EMR cluster. An auto-termination policy defines the amount of idle time in seconds after which a cluster automatically terminates. For alternative cluster termination options, see Control cluster termination.

    " } }, "com.amazonaws.emr#PutAutoTerminationPolicyInput": { @@ -6469,7 +6469,7 @@ "Applications": { "target": "com.amazonaws.emr#ApplicationList", "traits": { - "smithy.api#documentation": "

    Applies to Amazon EMR releases 4.0 and later. A case-insensitive list of applications\n for Amazon EMR to install and configure when launching the cluster. For a list of\n applications available for each Amazon EMR release version, see the Amazon EMR Release\n Guide.

    " + "smithy.api#documentation": "

    Applies to Amazon EMR releases 4.0 and later. A case-insensitive list of applications\n for Amazon EMR to install and configure when launching the cluster. For a list of\n applications available for each Amazon EMR release version, see the Amazon EMRRelease\n Guide.

    " } }, "Configurations": { @@ -6481,7 +6481,7 @@ "VisibleToAllUsers": { "target": "com.amazonaws.emr#Boolean", "traits": { - "smithy.api#documentation": "

    Set this value to true so that IAM principals in the Amazon Web Services account associated with the cluster can perform EMR actions on the cluster that their IAM policies allow. This value defaults to true for clusters created using the EMR API or the CLI create-cluster command.

    \n

    When set to false, only the IAM principal that created the cluster and the Amazon Web Services account root user can perform EMR actions for the cluster, regardless of the IAM permissions policies attached to other IAM principals. For more information, see Understanding the EMR Cluster VisibleToAllUsers Setting in the Amazon EMRManagement Guide.

    " + "smithy.api#documentation": "\n

    The VisibleToAllUsers parameter is no longer supported. By default, the value is set to true. Setting it to false now has no effect.

    \n     \n

    Set this value to true so that IAM principals in the Amazon Web Services account associated with the cluster can perform EMR actions on the cluster that their IAM policies allow. This value defaults to true for clusters created using the EMR API or the CLI create-cluster command.

    \n

    When set to false, only the IAM principal that created the cluster and the Amazon Web Services account root user can perform EMR actions for the cluster, regardless of the IAM permissions policies attached to other IAM principals. For more information, see Understanding the EMR Cluster VisibleToAllUsers Setting in the Amazon EMRManagement Guide.

    " } }, "JobFlowRole": { @@ -6904,7 +6904,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Sets the Cluster$VisibleToAllUsers value for an EMR cluster. When true, IAM principals in the\n Amazon Web Services account can perform EMR cluster actions that their IAM policies allow. When false, only the IAM principal that created the cluster and the Amazon Web Services account root user can perform EMR actions on the cluster, regardless of IAM permissions policies attached to other IAM principals.

    \n

    This action works on running clusters. When you create a cluster, use the RunJobFlowInput$VisibleToAllUsers parameter.

    \n

    For more information, see Understanding the EMR Cluster VisibleToAllUsers Setting in the Amazon EMRManagement Guide.

    " + "smithy.api#documentation": "\n

    The SetVisibleToAllUsers parameter is no longer supported. Your cluster may be visible to all users in your account.\n To restrict cluster access using an IAM policy, see Identity and Access Management for EMR.\n

    \n     \n

    Sets the Cluster$VisibleToAllUsers value for an EMR cluster. When true, IAM principals in the\n Amazon Web Services account can perform EMR cluster actions that their IAM policies allow. When false, only the IAM principal that created the cluster and the Amazon Web Services account root user can perform EMR actions on the cluster, regardless of IAM permissions policies attached to other IAM principals.

    \n

    This action works on running clusters. When you create a cluster, use the RunJobFlowInput$VisibleToAllUsers parameter.

    \n

    For more information, see Understanding the EMR Cluster VisibleToAllUsers Setting in the Amazon EMRManagement Guide.

    " } }, "com.amazonaws.emr#SetVisibleToAllUsersInput": { @@ -7033,7 +7033,7 @@ "BlockDurationMinutes": { "target": "com.amazonaws.emr#WholeNumber", "traits": { - "smithy.api#documentation": "

    The defined duration for Spot Instances (also known as Spot blocks) in minutes. When\n specified, the Spot Instance does not terminate before the defined duration expires, and\n defined duration pricing for Spot Instances applies. Valid values are 60, 120, 180, 240,\n 300, or 360. The duration period starts as soon as a Spot Instance receives its instance\n ID. At the end of the duration, Amazon EC2 marks the Spot Instance for termination and\n provides a Spot Instance termination notice, which gives the instance a two-minute warning\n before it terminates.

    " + "smithy.api#documentation": "

    The defined duration for Spot Instances (also known as Spot blocks) in minutes. When\n specified, the Spot Instance does not terminate before the defined duration expires, and\n defined duration pricing for Spot Instances applies. Valid values are 60, 120, 180, 240,\n 300, or 360. The duration period starts as soon as a Spot Instance receives its instance\n ID. At the end of the duration, Amazon EC2 marks the Spot Instance for termination and\n provides a Spot Instance termination notice, which gives the instance a two-minute warning\n before it terminates.

    \n \n

    Spot Instances with a defined duration (also known as Spot blocks) are no longer available to new customers from July 1, 2021. For customers who have previously used the feature, we will continue to support Spot Instances with a defined duration until December 31, 2022.\n

    \n     " } }, "AllocationStrategy": { @@ -7044,7 +7044,7 @@ } }, "traits": { - "smithy.api#documentation": "

    The launch specification for Spot Instances in the instance fleet, which determines the\n defined duration, provisioning timeout behavior, and allocation strategy.

    \n \n

    The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and\n later, excluding 5.0.x versions. Spot Instance allocation strategy is available in\n Amazon EMR version 5.12.1 and later.

    \n     " + "smithy.api#documentation": "

    The launch specification for Spot Instances in the instance fleet, which determines the\n defined duration, provisioning timeout behavior, and allocation strategy.

    \n \n

    The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and\n later, excluding 5.0.x versions. Spot Instance allocation strategy is available in\n Amazon EMR version 5.12.1 and later.

    \n     \n \n

    Spot Instances with a defined duration (also known as Spot blocks) are no longer available to new customers from July 1, 2021. For customers who have previously used the feature, we will continue to support Spot Instances with a defined duration until December 31, 2022.\n

    \n     " } }, "com.amazonaws.emr#SpotProvisioningTimeoutAction": { @@ -7801,7 +7801,7 @@ "Key": { "target": "com.amazonaws.emr#String", "traits": { - "smithy.api#documentation": "

    A user-defined key, which is the minimum required information for a valid tag. For more\n information, see Tag .

    " + "smithy.api#documentation": "

    A user-defined key, which is the minimum required information for a valid tag. For more\n information, see Tag.

    " } }, "Value": { @@ -8079,7 +8079,7 @@ "VolumeType": { "target": "com.amazonaws.emr#String", "traits": { - "smithy.api#documentation": "

    The volume type. Volume types supported are gp2, io1, standard.

    ", + "smithy.api#documentation": "

    The volume type. Volume types supported are gp2, io1, and standard.

    ", "smithy.api#required": {} } }, diff --git a/codegen/sdk-codegen/aws-models/fis.json b/codegen/sdk-codegen/aws-models/fis.json index 012a1ce603f83..9d2e3a7dfed85 100644 --- a/codegen/sdk-codegen/aws-models/fis.json +++ b/codegen/sdk-codegen/aws-models/fis.json @@ -182,7 +182,7 @@ "type": "structure", "members": { "resourceType": { - "target": "com.amazonaws.fis#TargetResourceType", + "target": "com.amazonaws.fis#TargetResourceTypeId", "traits": { "smithy.api#documentation": "

    The resource type of the target.

    " } @@ -412,9 +412,9 @@ "type": "structure", "members": { "resourceType": { - "target": "com.amazonaws.fis#ResourceType", + "target": "com.amazonaws.fis#TargetResourceTypeId", "traits": { - "smithy.api#documentation": "

    The Amazon Web Services resource type. The resource type must be supported for the specified action.

    ", + "smithy.api#documentation": "

    The resource type. The resource type must be supported for the specified action.

    ", "smithy.api#required": {} } }, @@ -442,6 +442,12 @@ "smithy.api#documentation": "

    Scopes the identified resources to a specific count of the resources at random, or a percentage of the resources. All identified resources are included in the target.

    \n
      \n
    • \n

      ALL - Run the action on all identified targets. This is the default.

      \n
      • \n
    • \n

      COUNT(n) - Run the action on the specified number of targets, chosen from the identified targets at random.\n For example, COUNT(1) selects one of the targets.

      \n
      • \n
    • \n

      PERCENT(n) - Run the action on the specified percentage of targets, chosen from the identified targets \n at random. For example, PERCENT(25) selects 25% of the targets.

      \n
      • \n
    ", "smithy.api#required": {} } + }, + "parameters": { + "target": "com.amazonaws.fis#ExperimentTemplateTargetParameterMap", + "traits": { + "smithy.api#documentation": "

    The resource type parameters.

    " + } } }, "traits": { @@ -972,7 +978,7 @@ "type": "structure", "members": { "resourceType": { - "target": "com.amazonaws.fis#ResourceType", + "target": "com.amazonaws.fis#TargetResourceTypeId", "traits": { "smithy.api#documentation": "

    The resource type.

    " } @@ -1000,6 +1006,12 @@ "traits": { "smithy.api#documentation": "

    Scopes the identified resources to a specific count or percentage.

    " } + }, + "parameters": { + "target": "com.amazonaws.fis#ExperimentTargetParameterMap", + "traits": { + "smithy.api#documentation": "

    The resource type parameters.

    " + } } }, "traits": { @@ -1077,6 +1089,34 @@ "smithy.api#pattern": "^[\\S]+$" } }, + "com.amazonaws.fis#ExperimentTargetParameterMap": { + "type": "map", + "key": { + "target": "com.amazonaws.fis#ExperimentTargetParameterName" + }, + "value": { + "target": "com.amazonaws.fis#ExperimentTargetParameterValue" + } + }, + "com.amazonaws.fis#ExperimentTargetParameterName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 64 + }, + "smithy.api#pattern": "^[\\S]+$" + } + }, + "com.amazonaws.fis#ExperimentTargetParameterValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + } + } + }, "com.amazonaws.fis#ExperimentTargetSelectionMode": { "type": "string", "traits": { @@ -1374,7 +1414,7 @@ "type": "structure", "members": { "resourceType": { - "target": "com.amazonaws.fis#ResourceType", + "target": "com.amazonaws.fis#TargetResourceTypeId", "traits": { "smithy.api#documentation": "

    The resource type.

    " } @@ -1402,6 +1442,12 @@ "traits": { "smithy.api#documentation": "

    Scopes the identified resources to a specific count or percentage.

    " } + }, + "parameters": { + "target": "com.amazonaws.fis#ExperimentTemplateTargetParameterMap", + "traits": { + "smithy.api#documentation": "

    The resource type parameters.

    " + } } }, "traits": { @@ -1507,6 +1553,35 @@ "smithy.api#pattern": "^[\\S]+$" } }, + "com.amazonaws.fis#ExperimentTemplateTargetParameterMap": { + "type": "map", + "key": { + "target": "com.amazonaws.fis#ExperimentTemplateTargetParameterName" + }, + "value": { + "target": "com.amazonaws.fis#ExperimentTemplateTargetParameterValue" + } + }, + "com.amazonaws.fis#ExperimentTemplateTargetParameterName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 64 + }, + "smithy.api#pattern": "^[\\S]+$" + } + }, + "com.amazonaws.fis#ExperimentTemplateTargetParameterValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^[\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]+$" + } + }, "com.amazonaws.fis#ExperimentTemplateTargetSelectionMode": { "type": "string", "traits": { @@ -1551,6 +1626,9 @@ { "target": "com.amazonaws.fis#GetExperimentTemplate" }, + { + "target": "com.amazonaws.fis#GetTargetResourceType" + }, { "target": "com.amazonaws.fis#ListActions" }, @@ -1563,6 +1641,9 @@ { "target": "com.amazonaws.fis#ListTagsForResource" }, + { + "target": "com.amazonaws.fis#ListTargetResourceTypes" + }, { "target": "com.amazonaws.fis#StartExperiment" }, @@ -1727,6 +1808,55 @@ } } }, + "com.amazonaws.fis#GetTargetResourceType": { + "type": "operation", + "input": { + "target": "com.amazonaws.fis#GetTargetResourceTypeRequest" + }, + "output": { + "target": "com.amazonaws.fis#GetTargetResourceTypeResponse" + }, + "errors": [ + { + "target": "com.amazonaws.fis#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.fis#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

    Gets information about the specified resource type.

    ", + "smithy.api#http": { + "method": "GET", + "uri": "/targetResourceTypes/{resourceType}", + "code": 200 + } + } + }, + "com.amazonaws.fis#GetTargetResourceTypeRequest": { + "type": "structure", + "members": { + "resourceType": { + "target": "com.amazonaws.fis#TargetResourceTypeId", + "traits": { + "smithy.api#documentation": "

    The resource type.

    ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.fis#GetTargetResourceTypeResponse": { + "type": "structure", + "members": { + "targetResourceType": { + "target": "com.amazonaws.fis#TargetResourceType", + "traits": { + "smithy.api#documentation": "

    Information about the resource type.

    " + } + } + } + }, "com.amazonaws.fis#LastUpdateTime": { "type": "timestamp" }, @@ -1990,6 +2120,79 @@ } } }, + "com.amazonaws.fis#ListTargetResourceTypes": { + "type": "operation", + "input": { + "target": "com.amazonaws.fis#ListTargetResourceTypesRequest" + }, + "output": { + "target": "com.amazonaws.fis#ListTargetResourceTypesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.fis#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

    Lists the target resource types.

    ", + "smithy.api#http": { + "method": "GET", + "uri": "/targetResourceTypes", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.fis#ListTargetResourceTypesMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.fis#ListTargetResourceTypesRequest": { + "type": "structure", + "members": { + "maxResults": { + "target": "com.amazonaws.fis#ListTargetResourceTypesMaxResults", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "

    The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

    ", + "smithy.api#httpQuery": "maxResults" + } + }, + "nextToken": { + "target": "com.amazonaws.fis#NextToken", + "traits": { + "smithy.api#documentation": "

    The token for the next page of results.

    ", + "smithy.api#httpQuery": "nextToken" + } + } + } + }, + "com.amazonaws.fis#ListTargetResourceTypesResponse": { + "type": "structure", + "members": { + "targetResourceTypes": { + "target": "com.amazonaws.fis#TargetResourceTypeSummaryList", + "traits": { + "smithy.api#documentation": "

    The target resource types.

    " + } + }, + "nextToken": { + "target": "com.amazonaws.fis#NextToken", + "traits": { + "smithy.api#documentation": "

    The token to use to retrieve the next page of results. This value is null when there are no more results to return.

    " + } + } + } + }, "com.amazonaws.fis#NextToken": { "type": "string", "traits": { @@ -2039,16 +2242,6 @@ "smithy.api#httpError": 404 } }, - "com.amazonaws.fis#ResourceType": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 64 - }, - "smithy.api#pattern": "^[\\S]+$" - } - }, "com.amazonaws.fis#RoleArn": { "type": "string", "traits": { @@ -2296,6 +2489,42 @@ } }, "com.amazonaws.fis#TargetResourceType": { + "type": "structure", + "members": { + "resourceType": { + "target": "com.amazonaws.fis#TargetResourceTypeId", + "traits": { + "smithy.api#documentation": "

    The resource type.

    " + } + }, + "description": { + "target": "com.amazonaws.fis#TargetResourceTypeDescription", + "traits": { + "smithy.api#documentation": "

    A description of the resource type.

    " + } + }, + "parameters": { + "target": "com.amazonaws.fis#TargetResourceTypeParameterMap", + "traits": { + "smithy.api#documentation": "

    The parameters for the resource type.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Describes a resource type.

    " + } + }, + "com.amazonaws.fis#TargetResourceTypeDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 512 + }, + "smithy.api#pattern": "^[\\s\\S]+$" + } + }, + "com.amazonaws.fis#TargetResourceTypeId": { "type": "string", "traits": { "smithy.api#length": { @@ -2305,6 +2534,85 @@ "smithy.api#pattern": "^[\\S]+$" } }, + "com.amazonaws.fis#TargetResourceTypeParameter": { + "type": "structure", + "members": { + "description": { + "target": "com.amazonaws.fis#TargetResourceTypeParameterDescription", + "traits": { + "smithy.api#documentation": "

    A description of the parameter.

    " + } + }, + "required": { + "target": "com.amazonaws.fis#TargetResourceTypeParameterRequired", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "

    Indicates whether the parameter is required.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Describes the parameters for a resource type. Use parameters to determine which tasks are\n identified during target resolution.

    " + } + }, + "com.amazonaws.fis#TargetResourceTypeParameterDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 512 + }, + "smithy.api#pattern": "^[\\s\\S]+$" + } + }, + "com.amazonaws.fis#TargetResourceTypeParameterMap": { + "type": "map", + "key": { + "target": "com.amazonaws.fis#TargetResourceTypeParameterName" + }, + "value": { + "target": "com.amazonaws.fis#TargetResourceTypeParameter" + } + }, + "com.amazonaws.fis#TargetResourceTypeParameterName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 64 + }, + "smithy.api#pattern": "^[\\S]+$" + } + }, + "com.amazonaws.fis#TargetResourceTypeParameterRequired": { + "type": "boolean" + }, + "com.amazonaws.fis#TargetResourceTypeSummary": { + "type": "structure", + "members": { + "resourceType": { + "target": "com.amazonaws.fis#TargetResourceTypeId", + "traits": { + "smithy.api#documentation": "

    The resource type.

    " + } + }, + "description": { + "target": "com.amazonaws.fis#TargetResourceTypeDescription", + "traits": { + "smithy.api#documentation": "

    A description of the resource type.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Describes a resource type.

    " + } + }, + "com.amazonaws.fis#TargetResourceTypeSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.fis#TargetResourceTypeSummary" + } + }, "com.amazonaws.fis#UntagResource": { "type": "operation", "input": { @@ -2506,9 +2814,9 @@ "type": "structure", "members": { "resourceType": { - "target": "com.amazonaws.fis#ResourceType", + "target": "com.amazonaws.fis#TargetResourceTypeId", "traits": { - "smithy.api#documentation": "

    The Amazon Web Services resource type. The resource type must be supported for the specified action.

    ", + "smithy.api#documentation": "

    The resource type. The resource type must be supported for the specified action.

    ", "smithy.api#required": {} } }, @@ -2536,6 +2844,12 @@ "smithy.api#documentation": "

    Scopes the identified resources to a specific count or percentage.

    ", "smithy.api#required": {} } + }, + "parameters": { + "target": "com.amazonaws.fis#ExperimentTemplateTargetParameterMap", + "traits": { + "smithy.api#documentation": "

    The resource type parameters.

    " + } } }, "traits": { diff --git a/codegen/sdk-codegen/aws-models/glue.json b/codegen/sdk-codegen/aws-models/glue.json index d20b258a4635c..0d32257f47c1a 100644 --- a/codegen/sdk-codegen/aws-models/glue.json +++ b/codegen/sdk-codegen/aws-models/glue.json @@ -2384,7 +2384,7 @@ "DataFormat": { "target": "com.amazonaws.glue#DataFormat", "traits": { - "smithy.api#documentation": "

    The data format of the schema definition. Currently AVRO and JSON are supported.

    ", + "smithy.api#documentation": "

    The data format of the schema definition. Currently AVRO, JSON and PROTOBUF are supported.

    ", "smithy.api#required": {} } }, @@ -5083,6 +5083,9 @@ { "target": "com.amazonaws.glue#AlreadyExistsException" }, + { + "target": "com.amazonaws.glue#ConcurrentModificationException" + }, { "target": "com.amazonaws.glue#InternalServiceException" }, @@ -5165,6 +5168,9 @@ { "target": "com.amazonaws.glue#AlreadyExistsException" }, + { + "target": "com.amazonaws.glue#ConcurrentModificationException" + }, { "target": "com.amazonaws.glue#EntityNotFoundException" }, @@ -5201,7 +5207,7 @@ "DataFormat": { "target": "com.amazonaws.glue#DataFormat", "traits": { - "smithy.api#documentation": "

    The data format of the schema definition. Currently AVRO and JSON are supported.

    ", + "smithy.api#documentation": "

    The data format of the schema definition. Currently AVRO, JSON and PROTOBUF are supported.

    ", "smithy.api#required": {} } }, @@ -5267,7 +5273,7 @@ "DataFormat": { "target": "com.amazonaws.glue#DataFormat", "traits": { - "smithy.api#documentation": "

    The data format of the schema definition. Currently AVRO and JSON are supported.

    " + "smithy.api#documentation": "

    The data format of the schema definition. Currently AVRO, JSON and PROTOBUF are supported.

    " } }, "Compatibility": { @@ -5991,6 +5997,10 @@ { "value": "JSON", "name": "JSON" + }, + { + "value": "PROTOBUF", + "name": "PROTOBUF" } ] } @@ -10815,7 +10825,7 @@ "DataFormat": { "target": "com.amazonaws.glue#DataFormat", "traits": { - "smithy.api#documentation": "

    The data format of the schema definition. Currently only AVRO and JSON are supported.

    " + "smithy.api#documentation": "

    The data format of the schema definition. Currently AVRO, JSON and PROTOBUF are supported.

    " } }, "Status": { @@ -10880,7 +10890,7 @@ "DataFormat": { "target": "com.amazonaws.glue#DataFormat", "traits": { - "smithy.api#documentation": "

    The data format of the schema definition. Currently AVRO and JSON are supported.

    " + "smithy.api#documentation": "

    The data format of the schema definition. Currently AVRO, JSON and PROTOBUF are supported.

    " } }, "Compatibility": { @@ -10994,7 +11004,7 @@ "DataFormat": { "target": "com.amazonaws.glue#DataFormat", "traits": { - "smithy.api#documentation": "

    The data format of the schema definition. Currently AVRO and JSON are supported.

    " + "smithy.api#documentation": "

    The data format of the schema definition. Currently AVRO, JSON and PROTOBUF are supported.

    " } }, "SchemaArn": { diff --git a/codegen/sdk-codegen/aws-models/iot.json b/codegen/sdk-codegen/aws-models/iot.json index bacf1d1baff06..40813a011cce1 100644 --- a/codegen/sdk-codegen/aws-models/iot.json +++ b/codegen/sdk-codegen/aws-models/iot.json @@ -21546,6 +21546,18 @@ { "value": "THING_GROUP", "name": "THING_GROUP" + }, + { + "value": "CLIENT_ID", + "name": "CLIENT_ID" + }, + { + "value": "SOURCE_IP", + "name": "SOURCE_IP" + }, + { + "value": "PRINCIPAL_ID", + "name": "PRINCIPAL_ID" } ] } diff --git a/codegen/sdk-codegen/aws-models/lakeformation.json b/codegen/sdk-codegen/aws-models/lakeformation.json index cc0feedaa4024..2c235adac40d2 100644 --- a/codegen/sdk-codegen/aws-models/lakeformation.json +++ b/codegen/sdk-codegen/aws-models/lakeformation.json @@ -5523,8 +5523,7 @@ "TransactionId": { "target": "com.amazonaws.lakeformation#TransactionIdString", "traits": { - "smithy.api#documentation": "

    The transaction at which to do the write.

    ", - "smithy.api#required": {} + "smithy.api#documentation": "

    The transaction at which to do the write.

    " } }, "WriteOperations": { diff --git a/codegen/sdk-codegen/aws-models/marketplace-metering.json b/codegen/sdk-codegen/aws-models/marketplace-metering.json index c3ed9984900ee..15abd8c1f5273 100644 --- a/codegen/sdk-codegen/aws-models/marketplace-metering.json +++ b/codegen/sdk-codegen/aws-models/marketplace-metering.json @@ -31,6 +31,21 @@ "shapes": { "com.amazonaws.marketplacemetering#AWSMPMeteringService": { "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "Marketplace Metering", + "arnNamespace": "aws-marketplace", + "cloudFormationName": "MarketplaceMetering", + "cloudTrailEventSource": "marketplacemetering.amazonaws.com", + "endpointPrefix": "metering.marketplace" + }, + "aws.auth#sigv4": { + "name": "aws-marketplace" + }, + "aws.protocols#awsJson1_1": {}, + "smithy.api#documentation": "AWS Marketplace Metering Service\n

    This reference provides descriptions of the low-level AWS Marketplace Metering Service\n API.

    \n

    AWS Marketplace sellers can use this API to submit usage data for custom usage\n dimensions.

    \n

    For information on the permissions you need to use this API, see AWS Marketplace metering and entitlement API permissions in the\n AWS Marketplace Seller Guide.\n

    \n

    \n Submitting Metering Records\n

    \n
      \n
    • \n

      \n MeterUsage - Submits the metering record for an AWS\n Marketplace product. MeterUsage is called from an EC2 instance or a\n container running on EKS or ECS.

      \n
      • \n
    • \n

      \n BatchMeterUsage - Submits the metering record for a set of\n customers. BatchMeterUsage is called from a software-as-a-service\n (SaaS) application.

      \n
      • \n
    \n

    \n Accepting New Customers\n

    \n
      \n
    • \n

      \n ResolveCustomer - Called by a SaaS application during the\n registration process. When a buyer visits your website during the registration\n process, the buyer submits a Registration Token through the browser. The\n Registration Token is resolved through this API to obtain a\n CustomerIdentifier\n \n along with the CustomerAWSAccountId and\n ProductCode.

      \n
      • \n
    \n

    \n Entitlement and Metering for Paid Container Products\n

    \n
      \n
    • \n

      Paid container software products sold through AWS Marketplace must integrate\n with the AWS Marketplace Metering Service and call the\n RegisterUsage operation for software entitlement and metering.\n Free and BYOL products for Amazon ECS or Amazon EKS aren't required to call\n RegisterUsage, but you can do so if you want to receive usage\n data in your seller reports. For more information on using the\n RegisterUsage operation, see Container-Based Products.

      \n
      • \n
    \n

    \n BatchMeterUsage API calls are captured by AWS CloudTrail. You can use\n Cloudtrail to verify that the SaaS metering records that you sent are accurate by\n searching for records with the eventName of BatchMeterUsage.\n You can also use CloudTrail to audit records over time. For more information, see the\n \n AWS CloudTrail User Guide.\n

    ", + "smithy.api#title": "AWSMarketplace Metering" + }, "version": "2016-01-14", "operations": [ { @@ -45,22 +60,7 @@ { "target": "com.amazonaws.marketplacemetering#ResolveCustomer" } - ], - "traits": { - "aws.api#service": { - "sdkId": "Marketplace Metering", - "arnNamespace": "aws-marketplace", - "cloudFormationName": "MarketplaceMetering", - "cloudTrailEventSource": "marketplacemetering.amazonaws.com", - "endpointPrefix": "metering.marketplace" - }, - "aws.auth#sigv4": { - "name": "aws-marketplace" - }, - "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "AWS Marketplace Metering Service\n

    This reference provides descriptions of the low-level AWS Marketplace Metering\n Service API.

    \n

    AWS Marketplace sellers can use this API to submit usage data for custom usage\n dimensions.

    \n

    For information on the permissions you need to use this API, see\n AWS Marketing metering and entitlement API permissions in the AWS Marketplace Seller Guide. \n

    \n

    \n Submitting Metering Records\n

    \n
      \n
    • \n

      \n MeterUsage- Submits the metering record for a Marketplace\n product. MeterUsage is called from an EC2 instance or a container running on EKS\n or ECS.

      \n
      • \n
    • \n

      \n BatchMeterUsage- Submits the metering record for a set of\n customers. BatchMeterUsage is called from a software-as-a-service (SaaS)\n application.

      \n
      • \n
    \n

    \n Accepting New Customers\n

    \n
      \n
    • \n

      \n ResolveCustomer- Called by a SaaS application during the\n registration process. When a buyer visits your website during the registration\n process, the buyer submits a Registration Token through the browser. The\n Registration Token is resolved through this API to obtain a CustomerIdentifier\n and Product Code.

      \n
      • \n
    \n

    \n Entitlement and Metering for Paid Container Products\n

    \n
      \n
    • \n

      Paid container software products sold through AWS Marketplace must\n integrate with the AWS Marketplace Metering Service and call the RegisterUsage\n operation for software entitlement and metering. Free and BYOL products for\n Amazon ECS or Amazon EKS aren't required to call RegisterUsage, but you can do\n so if you want to receive usage data in your seller reports. For more\n information on using the RegisterUsage operation, see Container-Based Products.

      \n
      • \n
    \n

    BatchMeterUsage API calls are captured by AWS CloudTrail. You can use Cloudtrail to\n verify that the SaaS metering records that you sent are accurate by searching for\n records with the eventName of BatchMeterUsage. You can also use CloudTrail to audit\n records over time. For more information, see the \n AWS CloudTrail User Guide\n .

    ", - "smithy.api#title": "AWSMarketplace Metering" - } + ] }, "com.amazonaws.marketplacemetering#AllocatedUsageQuantity": { "type": "integer", @@ -110,7 +110,7 @@ } ], "traits": { - "smithy.api#documentation": "

    BatchMeterUsage is called from a SaaS application listed on the AWS Marketplace to\n post metering records for a set of customers.

    \n

    For identical requests, the API is idempotent; requests can be retried with the\n same records or a subset of the input records.

    \n

    Every request to BatchMeterUsage is for one product. If you need to meter usage for\n multiple products, you must make multiple calls to BatchMeterUsage.

    \n

    BatchMeterUsage can process up to 25 UsageRecords at a time.

    \n

    A UsageRecord can optionally include multiple usage allocations, to provide customers\n with usagedata split into buckets by tags that you define (or allow the customer to \n define).

    \n

    BatchMeterUsage requests must be less than 1MB in size.

    " + "smithy.api#documentation": "

    \n BatchMeterUsage is called from a SaaS application listed on AWS\n Marketplace to post metering records for a set of customers.

    \n

    For identical requests, the API is idempotent; requests can be retried with the same\n records or a subset of the input records.

    \n

    Every request to BatchMeterUsage is for one product. If you need to meter\n usage for multiple products, you must make multiple calls to\n BatchMeterUsage.

    \n

    Usage records are expected to be submitted as quickly as possible after the event that\n is being recorded, and are not accepted more than 6 hours after the event.

    \n

    \n BatchMeterUsage can process up to 25 UsageRecords at a\n time.

    \n

    A UsageRecord can optionally include multiple usage allocations, to\n provide customers with usage data split into buckets by tags that you define (or allow\n the customer to define).

    \n

    \n BatchMeterUsage returns a list of UsageRecordResult objects,\n showing the result for each UsageRecord, as well as a list of\n UnprocessedRecords, indicating errors in the service side that you\n should retry.

    \n

    \n BatchMeterUsage requests must be less than 1MB in size.

    \n \n

    For an example of using BatchMeterUsage, see BatchMeterUsage code example in the AWS Marketplace Seller\n Guide.

    \n     " } }, "com.amazonaws.marketplacemetering#BatchMeterUsageRequest": { @@ -119,20 +119,20 @@ "UsageRecords": { "target": "com.amazonaws.marketplacemetering#UsageRecordList", "traits": { - "smithy.api#documentation": "

    The set of UsageRecords to submit. BatchMeterUsage accepts up to 25 UsageRecords at\n a time.

    ", + "smithy.api#documentation": "

    The set of UsageRecords to submit. BatchMeterUsage accepts\n up to 25 UsageRecords at a time.

    ", "smithy.api#required": {} } }, "ProductCode": { "target": "com.amazonaws.marketplacemetering#ProductCode", "traits": { - "smithy.api#documentation": "

    Product code is used to uniquely identify a product in AWS Marketplace. The product\n code should be the same as the one used during the publishing of a new\n product.

    ", + "smithy.api#documentation": "

    Product code is used to uniquely identify a product in AWS Marketplace. The product\n code should be the same as the one used during the publishing of a new product.

    ", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

    A BatchMeterUsageRequest contains UsageRecords, which indicate quantities of usage\n within your application.

    " + "smithy.api#documentation": "

    A BatchMeterUsageRequest contains UsageRecords, which\n indicate quantities of usage within your application.

    " } }, "com.amazonaws.marketplacemetering#BatchMeterUsageResult": { @@ -141,18 +141,18 @@ "Results": { "target": "com.amazonaws.marketplacemetering#UsageRecordResultList", "traits": { - "smithy.api#documentation": "

    Contains all UsageRecords processed by BatchMeterUsage. These records were either\n honored by AWS Marketplace Metering Service or were invalid.

    " + "smithy.api#documentation": "

    Contains all UsageRecords processed by BatchMeterUsage.\n These records were either honored by AWS Marketplace Metering Service or were invalid.\n Invalid records should be fixed before being resubmitted.

    " } }, "UnprocessedRecords": { "target": "com.amazonaws.marketplacemetering#UsageRecordList", "traits": { - "smithy.api#documentation": "

    Contains all UsageRecords that were not processed by BatchMeterUsage. This is a\n list of UsageRecords. You can retry the failed request by making another BatchMeterUsage\n call with this list as input in the BatchMeterUsageRequest.

    " + "smithy.api#documentation": "

    Contains all UsageRecords that were not processed by\n BatchMeterUsage. This is a list of UsageRecords. You can\n retry the failed request by making another BatchMeterUsage call with this\n list as input in the BatchMeterUsageRequest.

    " } } }, "traits": { - "smithy.api#documentation": "

    Contains the UsageRecords processed by BatchMeterUsage and any records that have\n failed due to transient error.

    " + "smithy.api#documentation": "

    Contains the UsageRecords processed by BatchMeterUsage and\n any records that have failed due to transient error.

    " } }, "com.amazonaws.marketplacemetering#Boolean": { @@ -161,6 +161,16 @@ "smithy.api#box": {} } }, + "com.amazonaws.marketplacemetering#CustomerAWSAccountId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^[0-9]+$" + } + }, "com.amazonaws.marketplacemetering#CustomerIdentifier": { "type": "string", "traits": { @@ -168,7 +178,7 @@ "min": 1, "max": 255 }, - "smithy.api#pattern": "[\\s\\S]+" + "smithy.api#pattern": "^[\\s\\S]+$" } }, "com.amazonaws.marketplacemetering#CustomerNotEntitledException": { @@ -203,7 +213,7 @@ } }, "traits": { - "smithy.api#documentation": "

    A metering record has already been emitted by the same EC2 instance, ECS task, or\n EKS pod for the given {usageDimension, timestamp} with a different\n usageQuantity.

    ", + "smithy.api#documentation": "

    A metering record has already been emitted by the same EC2 instance, ECS task, or EKS\n pod for the given {usageDimension, timestamp} with a different\n usageQuantity.

    ", "smithy.api#error": "client" } }, @@ -215,7 +225,7 @@ } }, "traits": { - "smithy.api#documentation": "

    The submitted registration token has expired. This can happen if the buyer's\n browser takes too long to redirect to your page, the buyer has resubmitted the\n registration token, or your application has held on to the registration token for too\n long. Your SaaS registration website should redeem this token as soon as it is submitted\n by the buyer's browser.

    ", + "smithy.api#documentation": "

    The submitted registration token has expired. This can happen if the buyer's browser\n takes too long to redirect to your page, the buyer has resubmitted the registration\n token, or your application has held on to the registration token for too long. Your SaaS\n registration website should redeem this token as soon as it is submitted by the buyer's\n browser.

    ", "smithy.api#error": "client" } }, @@ -239,7 +249,7 @@ } }, "traits": { - "smithy.api#documentation": "

    You have metered usage for a CustomerIdentifier that does not exist.

    ", + "smithy.api#documentation": "

    You have metered usage for a CustomerIdentifier that does not\n exist.

    ", "smithy.api#error": "client" } }, @@ -287,7 +297,7 @@ } }, "traits": { - "smithy.api#documentation": "

    RegisterUsage must be called in the same AWS Region the ECS task was launched in.\n This prevents a container from hardcoding a Region (e.g. withRegion(“us-east-1”) when\n calling RegisterUsage.

    ", + "smithy.api#documentation": "

    \n RegisterUsage must be called in the same AWS Region the ECS task was\n launched in. This prevents a container from hardcoding a Region (e.g.\n withRegion(“us-east-1”) when calling RegisterUsage.

    ", "smithy.api#error": "client" } }, @@ -323,7 +333,7 @@ } }, "traits": { - "smithy.api#documentation": "

    The usage allocation objects are invalid, or the number of allocations is greater\n than 500 for a single usage record.

    ", + "smithy.api#documentation": "

    The usage allocation objects are invalid, or the number of allocations is greater than\n 500 for a single usage record.

    ", "smithy.api#error": "client" } }, @@ -335,7 +345,7 @@ } }, "traits": { - "smithy.api#documentation": "

    The usage dimension does not match one of the UsageDimensions associated with\n products.

    ", + "smithy.api#documentation": "

    The usage dimension does not match one of the UsageDimensions associated\n with products.

    ", "smithy.api#error": "client" } }, @@ -380,7 +390,7 @@ } ], "traits": { - "smithy.api#documentation": "

    API to emit metering records. For identical requests, the API is idempotent. It\n simply returns the metering record ID.

    \n

    MeterUsage is authenticated on the buyer's AWS account using credentials from the\n EC2 instance, ECS task, or EKS pod.

    \n

    MeterUsage can optionally include multiple usage allocations, to provide customers\n with usage data split into buckets by tags that you define (or allow the customer to\n define).

    " + "smithy.api#documentation": "

    API to emit metering records. For identical requests, the API is idempotent. It simply\n returns the metering record ID.

    \n

    \n MeterUsage is authenticated on the buyer's AWS account using credentials\n from the EC2 instance, ECS task, or EKS pod.

    \n

    \n MeterUsage can optionally include multiple usage allocations, to provide\n customers with usage data split into buckets by tags that you define (or allow the\n customer to define).

    \n

    Usage records are expected to be submitted as quickly as possible after the event that\n is being recorded, and are not accepted more than 6 hours after the event.

    " } }, "com.amazonaws.marketplacemetering#MeterUsageRequest": { @@ -389,14 +399,14 @@ "ProductCode": { "target": "com.amazonaws.marketplacemetering#ProductCode", "traits": { - "smithy.api#documentation": "

    Product code is used to uniquely identify a product in AWS Marketplace. The product\n code should be the same as the one used during the publishing of a new\n product.

    ", + "smithy.api#documentation": "

    Product code is used to uniquely identify a product in AWS Marketplace. The product\n code should be the same as the one used during the publishing of a new product.

    ", "smithy.api#required": {} } }, "Timestamp": { "target": "com.amazonaws.marketplacemetering#Timestamp", "traits": { - "smithy.api#documentation": "

    Timestamp, in UTC, for which the usage is being reported. Your application can\n meter usage for up to one hour in the past. Make sure the timestamp value is not before\n the start of the software usage.

    ", + "smithy.api#documentation": "

    Timestamp, in UTC, for which the usage is being reported. Your application can meter\n usage for up to one hour in the past. Make sure the timestamp value is not\n before the start of the software usage.

    ", "smithy.api#required": {} } }, @@ -410,19 +420,19 @@ "UsageQuantity": { "target": "com.amazonaws.marketplacemetering#UsageQuantity", "traits": { - "smithy.api#documentation": "

    Consumption value for the hour. Defaults to 0 if not\n specified.

    " + "smithy.api#documentation": "

    Consumption value for the hour. Defaults to 0 if not specified.

    " } }, "DryRun": { "target": "com.amazonaws.marketplacemetering#Boolean", "traits": { - "smithy.api#documentation": "

    Checks whether you have the permissions required for the action, but does not make\n the request. If you have the permissions, the request returns DryRunOperation;\n otherwise, it returns UnauthorizedException. Defaults to false if not\n specified.

    " + "smithy.api#documentation": "

    Checks whether you have the permissions required for the action, but does not make the\n request. If you have the permissions, the request returns DryRunOperation;\n otherwise, it returns UnauthorizedException. Defaults to false\n if not specified.

    " } }, "UsageAllocations": { "target": "com.amazonaws.marketplacemetering#UsageAllocations", "traits": { - "smithy.api#documentation": "

    The set of UsageAllocations to submit.

    \n

    The sum of all UsageAllocation quantities must equal the\n UsageQuantity of the MeterUsage request, and each UsageAllocation must have a\n unique set of tags (include no tags).

    " + "smithy.api#documentation": "

    The set of UsageAllocations to submit.

    \n

    The sum of all UsageAllocation quantities must equal the\n UsageQuantity of the MeterUsage request, and each\n UsageAllocation must have a unique set of tags (include no\n tags).

    " } } } @@ -441,7 +451,7 @@ "com.amazonaws.marketplacemetering#NonEmptyString": { "type": "string", "traits": { - "smithy.api#pattern": "[\\s\\S]+" + "smithy.api#pattern": "^[\\s\\S]+$" } }, "com.amazonaws.marketplacemetering#Nonce": { @@ -451,7 +461,7 @@ "min": 0, "max": 255 }, - "smithy.api#pattern": "[\\s\\S]*" + "smithy.api#pattern": "^[\\s\\S]*$" } }, "com.amazonaws.marketplacemetering#PlatformNotSupportedException": { @@ -473,7 +483,7 @@ "min": 1, "max": 255 }, - "smithy.api#pattern": "[\\s\\S]+" + "smithy.api#pattern": "^[-a-zA-Z0-9/=:_.@]*$" } }, "com.amazonaws.marketplacemetering#RegisterUsage": { @@ -511,7 +521,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Paid container software products sold through AWS Marketplace must integrate with\n the AWS Marketplace Metering Service and call the RegisterUsage operation for software\n entitlement and metering. Free and BYOL products for Amazon ECS or Amazon EKS aren't\n required to call RegisterUsage, but you may choose to do so if you would like to receive\n usage data in your seller reports. The sections below explain the behavior of\n RegisterUsage. RegisterUsage performs two primary functions: metering and\n entitlement.

    \n\n
      \n
    • \n

      \n Entitlement: RegisterUsage allows you to verify that the\n customer running your paid software is subscribed to your product on AWS\n Marketplace, enabling you to guard against unauthorized use. Your container\n image that integrates with RegisterUsage is only required to guard against\n unauthorized use at container startup, as such a\n CustomerNotSubscribedException/PlatformNotSupportedException will only be thrown\n on the initial call to RegisterUsage. Subsequent calls from the same Amazon ECS\n task instance (e.g. task-id) or Amazon EKS pod will not throw a\n CustomerNotSubscribedException, even if the customer unsubscribes while the\n Amazon ECS task or Amazon EKS pod is still running.

      \n
      • \n
    • \n

      \n Metering: RegisterUsage meters software use per ECS task,\n per hour, or per pod for Amazon EKS with usage prorated to the second. A minimum\n of 1 minute of usage applies to tasks that are short lived. For example, if a\n customer has a 10 node Amazon ECS or Amazon EKS cluster and a service configured\n as a Daemon Set, then Amazon ECS or Amazon EKS will launch a task on all 10\n cluster nodes and the customer will be charged: (10 * hourly_rate). Metering for\n software use is automatically handled by the AWS Marketplace Metering Control\n Plane -- your software is not required to perform any metering specific actions,\n other than call RegisterUsage once for metering of software use to commence. The\n AWS Marketplace Metering Control Plane will also continue to bill customers for\n running ECS tasks and Amazon EKS pods, regardless of the customers subscription\n state, removing the need for your software to perform entitlement checks at\n runtime.

      \n
      • \n
    " + "smithy.api#documentation": "

    Paid container software products sold through AWS Marketplace must integrate with the\n AWS Marketplace Metering Service and call the RegisterUsage operation for\n software entitlement and metering. Free and BYOL products for Amazon ECS or Amazon EKS\n aren't required to call RegisterUsage, but you may choose to do so if you\n would like to receive usage data in your seller reports. The sections below explain the\n behavior of RegisterUsage. RegisterUsage performs two primary\n functions: metering and entitlement.

    \n
      \n
    • \n

      \n Entitlement: RegisterUsage allows you to\n verify that the customer running your paid software is subscribed to your\n product on AWS Marketplace, enabling you to guard against unauthorized use. Your\n container image that integrates with RegisterUsage is only required\n to guard against unauthorized use at container startup, as such a\n CustomerNotSubscribedException or\n PlatformNotSupportedException will only be thrown on the\n initial call to RegisterUsage. Subsequent calls from the same\n Amazon ECS task instance (e.g. task-id) or Amazon EKS pod will not throw a\n CustomerNotSubscribedException, even if the customer\n unsubscribes while the Amazon ECS task or Amazon EKS pod is still\n running.

      \n
      • \n
    • \n

      \n Metering: RegisterUsage meters software use\n per ECS task, per hour, or per pod for Amazon EKS with usage prorated to the\n second. A minimum of 1 minute of usage applies to tasks that are short lived.\n For example, if a customer has a 10 node Amazon ECS or Amazon EKS cluster and a\n service configured as a Daemon Set, then Amazon ECS or Amazon EKS will launch a\n task on all 10 cluster nodes and the customer will be charged: (10 *\n hourly_rate). Metering for software use is automatically handled by the AWS\n Marketplace Metering Control Plane -- your software is not required to perform\n any metering specific actions, other than call RegisterUsage once\n for metering of software use to commence. The AWS Marketplace Metering Control\n Plane will also continue to bill customers for running ECS tasks and Amazon EKS\n pods, regardless of the customers subscription state, removing the need for your\n software to perform entitlement checks at runtime.

      \n
      • \n
    " } }, "com.amazonaws.marketplacemetering#RegisterUsageRequest": { @@ -520,7 +530,7 @@ "ProductCode": { "target": "com.amazonaws.marketplacemetering#ProductCode", "traits": { - "smithy.api#documentation": "

    Product code is used to uniquely identify a product in AWS Marketplace. The product\n code should be the same as the one used during the publishing of a new\n product.

    ", + "smithy.api#documentation": "

    Product code is used to uniquely identify a product in AWS Marketplace. The product\n code should be the same as the one used during the publishing of a new product.

    ", "smithy.api#required": {} } }, @@ -534,7 +544,7 @@ "Nonce": { "target": "com.amazonaws.marketplacemetering#Nonce", "traits": { - "smithy.api#documentation": "

    (Optional) To scope down the registration to a specific running software instance\n and guard against replay attacks.

    " + "smithy.api#documentation": "

    (Optional) To scope down the registration to a specific running software instance and\n guard against replay attacks.

    " } } } @@ -582,7 +592,7 @@ } ], "traits": { - "smithy.api#documentation": "

    ResolveCustomer is called by a SaaS application during the registration process.\n When a buyer visits your website during the registration process, the buyer submits a\n registration token through their browser. The registration token is resolved through\n this API to obtain a CustomerIdentifier and product code.

    " + "smithy.api#documentation": "

    \n ResolveCustomer is called by a SaaS application during the registration\n process. When a buyer visits your website during the registration process, the buyer\n submits a registration token through their browser. The registration token is resolved\n through this API to obtain a CustomerIdentifier\n along with the\n CustomerAWSAccountId and\n ProductCode.

    \n \n

    The API needs to called from the seller account id used to publish the SaaS\n application to successfully resolve the token.

    \n

    For an example of using ResolveCustomer, see ResolveCustomer code example in the AWS Marketplace Seller\n Guide.

    \n     " } }, "com.amazonaws.marketplacemetering#ResolveCustomerRequest": { @@ -591,13 +601,13 @@ "RegistrationToken": { "target": "com.amazonaws.marketplacemetering#NonEmptyString", "traits": { - "smithy.api#documentation": "

    When a buyer visits your website during the registration process, the buyer submits\n a registration token through the browser. The registration token is resolved to obtain a\n CustomerIdentifier and product code.

    ", + "smithy.api#documentation": "

    When a buyer visits your website during the registration process, the buyer submits a\n registration token through the browser. The registration token is resolved to obtain a\n CustomerIdentifier\n along with the\n CustomerAWSAccountId\n and\n ProductCode.

    ", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

    Contains input to the ResolveCustomer operation.

    " + "smithy.api#documentation": "

    Contains input to the ResolveCustomer operation.

    " } }, "com.amazonaws.marketplacemetering#ResolveCustomerResult": { @@ -606,18 +616,24 @@ "CustomerIdentifier": { "target": "com.amazonaws.marketplacemetering#CustomerIdentifier", "traits": { - "smithy.api#documentation": "

    The CustomerIdentifier is used to identify an individual customer in your\n application. Calls to BatchMeterUsage require CustomerIdentifiers for each\n UsageRecord.

    " + "smithy.api#documentation": "

    The CustomerIdentifier is used to identify an individual customer in your\n application. Calls to BatchMeterUsage require\n CustomerIdentifiers for each UsageRecord.

    " } }, "ProductCode": { "target": "com.amazonaws.marketplacemetering#ProductCode", "traits": { - "smithy.api#documentation": "

    The product code is returned to confirm that the buyer is registering for your\n product. Subsequent BatchMeterUsage calls should be made using this product\n code.

    " + "smithy.api#documentation": "

    The product code is returned to confirm that the buyer is registering for your\n product. Subsequent BatchMeterUsage calls should be made using this product\n code.

    " + } + }, + "CustomerAWSAccountId": { + "target": "com.amazonaws.marketplacemetering#CustomerAWSAccountId", + "traits": { + "smithy.api#documentation": "

    The CustomerAWSAccountId provides the AWS account ID associated with the\n CustomerIdentifier for the individual customer.

    " } } }, "traits": { - "smithy.api#documentation": "

    The result of the ResolveCustomer operation. Contains the CustomerIdentifier and\n product code.

    " + "smithy.api#documentation": "

    The result of the ResolveCustomer operation. Contains the\n CustomerIdentifier\n \n along with the CustomerAWSAccountId and\n ProductCode.

    " } }, "com.amazonaws.marketplacemetering#String": { @@ -629,20 +645,20 @@ "Key": { "target": "com.amazonaws.marketplacemetering#TagKey", "traits": { - "smithy.api#documentation": "

    One part of a key-value pair that makes up a tag. A key is a label that acts like a\n category for the specific tag values.

    ", + "smithy.api#documentation": "

    One part of a key-value pair that makes up a tag. A key is a\n label that acts like a category for the specific tag values.

    ", "smithy.api#required": {} } }, "Value": { "target": "com.amazonaws.marketplacemetering#TagValue", "traits": { - "smithy.api#documentation": "

    One part of a key-value pair that makes up a tag. A value acts as a descriptor within\n a tag category (key). The value can be empty or null.

    ", + "smithy.api#documentation": "

    One part of a key-value pair that makes up a tag. A value\n acts as a descriptor within a tag category (key). The value can be empty or null.

    ", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

    Metadata assigned to an allocation. Each tag is made up of a key and a value.

    " + "smithy.api#documentation": "

    Metadata assigned to an allocation. Each tag is made up of a key and a\n value.

    " } }, "com.amazonaws.marketplacemetering#TagKey": { @@ -700,7 +716,7 @@ } }, "traits": { - "smithy.api#documentation": "

    The timestamp value passed in the meterUsage() is out of allowed range.

    ", + "smithy.api#documentation": "

    The timestamp value passed in the UsageRecord is out of\n allowed range.

    \n

    For BatchMeterUsage, if any of the records are outside of the allowed\n range, the entire batch is not processed. You must remove invalid records and try\n again.

    ", "smithy.api#error": "client" } }, @@ -717,12 +733,12 @@ "Tags": { "target": "com.amazonaws.marketplacemetering#TagList", "traits": { - "smithy.api#documentation": "

    The set of tags that define the bucket of usage. For the bucket of items with no\n tags, this parameter can be left out.

    " + "smithy.api#documentation": "

    The set of tags that define the bucket of usage. For the bucket of items with no tags,\n this parameter can be left out.

    " } } }, "traits": { - "smithy.api#documentation": "

    Usage allocations allow you to split usage into buckets by tags.

    \n

    Each UsageAllocation indicates the usage quantity for a specific set of tags.

    " + "smithy.api#documentation": "

    Usage allocations allow you to split usage into buckets by tags.

    \n

    Each UsageAllocation indicates the usage quantity for a specific set of\n tags.

    " } }, "com.amazonaws.marketplacemetering#UsageAllocations": { @@ -733,7 +749,7 @@ "traits": { "smithy.api#length": { "min": 1, - "max": 500 + "max": 2500 } } }, @@ -744,7 +760,7 @@ "min": 1, "max": 255 }, - "smithy.api#pattern": "[\\s\\S]+" + "smithy.api#pattern": "^[\\s\\S]+$" } }, "com.amazonaws.marketplacemetering#UsageQuantity": { @@ -763,21 +779,21 @@ "Timestamp": { "target": "com.amazonaws.marketplacemetering#Timestamp", "traits": { - "smithy.api#documentation": "

    Timestamp, in UTC, for which the usage is being reported.

    \n

    Your application can meter usage for up to one hour in the past. Make sure the\n timestamp value is not before the start of the software usage.

    ", + "smithy.api#documentation": "

    Timestamp, in UTC, for which the usage is being reported.

    \n

    Your application can meter usage for up to one hour in the past. Make sure the\n timestamp value is not before the start of the software usage.

    ", "smithy.api#required": {} } }, "CustomerIdentifier": { "target": "com.amazonaws.marketplacemetering#CustomerIdentifier", "traits": { - "smithy.api#documentation": "

    The CustomerIdentifier is obtained through the ResolveCustomer operation and\n represents an individual buyer in your application.

    ", + "smithy.api#documentation": "

    The CustomerIdentifier is obtained through the\n ResolveCustomer operation and represents an individual buyer in your\n application.

    ", "smithy.api#required": {} } }, "Dimension": { "target": "com.amazonaws.marketplacemetering#UsageDimension", "traits": { - "smithy.api#documentation": "

    During the process of registering a product on AWS Marketplace, up to eight\n dimensions are specified. These represent different units of value in your\n application.

    ", + "smithy.api#documentation": "

    During the process of registering a product on AWS Marketplace, dimensions are\n specified. These represent different units of value in your application.

    ", "smithy.api#required": {} } }, @@ -790,12 +806,12 @@ "UsageAllocations": { "target": "com.amazonaws.marketplacemetering#UsageAllocations", "traits": { - "smithy.api#documentation": "

    The set of UsageAllocations to submit. The sum of all UsageAllocation quantities \n must equal the Quantity of the UsageRecord.

    " + "smithy.api#documentation": "

    The set of UsageAllocations to submit. The sum of all\n UsageAllocation quantities must equal the Quantity of the\n UsageRecord.

    " } } }, "traits": { - "smithy.api#documentation": "

    A UsageRecord indicates a quantity of usage for a given product, customer,\n dimension and time.

    \n

    Multiple requests with the same UsageRecords as input will be deduplicated to\n prevent double charges.

    " + "smithy.api#documentation": "

    A UsageRecord indicates a quantity of usage for a given product,\n customer, dimension and time.

    \n

    Multiple requests with the same UsageRecords as input will be\n de-duplicated to prevent double charges.

    " } }, "com.amazonaws.marketplacemetering#UsageRecordList": { @@ -816,24 +832,24 @@ "UsageRecord": { "target": "com.amazonaws.marketplacemetering#UsageRecord", "traits": { - "smithy.api#documentation": "

    The UsageRecord that was part of the BatchMeterUsage request.

    " + "smithy.api#documentation": "

    The UsageRecord that was part of the BatchMeterUsage\n request.

    " } }, "MeteringRecordId": { "target": "com.amazonaws.marketplacemetering#String", "traits": { - "smithy.api#documentation": "

    The MeteringRecordId is a unique identifier for this metering event.

    " + "smithy.api#documentation": "

    The MeteringRecordId is a unique identifier for this metering\n event.

    " } }, "Status": { "target": "com.amazonaws.marketplacemetering#UsageRecordResultStatus", "traits": { - "smithy.api#documentation": "

    The UsageRecordResult Status indicates the status of an individual UsageRecord\n processed by BatchMeterUsage.

    \n
      \n
    • \n

      \n Success- The UsageRecord was accepted and honored by\n BatchMeterUsage.

      \n
      • \n
    • \n

      \n CustomerNotSubscribed- The CustomerIdentifier specified is\n not subscribed to your product. The UsageRecord was not honored. Future\n UsageRecords for this customer will fail until the customer subscribes to your\n product.

      \n
      • \n
    • \n

      \n DuplicateRecord- Indicates that the UsageRecord was invalid\n and not honored. A previously metered UsageRecord had the same customer,\n dimension, and time, but a different quantity.

      \n
      • \n
    " + "smithy.api#documentation": "

    The UsageRecordResult\n Status indicates the status of an individual UsageRecord\n processed by BatchMeterUsage.

    \n
      \n
    • \n

      \n Success- The UsageRecord was accepted and\n honored by BatchMeterUsage.

      \n
      • \n
    • \n

      \n CustomerNotSubscribed- The CustomerIdentifier\n specified is not able to use your product. The UsageRecord was not\n honored. There are three causes for this result:

      \n
        \n
      • \n

        The customer identifier is invalid.

        \n
        • \n
      • \n

        The customer identifier provided in the metering record does not have\n an active agreement or subscription with this product. Future\n UsageRecords for this customer will fail until the\n customer subscribes to your product.

        \n
        • \n
      • \n

        The customer's AWS account was suspended.

        \n
        • \n
      \n
      • \n
    • \n

      \n DuplicateRecord- Indicates that the\n UsageRecord was invalid and not honored. A previously metered\n UsageRecord had the same customer, dimension, and time, but a\n different quantity.

      \n
      • \n
    " } } }, "traits": { - "smithy.api#documentation": "

    A UsageRecordResult indicates the status of a given UsageRecord processed by\n BatchMeterUsage.

    " + "smithy.api#documentation": "

    A UsageRecordResult indicates the status of a given\n UsageRecord processed by BatchMeterUsage.

    " } }, "com.amazonaws.marketplacemetering#UsageRecordResultList": { diff --git a/codegen/sdk-codegen/aws-models/personalize.json b/codegen/sdk-codegen/aws-models/personalize.json index cdac02dbbc049..9b37bff1b1df5 100644 --- a/codegen/sdk-codegen/aws-models/personalize.json +++ b/codegen/sdk-codegen/aws-models/personalize.json @@ -1746,7 +1746,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Creates a recommender with the recipe (a Domain dataset group use case) you specify. \n You create recommenders for a Domain dataset group and specify the recommender's Amazon Resource Name (ARN) when you make a\n GetRecommendations\n request.\n

    \n \n \n \n

    \n Status\n

    \n

    A recommender can be in one of the following states:

    \n
      \n
    • \n

      CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

      \n
      • \n
    • \n

      DELETE PENDING > DELETE IN_PROGRESS

      \n
      • \n
    \n

    To get the recommender status, call DescribeRecommender.

    \n \n

    Wait until the status of the recommender\n is ACTIVE before asking the recommender for recommendations.

    \n     \n

    \n Related APIs\n

    \n ", + "smithy.api#documentation": "

    Creates a recommender with the recipe (a Domain dataset group use case) you specify. \n You create recommenders for a Domain dataset group and specify the recommender's Amazon Resource Name (ARN) when you make a\n GetRecommendations\n request.\n

    \n \n

    \n Minimum recommendation requests per second\n

    \n \n

    When you create a recommender, you can configure the recommender's minimum recommendation requests per second. The minimum recommendation requests per second\n (minRecommendationRequestsPerSecond) specifies the baseline recommendation request throughput provisioned by\n Amazon Personalize. The default minRecommendationRequestsPerSecond is 1. A recommendation request is a single GetRecommendations operation.\n Request throughput is measured in requests per second and Amazon Personalize uses your requests per second to derive\n your requests per hour and the price of your recommender usage.\n

    \n

    \n If your requests per second increases beyond\n minRecommendationRequestsPerSecond, Amazon Personalize auto-scales the provisioned capacity up and down,\n but never below minRecommendationRequestsPerSecond.\n There's a short time delay while the capacity is increased that might cause loss of\n requests.

    \n

    \n Your bill is the greater of either the minimum requests per hour (based on minRecommendationRequestsPerSecond)\n or the actual number of requests. The actual request throughput used is calculated as the average requests/second within a one-hour window.\n \n We recommend starting with the default minRecommendationRequestsPerSecond, track\n your usage using Amazon CloudWatch metrics, and then increase the minRecommendationRequestsPerSecond\n as necessary.\n

    \n \n

    \n Status\n

    \n

    A recommender can be in one of the following states:

    \n
      \n
    • \n

      CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

      \n
      • \n
    • \n

      DELETE PENDING > DELETE IN_PROGRESS

      \n
      • \n
    \n

    To get the recommender status, call DescribeRecommender.

    \n \n

    Wait until the status of the recommender\n is ACTIVE before asking the recommender for recommendations.

    \n     \n

    \n Related APIs\n

    \n ", "smithy.api#idempotent": {} } }, @@ -5670,6 +5670,12 @@ "traits": { "smithy.api#documentation": "

    Specifies the exploration configuration hyperparameters, including explorationWeight and \n explorationItemAgeCutOff, you want to use to configure the amount of item exploration Amazon Personalize uses when\n recommending items. Provide itemExplorationConfig data only if your recommenders generate personalized recommendations for a user\n (not popular items or similar items).

    " } + }, + "minRecommendationRequestsPerSecond": { + "target": "com.amazonaws.personalize#TransactionsPerSecond", + "traits": { + "smithy.api#documentation": "

    Specifies the requested minimum provisioned recommendation requests per second that\n Amazon Personalize will support.

    " + } } }, "traits": { @@ -5767,7 +5773,7 @@ } }, "traits": { - "smithy.api#documentation": "

    Provides a summary of the properties of a recommender update. For a complete listing, call the\n DescribeRecommender API.

    " + "smithy.api#documentation": "

    Provides a summary of the properties of a recommender update. For a complete listing, call the\n DescribeRecommender API operation.

    " } }, "com.amazonaws.personalize#Recommenders": { @@ -5859,7 +5865,7 @@ "kmsKeyArn": { "target": "com.amazonaws.personalize#KmsKeyArn", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the Key Management Service (KMS) key that Amazon Personalize uses to\n encrypt or decrypt the input and output files of a batch inference job.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the Key Management Service (KMS) key that Amazon Personalize uses to\n encrypt or decrypt the input and output files.

    " } } }, diff --git a/codegen/sdk-codegen/aws-models/rbin.json b/codegen/sdk-codegen/aws-models/rbin.json index 9c6f1bff52c17..01721089ae483 100644 --- a/codegen/sdk-codegen/aws-models/rbin.json +++ b/codegen/sdk-codegen/aws-models/rbin.json @@ -43,7 +43,7 @@ "name": "rbin" }, "aws.protocols#restJson1": {}, - "smithy.api#documentation": "

    This is the Recycle Bin API Reference. This documentation provides \n descriptions and syntax for each of the actions and data types in Recycle Bin.

    \n \n

    Recycle Bin is a snapshot recovery feature that enables you to restore accidentally \n deleted snapshots. When using Recycle Bin, if your snapshots are deleted, they are retained \n in the Recycle Bin for a time period that you specify.

    \n \n

    You can restore a snapshot from the Recycle Bin at any time before its retention period \n expires. After you restore a snapshot from the Recycle Bin, the snapshot is removed from the \n Recycle Bin, and you can then use it in the same way you use any other snapshot in your \n account. If the retention period expires and the snapshot is not restored, the snapshot is \n permanently deleted from the Recycle Bin and is no longer available for recovery. For more \n information about Recycle Bin, see \n Recycle Bin in the Amazon EC2 User Guide.

    ", + "smithy.api#documentation": "

    This is the Recycle Bin API Reference. This documentation provides \n descriptions and syntax for each of the actions and data types in Recycle Bin.

    \n \n

    Recycle Bin is a resource recovery feature that enables you to restore accidentally \n deleted snapshots and EBS-backed AMIs. When using Recycle Bin, if your resources are \n deleted, they are retained in the Recycle Bin for a time period that you specify.

    \n \n

    You can restore a resource from the Recycle Bin at any time before its retention period \n expires. After you restore a resource from the Recycle Bin, the resource is removed from the \n Recycle Bin, and you can then use it in the same way you use any other resource of that type \n in your account. If the retention period expires and the resource is not restored, the resource \n is permanently deleted from the Recycle Bin and is no longer available for recovery. For more \n information about Recycle Bin, see \n Recycle Bin in the Amazon Elastic Compute Cloud User Guide.

    ", "smithy.api#title": "Amazon Recycle Bin" }, "version": "2021-06-15", @@ -94,7 +94,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Creates a Recycle Bin retention rule. For more information, see \n Create Recycle Bin retention rules in the Amazon EC2 User Guide.

    ", + "smithy.api#documentation": "

    Creates a Recycle Bin retention rule. For more information, see \n Create Recycle Bin retention rules in the Amazon Elastic Compute Cloud User Guide.

    ", "smithy.api#http": { "method": "POST", "uri": "/rules", @@ -115,7 +115,7 @@ "Description": { "target": "com.amazonaws.rbin#Description", "traits": { - "smithy.api#documentation": "

    A brief description for the retention rule.

    " + "smithy.api#documentation": "

    The retention rule description.

    " } }, "Tags": { @@ -127,14 +127,14 @@ "ResourceType": { "target": "com.amazonaws.rbin#ResourceType", "traits": { - "smithy.api#documentation": "

    The resource type to be retained by the retention rule. Currently, only Amazon EBS snapshots are \n supported.

    ", + "smithy.api#documentation": "

    The resource type to be retained by the retention rule. Currently, only Amazon EBS snapshots \n and EBS-backed AMIs are supported. To retain snapshots, specify EBS_SNAPSHOT. To \n retain EBS-backed AMIs, specify EC2_IMAGE.

    ", "smithy.api#required": {} } }, "ResourceTags": { "target": "com.amazonaws.rbin#ResourceTags", "traits": { - "smithy.api#documentation": "

    Information about the resource tags to use to identify resources that are to be retained \n by the retention rule. The retention rule retains only deleted snapshots that have one or more \n of the specified tag key and value pairs. If a snapshot is deleted, but it does not have \n any of the specified tag key and value pairs, it is immediately deleted without being retained \n by the retention rule.

    \n

    You can add the same tag key and value pair to a maximum or five retention rules.

    " + "smithy.api#documentation": "

    Specifies the resource tags to use to identify resources that are to be retained by a \n tag-level retention rule. For tag-level retention rules, only deleted resources, of the specified resource type, that \n have one or more of the specified tag key and value pairs are retained. If a resource is deleted, but it does not have \n any of the specified tag key and value pairs, it is immediately deleted without being retained by the retention rule.

    \n

    You can add the same tag key and value pair to a maximum or five retention rules.

    \n

    To create a Region-level retention rule, omit this parameter. A Region-level retention rule \n does not have any resource tags specified. It retains all deleted resources of the specified \n resource type in the Region in which the rule is created, even if the resources are not tagged.

    " } } } @@ -145,7 +145,7 @@ "Identifier": { "target": "com.amazonaws.rbin#RuleIdentifier", "traits": { - "smithy.api#documentation": "

    The unique identifier of the retention rule.

    " + "smithy.api#documentation": "

    The unique ID of the retention rule.

    " } }, "RetentionPeriod": { @@ -160,7 +160,7 @@ "Tags": { "target": "com.amazonaws.rbin#TagList", "traits": { - "smithy.api#documentation": "

    The tags assigned to the retention rule.

    " + "smithy.api#documentation": "

    Information about the tags assigned to the retention rule.

    " } }, "ResourceType": { @@ -178,7 +178,7 @@ "Status": { "target": "com.amazonaws.rbin#RuleStatus", "traits": { - "smithy.api#documentation": "

    The state of the retention rule. Only retention rules that are in the available state retain snapshots.

    " + "smithy.api#documentation": "

    The state of the retention rule. Only retention rules that are in the available \n state retain resources.

    " } } } @@ -203,7 +203,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Deletes a Recycle Bin retention rule. For more information, see \n Delete Recycle Bin retention rules in the Amazon EC2 User Guide.

    ", + "smithy.api#documentation": "

    Deletes a Recycle Bin retention rule. For more information, see \n Delete Recycle Bin retention rules in the Amazon Elastic Compute Cloud User Guide.

    ", "smithy.api#http": { "method": "DELETE", "uri": "/rules/{Identifier}", @@ -217,7 +217,7 @@ "Identifier": { "target": "com.amazonaws.rbin#RuleIdentifier", "traits": { - "smithy.api#documentation": "

    The unique ID of the retention rule to delete.

    ", + "smithy.api#documentation": "

    The unique ID of the retention rule.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -290,31 +290,31 @@ "Description": { "target": "com.amazonaws.rbin#Description", "traits": { - "smithy.api#documentation": "

    The description assigned to the retention rule.

    " + "smithy.api#documentation": "

    The retention rule description.

    " } }, "ResourceType": { "target": "com.amazonaws.rbin#ResourceType", "traits": { - "smithy.api#documentation": "

    The resource type retained by the retention rule. Currently, only Amazon EBS snapshots are supported.

    " + "smithy.api#documentation": "

    The resource type retained by the retention rule.

    " } }, "RetentionPeriod": { "target": "com.amazonaws.rbin#RetentionPeriod", "traits": { - "smithy.api#documentation": "

    Information about the period for which the retention rule retains resources.

    " + "smithy.api#documentation": "

    Information about the retention period for which the retention rule is to retain resources.

    " } }, "ResourceTags": { "target": "com.amazonaws.rbin#ResourceTags", "traits": { - "smithy.api#documentation": "

    The resource tags used to identify resources that are to be retained by the retention rule.

    " + "smithy.api#documentation": "

    Information about the resource tags used to identify resources that are retained by the retention \n rule.

    " } }, "Status": { "target": "com.amazonaws.rbin#RuleStatus", "traits": { - "smithy.api#documentation": "

    The state of the retention rule. Only retention rules that are in the available state retain snapshots.

    " + "smithy.api#documentation": "

    The state of the retention rule. Only retention rules that are in the available \n state retain resources.

    " } } } @@ -368,26 +368,26 @@ "MaxResults": { "target": "com.amazonaws.rbin#MaxResults", "traits": { - "smithy.api#documentation": "

    The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error.

    " + "smithy.api#documentation": "

    The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned NextToken value.

    " } }, "NextToken": { "target": "com.amazonaws.rbin#NextToken", "traits": { - "smithy.api#documentation": "

    The token to use to retrieve the next page of results.

    " + "smithy.api#documentation": "

    The token for the next page of results.

    " } }, "ResourceType": { "target": "com.amazonaws.rbin#ResourceType", "traits": { - "smithy.api#documentation": "

    The resource type retained by the retention rule. Only retention rules that retain the specified resource type \n are listed.

    ", + "smithy.api#documentation": "

    The resource type retained by the retention rule. Only retention rules that retain \n the specified resource type are listed. Currently, only Amazon EBS snapshots and EBS-backed \n AMIs are supported. To list retention rules that retain snapshots, specify \n EBS_SNAPSHOT. To list retention rules that retain EBS-backed AMIs, specify \n EC2_IMAGE.

    ", "smithy.api#required": {} } }, "ResourceTags": { "target": "com.amazonaws.rbin#ResourceTags", "traits": { - "smithy.api#documentation": "

    The tags used to identify resources that are to be retained by the retention rule.

    " + "smithy.api#documentation": "

    Information about the resource tags used to identify resources that are retained by the retention \n rule.

    " } } } @@ -429,7 +429,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Lists the tags assigned a specific resource.

    ", + "smithy.api#documentation": "

    Lists the tags assigned to a retention rule.

    ", "smithy.api#http": { "method": "GET", "uri": "/tags/{ResourceArn}", @@ -443,7 +443,7 @@ "ResourceArn": { "target": "com.amazonaws.rbin#RuleArn", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the resource for which to list the tags.

    ", + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the retention rule.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -456,7 +456,7 @@ "Tags": { "target": "com.amazonaws.rbin#TagList", "traits": { - "smithy.api#documentation": "

    Information about the tags assigned to the resource.

    " + "smithy.api#documentation": "

    Information about the tags assigned to the retention rule.

    " } } } @@ -525,7 +525,7 @@ } }, "traits": { - "smithy.api#documentation": "

    Information about a resource tag used to identify resources that are to be retained by a Recycle Bin retention rule.

    " + "smithy.api#documentation": "

    Information about the resource tags used to identify resources that are retained by the retention \n rule.

    " } }, "com.amazonaws.rbin#ResourceTagKey": { @@ -559,6 +559,10 @@ { "value": "EBS_SNAPSHOT", "name": "EBS_SNAPSHOT" + }, + { + "value": "EC2_IMAGE", + "name": "EC2_IMAGE" } ] } @@ -582,7 +586,7 @@ } }, "traits": { - "smithy.api#documentation": "

    Information about the retention period for which a retention rule is to retain resources.

    " + "smithy.api#documentation": "

    Information about the retention period for which the retention rule is to retain resources.

    " } }, "com.amazonaws.rbin#RetentionPeriodUnit": { @@ -649,13 +653,13 @@ "Description": { "target": "com.amazonaws.rbin#Description", "traits": { - "smithy.api#documentation": "

    The description for the retention rule.

    " + "smithy.api#documentation": "

    The retention rule description.

    " } }, "RetentionPeriod": { "target": "com.amazonaws.rbin#RetentionPeriod", "traits": { - "smithy.api#documentation": "

    Information about the retention period for which the retention rule retains resources

    " + "smithy.api#documentation": "

    Information about the retention period for which the retention rule is to retain resources.

    " } } }, @@ -718,7 +722,7 @@ } }, "traits": { - "smithy.api#documentation": "

    Information about the tags assigned to a Recycle Bin retention rule.

    " + "smithy.api#documentation": "

    Information about the tags to assign to the retention rule.

    " } }, "com.amazonaws.rbin#TagKey": { @@ -778,7 +782,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Assigns tags to the specified resource.

    ", + "smithy.api#documentation": "

    Assigns tags to the specified retention rule.

    ", "smithy.api#http": { "method": "POST", "uri": "/tags/{ResourceArn}", @@ -792,7 +796,7 @@ "ResourceArn": { "target": "com.amazonaws.rbin#RuleArn", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the resource to which to assign the tags.

    ", + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the retention rule.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -800,7 +804,7 @@ "Tags": { "target": "com.amazonaws.rbin#TagList", "traits": { - "smithy.api#documentation": "

    Information about the tags to assign to the resource.

    ", + "smithy.api#documentation": "

    Information about the tags to assign to the retention rule.

    ", "smithy.api#required": {} } } @@ -840,7 +844,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Unassigns a tag from a resource.

    ", + "smithy.api#documentation": "

    Unassigns a tag from a retention rule.

    ", "smithy.api#http": { "method": "DELETE", "uri": "/tags/{ResourceArn}", @@ -854,7 +858,7 @@ "ResourceArn": { "target": "com.amazonaws.rbin#RuleArn", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the resource from which to unassign the tags.

    ", + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the retention rule.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -862,7 +866,7 @@ "TagKeys": { "target": "com.amazonaws.rbin#TagKeyList", "traits": { - "smithy.api#documentation": "

    Information about the tags to unassign from the resource.

    ", + "smithy.api#documentation": "

    The tag keys of the tags to unassign. All tags that have the specified tag key are unassigned.

    ", "smithy.api#httpQuery": "tagKeys", "smithy.api#required": {} } @@ -893,7 +897,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Updates an existing Recycle Bin retention rule. For more information, see \n Update Recycle Bin retention rules in the Amazon EC2 User Guide.

    ", + "smithy.api#documentation": "

    Updates an existing Recycle Bin retention rule. For more information, see \n Update Recycle Bin retention rules in the Amazon Elastic Compute Cloud User Guide.

    ", "smithy.api#http": { "method": "PATCH", "uri": "/rules/{Identifier}", @@ -907,7 +911,7 @@ "Identifier": { "target": "com.amazonaws.rbin#RuleIdentifier", "traits": { - "smithy.api#documentation": "

    The unique ID of the retention rule to update.

    ", + "smithy.api#documentation": "

    The unique ID of the retention rule.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -927,13 +931,13 @@ "ResourceType": { "target": "com.amazonaws.rbin#ResourceType", "traits": { - "smithy.api#documentation": "

    The resource type to be retained by the retention rule. Currently, only Amazon EBS snapshots are supported.

    " + "smithy.api#documentation": "

    The resource type to be retained by the retention rule. Currently, only Amazon EBS snapshots \n and EBS-backed AMIs are supported. To retain snapshots, specify EBS_SNAPSHOT. To \n retain EBS-backed AMIs, specify EC2_IMAGE.

    " } }, "ResourceTags": { "target": "com.amazonaws.rbin#ResourceTags", "traits": { - "smithy.api#documentation": "

    Information about the resource tags to use to identify resources that are to be retained \n by the retention rule. The retention rule retains only deleted snapshots that have one or more \n of the specified tag key and value pairs. If a snapshot is deleted, but it does not have \n any of the specified tag key and value pairs, it is immediately deleted without being retained \n by the retention rule.

    \n

    You can add the same tag key and value pair to a maximum or five retention rules.

    " + "smithy.api#documentation": "

    Specifies the resource tags to use to identify resources that are to be retained by a \n tag-level retention rule. For tag-level retention rules, only deleted resources, of the specified resource type, that \n have one or more of the specified tag key and value pairs are retained. If a resource is deleted, but it does not have \n any of the specified tag key and value pairs, it is immediately deleted without being retained by the retention rule.

    \n

    You can add the same tag key and value pair to a maximum or five retention rules.

    \n

    To create a Region-level retention rule, omit this parameter. A Region-level retention rule \n does not have any resource tags specified. It retains all deleted resources of the specified \n resource type in the Region in which the rule is created, even if the resources are not tagged.

    " } } } @@ -971,7 +975,7 @@ "Status": { "target": "com.amazonaws.rbin#RuleStatus", "traits": { - "smithy.api#documentation": "

    The state of the retention rule. Only retention rules that are in the available state retain snapshots.

    " + "smithy.api#documentation": "

    The state of the retention rule. Only retention rules that are in the available \n state retain resources.

    " } } } diff --git a/codegen/sdk-codegen/aws-models/rds.json b/codegen/sdk-codegen/aws-models/rds.json index 2ea8667c873ee..2356764328622 100644 --- a/codegen/sdk-codegen/aws-models/rds.json +++ b/codegen/sdk-codegen/aws-models/rds.json @@ -1900,7 +1900,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Creates a custom DB engine version (CEV). A CEV is a binary volume snapshot of a database engine and specific\n AMI. The only supported engine is Oracle Database 19c Enterprise Edition with the January 2021 or later\n RU/RUR.

    \n

    Amazon RDS, which is a fully managed service, supplies the Amazon Machine Image (AMI) and database software.\n The Amazon RDS database software is preinstalled, so you need only select a DB engine and version, and create\n your database. With Amazon RDS Custom for Oracle, you upload your database installation files in Amazon S3.

    \n

    When you create a custom engine version, you specify the files in a JSON document called a CEV manifest. \n This document describes installation .zip files stored in Amazon S3. RDS Custom creates your CEV from \n the installation files that you provided. This service model is called Bring Your Own Media (BYOM).

    \n

    Creation takes approximately two hours. If creation fails, RDS Custom issues RDS-EVENT-0196 with \n the message Creation failed for custom engine version, and includes details about the failure. \n For example, the event prints missing files.

    \n

    After you create the CEV, it is available for use. You can create multiple CEVs, and create multiple \n RDS Custom instances from any CEV. You can also change the status of a CEV to make it available or\n inactive.

    \n \n

    The MediaImport service that imports files from Amazon S3 to create CEVs isn't integrated with \n Amazon Web Services CloudTrail. If you turn on data logging for Amazon RDS in CloudTrail, calls to the \n CreateCustomDbEngineVersion event aren't logged. However, you might see calls from the \n API gateway that accesses your Amazon S3 bucket. These calls originate from the MediaImport service for \n the CreateCustomDbEngineVersion event.

    \n     \n

    For more information, see \n Creating a CEV in the Amazon RDS User Guide.

    " + "smithy.api#documentation": "

    Creates a custom DB engine version (CEV). A CEV is a binary volume snapshot of a database engine and specific\n AMI. The supported engines are the following:

    \n
      \n
    • \n

      Oracle Database 12.1 Enterprise Edition with the January 2021 or later RU/RUR

      \n
      • \n
    • \n

      Oracle Database 19c Enterprise Edition with the January 2021 or later RU/RUR

      \n
      • \n
    \n

    Amazon RDS, which is a fully managed service, supplies the Amazon Machine Image (AMI) and database software.\n The Amazon RDS database software is preinstalled, so you need only select a DB engine and version, and create\n your database. With Amazon RDS Custom for Oracle, you upload your database installation files in Amazon S3.

    \n

    When you create a custom engine version, you specify the files in a JSON document called a CEV manifest. \n This document describes installation .zip files stored in Amazon S3. RDS Custom creates your CEV from \n the installation files that you provided. This service model is called Bring Your Own Media (BYOM).

    \n

    Creation takes approximately two hours. If creation fails, RDS Custom issues RDS-EVENT-0196 with \n the message Creation failed for custom engine version, and includes details about the failure. \n For example, the event prints missing files.

    \n

    After you create the CEV, it is available for use. You can create multiple CEVs, and create multiple \n RDS Custom instances from any CEV. You can also change the status of a CEV to make it available or\n inactive.

    \n \n

    The MediaImport service that imports files from Amazon S3 to create CEVs isn't integrated with \n Amazon Web Services CloudTrail. If you turn on data logging for Amazon RDS in CloudTrail, calls to the \n CreateCustomDbEngineVersion event aren't logged. However, you might see calls from the \n API gateway that accesses your Amazon S3 bucket. These calls originate from the MediaImport service for \n the CreateCustomDbEngineVersion event.

    \n     \n

    For more information, see \n Creating a CEV in the Amazon RDS User Guide.

    " } }, "com.amazonaws.rds#CreateCustomDBEngineVersionMessage": { @@ -2151,7 +2151,7 @@ "DBSubnetGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    A DB subnet group to associate with this DB cluster.

    \n

    This setting is required to create a Multi-AZ DB cluster.

    \n

    Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.

    \n

    Example: mySubnetgroup\n

    \n

    Valid for: Aurora DB clusters and Multi-AZ DB clusters

    " + "smithy.api#documentation": "

    A DB subnet group to associate with this DB cluster.

    \n

    This setting is required to create a Multi-AZ DB cluster.

    \n

    Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.

    \n

    Example: mydbsubnetgroup\n

    \n

    Valid for: Aurora DB clusters and Multi-AZ DB clusters

    " } }, "Engine": { @@ -2652,7 +2652,7 @@ "DBSubnetGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    A DB subnet group to associate with this DB instance.

    \n

    If there is no DB subnet group, then it is a non-VPC DB instance.

    " + "smithy.api#documentation": "

    A DB subnet group to associate with this DB instance.

    \n

    Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.

    \n

    Example: mydbsubnetgroup\n

    " } }, "PreferredMaintenanceWindow": { @@ -3042,7 +3042,7 @@ "DBSubnetGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    Specifies a DB subnet group for the DB instance. The new DB instance is created in the VPC associated with the DB subnet group. If no DB subnet group is specified, then the new DB instance isn't created in a VPC.

    \n

    Constraints:

    \n
      \n
    • \n

      Can only be specified if the source DB instance identifier specifies a DB instance in another Amazon Web Services Region.

      \n
      • \n
    • \n

      If supplied, must match the name of an existing DBSubnetGroup.

      \n
      • \n
    • \n

      The specified DB subnet group must be in the same Amazon Web Services Region in which the operation is running.

      \n
      • \n
    • \n

      All read replicas in one Amazon Web Services Region that are created from the same source DB\n instance must either:>

      \n
        \n
      • \n

        Specify DB subnet groups from the same VPC. All these read replicas are created in the same\n VPC.

        \n
        • \n
      • \n

        Not specify a DB subnet group. All these read replicas are created outside of any\n VPC.

        \n
        • \n
      \n
      • \n
    \n

    Example: mySubnetgroup\n

    " + "smithy.api#documentation": "

    Specifies a DB subnet group for the DB instance. The new DB instance is created in the VPC associated with the DB subnet group. If no DB subnet group is specified, then the new DB instance isn't created in a VPC.

    \n

    Constraints:

    \n
      \n
    • \n

      Can only be specified if the source DB instance identifier specifies a DB instance in another Amazon Web Services Region.

      \n
      • \n
    • \n

      If supplied, must match the name of an existing DBSubnetGroup.

      \n
      • \n
    • \n

      The specified DB subnet group must be in the same Amazon Web Services Region in which the operation is running.

      \n
      • \n
    • \n

      All read replicas in one Amazon Web Services Region that are created from the same source DB\n instance must either:>

      \n
        \n
      • \n

        Specify DB subnet groups from the same VPC. All these read replicas are created in the same\n VPC.

        \n
        • \n
      • \n

        Not specify a DB subnet group. All these read replicas are created outside of any\n VPC.

        \n
        • \n
      \n
      • \n
    \n

    Example: mydbsubnetgroup\n

    " } }, "VpcSecurityGroupIds": { @@ -3584,7 +3584,7 @@ "DBSubnetGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The name for the DB subnet group. This value is stored as a lowercase string.

    \n

    Constraints: Must contain no more than 255 letters, numbers, periods, underscores, spaces, or hyphens. Must not be default.

    \n

    Example: mySubnetgroup\n

    ", + "smithy.api#documentation": "

    The name for the DB subnet group. This value is stored as a lowercase string.

    \n

    Constraints:

    \n
      \n
    • \n

      Must contain no more than 255 letters, numbers, periods, underscores, spaces, or hyphens.

      \n
      • \n
    • \n

      Must not be default.

      \n
      • \n
    • \n

      First character must be a letter.

      \n
      • \n
    \n

    Example: mydbsubnetgroup\n

    ", "smithy.api#required": {} } }, @@ -8456,7 +8456,7 @@ "DBSubnetGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The name of the database subnet group to delete.

    \n \n

    You can't delete the default subnet group.

    \n     \n

    Constraints:

    \n

    Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.

    \n

    Example: mySubnetgroup\n

    ", + "smithy.api#documentation": "

    The name of the database subnet group to delete.

    \n \n

    You can't delete the default subnet group.

    \n     \n

    Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.

    \n

    Example: mydbsubnetgroup\n

    ", "smithy.api#required": {} } } @@ -14283,7 +14283,7 @@ "DBSubnetGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The new DB subnet group for the DB instance.\n You can use this parameter to move your DB instance to a different VPC.\n \n If your DB instance isn't in a VPC, you can also use this parameter to move your DB instance into a VPC.\n For more information, see \n Working with a DB instance in a VPC \n in the Amazon RDS User Guide.\n

    \n

    Changing the subnet group causes an outage during the change. \n The change is applied during the next maintenance window,\n unless you enable ApplyImmediately.

    \n

    This parameter doesn't apply to RDS Custom.

    \n

    Constraints: If supplied, must match the name of an existing DBSubnetGroup.

    \n

    Example: mySubnetGroup\n

    " + "smithy.api#documentation": "

    The new DB subnet group for the DB instance.\n You can use this parameter to move your DB instance to a different VPC.\n \n If your DB instance isn't in a VPC, you can also use this parameter to move your DB instance into a VPC.\n For more information, see \n Working with a DB instance in a VPC \n in the Amazon RDS User Guide.\n

    \n

    Changing the subnet group causes an outage during the change. \n The change is applied during the next maintenance window,\n unless you enable ApplyImmediately.

    \n

    This parameter doesn't apply to RDS Custom.

    \n

    Constraints: If supplied, must match the name of an existing DBSubnetGroup.

    \n

    Example: mydbsubnetgroup\n

    " } }, "DBSecurityGroups": { @@ -14962,7 +14962,7 @@ "DBSubnetGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The name for the DB subnet group. This value is stored as a lowercase string.\n You can't modify the default subnet group.\n

    \n

    Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.

    \n

    Example: mySubnetgroup\n

    ", + "smithy.api#documentation": "

    The name for the DB subnet group. This value is stored as a lowercase string.\n You can't modify the default subnet group.\n

    \n

    Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.

    \n

    Example: mydbsubnetgroup\n

    ", "smithy.api#required": {} } }, @@ -17624,7 +17624,7 @@ "DBSubnetGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    A DB subnet group to associate with the restored DB cluster.

    \n

    Constraints: If supplied, must match the name of an existing DBSubnetGroup.\n

    \n

    Example: mySubnetgroup\n

    " + "smithy.api#documentation": "

    A DB subnet group to associate with the restored DB cluster.

    \n

    Constraints: If supplied, must match the name of an existing DBSubnetGroup.

    \n

    Example: mydbsubnetgroup\n

    " } }, "Engine": { @@ -17889,7 +17889,7 @@ "DBSubnetGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The name of the DB subnet group to use for the new DB cluster.

    \n

    Constraints: If supplied, must match the name of an existing DB subnet group.

    \n

    Example: mySubnetgroup\n

    \n

    Valid for: Aurora DB clusters and Multi-AZ DB clusters

    " + "smithy.api#documentation": "

    The name of the DB subnet group to use for the new DB cluster.

    \n

    Constraints: If supplied, must match the name of an existing DB subnet group.

    \n

    Example: mydbsubnetgroup\n

    \n

    Valid for: Aurora DB clusters and Multi-AZ DB clusters

    " } }, "DatabaseName": { @@ -18131,7 +18131,7 @@ "DBSubnetGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The DB subnet group name to use for the new DB cluster.

    \n

    Constraints: If supplied, must match the name of an existing DBSubnetGroup.

    \n

    Example: mySubnetgroup\n

    \n

    Valid for: Aurora DB clusters and Multi-AZ DB clusters

    " + "smithy.api#documentation": "

    The DB subnet group name to use for the new DB cluster.

    \n

    Constraints: If supplied, must match the name of an existing DBSubnetGroup.

    \n

    Example: mydbsubnetgroup\n

    \n

    Valid for: Aurora DB clusters and Multi-AZ DB clusters

    " } }, "OptionGroupName": { @@ -18364,7 +18364,7 @@ "DBSubnetGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The DB subnet group name to use for the new instance.

    \n

    Constraints: If supplied, must match the name of an existing DBSubnetGroup.

    \n

    Example: mySubnetgroup\n

    " + "smithy.api#documentation": "

    The DB subnet group name to use for the new instance.

    \n

    Constraints: If supplied, must match the name of an existing DBSubnetGroup.

    \n

    Example: mydbsubnetgroup\n

    " } }, "MultiAZ": { @@ -18451,7 +18451,7 @@ "CopyTagsToSnapshot": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

    A value that indicates whether to copy all tags from the restored DB instance to snapshots of the DB instance. By default, tags are not copied.

    " + "smithy.api#documentation": "

    A value that indicates whether to copy all tags from the restored DB instance to snapshots of the DB instance.

    \n

    In most cases, tags aren't copied by default. However, when you restore a DB instance from a DB snapshot, RDS checks whether you \n specify new tags. If yes, the new tags are added to the restored DB instance. If there are no new tags, RDS looks for the tags from\n the source DB instance for the DB snapshot, and then adds those tags to the restored DB instance.

    \n

    For more information, see \n Copying tags to DB instance snapshots in the Amazon RDS User Guide.

    " } }, "DomainIAMRoleName": { @@ -18505,7 +18505,7 @@ "CustomIamInstanceProfile": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The instance profile associated with the underlying Amazon EC2 instance of an \n RDS Custom DB instance. The instance profile must meet the following requirements:

    \n
      \n
    • \n

      The profile must exist in your account.

      \n
      • \n
    • \n

      The profile must have an IAM role that Amazon EC2 has permissions to assume.

      \n
      • \n
    • \n

      The instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom.

      \n
      • \n
    \n

    For the list of permissions required for the IAM role, see \n \n Configure IAM and your VPC in the Amazon Relational Database Service\n User Guide.

    \n

    This setting is required for RDS Custom.

    " + "smithy.api#documentation": "

    The instance profile associated with the underlying Amazon EC2 instance of an \n RDS Custom DB instance. The instance profile must meet the following requirements:

    \n
      \n
    • \n

      The profile must exist in your account.

      \n
      • \n
    • \n

      The profile must have an IAM role that Amazon EC2 has permissions to assume.

      \n
      • \n
    • \n

      The instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom.

      \n
      • \n
    \n

    For the list of permissions required for the IAM role, see \n \n Configure IAM and your VPC in the Amazon RDS User Guide.

    \n

    This setting is required for RDS Custom.

    " } }, "BackupTarget": { @@ -18661,7 +18661,7 @@ "DBSubnetGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    A DB subnet group to associate with this DB instance.

    " + "smithy.api#documentation": "

    A DB subnet group to associate with this DB instance.

    \n

    Constraints: If supplied, must match the name of an existing DBSubnetGroup.

    \n

    Example: mydbsubnetgroup\n

    " } }, "PreferredMaintenanceWindow": { @@ -19005,7 +19005,7 @@ "DBSubnetGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

    The DB subnet group name to use for the new instance.

    \n

    Constraints: If supplied, must match the name of an existing DBSubnetGroup.

    \n

    Example: mySubnetgroup\n

    " + "smithy.api#documentation": "

    The DB subnet group name to use for the new instance.

    \n

    Constraints: If supplied, must match the name of an existing DBSubnetGroup.

    \n

    Example: mydbsubnetgroup\n

    " } }, "MultiAZ": { @@ -19288,7 +19288,7 @@ "code": "SNSInvalidTopic", "httpResponseCode": 400 }, - "smithy.api#documentation": "

    SNS has responded that there is a problem with the SND topic specified.

    ", + "smithy.api#documentation": "

    SNS has responded that there is a problem with the SNS topic specified.

    ", "smithy.api#error": "client", "smithy.api#httpError": 400 } diff --git a/codegen/sdk-codegen/aws-models/robomaker.json b/codegen/sdk-codegen/aws-models/robomaker.json index 2d2c073576418..66701a5215130 100644 --- a/codegen/sdk-codegen/aws-models/robomaker.json +++ b/codegen/sdk-codegen/aws-models/robomaker.json @@ -239,7 +239,10 @@ } ], "traits": { - "smithy.api#documentation": "

    Cancels the specified deployment job.

    ", + "smithy.api#deprecated": { + "message": "Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." + }, + "smithy.api#documentation": "

    Cancels the specified deployment job.

    \n \n

    This API will no longer be supported as of May 2, 2022. Use it to remove resources that were created for Deployment Service.

    \n     ", "smithy.api#http": { "method": "POST", "uri": "/cancelDeploymentJob", @@ -257,11 +260,21 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#deprecated": { + "message": "Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." + } } }, "com.amazonaws.robomaker#CancelDeploymentJobResponse": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#deprecated": { + "message": "Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." + } + } }, "com.amazonaws.robomaker#CancelSimulationJob": { "type": "operation", @@ -589,7 +602,10 @@ } ], "traits": { - "smithy.api#documentation": "

    Deploys a specific version of a robot application to robots in a fleet.

    \n

    The robot application must have a numbered applicationVersion for\n consistency reasons. To create a new version, use\n CreateRobotApplicationVersion or see Creating a Robot Application Version.

    \n \n

    After 90 days, deployment jobs expire and will be deleted. They will no longer be\n accessible.

    \n     ", + "smithy.api#deprecated": { + "message": "AWS RoboMaker is unable to process this request as the support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." + }, + "smithy.api#documentation": "

    Deploys a specific version of a robot application to robots in a fleet.

    \n \n

    This API is no longer supported and will throw an error if used.

    \n     \n

    The robot application must have a numbered applicationVersion for\n consistency reasons. To create a new version, use\n CreateRobotApplicationVersion or see Creating a Robot Application Version.

    \n \n

    After 90 days, deployment jobs expire and will be deleted. They will no longer be\n accessible.

    \n     ", "smithy.api#http": { "method": "POST", "uri": "/createDeploymentJob", @@ -634,6 +650,11 @@ "smithy.api#documentation": "

    A map that contains tag keys and tag values that are attached to the deployment\n job.

    " } } + }, + "traits": { + "smithy.api#deprecated": { + "message": "AWS RoboMaker is unable to process this request as the support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." + } } }, "com.amazonaws.robomaker#CreateDeploymentJobResponse": { @@ -693,6 +714,11 @@ "smithy.api#documentation": "

    The list of all tags added to the deployment job.

    " } } + }, + "traits": { + "smithy.api#deprecated": { + "message": "AWS RoboMaker is unable to process this request as the support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." + } } }, "com.amazonaws.robomaker#CreateFleet": { @@ -718,7 +744,10 @@ } ], "traits": { - "smithy.api#documentation": "

    Creates a fleet, a logical group of robots running the same robot application.

    ", + "smithy.api#deprecated": { + "message": "AWS RoboMaker is unable to process this request as the support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." + }, + "smithy.api#documentation": "

    Creates a fleet, a logical group of robots running the same robot application.

    \n \n

    This API is no longer supported and will throw an error if used.

    \n     ", "smithy.api#http": { "method": "POST", "uri": "/createFleet", @@ -742,6 +771,11 @@ "smithy.api#documentation": "

    A map that contains tag keys and tag values that are attached to the fleet.

    " } } + }, + "traits": { + "smithy.api#deprecated": { + "message": "AWS RoboMaker is unable to process this request as the support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." + } } }, "com.amazonaws.robomaker#CreateFleetResponse": { @@ -771,6 +805,11 @@ "smithy.api#documentation": "

    The list of all tags added to the fleet.

    " } } + }, + "traits": { + "smithy.api#deprecated": { + "message": "AWS RoboMaker is unable to process this request as the support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." + } } }, "com.amazonaws.robomaker#CreateRobot": { @@ -799,7 +838,10 @@ } ], "traits": { - "smithy.api#documentation": "

    Creates a robot.

    ", + "smithy.api#deprecated": { + "message": "AWS RoboMaker is unable to process this request as the support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." + }, + "smithy.api#documentation": "

    Creates a robot.

    \n \n

    This API is no longer supported and will throw an error if used.

    \n     ", "smithy.api#http": { "method": "POST", "uri": "/createRobot", @@ -1087,6 +1129,11 @@ "smithy.api#documentation": "

    A map that contains tag keys and tag values that are attached to the robot.

    " } } + }, + "traits": { + "smithy.api#deprecated": { + "message": "AWS RoboMaker is unable to process this request as the support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." + } } }, "com.amazonaws.robomaker#CreateRobotResponse": { @@ -1128,6 +1175,11 @@ "smithy.api#documentation": "

    The list of all tags added to the robot.

    " } } + }, + "traits": { + "smithy.api#deprecated": { + "message": "AWS RoboMaker is unable to process this request as the support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." + } } }, "com.amazonaws.robomaker#CreateSimulationApplication": { @@ -2176,7 +2228,10 @@ } ], "traits": { - "smithy.api#documentation": "

    Deletes a fleet.

    ", + "smithy.api#deprecated": { + "message": "Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." + }, + "smithy.api#documentation": "

    Deletes a fleet.

    \n \n

    This API will no longer be supported as of May 2, 2022. Use it to remove resources that were created for Deployment Service.

    \n     ", "smithy.api#http": { "method": "POST", "uri": "/deleteFleet", @@ -2194,11 +2249,21 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#deprecated": { + "message": "Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." + } } }, "com.amazonaws.robomaker#DeleteFleetResponse": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#deprecated": { + "message": "Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." + } + } }, "com.amazonaws.robomaker#DeleteRobot": { "type": "operation", @@ -2220,7 +2285,10 @@ } ], "traits": { - "smithy.api#documentation": "

    Deletes a robot.

    ", + "smithy.api#deprecated": { + "message": "Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." + }, + "smithy.api#documentation": "

    Deletes a robot.

    \n \n

    This API will no longer be supported as of May 2, 2022. Use it to remove resources that were created for Deployment Service.

    \n     ", "smithy.api#http": { "method": "POST", "uri": "/deleteRobot", @@ -2288,11 +2356,21 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#deprecated": { + "message": "Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." + } } }, "com.amazonaws.robomaker#DeleteRobotResponse": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#deprecated": { + "message": "Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." + } + } }, "com.amazonaws.robomaker#DeleteSimulationApplication": { "type": "operation", @@ -2745,7 +2823,10 @@ } ], "traits": { - "smithy.api#documentation": "

    Deregisters a robot.

    ", + "smithy.api#deprecated": { + "message": "Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." + }, + "smithy.api#documentation": "

    Deregisters a robot.

    \n \n

    This API will no longer be supported as of May 2, 2022. Use it to remove resources that were created for Deployment Service.

    \n     ", "smithy.api#http": { "method": "POST", "uri": "/deregisterRobot", @@ -2770,6 +2851,11 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#deprecated": { + "message": "Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." + } } }, "com.amazonaws.robomaker#DeregisterRobotResponse": { @@ -2787,6 +2873,11 @@ "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the robot.

    " } } + }, + "traits": { + "smithy.api#deprecated": { + "message": "Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." + } } }, "com.amazonaws.robomaker#DescribeDeploymentJob": { @@ -2812,7 +2903,10 @@ } ], "traits": { - "smithy.api#documentation": "

    Describes a deployment job.

    ", + "smithy.api#deprecated": { + "message": "Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." + }, + "smithy.api#documentation": "

    Describes a deployment job.

    \n \n

    This API will no longer be supported as of May 2, 2022. Use it to remove resources that were created for Deployment Service.

    \n     ", "smithy.api#http": { "method": "POST", "uri": "/describeDeploymentJob", @@ -2830,6 +2924,11 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#deprecated": { + "message": "Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." + } } }, "com.amazonaws.robomaker#DescribeDeploymentJobResponse": { @@ -2895,6 +2994,11 @@ "smithy.api#documentation": "

    The list of all tags added to the specified deployment job.

    " } } + }, + "traits": { + "smithy.api#deprecated": { + "message": "Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." + } } }, "com.amazonaws.robomaker#DescribeFleet": { @@ -2920,7 +3024,10 @@ } ], "traits": { - "smithy.api#documentation": "

    Describes a fleet.

    ", + "smithy.api#deprecated": { + "message": "Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." + }, + "smithy.api#documentation": "

    Describes a fleet.

    \n \n

    This API will no longer be supported as of May 2, 2022. Use it to remove resources that were created for Deployment Service.

    \n     ", "smithy.api#http": { "method": "POST", "uri": "/describeFleet", @@ -2938,6 +3045,11 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#deprecated": { + "message": "Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." + } } }, "com.amazonaws.robomaker#DescribeFleetResponse": { @@ -2991,6 +3103,11 @@ "smithy.api#documentation": "

    The list of all tags added to the specified fleet.

    " } } + }, + "traits": { + "smithy.api#deprecated": { + "message": "Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." + } } }, "com.amazonaws.robomaker#DescribeRobot": { @@ -3016,7 +3133,10 @@ } ], "traits": { - "smithy.api#documentation": "

    Describes a robot.

    ", + "smithy.api#deprecated": { + "message": "Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." + }, + "smithy.api#documentation": "

    Describes a robot.

    \n \n

    This API will no longer be supported as of May 2, 2022. Use it to remove resources that were created for Deployment Service.

    \n     ", "smithy.api#http": { "method": "POST", "uri": "/describeRobot", @@ -3148,6 +3268,11 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#deprecated": { + "message": "Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." + } } }, "com.amazonaws.robomaker#DescribeRobotResponse": { @@ -3213,6 +3338,11 @@ "smithy.api#documentation": "

    The list of all tags added to the specified robot.

    " } } + }, + "traits": { + "smithy.api#deprecated": { + "message": "Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." + } } }, "com.amazonaws.robomaker#DescribeSimulationApplication": { @@ -4559,7 +4689,10 @@ } ], "traits": { - "smithy.api#documentation": "

    Returns a list of deployment jobs for a fleet. You can optionally provide filters to\n retrieve specific deployment jobs.

    ", + "smithy.api#deprecated": { + "message": "Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." + }, + "smithy.api#documentation": "

    Returns a list of deployment jobs for a fleet. You can optionally provide filters to retrieve specific deployment jobs.

    \n \n

    This API will no longer be supported as of May 2, 2022. Use it to remove resources that were created for Deployment Service.

    \n     ", "smithy.api#http": { "method": "POST", "uri": "/listDeploymentJobs", @@ -4593,6 +4726,11 @@ "smithy.api#documentation": "

    When this parameter is used, ListDeploymentJobs only returns\n maxResults results in a single page along with a nextToken\n response element. The remaining results of the initial request can be seen by sending\n another ListDeploymentJobs request with the returned nextToken\n value. This value can be between 1 and 200. If this parameter is not used, then\n ListDeploymentJobs returns up to 200 results and a nextToken\n value if applicable.

    " } } + }, + "traits": { + "smithy.api#deprecated": { + "message": "Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." + } } }, "com.amazonaws.robomaker#ListDeploymentJobsResponse": { @@ -4610,6 +4748,11 @@ "smithy.api#documentation": "

    If the previous paginated request did not return all of the remaining results, the\n response object's nextToken parameter value is set to a token. To retrieve the\n next set of results, call ListDeploymentJobs again and assign that token to\n the request object's nextToken parameter. If there are no remaining results,\n the previous response object's NextToken parameter is set to null.

    " } } + }, + "traits": { + "smithy.api#deprecated": { + "message": "Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." + } } }, "com.amazonaws.robomaker#ListFleets": { @@ -4635,7 +4778,10 @@ } ], "traits": { - "smithy.api#documentation": "

    Returns a list of fleets. You can optionally provide filters to retrieve specific\n fleets.

    ", + "smithy.api#deprecated": { + "message": "Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." + }, + "smithy.api#documentation": "

    Returns a list of fleets. You can optionally provide filters to retrieve specific fleets.

    \n \n

    This API will no longer be supported as of May 2, 2022. Use it to remove resources that were created for Deployment Service.

    \n     ", "smithy.api#http": { "method": "POST", "uri": "/listFleets", @@ -4669,6 +4815,11 @@ "smithy.api#documentation": "

    Optional filters to limit results.

    \n

    The filter name name is supported. When filtering, you must use the\n complete value of the filtered item. You can use up to three filters.

    " } } + }, + "traits": { + "smithy.api#deprecated": { + "message": "Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." + } } }, "com.amazonaws.robomaker#ListFleetsResponse": { @@ -4686,6 +4837,11 @@ "smithy.api#documentation": "

    If the previous paginated request did not return all of the remaining results, the\n response object's nextToken parameter value is set to a token. To retrieve the\n next set of results, call ListFleets again and assign that token to the\n request object's nextToken parameter. If there are no remaining results, the\n previous response object's NextToken parameter is set to null.

    " } } + }, + "traits": { + "smithy.api#deprecated": { + "message": "Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." + } } }, "com.amazonaws.robomaker#ListRobotApplications": { @@ -4790,7 +4946,10 @@ } ], "traits": { - "smithy.api#documentation": "

    Returns a list of robots. You can optionally provide filters to retrieve specific\n robots.

    ", + "smithy.api#deprecated": { + "message": "Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." + }, + "smithy.api#documentation": "

    Returns a list of robots. You can optionally provide filters to retrieve specific robots.

    \n \n

    This API will no longer be supported as of May 2, 2022. Use it to remove resources that were created for Deployment Service.

    \n     ", "smithy.api#http": { "method": "POST", "uri": "/listRobots", @@ -4824,6 +4983,11 @@ "smithy.api#documentation": "

    Optional filters to limit results.

    \n

    The filter names status and fleetName are supported. When\n filtering, you must use the complete value of the filtered item. You can use up to three\n filters, but they must be for the same named item. For example, if you are looking for\n items with the status Registered or the status Available.

    " } } + }, + "traits": { + "smithy.api#deprecated": { + "message": "Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." + } } }, "com.amazonaws.robomaker#ListRobotsResponse": { @@ -4841,6 +5005,11 @@ "smithy.api#documentation": "

    If the previous paginated request did not return all of the remaining results, the\n response object's nextToken parameter value is set to a token. To retrieve the\n next set of results, call ListRobots again and assign that token to the\n request object's nextToken parameter. If there are no remaining results, the\n previous response object's NextToken parameter is set to null.

    " } } + }, + "traits": { + "smithy.api#deprecated": { + "message": "Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." + } } }, "com.amazonaws.robomaker#ListSimulationApplications": { @@ -5672,7 +5841,10 @@ } ], "traits": { - "smithy.api#documentation": "

    Registers a robot with a fleet.

    ", + "smithy.api#deprecated": { + "message": "AWS RoboMaker is unable to process this request as the support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." + }, + "smithy.api#documentation": "

    Registers a robot with a fleet.

    \n \n

    This API is no longer supported and will throw an error if used.

    \n     ", "smithy.api#http": { "method": "POST", "uri": "/registerRobot", @@ -5697,6 +5869,11 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#deprecated": { + "message": "AWS RoboMaker is unable to process this request as the support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." + } } }, "com.amazonaws.robomaker#RegisterRobotResponse": { @@ -5714,6 +5891,11 @@ "smithy.api#documentation": "

    Information about the robot registration.

    " } } + }, + "traits": { + "smithy.api#deprecated": { + "message": "AWS RoboMaker is unable to process this request as the support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." + } } }, "com.amazonaws.robomaker#RenderingEngine": { @@ -7377,7 +7559,10 @@ } ], "traits": { - "smithy.api#documentation": "

    Syncrhonizes robots in a fleet to the latest deployment. This is helpful if robots were\n added after a deployment.

    ", + "smithy.api#deprecated": { + "message": "Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." + }, + "smithy.api#documentation": "

    Syncrhonizes robots in a fleet to the latest deployment. This is helpful if robots were added after a deployment.

    \n \n

    This API will no longer be supported as of May 2, 2022. Use it to remove resources that were created for Deployment Service.

    \n     ", "smithy.api#http": { "method": "POST", "uri": "/syncDeploymentJob", @@ -7403,6 +7588,11 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#deprecated": { + "message": "Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." + } } }, "com.amazonaws.robomaker#SyncDeploymentJobResponse": { @@ -7456,6 +7646,11 @@ "smithy.api#documentation": "

    The time, in milliseconds since the epoch, when the fleet was created.

    " } } + }, + "traits": { + "smithy.api#deprecated": { + "message": "Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." + } } }, "com.amazonaws.robomaker#TagKey": { @@ -8620,6 +8815,21 @@ }, "com.amazonaws.robomaker#robomaker": { "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "RoboMaker", + "arnNamespace": "robomaker", + "cloudFormationName": "RoboMaker", + "cloudTrailEventSource": "robomaker.amazonaws.com", + "endpointPrefix": "robomaker" + }, + "aws.auth#sigv4": { + "name": "robomaker" + }, + "aws.protocols#restJson1": {}, + "smithy.api#documentation": "

    This section provides documentation for the AWS RoboMaker API operations.

    ", + "smithy.api#title": "AWS RoboMaker" + }, "version": "2018-06-29", "operations": [ { @@ -8793,22 +9003,7 @@ { "target": "com.amazonaws.robomaker#UpdateWorldTemplate" } - ], - "traits": { - "aws.api#service": { - "sdkId": "RoboMaker", - "arnNamespace": "robomaker", - "cloudFormationName": "RoboMaker", - "cloudTrailEventSource": "robomaker.amazonaws.com", - "endpointPrefix": "robomaker" - }, - "aws.auth#sigv4": { - "name": "robomaker" - }, - "aws.protocols#restJson1": {}, - "smithy.api#documentation": "

    This section provides documentation for the AWS RoboMaker API operations.

    ", - "smithy.api#title": "AWS RoboMaker" - } + ] } } } diff --git a/codegen/smithy-aws-typescript-codegen/src/main/resources/software/amazon/smithy/aws/typescript/codegen/endpoints.json b/codegen/smithy-aws-typescript-codegen/src/main/resources/software/amazon/smithy/aws/typescript/codegen/endpoints.json index d75912f2426fa..4ecaa8b70f5fd 100644 --- a/codegen/smithy-aws-typescript-codegen/src/main/resources/software/amazon/smithy/aws/typescript/codegen/endpoints.json +++ b/codegen/smithy-aws-typescript-codegen/src/main/resources/software/amazon/smithy/aws/typescript/codegen/endpoints.json @@ -2873,6 +2873,7 @@ }, "connect": { "endpoints": { + "af-south-1": {}, "ap-northeast-1": {}, "ap-northeast-2": {}, "ap-southeast-1": {}, @@ -12883,6 +12884,32 @@ } } }, + "synthetics": { + "endpoints": { + "af-south-1": {}, + "ap-east-1": {}, + "ap-northeast-1": {}, + "ap-northeast-2": {}, + "ap-northeast-3": {}, + "ap-south-1": {}, + "ap-southeast-1": {}, + "ap-southeast-2": {}, + "ap-southeast-3": {}, + "ca-central-1": {}, + "eu-central-1": {}, + "eu-north-1": {}, + "eu-south-1": {}, + "eu-west-1": {}, + "eu-west-2": {}, + "eu-west-3": {}, + "me-south-1": {}, + "sa-east-1": {}, + "us-east-1": {}, + "us-east-2": {}, + "us-west-1": {}, + "us-west-2": {} + } + }, "tagging": { "endpoints": { "af-south-1": {}, @@ -14222,6 +14249,12 @@ "cn-northwest-1": {} } }, + "codepipeline": { + "endpoints": { + "cn-north-1": {}, + "cn-northwest-1": {} + } + }, "cognito-identity": { "endpoints": { "cn-north-1": {} @@ -14957,6 +14990,12 @@ "cn-northwest-1": {} } }, + "synthetics": { + "endpoints": { + "cn-north-1": {}, + "cn-northwest-1": {} + } + }, "tagging": { "endpoints": { "cn-north-1": {}, @@ -18538,6 +18577,12 @@ } } }, + "synthetics": { + "endpoints": { + "us-gov-east-1": {}, + "us-gov-west-1": {} + } + }, "tagging": { "endpoints": { "us-gov-east-1": {}, @@ -19265,6 +19310,11 @@ "us-iso-west-1": {} } }, + "synthetics": { + "endpoints": { + "us-iso-east-1": {} + } + }, "transcribe": { "defaults": { "protocols": ["https"] @@ -19639,6 +19689,11 @@ "us-isob-east-1": {} } }, + "synthetics": { + "endpoints": { + "us-isob-east-1": {} + } + }, "tagging": { "endpoints": { "us-isob-east-1": {}