Serialized Form (AWS Java SDK for Amazon OpenSearch Ingestion 1.12.559 API)

Package com.amazonaws.services.osis.model
- Class com.amazonaws.services.osis.model.AccessDeniedException extends AmazonOSISException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.osis.model.AmazonOSISException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.osis.model.ChangeProgressStage extends Object implements Serializable
  - Serialized Fields
    - name
```
String name
```
      The name of the stage.
    - status
```
String status
```
      The current status of the stage that the change is in.
    - description
```
String description
```
      A description of the stage.
    - lastUpdatedAt
```
Date lastUpdatedAt
```
      The most recent updated timestamp of the stage.
- Class com.amazonaws.services.osis.model.ChangeProgressStatus extends Object implements Serializable
  - Serialized Fields
    - startTime
```
Date startTime
```
      The time at which the configuration change is made on the pipeline.
    - status
```
String status
```
      The overall status of the pipeline configuration change.
    - totalNumberOfStages
```
Integer totalNumberOfStages
```
      The total number of stages required for the pipeline configuration change.
    - changeProgressStages
```
List<E> changeProgressStages
```
      Information about the stages that the pipeline is going through to perform the configuration change.
- Class com.amazonaws.services.osis.model.CloudWatchLogDestination extends Object implements Serializable
  - Serialized Fields
    - logGroup
```
String logGroup
```
      The name of the CloudWatch Logs group to send pipeline logs to. You can specify an existing log group or create a new one. For example, /aws/OpenSearchService/IngestionService/my-pipeline.
- Class com.amazonaws.services.osis.model.ConflictException extends AmazonOSISException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.osis.model.CreatePipelineRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - pipelineName
```
String pipelineName
```
      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.
    - minUnits
```
Integer minUnits
```
      The minimum pipeline capacity, in Ingestion Compute Units (ICUs).
    - maxUnits
```
Integer maxUnits
```
      The maximum pipeline capacity, in Ingestion Compute Units (ICUs).
    - pipelineConfigurationBody
```
String pipelineConfigurationBody
```
      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.
    - logPublishingOptions
```
LogPublishingOptions logPublishingOptions
```
      Key-value pairs to configure log publishing.
    - vpcOptions
