Class: Aws::OSIS::Client

Inherits:
Seahorse::Client::Base
  • Object
show all
Includes:
ClientStubs
Defined in:
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](/sdk-for-ruby/v3/developer-guide/setup-config.html).

See #initialize for a full list of supported configuration options.

Class Attribute Summary collapse

API Operations collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :plugins (Array<Seahorse::Client::Plugin>) — default: []] —

    A list of plugins to apply to the client. Each plugin is either a class name or an instance of a plugin class.

  • :credentials (required, Aws::CredentialProvider) —

    Your AWS credentials. This can be an instance of any one of the following classes:

    • ‘Aws::Credentials` - Used for configuring static, non-refreshing credentials.

    • ‘Aws::SharedCredentials` - Used for loading static credentials from a shared file, such as `~/.aws/config`.

    • ‘Aws::AssumeRoleCredentials` - Used when you need to assume a role.

    • ‘Aws::AssumeRoleWebIdentityCredentials` - Used when you need to assume a role after providing credentials via the web.

    • ‘Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an access token generated from `aws login`.

    • ‘Aws::ProcessCredentials` - Used for loading credentials from a process that outputs to stdout.

    • ‘Aws::InstanceProfileCredentials` - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • ‘Aws::ECSCredentials` - Used for loading credentials from instances running in ECS.

    • ‘Aws::CognitoIdentityCredentials` - Used for loading credentials from the Cognito Identity service.

    When ‘:credentials` are not configured directly, the following locations will be searched for credentials:

    • ‘Aws.config`

    • The ‘:access_key_id`, `:secret_access_key`, `:session_token`, and `:account_id` options.

    • ENV, ENV, ENV, and ENV

    • ‘~/.aws/credentials`

    • ‘~/.aws/config`

    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of ‘Aws::InstanceProfileCredentials` or `Aws::ECSCredentials` to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV to true.

  • :region (required, String) —

    The AWS region to connect to. The configured ‘:region` is used to determine the service `:endpoint`. When not passed, a default `:region` is searched for in the following locations:

  • :access_key_id (String)
  • :account_id (String)
  • :active_endpoint_cache (Boolean) — default: false —

    When set to ‘true`, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to `false`.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

    Used only in ‘adaptive` retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a `RetryCapacityNotAvailableError` and will not retry instead of sleeping.

  • :client_side_monitoring (Boolean) — default: false —

    When ‘true`, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: "" —

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1" —

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000 —

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true —

    When ‘true`, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true —

    Used only in ‘standard` and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :defaults_mode (String) — default: "legacy" —

    See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_host_prefix_injection (Boolean) — default: false —

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available.

  • :disable_request_compression (Boolean) — default: false —

    When set to ‘true’ the request body will not be compressed for supported operations.

  • :endpoint (String, URI::HTTPS, URI::HTTP) —

    Normally you should not configure the ‘:endpoint` option directly. This is normally constructed from the `:region` option. Configuring `:endpoint` is normally reserved for connecting to test or custom endpoints. The endpoint should be a URI formatted like:

    'http://example.com'
'https://example.com'
'http://example.com:123'
  • :endpoint_cache_max_entries (Integer) — default: 1000 —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10 —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false —

    When set to ‘true`, endpoint discovery will be enabled for operations when available.

  • :ignore_configured_endpoint_urls (Boolean) —

    Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

    The log formatter.

  • :log_level (Symbol) — default: :info —

    The log level to send messages to the ‘:logger` at.

  • :logger (Logger) —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3 —

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in ‘standard` and `adaptive` retry modes.

  • :profile (String) — default: "default" —

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, ‘default’ is used.

  • :request_min_compression_size_bytes (Integer) — default: 10240 —

    The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.

  • :retry_backoff (Proc) —

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the ‘legacy` retry mode.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function. This option is only used in the ‘legacy` retry mode.

  • :retry_jitter (Symbol) — default: :none —

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the ‘legacy` retry mode.

    @see www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 3 —

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the ‘legacy` retry mode.

  • :retry_max_delay (Integer) — default: 0 —

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the ‘legacy` retry mode.

  • :retry_mode (String) — default: "legacy" —

    Specifies which retry algorithm to use. Values are:

    • ‘legacy` - The pre-existing retry behavior. This is default value if no retry mode is provided.

    • ‘standard` - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • ‘adaptive` - An experimental retry mode that includes all the functionality of `standard` mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.

  • :sdk_ua_app_id (String) —

    A unique and opaque application ID that is appended to the User-Agent header as app/sdk_ua_app_id. It should have a maximum length of 50. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.

  • :secret_access_key (String)
  • :session_token (String)
  • :sigv4a_signing_region_set (Array) —

    A list of regions that should be signed with SigV4a signing. When not passed, a default ‘:sigv4a_signing_region_set` is searched for in the following locations:

  • :stub_responses (Boolean) — default: false —

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    ** Please note ** When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :telemetry_provider (Aws::Telemetry::TelemetryProviderBase) — default: Aws::Telemetry::NoOpTelemetryProvider —

    Allows you to provide a telemetry provider, which is used to emit telemetry data. By default, uses ‘NoOpTelemetryProvider` which will not record or emit any telemetry data. The SDK supports the following telemetry providers:

    • OpenTelemetry (OTel) - To use the OTel provider, install and require the

    ‘opentelemetry-sdk` gem and then, pass in an instance of a `Aws::Telemetry::OTelProvider` for telemetry provider.

  • :token_provider (Aws::TokenProvider) —

    A Bearer Token Provider. This can be an instance of any one of the following classes:

    • ‘Aws::StaticTokenProvider` - Used for configuring static, non-refreshing tokens.

    • ‘Aws::SSOTokenProvider` - Used for loading tokens from AWS SSO using an access token generated from `aws login`.

    When ‘:token_provider` is not configured directly, the `Aws::TokenProviderChain` will be used to search for tokens configured for your profile in shared configuration files.

  • :use_dualstack_endpoint (Boolean) —

    When set to ‘true`, dualstack enabled endpoints (with `.aws` TLD) will be used if available.

  • :use_fips_endpoint (Boolean) —

    When set to ‘true`, fips compatible endpoints will be used if available. When a `fips` region is used, the region is normalized and this config is set to `true`.

  • :validate_params (Boolean) — default: true —

    When ‘true`, request parameters are validated before sending the request.

  • :endpoint_provider (Aws::OSIS::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to ‘#resolve_endpoint(parameters)` where `parameters` is a Struct similar to `Aws::OSIS::EndpointParameters`.

  • :http_continue_timeout (Float) — default: 1 —

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has “Expect” header set to “100-continue”. Defaults to ‘nil` which disables this behaviour. This value can safely be set per request on the session.

  • :http_idle_timeout (Float) — default: 5 —

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_open_timeout (Float) — default: 15 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_proxy (URI::HTTP, String) —

    A proxy to send requests through. Formatted like ‘proxy.com:123’.

  • :http_read_timeout (Float) — default: 60 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_wire_trace (Boolean) — default: false —

    When ‘true`, HTTP debug output will be sent to the `:logger`.

  • :on_chunk_received (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the response body is received. It provides three arguments: the chunk, the number of bytes received, and the total number of bytes in the response (or nil if the server did not send a ‘content-length`).

  • :on_chunk_sent (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the request body is sent. It provides three arguments: the chunk, the number of bytes read from the body, and the total number of bytes in the body.

  • :raise_response_errors (Boolean) — default: true —

    When ‘true`, response errors are raised.

  • :ssl_ca_bundle (String) —

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass ‘:ssl_ca_bundle` or `:ssl_ca_directory` the the system default will be used if available.

  • :ssl_ca_directory (String) —

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass ‘:ssl_ca_bundle` or `:ssl_ca_directory` the the system default will be used if available.

  • :ssl_ca_store (String) —

    Sets the X509::Store to verify peer certificate.

  • :ssl_cert (OpenSSL::X509::Certificate) —

    Sets a client certificate when creating http connections.

  • :ssl_key (OpenSSL::PKey) —

    Sets a client key when creating http connections.

  • :ssl_timeout (Float) —

    Sets the SSL timeout in seconds

  • :ssl_verify_peer (Boolean) — default: true —

    When ‘true`, SSL peer certificates are verified when establishing a connection.



444
445
446
 
# File 'lib/aws-sdk-osis/client.rb', line 444

def initialize(*args)
  super
end

Class Attribute Details

.identifier ⇒ Object (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



1260
1261
1262
 
# File 'lib/aws-sdk-osis/client.rb', line 1260

def identifier
  @identifier
end

Class Method Details

.errors_module ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



1263
1264
1265
 
# File 'lib/aws-sdk-osis/client.rb', line 1263

def errors_module
  Errors
end

Instance Method Details

#build_request(operation_name, params = {}) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:

  • params ({}) (defaults to: {}) 


1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
 
# File 'lib/aws-sdk-osis/client.rb', line 1233

def build_request(operation_name, params = {})
  handlers = @handlers.for(operation_name)
  tracer = config.telemetry_provider.tracer_provider.tracer(
    Aws::Telemetry.module_to_tracer_name('Aws::OSIS')
  )
  context = Seahorse::Client::RequestContext.new(
    operation_name: operation_name,
    operation: config.api.operation(operation_name),
    client: self,
    params: params,
    config: config,
    tracer: tracer
  )
  context[:gem_name] = 'aws-sdk-osis'
  context[:gem_version] = '1.27.0'
  Seahorse::Client::Request.new(handlers, context)
end

#create_pipeline(params = {}) ⇒ Types::CreatePipelineResponse

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

[1]: docs.aws.amazon.com/opensearch-service/latest/developerguide/creating-pipeline.html

Examples:

Request syntax with placeholder values


resp = client.create_pipeline({
  pipeline_name: "PipelineName", # required
  min_units: 1, # required
  max_units: 1, # required
  pipeline_configuration_body: "PipelineConfigurationBody", # required
  log_publishing_options: {
    is_logging_enabled: false,
    cloud_watch_log_destination: {
      log_group: "LogGroup", # required
    },
  },
  vpc_options: {
    subnet_ids: ["SubnetId"], # required
    security_group_ids: ["SecurityGroupId"],
    vpc_attachment_options: {
      attach_to_vpc: false, # required
      cidr_block: "CidrBlock",
    },
    vpc_endpoint_management: "CUSTOMER", # accepts CUSTOMER, SERVICE
  },
  buffer_options: {
    persistent_buffer_enabled: false, # required
  },
  encryption_at_rest_options: {
    kms_key_arn: "KmsKeyArn", # required
  },
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure


resp.pipeline.pipeline_name #=> String
resp.pipeline.pipeline_arn #=> String
resp.pipeline.min_units #=> Integer
resp.pipeline.max_units #=> Integer
resp.pipeline.status #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "CREATE_FAILED", "UPDATE_FAILED", "STARTING", "START_FAILED", "STOPPING", "STOPPED"
resp.pipeline.status_reason.description #=> String
resp.pipeline.pipeline_configuration_body #=> String
resp.pipeline.created_at #=> Time
resp.pipeline.last_updated_at #=> Time
resp.pipeline.ingest_endpoint_urls #=> Array
resp.pipeline.ingest_endpoint_urls[0] #=> String
resp.pipeline.log_publishing_options.is_logging_enabled #=> Boolean
resp.pipeline.log_publishing_options.cloud_watch_log_destination.log_group #=> String
resp.pipeline.vpc_endpoints #=> Array
resp.pipeline.vpc_endpoints[0].vpc_endpoint_id #=> String
resp.pipeline.vpc_endpoints[0].vpc_id #=> String
resp.pipeline.vpc_endpoints[0].vpc_options.subnet_ids #=> Array
resp.pipeline.vpc_endpoints[0].vpc_options.subnet_ids[0] #=> String
resp.pipeline.vpc_endpoints[0].vpc_options.security_group_ids #=> Array
resp.pipeline.vpc_endpoints[0].vpc_options.security_group_ids[0] #=> String
resp.pipeline.vpc_endpoints[0].vpc_options.vpc_attachment_options.attach_to_vpc #=> Boolean
resp.pipeline.vpc_endpoints[0].vpc_options.vpc_attachment_options.cidr_block #=> String
resp.pipeline.vpc_endpoints[0].vpc_options.vpc_endpoint_management #=> String, one of "CUSTOMER", "SERVICE"
resp.pipeline.buffer_options.persistent_buffer_enabled #=> Boolean
resp.pipeline.encryption_at_rest_options.kms_key_arn #=> String
resp.pipeline.vpc_endpoint_service #=> String
resp.pipeline.service_vpc_endpoints #=> Array
resp.pipeline.service_vpc_endpoints[0].service_name #=> String, one of "OPENSEARCH_SERVERLESS"
resp.pipeline.service_vpc_endpoints[0].vpc_endpoint_id #=> String
resp.pipeline.destinations #=> Array
resp.pipeline.destinations[0].service_name #=> String
resp.pipeline.destinations[0].endpoint #=> String
resp.pipeline.tags #=> Array
resp.pipeline.tags[0].key #=> String
resp.pipeline.tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :pipeline_name (required, String) —

    The name of the OpenSearch Ingestion pipeline to create. Pipeline names are unique across the pipelines owned by an account within an Amazon Web Services Region.

  • :min_units (required, Integer) —

    The minimum pipeline capacity, in Ingestion Compute Units (ICUs).

  • :max_units (required, Integer) —

    The maximum pipeline capacity, in Ingestion Compute Units (ICUs).

  • :pipeline_configuration_body (required, String) —

    The pipeline configuration in YAML format. The command accepts the pipeline configuration as a string or within a .yaml file. If you provide the configuration as a string, each new line must be escaped with ‘n`.

  • :log_publishing_options (Types::LogPublishingOptions) —

    Key-value pairs to configure log publishing.

  • :vpc_options (Types::VpcOptions) —

    Container for the values required to configure VPC access for the pipeline. If you don’t specify these values, OpenSearch Ingestion creates the pipeline with a public endpoint.

  • :buffer_options (Types::BufferOptions) —

    Key-value pairs to configure persistent buffering for the pipeline.

  • :encryption_at_rest_options (Types::EncryptionAtRestOptions) —

    Key-value pairs to configure encryption for data that is written to a persistent buffer.

  • :tags (Array<Types::Tag>) —

    List of tags to add to the pipeline upon creation.

Returns:

See Also:



574
575
576
577
 
# File 'lib/aws-sdk-osis/client.rb', line 574

def create_pipeline(params = {}, options = {})
  req = build_request(:create_pipeline, params)
  req.send_request(options)
end

#delete_pipeline(params = {}) ⇒ Struct

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

[1]: docs.aws.amazon.com/opensearch-service/latest/developerguide/delete-pipeline.html

Examples:

Request syntax with placeholder values


resp = client.delete_pipeline({
  pipeline_name: "PipelineName", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :pipeline_name (required, String) —

    The name of the pipeline to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



601
602
603
604
 
# File 'lib/aws-sdk-osis/client.rb', line 601

def delete_pipeline(params = {}, options = {})
  req = build_request(:delete_pipeline, params)
  req.send_request(options)
end

#get_pipeline(params = {}) ⇒ Types::GetPipelineResponse

Retrieves information about an OpenSearch Ingestion pipeline.

Examples:

Request syntax with placeholder values


resp = client.get_pipeline({
  pipeline_name: "PipelineName", # required
})

Response structure


resp.pipeline.pipeline_name #=> String
resp.pipeline.pipeline_arn #=> String
resp.pipeline.min_units #=> Integer
resp.pipeline.max_units #=> Integer
resp.pipeline.status #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "CREATE_FAILED", "UPDATE_FAILED", "STARTING", "START_FAILED", "STOPPING", "STOPPED"
resp.pipeline.status_reason.description #=> String
resp.pipeline.pipeline_configuration_body #=> String
resp.pipeline.created_at #=> Time
resp.pipeline.last_updated_at #=> Time
resp.pipeline.ingest_endpoint_urls #=> Array
resp.pipeline.ingest_endpoint_urls[0] #=> String
resp.pipeline.log_publishing_options.is_logging_enabled #=> Boolean
resp.pipeline.log_publishing_options.cloud_watch_log_destination.log_group #=> String
resp.pipeline.vpc_endpoints #=> Array
resp.pipeline.vpc_endpoints[0].vpc_endpoint_id #=> String
resp.pipeline.vpc_endpoints[0].vpc_id #=> String
resp.pipeline.vpc_endpoints[0].vpc_options.subnet_ids #=> Array
resp.pipeline.vpc_endpoints[0].vpc_options.subnet_ids[0] #=> String
resp.pipeline.vpc_endpoints[0].vpc_options.security_group_ids #=> Array
resp.pipeline.vpc_endpoints[0].vpc_options.security_group_ids[0] #=> String
resp.pipeline.vpc_endpoints[0].vpc_options.vpc_attachment_options.attach_to_vpc #=> Boolean
resp.pipeline.vpc_endpoints[0].vpc_options.vpc_attachment_options.cidr_block #=> String
resp.pipeline.vpc_endpoints[0].vpc_options.vpc_endpoint_management #=> String, one of "CUSTOMER", "SERVICE"
resp.pipeline.buffer_options.persistent_buffer_enabled #=> Boolean
resp.pipeline.encryption_at_rest_options.kms_key_arn #=> String
resp.pipeline.vpc_endpoint_service #=> String
resp.pipeline.service_vpc_endpoints #=> Array
resp.pipeline.service_vpc_endpoints[0].service_name #=> String, one of "OPENSEARCH_SERVERLESS"
resp.pipeline.service_vpc_endpoints[0].vpc_endpoint_id #=> String
resp.pipeline.destinations #=> Array
resp.pipeline.destinations[0].service_name #=> String
resp.pipeline.destinations[0].endpoint #=> String
resp.pipeline.tags #=> Array
resp.pipeline.tags[0].key #=> String
resp.pipeline.tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :pipeline_name (required, String) —

    The name of the pipeline.

Returns:

See Also:



663
664
665
666
 
# File 'lib/aws-sdk-osis/client.rb', line 663

def get_pipeline(params = {}, options = {})
  req = build_request(:get_pipeline, params)
  req.send_request(options)
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].

[1]: docs.aws.amazon.com/opensearch-service/latest/developerguide/creating-pipeline.html#pipeline-blueprint

Examples:

Request syntax with placeholder values


resp = client.get_pipeline_blueprint({
  blueprint_name: "String", # required
  format: "BlueprintFormat",
})

Response structure


resp.blueprint.blueprint_name #=> String
resp.blueprint.pipeline_configuration_body #=> String
resp.blueprint.display_name #=> String
resp.blueprint.display_description #=> String
resp.blueprint.service #=> String
resp.blueprint.use_case #=> String
resp.format #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :blueprint_name (required, String) —

    The name of the blueprint to retrieve.

  • :format (String) —

    The format format of the blueprint to retrieve.

Returns:

See Also:



709
710
711
712
 
# File 'lib/aws-sdk-osis/client.rb', line 709

def get_pipeline_blueprint(params = {}, options = {})
  req = build_request(:get_pipeline_blueprint, params)
  req.send_request(options)
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].

[1]: docs.aws.amazon.com/opensearch-service/latest/developerguide/creating-pipeline.html#get-pipeline-progress

Examples:

Request syntax with placeholder values


resp = client.get_pipeline_change_progress({
  pipeline_name: "PipelineName", # required
})

Response structure


resp.change_progress_statuses #=> Array
resp.change_progress_statuses[0].start_time #=> Time
resp.change_progress_statuses[0].status #=> String, one of "PENDING", "IN_PROGRESS", "COMPLETED", "FAILED"
resp.change_progress_statuses[0].total_number_of_stages #=> Integer
resp.change_progress_statuses[0].change_progress_stages #=> Array
resp.change_progress_statuses[0].change_progress_stages[0].name #=> String
resp.change_progress_statuses[0].change_progress_stages[0].status #=> String, one of "PENDING", "IN_PROGRESS", "COMPLETED", "FAILED"
resp.change_progress_statuses[0].change_progress_stages[0].description #=> String
resp.change_progress_statuses[0].change_progress_stages[0].last_updated_at #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :pipeline_name (required, String) —

    The name of the pipeline.

Returns:

See Also:



754
755
756
757
 
# File 'lib/aws-sdk-osis/client.rb', line 754

def get_pipeline_change_progress(params = {}, options = {})
  req = build_request(:get_pipeline_change_progress, params)
  req.send_request(options)
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].

[1]: docs.aws.amazon.com/opensearch-service/latest/developerguide/creating-pipeline.html#pipeline-blueprint

Examples:

Response structure


resp.blueprints #=> Array
resp.blueprints[0].blueprint_name #=> String
resp.blueprints[0].display_name #=> String
resp.blueprints[0].display_description #=> String
resp.blueprints[0].service #=> String
resp.blueprints[0].use_case #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Returns:

See Also:



783
784
785
786
 
# File 'lib/aws-sdk-osis/client.rb', line 783

def list_pipeline_blueprints(params = {}, options = {})
  req = build_request(:list_pipeline_blueprints, params)
  req.send_request(options)
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].

