Skip to content

Type definitions#

Index > OpenSearchIngestion > Type definitions

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

PipelineEndpointVpcOptionsUnionTypeDef#

# PipelineEndpointVpcOptionsUnionTypeDef Union usage example

from types_boto3_osis.type_defs import PipelineEndpointVpcOptionsUnionTypeDef


def get_value() -> PipelineEndpointVpcOptionsUnionTypeDef:
    return ...


# PipelineEndpointVpcOptionsUnionTypeDef definition

PipelineEndpointVpcOptionsUnionTypeDef = Union[
    PipelineEndpointVpcOptionsTypeDef,  # (1)
    PipelineEndpointVpcOptionsOutputTypeDef,  # (2)
]
  1. See PipelineEndpointVpcOptionsTypeDef
  2. See PipelineEndpointVpcOptionsOutputTypeDef

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)
]
  1. See VpcOptionsTypeDef
  2. See VpcOptionsOutputTypeDef

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.datetime],
  1. See ChangeProgressStageStatusesType

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,

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],

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,

DeletePipelineEndpointRequestTypeDef#

# DeletePipelineEndpointRequestTypeDef TypedDict usage example

from types_boto3_osis.type_defs import DeletePipelineEndpointRequestTypeDef


def get_value() -> DeletePipelineEndpointRequestTypeDef:
    return {
        "EndpointId": ...,
    }


# DeletePipelineEndpointRequestTypeDef definition

class DeletePipelineEndpointRequestTypeDef(TypedDict):
    EndpointId: 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,

DeleteResourcePolicyRequestTypeDef#

# DeleteResourcePolicyRequestTypeDef TypedDict usage example

from types_boto3_osis.type_defs import DeleteResourcePolicyRequestTypeDef


def get_value() -> DeleteResourcePolicyRequestTypeDef:
    return {
        "ResourceArn": ...,
    }


# DeleteResourcePolicyRequestTypeDef definition

class DeleteResourcePolicyRequestTypeDef(TypedDict):
    ResourceArn: 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,

GetResourcePolicyRequestTypeDef#

# GetResourcePolicyRequestTypeDef TypedDict usage example

from types_boto3_osis.type_defs import GetResourcePolicyRequestTypeDef


def get_value() -> GetResourcePolicyRequestTypeDef:
    return {
        "ResourceArn": ...,
    }


# GetResourcePolicyRequestTypeDef definition

class GetResourcePolicyRequestTypeDef(TypedDict):
    ResourceArn: 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],

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef TypedDict usage example

from types_boto3_osis.type_defs import PaginatorConfigTypeDef


def get_value() -> PaginatorConfigTypeDef:
    return {
        "MaxItems": ...,
    }


# PaginatorConfigTypeDef definition

class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

ListPipelineEndpointConnectionsRequestTypeDef#

# ListPipelineEndpointConnectionsRequestTypeDef TypedDict usage example

from types_boto3_osis.type_defs import ListPipelineEndpointConnectionsRequestTypeDef


def get_value() -> ListPipelineEndpointConnectionsRequestTypeDef:
    return {
        "MaxResults": ...,
    }


# ListPipelineEndpointConnectionsRequestTypeDef definition

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

PipelineEndpointConnectionTypeDef#

# PipelineEndpointConnectionTypeDef TypedDict usage example

from types_boto3_osis.type_defs import PipelineEndpointConnectionTypeDef


def get_value() -> PipelineEndpointConnectionTypeDef:
    return {
        "PipelineArn": ...,
    }


# PipelineEndpointConnectionTypeDef definition

class PipelineEndpointConnectionTypeDef(TypedDict):
    PipelineArn: NotRequired[str],
    EndpointId: NotRequired[str],
    Status: NotRequired[PipelineEndpointStatusType],  # (1)
    VpcEndpointOwner: NotRequired[str],
  1. See PipelineEndpointStatusType

ListPipelineEndpointsRequestTypeDef#

# ListPipelineEndpointsRequestTypeDef TypedDict usage example

