/*
* 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.Collections.Generic;
using System.Net;
using Amazon.OSIS.Model;
using Amazon.OSIS.Model.Internal.MarshallTransformations;
using Amazon.OSIS.Internal;
using Amazon.Runtime;
using Amazon.Runtime.Internal;
using Amazon.Runtime.Internal.Auth;
using Amazon.Runtime.Internal.Transform;
namespace Amazon.OSIS
{
///
/// Implementation 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 class AmazonOSISClient : AmazonServiceClient, IAmazonOSIS
{
private static IServiceMetadata serviceMetadata = new AmazonOSISMetadata();
#if BCL45 || AWS_ASYNC_ENUMERABLES_API
private IOSISPaginatorFactory _paginators;
///
/// Paginators for the service
///
public IOSISPaginatorFactory Paginators
{
get
{
if (this._paginators == null)
{
this._paginators = new OSISPaginatorFactory(this);
}
return this._paginators;
}
}
#endif
#region Constructors
///
/// Constructs AmazonOSISClient with the credentials loaded from the application's
/// default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance.
///
/// Example App.config with credentials set.
///
/// <?xml version="1.0" encoding="utf-8" ?>
/// <configuration>
/// <appSettings>
/// <add key="AWSProfileName" value="AWS Default"/>
/// </appSettings>
/// </configuration>
///
///
///
public AmazonOSISClient()
: base(FallbackCredentialsFactory.GetCredentials(), new AmazonOSISConfig()) { }
///
/// Constructs AmazonOSISClient with the credentials loaded from the application's
/// default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance.
///
/// Example App.config with credentials set.
///
/// <?xml version="1.0" encoding="utf-8" ?>
/// <configuration>
/// <appSettings>
/// <add key="AWSProfileName" value="AWS Default"/>
/// </appSettings>
/// </configuration>
///
///
///
/// The region to connect.
public AmazonOSISClient(RegionEndpoint region)
: base(FallbackCredentialsFactory.GetCredentials(), new AmazonOSISConfig{RegionEndpoint = region}) { }
///
/// Constructs AmazonOSISClient with the credentials loaded from the application's
/// default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance.
///
/// Example App.config with credentials set.
///
/// <?xml version="1.0" encoding="utf-8" ?>
/// <configuration>
/// <appSettings>
/// <add key="AWSProfileName" value="AWS Default"/>
/// </appSettings>
/// </configuration>
///
///
///
/// The AmazonOSISClient Configuration Object
public AmazonOSISClient(AmazonOSISConfig config)
: base(FallbackCredentialsFactory.GetCredentials(config), config){}
///
/// Constructs AmazonOSISClient with AWS Credentials
///
/// AWS Credentials
public AmazonOSISClient(AWSCredentials credentials)
: this(credentials, new AmazonOSISConfig())
{
}
///
/// Constructs AmazonOSISClient with AWS Credentials
///
/// AWS Credentials
/// The region to connect.
public AmazonOSISClient(AWSCredentials credentials, RegionEndpoint region)
: this(credentials, new AmazonOSISConfig{RegionEndpoint = region})
{
}
///
/// Constructs AmazonOSISClient with AWS Credentials and an
/// AmazonOSISClient Configuration object.
///
/// AWS Credentials
/// The AmazonOSISClient Configuration Object
public AmazonOSISClient(AWSCredentials credentials, AmazonOSISConfig clientConfig)
: base(credentials, clientConfig)
{
}
///
/// Constructs AmazonOSISClient with AWS Access Key ID and AWS Secret Key
///
/// AWS Access Key ID
/// AWS Secret Access Key
public AmazonOSISClient(string awsAccessKeyId, string awsSecretAccessKey)
: this(awsAccessKeyId, awsSecretAccessKey, new AmazonOSISConfig())
{
}
///
/// Constructs AmazonOSISClient with AWS Access Key ID and AWS Secret Key
///
/// AWS Access Key ID
/// AWS Secret Access Key
/// The region to connect.
public AmazonOSISClient(string awsAccessKeyId, string awsSecretAccessKey, RegionEndpoint region)
: this(awsAccessKeyId, awsSecretAccessKey, new AmazonOSISConfig() {RegionEndpoint=region})
{
}
///
/// Constructs AmazonOSISClient with AWS Access Key ID, AWS Secret Key and an
/// AmazonOSISClient Configuration object.
///
/// AWS Access Key ID
/// AWS Secret Access Key
/// The AmazonOSISClient Configuration Object
public AmazonOSISClient(string awsAccessKeyId, string awsSecretAccessKey, AmazonOSISConfig clientConfig)
: base(awsAccessKeyId, awsSecretAccessKey, clientConfig)
{
}
///
/// Constructs AmazonOSISClient with AWS Access Key ID and AWS Secret Key
///
/// AWS Access Key ID
/// AWS Secret Access Key
/// AWS Session Token
public AmazonOSISClient(string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken)
: this(awsAccessKeyId, awsSecretAccessKey, awsSessionToken, new AmazonOSISConfig())
{
}
///
/// Constructs AmazonOSISClient with AWS Access Key ID and AWS Secret Key
///
/// AWS Access Key ID
/// AWS Secret Access Key
/// AWS Session Token
/// The region to connect.
public AmazonOSISClient(string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken, RegionEndpoint region)
: this(awsAccessKeyId, awsSecretAccessKey, awsSessionToken, new AmazonOSISConfig{RegionEndpoint = region})
{
}
///
/// Constructs AmazonOSISClient with AWS Access Key ID, AWS Secret Key and an
/// AmazonOSISClient Configuration object.
///
/// AWS Access Key ID
/// AWS Secret Access Key
/// AWS Session Token
/// The AmazonOSISClient Configuration Object
public AmazonOSISClient(string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken, AmazonOSISConfig clientConfig)
: base(awsAccessKeyId, awsSecretAccessKey, awsSessionToken, clientConfig)
{
}
#endregion
#region Overrides
///
/// Creates the signer for the service.
///
protected override AbstractAWSSigner CreateSigner()
{
return new AWS4Signer();
}
///
/// Customize the pipeline
///
///
protected override void CustomizeRuntimePipeline(RuntimePipeline pipeline)
{
pipeline.RemoveHandler();
pipeline.AddHandlerAfter(new AmazonOSISEndpointResolver());
}
///
/// Capture metadata for the service.
///
protected override IServiceMetadata ServiceMetadata
{
get
{
return serviceMetadata;
}
}
#endregion
#region Dispose
///
/// Disposes the service client.
///
protected override void Dispose(bool disposing)
{
base.Dispose(disposing);
}
#endregion
#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
public virtual CreatePipelineResponse CreatePipeline(CreatePipelineRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = CreatePipelineRequestMarshaller.Instance;
options.ResponseUnmarshaller = CreatePipelineResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Initiates the asynchronous execution of the CreatePipeline operation.
///
///
/// Container for the necessary parameters to execute the CreatePipeline operation on AmazonOSISClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreatePipeline
/// operation.
/// REST API Reference for CreatePipeline Operation
public virtual IAsyncResult BeginCreatePipeline(CreatePipelineRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = CreatePipelineRequestMarshaller.Instance;
options.ResponseUnmarshaller = CreatePipelineResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the CreatePipeline operation.
///
///
/// The IAsyncResult returned by the call to BeginCreatePipeline.
///
/// Returns a CreatePipelineResult from OSIS.
/// REST API Reference for CreatePipeline Operation
public virtual CreatePipelineResponse EndCreatePipeline(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#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
public virtual DeletePipelineResponse DeletePipeline(DeletePipelineRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = DeletePipelineRequestMarshaller.Instance;
options.ResponseUnmarshaller = DeletePipelineResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Initiates the asynchronous execution of the DeletePipeline operation.
///
///
/// Container for the necessary parameters to execute the DeletePipeline operation on AmazonOSISClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeletePipeline
/// operation.
/// REST API Reference for DeletePipeline Operation
public virtual IAsyncResult BeginDeletePipeline(DeletePipelineRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = DeletePipelineRequestMarshaller.Instance;
options.ResponseUnmarshaller = DeletePipelineResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the DeletePipeline operation.
///
///
/// The IAsyncResult returned by the call to BeginDeletePipeline.
///
/// Returns a DeletePipelineResult from OSIS.
/// REST API Reference for DeletePipeline Operation
public virtual DeletePipelineResponse EndDeletePipeline(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#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
public virtual GetPipelineResponse GetPipeline(GetPipelineRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = GetPipelineRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetPipelineResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Initiates the asynchronous execution of the GetPipeline operation.
///
///
/// Container for the necessary parameters to execute the GetPipeline operation on AmazonOSISClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetPipeline
/// operation.
/// REST API Reference for GetPipeline Operation
public virtual IAsyncResult BeginGetPipeline(GetPipelineRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = GetPipelineRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetPipelineResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the GetPipeline operation.
///
///
/// The IAsyncResult returned by the call to BeginGetPipeline.
///
/// Returns a GetPipelineResult from OSIS.
/// REST API Reference for GetPipeline Operation
public virtual GetPipelineResponse EndGetPipeline(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#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
public virtual GetPipelineBlueprintResponse GetPipelineBlueprint(GetPipelineBlueprintRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = GetPipelineBlueprintRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetPipelineBlueprintResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Initiates the asynchronous execution of the GetPipelineBlueprint operation.
///
///
/// Container for the necessary parameters to execute the GetPipelineBlueprint operation on AmazonOSISClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetPipelineBlueprint
/// operation.
/// REST API Reference for GetPipelineBlueprint Operation
public virtual IAsyncResult BeginGetPipelineBlueprint(GetPipelineBlueprintRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = GetPipelineBlueprintRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetPipelineBlueprintResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the GetPipelineBlueprint operation.
///
///
/// The IAsyncResult returned by the call to BeginGetPipelineBlueprint.
///
/// Returns a GetPipelineBlueprintResult from OSIS.
/// REST API Reference for GetPipelineBlueprint Operation
public virtual GetPipelineBlueprintResponse EndGetPipelineBlueprint(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#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
public virtual GetPipelineChangeProgressResponse GetPipelineChangeProgress(GetPipelineChangeProgressRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = GetPipelineChangeProgressRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetPipelineChangeProgressResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Initiates the asynchronous execution of the GetPipelineChangeProgress operation.
///
///
/// Container for the necessary parameters to execute the GetPipelineChangeProgress operation on AmazonOSISClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetPipelineChangeProgress
/// operation.
/// REST API Reference for GetPipelineChangeProgress Operation
public virtual IAsyncResult BeginGetPipelineChangeProgress(GetPipelineChangeProgressRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = GetPipelineChangeProgressRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetPipelineChangeProgressResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the GetPipelineChangeProgress operation.
///
///
/// The IAsyncResult returned by the call to BeginGetPipelineChangeProgress.
///
/// Returns a GetPipelineChangeProgressResult from OSIS.
/// REST API Reference for GetPipelineChangeProgress Operation
public virtual GetPipelineChangeProgressResponse EndGetPipelineChangeProgress(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#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
public virtual ListPipelineBlueprintsResponse ListPipelineBlueprints(ListPipelineBlueprintsRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = ListPipelineBlueprintsRequestMarshaller.Instance;
options.ResponseUnmarshaller = ListPipelineBlueprintsResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Initiates the asynchronous execution of the ListPipelineBlueprints operation.
///
///
/// Container for the necessary parameters to execute the ListPipelineBlueprints operation on AmazonOSISClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListPipelineBlueprints
/// operation.
/// REST API Reference for ListPipelineBlueprints Operation
public virtual IAsyncResult BeginListPipelineBlueprints(ListPipelineBlueprintsRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = ListPipelineBlueprintsRequestMarshaller.Instance;
options.ResponseUnmarshaller = ListPipelineBlueprintsResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the ListPipelineBlueprints operation.
///
///
/// The IAsyncResult returned by the call to BeginListPipelineBlueprints.
///
/// Returns a ListPipelineBlueprintsResult from OSIS.
/// REST API Reference for ListPipelineBlueprints Operation
public virtual ListPipelineBlueprintsResponse EndListPipelineBlueprints(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#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
public virtual ListPipelinesResponse ListPipelines(ListPipelinesRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = ListPipelinesRequestMarshaller.Instance;
options.ResponseUnmarshaller = ListPipelinesResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Initiates the asynchronous execution of the ListPipelines operation.
///
///
/// Container for the necessary parameters to execute the ListPipelines operation on AmazonOSISClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListPipelines
/// operation.
/// REST API Reference for ListPipelines Operation
public virtual IAsyncResult BeginListPipelines(ListPipelinesRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = ListPipelinesRequestMarshaller.Instance;
options.ResponseUnmarshaller = ListPipelinesResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the ListPipelines operation.
///
///
/// The IAsyncResult returned by the call to BeginListPipelines.
///
/// Returns a ListPipelinesResult from OSIS.
/// REST API Reference for ListPipelines Operation
public virtual ListPipelinesResponse EndListPipelines(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#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
public virtual ListTagsForResourceResponse ListTagsForResource(ListTagsForResourceRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = ListTagsForResourceRequestMarshaller.Instance;
options.ResponseUnmarshaller = ListTagsForResourceResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Initiates the asynchronous execution of the ListTagsForResource operation.
///
///
/// Container for the necessary parameters to execute the ListTagsForResource operation on AmazonOSISClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListTagsForResource
/// operation.
/// REST API Reference for ListTagsForResource Operation
public virtual IAsyncResult BeginListTagsForResource(ListTagsForResourceRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = ListTagsForResourceRequestMarshaller.Instance;
options.ResponseUnmarshaller = ListTagsForResourceResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the ListTagsForResource operation.
///
///
/// The IAsyncResult returned by the call to BeginListTagsForResource.
///
/// Returns a ListTagsForResourceResult from OSIS.
/// REST API Reference for ListTagsForResource Operation
public virtual ListTagsForResourceResponse EndListTagsForResource(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#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
public virtual StartPipelineResponse StartPipeline(StartPipelineRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = StartPipelineRequestMarshaller.Instance;
options.ResponseUnmarshaller = StartPipelineResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Initiates the asynchronous execution of the StartPipeline operation.
///
///
/// Container for the necessary parameters to execute the StartPipeline operation on AmazonOSISClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndStartPipeline
/// operation.
/// REST API Reference for StartPipeline Operation
public virtual IAsyncResult BeginStartPipeline(StartPipelineRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = StartPipelineRequestMarshaller.Instance;
options.ResponseUnmarshaller = StartPipelineResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the StartPipeline operation.
///
///
/// The IAsyncResult returned by the call to BeginStartPipeline.
///
/// Returns a StartPipelineResult from OSIS.
/// REST API Reference for StartPipeline Operation
public virtual StartPipelineResponse EndStartPipeline(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#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
public virtual StopPipelineResponse StopPipeline(StopPipelineRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = StopPipelineRequestMarshaller.Instance;
options.ResponseUnmarshaller = StopPipelineResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Initiates the asynchronous execution of the StopPipeline operation.
///
///
/// Container for the necessary parameters to execute the StopPipeline operation on AmazonOSISClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndStopPipeline
/// operation.
/// REST API Reference for StopPipeline Operation
public virtual IAsyncResult BeginStopPipeline(StopPipelineRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = StopPipelineRequestMarshaller.Instance;
options.ResponseUnmarshaller = StopPipelineResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the StopPipeline operation.
///
///
/// The IAsyncResult returned by the call to BeginStopPipeline.
///
/// Returns a StopPipelineResult from OSIS.
/// REST API Reference for StopPipeline Operation
public virtual StopPipelineResponse EndStopPipeline(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#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
public virtual TagResourceResponse TagResource(TagResourceRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = TagResourceRequestMarshaller.Instance;
options.ResponseUnmarshaller = TagResourceResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Initiates the asynchronous execution of the TagResource operation.
///
///
/// Container for the necessary parameters to execute the TagResource operation on AmazonOSISClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndTagResource
/// operation.
/// REST API Reference for TagResource Operation
public virtual IAsyncResult BeginTagResource(TagResourceRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = TagResourceRequestMarshaller.Instance;
options.ResponseUnmarshaller = TagResourceResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the TagResource operation.
///
///
/// The IAsyncResult returned by the call to BeginTagResource.
///
/// Returns a TagResourceResult from OSIS.
/// REST API Reference for TagResource Operation
public virtual TagResourceResponse EndTagResource(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#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
public virtual UntagResourceResponse UntagResource(UntagResourceRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = UntagResourceRequestMarshaller.Instance;
options.ResponseUnmarshaller = UntagResourceResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Initiates the asynchronous execution of the UntagResource operation.
///
///
/// Container for the necessary parameters to execute the UntagResource operation on AmazonOSISClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUntagResource
/// operation.
/// REST API Reference for UntagResource Operation
public virtual IAsyncResult BeginUntagResource(UntagResourceRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = UntagResourceRequestMarshaller.Instance;
options.ResponseUnmarshaller = UntagResourceResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the UntagResource operation.
///
///
/// The IAsyncResult returned by the call to BeginUntagResource.
///
/// Returns a UntagResourceResult from OSIS.
/// REST API Reference for UntagResource Operation
public virtual UntagResourceResponse EndUntagResource(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#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
public virtual UpdatePipelineResponse UpdatePipeline(UpdatePipelineRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = UpdatePipelineRequestMarshaller.Instance;
options.ResponseUnmarshaller = UpdatePipelineResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Initiates the asynchronous execution of the UpdatePipeline operation.
///
///
/// Container for the necessary parameters to execute the UpdatePipeline operation on AmazonOSISClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdatePipeline
/// operation.
/// REST API Reference for UpdatePipeline Operation
public virtual IAsyncResult BeginUpdatePipeline(UpdatePipelineRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = UpdatePipelineRequestMarshaller.Instance;
options.ResponseUnmarshaller = UpdatePipelineResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the UpdatePipeline operation.
///
///
/// The IAsyncResult returned by the call to BeginUpdatePipeline.
///
/// Returns a UpdatePipelineResult from OSIS.
/// REST API Reference for UpdatePipeline Operation
public virtual UpdatePipelineResponse EndUpdatePipeline(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#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
public virtual ValidatePipelineResponse ValidatePipeline(ValidatePipelineRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = ValidatePipelineRequestMarshaller.Instance;
options.ResponseUnmarshaller = ValidatePipelineResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Initiates the asynchronous execution of the ValidatePipeline operation.
///
///
/// Container for the necessary parameters to execute the ValidatePipeline operation on AmazonOSISClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndValidatePipeline
/// operation.
/// REST API Reference for ValidatePipeline Operation
public virtual IAsyncResult BeginValidatePipeline(ValidatePipelineRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = ValidatePipelineRequestMarshaller.Instance;
options.ResponseUnmarshaller = ValidatePipelineResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the ValidatePipeline operation.
///
///
/// The IAsyncResult returned by the call to BeginValidatePipeline.
///
/// Returns a ValidatePipelineResult from OSIS.
/// REST API Reference for ValidatePipeline Operation
public virtual ValidatePipelineResponse EndValidatePipeline(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#endregion
}
}