{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://zieapi.vercel.app"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/cloud:amazonaws-osis/create-pipeline":{"post":{"operationId":"cloud_amazonaws_osis_create_pipeline","summary":"Creates an OpenSearch Ingestion pipeline. For more information, see Creating Amazon OpenSearch Ingestion…","description":"POST /2022-01-01/osis/createPipeline","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"region":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-west-1","us-gov-east-1","ca-central-1","eu-north-1","eu-west-1","eu-west-2","eu-west-3","eu-central-1","eu-south-1","af-south-1","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-east-1","ap-south-1","sa-east-1","me-south-1"],"default":"us-east-1","description":"The AWS region"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:amazonaws-osis/delete-pipeline":{"post":{"operationId":"cloud_amazonaws_osis_delete_pipeline","summary":"Deletes an OpenSearch Ingestion pipeline. For more information, see Deleting Amazon OpenSearch Ingestion…","description":"DELETE /2022-01-01/osis/deletePipeline/{PipelineName}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["PipelineName"],"properties":{"region":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-west-1","us-gov-east-1","ca-central-1","eu-north-1","eu-west-1","eu-west-2","eu-west-3","eu-central-1","eu-south-1","af-south-1","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-east-1","ap-south-1","sa-east-1","me-south-1"],"default":"us-east-1","description":"The AWS region"},"PipelineName":{"type":"string","description":"The name of the pipeline to delete."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:amazonaws-osis/get-pipeline":{"get":{"operationId":"cloud_amazonaws_osis_get_pipeline","summary":"Retrieves information about an OpenSearch Ingestion pipeline.","description":"GET /2022-01-01/osis/getPipeline/{PipelineName}","tags":["cloud"],"parameters":[{"name":"region","in":"query","required":false,"description":"The AWS region","schema":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-west-1","us-gov-east-1","ca-central-1","eu-north-1","eu-west-1","eu-west-2","eu-west-3","eu-central-1","eu-south-1","af-south-1","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-east-1","ap-south-1","sa-east-1","me-south-1"],"default":"us-east-1","description":"The AWS region"}},{"name":"PipelineName","in":"query","required":true,"description":"The name of the pipeline to get information about.","schema":{"type":"string","description":"The name of the pipeline to get information about."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:amazonaws-osis/get-pipeline-blueprint":{"get":{"operationId":"cloud_amazonaws_osis_get_pipeline_blueprint","summary":"Retrieves information about a specific blueprint for OpenSearch Ingestion. Blueprints are templates for the…","description":"GET /2022-01-01/osis/getPipelineBlueprint/{BlueprintName}","tags":["cloud"],"parameters":[{"name":"region","in":"query","required":false,"description":"The AWS region","schema":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-west-1","us-gov-east-1","ca-central-1","eu-north-1","eu-west-1","eu-west-2","eu-west-3","eu-central-1","eu-south-1","af-south-1","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-east-1","ap-south-1","sa-east-1","me-south-1"],"default":"us-east-1","description":"The AWS region"}},{"name":"BlueprintName","in":"query","required":true,"description":"The name of the blueprint to retrieve.","schema":{"type":"string","description":"The name of the blueprint to retrieve."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:amazonaws-osis/get-pipeline-change-progress":{"get":{"operationId":"cloud_amazonaws_osis_get_pipeline_change_progress","summary":"Returns progress information for the current change happening on an OpenSearch Ingestion pipeline.…","description":"GET /2022-01-01/osis/getPipelineChangeProgress/{PipelineName}","tags":["cloud"],"parameters":[{"name":"region","in":"query","required":false,"description":"The AWS region","schema":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-west-1","us-gov-east-1","ca-central-1","eu-north-1","eu-west-1","eu-west-2","eu-west-3","eu-central-1","eu-south-1","af-south-1","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-east-1","ap-south-1","sa-east-1","me-south-1"],"default":"us-east-1","description":"The AWS region"}},{"name":"PipelineName","in":"query","required":true,"description":"The name of the pipeline.","schema":{"type":"string","description":"The name of the pipeline."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:amazonaws-osis/list-pipeline-blueprints":{"post":{"operationId":"cloud_amazonaws_osis_list_pipeline_blueprints","summary":"Retrieves a list of all available blueprints for Data Prepper. For more information, see Using blueprints to…","description":"POST /2022-01-01/osis/listPipelineBlueprints","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"region":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-west-1","us-gov-east-1","ca-central-1","eu-north-1","eu-west-1","eu-west-2","eu-west-3","eu-central-1","eu-south-1","af-south-1","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-east-1","ap-south-1","sa-east-1","me-south-1"],"default":"us-east-1","description":"The AWS region"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:amazonaws-osis/list-pipelines":{"get":{"operationId":"cloud_amazonaws_osis_list_pipelines","summary":"Lists all OpenSearch Ingestion pipelines in the current Amazon Web Services account and Region. For more…","description":"GET /2022-01-01/osis/listPipelines","tags":["cloud"],"parameters":[{"name":"region","in":"query","required":false,"description":"The AWS region","schema":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-west-1","us-gov-east-1","ca-central-1","eu-north-1","eu-west-1","eu-west-2","eu-west-3","eu-central-1","eu-south-1","af-south-1","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-east-1","ap-south-1","sa-east-1","me-south-1"],"default":"us-east-1","description":"The AWS region"}},{"name":"maxResults","in":"query","required":false,"description":"An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.","schema":{"type":"integer","description":"An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results."}},{"name":"nextToken","in":"query","required":false,"description":"If your initial ListPipelines operation returns a nextToken , you can include the returned nextToken in subsequent ListPipelines…","schema":{"type":"string","description":"If your initial ListPipelines operation returns a nextToken , you can include the returned nextToken in subsequent ListPipelines…"}},{"name":"MaxResults","in":"query","required":false,"description":"Pagination limit","schema":{"type":"string","description":"Pagination limit"}},{"name":"NextToken","in":"query","required":false,"description":"Pagination token","schema":{"type":"string","description":"Pagination token"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:amazonaws-osis/list-tags-for-resource":{"get":{"operationId":"cloud_amazonaws_osis_list_tags_for_resource","summary":"Lists all resource tags associated with an OpenSearch Ingestion pipeline. For more information, see Tagging…","description":"GET /2022-01-01/osis/listTagsForResource/","tags":["cloud"],"parameters":[{"name":"region","in":"query","required":false,"description":"The AWS region","schema":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-west-1","us-gov-east-1","ca-central-1","eu-north-1","eu-west-1","eu-west-2","eu-west-3","eu-central-1","eu-south-1","af-south-1","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-east-1","ap-south-1","sa-east-1","me-south-1"],"default":"us-east-1","description":"The AWS region"}},{"name":"arn","in":"query","required":true,"description":"The Amazon Resource Name (ARN) of the pipeline to retrieve tags for.","schema":{"type":"string","description":"The Amazon Resource Name (ARN) of the pipeline to retrieve tags for."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:amazonaws-osis/start-pipeline":{"post":{"operationId":"cloud_amazonaws_osis_start_pipeline","summary":"Starts an OpenSearch Ingestion pipeline. For more information, see Starting an OpenSearch Ingestion pipeline .","description":"PUT /2022-01-01/osis/startPipeline/{PipelineName}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["PipelineName"],"properties":{"region":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-west-1","us-gov-east-1","ca-central-1","eu-north-1","eu-west-1","eu-west-2","eu-west-3","eu-central-1","eu-south-1","af-south-1","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-east-1","ap-south-1","sa-east-1","me-south-1"],"default":"us-east-1","description":"The AWS region"},"PipelineName":{"type":"string","description":"The name of the pipeline to start."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:amazonaws-osis/stop-pipeline":{"post":{"operationId":"cloud_amazonaws_osis_stop_pipeline","summary":"Stops an OpenSearch Ingestion pipeline. For more information, see Stopping an OpenSearch Ingestion pipeline .","description":"PUT /2022-01-01/osis/stopPipeline/{PipelineName}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["PipelineName"],"properties":{"region":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-west-1","us-gov-east-1","ca-central-1","eu-north-1","eu-west-1","eu-west-2","eu-west-3","eu-central-1","eu-south-1","af-south-1","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-east-1","ap-south-1","sa-east-1","me-south-1"],"default":"us-east-1","description":"The AWS region"},"PipelineName":{"type":"string","description":"The name of the pipeline to stop."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:amazonaws-osis/tag-resource":{"post":{"operationId":"cloud_amazonaws_osis_tag_resource","summary":"Tags an OpenSearch Ingestion pipeline. For more information, see Tagging Amazon OpenSearch Ingestion…","description":"POST /2022-01-01/osis/tagResource/","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["arn","body"],"properties":{"region":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-west-1","us-gov-east-1","ca-central-1","eu-north-1","eu-west-1","eu-west-2","eu-west-3","eu-central-1","eu-south-1","af-south-1","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-east-1","ap-south-1","sa-east-1","me-south-1"],"default":"us-east-1","description":"The AWS region"},"arn":{"type":"string","description":"The Amazon Resource Name (ARN) of the pipeline to tag."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:amazonaws-osis/untag-resource":{"post":{"operationId":"cloud_amazonaws_osis_untag_resource","summary":"Removes one or more tags from an OpenSearch Ingestion pipeline. For more information, see Tagging Amazon…","description":"POST /2022-01-01/osis/untagResource/","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["arn","body"],"properties":{"region":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-west-1","us-gov-east-1","ca-central-1","eu-north-1","eu-west-1","eu-west-2","eu-west-3","eu-central-1","eu-south-1","af-south-1","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-east-1","ap-south-1","sa-east-1","me-south-1"],"default":"us-east-1","description":"The AWS region"},"arn":{"type":"string","description":"The Amazon Resource Name (ARN) of the pipeline to remove tags from."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:amazonaws-osis/update-pipeline":{"post":{"operationId":"cloud_amazonaws_osis_update_pipeline","summary":"Updates an OpenSearch Ingestion pipeline. For more information, see Updating Amazon OpenSearch Ingestion…","description":"PUT /2022-01-01/osis/updatePipeline/{PipelineName}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["PipelineName","body"],"properties":{"region":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-west-1","us-gov-east-1","ca-central-1","eu-north-1","eu-west-1","eu-west-2","eu-west-3","eu-central-1","eu-south-1","af-south-1","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-east-1","ap-south-1","sa-east-1","me-south-1"],"default":"us-east-1","description":"The AWS region"},"PipelineName":{"type":"string","description":"The name of the pipeline to update."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:amazonaws-osis/validate-pipeline":{"post":{"operationId":"cloud_amazonaws_osis_validate_pipeline","summary":"Checks whether an OpenSearch Ingestion pipeline configuration is valid prior to creation. For more…","description":"POST /2022-01-01/osis/validatePipeline","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"region":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-west-1","us-gov-east-1","ca-central-1","eu-north-1","eu-west-1","eu-west-2","eu-west-3","eu-central-1","eu-south-1","af-south-1","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-east-1","ap-south-1","sa-east-1","me-south-1"],"default":"us-east-1","description":"The AWS region"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}