Skip to content

Type definitions#

Index > OpenSearchIngestion > Type definitions

Auto-generated documentation for OpenSearchIngestion type annotations stubs module types-boto3-osis.

BufferOptionsTypeDef#

# BufferOptionsTypeDef definition

class BufferOptionsTypeDef(TypedDict):
    PersistentBufferEnabled: bool,

ChangeProgressStageTypeDef#

# ChangeProgressStageTypeDef definition

class ChangeProgressStageTypeDef(TypedDict):
    Name: NotRequired[str],
    Status: NotRequired[ChangeProgressStageStatusesType],  # (1)
    Description: NotRequired[str],
    LastUpdatedAt: NotRequired[datetime],
  1. See ChangeProgressStageStatusesType

CloudWatchLogDestinationTypeDef#

# CloudWatchLogDestinationTypeDef definition

class CloudWatchLogDestinationTypeDef(TypedDict):
    LogGroup: str,

EncryptionAtRestOptionsTypeDef#

# EncryptionAtRestOptionsTypeDef definition

class EncryptionAtRestOptionsTypeDef(TypedDict):
    KmsKeyArn: str,

TagTypeDef#

# TagTypeDef definition

class TagTypeDef(TypedDict):
    Key: str,
    Value: str,

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HTTPStatusCode: int,
    HTTPHeaders: dict[str, str],
    RetryAttempts: int,
    HostId: NotRequired[str],

DeletePipelineRequestRequestTypeDef#

# DeletePipelineRequestRequestTypeDef definition

class DeletePipelineRequestRequestTypeDef(TypedDict):
    PipelineName: str,

GetPipelineBlueprintRequestRequestTypeDef#

# GetPipelineBlueprintRequestRequestTypeDef definition

class GetPipelineBlueprintRequestRequestTypeDef(TypedDict):
    BlueprintName: str,
    Format: NotRequired[str],

PipelineBlueprintTypeDef#

# PipelineBlueprintTypeDef definition

class PipelineBlueprintTypeDef(TypedDict):
    BlueprintName: NotRequired[str],
    PipelineConfigurationBody: NotRequired[str],
    DisplayName: NotRequired[str],
    DisplayDescription: NotRequired[str],
    Service: NotRequired[str],
    UseCase: NotRequired[str],

GetPipelineChangeProgressRequestRequestTypeDef#

# GetPipelineChangeProgressRequestRequestTypeDef definition

class GetPipelineChangeProgressRequestRequestTypeDef(TypedDict):
    PipelineName: str,

GetPipelineRequestRequestTypeDef#

# GetPipelineRequestRequestTypeDef definition

class GetPipelineRequestRequestTypeDef(TypedDict):
    PipelineName: str,

PipelineBlueprintSummaryTypeDef#

# PipelineBlueprintSummaryTypeDef definition

class PipelineBlueprintSummaryTypeDef(TypedDict):
    BlueprintName: NotRequired[str],
    DisplayName: NotRequired[str],
    DisplayDescription: NotRequired[str],
    Service: NotRequired[str],
    UseCase: NotRequired[str],

ListPipelinesRequestRequestTypeDef#

# ListPipelinesRequestRequestTypeDef definition

class ListPipelinesRequestRequestTypeDef(TypedDict):
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

ListTagsForResourceRequestRequestTypeDef#

# ListTagsForResourceRequestRequestTypeDef definition

class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    Arn: str,

PipelineDestinationTypeDef#

# PipelineDestinationTypeDef definition

class PipelineDestinationTypeDef(TypedDict):
    ServiceName: NotRequired[str],
    Endpoint: NotRequired[str],

PipelineStatusReasonTypeDef#

# PipelineStatusReasonTypeDef definition

class PipelineStatusReasonTypeDef(TypedDict):
    Description: NotRequired[str],

ServiceVpcEndpointTypeDef#

# ServiceVpcEndpointTypeDef definition

class ServiceVpcEndpointTypeDef(TypedDict):
    ServiceName: NotRequired[VpcEndpointServiceNameType],  # (1)
    VpcEndpointId: NotRequired[str],
  1. See VpcEndpointServiceNameType

StartPipelineRequestRequestTypeDef#

# StartPipelineRequestRequestTypeDef definition

class StartPipelineRequestRequestTypeDef(TypedDict):
    PipelineName: str,

StopPipelineRequestRequestTypeDef#

# StopPipelineRequestRequestTypeDef definition

class StopPipelineRequestRequestTypeDef(TypedDict):
    PipelineName: str,

UntagResourceRequestRequestTypeDef#

# UntagResourceRequestRequestTypeDef definition

class UntagResourceRequestRequestTypeDef(TypedDict):
    Arn: str,
    TagKeys: Sequence[str],

ValidatePipelineRequestRequestTypeDef#

# ValidatePipelineRequestRequestTypeDef definition

class ValidatePipelineRequestRequestTypeDef(TypedDict):
    PipelineConfigurationBody: str,

ValidationMessageTypeDef#

# ValidationMessageTypeDef definition

class ValidationMessageTypeDef(TypedDict):
    Message: NotRequired[str],

VpcAttachmentOptionsTypeDef#

