Type definitions#
Index > OpenSearchIngestion > Type definitions
Auto-generated documentation for OpenSearchIngestion type annotations stubs module types-boto3-osis.
VpcOptionsUnionTypeDef#
# VpcOptionsUnionTypeDef Union usage example
from types_boto3_osis.type_defs import VpcOptionsUnionTypeDef
def get_value() -> VpcOptionsUnionTypeDef:
return ...
# VpcOptionsUnionTypeDef definition
VpcOptionsUnionTypeDef = Union[
VpcOptionsTypeDef, # (1)
VpcOptionsOutputTypeDef, # (2)
]
BufferOptionsTypeDef#
# BufferOptionsTypeDef TypedDict usage example
from types_boto3_osis.type_defs import BufferOptionsTypeDef
def get_value() -> BufferOptionsTypeDef:
return {
"PersistentBufferEnabled": ...,
}
# BufferOptionsTypeDef definition
class BufferOptionsTypeDef(TypedDict):
PersistentBufferEnabled: bool,
ChangeProgressStageTypeDef#
# ChangeProgressStageTypeDef TypedDict usage example
from types_boto3_osis.type_defs import ChangeProgressStageTypeDef
def get_value() -> ChangeProgressStageTypeDef:
return {
"Name": ...,
}
# ChangeProgressStageTypeDef definition
class ChangeProgressStageTypeDef(TypedDict):
Name: NotRequired[str],
Status: NotRequired[ChangeProgressStageStatusesType], # (1)
Description: NotRequired[str],
LastUpdatedAt: NotRequired[datetime],
CloudWatchLogDestinationTypeDef#
# CloudWatchLogDestinationTypeDef TypedDict usage example
from types_boto3_osis.type_defs import CloudWatchLogDestinationTypeDef
def get_value() -> CloudWatchLogDestinationTypeDef:
return {
"LogGroup": ...,
}
# CloudWatchLogDestinationTypeDef definition
class CloudWatchLogDestinationTypeDef(TypedDict):
LogGroup: str,
EncryptionAtRestOptionsTypeDef#
# EncryptionAtRestOptionsTypeDef TypedDict usage example
from types_boto3_osis.type_defs import EncryptionAtRestOptionsTypeDef
def get_value() -> EncryptionAtRestOptionsTypeDef:
return {
"KmsKeyArn": ...,
}
# EncryptionAtRestOptionsTypeDef definition
class EncryptionAtRestOptionsTypeDef(TypedDict):
KmsKeyArn: str,
TagTypeDef#
# TagTypeDef TypedDict usage example
from types_boto3_osis.type_defs import TagTypeDef
def get_value() -> TagTypeDef:
return {
"Key": ...,
}
# TagTypeDef definition
class TagTypeDef(TypedDict):
Key: str,
Value: str,
ResponseMetadataTypeDef#
# ResponseMetadataTypeDef TypedDict usage example
from types_boto3_osis.type_defs import ResponseMetadataTypeDef
def get_value() -> ResponseMetadataTypeDef:
return {
"RequestId": ...,
}
# ResponseMetadataTypeDef definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
HostId: NotRequired[str],
DeletePipelineRequestTypeDef#
# DeletePipelineRequestTypeDef TypedDict usage example
from types_boto3_osis.type_defs import DeletePipelineRequestTypeDef
def get_value() -> DeletePipelineRequestTypeDef:
return {
"PipelineName": ...,
}
# DeletePipelineRequestTypeDef definition
class DeletePipelineRequestTypeDef(TypedDict):
PipelineName: str,
GetPipelineBlueprintRequestTypeDef#
# GetPipelineBlueprintRequestTypeDef TypedDict usage example
from types_boto3_osis.type_defs import GetPipelineBlueprintRequestTypeDef
def get_value() -> GetPipelineBlueprintRequestTypeDef:
return {
"BlueprintName": ...,
}
# GetPipelineBlueprintRequestTypeDef definition
class GetPipelineBlueprintRequestTypeDef(TypedDict):
BlueprintName: str,
Format: NotRequired[str],
PipelineBlueprintTypeDef#
# PipelineBlueprintTypeDef TypedDict usage example
from types_boto3_osis.type_defs import PipelineBlueprintTypeDef
def get_value() -> PipelineBlueprintTypeDef:
return {
"BlueprintName": ...,
}
# PipelineBlueprintTypeDef definition
class PipelineBlueprintTypeDef(TypedDict):
BlueprintName: NotRequired[str],
PipelineConfigurationBody: NotRequired[str],
DisplayName: NotRequired[str],
DisplayDescription: NotRequired[str],
Service: NotRequired[str],
UseCase: NotRequired[str],
GetPipelineChangeProgressRequestTypeDef#
# GetPipelineChangeProgressRequestTypeDef TypedDict usage example
from types_boto3_osis.type_defs import GetPipelineChangeProgressRequestTypeDef
def get_value() -> GetPipelineChangeProgressRequestTypeDef:
return {
"PipelineName": ...,
}
# GetPipelineChangeProgressRequestTypeDef definition
class GetPipelineChangeProgressRequestTypeDef(TypedDict):
PipelineName: str,
GetPipelineRequestTypeDef#
# GetPipelineRequestTypeDef TypedDict usage example
from types_boto3_osis.type_defs import GetPipelineRequestTypeDef
def get_value() -> GetPipelineRequestTypeDef:
return {
"PipelineName": ...,
}
# GetPipelineRequestTypeDef definition
class GetPipelineRequestTypeDef(TypedDict):
PipelineName: str,
PipelineBlueprintSummaryTypeDef#
# PipelineBlueprintSummaryTypeDef TypedDict usage example
from types_boto3_osis.type_defs import PipelineBlueprintSummaryTypeDef
def get_value() -> PipelineBlueprintSummaryTypeDef:
return {
"BlueprintName": ...,
}
# PipelineBlueprintSummaryTypeDef definition
class PipelineBlueprintSummaryTypeDef(TypedDict):
BlueprintName: NotRequired[str],
DisplayName: NotRequired[str],
DisplayDescription: NotRequired[str],
Service: NotRequired[str],
UseCase: NotRequired[str],
ListPipelinesRequestTypeDef#
# ListPipelinesRequestTypeDef TypedDict usage example
from types_boto3_osis.type_defs import ListPipelinesRequestTypeDef
def get_value() -> ListPipelinesRequestTypeDef:
return {
"MaxResults": ...,
}
# ListPipelinesRequestTypeDef definition
class ListPipelinesRequestTypeDef(TypedDict):
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
ListTagsForResourceRequestTypeDef#
# ListTagsForResourceRequestTypeDef TypedDict usage example
from types_boto3_osis.type_defs import ListTagsForResourceRequestTypeDef
def get_value() -> ListTagsForResourceRequestTypeDef:
return {
"Arn": ...,
}
# ListTagsForResourceRequestTypeDef definition
class ListTagsForResourceRequestTypeDef(TypedDict):
Arn: str,
PipelineDestinationTypeDef#
# PipelineDestinationTypeDef TypedDict usage example
from types_boto3_osis.type_defs import PipelineDestinationTypeDef
def get_value() -> PipelineDestinationTypeDef:
return {
"ServiceName": ...,
}
# PipelineDestinationTypeDef definition
class PipelineDestinationTypeDef(TypedDict):
ServiceName: NotRequired[str],
Endpoint: NotRequired[str],
PipelineStatusReasonTypeDef#
# PipelineStatusReasonTypeDef TypedDict usage example
from types_boto3_osis.type_defs import PipelineStatusReasonTypeDef
def get_value() -> PipelineStatusReasonTypeDef:
return {
"Description": ...,
}
# PipelineStatusReasonTypeDef definition
class PipelineStatusReasonTypeDef(TypedDict):
Description: NotRequired[str],
ServiceVpcEndpointTypeDef#
# ServiceVpcEndpointTypeDef TypedDict usage example
from types_boto3_osis.type_defs import ServiceVpcEndpointTypeDef
def get_value() -> ServiceVpcEndpointTypeDef:
return {
"ServiceName": ...,
}
# ServiceVpcEndpointTypeDef definition
class ServiceVpcEndpointTypeDef(TypedDict):
ServiceName: NotRequired[VpcEndpointServiceNameType], # (1)
VpcEndpointId: NotRequired[str],
StartPipelineRequestTypeDef#
# StartPipelineRequestTypeDef TypedDict usage example
from types_boto3_osis.type_defs import StartPipelineRequestTypeDef
def get_value() -> StartPipelineRequestTypeDef:
return {
"PipelineName": ...,
}
# StartPipelineRequestTypeDef definition
class StartPipelineRequestTypeDef(TypedDict):
PipelineName: str,
StopPipelineRequestTypeDef#
# StopPipelineRequestTypeDef TypedDict usage example
from types_boto3_osis.type_defs import StopPipelineRequestTypeDef
def get_value() -> StopPipelineRequestTypeDef:
return {
"PipelineName": ...,
}
# StopPipelineRequestTypeDef definition
class StopPipelineRequestTypeDef(TypedDict):
PipelineName: str,
UntagResourceRequestTypeDef#
# UntagResourceRequestTypeDef TypedDict usage example
from types_boto3_osis.type_defs import UntagResourceRequestTypeDef
def get_value() -> UntagResourceRequestTypeDef:
return {
"Arn": ...,
}
# UntagResourceRequestTypeDef definition
class UntagResourceRequestTypeDef(TypedDict):
Arn: str,
TagKeys: Sequence[str],
ValidatePipelineRequestTypeDef#
# ValidatePipelineRequestTypeDef TypedDict usage example
from types_boto3_osis.type_defs import ValidatePipelineRequestTypeDef
def get_value() -> ValidatePipelineRequestTypeDef:
return {
"PipelineConfigurationBody": ...,
}
# ValidatePipelineRequestTypeDef definition
class ValidatePipelineRequestTypeDef(TypedDict):
PipelineConfigurationBody: str,
ValidationMessageTypeDef#
# ValidationMessageTypeDef TypedDict usage example
from types_boto3_osis.type_defs import ValidationMessageTypeDef
def get_value() -> ValidationMessageTypeDef:
return {
"Message": ...,
}
# ValidationMessageTypeDef definition
class ValidationMessageTypeDef(TypedDict):
Message: NotRequired[str],
VpcAttachmentOptionsTypeDef#
# VpcAttachmentOptionsTypeDef TypedDict usage example
from types_boto3_osis.type_defs import VpcAttachmentOptionsTypeDef
def get_value() -> VpcAttachmentOptionsTypeDef:
return {
"AttachToVpc": ...,
}
# VpcAttachmentOptionsTypeDef definition
class VpcAttachmentOptionsTypeDef(TypedDict):
AttachToVpc: bool,
CidrBlock: NotRequired[str],
ChangeProgressStatusTypeDef#
# ChangeProgressStatusTypeDef TypedDict usage example
from types_boto3_osis.type_defs import ChangeProgressStatusTypeDef
def get_value() -> ChangeProgressStatusTypeDef:
return {
"StartTime": ...,
}
# ChangeProgressStatusTypeDef definition
class ChangeProgressStatusTypeDef(TypedDict):
StartTime: NotRequired[datetime],
Status: NotRequired[ChangeProgressStatusesType], # (1)
TotalNumberOfStages: NotRequired[int],
ChangeProgressStages: NotRequired[List[ChangeProgressStageTypeDef]], # (2)
LogPublishingOptionsTypeDef#
# LogPublishingOptionsTypeDef TypedDict usage example
from types_boto3_osis.type_defs import LogPublishingOptionsTypeDef
def get_value() -> LogPublishingOptionsTypeDef:
return {
"IsLoggingEnabled": ...,
}
# LogPublishingOptionsTypeDef definition
class LogPublishingOptionsTypeDef(TypedDict):
IsLoggingEnabled: NotRequired[bool],
CloudWatchLogDestination: NotRequired[CloudWatchLogDestinationTypeDef], # (1)
TagResourceRequestTypeDef#
# TagResourceRequestTypeDef TypedDict usage example
from types_boto3_osis.type_defs import TagResourceRequestTypeDef
def get_value() -> TagResourceRequestTypeDef:
return {
"Arn": ...,
}
# TagResourceRequestTypeDef definition
class TagResourceRequestTypeDef(TypedDict):
Arn: str,
Tags: Sequence[TagTypeDef], # (1)
- See TagTypeDef
ListTagsForResourceResponseTypeDef#
# ListTagsForResourceResponseTypeDef TypedDict usage example
from types_boto3_osis.type_defs import ListTagsForResourceResponseTypeDef
def get_value() -> ListTagsForResourceResponseTypeDef:
return {
"Tags": ...,
}
# ListTagsForResourceResponseTypeDef definition
class ListTagsForResourceResponseTypeDef(TypedDict):
Tags: List[TagTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See TagTypeDef
- See ResponseMetadataTypeDef
GetPipelineBlueprintResponseTypeDef#
# GetPipelineBlueprintResponseTypeDef TypedDict usage example
from types_boto3_osis.type_defs import GetPipelineBlueprintResponseTypeDef
def get_value() -> GetPipelineBlueprintResponseTypeDef:
return {
"Blueprint": ...,
}
# GetPipelineBlueprintResponseTypeDef definition
class GetPipelineBlueprintResponseTypeDef(TypedDict):
Blueprint: PipelineBlueprintTypeDef, # (1)
Format: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListPipelineBlueprintsResponseTypeDef#
# ListPipelineBlueprintsResponseTypeDef TypedDict usage example
from types_boto3_osis.type_defs import ListPipelineBlueprintsResponseTypeDef
def get_value() -> ListPipelineBlueprintsResponseTypeDef:
return {
"Blueprints": ...,
}
# ListPipelineBlueprintsResponseTypeDef definition
class ListPipelineBlueprintsResponseTypeDef(TypedDict):
Blueprints: List[PipelineBlueprintSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
PipelineSummaryTypeDef#
# PipelineSummaryTypeDef TypedDict usage example
from types_boto3_osis.type_defs import PipelineSummaryTypeDef
def get_value() -> PipelineSummaryTypeDef:
return {
"Status": ...,
}
# 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)
- See PipelineStatusType
- See PipelineStatusReasonTypeDef
- See PipelineDestinationTypeDef
- See TagTypeDef
ValidatePipelineResponseTypeDef#
# ValidatePipelineResponseTypeDef TypedDict usage example
from types_boto3_osis.type_defs import ValidatePipelineResponseTypeDef
def get_value() -> ValidatePipelineResponseTypeDef:
return {
"isValid": ...,
}
# ValidatePipelineResponseTypeDef definition
class ValidatePipelineResponseTypeDef(TypedDict):
isValid: bool,
Errors: List[ValidationMessageTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
VpcOptionsOutputTypeDef#
# VpcOptionsOutputTypeDef TypedDict usage example
from types_boto3_osis.type_defs import VpcOptionsOutputTypeDef
def get_value() -> VpcOptionsOutputTypeDef:
return {
"SubnetIds": ...,
}
# VpcOptionsOutputTypeDef definition
class VpcOptionsOutputTypeDef(TypedDict):
SubnetIds: List[str],
SecurityGroupIds: NotRequired[List[str]],
VpcAttachmentOptions: NotRequired[VpcAttachmentOptionsTypeDef], # (1)
VpcEndpointManagement: NotRequired[VpcEndpointManagementType], # (2)
VpcOptionsTypeDef#
# VpcOptionsTypeDef TypedDict usage example
from types_boto3_osis.type_defs import VpcOptionsTypeDef
def get_value() -> VpcOptionsTypeDef:
return {
"SubnetIds": ...,
}
# VpcOptionsTypeDef definition
class VpcOptionsTypeDef(TypedDict):
SubnetIds: Sequence[str],
SecurityGroupIds: NotRequired[Sequence[str]],
VpcAttachmentOptions: NotRequired[VpcAttachmentOptionsTypeDef], # (1)
VpcEndpointManagement: NotRequired[VpcEndpointManagementType], # (2)
GetPipelineChangeProgressResponseTypeDef#
# GetPipelineChangeProgressResponseTypeDef TypedDict usage example
from types_boto3_osis.type_defs import GetPipelineChangeProgressResponseTypeDef
def get_value() -> GetPipelineChangeProgressResponseTypeDef:
return {
"ChangeProgressStatuses": ...,
}
# GetPipelineChangeProgressResponseTypeDef definition
class GetPipelineChangeProgressResponseTypeDef(TypedDict):
ChangeProgressStatuses: List[ChangeProgressStatusTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
UpdatePipelineRequestTypeDef#
# UpdatePipelineRequestTypeDef TypedDict usage example
from types_boto3_osis.type_defs import UpdatePipelineRequestTypeDef
def get_value() -> UpdatePipelineRequestTypeDef:
return {
"PipelineName": ...,
}
# UpdatePipelineRequestTypeDef definition
class UpdatePipelineRequestTypeDef(TypedDict):
PipelineName: str,
MinUnits: NotRequired[int],
MaxUnits: NotRequired[int],
PipelineConfigurationBody: NotRequired[str],
LogPublishingOptions: NotRequired[LogPublishingOptionsTypeDef], # (1)
BufferOptions: NotRequired[BufferOptionsTypeDef], # (2)
EncryptionAtRestOptions: NotRequired[EncryptionAtRestOptionsTypeDef], # (3)
ListPipelinesResponseTypeDef#
# ListPipelinesResponseTypeDef TypedDict usage example
from types_boto3_osis.type_defs import ListPipelinesResponseTypeDef
def get_value() -> ListPipelinesResponseTypeDef:
return {
"NextToken": ...,
}
# ListPipelinesResponseTypeDef definition
class ListPipelinesResponseTypeDef(TypedDict):
Pipelines: List[PipelineSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],
VpcEndpointTypeDef#
# VpcEndpointTypeDef TypedDict usage example
from types_boto3_osis.type_defs import VpcEndpointTypeDef
def get_value() -> VpcEndpointTypeDef:
return {
"VpcEndpointId": ...,
}
# VpcEndpointTypeDef definition
class VpcEndpointTypeDef(TypedDict):
VpcEndpointId: NotRequired[str],
VpcId: NotRequired[str],
VpcOptions: NotRequired[VpcOptionsOutputTypeDef], # (1)
PipelineTypeDef#
# PipelineTypeDef TypedDict usage example
from types_boto3_osis.type_defs import PipelineTypeDef
def get_value() -> PipelineTypeDef:
return {
"PipelineName": ...,
}
# 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)
- See PipelineStatusType
- See PipelineStatusReasonTypeDef
- See LogPublishingOptionsTypeDef
- See VpcEndpointTypeDef
- See BufferOptionsTypeDef
- See EncryptionAtRestOptionsTypeDef
- See ServiceVpcEndpointTypeDef
- See PipelineDestinationTypeDef
- See TagTypeDef
CreatePipelineRequestTypeDef#
# CreatePipelineRequestTypeDef TypedDict usage example
from types_boto3_osis.type_defs import CreatePipelineRequestTypeDef
def get_value() -> CreatePipelineRequestTypeDef:
return {
"PipelineName": ...,
}
# CreatePipelineRequestTypeDef definition
class CreatePipelineRequestTypeDef(TypedDict):
PipelineName: str,
MinUnits: int,
MaxUnits: int,
PipelineConfigurationBody: str,
LogPublishingOptions: NotRequired[LogPublishingOptionsTypeDef], # (1)
VpcOptions: NotRequired[VpcOptionsUnionTypeDef], # (2)
BufferOptions: NotRequired[BufferOptionsTypeDef], # (3)
EncryptionAtRestOptions: NotRequired[EncryptionAtRestOptionsTypeDef], # (4)
Tags: NotRequired[Sequence[TagTypeDef]], # (5)
- See LogPublishingOptionsTypeDef
- See VpcOptionsTypeDef VpcOptionsOutputTypeDef
- See BufferOptionsTypeDef
- See EncryptionAtRestOptionsTypeDef
- See TagTypeDef
CreatePipelineResponseTypeDef#
# CreatePipelineResponseTypeDef TypedDict usage example
from types_boto3_osis.type_defs import CreatePipelineResponseTypeDef
def get_value() -> CreatePipelineResponseTypeDef:
return {
"Pipeline": ...,
}
# CreatePipelineResponseTypeDef definition
class CreatePipelineResponseTypeDef(TypedDict):
Pipeline: PipelineTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetPipelineResponseTypeDef#
# GetPipelineResponseTypeDef TypedDict usage example
from types_boto3_osis.type_defs import GetPipelineResponseTypeDef
def get_value() -> GetPipelineResponseTypeDef:
return {
"Pipeline": ...,
}
# GetPipelineResponseTypeDef definition
class GetPipelineResponseTypeDef(TypedDict):
Pipeline: PipelineTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
StartPipelineResponseTypeDef#
# StartPipelineResponseTypeDef TypedDict usage example
from types_boto3_osis.type_defs import StartPipelineResponseTypeDef
def get_value() -> StartPipelineResponseTypeDef:
return {
"Pipeline": ...,
}
# StartPipelineResponseTypeDef definition
class StartPipelineResponseTypeDef(TypedDict):
Pipeline: PipelineTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
StopPipelineResponseTypeDef#
# StopPipelineResponseTypeDef TypedDict usage example
from types_boto3_osis.type_defs import StopPipelineResponseTypeDef
def get_value() -> StopPipelineResponseTypeDef:
return {
"Pipeline": ...,
}
# StopPipelineResponseTypeDef definition
class StopPipelineResponseTypeDef(TypedDict):
Pipeline: PipelineTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
UpdatePipelineResponseTypeDef#
# UpdatePipelineResponseTypeDef TypedDict usage example
from types_boto3_osis.type_defs import UpdatePipelineResponseTypeDef
def get_value() -> UpdatePipelineResponseTypeDef:
return {
"Pipeline": ...,
}
# UpdatePipelineResponseTypeDef definition
class UpdatePipelineResponseTypeDef(TypedDict):
Pipeline: PipelineTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)