[1]: docs.aws.amazon.com/opensearch-service/latest/developerguide/list-pipeline.html

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_pipelines({
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.next_token #=> String
resp.pipelines #=> Array
resp.pipelines[0].status #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "CREATE_FAILED", "UPDATE_FAILED", "STARTING", "START_FAILED", "STOPPING", "STOPPED"
resp.pipelines[0].status_reason.description #=> String
resp.pipelines[0].pipeline_name #=> String
resp.pipelines[0].pipeline_arn #=> String
resp.pipelines[0].min_units #=> Integer
resp.pipelines[0].max_units #=> Integer
resp.pipelines[0].created_at #=> Time
resp.pipelines[0].last_updated_at #=> Time
resp.pipelines[0].destinations #=> Array
resp.pipelines[0].destinations[0].service_name #=> String
resp.pipelines[0].destinations[0].endpoint #=> String
resp.pipelines[0].tags #=> Array
resp.pipelines[0].tags[0].key #=> String
resp.pipelines[0].tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :max_results (Integer) —

    An optional parameter that specifies the maximum number of results to return. You can use ‘nextToken` to get the next page of results.

  • :next_token (String) —

    If your initial ‘ListPipelines` operation returns a `nextToken`, you can include the returned `nextToken` in subsequent `ListPipelines` operations, which returns results in the next page.

Returns:

See Also:



842
843
844
845
 
# File 'lib/aws-sdk-osis/client.rb', line 842

def list_pipelines(params = {}, options = {})
  req = build_request(:list_pipelines, params)
  req.send_request(options)
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].

[1]: docs.aws.amazon.com/opensearch-service/latest/developerguide/tag-pipeline.html

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  arn: "PipelineArn", # required
})

