Skip to content

Osis Classes

BaseValidatorModel

Oops! This Pydantic model is currently empty. Stay tuned!

BufferOptionsTypeDef

PersistentBufferEnabled

  • Type:
  • Required: Yes

ChangeProgressStageTypeDef

Name

  • Type: typing.Optional[str]

Status

  • Type: typing.Optional[typing.Literal['COMPLETED', 'FAILED', 'IN_PROGRESS', 'PENDING']]

Description

  • Type: typing.Optional[str]

LastUpdatedAt

  • Type: typing.Optional[datetime.datetime]

ChangeProgressStatusTypeDef

StartTime

  • Type: typing.Optional[datetime.datetime]

Status

  • Type: typing.Optional[typing.Literal['COMPLETED', 'FAILED', 'IN_PROGRESS', 'PENDING']]

TotalNumberOfStages

  • Type: typing.Optional[int]

ChangeProgressStages

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.osis_classes.ChangeProgressStageTypeDef]]

CloudWatchLogDestinationTypeDef

LogGroup

  • Type:
  • Required: Yes

CreatePipelineRequestRequestTypeDef

PipelineName

  • Type:
  • Required: Yes

MinUnits

  • Type:
  • Required: Yes

MaxUnits

  • Type:
  • Required: Yes

PipelineConfigurationBody

  • Type:
  • Required: Yes

LogPublishingOptions

  • Type: typing.Optional[aws_resource_validator.pydantic_models.osis_classes.LogPublishingOptionsTypeDef]

VpcOptions

  • Type: typing.Optional[aws_resource_validator.pydantic_models.osis_classes.VpcOptionsTypeDef]

BufferOptions

  • Type: typing.Optional[aws_resource_validator.pydantic_models.osis_classes.BufferOptionsTypeDef]

EncryptionAtRestOptions

  • Type: typing.Optional[aws_resource_validator.pydantic_models.osis_classes.EncryptionAtRestOptionsTypeDef]

Tags

  • Type: typing.Optional[typing.Sequence[aws_resource_validator.pydantic_models.osis_classes.TagTypeDef]]

CreatePipelineResponseTypeDef

Pipeline

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DeletePipelineRequestRequestTypeDef

PipelineName

  • Type:
  • Required: Yes

EncryptionAtRestOptionsTypeDef

KmsKeyArn

  • Type:
  • Required: Yes

GetPipelineBlueprintRequestRequestTypeDef

BlueprintName

  • Type:
  • Required: Yes

Format

  • Type: typing.Optional[str]

GetPipelineBlueprintResponseTypeDef

Blueprint

  • Type:
  • Required: Yes

Format

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetPipelineChangeProgressRequestRequestTypeDef

PipelineName

  • Type:
  • Required: Yes

GetPipelineChangeProgressResponseTypeDef

ChangeProgressStatuses

  • Type: typing.List[aws_resource_validator.pydantic_models.osis_classes.ChangeProgressStatusTypeDef]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetPipelineRequestRequestTypeDef

PipelineName

  • Type:
  • Required: Yes

GetPipelineResponseTypeDef

Pipeline

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ListPipelineBlueprintsResponseTypeDef

Blueprints

  • Type: typing.List[aws_resource_validator.pydantic_models.osis_classes.PipelineBlueprintSummaryTypeDef]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ListPipelinesRequestRequestTypeDef

MaxResults

  • Type: typing.Optional[int]

NextToken

  • Type: typing.Optional[str]

ListPipelinesResponseTypeDef

Pipelines

  • Type: typing.List[aws_resource_validator.pydantic_models.osis_classes.PipelineSummaryTypeDef]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

NextToken

  • Type: typing.Optional[str]

ListTagsForResourceRequestRequestTypeDef

Arn

  • Type:
  • Required: Yes

ListTagsForResourceResponseTypeDef

Tags

  • Type: typing.List[aws_resource_validator.pydantic_models.osis_classes.TagTypeDef]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

