Skip to content

OpenSearchIngestionClient#

Index > OpenSearchIngestion > OpenSearchIngestionClient

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

OpenSearchIngestionClient#

Type annotations and code completion for boto3.client("osis"). boto3 documentation

# OpenSearchIngestionClient usage example

from boto3.session import Session
from types_boto3_osis.client import OpenSearchIngestionClient

def get_osis_client() -> OpenSearchIngestionClient:
    return Session().client("osis")

Exceptions#

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("osis").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("osis")

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.ClientError,
    client.exceptions.ConflictException,
    client.exceptions.DisabledOperationException,
    client.exceptions.InternalException,
    client.exceptions.InvalidPaginationTokenException,
    client.exceptions.LimitExceededException,
    client.exceptions.ResourceAlreadyExistsException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ValidationException,
) as e:
    print(e)
# Exceptions.exceptions type checking example

from types_boto3_osis.client import Exceptions

def handle_error(exc: Exceptions.AccessDeniedException) -> None:
    ...

Methods#

can_paginate#

Type annotations and code completion for boto3.client("osis").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

generate_presigned_url#

Type annotations and code completion for boto3.client("osis").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

create_pipeline#

Creates an OpenSearch Ingestion pipeline.

Type annotations and code completion for boto3.client("osis").create_pipeline method. boto3 documentation

# create_pipeline method definition

def create_pipeline(
    self,
    *,
    PipelineName: str,
    MinUnits: int,
    MaxUnits: int,
    PipelineConfigurationBody: str,
    LogPublishingOptions: LogPublishingOptionsTypeDef = ...,  # (1)
    VpcOptions: VpcOptionsUnionTypeDef = ...,  # (2)
    BufferOptions: BufferOptionsTypeDef = ...,  # (3)
    EncryptionAtRestOptions: EncryptionAtRestOptionsTypeDef = ...,  # (4)
    Tags: Sequence[TagTypeDef] = ...,  # (5)
    PipelineRoleArn: str = ...,
) -> CreatePipelineResponseTypeDef:  # (6)
    ...
  1. See LogPublishingOptionsTypeDef
  2. See VpcOptionsUnionTypeDef
  3. See BufferOptionsTypeDef
  4. See EncryptionAtRestOptionsTypeDef
  5. See Sequence[TagTypeDef]
  6. See CreatePipelineResponseTypeDef
# create_pipeline method usage example with argument unpacking

kwargs: CreatePipelineRequestTypeDef = {  # (1)
    "PipelineName": ...,
    "MinUnits": ...,
    "MaxUnits": ...,
    "PipelineConfigurationBody": ...,
}

parent.create_pipeline(**kwargs)
  1. See CreatePipelineRequestTypeDef

create_pipeline_endpoint#

Creates a VPC endpoint for an OpenSearch Ingestion pipeline.

Type annotations and code completion for boto3.client("osis").create_pipeline_endpoint method. boto3 documentation

# create_pipeline_endpoint method definition

def create_pipeline_endpoint(
    self,
    *,
    PipelineArn: str,
    VpcOptions: PipelineEndpointVpcOptionsUnionTypeDef,  # (1)
) -> CreatePipelineEndpointResponseTypeDef:  # (2)
    ...
  1. See PipelineEndpointVpcOptionsUnionTypeDef
  2. See CreatePipelineEndpointResponseTypeDef
# create_pipeline_endpoint method usage example with argument unpacking

kwargs: CreatePipelineEndpointRequestTypeDef = {  # (1)
    "PipelineArn": ...,
    "VpcOptions": ...,
}

parent.create_pipeline_endpoint(**kwargs)
  1. See CreatePipelineEndpointRequestTypeDef

delete_pipeline#

Deletes an OpenSearch Ingestion pipeline.

Type annotations and code completion for boto3.client("osis").delete_pipeline method. boto3 documentation

# delete_pipeline method definition

def delete_pipeline(
    self,
    *,
    PipelineName: str,
) -> Dict[str, Any]:
    ...
# delete_pipeline method usage example with argument unpacking

kwargs: DeletePipelineRequestTypeDef = {  # (1)
    "PipelineName": ...,
}

parent.delete_pipeline(**kwargs)
  1. See DeletePipelineRequestTypeDef

delete_pipeline_endpoint#

