osis.d.ts 25 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629
  1. import {Request} from '../lib/request';
  2. import {Response} from '../lib/response';
  3. import {AWSError} from '../lib/error';
  4. import {Service} from '../lib/service';
  5. import {ServiceConfigurationOptions} from '../lib/service';
  6. import {ConfigBase as Config} from '../lib/config-base';
  7. interface Blob {}
  8. declare class OSIS extends Service {
  9. /**
  10. * Constructs a service object. This object has one method for each API operation.
  11. */
  12. constructor(options?: OSIS.Types.ClientConfiguration)
  13. config: Config & OSIS.Types.ClientConfiguration;
  14. /**
  15. * Creates an OpenSearch Ingestion pipeline. For more information, see Creating Amazon OpenSearch Ingestion pipelines.
  16. */
  17. createPipeline(params: OSIS.Types.CreatePipelineRequest, callback?: (err: AWSError, data: OSIS.Types.CreatePipelineResponse) => void): Request<OSIS.Types.CreatePipelineResponse, AWSError>;
  18. /**
  19. * Creates an OpenSearch Ingestion pipeline. For more information, see Creating Amazon OpenSearch Ingestion pipelines.
  20. */
  21. createPipeline(callback?: (err: AWSError, data: OSIS.Types.CreatePipelineResponse) => void): Request<OSIS.Types.CreatePipelineResponse, AWSError>;
  22. /**
  23. * Deletes an OpenSearch Ingestion pipeline. For more information, see Deleting Amazon OpenSearch Ingestion pipelines.
  24. */
  25. deletePipeline(params: OSIS.Types.DeletePipelineRequest, callback?: (err: AWSError, data: OSIS.Types.DeletePipelineResponse) => void): Request<OSIS.Types.DeletePipelineResponse, AWSError>;
  26. /**
  27. * Deletes an OpenSearch Ingestion pipeline. For more information, see Deleting Amazon OpenSearch Ingestion pipelines.
  28. */
  29. deletePipeline(callback?: (err: AWSError, data: OSIS.Types.DeletePipelineResponse) => void): Request<OSIS.Types.DeletePipelineResponse, AWSError>;
  30. /**
  31. * Retrieves information about an OpenSearch Ingestion pipeline.
  32. */
  33. getPipeline(params: OSIS.Types.GetPipelineRequest, callback?: (err: AWSError, data: OSIS.Types.GetPipelineResponse) => void): Request<OSIS.Types.GetPipelineResponse, AWSError>;
  34. /**
  35. * Retrieves information about an OpenSearch Ingestion pipeline.
  36. */
  37. getPipeline(callback?: (err: AWSError, data: OSIS.Types.GetPipelineResponse) => void): Request<OSIS.Types.GetPipelineResponse, AWSError>;
  38. /**
  39. * Retrieves information about a specific blueprint for OpenSearch Ingestion. Blueprints are templates for the configuration needed for a CreatePipeline request. For more information, see Using blueprints to create a pipeline.
  40. */
  41. getPipelineBlueprint(params: OSIS.Types.GetPipelineBlueprintRequest, callback?: (err: AWSError, data: OSIS.Types.GetPipelineBlueprintResponse) => void): Request<OSIS.Types.GetPipelineBlueprintResponse, AWSError>;
  42. /**
  43. * Retrieves information about a specific blueprint for OpenSearch Ingestion. Blueprints are templates for the configuration needed for a CreatePipeline request. For more information, see Using blueprints to create a pipeline.
  44. */
  45. getPipelineBlueprint(callback?: (err: AWSError, data: OSIS.Types.GetPipelineBlueprintResponse) => void): Request<OSIS.Types.GetPipelineBlueprintResponse, AWSError>;
  46. /**
  47. * Returns progress information for the current change happening on an OpenSearch Ingestion pipeline. Currently, this operation only returns information when a pipeline is being created. For more information, see Tracking the status of pipeline creation.
  48. */
  49. getPipelineChangeProgress(params: OSIS.Types.GetPipelineChangeProgressRequest, callback?: (err: AWSError, data: OSIS.Types.GetPipelineChangeProgressResponse) => void): Request<OSIS.Types.GetPipelineChangeProgressResponse, AWSError>;
  50. /**
  51. * Returns progress information for the current change happening on an OpenSearch Ingestion pipeline. Currently, this operation only returns information when a pipeline is being created. For more information, see Tracking the status of pipeline creation.
  52. */
  53. getPipelineChangeProgress(callback?: (err: AWSError, data: OSIS.Types.GetPipelineChangeProgressResponse) => void): Request<OSIS.Types.GetPipelineChangeProgressResponse, AWSError>;
  54. /**
  55. * Retrieves a list of all available blueprints for Data Prepper. For more information, see Using blueprints to create a pipeline.
  56. */
  57. listPipelineBlueprints(params: OSIS.Types.ListPipelineBlueprintsRequest, callback?: (err: AWSError, data: OSIS.Types.ListPipelineBlueprintsResponse) => void): Request<OSIS.Types.ListPipelineBlueprintsResponse, AWSError>;
  58. /**
  59. * Retrieves a list of all available blueprints for Data Prepper. For more information, see Using blueprints to create a pipeline.
  60. */
  61. listPipelineBlueprints(callback?: (err: AWSError, data: OSIS.Types.ListPipelineBlueprintsResponse) => void): Request<OSIS.Types.ListPipelineBlueprintsResponse, AWSError>;
  62. /**
  63. * Lists all OpenSearch Ingestion pipelines in the current Amazon Web Services account and Region. For more information, see Viewing Amazon OpenSearch Ingestion pipelines.
  64. */
  65. listPipelines(params: OSIS.Types.ListPipelinesRequest, callback?: (err: AWSError, data: OSIS.Types.ListPipelinesResponse) => void): Request<OSIS.Types.ListPipelinesResponse, AWSError>;
  66. /**
  67. * Lists all OpenSearch Ingestion pipelines in the current Amazon Web Services account and Region. For more information, see Viewing Amazon OpenSearch Ingestion pipelines.
  68. */
  69. listPipelines(callback?: (err: AWSError, data: OSIS.Types.ListPipelinesResponse) => void): Request<OSIS.Types.ListPipelinesResponse, AWSError>;
  70. /**
  71. * Lists all resource tags associated with an OpenSearch Ingestion pipeline. For more information, see Tagging Amazon OpenSearch Ingestion pipelines.
  72. */
  73. listTagsForResource(params: OSIS.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: OSIS.Types.ListTagsForResourceResponse) => void): Request<OSIS.Types.ListTagsForResourceResponse, AWSError>;
  74. /**
  75. * Lists all resource tags associated with an OpenSearch Ingestion pipeline. For more information, see Tagging Amazon OpenSearch Ingestion pipelines.
  76. */
  77. listTagsForResource(callback?: (err: AWSError, data: OSIS.Types.ListTagsForResourceResponse) => void): Request<OSIS.Types.ListTagsForResourceResponse, AWSError>;
  78. /**
  79. * Starts an OpenSearch Ingestion pipeline. For more information, see Starting an OpenSearch Ingestion pipeline.
  80. */
  81. startPipeline(params: OSIS.Types.StartPipelineRequest, callback?: (err: AWSError, data: OSIS.Types.StartPipelineResponse) => void): Request<OSIS.Types.StartPipelineResponse, AWSError>;
  82. /**
  83. * Starts an OpenSearch Ingestion pipeline. For more information, see Starting an OpenSearch Ingestion pipeline.
  84. */
  85. startPipeline(callback?: (err: AWSError, data: OSIS.Types.StartPipelineResponse) => void): Request<OSIS.Types.StartPipelineResponse, AWSError>;
  86. /**
  87. * Stops an OpenSearch Ingestion pipeline. For more information, see Stopping an OpenSearch Ingestion pipeline.
  88. */
  89. stopPipeline(params: OSIS.Types.StopPipelineRequest, callback?: (err: AWSError, data: OSIS.Types.StopPipelineResponse) => void): Request<OSIS.Types.StopPipelineResponse, AWSError>;
  90. /**
  91. * Stops an OpenSearch Ingestion pipeline. For more information, see Stopping an OpenSearch Ingestion pipeline.
  92. */
  93. stopPipeline(callback?: (err: AWSError, data: OSIS.Types.StopPipelineResponse) => void): Request<OSIS.Types.StopPipelineResponse, AWSError>;
  94. /**
  95. * Tags an OpenSearch Ingestion pipeline. For more information, see Tagging Amazon OpenSearch Ingestion pipelines.
  96. */
  97. tagResource(params: OSIS.Types.TagResourceRequest, callback?: (err: AWSError, data: OSIS.Types.TagResourceResponse) => void): Request<OSIS.Types.TagResourceResponse, AWSError>;
  98. /**
  99. * Tags an OpenSearch Ingestion pipeline. For more information, see Tagging Amazon OpenSearch Ingestion pipelines.
  100. */
  101. tagResource(callback?: (err: AWSError, data: OSIS.Types.TagResourceResponse) => void): Request<OSIS.Types.TagResourceResponse, AWSError>;
  102. /**
  103. * Removes one or more tags from an OpenSearch Ingestion pipeline. For more information, see Tagging Amazon OpenSearch Ingestion pipelines.
  104. */
  105. untagResource(params: OSIS.Types.UntagResourceRequest, callback?: (err: AWSError, data: OSIS.Types.UntagResourceResponse) => void): Request<OSIS.Types.UntagResourceResponse, AWSError>;
  106. /**
  107. * Removes one or more tags from an OpenSearch Ingestion pipeline. For more information, see Tagging Amazon OpenSearch Ingestion pipelines.
  108. */
  109. untagResource(callback?: (err: AWSError, data: OSIS.Types.UntagResourceResponse) => void): Request<OSIS.Types.UntagResourceResponse, AWSError>;
  110. /**
  111. * Updates an OpenSearch Ingestion pipeline. For more information, see Updating Amazon OpenSearch Ingestion pipelines.
  112. */
  113. updatePipeline(params: OSIS.Types.UpdatePipelineRequest, callback?: (err: AWSError, data: OSIS.Types.UpdatePipelineResponse) => void): Request<OSIS.Types.UpdatePipelineResponse, AWSError>;
  114. /**
  115. * Updates an OpenSearch Ingestion pipeline. For more information, see Updating Amazon OpenSearch Ingestion pipelines.
  116. */
  117. updatePipeline(callback?: (err: AWSError, data: OSIS.Types.UpdatePipelineResponse) => void): Request<OSIS.Types.UpdatePipelineResponse, AWSError>;
  118. /**
  119. * Checks whether an OpenSearch Ingestion pipeline configuration is valid prior to creation. For more information, see Creating Amazon OpenSearch Ingestion pipelines.
  120. */
  121. validatePipeline(params: OSIS.Types.ValidatePipelineRequest, callback?: (err: AWSError, data: OSIS.Types.ValidatePipelineResponse) => void): Request<OSIS.Types.ValidatePipelineResponse, AWSError>;
  122. /**
  123. * Checks whether an OpenSearch Ingestion pipeline configuration is valid prior to creation. For more information, see Creating Amazon OpenSearch Ingestion pipelines.
  124. */
  125. validatePipeline(callback?: (err: AWSError, data: OSIS.Types.ValidatePipelineResponse) => void): Request<OSIS.Types.ValidatePipelineResponse, AWSError>;
  126. }
  127. declare namespace OSIS {
  128. export type Boolean = boolean;
  129. export interface BufferOptions {
  130. /**
  131. * Whether persistent buffering should be enabled.
  132. */
  133. PersistentBufferEnabled: Boolean;
  134. }
  135. export interface ChangeProgressStage {
  136. /**
  137. * The name of the stage.
  138. */
  139. Name?: String;
  140. /**
  141. * The current status of the stage that the change is in.
  142. */
  143. Status?: ChangeProgressStageStatuses;
  144. /**
  145. * A description of the stage.
  146. */
  147. Description?: String;
  148. /**
  149. * The most recent updated timestamp of the stage.
  150. */
  151. LastUpdatedAt?: Timestamp;
  152. }
  153. export type ChangeProgressStageList = ChangeProgressStage[];
  154. export type ChangeProgressStageStatuses = "PENDING"|"IN_PROGRESS"|"COMPLETED"|"FAILED"|string;
  155. export interface ChangeProgressStatus {
  156. /**
  157. * The time at which the configuration change is made on the pipeline.
  158. */
  159. StartTime?: Timestamp;
  160. /**
  161. * The overall status of the pipeline configuration change.
  162. */
  163. Status?: ChangeProgressStatuses;
  164. /**
  165. * The total number of stages required for the pipeline configuration change.
  166. */
  167. TotalNumberOfStages?: Integer;
  168. /**
  169. * Information about the stages that the pipeline is going through to perform the configuration change.
  170. */
  171. ChangeProgressStages?: ChangeProgressStageList;
  172. }
  173. export type ChangeProgressStatusList = ChangeProgressStatus[];
  174. export type ChangeProgressStatuses = "PENDING"|"IN_PROGRESS"|"COMPLETED"|"FAILED"|string;
  175. export interface CloudWatchLogDestination {
  176. /**
  177. * The name of the CloudWatch Logs group to send pipeline logs to. You can specify an existing log group or create a new one. For example, /aws/OpenSearchService/IngestionService/my-pipeline.
  178. */
  179. LogGroup: LogGroup;
  180. }
  181. export interface CreatePipelineRequest {
  182. /**
  183. * The name of the OpenSearch Ingestion pipeline to create. Pipeline names are unique across the pipelines owned by an account within an Amazon Web Services Region.
  184. */
  185. PipelineName: PipelineName;
  186. /**
  187. * The minimum pipeline capacity, in Ingestion Compute Units (ICUs).
  188. */
  189. MinUnits: PipelineUnits;
  190. /**
  191. * The maximum pipeline capacity, in Ingestion Compute Units (ICUs).
  192. */
  193. MaxUnits: PipelineUnits;
  194. /**
  195. * The pipeline configuration in YAML format. The command accepts the pipeline configuration as a string or within a .yaml file. If you provide the configuration as a string, each new line must be escaped with \n.
  196. */
  197. PipelineConfigurationBody: PipelineConfigurationBody;
  198. /**
  199. * Key-value pairs to configure log publishing.
  200. */
  201. LogPublishingOptions?: LogPublishingOptions;
  202. /**
  203. * Container for the values required to configure VPC access for the pipeline. If you don't specify these values, OpenSearch Ingestion creates the pipeline with a public endpoint.
  204. */
  205. VpcOptions?: VpcOptions;
  206. /**
  207. * Key-value pairs to configure persistent buffering for the pipeline.
  208. */
  209. BufferOptions?: BufferOptions;
  210. /**
  211. * Key-value pairs to configure encryption for data that is written to a persistent buffer.
  212. */
  213. EncryptionAtRestOptions?: EncryptionAtRestOptions;
  214. /**
  215. * List of tags to add to the pipeline upon creation.
  216. */
  217. Tags?: TagList;
  218. }
  219. export interface CreatePipelineResponse {
  220. /**
  221. * Container for information about the created pipeline.
  222. */
  223. Pipeline?: Pipeline;
  224. }
  225. export interface DeletePipelineRequest {
  226. /**
  227. * The name of the pipeline to delete.
  228. */
  229. PipelineName: PipelineName;
  230. }
  231. export interface DeletePipelineResponse {
  232. }
  233. export interface EncryptionAtRestOptions {
  234. /**
  235. * The ARN of the KMS key used to encrypt data-at-rest in OpenSearch Ingestion. By default, data is encrypted using an AWS owned key.
  236. */
  237. KmsKeyArn: KmsKeyArn;
  238. }
  239. export interface GetPipelineBlueprintRequest {
  240. /**
  241. * The name of the blueprint to retrieve.
  242. */
  243. BlueprintName: String;
  244. }
  245. export interface GetPipelineBlueprintResponse {
  246. /**
  247. * The requested blueprint in YAML format.
  248. */
  249. Blueprint?: PipelineBlueprint;
  250. }
  251. export interface GetPipelineChangeProgressRequest {
  252. /**
  253. * The name of the pipeline.
  254. */
  255. PipelineName: PipelineName;
  256. }
  257. export interface GetPipelineChangeProgressResponse {
  258. /**
  259. * The current status of the change happening on the pipeline.
  260. */
  261. ChangeProgressStatuses?: ChangeProgressStatusList;
  262. }
  263. export interface GetPipelineRequest {
  264. /**
  265. * The name of the pipeline to get information about.
  266. */
  267. PipelineName: PipelineName;
  268. }
  269. export interface GetPipelineResponse {
  270. /**
  271. * Detailed information about the requested pipeline.
  272. */
  273. Pipeline?: Pipeline;
  274. }
  275. export type IngestEndpointUrlsList = String[];
  276. export type Integer = number;
  277. export type KmsKeyArn = string;
  278. export interface ListPipelineBlueprintsRequest {
  279. }
  280. export interface ListPipelineBlueprintsResponse {
  281. /**
  282. * A list of available blueprints for Data Prepper.
  283. */
  284. Blueprints?: PipelineBlueprintsSummaryList;
  285. }
  286. export interface ListPipelinesRequest {
  287. /**
  288. * An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.
  289. */
  290. MaxResults?: MaxResults;
  291. /**
  292. * If your initial ListPipelines operation returns a nextToken, you can include the returned nextToken in subsequent ListPipelines operations, which returns results in the next page.
  293. */
  294. NextToken?: NextToken;
  295. }
  296. export interface ListPipelinesResponse {
  297. /**
  298. * When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
  299. */
  300. NextToken?: NextToken;
  301. /**
  302. * A list of all existing Data Prepper pipelines.
  303. */
  304. Pipelines?: PipelineSummaryList;
  305. }
  306. export interface ListTagsForResourceRequest {
  307. /**
  308. * The Amazon Resource Name (ARN) of the pipeline to retrieve tags for.
  309. */
  310. Arn: PipelineArn;
  311. }
  312. export interface ListTagsForResourceResponse {
  313. /**
  314. * A list of tags associated with the given pipeline.
  315. */
  316. Tags?: TagList;
  317. }
  318. export type LogGroup = string;
  319. export interface LogPublishingOptions {
  320. /**
  321. * Whether logs should be published.
  322. */
  323. IsLoggingEnabled?: Boolean;
  324. /**
  325. * The destination for OpenSearch Ingestion logs sent to Amazon CloudWatch Logs. This parameter is required if IsLoggingEnabled is set to true.
  326. */
  327. CloudWatchLogDestination?: CloudWatchLogDestination;
  328. }
  329. export type MaxResults = number;
  330. export type NextToken = string;
  331. export interface Pipeline {
  332. /**
  333. * The name of the pipeline.
  334. */
  335. PipelineName?: String;
  336. /**
  337. * The Amazon Resource Name (ARN) of the pipeline.
  338. */
  339. PipelineArn?: String;
  340. /**
  341. * The minimum pipeline capacity, in Ingestion Compute Units (ICUs).
  342. */
  343. MinUnits?: Integer;
  344. /**
  345. * The maximum pipeline capacity, in Ingestion Compute Units (ICUs).
  346. */
  347. MaxUnits?: Integer;
  348. /**
  349. * The current status of the pipeline.
  350. */
  351. Status?: PipelineStatus;
  352. /**
  353. * The reason for the current status of the pipeline.
  354. */
  355. StatusReason?: PipelineStatusReason;
  356. /**
  357. * The Data Prepper pipeline configuration in YAML format.
  358. */
  359. PipelineConfigurationBody?: String;
  360. /**
  361. * The date and time when the pipeline was created.
  362. */
  363. CreatedAt?: Timestamp;
  364. /**
  365. * The date and time when the pipeline was last updated.
  366. */
  367. LastUpdatedAt?: Timestamp;
  368. /**
  369. * The ingestion endpoints for the pipeline, which you can send data to.
  370. */
  371. IngestEndpointUrls?: IngestEndpointUrlsList;
  372. /**
  373. * Key-value pairs that represent log publishing settings.
  374. */
  375. LogPublishingOptions?: LogPublishingOptions;
  376. /**
  377. * The VPC interface endpoints that have access to the pipeline.
  378. */
  379. VpcEndpoints?: VpcEndpointsList;
  380. BufferOptions?: BufferOptions;
  381. EncryptionAtRestOptions?: EncryptionAtRestOptions;
  382. /**
  383. * A list of VPC endpoints that OpenSearch Ingestion has created to other AWS services.
  384. */
  385. ServiceVpcEndpoints?: ServiceVpcEndpointsList;
  386. /**
  387. * A list of tags associated with the given pipeline.
  388. */
  389. Tags?: TagList;
  390. }
  391. export type PipelineArn = string;
  392. export interface PipelineBlueprint {
  393. /**
  394. * The name of the blueprint.
  395. */
  396. BlueprintName?: String;
  397. /**
  398. * The YAML configuration of the blueprint.
  399. */
  400. PipelineConfigurationBody?: String;
  401. }
  402. export interface PipelineBlueprintSummary {
  403. /**
  404. * The name of the blueprint.
  405. */
  406. BlueprintName?: String;
  407. }
  408. export type PipelineBlueprintsSummaryList = PipelineBlueprintSummary[];
  409. export type PipelineConfigurationBody = string;
  410. export type PipelineName = string;
  411. export type PipelineStatus = "CREATING"|"ACTIVE"|"UPDATING"|"DELETING"|"CREATE_FAILED"|"UPDATE_FAILED"|"STARTING"|"START_FAILED"|"STOPPING"|"STOPPED"|string;
  412. export interface PipelineStatusReason {
  413. /**
  414. * A description of why a pipeline has a certain status.
  415. */
  416. Description?: String;
  417. }
  418. export interface PipelineSummary {
  419. /**
  420. * The current status of the pipeline.
  421. */
  422. Status?: PipelineStatus;
  423. StatusReason?: PipelineStatusReason;
  424. /**
  425. * The name of the pipeline.
  426. */
  427. PipelineName?: PipelineName;
  428. /**
  429. * The Amazon Resource Name (ARN) of the pipeline.
  430. */
  431. PipelineArn?: PipelineArn;
  432. /**
  433. * The minimum pipeline capacity, in Ingestion Compute Units (ICUs).
  434. */
  435. MinUnits?: PipelineUnits;
  436. /**
  437. * The maximum pipeline capacity, in Ingestion Compute Units (ICUs).
  438. */
  439. MaxUnits?: PipelineUnits;
  440. /**
  441. * The date and time when the pipeline was created.
  442. */
  443. CreatedAt?: Timestamp;
  444. /**
  445. * The date and time when the pipeline was last updated.
  446. */
  447. LastUpdatedAt?: Timestamp;
  448. /**
  449. * A list of tags associated with the given pipeline.
  450. */
  451. Tags?: TagList;
  452. }
  453. export type PipelineSummaryList = PipelineSummary[];
  454. export type PipelineUnits = number;
  455. export type SecurityGroupId = string;
  456. export type SecurityGroupIds = SecurityGroupId[];
  457. export interface ServiceVpcEndpoint {
  458. /**
  459. * The name of the service for which a VPC endpoint was created.
  460. */
  461. ServiceName?: VpcEndpointServiceName;
  462. /**
  463. * The ID of the VPC endpoint that was created.
  464. */
  465. VpcEndpointId?: String;
  466. }
  467. export type ServiceVpcEndpointsList = ServiceVpcEndpoint[];
  468. export interface StartPipelineRequest {
  469. /**
  470. * The name of the pipeline to start.
  471. */
  472. PipelineName: PipelineName;
  473. }
  474. export interface StartPipelineResponse {
  475. Pipeline?: Pipeline;
  476. }
  477. export interface StopPipelineRequest {
  478. /**
  479. * The name of the pipeline to stop.
  480. */
  481. PipelineName: PipelineName;
  482. }
  483. export interface StopPipelineResponse {
  484. Pipeline?: Pipeline;
  485. }
  486. export type String = string;
  487. export type StringList = String[];
  488. export type SubnetId = string;
  489. export type SubnetIds = SubnetId[];
  490. export interface Tag {
  491. /**
  492. * The tag key. Tag keys must be unique for the pipeline to which they are attached.
  493. */
  494. Key: TagKey;
  495. /**
  496. * 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
  497. */
  498. Value: TagValue;
  499. }
  500. export type TagKey = string;
  501. export type TagList = Tag[];
  502. export interface TagResourceRequest {
  503. /**
  504. * The Amazon Resource Name (ARN) of the pipeline to tag.
  505. */
  506. Arn: PipelineArn;
  507. /**
  508. * The list of key-value tags to add to the pipeline.
  509. */
  510. Tags: TagList;
  511. }
  512. export interface TagResourceResponse {
  513. }
  514. export type TagValue = string;
  515. export type Timestamp = Date;
  516. export interface UntagResourceRequest {
  517. /**
  518. * The Amazon Resource Name (ARN) of the pipeline to remove tags from.
  519. */
  520. Arn: PipelineArn;
  521. /**
  522. * The tag keys to remove.
  523. */
  524. TagKeys: StringList;
  525. }
  526. export interface UntagResourceResponse {
  527. }
  528. export interface UpdatePipelineRequest {
  529. /**
  530. * The name of the pipeline to update.
  531. */
  532. PipelineName: PipelineName;
  533. /**
  534. * The minimum pipeline capacity, in Ingestion Compute Units (ICUs).
  535. */
  536. MinUnits?: PipelineUnits;
  537. /**
  538. * The maximum pipeline capacity, in Ingestion Compute Units (ICUs)
  539. */
  540. MaxUnits?: PipelineUnits;
  541. /**
  542. * The pipeline configuration in YAML format. The command accepts the pipeline configuration as a string or within a .yaml file. If you provide the configuration as a string, each new line must be escaped with \n.
  543. */
  544. PipelineConfigurationBody?: PipelineConfigurationBody;
  545. /**
  546. * Key-value pairs to configure log publishing.
  547. */
  548. LogPublishingOptions?: LogPublishingOptions;
  549. /**
  550. * Key-value pairs to configure persistent buffering for the pipeline.
  551. */
  552. BufferOptions?: BufferOptions;
  553. /**
  554. * Key-value pairs to configure encryption for data that is written to a persistent buffer.
  555. */
  556. EncryptionAtRestOptions?: EncryptionAtRestOptions;
  557. }
  558. export interface UpdatePipelineResponse {
  559. /**
  560. * Container for information about the updated pipeline.
  561. */
  562. Pipeline?: Pipeline;
  563. }
  564. export interface ValidatePipelineRequest {
  565. /**
  566. * The pipeline configuration in YAML format. The command accepts the pipeline configuration as a string or within a .yaml file. If you provide the configuration as a string, each new line must be escaped with \n.
  567. */
  568. PipelineConfigurationBody: PipelineConfigurationBody;
  569. }
  570. export interface ValidatePipelineResponse {
  571. /**
  572. * A boolean indicating whether or not the pipeline configuration is valid.
  573. */
  574. isValid?: Boolean;
  575. /**
  576. * A list of errors if the configuration is invalid.
  577. */
  578. Errors?: ValidationMessageList;
  579. }
  580. export interface ValidationMessage {
  581. /**
  582. * The validation message.
  583. */
  584. Message?: String;
  585. }
  586. export type ValidationMessageList = ValidationMessage[];
  587. export interface VpcEndpoint {
  588. /**
  589. * The unique identifier of the endpoint.
  590. */
  591. VpcEndpointId?: String;
  592. /**
  593. * The ID for your VPC. Amazon Web Services PrivateLink generates this value when you create a VPC.
  594. */
  595. VpcId?: String;
  596. /**
  597. * Information about the VPC, including associated subnets and security groups.
  598. */
  599. VpcOptions?: VpcOptions;
  600. }
  601. export type VpcEndpointServiceName = "OPENSEARCH_SERVERLESS"|string;
  602. export type VpcEndpointsList = VpcEndpoint[];
  603. export interface VpcOptions {
  604. /**
  605. * A list of subnet IDs associated with the VPC endpoint.
  606. */
  607. SubnetIds: SubnetIds;
  608. /**
  609. * A list of security groups associated with the VPC endpoint.
  610. */
  611. SecurityGroupIds?: SecurityGroupIds;
  612. }
  613. /**
  614. * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
  615. */
  616. export type apiVersion = "2022-01-01"|"latest"|string;
  617. export interface ClientApiVersions {
  618. /**
  619. * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
  620. */
  621. apiVersion?: apiVersion;
  622. }
  623. export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
  624. /**
  625. * Contains interfaces for use with the OSIS client.
  626. */
  627. export import Types = OSIS;
  628. }
  629. export = OSIS;