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

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.

Usage example

client = boto3.client("pipes")

try:
    do_something(client)
except (
    client.ClientError,
    client.ConflictException,
    client.InternalException,
    client.NotFoundException,
    client.ServiceQuotaExceededException,
    client.ThrottlingException,
    client.ValidationException,
) as e:
    print(e)

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

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

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

Method definition

def create_pipe(
    self,
    *,
    Name: str,
    RoleArn: str,
    Source: str,
    Target: str,
    Description: str = ...,
    DesiredState: RequestedPipeStateType = ...,  # (1)
    Enrichment: str = ...,
    EnrichmentParameters: PipeEnrichmentParametersTypeDef = ...,  # (2)
    SourceParameters: PipeSourceParametersTypeDef = ...,  # (3)
    Tags: Mapping[str, str] = ...,
    TargetParameters: PipeTargetParametersTypeDef = ...,  # (4)
) -> CreatePipeResponseTypeDef:  # (5)
    ...

1. See RequestedPipeStateType
2. See PipeEnrichmentParametersTypeDef
3. See PipeSourceParametersTypeDef
4. See PipeTargetParametersTypeDef
5. See CreatePipeResponseTypeDef

Usage example with kwargs

kwargs: CreatePipeRequestRequestTypeDef = {  # (1)
    "Name": ...,
    "RoleArn": ...,
    "Source": ...,
    "Target": ...,
}

parent.create_pipe(**kwargs)

1. See CreatePipeRequestRequestTypeDef

delete_pipe

Delete an existing pipe.

Type annotations and code completion for boto3.client("pipes").delete_pipe method. boto3 documentation

Method definition

def delete_pipe(
    self,
    *,
    Name: str,
) -> DeletePipeResponseTypeDef:  # (1)
    ...

1. See DeletePipeResponseTypeDef

Usage example with kwargs

kwargs: DeletePipeRequestRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.delete_pipe(**kwargs)

1. See DeletePipeRequestRequestTypeDef

describe_pipe

Get the information about an existing pipe.

Type annotations and code completion for boto3.client("pipes").describe_pipe method. boto3 documentation

Method definition

def describe_pipe(
    self,
    *,
    Name: str,
) -> DescribePipeResponseTypeDef:  # (1)
    ...

1. See DescribePipeResponseTypeDef

Usage example with kwargs

kwargs: DescribePipeRequestRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.describe_pipe(**kwargs)

1. See DescribePipeRequestRequestTypeDef

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

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

Method definition

def list_pipes(
    self,
    *,
    CurrentState: PipeStateType = ...,  # (1)
    DesiredState: RequestedPipeStateType = ...,  # (2)
    Limit: int = ...,
    NamePrefix: str = ...,
    NextToken: str = ...,
    SourcePrefix: str = ...,
    TargetPrefix: str = ...,
) -> ListPipesResponseTypeDef:  # (3)
    ...

1. See PipeStateType
2. See RequestedPipeStateType
3. See ListPipesResponseTypeDef

Usage example with kwargs

kwargs: ListPipesRequestRequestTypeDef = {  # (1)
    "CurrentState": ...,
}

parent.list_pipes(**kwargs)

1. See ListPipesRequestRequestTypeDef

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

Method definition

def list_tags_for_resource(
    self,
    *,
    resourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...

1. See ListTagsForResourceResponseTypeDef

Usage example with kwargs

kwargs: ListTagsForResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)

1. See ListTagsForResourceRequestRequestTypeDef

start_pipe

Start an existing pipe.

Type annotations and code completion for boto3.client("pipes").start_pipe method. boto3 documentation

Method definition

def start_pipe(
    self,
    *,
    Name: str,
) -> StartPipeResponseTypeDef:  # (1)
    ...

1. See StartPipeResponseTypeDef

Usage example with kwargs

kwargs: StartPipeRequestRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.start_pipe(**kwargs)

1. See StartPipeRequestRequestTypeDef

stop_pipe

Stop an existing pipe.

Type annotations and code completion for boto3.client("pipes").stop_pipe method. boto3 documentation

Method definition

def stop_pipe(
    self,
    *,
    Name: str,
) -> StopPipeResponseTypeDef:  # (1)
    ...

1. See StopPipeResponseTypeDef

Usage example with kwargs

kwargs: StopPipeRequestRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.stop_pipe(**kwargs)

1. See StopPipeRequestRequestTypeDef

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

Method definition

def tag_resource(
    self,
    *,
    resourceArn: str,
    tags: Mapping[str, str],
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: TagResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tags": ...,
}

parent.tag_resource(**kwargs)

1. See TagResourceRequestRequestTypeDef

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

Method definition

def untag_resource(
    self,
    *,
    resourceArn: str,
    tagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: UntagResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tagKeys": ...,
}

parent.untag_resource(**kwargs)

1. See UntagResourceRequestRequestTypeDef

update_pipe

Update an existing pipe.

Type annotations and code completion for boto3.client("pipes").update_pipe method. boto3 documentation

Method definition

def update_pipe(
    self,
    *,
    Name: str,
    RoleArn: str,
    Description: str = ...,
    DesiredState: RequestedPipeStateType = ...,  # (1)
    Enrichment: str = ...,
    EnrichmentParameters: PipeEnrichmentParametersTypeDef = ...,  # (2)
    SourceParameters: UpdatePipeSourceParametersTypeDef = ...,  # (3)
    Target: str = ...,
    TargetParameters: PipeTargetParametersTypeDef = ...,  # (4)
) -> UpdatePipeResponseTypeDef:  # (5)
    ...

1. See RequestedPipeStateType
2. See PipeEnrichmentParametersTypeDef
3. See UpdatePipeSourceParametersTypeDef
4. See PipeTargetParametersTypeDef
5. See UpdatePipeResponseTypeDef

Usage example with kwargs

kwargs: UpdatePipeRequestRequestTypeDef = {  # (1)
    "Name": ...,
    "RoleArn": ...,
}

parent.update_pipe(**kwargs)

1. See UpdatePipeRequestRequestTypeDef

get_paginator

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

• client.get_paginator("list_pipes") -> ListPipesPaginator