RTBFabricClient

Index > RTBFabric > RTBFabricClient

Auto-generated documentation for RTBFabric type annotations stubs module mypy-boto3-rtbfabric.

RTBFabricClient

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

# RTBFabricClient usage example

from boto3.session import Session
from mypy_boto3_rtbfabric.client import RTBFabricClient

def get_rtbfabric_client() -> RTBFabricClient:
    return Session().client("rtbfabric")

Exceptions

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

# Exceptions.exceptions usage example

client = boto3.client("rtbfabric")

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.ClientError,
    client.exceptions.ConflictException,
    client.exceptions.InternalServerException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ServiceQuotaExceededException,
    client.exceptions.ThrottlingException,
    client.exceptions.ValidationException,
) as e:
    print(e)

# Exceptions.exceptions type checking example

from mypy_boto3_rtbfabric.client import Exceptions

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

Methods

can_paginate

Type annotations and code completion for boto3.client("rtbfabric").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("rtbfabric").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:
    ...

accept_link

Accepts a link request between RTB applications.

Type annotations and code completion for boto3.client("rtbfabric").accept_link method. boto3 documentation

# accept_link method definition

def accept_link(
    self,
    *,
    gatewayId: str,
    linkId: str,
    logSettings: LinkLogSettingsTypeDef,  # (1)
    attributes: LinkAttributesUnionTypeDef = ...,  # (2)
) -> AcceptLinkResponseTypeDef:  # (3)
    ...

1. See LinkLogSettingsTypeDef
2. See LinkAttributesUnionTypeDef
3. See AcceptLinkResponseTypeDef

# accept_link method usage example with argument unpacking

kwargs: AcceptLinkRequestTypeDef = {  # (1)
    "gatewayId": ...,
    "linkId": ...,
    "logSettings": ...,
}

parent.accept_link(**kwargs)

1. See AcceptLinkRequestTypeDef

create_inbound_external_link

Creates an inbound external link.

Type annotations and code completion for boto3.client("rtbfabric").create_inbound_external_link method. boto3 documentation

# create_inbound_external_link method definition

def create_inbound_external_link(
    self,
    *,
    clientToken: str,
    gatewayId: str,
    attributes: LinkAttributesUnionTypeDef = ...,  # (1)
    tags: Mapping[str, str] = ...,
) -> CreateInboundExternalLinkResponseTypeDef:  # (2)
    ...

1. See LinkAttributesUnionTypeDef
2. See CreateInboundExternalLinkResponseTypeDef

# create_inbound_external_link method usage example with argument unpacking

kwargs: CreateInboundExternalLinkRequestTypeDef = {  # (1)
    "clientToken": ...,
    "gatewayId": ...,
}

parent.create_inbound_external_link(**kwargs)

1. See CreateInboundExternalLinkRequestTypeDef

create_link

Creates a new link between RTB applications.

Type annotations and code completion for boto3.client("rtbfabric").create_link method. boto3 documentation

# create_link method definition

def create_link(
    self,
    *,
    gatewayId: str,
    peerGatewayId: str,
    logSettings: LinkLogSettingsTypeDef,  # (1)
    attributes: LinkAttributesUnionTypeDef = ...,  # (2)
    httpResponderAllowed: bool = ...,
    tags: Mapping[str, str] = ...,
) -> CreateLinkResponseTypeDef:  # (3)
    ...

1. See LinkLogSettingsTypeDef
2. See LinkAttributesUnionTypeDef
3. See CreateLinkResponseTypeDef

# create_link method usage example with argument unpacking

kwargs: CreateLinkRequestTypeDef = {  # (1)
    "gatewayId": ...,
    "peerGatewayId": ...,
    "logSettings": ...,
}

parent.create_link(**kwargs)

1. See CreateLinkRequestTypeDef

create_outbound_external_link

Creates an outbound external link.

Type annotations and code completion for boto3.client("rtbfabric").create_outbound_external_link method. boto3 documentation

# create_outbound_external_link method definition

def create_outbound_external_link(
    self,
    *,
    clientToken: str,
    gatewayId: str,
    publicEndpoint: str,
    tags: Mapping[str, str] = ...,
) -> CreateOutboundExternalLinkResponseTypeDef:  # (1)
    ...

1. See CreateOutboundExternalLinkResponseTypeDef

# create_outbound_external_link method usage example with argument unpacking

