Expand description
Data structures used by operation inputs/outputs.
Modules§
Structs§
- Buffer
Options Options that specify the configuration of a persistent buffer. To configure how OpenSearch Ingestion encrypts this data, set the
EncryptionAtRestOptions
. For more information, see Persistent buffering.- Change
Progress Stage Progress details for a specific stage of a pipeline configuration change.
- Change
Progress Status The progress details of a pipeline configuration change.
- Cloud
Watch LogDestination The destination for OpenSearch Ingestion logs sent to Amazon CloudWatch.
- Encryption
AtRest Options Options to control how OpenSearch encrypts buffer data.
- LogPublishing
Options Container for the values required to configure logging for the pipeline. If you don't specify these values, OpenSearch Ingestion will not publish logs from your application to CloudWatch Logs.
- Pipeline
Information about an existing OpenSearch Ingestion pipeline.
- Pipeline
Blueprint Container for information about an OpenSearch Ingestion blueprint.
- Pipeline
Blueprint Summary A summary of an OpenSearch Ingestion blueprint.
- Pipeline
Destination An object representing the destination of a pipeline.
- Pipeline
Endpoint Represents a VPC endpoint for an OpenSearch Ingestion pipeline, enabling private connectivity between your VPC and the pipeline.
- Pipeline
Endpoint Connection Represents a connection to a pipeline endpoint, containing details about the endpoint association.
- Pipeline
Endpoint VpcOptions Configuration settings for the VPC endpoint, specifying network access controls.
- Pipeline
Status Reason Information about a pipeline's current status.
- Pipeline
Summary Summary information for an OpenSearch Ingestion pipeline.
- Service
VpcEndpoint A container for information about VPC endpoints that were created to other services
- Tag
A tag (key-value pair) for an OpenSearch Ingestion pipeline.
- Validation
Message A validation message associated with a
ValidatePipeline
request in OpenSearch Ingestion.- VpcAttachment
Options Options for attaching a VPC to pipeline.
- VpcEndpoint
An OpenSearch Ingestion-managed VPC endpoint that will access one or more pipelines.
- VpcOptions
Options that specify the subnets and security groups for an OpenSearch Ingestion VPC endpoint.
Enums§
- Change
Progress Stage Statuses - When writing a match expression against
ChangeProgressStageStatuses
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Change
Progress Statuses - When writing a match expression against
ChangeProgressStatuses
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Pipeline
Endpoint Status - When writing a match expression against
PipelineEndpointStatus
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Pipeline
Status - When writing a match expression against
PipelineStatus
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - VpcEndpoint
Management - When writing a match expression against
VpcEndpointManagement
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - VpcEndpoint
Service Name - When writing a match expression against
VpcEndpointServiceName
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.