from types_boto3_osis.type_defs import ListPipelineEndpointsRequestTypeDef


def get_value() -> ListPipelineEndpointsRequestTypeDef:
    return {
        "MaxResults": ...,
    }


# ListPipelineEndpointsRequestTypeDef definition

class ListPipelineEndpointsRequestTypeDef(TypedDict):
    MaxResults: NotRequired[int],
    NextToken: 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],

PipelineEndpointVpcOptionsOutputTypeDef#

# PipelineEndpointVpcOptionsOutputTypeDef TypedDict usage example

from types_boto3_osis.type_defs import PipelineEndpointVpcOptionsOutputTypeDef


def get_value() -> PipelineEndpointVpcOptionsOutputTypeDef:
    return {
        "SubnetIds": ...,
    }


# PipelineEndpointVpcOptionsOutputTypeDef definition

class PipelineEndpointVpcOptionsOutputTypeDef(TypedDict):
    SubnetIds: NotRequired[List[str]],
    SecurityGroupIds: NotRequired[List[str]],

PipelineEndpointVpcOptionsTypeDef#

# PipelineEndpointVpcOptionsTypeDef TypedDict usage example

from types_boto3_osis.type_defs import PipelineEndpointVpcOptionsTypeDef


def get_value() -> PipelineEndpointVpcOptionsTypeDef:
    return {
        "SubnetIds": ...,
    }


# PipelineEndpointVpcOptionsTypeDef definition

class PipelineEndpointVpcOptionsTypeDef(TypedDict):
    SubnetIds: NotRequired[Sequence[str]],
    SecurityGroupIds: NotRequired[Sequence[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],
  1. See VpcEndpointServiceNameType

PutResourcePolicyRequestTypeDef#

# PutResourcePolicyRequestTypeDef TypedDict usage example

from types_boto3_osis.type_defs import PutResourcePolicyRequestTypeDef


def get_value() -> PutResourcePolicyRequestTypeDef:
    return {
        "ResourceArn": ...,
    }


# PutResourcePolicyRequestTypeDef definition

class PutResourcePolicyRequestTypeDef(TypedDict):
    ResourceArn: str,
    Policy: str,

RevokePipelineEndpointConnectionsRequestTypeDef#

# RevokePipelineEndpointConnectionsRequestTypeDef TypedDict usage example

from types_boto3_osis.type_defs import RevokePipelineEndpointConnectionsRequestTypeDef


def get_value() -> RevokePipelineEndpointConnectionsRequestTypeDef:
    return {
        "PipelineArn": ...,
    }


# RevokePipelineEndpointConnectionsRequestTypeDef definition

class RevokePipelineEndpointConnectionsRequestTypeDef(TypedDict):
    PipelineArn: str,
    EndpointIds: Sequence[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.datetime],
    Status: NotRequired[ChangeProgressStatusesType],  # (1)
    TotalNumberOfStages: NotRequired[int],
    ChangeProgressStages: NotRequired[List[ChangeProgressStageTypeDef]],  # (2)
  1. See ChangeProgressStatusesType
  2. See List[ChangeProgressStageTypeDef]

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)
  1. See CloudWatchLogDestinationTypeDef

CreatePipelineEndpointResponseTypeDef#

# CreatePipelineEndpointResponseTypeDef TypedDict usage example

from types_boto3_osis.type_defs import CreatePipelineEndpointResponseTypeDef


def get_value() -> CreatePipelineEndpointResponseTypeDef:
    return {
        "PipelineArn": ...,
    }


# CreatePipelineEndpointResponseTypeDef definition

class CreatePipelineEndpointResponseTypeDef(TypedDict):
    PipelineArn: str,
    EndpointId: str,
    Status: PipelineEndpointStatusType,  # (1)
    VpcId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See PipelineEndpointStatusType
  2. See ResponseMetadataTypeDef

GetResourcePolicyResponseTypeDef#

# GetResourcePolicyResponseTypeDef TypedDict usage example

from types_boto3_osis.type_defs import GetResourcePolicyResponseTypeDef