LogPublishingOptionsTypeDef

IsLoggingEnabled

  • Type: typing.Optional[bool]

CloudWatchLogDestination

  • Type: typing.Optional[aws_resource_validator.pydantic_models.osis_classes.CloudWatchLogDestinationTypeDef]

PipelineBlueprintSummaryTypeDef

BlueprintName

  • Type: typing.Optional[str]

DisplayName

  • Type: typing.Optional[str]

DisplayDescription

  • Type: typing.Optional[str]

Service

  • Type: typing.Optional[str]

UseCase

  • Type: typing.Optional[str]

PipelineBlueprintTypeDef

BlueprintName

  • Type: typing.Optional[str]

PipelineConfigurationBody

  • Type: typing.Optional[str]

DisplayName

  • Type: typing.Optional[str]

DisplayDescription

  • Type: typing.Optional[str]

Service

  • Type: typing.Optional[str]

UseCase

  • Type: typing.Optional[str]

PipelineDestinationTypeDef

ServiceName

  • Type: typing.Optional[str]

Endpoint

  • Type: typing.Optional[str]

PipelineStatusReasonTypeDef

Description

  • Type: typing.Optional[str]

PipelineSummaryTypeDef

Status

  • Type: typing.Optional[typing.Literal['ACTIVE', 'CREATE_FAILED', 'CREATING', 'DELETING', 'STARTING', 'START_FAILED', 'STOPPED', 'STOPPING', 'UPDATE_FAILED', 'UPDATING']]

StatusReason

  • Type: typing.Optional[aws_resource_validator.pydantic_models.osis_classes.PipelineStatusReasonTypeDef]

PipelineName

  • Type: typing.Optional[str]

PipelineArn

  • Type: typing.Optional[str]

MinUnits

  • Type: typing.Optional[int]

MaxUnits

  • Type: typing.Optional[int]

CreatedAt

  • Type: typing.Optional[datetime.datetime]

LastUpdatedAt

  • Type: typing.Optional[datetime.datetime]

Destinations

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.osis_classes.PipelineDestinationTypeDef]]

Tags

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.osis_classes.TagTypeDef]]

PipelineTypeDef

PipelineName

  • Type: typing.Optional[str]

PipelineArn

  • Type: typing.Optional[str]

MinUnits

  • Type: typing.Optional[int]

MaxUnits

  • Type: typing.Optional[int]

Status

  • Type: typing.Optional[typing.Literal['ACTIVE', 'CREATE_FAILED', 'CREATING', 'DELETING', 'STARTING', 'START_FAILED', 'STOPPED', 'STOPPING', 'UPDATE_FAILED', 'UPDATING']]

StatusReason

  • Type: typing.Optional[aws_resource_validator.pydantic_models.osis_classes.PipelineStatusReasonTypeDef]

PipelineConfigurationBody

  • Type: typing.Optional[str]

CreatedAt

  • Type: typing.Optional[datetime.datetime]

LastUpdatedAt

  • Type: typing.Optional[datetime.datetime]

IngestEndpointUrls

  • Type: typing.Optional[typing.List[str]]

LogPublishingOptions

  • Type: typing.Optional[aws_resource_validator.pydantic_models.osis_classes.LogPublishingOptionsTypeDef]

VpcEndpoints

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.osis_classes.VpcEndpointTypeDef]]

BufferOptions

  • Type: typing.Optional[aws_resource_validator.pydantic_models.osis_classes.BufferOptionsTypeDef]

EncryptionAtRestOptions

  • Type: typing.Optional[aws_resource_validator.pydantic_models.osis_classes.EncryptionAtRestOptionsTypeDef]

VpcEndpointService

  • Type: typing.Optional[str]

ServiceVpcEndpoints

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.osis_classes.ServiceVpcEndpointTypeDef]]

Destinations

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.osis_classes.PipelineDestinationTypeDef]]

Tags

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.osis_classes.TagTypeDef]]

ResponseMetadataTypeDef