Response structure


resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :arn (required, String) —

    The Amazon Resource Name (ARN) of the pipeline to retrieve tags for.

Returns:

See Also:



878
879
880
881
 
# File 'lib/aws-sdk-osis/client.rb', line 878

def list_tags_for_resource(params = {}, options = {})
  req = build_request(:list_tags_for_resource, params)
  req.send_request(options)
end

#start_pipeline(params = {}) ⇒ Types::StartPipelineResponse

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

[1]: docs.aws.amazon.com/opensearch-service/latest/developerguide/pipeline–stop-start.html#pipeline–start

Examples:

Request syntax with placeholder values


resp = client.start_pipeline({
  pipeline_name: "PipelineName", # required
})

Response structure


resp.pipeline.pipeline_name #=> String
resp.pipeline.pipeline_arn #=> String
resp.pipeline.min_units #=> Integer
resp.pipeline.max_units #=> Integer
resp.pipeline.status #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "CREATE_FAILED", "UPDATE_FAILED", "STARTING", "START_FAILED", "STOPPING", "STOPPED"
resp.pipeline.status_reason.description #=> String
resp.pipeline.pipeline_configuration_body #=> String
resp.pipeline.created_at #=> Time
resp.pipeline.last_updated_at #=> Time
resp.pipeline.ingest_endpoint_urls #=> Array
resp.pipeline.ingest_endpoint_urls[0] #=> String
resp.pipeline.log_publishing_options.is_logging_enabled #=> Boolean
resp.pipeline.log_publishing_options.cloud_watch_log_destination.log_group #=> String
resp.pipeline.vpc_endpoints #=> Array
resp.pipeline.vpc_endpoints[0].vpc_endpoint_id #=> String
resp.pipeline.vpc_endpoints[0].vpc_id #=> String
resp.pipeline.vpc_endpoints[0].vpc_options.subnet_ids #=> Array
resp.pipeline.vpc_endpoints[0].vpc_options.subnet_ids[0] #=> String
resp.pipeline.vpc_endpoints[0].vpc_options.security_group_ids #=> Array
resp.pipeline.vpc_endpoints[0].vpc_options.security_group_ids[0] #=> String
resp.pipeline.vpc_endpoints[0].vpc_options.vpc_attachment_options.attach_to_vpc #=> Boolean
resp.pipeline.vpc_endpoints[0].vpc_options.vpc_attachment_options.cidr_block #=> String
resp.pipeline.vpc_endpoints[0].vpc_options.vpc_endpoint_management #=> String, one of "CUSTOMER", "SERVICE"
resp.pipeline.buffer_options.persistent_buffer_enabled #=> Boolean
resp.pipeline.encryption_at_rest_options.kms_key_arn #=> String
resp.pipeline.vpc_endpoint_service #=> String
resp.pipeline.service_vpc_endpoints #=> Array
resp.pipeline.service_vpc_endpoints[0].service_name #=> String, one of "OPENSEARCH_SERVERLESS"
resp.pipeline.service_vpc_endpoints[0].vpc_endpoint_id #=> String
resp.pipeline.destinations #=> Array
resp.pipeline.destinations[0].service_name #=> String
resp.pipeline.destinations[0].endpoint #=> String
resp.pipeline.tags #=> Array
resp.pipeline.tags[0].key #=> String
resp.pipeline.tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :pipeline_name (required, String) —

    The name of the pipeline to start.