kwargs: CreateOutboundExternalLinkRequestTypeDef = {  # (1)
    "clientToken": ...,
    "gatewayId": ...,
    "publicEndpoint": ...,
}

parent.create_outbound_external_link(**kwargs)

1. See CreateOutboundExternalLinkRequestTypeDef

create_requester_gateway

Creates a requester gateway.

Type annotations and code completion for boto3.client("rtbfabric").create_requester_gateway method. boto3 documentation

# create_requester_gateway method definition

def create_requester_gateway(
    self,
    *,
    vpcId: str,
    subnetIds: Sequence[str],
    securityGroupIds: Sequence[str],
    clientToken: str,
    description: str = ...,
    tags: Mapping[str, str] = ...,
) -> CreateRequesterGatewayResponseTypeDef:  # (1)
    ...

1. See CreateRequesterGatewayResponseTypeDef

# create_requester_gateway method usage example with argument unpacking

kwargs: CreateRequesterGatewayRequestTypeDef = {  # (1)
    "vpcId": ...,
    "subnetIds": ...,
    "securityGroupIds": ...,
    "clientToken": ...,
}

parent.create_requester_gateway(**kwargs)

1. See CreateRequesterGatewayRequestTypeDef

create_responder_gateway

Creates a responder gateway.

Type annotations and code completion for boto3.client("rtbfabric").create_responder_gateway method. boto3 documentation

# create_responder_gateway method definition

def create_responder_gateway(
    self,
    *,
    vpcId: str,
    subnetIds: Sequence[str],
    securityGroupIds: Sequence[str],
    port: int,
    protocol: ProtocolType,  # (1)
    clientToken: str,
    domainName: str = ...,
    trustStoreConfiguration: TrustStoreConfigurationUnionTypeDef = ...,  # (2)
    managedEndpointConfiguration: ManagedEndpointConfigurationUnionTypeDef = ...,  # (3)
    description: str = ...,
    tags: Mapping[str, str] = ...,
) -> CreateResponderGatewayResponseTypeDef:  # (4)
    ...

1. See ProtocolType
2. See TrustStoreConfigurationUnionTypeDef
3. See ManagedEndpointConfigurationUnionTypeDef
4. See CreateResponderGatewayResponseTypeDef

# create_responder_gateway method usage example with argument unpacking

kwargs: CreateResponderGatewayRequestTypeDef = {  # (1)
    "vpcId": ...,
    "subnetIds": ...,
    "securityGroupIds": ...,
    "port": ...,
    "protocol": ...,
    "clientToken": ...,
}

parent.create_responder_gateway(**kwargs)

1. See CreateResponderGatewayRequestTypeDef

delete_inbound_external_link

Deletes an inbound external link.

Type annotations and code completion for boto3.client("rtbfabric").delete_inbound_external_link method. boto3 documentation

# delete_inbound_external_link method definition

def delete_inbound_external_link(
    self,
    *,
    gatewayId: str,
    linkId: str,
) -> DeleteInboundExternalLinkResponseTypeDef:  # (1)
    ...

1. See DeleteInboundExternalLinkResponseTypeDef

# delete_inbound_external_link method usage example with argument unpacking

kwargs: DeleteInboundExternalLinkRequestTypeDef = {  # (1)
    "gatewayId": ...,
    "linkId": ...,
}

parent.delete_inbound_external_link(**kwargs)

1. See DeleteInboundExternalLinkRequestTypeDef

delete_link

Deletes a link between RTB applications.

Type annotations and code completion for boto3.client("rtbfabric").delete_link method. boto3 documentation

# delete_link method definition

def delete_link(
    self,
    *,
    gatewayId: str,
    linkId: str,
) -> DeleteLinkResponseTypeDef:  # (1)
    ...

1. See DeleteLinkResponseTypeDef

# delete_link method usage example with argument unpacking

kwargs: DeleteLinkRequestTypeDef = {  # (1)
    "gatewayId": ...,
    "linkId": ...,
}

parent.delete_link(**kwargs)

1. See DeleteLinkRequestTypeDef

delete_outbound_external_link

Deletes an outbound external link.

Type annotations and code completion for boto3.client("rtbfabric").delete_outbound_external_link method. boto3 documentation

# delete_outbound_external_link method definition

def delete_outbound_external_link(
    self,
    *,
    gatewayId: str,
    linkId: str,
) -> DeleteOutboundExternalLinkResponseTypeDef:  # (1)
    ...

