Amazon OpenSearch Ingestion¶

Description¶

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.

Usage¶

opensearchingestion(
  config = list(),
  credentials = list(),
  endpoint = NULL,
  region = NULL
)

Arguments¶

config

Optional configuration of credentials, endpoint, and/or region.
- credentials:
  - creds:
    - access_key_id: AWS access key ID
    - secret_access_key: AWS secret access key
    - session_token: AWS temporary session token
  - profile: The name of a profile to use. If not given, then the default profile is used.
  - anonymous: Set anonymous credentials.
- endpoint: The complete URL to use for the constructed client.
- region: The AWS Region used in instantiating the client.
- close_connection: Immediately close all HTTP connections.
- timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.
- s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. http://s3.amazonaws.com/BUCKET/KEY.
- sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html
- use_dual_stack: Set this to true to use the dualstack (IPv4 and IPv6) endpoint for a service, where available, falling back to the regular endpoint when it isn't. Defaults to the AWS_USE_DUALSTACK_ENDPOINT environment variable when unset.
credentials

Optional credentials shorthand for the config parameter
- creds:
  - access_key_id: AWS access key ID
  - secret_access_key: AWS secret access key
  - session_token: AWS temporary session token
- profile: The name of a profile to use. If not given, then the default profile is used.
- anonymous: Set anonymous credentials.
endpoint

Optional shorthand for complete URL to use for the constructed client.
region

Optional shorthand for AWS Region used in instantiating the client.

Value¶

A client for the service. You can call the service's operations using syntax like svc$operation(...), where svc is the name you've assigned to the client. The available operations are listed in the Operations section.

Service syntax¶

svc <- opensearchingestion(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string",
      anonymous = "logical"
    ),
    endpoint = "string",
    region = "string",
    close_connection = "logical",
    timeout = "numeric",
    s3_force_path_style = "logical",
    sts_regional_endpoint = "string",
    use_dual_stack = "logical"
  ),
  credentials = list(
    creds = list(
      access_key_id = "string",
      secret_access_key = "string",
      session_token = "string"
    ),
    profile = "string",
    anonymous = "logical"
  ),
  endpoint = "string",
  region = "string"
)

Operations¶

`create_pipeline`	Creates an OpenSearch Ingestion pipeline
`create_pipeline_endpoint`	Creates a VPC endpoint for an OpenSearch Ingestion pipeline
`delete_pipeline`	Deletes an OpenSearch Ingestion pipeline
`delete_pipeline_endpoint`	Deletes a VPC endpoint for an OpenSearch Ingestion pipeline
`delete_resource_policy`	Deletes a resource-based policy from an OpenSearch Ingestion resource
`get_pipeline`	Retrieves information about an OpenSearch Ingestion pipeline
`get_pipeline_blueprint`	Retrieves information about a specific blueprint for OpenSearch Ingestion
`get_pipeline_change_progress`	Returns progress information for the current change happening on an OpenSearch Ingestion pipeline
`get_resource_policy`	Retrieves the resource-based policy attached to an OpenSearch Ingestion resource
`list_pipeline_blueprints`	Retrieves a list of all available blueprints for Data Prepper
`list_pipeline_endpoint_connections`	Lists the pipeline endpoints connected to pipelines in your account
`list_pipeline_endpoints`	Lists all pipeline endpoints in your account
`list_pipelines`	Lists all OpenSearch Ingestion pipelines in the current Amazon Web Services account and Region
`list_tags_for_resource`	Lists all resource tags associated with an OpenSearch Ingestion pipeline
`put_resource_policy`	Attaches a resource-based policy to an OpenSearch Ingestion resource
`revoke_pipeline_endpoint_connections`	Revokes pipeline endpoints from specified endpoint IDs
`start_pipeline`	Starts an OpenSearch Ingestion pipeline
`stop_pipeline`	Stops an OpenSearch Ingestion pipeline
`tag_resource`	Tags an OpenSearch Ingestion pipeline
`untag_resource`	Removes one or more tags from an OpenSearch Ingestion pipeline
`update_pipeline`	Updates an OpenSearch Ingestion pipeline
`validate_pipeline`	Checks whether an OpenSearch Ingestion pipeline configuration is valid prior to creation

Examples¶

svc <- opensearchingestion()
svc$create_pipeline(
  Foo = 123
)