def get_value() -> GetResourcePolicyResponseTypeDef:
    return {
        "ResourceArn": ...,
    }


# GetResourcePolicyResponseTypeDef definition

class GetResourcePolicyResponseTypeDef(TypedDict):
    ResourceArn: str,
    Policy: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

PutResourcePolicyResponseTypeDef#

# PutResourcePolicyResponseTypeDef TypedDict usage example

from types_boto3_osis.type_defs import PutResourcePolicyResponseTypeDef


def get_value() -> PutResourcePolicyResponseTypeDef:
    return {
        "ResourceArn": ...,
    }


# PutResourcePolicyResponseTypeDef definition

class PutResourcePolicyResponseTypeDef(TypedDict):
    ResourceArn: str,
    Policy: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

RevokePipelineEndpointConnectionsResponseTypeDef#

# RevokePipelineEndpointConnectionsResponseTypeDef TypedDict usage example

from types_boto3_osis.type_defs import RevokePipelineEndpointConnectionsResponseTypeDef


def get_value() -> RevokePipelineEndpointConnectionsResponseTypeDef:
    return {
        "PipelineArn": ...,
    }


# RevokePipelineEndpointConnectionsResponseTypeDef definition

class RevokePipelineEndpointConnectionsResponseTypeDef(TypedDict):
    PipelineArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

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)
  1. See List[TagTypeDef]
  2. See ResponseMetadataTypeDef

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)
  1. See Sequence[TagTypeDef]

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)
  1. See PipelineBlueprintTypeDef
  2. See ResponseMetadataTypeDef

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)
  1. See List[PipelineBlueprintSummaryTypeDef]
  2. See ResponseMetadataTypeDef

ListPipelineEndpointConnectionsRequestPaginateTypeDef#

# ListPipelineEndpointConnectionsRequestPaginateTypeDef TypedDict usage example

from types_boto3_osis.type_defs import ListPipelineEndpointConnectionsRequestPaginateTypeDef


def get_value() -> ListPipelineEndpointConnectionsRequestPaginateTypeDef:
    return {
        "PaginationConfig": ...,
    }


# ListPipelineEndpointConnectionsRequestPaginateTypeDef definition

class ListPipelineEndpointConnectionsRequestPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListPipelineEndpointsRequestPaginateTypeDef#

# ListPipelineEndpointsRequestPaginateTypeDef TypedDict usage example

from types_boto3_osis.type_defs import ListPipelineEndpointsRequestPaginateTypeDef


def get_value() -> ListPipelineEndpointsRequestPaginateTypeDef:
    return {
        "PaginationConfig": ...,
    }


# ListPipelineEndpointsRequestPaginateTypeDef definition

class ListPipelineEndpointsRequestPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListPipelineEndpointConnectionsResponseTypeDef#

# ListPipelineEndpointConnectionsResponseTypeDef TypedDict usage example

from types_boto3_osis.type_defs import ListPipelineEndpointConnectionsResponseTypeDef


def get_value() -> ListPipelineEndpointConnectionsResponseTypeDef:
    return {
        "NextToken": ...,
    }


# ListPipelineEndpointConnectionsResponseTypeDef definition

