Class: Aws::OSIS::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::OSIS::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-osis/lib/aws-sdk-osis/client.rb
Overview
An API client for OSIS. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::OSIS::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#create_pipeline(params = {}) ⇒ Types::CreatePipelineResponse
Creates an OpenSearch Ingestion pipeline.
-
#delete_pipeline(params = {}) ⇒ Struct
Deletes an OpenSearch Ingestion pipeline.
-
#get_pipeline(params = {}) ⇒ Types::GetPipelineResponse
Retrieves information about an OpenSearch Ingestion pipeline.
-
#get_pipeline_blueprint(params = {}) ⇒ Types::GetPipelineBlueprintResponse
Retrieves information about a specific blueprint for OpenSearch Ingestion.
-
#get_pipeline_change_progress(params = {}) ⇒ Types::GetPipelineChangeProgressResponse
Returns progress information for the current change happening on an OpenSearch Ingestion pipeline.
-
#list_pipeline_blueprints(params = {}) ⇒ Types::ListPipelineBlueprintsResponse
Retrieves a list of all available blueprints for Data Prepper.
-
#list_pipelines(params = {}) ⇒ Types::ListPipelinesResponse
Lists all OpenSearch Ingestion pipelines in the current Amazon Web Services account and Region.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists all resource tags associated with an OpenSearch Ingestion pipeline.
-
#start_pipeline(params = {}) ⇒ Types::StartPipelineResponse
Starts an OpenSearch Ingestion pipeline.
-
#stop_pipeline(params = {}) ⇒ Types::StopPipelineResponse
Stops an OpenSearch Ingestion pipeline.
-
#tag_resource(params = {}) ⇒ Struct
Tags an OpenSearch Ingestion pipeline.
-
#untag_resource(params = {}) ⇒ Struct
Removes one or more tags from an OpenSearch Ingestion pipeline.
-
#update_pipeline(params = {}) ⇒ Types::UpdatePipelineResponse
Updates an OpenSearch Ingestion pipeline.
-
#validate_pipeline(params = {}) ⇒ Types::ValidatePipelineResponse
Checks whether an OpenSearch Ingestion pipeline configuration is valid prior to creation.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
385 386 387 |
# File 'gems/aws-sdk-osis/lib/aws-sdk-osis/client.rb', line 385 def initialize(*args) super end |
Instance Method Details
#create_pipeline(params = {}) ⇒ Types::CreatePipelineResponse
Creates an OpenSearch Ingestion pipeline. For more information, see Creating Amazon OpenSearch Ingestion pipelines.
503 504 505 506 |
# File 'gems/aws-sdk-osis/lib/aws-sdk-osis/client.rb', line 503 def create_pipeline(params = {}, = {}) req = build_request(:create_pipeline, params) req.send_request() end |
#delete_pipeline(params = {}) ⇒ Struct
Deletes an OpenSearch Ingestion pipeline. For more information, see Deleting Amazon OpenSearch Ingestion pipelines.
530 531 532 533 |
# File 'gems/aws-sdk-osis/lib/aws-sdk-osis/client.rb', line 530 def delete_pipeline(params = {}, = {}) req = build_request(:delete_pipeline, params) req.send_request() end |
#get_pipeline(params = {}) ⇒ Types::GetPipelineResponse
Retrieves information about an OpenSearch Ingestion pipeline.
585 586 587 588 |
# File 'gems/aws-sdk-osis/lib/aws-sdk-osis/client.rb', line 585 def get_pipeline(params = {}, = {}) req = build_request(:get_pipeline, params) req.send_request() end |
#get_pipeline_blueprint(params = {}) ⇒ Types::GetPipelineBlueprintResponse
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.
621 622 623 624 |
# File 'gems/aws-sdk-osis/lib/aws-sdk-osis/client.rb', line 621 def get_pipeline_blueprint(params = {}, = {}) req = build_request(:get_pipeline_blueprint, params) req.send_request() end |
#get_pipeline_change_progress(params = {}) ⇒ Types::GetPipelineChangeProgressResponse
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.
666 667 668 669 |
# File 'gems/aws-sdk-osis/lib/aws-sdk-osis/client.rb', line 666 def get_pipeline_change_progress(params = {}, = {}) req = build_request(:get_pipeline_change_progress, params) req.send_request() end |
#list_pipeline_blueprints(params = {}) ⇒ Types::ListPipelineBlueprintsResponse
Retrieves a list of all available blueprints for Data Prepper. For more information, see Using blueprints to create a pipeline.
691 692 693 694 |
# File 'gems/aws-sdk-osis/lib/aws-sdk-osis/client.rb', line 691 def list_pipeline_blueprints(params = {}, = {}) req = build_request(:list_pipeline_blueprints, params) req.send_request() end |
#list_pipelines(params = {}) ⇒ Types::ListPipelinesResponse
Lists all OpenSearch Ingestion pipelines in the current Amazon Web Services account and Region. For more information, see Viewing Amazon OpenSearch Ingestion pipelines.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
747 748 749 750 |
# File 'gems/aws-sdk-osis/lib/aws-sdk-osis/client.rb', line 747 def list_pipelines(params = {}, = {}) req = build_request(:list_pipelines, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists all resource tags associated with an OpenSearch Ingestion pipeline. For more information, see Tagging Amazon OpenSearch Ingestion pipelines.
783 784 785 786 |
# File 'gems/aws-sdk-osis/lib/aws-sdk-osis/client.rb', line 783 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#start_pipeline(params = {}) ⇒ Types::StartPipelineResponse
Starts an OpenSearch Ingestion pipeline. For more information, see Starting an OpenSearch Ingestion pipeline.
843 844 845 846 |
# File 'gems/aws-sdk-osis/lib/aws-sdk-osis/client.rb', line 843 def start_pipeline(params = {}, = {}) req = build_request(:start_pipeline, params) req.send_request() end |
#stop_pipeline(params = {}) ⇒ Types::StopPipelineResponse
Stops an OpenSearch Ingestion pipeline. For more information, see Stopping an OpenSearch Ingestion pipeline.
903 904 905 906 |
# File 'gems/aws-sdk-osis/lib/aws-sdk-osis/client.rb', line 903 def stop_pipeline(params = {}, = {}) req = build_request(:stop_pipeline, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Tags an OpenSearch Ingestion pipeline. For more information, see Tagging Amazon OpenSearch Ingestion pipelines.
939 940 941 942 |
# File 'gems/aws-sdk-osis/lib/aws-sdk-osis/client.rb', line 939 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes one or more tags from an OpenSearch Ingestion pipeline. For more information, see Tagging Amazon OpenSearch Ingestion pipelines.
971 972 973 974 |
# File 'gems/aws-sdk-osis/lib/aws-sdk-osis/client.rb', line 971 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_pipeline(params = {}) ⇒ Types::UpdatePipelineResponse
Updates an OpenSearch Ingestion pipeline. For more information, see Updating Amazon OpenSearch Ingestion pipelines.
1068 1069 1070 1071 |
# File 'gems/aws-sdk-osis/lib/aws-sdk-osis/client.rb', line 1068 def update_pipeline(params = {}, = {}) req = build_request(:update_pipeline, params) req.send_request() end |
#validate_pipeline(params = {}) ⇒ Types::ValidatePipelineResponse
Checks whether an OpenSearch Ingestion pipeline configuration is valid prior to creation. For more information, see Creating Amazon OpenSearch Ingestion pipelines.
1108 1109 1110 1111 |
# File 'gems/aws-sdk-osis/lib/aws-sdk-osis/client.rb', line 1108 def validate_pipeline(params = {}, = {}) req = build_request(:validate_pipeline, params) req.send_request() end |