EventBridgePipesClient#
Index > EventBridgePipes > EventBridgePipesClient
Auto-generated documentation for EventBridgePipes type annotations stubs module mypy-boto3-pipes.
EventBridgePipesClient#
Type annotations and code completion for boto3.client("pipes").
boto3 documentation
# EventBridgePipesClient usage example
from boto3.session import Session
from mypy_boto3_pipes.client import EventBridgePipesClient
def get_pipes_client() -> EventBridgePipesClient:
return Session().client("pipes")Exceptions#
boto3 client exceptions are generated in runtime.
This class provides code completion for boto3.client("pipes").exceptions structure.
# Exceptions.exceptions usage example
client = boto3.client("pipes")
try:
do_something(client)
except (
client.exceptions.ClientError,
client.exceptions.ConflictException,
client.exceptions.InternalException,
client.exceptions.NotFoundException,
client.exceptions.ServiceQuotaExceededException,
client.exceptions.ThrottlingException,
client.exceptions.ValidationException,
) as e:
print(e)# Exceptions.exceptions type checking example
from mypy_boto3_pipes.client import Exceptions
def handle_error(exc: Exceptions.ClientError) -> None:
...Methods#
can_paginate#
Check if an operation can be paginated.
Type annotations and code completion for boto3.client("pipes").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 boto3.client("pipes").close method.
boto3 documentation
# close method definition
def close(
self,
) -> None:
...create_pipe#
Create a pipe.
Type annotations and code completion for boto3.client("pipes").create_pipe method.
boto3 documentation
# create_pipe method definition
def create_pipe(
self,
*,
Name: str,
Source: str,
Target: str,
RoleArn: str,
Description: str = ...,
DesiredState: RequestedPipeStateType = ..., # (1)
SourceParameters: PipeSourceParametersTypeDef = ..., # (2)
Enrichment: str = ...,
EnrichmentParameters: PipeEnrichmentParametersTypeDef = ..., # (3)
TargetParameters: PipeTargetParametersTypeDef = ..., # (4)
Tags: Mapping[str, str] = ...,
LogConfiguration: PipeLogConfigurationParametersTypeDef = ..., # (5)
KmsKeyIdentifier: str = ...,
) -> CreatePipeResponseTypeDef: # (6)
...- See RequestedPipeStateType
- See PipeSourceParametersTypeDef
- See PipeEnrichmentParametersTypeDef
- See PipeTargetParametersTypeDef
- See PipeLogConfigurationParametersTypeDef
- See CreatePipeResponseTypeDef
# create_pipe method usage example with argument unpacking
kwargs: CreatePipeRequestRequestTypeDef = { # (1)
"Name": ...,
"Source": ...,
"Target": ...,
"RoleArn": ...,
}
parent.create_pipe(**kwargs)delete_pipe#
Delete an existing pipe.
Type annotations and code completion for boto3.client("pipes").delete_pipe method.
boto3 documentation
# delete_pipe method definition
def delete_pipe(
self,
*,
Name: str,
) -> DeletePipeResponseTypeDef: # (1)
...# delete_pipe method usage example with argument unpacking
kwargs: DeletePipeRequestRequestTypeDef = { # (1)
"Name": ...,
}
parent.delete_pipe(**kwargs)describe_pipe#
Get the information about an existing pipe.
Type annotations and code completion for boto3.client("pipes").describe_pipe method.
boto3 documentation
# describe_pipe method definition
def describe_pipe(
self,
*,
Name: str,
) -> DescribePipeResponseTypeDef: # (1)
...# describe_pipe method usage example with argument unpacking
kwargs: DescribePipeRequestRequestTypeDef = { # (1)
"Name": ...,
}
parent.describe_pipe(**kwargs)generate_presigned_url#
Generate a presigned url given a client, its method, and arguments.
Type annotations and code completion for boto3.client("pipes").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:
...list_pipes#
Get the pipes associated with this account.
Type annotations and code completion for boto3.client("pipes").list_pipes method.
boto3 documentation
# list_pipes method definition
def list_pipes(
self,
*,
NamePrefix: str = ...,
DesiredState: RequestedPipeStateType = ..., # (1)
CurrentState: PipeStateType = ..., # (2)
SourcePrefix: str = ...,
TargetPrefix: str = ...,
NextToken: str = ...,
Limit: int = ...,
) -> ListPipesResponseTypeDef: # (3)
...# list_pipes method usage example with argument unpacking
kwargs: ListPipesRequestRequestTypeDef = { # (1)
"NamePrefix": ...,
}
parent.list_pipes(**kwargs)list_tags_for_resource#
Displays the tags associated with a pipe.
Type annotations and code completion for boto3.client("pipes").list_tags_for_resource method.
boto3 documentation
# list_tags_for_resource method definition
def list_tags_for_resource(
self,
*,
resourceArn: str,
) -> ListTagsForResourceResponseTypeDef: # (1)
...# list_tags_for_resource method usage example with argument unpacking
kwargs: ListTagsForResourceRequestRequestTypeDef = { # (1)
"resourceArn": ...,
}
parent.list_tags_for_resource(**kwargs)start_pipe#
Start an existing pipe.
Type annotations and code completion for boto3.client("pipes").start_pipe method.
boto3 documentation
# start_pipe method definition
def start_pipe(
self,
*,
Name: str,
) -> StartPipeResponseTypeDef: # (1)
...# start_pipe method usage example with argument unpacking
kwargs: StartPipeRequestRequestTypeDef = { # (1)
"Name": ...,
}
parent.start_pipe(**kwargs)stop_pipe#
Stop an existing pipe.
Type annotations and code completion for boto3.client("pipes").stop_pipe method.
boto3 documentation
# stop_pipe method definition
def stop_pipe(
self,
*,
Name: str,
) -> StopPipeResponseTypeDef: # (1)
...# stop_pipe method usage example with argument unpacking
kwargs: StopPipeRequestRequestTypeDef = { # (1)
"Name": ...,
}
parent.stop_pipe(**kwargs)tag_resource#
Assigns one or more tags (key-value pairs) to the specified pipe.
Type annotations and code completion for boto3.client("pipes").tag_resource method.
boto3 documentation
# tag_resource method definition
def tag_resource(
self,
*,
resourceArn: str,
tags: Mapping[str, str],
) -> Dict[str, Any]:
...# tag_resource method usage example with argument unpacking
kwargs: TagResourceRequestRequestTypeDef = { # (1)
"resourceArn": ...,
"tags": ...,
}
parent.tag_resource(**kwargs)untag_resource#
Removes one or more tags from the specified pipes.
Type annotations and code completion for boto3.client("pipes").untag_resource method.
boto3 documentation
# untag_resource method definition
def untag_resource(
self,
*,
resourceArn: str,
tagKeys: Sequence[str],
) -> Dict[str, Any]:
...# untag_resource method usage example with argument unpacking
kwargs: UntagResourceRequestRequestTypeDef = { # (1)
"resourceArn": ...,
"tagKeys": ...,
}
parent.untag_resource(**kwargs)update_pipe#
Update an existing pipe.
Type annotations and code completion for boto3.client("pipes").update_pipe method.
boto3 documentation
# update_pipe method definition
def update_pipe(
self,
*,
Name: str,
RoleArn: str,
Description: str = ...,
DesiredState: RequestedPipeStateType = ..., # (1)
SourceParameters: UpdatePipeSourceParametersTypeDef = ..., # (2)
Enrichment: str = ...,
EnrichmentParameters: PipeEnrichmentParametersTypeDef = ..., # (3)
Target: str = ...,
TargetParameters: PipeTargetParametersTypeDef = ..., # (4)
LogConfiguration: PipeLogConfigurationParametersTypeDef = ..., # (5)
KmsKeyIdentifier: str = ...,
) -> UpdatePipeResponseTypeDef: # (6)
...- See RequestedPipeStateType
- See UpdatePipeSourceParametersTypeDef
- See PipeEnrichmentParametersTypeDef
- See PipeTargetParametersTypeDef
- See PipeLogConfigurationParametersTypeDef
- See UpdatePipeResponseTypeDef
# update_pipe method usage example with argument unpacking
kwargs: UpdatePipeRequestRequestTypeDef = { # (1)
"Name": ...,
"RoleArn": ...,
}
parent.update_pipe(**kwargs)get_paginator#
Type annotations and code completion for boto3.client("pipes").get_paginator method with overloads.
client.get_paginator("list_pipes")-> ListPipesPaginator