/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
/*
* Do not modify this file. This file is generated from the osis-2022-01-01.normal.json service model.
*/
using System;
using System.Threading;
using System.Threading.Tasks;
using System.Collections.Generic;
using Amazon.Runtime;
using Amazon.OSIS.Model;
namespace Amazon.OSIS
{
///
/// Interface for accessing OSIS
///
/// Use the Amazon OpenSearch Ingestion API to create and manage ingestion pipelines.
/// OpenSearch Ingestion is a fully managed data collector that delivers real-time log
/// and trace data to OpenSearch Service domains. For more information, see Getting
/// data into your cluster using OpenSearch Ingestion.
///
public partial interface IAmazonOSIS : IAmazonService, IDisposable
{
///
/// Paginators for the service
///
IOSISPaginatorFactory Paginators { get; }
#region CreatePipeline
///
/// Creates an OpenSearch Ingestion pipeline. For more information, see Creating
/// Amazon OpenSearch Ingestion pipelines.
///
/// Container for the necessary parameters to execute the CreatePipeline service method.
///
/// The response from the CreatePipeline service method, as returned by OSIS.
///
/// You don't have permissions to access the resource.
///
///
/// The request failed because of an unknown error, exception, or failure (the failure
/// is internal to the service).
///
///
/// You attempted to create more than the allowed number of tags.
///
///
/// You attempted to create a resource that already exists.
///
///
/// An exception for missing or invalid input fields.
///
/// REST API Reference for CreatePipeline Operation
CreatePipelineResponse CreatePipeline(CreatePipelineRequest request);
///
/// Creates an OpenSearch Ingestion pipeline. For more information, see Creating
/// Amazon OpenSearch Ingestion pipelines.
///
/// Container for the necessary parameters to execute the CreatePipeline service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the CreatePipeline service method, as returned by OSIS.
///
/// You don't have permissions to access the resource.
///
///
/// The request failed because of an unknown error, exception, or failure (the failure
/// is internal to the service).
///
///
/// You attempted to create more than the allowed number of tags.
///
///
/// You attempted to create a resource that already exists.
///
///
/// An exception for missing or invalid input fields.
///
/// REST API Reference for CreatePipeline Operation
Task CreatePipelineAsync(CreatePipelineRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DeletePipeline
///
/// Deletes an OpenSearch Ingestion pipeline. For more information, see Deleting
/// Amazon OpenSearch Ingestion pipelines.
///
/// Container for the necessary parameters to execute the DeletePipeline service method.
///
/// The response from the DeletePipeline service method, as returned by OSIS.
///
/// You don't have permissions to access the resource.
///
///
/// The client attempted to remove a resource that is currently in use.
///
///
/// The request failed because of an unknown error, exception, or failure (the failure
/// is internal to the service).
///
///
/// You attempted to access or delete a resource that does not exist.
///
///
/// An exception for missing or invalid input fields.
///
/// REST API Reference for DeletePipeline Operation
DeletePipelineResponse DeletePipeline(DeletePipelineRequest request);
///
/// Deletes an OpenSearch Ingestion pipeline. For more information, see Deleting
/// Amazon OpenSearch Ingestion pipelines.
///
/// Container for the necessary parameters to execute the DeletePipeline service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DeletePipeline service method, as returned by OSIS.
///
/// You don't have permissions to access the resource.
///
///
/// The client attempted to remove a resource that is currently in use.
///
///
/// The request failed because of an unknown error, exception, or failure (the failure
/// is internal to the service).
///
///
/// You attempted to access or delete a resource that does not exist.
///
///
/// An exception for missing or invalid input fields.
///
/// REST API Reference for DeletePipeline Operation
Task DeletePipelineAsync(DeletePipelineRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region GetPipeline
///
/// Retrieves information about an OpenSearch Ingestion pipeline.
///
/// Container for the necessary parameters to execute the GetPipeline service method.
///
/// The response from the GetPipeline service method, as returned by OSIS.
///
/// You don't have permissions to access the resource.
///
///
/// The request failed because of an unknown error, exception, or failure (the failure
/// is internal to the service).
///
///
/// You attempted to access or delete a resource that does not exist.
///
///
/// An exception for missing or invalid input fields.
///
/// REST API Reference for GetPipeline Operation
GetPipelineResponse GetPipeline(GetPipelineRequest request);
///
/// Retrieves information about an OpenSearch Ingestion pipeline.
///
/// Container for the necessary parameters to execute the GetPipeline service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the GetPipeline service method, as returned by OSIS.
///
/// You don't have permissions to access the resource.
///
///
/// The request failed because of an unknown error, exception, or failure (the failure
/// is internal to the service).
///
///
/// You attempted to access or delete a resource that does not exist.
///
///
/// An exception for missing or invalid input fields.
///
/// REST API Reference for GetPipeline Operation
Task GetPipelineAsync(GetPipelineRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region GetPipelineBlueprint
///
/// 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.
///
/// Container for the necessary parameters to execute the GetPipelineBlueprint service method.
///
/// The response from the GetPipelineBlueprint service method, as returned by OSIS.
///
/// You don't have permissions to access the resource.
///
///
/// The request failed because of an unknown error, exception, or failure (the failure
/// is internal to the service).
///
///
/// You attempted to access or delete a resource that does not exist.
///
///
/// An exception for missing or invalid input fields.
///
/// REST API Reference for GetPipelineBlueprint Operation
GetPipelineBlueprintResponse GetPipelineBlueprint(GetPipelineBlueprintRequest request);
///
/// 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.
///
/// Container for the necessary parameters to execute the GetPipelineBlueprint service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the GetPipelineBlueprint service method, as returned by OSIS.
///
/// You don't have permissions to access the resource.
///
///
/// The request failed because of an unknown error, exception, or failure (the failure
/// is internal to the service).
///
///
/// You attempted to access or delete a resource that does not exist.
///
///
/// An exception for missing or invalid input fields.
///
/// REST API Reference for GetPipelineBlueprint Operation
Task GetPipelineBlueprintAsync(GetPipelineBlueprintRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region GetPipelineChangeProgress
///
/// 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.
///
///
/// Container for the necessary parameters to execute the GetPipelineChangeProgress service method.
///
/// The response from the GetPipelineChangeProgress service method, as returned by OSIS.
///
/// You don't have permissions to access the resource.
///
///
/// The request failed because of an unknown error, exception, or failure (the failure
/// is internal to the service).
///
///
/// You attempted to access or delete a resource that does not exist.
///
///
/// An exception for missing or invalid input fields.
///
/// REST API Reference for GetPipelineChangeProgress Operation
GetPipelineChangeProgressResponse GetPipelineChangeProgress(GetPipelineChangeProgressRequest request);
///
/// 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.
///
///
/// Container for the necessary parameters to execute the GetPipelineChangeProgress service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the GetPipelineChangeProgress service method, as returned by OSIS.
///
/// You don't have permissions to access the resource.
///
///
/// The request failed because of an unknown error, exception, or failure (the failure
/// is internal to the service).
///
///
/// You attempted to access or delete a resource that does not exist.
///
///
/// An exception for missing or invalid input fields.
///
/// REST API Reference for GetPipelineChangeProgress Operation
Task GetPipelineChangeProgressAsync(GetPipelineChangeProgressRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ListPipelineBlueprints
///
/// Retrieves a list of all available blueprints for Data Prepper. For more information,
/// see Using
/// blueprints to create a pipeline.
///
/// Container for the necessary parameters to execute the ListPipelineBlueprints service method.
///
/// The response from the ListPipelineBlueprints service method, as returned by OSIS.
///
/// You don't have permissions to access the resource.
///
///
/// The request failed because of an unknown error, exception, or failure (the failure
/// is internal to the service).
///
///
/// An invalid pagination token provided in the request.
///
///
/// An exception for missing or invalid input fields.
///
/// REST API Reference for ListPipelineBlueprints Operation
ListPipelineBlueprintsResponse ListPipelineBlueprints(ListPipelineBlueprintsRequest request);
///
/// Retrieves a list of all available blueprints for Data Prepper. For more information,
/// see Using
/// blueprints to create a pipeline.
///
/// Container for the necessary parameters to execute the ListPipelineBlueprints service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListPipelineBlueprints service method, as returned by OSIS.
///
/// You don't have permissions to access the resource.
///
///
/// The request failed because of an unknown error, exception, or failure (the failure
/// is internal to the service).
///
///
/// An invalid pagination token provided in the request.
///
///
/// An exception for missing or invalid input fields.
///
/// REST API Reference for ListPipelineBlueprints Operation
Task ListPipelineBlueprintsAsync(ListPipelineBlueprintsRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ListPipelines
///
/// Lists all OpenSearch Ingestion pipelines in the current Amazon Web Services account
/// and Region. For more information, see Viewing
/// Amazon OpenSearch Ingestion pipelines.
///
/// Container for the necessary parameters to execute the ListPipelines service method.
///
/// The response from the ListPipelines service method, as returned by OSIS.
///
/// You don't have permissions to access the resource.
///
///
/// The request failed because of an unknown error, exception, or failure (the failure
/// is internal to the service).
///
///
/// An invalid pagination token provided in the request.
///
///
/// An exception for missing or invalid input fields.
///
/// REST API Reference for ListPipelines Operation
ListPipelinesResponse ListPipelines(ListPipelinesRequest request);
///
/// Lists all OpenSearch Ingestion pipelines in the current Amazon Web Services account
/// and Region. For more information, see Viewing
/// Amazon OpenSearch Ingestion pipelines.
///
/// Container for the necessary parameters to execute the ListPipelines service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListPipelines service method, as returned by OSIS.
///
/// You don't have permissions to access the resource.
///
///
/// The request failed because of an unknown error, exception, or failure (the failure
/// is internal to the service).
///
///
/// An invalid pagination token provided in the request.
///
///
/// An exception for missing or invalid input fields.
///
/// REST API Reference for ListPipelines Operation
Task ListPipelinesAsync(ListPipelinesRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ListTagsForResource
///
/// Lists all resource tags associated with an OpenSearch Ingestion pipeline. For more
/// information, see Tagging
/// Amazon OpenSearch Ingestion pipelines.
///
/// Container for the necessary parameters to execute the ListTagsForResource service method.
///
/// The response from the ListTagsForResource service method, as returned by OSIS.
///
/// You don't have permissions to access the resource.
///
///
/// The request failed because of an unknown error, exception, or failure (the failure
/// is internal to the service).
///
///
/// You attempted to access or delete a resource that does not exist.
///
///
/// An exception for missing or invalid input fields.
///
/// REST API Reference for ListTagsForResource Operation
ListTagsForResourceResponse ListTagsForResource(ListTagsForResourceRequest request);
///
/// Lists all resource tags associated with an OpenSearch Ingestion pipeline. For more
/// information, see Tagging
/// Amazon OpenSearch Ingestion pipelines.
///
/// Container for the necessary parameters to execute the ListTagsForResource service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListTagsForResource service method, as returned by OSIS.
///
/// You don't have permissions to access the resource.
///
///
/// The request failed because of an unknown error, exception, or failure (the failure
/// is internal to the service).
///
///
/// You attempted to access or delete a resource that does not exist.
///
///
/// An exception for missing or invalid input fields.
///
/// REST API Reference for ListTagsForResource Operation
Task ListTagsForResourceAsync(ListTagsForResourceRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region StartPipeline
///
/// Starts an OpenSearch Ingestion pipeline. For more information, see Starting
/// an OpenSearch Ingestion pipeline.
///
/// Container for the necessary parameters to execute the StartPipeline service method.
///
/// The response from the StartPipeline service method, as returned by OSIS.
///
/// You don't have permissions to access the resource.
///
///
/// The client attempted to remove a resource that is currently in use.
///
///
/// The request failed because of an unknown error, exception, or failure (the failure
/// is internal to the service).
///
///
/// You attempted to access or delete a resource that does not exist.
///
///
/// An exception for missing or invalid input fields.
///
/// REST API Reference for StartPipeline Operation
StartPipelineResponse StartPipeline(StartPipelineRequest request);
///
/// Starts an OpenSearch Ingestion pipeline. For more information, see Starting
/// an OpenSearch Ingestion pipeline.
///
/// Container for the necessary parameters to execute the StartPipeline service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the StartPipeline service method, as returned by OSIS.
///
/// You don't have permissions to access the resource.
///
///
/// The client attempted to remove a resource that is currently in use.
///
///
/// The request failed because of an unknown error, exception, or failure (the failure
/// is internal to the service).
///
///
/// You attempted to access or delete a resource that does not exist.
///
///
/// An exception for missing or invalid input fields.
///
/// REST API Reference for StartPipeline Operation
Task StartPipelineAsync(StartPipelineRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region StopPipeline
///
/// Stops an OpenSearch Ingestion pipeline. For more information, see Stopping
/// an OpenSearch Ingestion pipeline.
///
/// Container for the necessary parameters to execute the StopPipeline service method.
///
/// The response from the StopPipeline service method, as returned by OSIS.
///
/// You don't have permissions to access the resource.
///
///
/// The client attempted to remove a resource that is currently in use.
///
///
/// The request failed because of an unknown error, exception, or failure (the failure
/// is internal to the service).
///
///
/// You attempted to access or delete a resource that does not exist.
///
///
/// An exception for missing or invalid input fields.
///
/// REST API Reference for StopPipeline Operation
StopPipelineResponse StopPipeline(StopPipelineRequest request);
///
/// Stops an OpenSearch Ingestion pipeline. For more information, see Stopping
/// an OpenSearch Ingestion pipeline.
///
/// Container for the necessary parameters to execute the StopPipeline service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the StopPipeline service method, as returned by OSIS.
///
/// You don't have permissions to access the resource.
///
///
/// The client attempted to remove a resource that is currently in use.
///
///
/// The request failed because of an unknown error, exception, or failure (the failure
/// is internal to the service).
///
///
/// You attempted to access or delete a resource that does not exist.
///
///
/// An exception for missing or invalid input fields.
///
/// REST API Reference for StopPipeline Operation
Task StopPipelineAsync(StopPipelineRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region TagResource
///
/// Tags an OpenSearch Ingestion pipeline. For more information, see Tagging
/// Amazon OpenSearch Ingestion pipelines.
///
/// Container for the necessary parameters to execute the TagResource service method.
///
/// The response from the TagResource service method, as returned by OSIS.
///
/// You don't have permissions to access the resource.
///
///
/// The request failed because of an unknown error, exception, or failure (the failure
/// is internal to the service).
///
///
/// You attempted to create more than the allowed number of tags.
///
///
/// You attempted to access or delete a resource that does not exist.
///
///
/// An exception for missing or invalid input fields.
///
/// REST API Reference for TagResource Operation
TagResourceResponse TagResource(TagResourceRequest request);
///
/// Tags an OpenSearch Ingestion pipeline. For more information, see Tagging
/// Amazon OpenSearch Ingestion pipelines.
///
/// Container for the necessary parameters to execute the TagResource service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the TagResource service method, as returned by OSIS.
///
/// You don't have permissions to access the resource.
///
///
/// The request failed because of an unknown error, exception, or failure (the failure
/// is internal to the service).
///
///
/// You attempted to create more than the allowed number of tags.
///
///
/// You attempted to access or delete a resource that does not exist.
///
///
/// An exception for missing or invalid input fields.
///
/// REST API Reference for TagResource Operation
Task TagResourceAsync(TagResourceRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region UntagResource
///
/// Removes one or more tags from an OpenSearch Ingestion pipeline. For more information,
/// see Tagging
/// Amazon OpenSearch Ingestion pipelines.
///
/// Container for the necessary parameters to execute the UntagResource service method.
///
/// The response from the UntagResource service method, as returned by OSIS.
///
/// You don't have permissions to access the resource.
///
///
/// The request failed because of an unknown error, exception, or failure (the failure
/// is internal to the service).
///
///
/// You attempted to access or delete a resource that does not exist.
///
///
/// An exception for missing or invalid input fields.
///
/// REST API Reference for UntagResource Operation
UntagResourceResponse UntagResource(UntagResourceRequest request);
///
/// Removes one or more tags from an OpenSearch Ingestion pipeline. For more information,
/// see Tagging
/// Amazon OpenSearch Ingestion pipelines.
///
/// Container for the necessary parameters to execute the UntagResource service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the UntagResource service method, as returned by OSIS.
///
/// You don't have permissions to access the resource.
///
///
/// The request failed because of an unknown error, exception, or failure (the failure
/// is internal to the service).
///
///
/// You attempted to access or delete a resource that does not exist.
///
///
/// An exception for missing or invalid input fields.
///
/// REST API Reference for UntagResource Operation
Task UntagResourceAsync(UntagResourceRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region UpdatePipeline
///
/// Updates an OpenSearch Ingestion pipeline. For more information, see Updating
/// Amazon OpenSearch Ingestion pipelines.
///
/// Container for the necessary parameters to execute the UpdatePipeline service method.
///
/// The response from the UpdatePipeline service method, as returned by OSIS.
///
/// You don't have permissions to access the resource.
///
///
/// The client attempted to remove a resource that is currently in use.
///
///
/// The request failed because of an unknown error, exception, or failure (the failure
/// is internal to the service).
///
///
/// You attempted to access or delete a resource that does not exist.
///
///
/// An exception for missing or invalid input fields.
///
/// REST API Reference for UpdatePipeline Operation
UpdatePipelineResponse UpdatePipeline(UpdatePipelineRequest request);
///
/// Updates an OpenSearch Ingestion pipeline. For more information, see Updating
/// Amazon OpenSearch Ingestion pipelines.
///
/// Container for the necessary parameters to execute the UpdatePipeline service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the UpdatePipeline service method, as returned by OSIS.
///
/// You don't have permissions to access the resource.
///
///
/// The client attempted to remove a resource that is currently in use.
///
///
/// The request failed because of an unknown error, exception, or failure (the failure
/// is internal to the service).
///
///
/// You attempted to access or delete a resource that does not exist.
///
///
/// An exception for missing or invalid input fields.
///
/// REST API Reference for UpdatePipeline Operation
Task UpdatePipelineAsync(UpdatePipelineRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ValidatePipeline
///
/// Checks whether an OpenSearch Ingestion pipeline configuration is valid prior to creation.
/// For more information, see Creating
/// Amazon OpenSearch Ingestion pipelines.
///
/// Container for the necessary parameters to execute the ValidatePipeline service method.
///
/// The response from the ValidatePipeline service method, as returned by OSIS.
///
/// You don't have permissions to access the resource.
///
///
/// The request failed because of an unknown error, exception, or failure (the failure
/// is internal to the service).
///
///
/// An exception for missing or invalid input fields.
///
/// REST API Reference for ValidatePipeline Operation
ValidatePipelineResponse ValidatePipeline(ValidatePipelineRequest request);
///
/// Checks whether an OpenSearch Ingestion pipeline configuration is valid prior to creation.
/// For more information, see Creating
/// Amazon OpenSearch Ingestion pipelines.
///
/// Container for the necessary parameters to execute the ValidatePipeline service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ValidatePipeline service method, as returned by OSIS.
///
/// You don't have permissions to access the resource.
///
///
/// The request failed because of an unknown error, exception, or failure (the failure
/// is internal to the service).
///
///
/// An exception for missing or invalid input fields.
///
/// REST API Reference for ValidatePipeline Operation
Task ValidatePipelineAsync(ValidatePipelineRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
}
}