Deletes a VPC endpoint for an OpenSearch Ingestion pipeline.

Type annotations and code completion for boto3.client("osis").delete_pipeline_endpoint method. boto3 documentation

# delete_pipeline_endpoint method definition

def delete_pipeline_endpoint(
    self,
    *,
    EndpointId: str,
) -> Dict[str, Any]:
    ...
# delete_pipeline_endpoint method usage example with argument unpacking

kwargs: DeletePipelineEndpointRequestTypeDef = {  # (1)
    "EndpointId": ...,
}

parent.delete_pipeline_endpoint(**kwargs)
  1. See DeletePipelineEndpointRequestTypeDef

delete_resource_policy#

Deletes a resource-based policy from an OpenSearch Ingestion resource.

Type annotations and code completion for boto3.client("osis").delete_resource_policy method. boto3 documentation

# delete_resource_policy method definition

def delete_resource_policy(
    self,
    *,
    ResourceArn: str,
) -> Dict[str, Any]:
    ...
# delete_resource_policy method usage example with argument unpacking

kwargs: DeleteResourcePolicyRequestTypeDef = {  # (1)
    "ResourceArn": ...,
}

parent.delete_resource_policy(**kwargs)
  1. See DeleteResourcePolicyRequestTypeDef

get_pipeline#

Retrieves information about an OpenSearch Ingestion pipeline.

Type annotations and code completion for boto3.client("osis").get_pipeline method. boto3 documentation

# get_pipeline method definition

def get_pipeline(
    self,
    *,
    PipelineName: str,
) -> GetPipelineResponseTypeDef:  # (1)
    ...
  1. See GetPipelineResponseTypeDef
# get_pipeline method usage example with argument unpacking

kwargs: GetPipelineRequestTypeDef = {  # (1)
    "PipelineName": ...,
}

parent.get_pipeline(**kwargs)
  1. See GetPipelineRequestTypeDef

get_pipeline_blueprint#

Retrieves information about a specific blueprint for OpenSearch Ingestion.

Type annotations and code completion for boto3.client("osis").get_pipeline_blueprint method. boto3 documentation

# get_pipeline_blueprint method definition

def get_pipeline_blueprint(
    self,
    *,
    BlueprintName: str,
    Format: str = ...,
) -> GetPipelineBlueprintResponseTypeDef:  # (1)
    ...
  1. See GetPipelineBlueprintResponseTypeDef
# get_pipeline_blueprint method usage example with argument unpacking

kwargs: GetPipelineBlueprintRequestTypeDef = {  # (1)
    "BlueprintName": ...,
}

parent.get_pipeline_blueprint(**kwargs)
  1. See GetPipelineBlueprintRequestTypeDef

get_pipeline_change_progress#

Returns progress information for the current change happening on an OpenSearch Ingestion pipeline.

Type annotations and code completion for boto3.client("osis").get_pipeline_change_progress method. boto3 documentation

# get_pipeline_change_progress method definition

def get_pipeline_change_progress(
    self,
    *,
    PipelineName: str,
) -> GetPipelineChangeProgressResponseTypeDef:  # (1)
    ...
  1. See GetPipelineChangeProgressResponseTypeDef
# get_pipeline_change_progress method usage example with argument unpacking

kwargs: GetPipelineChangeProgressRequestTypeDef = {  # (1)
    "PipelineName": ...,
}

parent.get_pipeline_change_progress(**kwargs)
  1. See GetPipelineChangeProgressRequestTypeDef

get_resource_policy#

Retrieves the resource-based policy attached to an OpenSearch Ingestion resource.

Type annotations and code completion for boto3.client("osis").get_resource_policy method. boto3 documentation

# get_resource_policy method definition

def get_resource_policy(
    self,
    *,
    ResourceArn: str,
) -> GetResourcePolicyResponseTypeDef:  # (1)
    ...
  1. See GetResourcePolicyResponseTypeDef
# get_resource_policy method usage example with argument unpacking

kwargs: GetResourcePolicyRequestTypeDef = {  # (1)
    "ResourceArn": ...,
}

parent.get_resource_policy(**kwargs)
  1. See GetResourcePolicyRequestTypeDef

list_pipeline_blueprints#

Retrieves a list of all available blueprints for Data Prepper.

Type annotations and code completion for boto3.client("osis").list_pipeline_blueprints method. boto3 documentation