RequestId

  • Type:
  • Required: Yes

HTTPStatusCode

  • Type:
  • Required: Yes

HTTPHeaders

  • Type: typing.Dict[str, str]
  • Required: Yes

RetryAttempts

  • Type:
  • Required: Yes

HostId

  • Type: typing.Optional[str]

ServiceVpcEndpointTypeDef

ServiceName

  • Type: typing.Optional[typing.Literal['OPENSEARCH_SERVERLESS']]

VpcEndpointId

  • Type: typing.Optional[str]

StartPipelineRequestRequestTypeDef

PipelineName

  • Type:
  • Required: Yes

StartPipelineResponseTypeDef

Pipeline

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

StopPipelineRequestRequestTypeDef

PipelineName

  • Type:
  • Required: Yes

StopPipelineResponseTypeDef

Pipeline

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

TagResourceRequestRequestTypeDef

Arn

  • Type:
  • Required: Yes

Tags

  • Type: typing.Sequence[aws_resource_validator.pydantic_models.osis_classes.TagTypeDef]
  • Required: Yes

TagTypeDef

Key

  • Type:
  • Required: Yes

Value

  • Type:
  • Required: Yes

UntagResourceRequestRequestTypeDef

Arn

  • Type:
  • Required: Yes

TagKeys

  • Type: typing.Sequence[str]
  • Required: Yes

UpdatePipelineRequestRequestTypeDef

PipelineName

  • Type:
  • Required: Yes

MinUnits

  • Type: typing.Optional[int]

MaxUnits

  • Type: typing.Optional[int]

PipelineConfigurationBody

  • Type: typing.Optional[str]

LogPublishingOptions

  • Type: typing.Optional[aws_resource_validator.pydantic_models.osis_classes.LogPublishingOptionsTypeDef]

BufferOptions

  • Type: typing.Optional[aws_resource_validator.pydantic_models.osis_classes.BufferOptionsTypeDef]

EncryptionAtRestOptions

  • Type: typing.Optional[aws_resource_validator.pydantic_models.osis_classes.EncryptionAtRestOptionsTypeDef]

UpdatePipelineResponseTypeDef

Pipeline

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ValidatePipelineRequestRequestTypeDef

PipelineConfigurationBody

  • Type:
  • Required: Yes

ValidatePipelineResponseTypeDef

isValid

  • Type:
  • Required: Yes

Errors

  • Type: typing.List[aws_resource_validator.pydantic_models.osis_classes.ValidationMessageTypeDef]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ValidationMessageTypeDef

Message

  • Type: typing.Optional[str]

VpcAttachmentOptionsTypeDef

AttachToVpc

  • Type:
  • Required: Yes

CidrBlock

  • Type: typing.Optional[str]

VpcEndpointTypeDef

VpcEndpointId

  • Type: typing.Optional[str]

VpcId

  • Type: typing.Optional[str]

VpcOptions

  • Type: typing.Optional[aws_resource_validator.pydantic_models.osis_classes.VpcOptionsOutputTypeDef]

VpcOptionsOutputTypeDef

SubnetIds

  • Type: typing.List[str]
  • Required: Yes

SecurityGroupIds

  • Type: typing.Optional[typing.List[str]]

VpcAttachmentOptions

  • Type: typing.Optional[aws_resource_validator.pydantic_models.osis_classes.VpcAttachmentOptionsTypeDef]

VpcEndpointManagement

  • Type: typing.Optional[typing.Literal['CUSTOMER', 'SERVICE']]

VpcOptionsTypeDef

SubnetIds

  • Type: typing.Sequence[str]
  • Required: Yes

SecurityGroupIds

  • Type: typing.Optional[typing.Sequence[str]]

VpcAttachmentOptions

  • Type: typing.Optional[aws_resource_validator.pydantic_models.osis_classes.VpcAttachmentOptionsTypeDef]

VpcEndpointManagement

  • Type: typing.Optional[typing.Literal['CUSTOMER', 'SERVICE']]