```
VpcOptions 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.
    - tags
```
List<E> tags
```
      List of tags to add to the pipeline upon creation.
- Class com.amazonaws.services.osis.model.CreatePipelineResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - pipeline
```
Pipeline pipeline
```
      Container for information about the created pipeline.
- Class com.amazonaws.services.osis.model.DeletePipelineRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - pipelineName
```
String pipelineName
```
      The name of the pipeline to delete.
- Class com.amazonaws.services.osis.model.DeletePipelineResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.osis.model.GetPipelineBlueprintRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - blueprintName
```
String blueprintName
```
      The name of the blueprint to retrieve.
- Class com.amazonaws.services.osis.model.GetPipelineBlueprintResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - blueprint
```
PipelineBlueprint blueprint
```
      The requested blueprint in YAML format.
- Class com.amazonaws.services.osis.model.GetPipelineChangeProgressRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - pipelineName
```
String pipelineName
```
      The name of the pipeline.
- Class com.amazonaws.services.osis.model.GetPipelineChangeProgressResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - changeProgressStatuses
```
List<E> changeProgressStatuses
```
      The current status of the change happening on the pipeline.
- Class com.amazonaws.services.osis.model.GetPipelineRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - pipelineName
```
String pipelineName
```
      The name of the pipeline to get information about.
- Class com.amazonaws.services.osis.model.GetPipelineResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - pipeline
```
Pipeline pipeline
```
      Detailed information about the requested pipeline.
- Class com.amazonaws.services.osis.model.InternalException extends AmazonOSISException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.osis.model.InvalidPaginationTokenException extends AmazonOSISException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.osis.model.LimitExceededException extends AmazonOSISException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.osis.model.ListPipelineBlueprintsRequest extends AmazonWebServiceRequest implements Serializable
- Class com.amazonaws.services.osis.model.ListPipelineBlueprintsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - blueprints
```
List<E> blueprints
```
      A list of available blueprints for Data Prepper.
- Class com.amazonaws.services.osis.model.ListPipelinesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - maxResults
```
Integer maxResults
```
      An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.
    - nextToken
```
String nextToken
```
      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.
- Class com.amazonaws.services.osis.model.ListPipelinesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - nextToken
```
String nextToken
```
      When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
    - pipelines
```
List<E> pipelines
```
      A list of all existing Data Prepper pipelines.
- Class com.amazonaws.services.osis.model.ListTagsForResourceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - arn
```
String arn
```
      The Amazon Resource Name (ARN) of the pipeline to retrieve tags for.
- Class com.amazonaws.services.osis.model.ListTagsForResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - tags
```
List<E> tags
```
      A list of tags associated with the given pipeline.
- Class com.amazonaws.services.osis.model.LogPublishingOptions extends Object implements Serializable
  - Serialized Fields
    - isLoggingEnabled
```
Boolean isLoggingEnabled
```
      Whether logs should be published.
    - cloudWatchLogDestination
```
CloudWatchLogDestination cloudWatchLogDestination
```
      The destination for OpenSearch Ingestion logs sent to Amazon CloudWatch Logs. This parameter is required if IsLoggingEnabled is set to true.
- Class com.amazonaws.services.osis.model.Pipeline extends Object implements Serializable
  - Serialized Fields
    - pipelineName
```
String pipelineName
```
      The name of the pipeline.
    - pipelineArn
```
String pipelineArn
```
      The Amazon Resource Name (ARN) of the pipeline.
    - minUnits
```
Integer minUnits
```
      The minimum pipeline capacity, in Ingestion Compute Units (ICUs).
    - maxUnits
```
Integer maxUnits
```
      The maximum pipeline capacity, in Ingestion Compute Units (ICUs).
    - status
```
String status
```
      The current status of the pipeline.
    - statusReason
```
PipelineStatusReason statusReason
```
      The reason for the current status of the pipeline.
    - pipelineConfigurationBody
```
String pipelineConfigurationBody
```
      The Data Prepper pipeline configuration in YAML format.
    - createdAt
```
Date createdAt
```
      The date and time when the pipeline was created.
    - lastUpdatedAt
```
Date lastUpdatedAt
```
      The date and time when the pipeline was last updated.
    - ingestEndpointUrls
```
List<E> ingestEndpointUrls
```
      The ingestion endpoints for the pipeline, which you can send data to.
    - logPublishingOptions
```
LogPublishingOptions logPublishingOptions
```
      Key-value pairs that represent log publishing settings.
    - vpcEndpoints
```
List<E> vpcEndpoints
```
      The VPC interface endpoints that have access to the pipeline.
- Class com.amazonaws.services.osis.model.PipelineBlueprint extends Object implements Serializable
  - Serialized Fields
    - blueprintName
```
String blueprintName
```
      The name of the blueprint.
    - pipelineConfigurationBody
```
String pipelineConfigurationBody
```
      The YAML configuration of the blueprint.
- Class com.amazonaws.services.osis.model.PipelineBlueprintSummary extends Object implements Serializable
  - Serialized Fields
    - blueprintName
```
String blueprintName
```
      The name of the blueprint.
- Class com.amazonaws.services.osis.model.PipelineStatusReason extends Object implements Serializable
  - Serialized Fields
    - description
```
String description
```
      A description of why a pipeline has a certain status.
- Class com.amazonaws.services.osis.model.PipelineSummary extends Object implements Serializable
  - Serialized Fields
    - status
```
String status
```
      The current status of the pipeline.
    - statusReason
```
PipelineStatusReason statusReason
```
    - pipelineName
```
String pipelineName
```
      The name of the pipeline.
    - pipelineArn
```
String pipelineArn
```
      The Amazon Resource Name (ARN) of the pipeline.
    - minUnits
```
Integer minUnits
```
      The minimum pipeline capacity, in Ingestion Compute Units (ICUs).
    - maxUnits
```
Integer maxUnits
```
      The maximum pipeline capacity, in Ingestion Compute Units (ICUs).
    - createdAt
```
Date createdAt
```
      The date and time when the pipeline was created.
    - lastUpdatedAt
```
Date lastUpdatedAt
```
      The date and time when the pipeline was last updated.
- Class com.amazonaws.services.osis.model.ResourceAlreadyExistsException extends AmazonOSISException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.osis.model.ResourceNotFoundException extends AmazonOSISException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.osis.model.StartPipelineRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - pipelineName
```
String pipelineName
```
      The name of the pipeline to start.
- Class com.amazonaws.services.osis.model.StartPipelineResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - pipeline
```
Pipeline pipeline
```
- Class com.amazonaws.services.osis.model.StopPipelineRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - pipelineName
```
String pipelineName
```
      The name of the pipeline to stop.
- Class com.amazonaws.services.osis.model.StopPipelineResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - pipeline
```
Pipeline pipeline
```
- Class com.amazonaws.services.osis.model.Tag extends Object implements Serializable
  - Serialized Fields
    - key
```
String key
```
      The tag key. Tag keys must be unique for the pipeline to which they are attached.
    - value
```
String value
```
      The value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key value pair in a tag set of project : Trinity and cost-center : Trinity
- Class com.amazonaws.services.osis.model.TagResourceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - arn
```
String arn
```
      The Amazon Resource Name (ARN) of the pipeline to tag.
    - tags
```
List<E> tags
```
      The list of key-value tags to add to the pipeline.
- Class com.amazonaws.services.osis.model.TagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.osis.model.UntagResourceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - arn
```
String arn
```
      The Amazon Resource Name (ARN) of the pipeline to remove tags from.
    - tagKeys
```
List<E> tagKeys
```
      The tag keys to remove.
- Class com.amazonaws.services.osis.model.UntagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.osis.model.UpdatePipelineRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - pipelineName
```
String pipelineName
```
      The name of the pipeline to update.
    - minUnits
```
Integer minUnits
```
      The minimum pipeline capacity, in Ingestion Compute Units (ICUs).
    - maxUnits
```
Integer maxUnits
```
      The maximum pipeline capacity, in Ingestion Compute Units (ICUs)
    - pipelineConfigurationBody
```
String pipelineConfigurationBody
```
      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.
    - logPublishingOptions
```
LogPublishingOptions logPublishingOptions
```
      Key-value pairs to configure log publishing.
- Class com.amazonaws.services.osis.model.UpdatePipelineResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - pipeline
```
Pipeline pipeline
```
      Container for information about the updated pipeline.
- Class com.amazonaws.services.osis.model.ValidatePipelineRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - pipelineConfigurationBody
```
String pipelineConfigurationBody
```
      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.
- Class com.amazonaws.services.osis.model.ValidatePipelineResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - isValid
```
Boolean isValid
```
      A boolean indicating whether or not the pipeline configuration is valid.
    - errors
```
List<E> errors
```
      A list of errors if the configuration is invalid.
- Class com.amazonaws.services.osis.model.ValidationException extends AmazonOSISException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.osis.model.ValidationMessage extends Object implements Serializable
  - Serialized Fields
    - message
```
String message
```
      The validation message.
- Class com.amazonaws.services.osis.model.VpcEndpoint extends Object implements Serializable
  - Serialized Fields
    - vpcEndpointId
```
String vpcEndpointId
```
      The unique identifier of the endpoint.
    - vpcId
```
String vpcId
```
      The ID for your VPC. Amazon Web Services PrivateLink generates this value when you create a VPC.
    - vpcOptions
```
VpcOptions vpcOptions
```
      Information about the VPC, including associated subnets and security groups.
- Class com.amazonaws.services.osis.model.VpcOptions extends Object implements Serializable
  - Serialized Fields
    - subnetIds
```
List<E> subnetIds
```
      A list of subnet IDs associated with the VPC endpoint.
    - securityGroupIds
```
List<E> securityGroupIds
```
      A list of security groups associated with the VPC endpoint.

Serialized Form

Package com.amazonaws.services.osis.model

Class com.amazonaws.services.osis.model.AccessDeniedException extends AmazonOSISException implements Serializable

Class com.amazonaws.services.osis.model.AmazonOSISException extends AmazonServiceException implements Serializable

Class com.amazonaws.services.osis.model.ChangeProgressStage extends Object implements Serializable

Serialized Fields

name

status

description

lastUpdatedAt

Class com.amazonaws.services.osis.model.ChangeProgressStatus extends Object implements Serializable

Serialized Fields

startTime

status

totalNumberOfStages

changeProgressStages

Class com.amazonaws.services.osis.model.CloudWatchLogDestination extends Object implements Serializable

Serialized Fields

logGroup

Class com.amazonaws.services.osis.model.ConflictException extends AmazonOSISException implements Serializable

Class com.amazonaws.services.osis.model.CreatePipelineRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

pipelineName

minUnits

maxUnits

pipelineConfigurationBody

logPublishingOptions

vpcOptions

tags

Class com.amazonaws.services.osis.model.CreatePipelineResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

pipeline

Class com.amazonaws.services.osis.model.DeletePipelineRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

pipelineName

Class com.amazonaws.services.osis.model.DeletePipelineResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Class com.amazonaws.services.osis.model.GetPipelineBlueprintRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

blueprintName

Class com.amazonaws.services.osis.model.GetPipelineBlueprintResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

blueprint

Class com.amazonaws.services.osis.model.GetPipelineChangeProgressRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

pipelineName

Class com.amazonaws.services.osis.model.GetPipelineChangeProgressResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

changeProgressStatuses

Class com.amazonaws.services.osis.model.GetPipelineRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

pipelineName

Class com.amazonaws.services.osis.model.GetPipelineResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

pipeline

Class com.amazonaws.services.osis.model.InternalException extends AmazonOSISException implements Serializable

Class com.amazonaws.services.osis.model.InvalidPaginationTokenException extends AmazonOSISException implements Serializable

Class com.amazonaws.services.osis.model.LimitExceededException extends AmazonOSISException implements Serializable

Class com.amazonaws.services.osis.model.ListPipelineBlueprintsRequest extends AmazonWebServiceRequest implements Serializable

Class com.amazonaws.services.osis.model.ListPipelineBlueprintsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

blueprints

Class com.amazonaws.services.osis.model.ListPipelinesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

maxResults

nextToken

Class com.amazonaws.services.osis.model.ListPipelinesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

nextToken

pipelines

Class com.amazonaws.services.osis.model.ListTagsForResourceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

arn

Class com.amazonaws.services.osis.model.ListTagsForResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

tags

Class com.amazonaws.services.osis.model.LogPublishingOptions extends Object implements Serializable

Serialized Fields

isLoggingEnabled

cloudWatchLogDestination

Class com.amazonaws.services.osis.model.Pipeline extends Object implements Serializable