# VpcAttachmentOptionsTypeDef definition

class VpcAttachmentOptionsTypeDef(TypedDict):
    AttachToVpc: bool,
    CidrBlock: NotRequired[str],

ChangeProgressStatusTypeDef#

# ChangeProgressStatusTypeDef definition

class ChangeProgressStatusTypeDef(TypedDict):
    StartTime: NotRequired[datetime],
    Status: NotRequired[ChangeProgressStatusesType],  # (1)
    TotalNumberOfStages: NotRequired[int],
    ChangeProgressStages: NotRequired[list[ChangeProgressStageTypeDef]],  # (2)
  1. See ChangeProgressStatusesType
  2. See ChangeProgressStageTypeDef

LogPublishingOptionsTypeDef#

# LogPublishingOptionsTypeDef definition

class LogPublishingOptionsTypeDef(TypedDict):
    IsLoggingEnabled: NotRequired[bool],
    CloudWatchLogDestination: NotRequired[CloudWatchLogDestinationTypeDef],  # (1)
  1. See CloudWatchLogDestinationTypeDef

TagResourceRequestRequestTypeDef#

# TagResourceRequestRequestTypeDef definition

class TagResourceRequestRequestTypeDef(TypedDict):
    Arn: str,
    Tags: Sequence[TagTypeDef],  # (1)
  1. See TagTypeDef

ListTagsForResourceResponseTypeDef#

# ListTagsForResourceResponseTypeDef definition