Returns:

See Also:



945
946
947
948
 
# File 'lib/aws-sdk-osis/client.rb', line 945

def start_pipeline(params = {}, options = {})
  req = build_request(:start_pipeline, params)
  req.send_request(options)
end

#stop_pipeline(params = {}) ⇒ Types::StopPipelineResponse

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

[1]: docs.aws.amazon.com/opensearch-service/latest/developerguide/pipeline–stop-start.html#pipeline–stop

Examples:

Request syntax with placeholder values


resp = client.stop_pipeline({
  pipeline_name: "PipelineName", # required
})

Response structure


resp.pipeline.pipeline_name #=> String
resp.pipeline.pipeline_arn #=> String
resp.pipeline.min_units #=> Integer
resp.pipeline.max_units #=> Integer
resp.pipeline.status #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "CREATE_FAILED", "UPDATE_FAILED", "STARTING", "START_FAILED", "STOPPING", "STOPPED"
resp.pipeline.status_reason.description #=> String
resp.pipeline.pipeline_configuration_body #=> String
resp.pipeline.created_at #=> Time
resp.pipeline.last_updated_at #=> Time
resp.pipeline.ingest_endpoint_urls #=> Array
resp.pipeline.ingest_endpoint_urls[0] #=> String
resp.pipeline.log_publishing_options.is_logging_enabled #=> Boolean
resp.pipeline.log_publishing_options.cloud_watch_log_destination.log_group #=> String
resp.pipeline.vpc_endpoints #=> Array
resp.pipeline.vpc_endpoints[0].vpc_endpoint_id #=> String
resp.pipeline.vpc_endpoints[0].vpc_id #=> String
resp.pipeline.vpc_endpoints[0].vpc_options.subnet_ids #=> Array
resp.pipeline.vpc_endpoints[0].vpc_options.subnet_ids[0] #=> String
resp.pipeline.vpc_endpoints[0].vpc_options.security_group_ids #=> Array
resp.pipeline.vpc_endpoints[0].vpc_options.security_group_ids[0] #=> String
resp.pipeline.vpc_endpoints[0].vpc_options.vpc_attachment_options.attach_to_vpc #=> Boolean
resp.pipeline.vpc_endpoints[0].vpc_options.vpc_attachment_options.cidr_block #=> String
resp.pipeline.vpc_endpoints[0].vpc_options.vpc_endpoint_management #=> String, one of "CUSTOMER", "SERVICE"
resp.pipeline.buffer_options.persistent_buffer_enabled #=> Boolean
resp.pipeline.encryption_at_rest_options.kms_key_arn #=> String
resp.pipeline.vpc_endpoint_service #=> String
resp.pipeline.service_vpc_endpoints #=> Array
resp.pipeline.service_vpc_endpoints[0].service_name #=> String, one of "OPENSEARCH_SERVERLESS"
resp.pipeline.service_vpc_endpoints[0].vpc_endpoint_id #=> String
resp.pipeline.destinations #=> Array
resp.pipeline.destinations[0].service_name #=> String
resp.pipeline.destinations[0].endpoint #=> String
resp.pipeline.tags #=> Array
resp.pipeline.tags[0].key #=> String
resp.pipeline.tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :pipeline_name (required, String) —

    The name of the pipeline to stop.