1. See DeleteOutboundExternalLinkResponseTypeDef

# delete_outbound_external_link method usage example with argument unpacking

kwargs: DeleteOutboundExternalLinkRequestTypeDef = {  # (1)
    "gatewayId": ...,
    "linkId": ...,
}

parent.delete_outbound_external_link(**kwargs)

1. See DeleteOutboundExternalLinkRequestTypeDef

delete_requester_gateway

Deletes a requester gateway.

Type annotations and code completion for boto3.client("rtbfabric").delete_requester_gateway method. boto3 documentation

# delete_requester_gateway method definition

def delete_requester_gateway(
    self,
    *,
    gatewayId: str,
) -> DeleteRequesterGatewayResponseTypeDef:  # (1)
    ...

1. See DeleteRequesterGatewayResponseTypeDef

# delete_requester_gateway method usage example with argument unpacking

kwargs: DeleteRequesterGatewayRequestTypeDef = {  # (1)
    "gatewayId": ...,
}

parent.delete_requester_gateway(**kwargs)

1. See DeleteRequesterGatewayRequestTypeDef

delete_responder_gateway

Deletes a responder gateway.

Type annotations and code completion for boto3.client("rtbfabric").delete_responder_gateway method. boto3 documentation

# delete_responder_gateway method definition

def delete_responder_gateway(
    self,
    *,
    gatewayId: str,
) -> DeleteResponderGatewayResponseTypeDef:  # (1)
    ...

1. See DeleteResponderGatewayResponseTypeDef

# delete_responder_gateway method usage example with argument unpacking

kwargs: DeleteResponderGatewayRequestTypeDef = {  # (1)
    "gatewayId": ...,
}

parent.delete_responder_gateway(**kwargs)

1. See DeleteResponderGatewayRequestTypeDef

get_inbound_external_link

Retrieves information about an inbound external link.

Type annotations and code completion for boto3.client("rtbfabric").get_inbound_external_link method. boto3 documentation

# get_inbound_external_link method definition

def get_inbound_external_link(
    self,
    *,
    gatewayId: str,
    linkId: str,
) -> GetInboundExternalLinkResponseTypeDef:  # (1)
    ...

1. See GetInboundExternalLinkResponseTypeDef

# get_inbound_external_link method usage example with argument unpacking

kwargs: GetInboundExternalLinkRequestTypeDef = {  # (1)
    "gatewayId": ...,
    "linkId": ...,
}

parent.get_inbound_external_link(**kwargs)

1. See GetInboundExternalLinkRequestTypeDef

get_link

Retrieves information about a link between RTB applications.

Type annotations and code completion for boto3.client("rtbfabric").get_link method. boto3 documentation

# get_link method definition

def get_link(
    self,
    *,
    gatewayId: str,
    linkId: str,
) -> GetLinkResponseTypeDef:  # (1)
    ...

1. See GetLinkResponseTypeDef

# get_link method usage example with argument unpacking

kwargs: GetLinkRequestTypeDef = {  # (1)
    "gatewayId": ...,
    "linkId": ...,
}

parent.get_link(**kwargs)

1. See GetLinkRequestTypeDef

get_outbound_external_link

Retrieves information about an outbound external link.

Type annotations and code completion for boto3.client("rtbfabric").get_outbound_external_link method. boto3 documentation

# get_outbound_external_link method definition

def get_outbound_external_link(
    self,
    *,
    gatewayId: str,
    linkId: str,
) -> GetOutboundExternalLinkResponseTypeDef:  # (1)
    ...

1. See GetOutboundExternalLinkResponseTypeDef

# get_outbound_external_link method usage example with argument unpacking

kwargs: GetOutboundExternalLinkRequestTypeDef = {  # (1)
    "gatewayId": ...,
    "linkId": ...,
}

parent.get_outbound_external_link(**kwargs)

1. See GetOutboundExternalLinkRequestTypeDef

get_requester_gateway

Retrieves information about a requester gateway.

Type annotations and code completion for boto3.client("rtbfabric").get_requester_gateway method. boto3 documentation

# get_requester_gateway method definition

def get_requester_gateway(
    self,
    *,
    gatewayId: str,
) -> GetRequesterGatewayResponseTypeDef:  # (1)
    ...

1. See GetRequesterGatewayResponseTypeDef

# get_requester_gateway method usage example with argument unpacking