class ListTagsForResourceResponseTypeDef(TypedDict):
    Tags: list[TagTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See TagTypeDef
  2. See ResponseMetadataTypeDef

GetPipelineBlueprintResponseTypeDef#

# GetPipelineBlueprintResponseTypeDef definition

class GetPipelineBlueprintResponseTypeDef(TypedDict):
    Blueprint: PipelineBlueprintTypeDef,  # (1)
    Format: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See PipelineBlueprintTypeDef
  2. See ResponseMetadataTypeDef

ListPipelineBlueprintsResponseTypeDef#

# ListPipelineBlueprintsResponseTypeDef definition

class ListPipelineBlueprintsResponseTypeDef(TypedDict):
    Blueprints: list[PipelineBlueprintSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See PipelineBlueprintSummaryTypeDef
  2. See ResponseMetadataTypeDef

PipelineSummaryTypeDef#

# PipelineSummaryTypeDef definition

class PipelineSummaryTypeDef(TypedDict):
    Status: NotRequired[PipelineStatusType],  # (1)
    StatusReason: NotRequired[PipelineStatusReasonTypeDef],  # (2)
    PipelineName: NotRequired[str],
    PipelineArn: NotRequired[str],
    MinUnits: NotRequired[int],
    MaxUnits: NotRequired[int],
    CreatedAt: NotRequired[datetime],
    LastUpdatedAt: NotRequired[datetime],
    Destinations: NotRequired[list[PipelineDestinationTypeDef]],  # (3)
    Tags: NotRequired[list[TagTypeDef]],  # (4)
  1. See PipelineStatusType
  2. See PipelineStatusReasonTypeDef
  3. See PipelineDestinationTypeDef
  4. See TagTypeDef

ValidatePipelineResponseTypeDef#

# ValidatePipelineResponseTypeDef definition

class ValidatePipelineResponseTypeDef(TypedDict):
    isValid: bool,
    Errors: list[ValidationMessageTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ValidationMessageTypeDef
  2. See ResponseMetadataTypeDef

VpcOptionsOutputTypeDef#

# VpcOptionsOutputTypeDef definition

class VpcOptionsOutputTypeDef(TypedDict):
    SubnetIds: list[str],
    SecurityGroupIds: NotRequired[list[str]],
    VpcAttachmentOptions: NotRequired[VpcAttachmentOptionsTypeDef],  # (1)
    VpcEndpointManagement: NotRequired[VpcEndpointManagementType],  # (2)
  1. See VpcAttachmentOptionsTypeDef
  2. See VpcEndpointManagementType

VpcOptionsTypeDef#

# VpcOptionsTypeDef definition

class VpcOptionsTypeDef(TypedDict):
    SubnetIds: Sequence[str],
    SecurityGroupIds: NotRequired[Sequence[str]],
    VpcAttachmentOptions: NotRequired[VpcAttachmentOptionsTypeDef],  # (1)
    VpcEndpointManagement: NotRequired[VpcEndpointManagementType],  # (2)
  1. See VpcAttachmentOptionsTypeDef
  2. See VpcEndpointManagementType

GetPipelineChangeProgressResponseTypeDef#

# GetPipelineChangeProgressResponseTypeDef definition

class GetPipelineChangeProgressResponseTypeDef(TypedDict):
    ChangeProgressStatuses: list[ChangeProgressStatusTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ChangeProgressStatusTypeDef
  2. See ResponseMetadataTypeDef

UpdatePipelineRequestRequestTypeDef#

# UpdatePipelineRequestRequestTypeDef definition

class UpdatePipelineRequestRequestTypeDef(TypedDict):
    PipelineName: str,
    MinUnits: NotRequired[int],
    MaxUnits: NotRequired[int],
    PipelineConfigurationBody: NotRequired[str],
    LogPublishingOptions: NotRequired[LogPublishingOptionsTypeDef],  # (1)
    BufferOptions: NotRequired[BufferOptionsTypeDef],  # (2)
    EncryptionAtRestOptions: NotRequired[EncryptionAtRestOptionsTypeDef],  # (3)
  1. See LogPublishingOptionsTypeDef
  2. See BufferOptionsTypeDef
  3. See EncryptionAtRestOptionsTypeDef

ListPipelinesResponseTypeDef#

# ListPipelinesResponseTypeDef definition

class ListPipelinesResponseTypeDef(TypedDict):
    Pipelines: list[PipelineSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See PipelineSummaryTypeDef
  2. See ResponseMetadataTypeDef

VpcEndpointTypeDef#

# VpcEndpointTypeDef definition

class VpcEndpointTypeDef(TypedDict):
    VpcEndpointId: NotRequired[str],
    VpcId: NotRequired[str],
    VpcOptions: NotRequired[VpcOptionsOutputTypeDef],  # (1)
  1. See VpcOptionsOutputTypeDef

CreatePipelineRequestRequestTypeDef#

# CreatePipelineRequestRequestTypeDef definition

class CreatePipelineRequestRequestTypeDef(TypedDict):
    PipelineName: str,
    MinUnits: int,
    MaxUnits: int,
    PipelineConfigurationBody: str,
    LogPublishingOptions: NotRequired[LogPublishingOptionsTypeDef],  # (1)
    VpcOptions: NotRequired[VpcOptionsTypeDef],  # (2)
    BufferOptions: NotRequired[BufferOptionsTypeDef],  # (3)
    EncryptionAtRestOptions: NotRequired[EncryptionAtRestOptionsTypeDef],  # (4)
    Tags: NotRequired[Sequence[TagTypeDef]],  # (5)
  1. See LogPublishingOptionsTypeDef
  2. See VpcOptionsTypeDef
  3. See BufferOptionsTypeDef
  4. See EncryptionAtRestOptionsTypeDef
  5. See TagTypeDef

PipelineTypeDef#

# PipelineTypeDef definition

class PipelineTypeDef(TypedDict):
    PipelineName: NotRequired[str],
    PipelineArn: NotRequired[str],
    MinUnits: NotRequired[int],
    MaxUnits: NotRequired[int],
    Status: NotRequired[PipelineStatusType],  # (1)
    StatusReason: NotRequired[PipelineStatusReasonTypeDef],  # (2)
    PipelineConfigurationBody: NotRequired[str],
    CreatedAt: NotRequired[datetime],
    LastUpdatedAt: NotRequired[datetime],
    IngestEndpointUrls: NotRequired[list[str]],
    LogPublishingOptions: NotRequired[LogPublishingOptionsTypeDef],  # (3)
    VpcEndpoints: NotRequired[list[VpcEndpointTypeDef]],  # (4)
    BufferOptions: NotRequired[BufferOptionsTypeDef],  # (5)
    EncryptionAtRestOptions: NotRequired[EncryptionAtRestOptionsTypeDef],  # (6)
    VpcEndpointService: NotRequired[str],
    ServiceVpcEndpoints: NotRequired[list[ServiceVpcEndpointTypeDef]],  # (7)
    Destinations: NotRequired[list[PipelineDestinationTypeDef]],  # (8)
    Tags: NotRequired[list[TagTypeDef]],  # (9)
  1. See PipelineStatusType
  2. See PipelineStatusReasonTypeDef
  3. See LogPublishingOptionsTypeDef
  4. See VpcEndpointTypeDef
  5. See BufferOptionsTypeDef
  6. See EncryptionAtRestOptionsTypeDef
  7. See ServiceVpcEndpointTypeDef
  8. See PipelineDestinationTypeDef
  9. See TagTypeDef

CreatePipelineResponseTypeDef#

# CreatePipelineResponseTypeDef definition

class CreatePipelineResponseTypeDef(TypedDict):
    Pipeline: PipelineTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See PipelineTypeDef
  2. See ResponseMetadataTypeDef

GetPipelineResponseTypeDef#

# GetPipelineResponseTypeDef definition

class GetPipelineResponseTypeDef(TypedDict):
    Pipeline: PipelineTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See PipelineTypeDef
  2. See ResponseMetadataTypeDef

StartPipelineResponseTypeDef#

# StartPipelineResponseTypeDef definition

class StartPipelineResponseTypeDef(TypedDict):
    Pipeline: PipelineTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See PipelineTypeDef
  2. See ResponseMetadataTypeDef

StopPipelineResponseTypeDef#

# StopPipelineResponseTypeDef definition

class StopPipelineResponseTypeDef(TypedDict):
    Pipeline: PipelineTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See PipelineTypeDef
  2. See ResponseMetadataTypeDef

UpdatePipelineResponseTypeDef#

# UpdatePipelineResponseTypeDef definition

class UpdatePipelineResponseTypeDef(TypedDict):
    Pipeline: PipelineTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See PipelineTypeDef
  2. See ResponseMetadataTypeDef