Adds the data source on the domain.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OpenSearchClient, AddDataSourceCommand } from "@aws-sdk/client-opensearch"; // ES Modules import + * // const { OpenSearchClient, AddDataSourceCommand } = require("@aws-sdk/client-opensearch"); // CommonJS import + * const client = new OpenSearchClient(config); + * const input = { // AddDataSourceRequest + * DomainName: "STRING_VALUE", // required + * Name: "STRING_VALUE", // required + * DataSourceType: { // DataSourceType Union: only one key present + * S3GlueDataCatalog: { // S3GlueDataCatalog + * RoleArn: "STRING_VALUE", + * }, + * }, + * Description: "STRING_VALUE", + * }; + * const command = new AddDataSourceCommand(input); + * const response = await client.send(command); + * // { // AddDataSourceResponse + * // Message: "STRING_VALUE", + * // }; + * + * ``` + * + * @param AddDataSourceCommandInput - {@link AddDataSourceCommandInput} + * @returns {@link AddDataSourceCommandOutput} + * @see {@link AddDataSourceCommandInput} for command's `input` shape. + * @see {@link AddDataSourceCommandOutput} for command's `response` shape. + * @see {@link OpenSearchClientResolvedConfig | config} for OpenSearchClient's `config` shape. + * + * @throws {@link BaseException} (client fault) + *An error occurred while processing the request.
+ * + * @throws {@link DependencyFailureException} (client fault) + *An exception for when a failure in one of the dependencies results in the service being unable to fetch details about the resource.
+ * + * @throws {@link DisabledOperationException} (client fault) + *An error occured because the client wanted to access an unsupported operation.
+ * + * @throws {@link InternalException} (server fault) + *Request processing failed because of an unknown error, exception, or internal failure.
+ * + * @throws {@link LimitExceededException} (client fault) + *An exception for trying to create more than the allowed number of resources or sub-resources.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *An exception for accessing or deleting a resource that doesn't exist.
+ * + * @throws {@link ValidationException} (client fault) + *An exception for accessing or deleting a resource that doesn't exist.
+ * + * @throws {@link OpenSearchServiceException} + *Base exception class for all service exceptions from OpenSearch service.
+ * + */ +export class AddDataSourceCommand extends $Command< + AddDataSourceCommandInput, + AddDataSourceCommandOutput, + OpenSearchClientResolvedConfig +> { + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: AddDataSourceCommandInput) { + super(); + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackDeletes the data source.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OpenSearchClient, DeleteDataSourceCommand } from "@aws-sdk/client-opensearch"; // ES Modules import + * // const { OpenSearchClient, DeleteDataSourceCommand } = require("@aws-sdk/client-opensearch"); // CommonJS import + * const client = new OpenSearchClient(config); + * const input = { // DeleteDataSourceRequest + * DomainName: "STRING_VALUE", // required + * Name: "STRING_VALUE", // required + * }; + * const command = new DeleteDataSourceCommand(input); + * const response = await client.send(command); + * // { // DeleteDataSourceResponse + * // Message: "STRING_VALUE", + * // }; + * + * ``` + * + * @param DeleteDataSourceCommandInput - {@link DeleteDataSourceCommandInput} + * @returns {@link DeleteDataSourceCommandOutput} + * @see {@link DeleteDataSourceCommandInput} for command's `input` shape. + * @see {@link DeleteDataSourceCommandOutput} for command's `response` shape. + * @see {@link OpenSearchClientResolvedConfig | config} for OpenSearchClient's `config` shape. + * + * @throws {@link BaseException} (client fault) + *An error occurred while processing the request.
+ * + * @throws {@link DependencyFailureException} (client fault) + *An exception for when a failure in one of the dependencies results in the service being unable to fetch details about the resource.
+ * + * @throws {@link DisabledOperationException} (client fault) + *An error occured because the client wanted to access an unsupported operation.
+ * + * @throws {@link InternalException} (server fault) + *Request processing failed because of an unknown error, exception, or internal failure.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *An exception for accessing or deleting a resource that doesn't exist.
+ * + * @throws {@link ValidationException} (client fault) + *An exception for accessing or deleting a resource that doesn't exist.
+ * + * @throws {@link OpenSearchServiceException} + *Base exception class for all service exceptions from OpenSearch service.
+ * + */ +export class DeleteDataSourceCommand extends $Command< + DeleteDataSourceCommandInput, + DeleteDataSourceCommandOutput, + OpenSearchClientResolvedConfig +> { + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: DeleteDataSourceCommandInput) { + super(); + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackDescribes the data source details.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OpenSearchClient, GetDataSourceCommand } from "@aws-sdk/client-opensearch"; // ES Modules import + * // const { OpenSearchClient, GetDataSourceCommand } = require("@aws-sdk/client-opensearch"); // CommonJS import + * const client = new OpenSearchClient(config); + * const input = { // GetDataSourceRequest + * DomainName: "STRING_VALUE", // required + * Name: "STRING_VALUE", // required + * }; + * const command = new GetDataSourceCommand(input); + * const response = await client.send(command); + * // { // GetDataSourceResponse + * // DataSourceType: { // DataSourceType Union: only one key present + * // S3GlueDataCatalog: { // S3GlueDataCatalog + * // RoleArn: "STRING_VALUE", + * // }, + * // }, + * // Name: "STRING_VALUE", + * // Description: "STRING_VALUE", + * // }; + * + * ``` + * + * @param GetDataSourceCommandInput - {@link GetDataSourceCommandInput} + * @returns {@link GetDataSourceCommandOutput} + * @see {@link GetDataSourceCommandInput} for command's `input` shape. + * @see {@link GetDataSourceCommandOutput} for command's `response` shape. + * @see {@link OpenSearchClientResolvedConfig | config} for OpenSearchClient's `config` shape. + * + * @throws {@link BaseException} (client fault) + *An error occurred while processing the request.
+ * + * @throws {@link DependencyFailureException} (client fault) + *An exception for when a failure in one of the dependencies results in the service being unable to fetch details about the resource.
+ * + * @throws {@link DisabledOperationException} (client fault) + *An error occured because the client wanted to access an unsupported operation.
+ * + * @throws {@link InternalException} (server fault) + *Request processing failed because of an unknown error, exception, or internal failure.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *An exception for accessing or deleting a resource that doesn't exist.
+ * + * @throws {@link ValidationException} (client fault) + *An exception for accessing or deleting a resource that doesn't exist.
+ * + * @throws {@link OpenSearchServiceException} + *Base exception class for all service exceptions from OpenSearch service.
+ * + */ +export class GetDataSourceCommand extends $Command< + GetDataSourceCommandInput, + GetDataSourceCommandOutput, + OpenSearchClientResolvedConfig +> { + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: GetDataSourceCommandInput) { + super(); + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackA list of the data source details of the domain.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OpenSearchClient, ListDataSourcesCommand } from "@aws-sdk/client-opensearch"; // ES Modules import + * // const { OpenSearchClient, ListDataSourcesCommand } = require("@aws-sdk/client-opensearch"); // CommonJS import + * const client = new OpenSearchClient(config); + * const input = { // ListDataSourcesRequest + * DomainName: "STRING_VALUE", // required + * }; + * const command = new ListDataSourcesCommand(input); + * const response = await client.send(command); + * // { // ListDataSourcesResponse + * // DataSources: [ // DataSourceList + * // { // DataSourceDetails + * // DataSourceType: { // DataSourceType Union: only one key present + * // S3GlueDataCatalog: { // S3GlueDataCatalog + * // RoleArn: "STRING_VALUE", + * // }, + * // }, + * // Name: "STRING_VALUE", + * // Description: "STRING_VALUE", + * // }, + * // ], + * // }; + * + * ``` + * + * @param ListDataSourcesCommandInput - {@link ListDataSourcesCommandInput} + * @returns {@link ListDataSourcesCommandOutput} + * @see {@link ListDataSourcesCommandInput} for command's `input` shape. + * @see {@link ListDataSourcesCommandOutput} for command's `response` shape. + * @see {@link OpenSearchClientResolvedConfig | config} for OpenSearchClient's `config` shape. + * + * @throws {@link BaseException} (client fault) + *An error occurred while processing the request.
+ * + * @throws {@link DependencyFailureException} (client fault) + *An exception for when a failure in one of the dependencies results in the service being unable to fetch details about the resource.
+ * + * @throws {@link DisabledOperationException} (client fault) + *An error occured because the client wanted to access an unsupported operation.
+ * + * @throws {@link InternalException} (server fault) + *Request processing failed because of an unknown error, exception, or internal failure.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *An exception for accessing or deleting a resource that doesn't exist.
+ * + * @throws {@link ValidationException} (client fault) + *An exception for accessing or deleting a resource that doesn't exist.
+ * + * @throws {@link OpenSearchServiceException} + *Base exception class for all service exceptions from OpenSearch service.
+ * + */ +export class ListDataSourcesCommand extends $Command< + ListDataSourcesCommandInput, + ListDataSourcesCommandOutput, + OpenSearchClientResolvedConfig +> { + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: ListDataSourcesCommandInput) { + super(); + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackUpdates the data source on the domain.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OpenSearchClient, UpdateDataSourceCommand } from "@aws-sdk/client-opensearch"; // ES Modules import + * // const { OpenSearchClient, UpdateDataSourceCommand } = require("@aws-sdk/client-opensearch"); // CommonJS import + * const client = new OpenSearchClient(config); + * const input = { // UpdateDataSourceRequest + * DomainName: "STRING_VALUE", // required + * Name: "STRING_VALUE", // required + * DataSourceType: { // DataSourceType Union: only one key present + * S3GlueDataCatalog: { // S3GlueDataCatalog + * RoleArn: "STRING_VALUE", + * }, + * }, + * Description: "STRING_VALUE", + * }; + * const command = new UpdateDataSourceCommand(input); + * const response = await client.send(command); + * // { // UpdateDataSourceResponse + * // Message: "STRING_VALUE", + * // }; + * + * ``` + * + * @param UpdateDataSourceCommandInput - {@link UpdateDataSourceCommandInput} + * @returns {@link UpdateDataSourceCommandOutput} + * @see {@link UpdateDataSourceCommandInput} for command's `input` shape. + * @see {@link UpdateDataSourceCommandOutput} for command's `response` shape. + * @see {@link OpenSearchClientResolvedConfig | config} for OpenSearchClient's `config` shape. + * + * @throws {@link BaseException} (client fault) + *An error occurred while processing the request.
+ * + * @throws {@link DependencyFailureException} (client fault) + *An exception for when a failure in one of the dependencies results in the service being unable to fetch details about the resource.
+ * + * @throws {@link DisabledOperationException} (client fault) + *An error occured because the client wanted to access an unsupported operation.
+ * + * @throws {@link InternalException} (server fault) + *Request processing failed because of an unknown error, exception, or internal failure.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *An exception for accessing or deleting a resource that doesn't exist.
+ * + * @throws {@link ValidationException} (client fault) + *An exception for accessing or deleting a resource that doesn't exist.
+ * + * @throws {@link OpenSearchServiceException} + *Base exception class for all service exceptions from OpenSearch service.
+ * + */ +export class UpdateDataSourceCommand extends $Command< + UpdateDataSourceCommandInput, + UpdateDataSourceCommandOutput, + OpenSearchClientResolvedConfig +> { + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: UpdateDataSourceCommandInput) { + super(); + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackList of limits that are specific to a given instance type.
+ *Information about the AWS S3 Glue Data Catalog.
*/ -export interface AdditionalLimit { - /** - * @public - *
- * MaximumNumberOfDataNodesSupported - This attribute only applies to master
- * nodes and specifies the maximum number of data nodes of a given instance type a master node can
- * support.
- * MaximumNumberOfDataNodesWithoutMasterNode - This attribute only applies to
- * data nodes and specifies the maximum number of data nodes of a given instance type can exist
- * without a master node governing them.
The values of the additional instance type limits.
+ *The role ARN for the AWS S3 Glue Data Catalog.
*/ - LimitValues?: string[]; + RoleArn?: string; } /** * @public - *A tag (key-value pair) for an Amazon OpenSearch Service resource.
+ *Information about the data source.
*/ -export interface Tag { +export type DataSourceType = DataSourceType.S3GlueDataCatalogMember | DataSourceType.$UnknownMember; + +/** + * @public + */ +export namespace DataSourceType { /** * @public - *The tag key. Tag keys must be unique for the domain to which they are attached.
+ *The data source for the AWS S3 Glue Data Catalog.
*/ - Key: string | undefined; + export interface S3GlueDataCatalogMember { + S3GlueDataCatalog: S3GlueDataCatalog; + $unknown?: never; + } /** * @public - *The value assigned to the corresponding tag key. Tag values can be null and don't have to be
- * unique in a tag set. For example, you can have a key value pair in a tag set of project :
- * Trinity and cost-center : Trinity
- *
Container for the parameters to the AddTags operation. Specifies the tags to
- * attach to the domain.
Container for the parameters to the AddDataSource
+ * operation.
Amazon Resource Name (ARN) for the OpenSearch Service domain to which you want to attach - * resource tags.
+ *The name of the domain.
*/ - ARN: string | undefined; + DomainName: string | undefined; /** * @public - *List of resource tags.
+ *The name of the data source.
*/ - TagList: Tag[] | undefined; + Name: string | undefined; + + /** + * @public + *The type of data source.
+ */ + DataSourceType: DataSourceType | undefined; + + /** + * @public + *A description of the data source.
+ */ + Description?: string; +} + +/** + * @public + *The result of an AddDataSource operation.
A message associated with the data source.
+ */ + Message?: string; } /** @@ -486,6 +507,26 @@ export class BaseException extends __BaseException { } } +/** + * @public + *An exception for when a failure in one of the dependencies results in the service being unable to fetch details about the resource.
+ */ +export class DependencyFailureException extends __BaseException { + readonly name: "DependencyFailureException" = "DependencyFailureException"; + readonly $fault: "client" = "client"; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeRequest processing failed because of an unknown error, exception, or internal failure.
@@ -526,6 +567,78 @@ export class ValidationException extends __BaseException { } } +/** + * @public + *List of limits that are specific to a given instance type.
+ */ +export interface AdditionalLimit { + /** + * @public + *
+ * MaximumNumberOfDataNodesSupported - This attribute only applies to master
+ * nodes and specifies the maximum number of data nodes of a given instance type a master node can
+ * support.
+ * MaximumNumberOfDataNodesWithoutMasterNode - This attribute only applies to
+ * data nodes and specifies the maximum number of data nodes of a given instance type can exist
+ * without a master node governing them.
The values of the additional instance type limits.
+ */ + LimitValues?: string[]; +} + +/** + * @public + *A tag (key-value pair) for an Amazon OpenSearch Service resource.
+ */ +export interface Tag { + /** + * @public + *The tag key. Tag keys must be unique for the domain to which they are attached.
+ */ + Key: string | undefined; + + /** + * @public + *The value assigned to the corresponding tag key. Tag values can be null and don't have to be
+ * unique in a tag set. For example, you can have a key value pair in a tag set of project :
+ * Trinity and cost-center : Trinity
+ *
Container for the parameters to the AddTags operation. Specifies the tags to
+ * attach to the domain.
Amazon Resource Name (ARN) for the OpenSearch Service domain to which you want to attach + * resource tags.
+ */ + ARN: string | undefined; + + /** + * @public + *List of resource tags.
+ */ + TagList: Tag[] | undefined; +} + /** * @public *Status of the advanced options for the specified domain. The following options are @@ -1533,18 +1646,28 @@ export interface DomainEndpointOptions { /** * @public - *
Specify the TLS security policy to apply to the HTTPS endpoint of the domain.
- *Can be one of the following values:
+ *Specify the TLS security policy to apply to the HTTPS endpoint of the domain. The policy can + * be one of the following values:
*- * Policy-Min-TLS-1-0-2019-07: TLS security policy which supports - * TLS version 1.0 and higher.
+ * Policy-Min-TLS-1-0-2019-07: TLS security policy which + * supports TLS version 1.0 to TLS version 1.2 + *+ * Policy-Min-TLS-1-2-2019-07: TLS security policy which + * supports only TLS version 1.2
+ *+ * Policy-Min-TLS-1-0-2023-10: TLS security policy which + * supports TLS version 1.0 to TLS version 1.3
*- * Policy-Min-TLS-1-2-2019-07: TLS security policy which supports - * only TLS version 1.2
+ * Policy-Min-TLS-1-2-2023-10: TLS security policy which + * supports TLS version 1.2 to TLS version 1.3 with perfect forward secrecy cipher suites *Container for the parameters to the DeleteDataSource
+ * operation.
The name of the domain.
+ */ + DomainName: string | undefined; + + /** + * @public + *The name of the data source.
+ */ + Name: string | undefined; +} + +/** + * @public + *The result of a GetDataSource operation.
A message associated with the initiated request.
+ */ + Message?: string; +} + /** * @public *Container for the parameters to the DeleteDomain operation.
An exception for when a failure in one of the dependencies results in the service being unable to fetch details about the resource.
- */ -export class DependencyFailureException extends __BaseException { - readonly name: "DependencyFailureException" = "DependencyFailureException"; - readonly $fault: "client" = "client"; - /** - * @internal - */ - constructor(opts: __ExceptionOptionTypeContainer for the parameters to the DescribeDomainNodes
@@ -5219,6 +5353,49 @@ export interface GetCompatibleVersionsResponse {
CompatibleVersions?: CompatibleVersionsMap[];
}
+/**
+ * @public
+ *
Container for the parameters to the GetDataSource
+ * operation.
The name of the domain.
+ */ + DomainName: string | undefined; + + /** + * @public + *The name of the data source.
+ */ + Name: string | undefined; +} + +/** + * @public + *The result of a GetDataSource operation.
The type of data source.
+ */ + DataSourceType?: DataSourceType; + + /** + * @public + *The name of the data source.
+ */ + Name?: string; + + /** + * @public + *A description of the data source.
+ */ + Description?: string; +} + /** * @public *Container for the parameters to the GetDomainMaintenanceStatus
@@ -5612,6 +5789,55 @@ export interface GetUpgradeStatusResponse {
UpgradeName?: string;
}
+/**
+ * @public
+ *
Container for the parameters to the ListDataSources
+ * operation.
The name of the domain.
+ */ + DomainName: string | undefined; +} + +/** + * @public + *Details about the data sources.
+ */ +export interface DataSourceDetails { + /** + * @public + *The type of data source.
+ */ + DataSourceType?: DataSourceType; + + /** + * @public + *The name of the data source.
+ */ + Name?: string; + + /** + * @public + *A description of the data source.
+ */ + Description?: string; +} + +/** + * @public + *The result of a ListDataSources operation.
A list of the data sources.
+ */ + DataSources?: DataSourceDetails[]; +} + /** * @public *Container for the parameters to the ListDomainMaintenances
@@ -6518,6 +6744,49 @@ export interface StartServiceSoftwareUpdateResponse {
ServiceSoftwareOptions?: ServiceSoftwareOptions;
}
+/**
+ * @public
+ *
Container for the parameters to the UpdateDataSource
+ * operation.
The name of the domain.
+ */ + DomainName: string | undefined; + + /** + * @public + *The name of the data source.
+ */ + Name: string | undefined; + + /** + * @public + *The type of data source.
+ */ + DataSourceType: DataSourceType | undefined; + + /** + * @public + *A description of the data source.
+ */ + Description?: string; +} + +/** + * @public + *The result of an UpdateDataSource operation.
A message associated with the data source.
+ */ + Message?: string; +} + /** * @public * @enum diff --git a/clients/client-opensearch/src/protocols/Aws_restJson1.ts b/clients/client-opensearch/src/protocols/Aws_restJson1.ts index 52749355f872..4570142cfee4 100644 --- a/clients/client-opensearch/src/protocols/Aws_restJson1.ts +++ b/clients/client-opensearch/src/protocols/Aws_restJson1.ts @@ -1,4 +1,5 @@ // smithy-typescript generated code +import { awsExpectUnion as __expectUnion } from "@aws-sdk/core"; import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@smithy/protocol-http"; import { _json, @@ -29,6 +30,7 @@ import { AcceptInboundConnectionCommandInput, AcceptInboundConnectionCommandOutput, } from "../commands/AcceptInboundConnectionCommand"; +import { AddDataSourceCommandInput, AddDataSourceCommandOutput } from "../commands/AddDataSourceCommand"; import { AddTagsCommandInput, AddTagsCommandOutput } from "../commands/AddTagsCommand"; import { AssociatePackageCommandInput, AssociatePackageCommandOutput } from "../commands/AssociatePackageCommand"; import { @@ -46,6 +48,7 @@ import { } from "../commands/CreateOutboundConnectionCommand"; import { CreatePackageCommandInput, CreatePackageCommandOutput } from "../commands/CreatePackageCommand"; import { CreateVpcEndpointCommandInput, CreateVpcEndpointCommandOutput } from "../commands/CreateVpcEndpointCommand"; +import { DeleteDataSourceCommandInput, DeleteDataSourceCommandOutput } from "../commands/DeleteDataSourceCommand"; import { DeleteDomainCommandInput, DeleteDomainCommandOutput } from "../commands/DeleteDomainCommand"; import { DeleteInboundConnectionCommandInput, @@ -113,6 +116,7 @@ import { GetCompatibleVersionsCommandInput, GetCompatibleVersionsCommandOutput, } from "../commands/GetCompatibleVersionsCommand"; +import { GetDataSourceCommandInput, GetDataSourceCommandOutput } from "../commands/GetDataSourceCommand"; import { GetDomainMaintenanceStatusCommandInput, GetDomainMaintenanceStatusCommandOutput, @@ -123,6 +127,7 @@ import { } from "../commands/GetPackageVersionHistoryCommand"; import { GetUpgradeHistoryCommandInput, GetUpgradeHistoryCommandOutput } from "../commands/GetUpgradeHistoryCommand"; import { GetUpgradeStatusCommandInput, GetUpgradeStatusCommandOutput } from "../commands/GetUpgradeStatusCommand"; +import { ListDataSourcesCommandInput, ListDataSourcesCommandOutput } from "../commands/ListDataSourcesCommand"; import { ListDomainMaintenancesCommandInput, ListDomainMaintenancesCommandOutput, @@ -176,6 +181,7 @@ import { StartServiceSoftwareUpdateCommandInput, StartServiceSoftwareUpdateCommandOutput, } from "../commands/StartServiceSoftwareUpdateCommand"; +import { UpdateDataSourceCommandInput, UpdateDataSourceCommandOutput } from "../commands/UpdateDataSourceCommand"; import { UpdateDomainConfigCommandInput, UpdateDomainConfigCommandOutput } from "../commands/UpdateDomainConfigCommand"; import { UpdatePackageCommandInput, UpdatePackageCommandOutput } from "../commands/UpdatePackageCommand"; import { @@ -210,6 +216,7 @@ import { ConflictException, ConnectionProperties, CrossClusterSearchConnectionProperties, + DataSourceType, DependencyFailureException, DescribePackagesFilter, DisabledOperationException, @@ -249,6 +256,7 @@ import { ReservedInstanceOffering, ResourceAlreadyExistsException, ResourceNotFoundException, + S3GlueDataCatalog, SAMLIdp, SAMLOptionsInput, ScheduledAutoTuneDetails, @@ -302,6 +310,40 @@ export const se_AcceptInboundConnectionCommand = async ( }); }; +/** + * serializeAws_restJson1AddDataSourceCommand + */ +export const se_AddDataSourceCommand = async ( + input: AddDataSourceCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const { hostname, protocol = "https", port, path: basePath } = await context.endpoint(); + const headers: any = { + "content-type": "application/json", + }; + let resolvedPath = + `${basePath?.endsWith("/") ? basePath.slice(0, -1) : basePath || ""}` + + "/2021-01-01/opensearch/domain/{DomainName}/dataSource"; + resolvedPath = __resolvedPath(resolvedPath, input, "DomainName", () => input.DomainName!, "{DomainName}", false); + let body: any; + body = JSON.stringify( + take(input, { + DataSourceType: (_) => _json(_), + Description: [], + Name: [], + }) + ); + return new __HttpRequest({ + protocol, + hostname, + port, + method: "POST", + headers, + path: resolvedPath, + body, + }); +}; + /** * serializeAws_restJson1AddTagsCommand */ @@ -568,6 +610,32 @@ export const se_CreateVpcEndpointCommand = async ( }); }; +/** + * serializeAws_restJson1DeleteDataSourceCommand + */ +export const se_DeleteDataSourceCommand = async ( + input: DeleteDataSourceCommandInput, + 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 || ""}` + + "/2021-01-01/opensearch/domain/{DomainName}/dataSource/{Name}"; + resolvedPath = __resolvedPath(resolvedPath, input, "DomainName", () => input.DomainName!, "{DomainName}", false); + resolvedPath = __resolvedPath(resolvedPath, input, "Name", () => input.Name!, "{Name}", false); + let body: any; + return new __HttpRequest({ + protocol, + hostname, + port, + method: "DELETE", + headers, + path: resolvedPath, + body, + }); +}; + /** * serializeAws_restJson1DeleteDomainCommand */ @@ -1220,6 +1288,32 @@ export const se_GetCompatibleVersionsCommand = async ( }); }; +/** + * serializeAws_restJson1GetDataSourceCommand + */ +export const se_GetDataSourceCommand = async ( + input: GetDataSourceCommandInput, + 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 || ""}` + + "/2021-01-01/opensearch/domain/{DomainName}/dataSource/{Name}"; + resolvedPath = __resolvedPath(resolvedPath, input, "DomainName", () => input.DomainName!, "{DomainName}", false); + resolvedPath = __resolvedPath(resolvedPath, input, "Name", () => input.Name!, "{Name}", false); + let body: any; + return new __HttpRequest({ + protocol, + hostname, + port, + method: "GET", + headers, + path: resolvedPath, + body, + }); +}; + /** * serializeAws_restJson1GetDomainMaintenanceStatusCommand */ @@ -1333,6 +1427,31 @@ export const se_GetUpgradeStatusCommand = async ( }); }; +/** + * serializeAws_restJson1ListDataSourcesCommand + */ +export const se_ListDataSourcesCommand = async ( + input: ListDataSourcesCommandInput, + 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 || ""}` + + "/2021-01-01/opensearch/domain/{DomainName}/dataSource"; + resolvedPath = __resolvedPath(resolvedPath, input, "DomainName", () => input.DomainName!, "{DomainName}", false); + let body: any; + return new __HttpRequest({ + protocol, + hostname, + port, + method: "GET", + headers, + path: resolvedPath, + body, + }); +}; + /** * serializeAws_restJson1ListDomainMaintenancesCommand */ @@ -1852,6 +1971,40 @@ export const se_StartServiceSoftwareUpdateCommand = async ( }); }; +/** + * serializeAws_restJson1UpdateDataSourceCommand + */ +export const se_UpdateDataSourceCommand = async ( + input: UpdateDataSourceCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const { hostname, protocol = "https", port, path: basePath } = await context.endpoint(); + const headers: any = { + "content-type": "application/json", + }; + let resolvedPath = + `${basePath?.endsWith("/") ? basePath.slice(0, -1) : basePath || ""}` + + "/2021-01-01/opensearch/domain/{DomainName}/dataSource/{Name}"; + resolvedPath = __resolvedPath(resolvedPath, input, "DomainName", () => input.DomainName!, "{DomainName}", false); + resolvedPath = __resolvedPath(resolvedPath, input, "Name", () => input.Name!, "{Name}", false); + let body: any; + body = JSON.stringify( + take(input, { + DataSourceType: (_) => _json(_), + Description: [], + }) + ); + return new __HttpRequest({ + protocol, + hostname, + port, + method: "PUT", + headers, + path: resolvedPath, + body, + }); +}; + /** * serializeAws_restJson1UpdateDomainConfigCommand */ @@ -2087,6 +2240,71 @@ const de_AcceptInboundConnectionCommandError = async ( } }; +/** + * deserializeAws_restJson1AddDataSourceCommand + */ +export const de_AddDataSourceCommand = async ( + output: __HttpResponse, + context: __SerdeContext +): PromiseAdds the data source on the domain.
", + "smithy.api#http": { + "method": "POST", + "uri": "/2021-01-01/opensearch/domain/{DomainName}/dataSource", + "code": 200 + } + } + }, + "com.amazonaws.opensearch#AddDataSourceRequest": { + "type": "structure", + "members": { + "DomainName": { + "target": "com.amazonaws.opensearch#DomainName", + "traits": { + "smithy.api#documentation": "The name of the domain.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.opensearch#DataSourceName", + "traits": { + "smithy.api#documentation": "The name of the data source.
", + "smithy.api#required": {} + } + }, + "DataSourceType": { + "target": "com.amazonaws.opensearch#DataSourceType", + "traits": { + "smithy.api#documentation": "The type of data source.
", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.opensearch#DataSourceDescription", + "traits": { + "smithy.api#documentation": "A description of the data source.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Container for the parameters to the AddDataSource\n operation.
A message associated with the data source.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The result of an AddDataSource operation.
Cross-cluster search specific connection properties.
" } }, + "com.amazonaws.opensearch#DataSourceDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1000 + }, + "smithy.api#pattern": "^([a-zA-Z0-9_])*[\\\\a-zA-Z0-9_@#%*+=:?./!\\s-]*$" + } + }, + "com.amazonaws.opensearch#DataSourceDetails": { + "type": "structure", + "members": { + "DataSourceType": { + "target": "com.amazonaws.opensearch#DataSourceType", + "traits": { + "smithy.api#documentation": "The type of data source.
" + } + }, + "Name": { + "target": "com.amazonaws.opensearch#DataSourceName", + "traits": { + "smithy.api#documentation": "The name of the data source.
" + } + }, + "Description": { + "target": "com.amazonaws.opensearch#DataSourceDescription", + "traits": { + "smithy.api#documentation": "A description of the data source.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Details about the data sources.
" + } + }, + "com.amazonaws.opensearch#DataSourceList": { + "type": "list", + "member": { + "target": "com.amazonaws.opensearch#DataSourceDetails" + } + }, + "com.amazonaws.opensearch#DataSourceName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 80 + }, + "smithy.api#pattern": "^[a-z][a-z0-9_]+$" + } + }, + "com.amazonaws.opensearch#DataSourceType": { + "type": "union", + "members": { + "S3GlueDataCatalog": { + "target": "com.amazonaws.opensearch#S3GlueDataCatalog", + "traits": { + "smithy.api#documentation": "The data source for the AWS S3 Glue Data Catalog.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about the data source.
" + } + }, + "com.amazonaws.opensearch#DeleteDataSource": { + "type": "operation", + "input": { + "target": "com.amazonaws.opensearch#DeleteDataSourceRequest" + }, + "output": { + "target": "com.amazonaws.opensearch#DeleteDataSourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.opensearch#BaseException" + }, + { + "target": "com.amazonaws.opensearch#DependencyFailureException" + }, + { + "target": "com.amazonaws.opensearch#DisabledOperationException" + }, + { + "target": "com.amazonaws.opensearch#InternalException" + }, + { + "target": "com.amazonaws.opensearch#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.opensearch#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes the data source.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/2021-01-01/opensearch/domain/{DomainName}/dataSource/{Name}", + "code": 200 + } + } + }, + "com.amazonaws.opensearch#DeleteDataSourceRequest": { + "type": "structure", + "members": { + "DomainName": { + "target": "com.amazonaws.opensearch#DomainName", + "traits": { + "smithy.api#documentation": "The name of the domain.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.opensearch#DataSourceName", + "traits": { + "smithy.api#documentation": "The name of the data source.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Container for the parameters to the DeleteDataSource\n operation.
A message associated with the initiated request.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The result of a GetDataSource operation.
Specify the TLS security policy to apply to the HTTPS endpoint of the domain.
\nCan be one of the following values:
\n\n Policy-Min-TLS-1-0-2019-07: TLS security policy which supports\n TLS version 1.0 and higher.
\n\n Policy-Min-TLS-1-2-2019-07: TLS security policy which supports\n only TLS version 1.2
\nSpecify the TLS security policy to apply to the HTTPS endpoint of the domain. The policy can\n be one of the following values:
\n\n Policy-Min-TLS-1-0-2019-07: TLS security policy which\n supports TLS version 1.0 to TLS version 1.2
\n\n Policy-Min-TLS-1-2-2019-07: TLS security policy which\n supports only TLS version 1.2
\n\n Policy-Min-TLS-1-0-2023-10: TLS security policy which\n supports TLS version 1.0 to TLS version 1.3
\n\n Policy-Min-TLS-1-2-2023-10: TLS security policy which\n supports TLS version 1.2 to TLS version 1.3 with perfect forward secrecy cipher suites
\nDescribes the data source details.
", + "smithy.api#http": { + "method": "GET", + "uri": "/2021-01-01/opensearch/domain/{DomainName}/dataSource/{Name}", + "code": 200 + } + } + }, + "com.amazonaws.opensearch#GetDataSourceRequest": { + "type": "structure", + "members": { + "DomainName": { + "target": "com.amazonaws.opensearch#DomainName", + "traits": { + "smithy.api#documentation": "The name of the domain.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.opensearch#DataSourceName", + "traits": { + "smithy.api#documentation": "The name of the data source.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Container for the parameters to the GetDataSource\n operation.
The type of data source.
" + } + }, + "Name": { + "target": "com.amazonaws.opensearch#DataSourceName", + "traits": { + "smithy.api#documentation": "The name of the data source.
" + } + }, + "Description": { + "target": "com.amazonaws.opensearch#DataSourceDescription", + "traits": { + "smithy.api#documentation": "A description of the data source.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The result of a GetDataSource operation.
The role of a given instance and all applicable limits. The role performed by a given OpenSearch instance can\n be one of the following:
\n\n data - A data node.
\n\n master - A dedicated master node.
\n\n ultra_warm - An UltraWarm node.
\nA list of the data source details of the domain.
", + "smithy.api#http": { + "method": "GET", + "uri": "/2021-01-01/opensearch/domain/{DomainName}/dataSource", + "code": 200 + } + } + }, + "com.amazonaws.opensearch#ListDataSourcesRequest": { + "type": "structure", + "members": { + "DomainName": { + "target": "com.amazonaws.opensearch#DomainName", + "traits": { + "smithy.api#documentation": "The name of the domain.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Container for the parameters to the ListDataSources\n operation.
A list of the data sources.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The result of a ListDataSources operation.
The role ARN for the AWS S3 Glue Data Catalog.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about the AWS S3 Glue Data Catalog.
" + } + }, "com.amazonaws.opensearch#S3Key": { "type": "string", "traits": { @@ -11005,6 +11427,96 @@ "com.amazonaws.opensearch#UncompressedPluginSizeInBytes": { "type": "long" }, + "com.amazonaws.opensearch#UpdateDataSource": { + "type": "operation", + "input": { + "target": "com.amazonaws.opensearch#UpdateDataSourceRequest" + }, + "output": { + "target": "com.amazonaws.opensearch#UpdateDataSourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.opensearch#BaseException" + }, + { + "target": "com.amazonaws.opensearch#DependencyFailureException" + }, + { + "target": "com.amazonaws.opensearch#DisabledOperationException" + }, + { + "target": "com.amazonaws.opensearch#InternalException" + }, + { + "target": "com.amazonaws.opensearch#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.opensearch#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates the data source on the domain.
", + "smithy.api#http": { + "method": "PUT", + "uri": "/2021-01-01/opensearch/domain/{DomainName}/dataSource/{Name}", + "code": 200 + } + } + }, + "com.amazonaws.opensearch#UpdateDataSourceRequest": { + "type": "structure", + "members": { + "DomainName": { + "target": "com.amazonaws.opensearch#DomainName", + "traits": { + "smithy.api#documentation": "The name of the domain.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.opensearch#DataSourceName", + "traits": { + "smithy.api#documentation": "The name of the data source.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "DataSourceType": { + "target": "com.amazonaws.opensearch#DataSourceType", + "traits": { + "smithy.api#documentation": "The type of data source.
", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.opensearch#DataSourceDescription", + "traits": { + "smithy.api#documentation": "A description of the data source.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Container for the parameters to the UpdateDataSource\n operation.
A message associated with the data source.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The result of an UpdateDataSource operation.