Returns:

See Also:



1012
1013
1014
1015
 
# File 'lib/aws-sdk-osis/client.rb', line 1012

def stop_pipeline(params = {}, options = {})
  req = build_request(:stop_pipeline, params)
  req.send_request(options)
end

#tag_resource(params = {}) ⇒ Struct

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

[1]: docs.aws.amazon.com/opensearch-service/latest/developerguide/tag-pipeline.html

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  arn: "PipelineArn", # required
  tags: [ # required
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :arn (required, String) —

    The Amazon Resource Name (ARN) of the pipeline to tag.

  • :tags (required, Array<Types::Tag>) —

    The list of key-value tags to add to the pipeline.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1048
1049
1050
1051
 
# File 'lib/aws-sdk-osis/client.rb', line 1048

def tag_resource(params = {}, options = {})
  req = build_request(:tag_resource, params)
  req.send_request(options)
end

#untag_resource(params = {}) ⇒ Struct

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

[1]: docs.aws.amazon.com/opensearch-service/latest/developerguide/tag-pipeline.html

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  arn: "PipelineArn", # required
  tag_keys: ["String"], # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :arn (required, String) —

    The Amazon Resource Name (ARN) of the pipeline to remove tags from.

  • :tag_keys (required, Array<String>) —

    The tag keys to remove.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1080
1081
1082
1083
 
# File 'lib/aws-sdk-osis/client.rb', line 1080

def untag_resource(params = {}, options = {})
  req = build_request(:untag_resource, params)
  req.send_request(options)
end

#update_pipeline(params = {}) ⇒ Types::UpdatePipelineResponse

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

[1]: docs.aws.amazon.com/opensearch-service/latest/developerguide/update-pipeline.html

Examples:

Request syntax with placeholder values


resp = client.update_pipeline({
  pipeline_name: "PipelineName", # required
  min_units: 1,
  max_units: 1,
  pipeline_configuration_body: "PipelineConfigurationBody",
  log_publishing_options: {
    is_logging_enabled: false,
    cloud_watch_log_destination: {
      log_group: "LogGroup", # required
    },
  },
  buffer_options: {
    persistent_buffer_enabled: false, # required
  },
  encryption_at_rest_options: {
    kms_key_arn: "KmsKeyArn", # required
  },
})

Response structure


resp.pipeline.pipeline_name #=> String
resp.pipeline.pipeline_arn #=> String
resp.pipeline.min_units #=> Integer
resp.pipeline.max_units #=> Integer
resp.pipeline.status #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "CREATE_FAILED", "UPDATE_FAILED", "STARTING", "START_FAILED", "STOPPING", "STOPPED"
resp.pipeline.status_reason.description #=> String
resp.pipeline.pipeline_configuration_body #=> String
resp.pipeline.created_at #=> Time
resp.pipeline.last_updated_at #=> Time
resp.pipeline.ingest_endpoint_urls #=> Array
resp.pipeline.ingest_endpoint_urls[0] #=> String
resp.pipeline.log_publishing_options.is_logging_enabled #=> Boolean
resp.pipeline.log_publishing_options.cloud_watch_log_destination.log_group #=> String
resp.pipeline.vpc_endpoints #=> Array
resp.pipeline.vpc_endpoints[0].vpc_endpoint_id #=> String
resp.pipeline.vpc_endpoints[0].vpc_id #=> String
resp.pipeline.vpc_endpoints[0].vpc_options.subnet_ids #=> Array
resp.pipeline.vpc_endpoints[0].vpc_options.subnet_ids[0] #=> String
resp.pipeline.vpc_endpoints[0].vpc_options.security_group_ids #=> Array
resp.pipeline.vpc_endpoints[0].vpc_options.security_group_ids[0] #=> String
resp.pipeline.vpc_endpoints[0].vpc_options.vpc_attachment_options.attach_to_vpc #=> Boolean
resp.pipeline.vpc_endpoints[0].vpc_options.vpc_attachment_options.cidr_block #=> String
resp.pipeline.vpc_endpoints[0].vpc_options.vpc_endpoint_management #=> String, one of "CUSTOMER", "SERVICE"
resp.pipeline.buffer_options.persistent_buffer_enabled #=> Boolean
resp.pipeline.encryption_at_rest_options.kms_key_arn #=> String
resp.pipeline.vpc_endpoint_service #=> String
resp.pipeline.service_vpc_endpoints #=> Array
resp.pipeline.service_vpc_endpoints[0].service_name #=> String, one of "OPENSEARCH_SERVERLESS"
resp.pipeline.service_vpc_endpoints[0].vpc_endpoint_id #=> String
resp.pipeline.destinations #=> Array
resp.pipeline.destinations[0].service_name #=> String
resp.pipeline.destinations[0].endpoint #=> String
resp.pipeline.tags #=> Array
resp.pipeline.tags[0].key #=> String
resp.pipeline.tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :pipeline_name (required, String) —

    The name of the pipeline to update.

  • :min_units (Integer) —

    The minimum pipeline capacity, in Ingestion Compute Units (ICUs).

  • :max_units (Integer) —

    The maximum pipeline capacity, in Ingestion Compute Units (ICUs)

  • :pipeline_configuration_body (String) —

    The pipeline configuration in YAML format. The command accepts the pipeline configuration as a string or within a .yaml file. If you provide the configuration as a string, each new line must be escaped with ‘n`.

  • :log_publishing_options (Types::LogPublishingOptions) —

    Key-value pairs to configure log publishing.

  • :buffer_options (Types::BufferOptions) —

    Key-value pairs to configure persistent buffering for the pipeline.

  • :encryption_at_rest_options (Types::EncryptionAtRestOptions) —

    Key-value pairs to configure encryption for data that is written to a persistent buffer.

Returns:

See Also:



1184
1185
1186
1187
 
# File 'lib/aws-sdk-osis/client.rb', line 1184

def update_pipeline(params = {}, options = {})
  req = build_request(:update_pipeline, params)
  req.send_request(options)
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].

[1]: docs.aws.amazon.com/opensearch-service/latest/developerguide/creating-pipeline.html

Examples:

Request syntax with placeholder values


resp = client.validate_pipeline({
  pipeline_configuration_body: "PipelineConfigurationBody", # required
})

Response structure


resp.is_valid #=> Boolean
resp.errors #=> Array
resp.errors[0].message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :pipeline_configuration_body (required, String) —

    The pipeline configuration in YAML format. The command accepts the pipeline configuration as a string or within a .yaml file. If you provide the configuration as a string, each new line must be escaped with ‘n`.

Returns:

See Also:



1224
1225
1226
1227
 
# File 'lib/aws-sdk-osis/client.rb', line 1224

def validate_pipeline(params = {}, options = {})
  req = build_request(:validate_pipeline, params)
  req.send_request(options)
end

#waiter_names ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Deprecated. 


1253
1254
1255
 
# File 'lib/aws-sdk-osis/client.rb', line 1253

def waiter_names
  []
end