Type definitions#
Index > OpenSearchIngestion > Type definitions
Auto-generated documentation for OpenSearchIngestion type annotations stubs module mypy-boto3-osis.
ChangeProgressStageTypeDef#
# ChangeProgressStageTypeDef definition
class ChangeProgressStageTypeDef(TypedDict):
Name: NotRequired[str],
Status: NotRequired[ChangeProgressStageStatusesType], # (1)
Description: NotRequired[str],
LastUpdatedAt: NotRequired[datetime],
CloudWatchLogDestinationTypeDef#
# CloudWatchLogDestinationTypeDef definition
class CloudWatchLogDestinationTypeDef(TypedDict):
LogGroup: str,
TagTypeDef#
# TagTypeDef definition
class TagTypeDef(TypedDict):
Key: str,
Value: str,
VpcOptionsTypeDef#
# VpcOptionsTypeDef definition
class VpcOptionsTypeDef(TypedDict):
SubnetIds: Sequence[str],
SecurityGroupIds: NotRequired[Sequence[str]],
ResponseMetadataTypeDef#
# ResponseMetadataTypeDef definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HostId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
DeletePipelineRequestRequestTypeDef#
# DeletePipelineRequestRequestTypeDef definition
class DeletePipelineRequestRequestTypeDef(TypedDict):
PipelineName: str,
GetPipelineBlueprintRequestRequestTypeDef#
# GetPipelineBlueprintRequestRequestTypeDef definition
class GetPipelineBlueprintRequestRequestTypeDef(TypedDict):
BlueprintName: str,
PipelineBlueprintTypeDef#
# PipelineBlueprintTypeDef definition
class PipelineBlueprintTypeDef(TypedDict):
BlueprintName: NotRequired[str],
PipelineConfigurationBody: 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],
ListPipelinesRequestRequestTypeDef#
# ListPipelinesRequestRequestTypeDef definition
class ListPipelinesRequestRequestTypeDef(TypedDict):
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
ListTagsForResourceRequestRequestTypeDef#
# ListTagsForResourceRequestRequestTypeDef definition
class ListTagsForResourceRequestRequestTypeDef(TypedDict):
Arn: str,
PipelineStatusReasonTypeDef#
# PipelineStatusReasonTypeDef definition
class PipelineStatusReasonTypeDef(TypedDict):
Description: NotRequired[str],
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],
ChangeProgressStatusTypeDef#
# ChangeProgressStatusTypeDef definition
class ChangeProgressStatusTypeDef(TypedDict):
StartTime: NotRequired[datetime],
Status: NotRequired[ChangeProgressStatusesType], # (1)
TotalNumberOfStages: NotRequired[int],
ChangeProgressStages: NotRequired[List[ChangeProgressStageTypeDef]], # (2)
LogPublishingOptionsTypeDef#
# LogPublishingOptionsTypeDef definition
class LogPublishingOptionsTypeDef(TypedDict):
IsLoggingEnabled: NotRequired[bool],
CloudWatchLogDestination: NotRequired[CloudWatchLogDestinationTypeDef], # (1)
TagResourceRequestRequestTypeDef#
# TagResourceRequestRequestTypeDef definition
class TagResourceRequestRequestTypeDef(TypedDict):
Arn: str,
Tags: Sequence[TagTypeDef], # (1)
- See TagTypeDef
VpcEndpointTypeDef#
# VpcEndpointTypeDef definition
class VpcEndpointTypeDef(TypedDict):
VpcEndpointId: NotRequired[str],
VpcId: NotRequired[str],
VpcOptions: NotRequired[VpcOptionsTypeDef], # (1)
ListTagsForResourceResponseTypeDef#
# ListTagsForResourceResponseTypeDef definition
class ListTagsForResourceResponseTypeDef(TypedDict):
Tags: List[TagTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See TagTypeDef
- See ResponseMetadataTypeDef
GetPipelineBlueprintResponseTypeDef#
# GetPipelineBlueprintResponseTypeDef definition
class GetPipelineBlueprintResponseTypeDef(TypedDict):
Blueprint: PipelineBlueprintTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListPipelineBlueprintsResponseTypeDef#
# ListPipelineBlueprintsResponseTypeDef definition
class ListPipelineBlueprintsResponseTypeDef(TypedDict):
Blueprints: List[PipelineBlueprintSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
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],
ValidatePipelineResponseTypeDef#
# ValidatePipelineResponseTypeDef definition
class ValidatePipelineResponseTypeDef(TypedDict):
isValid: bool,
Errors: List[ValidationMessageTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetPipelineChangeProgressResponseTypeDef#
# GetPipelineChangeProgressResponseTypeDef definition
class GetPipelineChangeProgressResponseTypeDef(TypedDict):
ChangeProgressStatuses: List[ChangeProgressStatusTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreatePipelineRequestRequestTypeDef#
# CreatePipelineRequestRequestTypeDef definition
class CreatePipelineRequestRequestTypeDef(TypedDict):
PipelineName: str,
MinUnits: int,
MaxUnits: int,
PipelineConfigurationBody: str,
LogPublishingOptions: NotRequired[LogPublishingOptionsTypeDef], # (1)
VpcOptions: NotRequired[VpcOptionsTypeDef], # (2)
Tags: NotRequired[Sequence[TagTypeDef]], # (3)
- See LogPublishingOptionsTypeDef
- See VpcOptionsTypeDef
- See TagTypeDef
UpdatePipelineRequestRequestTypeDef#
# UpdatePipelineRequestRequestTypeDef definition
class UpdatePipelineRequestRequestTypeDef(TypedDict):
PipelineName: str,
MinUnits: NotRequired[int],
MaxUnits: NotRequired[int],
PipelineConfigurationBody: NotRequired[str],
LogPublishingOptions: NotRequired[LogPublishingOptionsTypeDef], # (1)
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)
- See PipelineStatusType
- See PipelineStatusReasonTypeDef
- See LogPublishingOptionsTypeDef
- See VpcEndpointTypeDef
ListPipelinesResponseTypeDef#
# ListPipelinesResponseTypeDef definition
class ListPipelinesResponseTypeDef(TypedDict):
NextToken: str,
Pipelines: List[PipelineSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreatePipelineResponseTypeDef#
# CreatePipelineResponseTypeDef definition
class CreatePipelineResponseTypeDef(TypedDict):
Pipeline: PipelineTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetPipelineResponseTypeDef#
# GetPipelineResponseTypeDef definition
class GetPipelineResponseTypeDef(TypedDict):
Pipeline: PipelineTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
StartPipelineResponseTypeDef#
# StartPipelineResponseTypeDef definition
class StartPipelineResponseTypeDef(TypedDict):
Pipeline: PipelineTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
StopPipelineResponseTypeDef#
# StopPipelineResponseTypeDef definition
class StopPipelineResponseTypeDef(TypedDict):
Pipeline: PipelineTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
UpdatePipelineResponseTypeDef#
# UpdatePipelineResponseTypeDef definition
class UpdatePipelineResponseTypeDef(TypedDict):
Pipeline: PipelineTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)