# list_pipeline_blueprints method definition

def list_pipeline_blueprints(
    self,
) -> ListPipelineBlueprintsResponseTypeDef:  # (1)
    ...
  1. See ListPipelineBlueprintsResponseTypeDef

list_pipeline_endpoint_connections#

Lists the pipeline endpoints connected to pipelines in your account.

Type annotations and code completion for boto3.client("osis").list_pipeline_endpoint_connections method. boto3 documentation

# list_pipeline_endpoint_connections method definition

def list_pipeline_endpoint_connections(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListPipelineEndpointConnectionsResponseTypeDef:  # (1)
    ...
  1. See ListPipelineEndpointConnectionsResponseTypeDef
# list_pipeline_endpoint_connections method usage example with argument unpacking

kwargs: ListPipelineEndpointConnectionsRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.list_pipeline_endpoint_connections(**kwargs)
  1. See ListPipelineEndpointConnectionsRequestTypeDef

list_pipeline_endpoints#

Lists all pipeline endpoints in your account.

Type annotations and code completion for boto3.client("osis").list_pipeline_endpoints method. boto3 documentation

# list_pipeline_endpoints method definition

def list_pipeline_endpoints(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListPipelineEndpointsResponseTypeDef:  # (1)
    ...
  1. See ListPipelineEndpointsResponseTypeDef
# list_pipeline_endpoints method usage example with argument unpacking

kwargs: ListPipelineEndpointsRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.list_pipeline_endpoints(**kwargs)
  1. See ListPipelineEndpointsRequestTypeDef

list_pipelines#

Lists all OpenSearch Ingestion pipelines in the current Amazon Web Services account and Region.

Type annotations and code completion for boto3.client("osis").list_pipelines method. boto3 documentation

# list_pipelines method definition

def list_pipelines(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListPipelinesResponseTypeDef:  # (1)
    ...
  1. See ListPipelinesResponseTypeDef
# list_pipelines method usage example with argument unpacking

kwargs: ListPipelinesRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.list_pipelines(**kwargs)
  1. See ListPipelinesRequestTypeDef

list_tags_for_resource#

Lists all resource tags associated with an OpenSearch Ingestion pipeline.

Type annotations and code completion for boto3.client("osis").list_tags_for_resource method. boto3 documentation

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    Arn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...
  1. See ListTagsForResourceResponseTypeDef
# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceRequestTypeDef = {  # (1)
    "Arn": ...,
}

parent.list_tags_for_resource(**kwargs)
  1. See ListTagsForResourceRequestTypeDef

put_resource_policy#

Attaches a resource-based policy to an OpenSearch Ingestion resource.

Type annotations and code completion for boto3.client("osis").put_resource_policy method. boto3 documentation

# put_resource_policy method definition

def put_resource_policy(
    self,
    *,
    ResourceArn: str,
    Policy: str,
) -> PutResourcePolicyResponseTypeDef:  # (1)
    ...
  1. See PutResourcePolicyResponseTypeDef
# put_resource_policy method usage example with argument unpacking

kwargs: PutResourcePolicyRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "Policy": ...,
}

parent.put_resource_policy(**kwargs)
  1. See PutResourcePolicyRequestTypeDef

revoke_pipeline_endpoint_connections#

Revokes pipeline endpoints from specified endpoint IDs.

Type annotations and code completion for boto3.client("osis").revoke_pipeline_endpoint_connections method. boto3 documentation

# revoke_pipeline_endpoint_connections method definition

def revoke_pipeline_endpoint_connections(
    self,
    *,
    PipelineArn: str,
    EndpointIds: Sequence[str],
) -> RevokePipelineEndpointConnectionsResponseTypeDef:  # (1)
    ...
  1. See RevokePipelineEndpointConnectionsResponseTypeDef
# revoke_pipeline_endpoint_connections method usage example with argument unpacking

kwargs: RevokePipelineEndpointConnectionsRequestTypeDef = {  # (1)
    "PipelineArn": ...,
    "EndpointIds": ...,
}

parent.revoke_pipeline_endpoint_connections(**kwargs)
  1. See RevokePipelineEndpointConnectionsRequestTypeDef

start_pipeline#

Starts an OpenSearch Ingestion pipeline.

Type annotations and code completion for boto3.client("osis").start_pipeline method. boto3 documentation

# start_pipeline method definition

def start_pipeline(
    self,
    *,
    PipelineName: str,
) -> StartPipelineResponseTypeDef:  # (1)
    ...
  1. See StartPipelineResponseTypeDef
# start_pipeline method usage example with argument unpacking

kwargs: StartPipelineRequestTypeDef = {  # (1)
    "PipelineName": ...,
}

parent.start_pipeline(**kwargs)
  1. See StartPipelineRequestTypeDef

stop_pipeline#

Stops an OpenSearch Ingestion pipeline.

Type annotations and code completion for boto3.client("osis").stop_pipeline method. boto3 documentation

# stop_pipeline method definition

def stop_pipeline(
    self,
    *,
    PipelineName: str,
) -> StopPipelineResponseTypeDef:  # (1)
    ...
  1. See StopPipelineResponseTypeDef
# stop_pipeline method usage example with argument unpacking

kwargs: StopPipelineRequestTypeDef = {  # (1)
    "PipelineName": ...,
}

parent.stop_pipeline(**kwargs)
  1. See StopPipelineRequestTypeDef

tag_resource#

Tags an OpenSearch Ingestion pipeline.

Type annotations and code completion for boto3.client("osis").tag_resource method. boto3 documentation

# tag_resource method definition

def tag_resource(
    self,
    *,
    Arn: str,
    Tags: Sequence[TagTypeDef],  # (1)
) -> Dict[str, Any]:
    ...
  1. See Sequence[TagTypeDef]
# tag_resource method usage example with argument unpacking

kwargs: TagResourceRequestTypeDef = {  # (1)
    "Arn": ...,
    "Tags": ...,
}

parent.tag_resource(**kwargs)
  1. See TagResourceRequestTypeDef

untag_resource#

Removes one or more tags from an OpenSearch Ingestion pipeline.

Type annotations and code completion for boto3.client("osis").untag_resource method. boto3 documentation

# untag_resource method definition

def untag_resource(
    self,
    *,
    Arn: str,
    TagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...
# untag_resource method usage example with argument unpacking

kwargs: UntagResourceRequestTypeDef = {  # (1)
    "Arn": ...,
    "TagKeys": ...,
}

parent.untag_resource(**kwargs)
  1. See UntagResourceRequestTypeDef

update_pipeline#

Updates an OpenSearch Ingestion pipeline.

Type annotations and code completion for boto3.client("osis").update_pipeline method. boto3 documentation

# update_pipeline method definition

def update_pipeline(
    self,
    *,
    PipelineName: str,
    MinUnits: int = ...,
    MaxUnits: int = ...,
    PipelineConfigurationBody: str = ...,
    LogPublishingOptions: LogPublishingOptionsTypeDef = ...,  # (1)
    BufferOptions: BufferOptionsTypeDef = ...,  # (2)
    EncryptionAtRestOptions: EncryptionAtRestOptionsTypeDef = ...,  # (3)
    PipelineRoleArn: str = ...,
) -> UpdatePipelineResponseTypeDef:  # (4)
    ...
  1. See LogPublishingOptionsTypeDef
  2. See BufferOptionsTypeDef
  3. See EncryptionAtRestOptionsTypeDef
  4. See UpdatePipelineResponseTypeDef
# update_pipeline method usage example with argument unpacking

kwargs: UpdatePipelineRequestTypeDef = {  # (1)
    "PipelineName": ...,
}

parent.update_pipeline(**kwargs)
  1. See UpdatePipelineRequestTypeDef

validate_pipeline#

Checks whether an OpenSearch Ingestion pipeline configuration is valid prior to creation.

Type annotations and code completion for boto3.client("osis").validate_pipeline method. boto3 documentation

# validate_pipeline method definition

def validate_pipeline(
    self,
    *,
    PipelineConfigurationBody: str,
) -> ValidatePipelineResponseTypeDef:  # (1)
    ...
  1. See ValidatePipelineResponseTypeDef
# validate_pipeline method usage example with argument unpacking

kwargs: ValidatePipelineRequestTypeDef = {  # (1)
    "PipelineConfigurationBody": ...,
}

parent.validate_pipeline(**kwargs)
  1. See ValidatePipelineRequestTypeDef

get_paginator#

Type annotations and code completion for boto3.client("osis").get_paginator method with overloads.