OpenSearchIngestionClient#
Index > OpenSearchIngestion > OpenSearchIngestionClient
Auto-generated documentation for OpenSearchIngestion type annotations stubs module types-aiobotocore-osis.
OpenSearchIngestionClient#
Type annotations and code completion for session.create_client("osis")
boto3 documentation
OpenSearchIngestionClient usage example
from aiobotocore.session import get_session
from types_aiobotocore_osis.client import OpenSearchIngestionClient
session = get_session()
async with session.create_client("osis") as client:
client: OpenSearchIngestionClientExceptions#
aiobotocore client exceptions are generated in runtime.
This class provides code completion for session.create_client("osis").exceptions structure.
OpenSearchIngestionClient.exceptions usage example
async with session.create_client("osis") as client:
try:
do_something(client)
except (
client.AccessDeniedException,
client.ClientError,
client.ConflictException,
client.InternalException,
client.InvalidPaginationTokenException,
client.LimitExceededException,
client.ResourceAlreadyExistsException,
client.ResourceNotFoundException,
client.ValidationException,
) as e:
print(e)OpenSearchIngestionClient usage type checking example
from types_aiobotocore_osis.client import Exceptions
def handle_error(exc: Exceptions.AccessDeniedException) -> None:
...Methods#
can_paginate#
Check if an operation can be paginated.
Type annotations and code completion for session.create_client("osis").can_paginate method.
boto3 documentation
# can_paginate method definition
def can_paginate(
self,
operation_name: str,
) -> bool:
...close#
Closes underlying endpoint connections.
Type annotations and code completion for session.create_client("osis").close method.
boto3 documentation
# close method definition
await def close(
self,
) -> None:
...create_pipeline#
Creates an OpenSearch Ingestion pipeline.
Type annotations and code completion for session.create_client("osis").create_pipeline method.
boto3 documentation
# create_pipeline method definition
await def create_pipeline(
self,
*,
PipelineName: str,
MinUnits: int,
MaxUnits: int,
PipelineConfigurationBody: str,
LogPublishingOptions: LogPublishingOptionsTypeDef = ..., # (1)
VpcOptions: VpcOptionsTypeDef = ..., # (2)
Tags: Sequence[TagTypeDef] = ..., # (3)
) -> CreatePipelineResponseTypeDef: # (4)
...- See LogPublishingOptionsTypeDef
- See VpcOptionsTypeDef
- See TagTypeDef
- See CreatePipelineResponseTypeDef
# create_pipeline method usage example with argument unpacking
kwargs: CreatePipelineRequestRequestTypeDef = { # (1)
"PipelineName": ...,
"MinUnits": ...,
"MaxUnits": ...,
"PipelineConfigurationBody": ...,
}
parent.create_pipeline(**kwargs)delete_pipeline#
Deletes an OpenSearch Ingestion pipeline.
Type annotations and code completion for session.create_client("osis").delete_pipeline method.
boto3 documentation
# delete_pipeline method definition
await def delete_pipeline(
self,
*,
PipelineName: str,
) -> Dict[str, Any]:
...# delete_pipeline method usage example with argument unpacking
kwargs: DeletePipelineRequestRequestTypeDef = { # (1)
"PipelineName": ...,
}
parent.delete_pipeline(**kwargs)generate_presigned_url#
Generate a presigned url given a client, its method, and arguments.
Type annotations and code completion for session.create_client("osis").generate_presigned_url method.
boto3 documentation
# generate_presigned_url method definition
await def generate_presigned_url(
self,
ClientMethod: str,
Params: Mapping[str, Any] = ...,
ExpiresIn: int = 3600,
HttpMethod: str = ...,
) -> str:
...get_pipeline#
Retrieves information about an OpenSearch Ingestion pipeline.
Type annotations and code completion for session.create_client("osis").get_pipeline method.
boto3 documentation
# get_pipeline method definition
await def get_pipeline(
self,
*,
PipelineName: str,
) -> GetPipelineResponseTypeDef: # (1)
...# get_pipeline method usage example with argument unpacking
kwargs: GetPipelineRequestRequestTypeDef = { # (1)
"PipelineName": ...,
}
parent.get_pipeline(**kwargs)get_pipeline_blueprint#
Retrieves information about a specific blueprint for OpenSearch Ingestion.
Type annotations and code completion for session.create_client("osis").get_pipeline_blueprint method.
boto3 documentation
# get_pipeline_blueprint method definition
await def get_pipeline_blueprint(
self,
*,
BlueprintName: str,
) -> GetPipelineBlueprintResponseTypeDef: # (1)
...# get_pipeline_blueprint method usage example with argument unpacking
kwargs: GetPipelineBlueprintRequestRequestTypeDef = { # (1)
"BlueprintName": ...,
}
parent.get_pipeline_blueprint(**kwargs)get_pipeline_change_progress#
Returns progress information for the current change happening on an OpenSearch Ingestion pipeline.
Type annotations and code completion for session.create_client("osis").get_pipeline_change_progress method.
boto3 documentation
# get_pipeline_change_progress method definition
await def get_pipeline_change_progress(
self,
*,
PipelineName: str,
) -> GetPipelineChangeProgressResponseTypeDef: # (1)
...# get_pipeline_change_progress method usage example with argument unpacking
kwargs: GetPipelineChangeProgressRequestRequestTypeDef = { # (1)
"PipelineName": ...,
}
parent.get_pipeline_change_progress(**kwargs)list_pipeline_blueprints#
Retrieves a list of all available blueprints for Data Prepper.
Type annotations and code completion for session.create_client("osis").list_pipeline_blueprints method.
boto3 documentation
# list_pipeline_blueprints method definition
await def list_pipeline_blueprints(
self,
) -> ListPipelineBlueprintsResponseTypeDef: # (1)
...list_pipelines#
Lists all OpenSearch Ingestion pipelines in the current Amazon Web Services account and Region.
Type annotations and code completion for session.create_client("osis").list_pipelines method.
boto3 documentation
# list_pipelines method definition
await def list_pipelines(
self,
*,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListPipelinesResponseTypeDef: # (1)
...# list_pipelines method usage example with argument unpacking
kwargs: ListPipelinesRequestRequestTypeDef = { # (1)
"MaxResults": ...,
}
parent.list_pipelines(**kwargs)list_tags_for_resource#
Lists all resource tags associated with an OpenSearch Ingestion pipeline.
Type annotations and code completion for session.create_client("osis").list_tags_for_resource method.
boto3 documentation
# list_tags_for_resource method definition
await def list_tags_for_resource(
self,
*,
Arn: str,
) -> ListTagsForResourceResponseTypeDef: # (1)
...# list_tags_for_resource method usage example with argument unpacking
kwargs: ListTagsForResourceRequestRequestTypeDef = { # (1)
"Arn": ...,
}
parent.list_tags_for_resource(**kwargs)start_pipeline#
Starts an OpenSearch Ingestion pipeline.
Type annotations and code completion for session.create_client("osis").start_pipeline method.
boto3 documentation
# start_pipeline method definition
await def start_pipeline(
self,
*,
PipelineName: str,
) -> StartPipelineResponseTypeDef: # (1)
...# start_pipeline method usage example with argument unpacking
kwargs: StartPipelineRequestRequestTypeDef = { # (1)
"PipelineName": ...,
}
parent.start_pipeline(**kwargs)stop_pipeline#
Stops an OpenSearch Ingestion pipeline.
Type annotations and code completion for session.create_client("osis").stop_pipeline method.
boto3 documentation
# stop_pipeline method definition
await def stop_pipeline(
self,
*,
PipelineName: str,
) -> StopPipelineResponseTypeDef: # (1)
...# stop_pipeline method usage example with argument unpacking
kwargs: StopPipelineRequestRequestTypeDef = { # (1)
"PipelineName": ...,
}
parent.stop_pipeline(**kwargs)tag_resource#
Tags an OpenSearch Ingestion pipeline.
Type annotations and code completion for session.create_client("osis").tag_resource method.
boto3 documentation
# tag_resource method definition
await def tag_resource(
self,
*,
Arn: str,
Tags: Sequence[TagTypeDef], # (1)
) -> Dict[str, Any]:
...- See TagTypeDef
# tag_resource method usage example with argument unpacking
kwargs: TagResourceRequestRequestTypeDef = { # (1)
"Arn": ...,
"Tags": ...,
}
parent.tag_resource(**kwargs)untag_resource#
Removes one or more tags from an OpenSearch Ingestion pipeline.
Type annotations and code completion for session.create_client("osis").untag_resource method.
boto3 documentation
# untag_resource method definition
await def untag_resource(
self,
*,
Arn: str,
TagKeys: Sequence[str],
) -> Dict[str, Any]:
...# untag_resource method usage example with argument unpacking
kwargs: UntagResourceRequestRequestTypeDef = { # (1)
"Arn": ...,
"TagKeys": ...,
}
parent.untag_resource(**kwargs)update_pipeline#
Updates an OpenSearch Ingestion pipeline.
Type annotations and code completion for session.create_client("osis").update_pipeline method.
boto3 documentation
# update_pipeline method definition
await def update_pipeline(
self,
*,
PipelineName: str,
MinUnits: int = ...,
MaxUnits: int = ...,
PipelineConfigurationBody: str = ...,
LogPublishingOptions: LogPublishingOptionsTypeDef = ..., # (1)
) -> UpdatePipelineResponseTypeDef: # (2)
...# update_pipeline method usage example with argument unpacking
kwargs: UpdatePipelineRequestRequestTypeDef = { # (1)
"PipelineName": ...,
}
parent.update_pipeline(**kwargs)validate_pipeline#
Checks whether an OpenSearch Ingestion pipeline configuration is valid prior to creation.
Type annotations and code completion for session.create_client("osis").validate_pipeline method.
boto3 documentation
# validate_pipeline method definition
await def validate_pipeline(
self,
*,
PipelineConfigurationBody: str,
) -> ValidatePipelineResponseTypeDef: # (1)
...# validate_pipeline method usage example with argument unpacking
kwargs: ValidatePipelineRequestRequestTypeDef = { # (1)
"PipelineConfigurationBody": ...,
}
parent.validate_pipeline(**kwargs)__aenter__#
Type annotations and code completion for session.create_client("osis").__aenter__ method.
boto3 documentation
# __aenter__ method definition
await def __aenter__(
self,
) -> OpenSearchIngestionClient:
...__aexit__#
Type annotations and code completion for session.create_client("osis").__aexit__ method.
boto3 documentation
# __aexit__ method definition
await def __aexit__(
self,
exc_type: Any,
exc_val: Any,
exc_tb: Any,
) -> Any:
...