class ListPipelineEndpointConnectionsResponseTypeDef(TypedDict):
    PipelineEndpointConnections: List[PipelineEndpointConnectionTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See List[PipelineEndpointConnectionTypeDef]
  2. See ResponseMetadataTypeDef

PipelineEndpointTypeDef#

# PipelineEndpointTypeDef TypedDict usage example

from types_boto3_osis.type_defs import PipelineEndpointTypeDef


def get_value() -> PipelineEndpointTypeDef:
    return {
        "PipelineArn": ...,
    }


# PipelineEndpointTypeDef definition

class PipelineEndpointTypeDef(TypedDict):
    PipelineArn: NotRequired[str],
    EndpointId: NotRequired[str],
    Status: NotRequired[PipelineEndpointStatusType],  # (1)
    VpcId: NotRequired[str],
    VpcOptions: NotRequired[PipelineEndpointVpcOptionsOutputTypeDef],  # (2)
    IngestEndpointUrl: NotRequired[str],
  1. See PipelineEndpointStatusType
  2. See PipelineEndpointVpcOptionsOutputTypeDef

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.datetime],
    LastUpdatedAt: NotRequired[datetime.datetime],
    Destinations: NotRequired[List[PipelineDestinationTypeDef]],  # (3)
    Tags: NotRequired[List[TagTypeDef]],  # (4)
  1. See PipelineStatusType
  2. See PipelineStatusReasonTypeDef
  3. See List[PipelineDestinationTypeDef]
  4. See List[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)
  1. See List[ValidationMessageTypeDef]
  2. See ResponseMetadataTypeDef

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)
  1. See VpcAttachmentOptionsTypeDef
  2. See VpcEndpointManagementType

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)
  1. See VpcAttachmentOptionsTypeDef
  2. See VpcEndpointManagementType

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)
  1. See List[ChangeProgressStatusTypeDef]
  2. See ResponseMetadataTypeDef

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)
    PipelineRoleArn: NotRequired[str],
  1. See LogPublishingOptionsTypeDef
  2. See BufferOptionsTypeDef
  3. See EncryptionAtRestOptionsTypeDef

ListPipelineEndpointsResponseTypeDef#

# ListPipelineEndpointsResponseTypeDef TypedDict usage example

from types_boto3_osis.type_defs import ListPipelineEndpointsResponseTypeDef


def get_value() -> ListPipelineEndpointsResponseTypeDef:
    return {
        "NextToken": ...,
    }


# ListPipelineEndpointsResponseTypeDef definition

class ListPipelineEndpointsResponseTypeDef(TypedDict):
    PipelineEndpoints: List[PipelineEndpointTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See List[PipelineEndpointTypeDef]
  2. See ResponseMetadataTypeDef

CreatePipelineEndpointRequestTypeDef#

# CreatePipelineEndpointRequestTypeDef TypedDict usage example

from types_boto3_osis.type_defs import CreatePipelineEndpointRequestTypeDef


def get_value() -> CreatePipelineEndpointRequestTypeDef:
    return {
        "PipelineArn": ...,
    }


# CreatePipelineEndpointRequestTypeDef definition

class CreatePipelineEndpointRequestTypeDef(TypedDict):
    PipelineArn: str,
    VpcOptions: PipelineEndpointVpcOptionsUnionTypeDef,  # (1)
  1. See PipelineEndpointVpcOptionsUnionTypeDef

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],
  1. See List[PipelineSummaryTypeDef]
  2. See ResponseMetadataTypeDef

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)
  1. See VpcOptionsOutputTypeDef

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.datetime],
    LastUpdatedAt: NotRequired[datetime.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)
    PipelineRoleArn: NotRequired[str],
  1. See PipelineStatusType
  2. See PipelineStatusReasonTypeDef
  3. See LogPublishingOptionsTypeDef
  4. See List[VpcEndpointTypeDef]
  5. See BufferOptionsTypeDef
  6. See EncryptionAtRestOptionsTypeDef
  7. See List[ServiceVpcEndpointTypeDef]
  8. See List[PipelineDestinationTypeDef]
  9. See List[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)
    PipelineRoleArn: NotRequired[str],
  1. See LogPublishingOptionsTypeDef
  2. See VpcOptionsUnionTypeDef
  3. See BufferOptionsTypeDef
  4. See EncryptionAtRestOptionsTypeDef
  5. See Sequence[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)
  1. See PipelineTypeDef
  2. See ResponseMetadataTypeDef

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)
  1. See PipelineTypeDef
  2. See ResponseMetadataTypeDef

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)
  1. See PipelineTypeDef
  2. See ResponseMetadataTypeDef

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)
  1. See PipelineTypeDef
  2. See ResponseMetadataTypeDef

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)
  1. See PipelineTypeDef
  2. See ResponseMetadataTypeDef