AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonServiceClient
    Amazon.OSIS.AmazonOSISClient

Namespace: Amazon.OSIS
Assembly: AWSSDK.OSIS.dll
Version: 3.x.y.z

Syntax

C# 
public class AmazonOSISClient : AmazonServiceClient
         IAmazonOSIS, IAmazonService, IDisposable

The AmazonOSISClient type exposes the following members

Constructors

NameDescription
Public Method AmazonOSISClient()

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 Method AmazonOSISClient(RegionEndpoint)

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 Method AmazonOSISClient(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>

Public Method AmazonOSISClient(AWSCredentials)

Constructs AmazonOSISClient with AWS Credentials

Public Method AmazonOSISClient(AWSCredentials, RegionEndpoint)

Constructs AmazonOSISClient with AWS Credentials

Public Method AmazonOSISClient(AWSCredentials, AmazonOSISConfig)

Constructs AmazonOSISClient with AWS Credentials and an AmazonOSISClient Configuration object.

Public Method AmazonOSISClient(string, string)

Constructs AmazonOSISClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonOSISClient(string, string, RegionEndpoint)

Constructs AmazonOSISClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonOSISClient(string, string, AmazonOSISConfig)

Constructs AmazonOSISClient with AWS Access Key ID, AWS Secret Key and an AmazonOSISClient Configuration object.

Public Method AmazonOSISClient(string, string, string)

Constructs AmazonOSISClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonOSISClient(string, string, string, RegionEndpoint)

Constructs AmazonOSISClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonOSISClient(string, string, string, AmazonOSISConfig)

Constructs AmazonOSISClient with AWS Access Key ID, AWS Secret Key and an AmazonOSISClient Configuration object.

Properties

NameTypeDescription
Public Property Config Amazon.Runtime.IClientConfig Inherited from Amazon.Runtime.AmazonServiceClient.
Public Property Paginators Amazon.OSIS.Model.IOSISPaginatorFactory

Paginators for the service

Methods

Note:

Asynchronous operations (methods ending with Async) in the table below are for .NET 4.5 or higher. For .NET 3.5 the SDK follows the standard naming convention of BeginMethodName and EndMethodName to indicate asynchronous operations - these method pairs are not shown in the table below.

NameDescription
Public Method CreatePipeline(CreatePipelineRequest)

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

Public Method CreatePipelineAsync(CreatePipelineRequest, CancellationToken)

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

Public Method DeletePipeline(DeletePipelineRequest)

Deletes an OpenSearch Ingestion pipeline. For more information, see Deleting Amazon OpenSearch Ingestion pipelines.

Public Method DeletePipelineAsync(DeletePipelineRequest, CancellationToken)

Deletes an OpenSearch Ingestion pipeline. For more information, see Deleting Amazon OpenSearch Ingestion pipelines.

Public Method DetermineServiceOperationEndpoint(AmazonWebServiceRequest)

Returns the endpoint that will be used for a particular request.

Public Method Dispose() Inherited from Amazon.Runtime.AmazonServiceClient.
Public Method GetPipeline(GetPipelineRequest)

Retrieves information about an OpenSearch Ingestion pipeline.

Public Method GetPipelineAsync(GetPipelineRequest, CancellationToken)

Retrieves information about an OpenSearch Ingestion pipeline.

Public Method GetPipelineBlueprint(GetPipelineBlueprintRequest)

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.

Public Method GetPipelineBlueprintAsync(GetPipelineBlueprintRequest, CancellationToken)

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.

Public Method GetPipelineChangeProgress(GetPipelineChangeProgressRequest)

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.

Public Method GetPipelineChangeProgressAsync(GetPipelineChangeProgressRequest, CancellationToken)

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.

Public Method ListPipelineBlueprints(ListPipelineBlueprintsRequest)

Retrieves a list of all available blueprints for Data Prepper. For more information, see Using blueprints to create a pipeline.

Public Method ListPipelineBlueprintsAsync(ListPipelineBlueprintsRequest, CancellationToken)

Retrieves a list of all available blueprints for Data Prepper. For more information, see Using blueprints to create a pipeline.

Public Method ListPipelines(ListPipelinesRequest)

Lists all OpenSearch Ingestion pipelines in the current Amazon Web Services account and Region. For more information, see Viewing Amazon OpenSearch Ingestion pipelines.

Public Method ListPipelinesAsync(ListPipelinesRequest, CancellationToken)

Lists all OpenSearch Ingestion pipelines in the current Amazon Web Services account and Region. For more information, see Viewing Amazon OpenSearch Ingestion pipelines.

Public Method ListTagsForResource(ListTagsForResourceRequest)

Lists all resource tags associated with an OpenSearch Ingestion pipeline. For more information, see Tagging Amazon OpenSearch Ingestion pipelines.

Public Method ListTagsForResourceAsync(ListTagsForResourceRequest, CancellationToken)

Lists all resource tags associated with an OpenSearch Ingestion pipeline. For more information, see Tagging Amazon OpenSearch Ingestion pipelines.

Public Method StartPipeline(StartPipelineRequest)

Starts an OpenSearch Ingestion pipeline. For more information, see Starting an OpenSearch Ingestion pipeline.

Public Method StartPipelineAsync(StartPipelineRequest, CancellationToken)

Starts an OpenSearch Ingestion pipeline. For more information, see Starting an OpenSearch Ingestion pipeline.

Public Method StopPipeline(StopPipelineRequest)

Stops an OpenSearch Ingestion pipeline. For more information, see Stopping an OpenSearch Ingestion pipeline.

Public Method StopPipelineAsync(StopPipelineRequest, CancellationToken)

Stops an OpenSearch Ingestion pipeline. For more information, see Stopping an OpenSearch Ingestion pipeline.

Public Method TagResource(TagResourceRequest)

Tags an OpenSearch Ingestion pipeline. For more information, see Tagging Amazon OpenSearch Ingestion pipelines.

Public Method TagResourceAsync(TagResourceRequest, CancellationToken)

Tags an OpenSearch Ingestion pipeline. For more information, see Tagging Amazon OpenSearch Ingestion pipelines.

Public Method UntagResource(UntagResourceRequest)

Removes one or more tags from an OpenSearch Ingestion pipeline. For more information, see Tagging Amazon OpenSearch Ingestion pipelines.

Public Method UntagResourceAsync(UntagResourceRequest, CancellationToken)

Removes one or more tags from an OpenSearch Ingestion pipeline. For more information, see Tagging Amazon OpenSearch Ingestion pipelines.

Public Method UpdatePipeline(UpdatePipelineRequest)

Updates an OpenSearch Ingestion pipeline. For more information, see Updating Amazon OpenSearch Ingestion pipelines.

Public Method UpdatePipelineAsync(UpdatePipelineRequest, CancellationToken)

Updates an OpenSearch Ingestion pipeline. For more information, see Updating Amazon OpenSearch Ingestion pipelines.

Public Method ValidatePipeline(ValidatePipelineRequest)

Checks whether an OpenSearch Ingestion pipeline configuration is valid prior to creation. For more information, see Creating Amazon OpenSearch Ingestion pipelines.

Public Method ValidatePipelineAsync(ValidatePipelineRequest, CancellationToken)

Checks whether an OpenSearch Ingestion pipeline configuration is valid prior to creation. For more information, see Creating Amazon OpenSearch Ingestion pipelines.

Events

NameDescription
Event AfterResponseEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event BeforeRequestEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event ExceptionEvent Inherited from Amazon.Runtime.AmazonServiceClient.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5