kwargs: GetRequesterGatewayRequestTypeDef = {  # (1)
    "gatewayId": ...,
}

parent.get_requester_gateway(**kwargs)

1. See GetRequesterGatewayRequestTypeDef

get_responder_gateway

Retrieves information about a responder gateway.

Type annotations and code completion for boto3.client("rtbfabric").get_responder_gateway method. boto3 documentation

# get_responder_gateway method definition

def get_responder_gateway(
    self,
    *,
    gatewayId: str,
) -> GetResponderGatewayResponseTypeDef:  # (1)
    ...

1. See GetResponderGatewayResponseTypeDef

# get_responder_gateway method usage example with argument unpacking

kwargs: GetResponderGatewayRequestTypeDef = {  # (1)
    "gatewayId": ...,
}

parent.get_responder_gateway(**kwargs)

1. See GetResponderGatewayRequestTypeDef

list_links

Lists links associated with an RTB application.

Type annotations and code completion for boto3.client("rtbfabric").list_links method. boto3 documentation

# list_links method definition

def list_links(
    self,
    *,
    gatewayId: str,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListLinksResponseTypeDef:  # (1)
    ...

1. See ListLinksResponseTypeDef

# list_links method usage example with argument unpacking

kwargs: ListLinksRequestTypeDef = {  # (1)
    "gatewayId": ...,
}

parent.list_links(**kwargs)

1. See ListLinksRequestTypeDef

list_requester_gateways

Lists requester gateways.

Type annotations and code completion for boto3.client("rtbfabric").list_requester_gateways method. boto3 documentation

# list_requester_gateways method definition

def list_requester_gateways(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListRequesterGatewaysResponseTypeDef:  # (1)
    ...

1. See ListRequesterGatewaysResponseTypeDef

# list_requester_gateways method usage example with argument unpacking

kwargs: ListRequesterGatewaysRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_requester_gateways(**kwargs)

1. See ListRequesterGatewaysRequestTypeDef

list_responder_gateways

Lists reponder gateways.

Type annotations and code completion for boto3.client("rtbfabric").list_responder_gateways method. boto3 documentation

# list_responder_gateways method definition

def list_responder_gateways(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListResponderGatewaysResponseTypeDef:  # (1)
    ...

1. See ListResponderGatewaysResponseTypeDef

# list_responder_gateways method usage example with argument unpacking

kwargs: ListResponderGatewaysRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_responder_gateways(**kwargs)

1. See ListResponderGatewaysRequestTypeDef

list_tags_for_resource

Lists tags for a resource.

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

# list_tags_for_resource method definition

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

1. See ListTagsForResourceResponseTypeDef

# list_tags_for_resource method usage example with argument unpacking

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

parent.list_tags_for_resource(**kwargs)

1. See ListTagsForResourceRequestTypeDef

reject_link

Rejects a link request between RTB applications.

Type annotations and code completion for boto3.client("rtbfabric").reject_link method. boto3 documentation

# reject_link method definition

def reject_link(
    self,
    *,
    gatewayId: str,
    linkId: str,
) -> RejectLinkResponseTypeDef:  # (1)
    ...

1. See RejectLinkResponseTypeDef

# reject_link method usage example with argument unpacking

kwargs: RejectLinkRequestTypeDef = {  # (1)
    "gatewayId": ...,
    "linkId": ...,
}

parent.reject_link(**kwargs)

1. See RejectLinkRequestTypeDef

tag_resource

Assigns one or more tags (key-value pairs) to the specified resource.

Type annotations and code completion for boto3.client("rtbfabric").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: TagResourceRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tags": ...,
}

parent.tag_resource(**kwargs)

1. See TagResourceRequestTypeDef

untag_resource

Removes a tag or tags from a resource.

Type annotations and code completion for boto3.client("rtbfabric").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: UntagResourceRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tagKeys": ...,
}

parent.untag_resource(**kwargs)

1. See UntagResourceRequestTypeDef

update_link

Updates the configuration of a link between RTB applications.

Type annotations and code completion for boto3.client("rtbfabric").update_link method. boto3 documentation

# update_link method definition

def update_link(
    self,
    *,
    gatewayId: str,
    linkId: str,
    logSettings: LinkLogSettingsTypeDef = ...,  # (1)
) -> UpdateLinkResponseTypeDef:  # (2)
    ...

1. See LinkLogSettingsTypeDef
2. See UpdateLinkResponseTypeDef

# update_link method usage example with argument unpacking

kwargs: UpdateLinkRequestTypeDef = {  # (1)
    "gatewayId": ...,
    "linkId": ...,
}

parent.update_link(**kwargs)

1. See UpdateLinkRequestTypeDef

update_link_module_flow

Updates a link module flow.

Type annotations and code completion for boto3.client("rtbfabric").update_link_module_flow method. boto3 documentation

# update_link_module_flow method definition

def update_link_module_flow(
    self,
    *,
    clientToken: str,
    gatewayId: str,
    linkId: str,
    modules: Sequence[ModuleConfigurationUnionTypeDef],  # (1)
) -> UpdateLinkModuleFlowResponseTypeDef:  # (2)
    ...

1. See Sequence[ModuleConfigurationUnionTypeDef]
2. See UpdateLinkModuleFlowResponseTypeDef

# update_link_module_flow method usage example with argument unpacking

kwargs: UpdateLinkModuleFlowRequestTypeDef = {  # (1)
    "clientToken": ...,
    "gatewayId": ...,
    "linkId": ...,
    "modules": ...,
}

parent.update_link_module_flow(**kwargs)

1. See UpdateLinkModuleFlowRequestTypeDef

update_requester_gateway

Updates a requester gateway.

Type annotations and code completion for boto3.client("rtbfabric").update_requester_gateway method. boto3 documentation

# update_requester_gateway method definition

def update_requester_gateway(
    self,
    *,
    clientToken: str,
    gatewayId: str,
    description: str = ...,
) -> UpdateRequesterGatewayResponseTypeDef:  # (1)
    ...

1. See UpdateRequesterGatewayResponseTypeDef

# update_requester_gateway method usage example with argument unpacking

kwargs: UpdateRequesterGatewayRequestTypeDef = {  # (1)
    "clientToken": ...,
    "gatewayId": ...,
}

parent.update_requester_gateway(**kwargs)

1. See UpdateRequesterGatewayRequestTypeDef

update_responder_gateway

Updates a responder gateway.

Type annotations and code completion for boto3.client("rtbfabric").update_responder_gateway method. boto3 documentation

# update_responder_gateway method definition

def update_responder_gateway(
    self,
    *,
    port: int,
    protocol: ProtocolType,  # (1)
    clientToken: str,
    gatewayId: str,
    domainName: str = ...,
    trustStoreConfiguration: TrustStoreConfigurationUnionTypeDef = ...,  # (2)
    managedEndpointConfiguration: ManagedEndpointConfigurationUnionTypeDef = ...,  # (3)
    description: str = ...,
) -> UpdateResponderGatewayResponseTypeDef:  # (4)
    ...

1. See ProtocolType
2. See TrustStoreConfigurationUnionTypeDef
3. See ManagedEndpointConfigurationUnionTypeDef
4. See UpdateResponderGatewayResponseTypeDef

# update_responder_gateway method usage example with argument unpacking

kwargs: UpdateResponderGatewayRequestTypeDef = {  # (1)
    "port": ...,
    "protocol": ...,
    "clientToken": ...,
    "gatewayId": ...,
}

parent.update_responder_gateway(**kwargs)

1. See UpdateResponderGatewayRequestTypeDef

get_paginator

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

• client.get_paginator("list_links") -> ListLinksPaginator
• client.get_paginator("list_requester_gateways") -> ListRequesterGatewaysPaginator
• client.get_paginator("list_responder_gateways") -> ListResponderGatewaysPaginator

get_waiter

Type annotations and code completion for boto3.client("rtbfabric").get_waiter method with overloads.

• client.get_waiter("inbound_external_link_active") -> InboundExternalLinkActiveWaiter
• client.get_waiter("link_accepted") -> LinkAcceptedWaiter
• client.get_waiter("link_active") -> LinkActiveWaiter
• client.get_waiter("outbound_external_link_active") -> OutboundExternalLinkActiveWaiter
• client.get_waiter("requester_gateway_active") -> RequesterGatewayActiveWaiter
• client.get_waiter("requester_gateway_deleted") -> RequesterGatewayDeletedWaiter
• client.get_waiter("responder_gateway_active") -> ResponderGatewayActiveWaiter
• client.get_waiter("responder_gateway_deleted") -> ResponderGatewayDeletedWaiter