import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { CreatePipelineRequest, CreatePipelineResponse } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; /** * @public * * The input for {@link CreatePipelineCommand}. */ export interface CreatePipelineCommandInput extends CreatePipelineRequest { } /** * @public * * The output of {@link CreatePipelineCommand}. */ export interface CreatePipelineCommandOutput extends CreatePipelineResponse, __MetadataBearer { } declare const CreatePipelineCommand_base: { new (input: CreatePipelineCommandInput): import("@smithy/core/client").CommandImpl; new (input: CreatePipelineCommandInput): import("@smithy/core/client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions; }; /** *

Creates an OpenSearch Ingestion pipeline. For more information, see Creating Amazon OpenSearch * Ingestion pipelines.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { OSISClient, CreatePipelineCommand } from "@aws-sdk/client-osis"; // ES Modules import * // const { OSISClient, CreatePipelineCommand } = require("@aws-sdk/client-osis"); // CommonJS import * // import type { OSISClientConfig } from "@aws-sdk/client-osis"; * const config = {}; // type is OSISClientConfig * const client = new OSISClient(config); * const input = { // CreatePipelineRequest * PipelineName: "STRING_VALUE", // required * MinUnits: Number("int"), // required * MaxUnits: Number("int"), // required * PipelineConfigurationBody: "STRING_VALUE", // required * LogPublishingOptions: { // LogPublishingOptions * IsLoggingEnabled: true || false, * CloudWatchLogDestination: { // CloudWatchLogDestination * LogGroup: "STRING_VALUE", // required * }, * }, * VpcOptions: { // VpcOptions * SubnetIds: [ // SubnetIds // required * "STRING_VALUE", * ], * SecurityGroupIds: [ // SecurityGroupIds * "STRING_VALUE", * ], * VpcAttachmentOptions: { // VpcAttachmentOptions * AttachToVpc: true || false, // required * CidrBlock: "STRING_VALUE", * }, * VpcEndpointManagement: "CUSTOMER" || "SERVICE", * }, * BufferOptions: { // BufferOptions * PersistentBufferEnabled: true || false, // required * }, * EncryptionAtRestOptions: { // EncryptionAtRestOptions * KmsKeyArn: "STRING_VALUE", // required * }, * Tags: [ // TagList * { // Tag * Key: "STRING_VALUE", // required * Value: "STRING_VALUE", // required * }, * ], * PipelineRoleArn: "STRING_VALUE", * }; * const command = new CreatePipelineCommand(input); * const response = await client.send(command); * // { // CreatePipelineResponse * // Pipeline: { // Pipeline * // PipelineName: "STRING_VALUE", * // PipelineArn: "STRING_VALUE", * // MinUnits: Number("int"), * // MaxUnits: Number("int"), * // Status: "CREATING" || "ACTIVE" || "UPDATING" || "DELETING" || "CREATE_FAILED" || "UPDATE_FAILED" || "STARTING" || "START_FAILED" || "STOPPING" || "STOPPED", * // StatusReason: { // PipelineStatusReason * // Description: "STRING_VALUE", * // }, * // PipelineConfigurationBody: "STRING_VALUE", * // CreatedAt: new Date("TIMESTAMP"), * // LastUpdatedAt: new Date("TIMESTAMP"), * // IngestEndpointUrls: [ // IngestEndpointUrlsList * // "STRING_VALUE", * // ], * // LogPublishingOptions: { // LogPublishingOptions * // IsLoggingEnabled: true || false, * // CloudWatchLogDestination: { // CloudWatchLogDestination * // LogGroup: "STRING_VALUE", // required * // }, * // }, * // VpcEndpoints: [ // VpcEndpointsList * // { // VpcEndpoint * // VpcEndpointId: "STRING_VALUE", * // VpcId: "STRING_VALUE", * // VpcOptions: { // VpcOptions * // SubnetIds: [ // SubnetIds // required * // "STRING_VALUE", * // ], * // SecurityGroupIds: [ // SecurityGroupIds * // "STRING_VALUE", * // ], * // VpcAttachmentOptions: { // VpcAttachmentOptions * // AttachToVpc: true || false, // required * // CidrBlock: "STRING_VALUE", * // }, * // VpcEndpointManagement: "CUSTOMER" || "SERVICE", * // }, * // }, * // ], * // BufferOptions: { // BufferOptions * // PersistentBufferEnabled: true || false, // required * // }, * // EncryptionAtRestOptions: { // EncryptionAtRestOptions * // KmsKeyArn: "STRING_VALUE", // required * // }, * // VpcEndpointService: "STRING_VALUE", * // ServiceVpcEndpoints: [ // ServiceVpcEndpointsList * // { // ServiceVpcEndpoint * // ServiceName: "OPENSEARCH_SERVERLESS", * // VpcEndpointId: "STRING_VALUE", * // }, * // ], * // Destinations: [ // PipelineDestinationList * // { // PipelineDestination * // ServiceName: "STRING_VALUE", * // Endpoint: "STRING_VALUE", * // }, * // ], * // Tags: [ // TagList * // { // Tag * // Key: "STRING_VALUE", // required * // Value: "STRING_VALUE", // required * // }, * // ], * // PipelineRoleArn: "STRING_VALUE", * // }, * // }; * * ``` * * @param CreatePipelineCommandInput - {@link CreatePipelineCommandInput} * @returns {@link CreatePipelineCommandOutput} * @see {@link CreatePipelineCommandInput} for command's `input` shape. * @see {@link CreatePipelineCommandOutput} for command's `response` shape. * @see {@link OSISClientResolvedConfig | config} for OSISClient's `config` shape. * * @throws {@link AccessDeniedException} (client fault) *

You don't have permissions to access the resource.

* * @throws {@link DisabledOperationException} (client fault) *

Exception is thrown when an operation has been disabled.

* * @throws {@link InternalException} (server fault) *

The request failed because of an unknown error, exception, or failure (the failure is * internal to the service).

* * @throws {@link LimitExceededException} (client fault) *

You attempted to create more than the allowed number of tags.

* * @throws {@link ResourceAlreadyExistsException} (client fault) *

You attempted to create a resource that already exists.

* * @throws {@link ResourceNotFoundException} (client fault) *

You attempted to access or delete a resource that does not exist.

* * @throws {@link ValidationException} (client fault) *

An exception for missing or invalid input fields.

* * @throws {@link OSISServiceException} *

Base exception class for all service exceptions from OSIS service.

* * * @public */ export declare class CreatePipelineCommand extends CreatePipelineCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: CreatePipelineRequest; output: CreatePipelineResponse; }; sdk: { input: CreatePipelineCommandInput; output: CreatePipelineCommandOutput; }; }; }