rtbfabric/aws.sdk.kotlin.services.rtbfabric/RtbFabricClient

RtbFabricClient

Amazon Web Services RTB Fabric provides secure, low-latency infrastructure for connecting real-time bidding (RTB) applications. Rather than hosting applications directly, RTB Fabric acts as the connecting fabric that enables your applications to communicate efficiently over private networks instead of the public internet. You maintain complete control over your applications, data, and bidding decisions, while RTB Fabric provides the underlying infrastructure for secure, reliable connectivity.

You can use these APIs to complete RTB Fabric tasks, such as setting up audit log ingestions or viewing user access. For more information about RTB Fabric, including the required permissions to use the service, see the Amazon Web Services RTB Fabric User Guide.

Types

Builder

class Builder : AbstractSdkClientBuilder<RtbFabricClient.Config, RtbFabricClient.Config.Builder, RtbFabricClient>

Companion

object Companion : AbstractAwsSdkClientFactory<RtbFabricClient.Config, RtbFabricClient.Config.Builder, RtbFabricClient, RtbFabricClient.Builder>

Config

class Config : AwsSdkClientConfig, CredentialsProviderConfig, HttpAuthConfig, HttpClientConfig, HttpEngineConfig, IdempotencyTokenConfig, RetryClientConfig, RetryStrategyClientConfig, SdkClientConfig, TelemetryConfig, TimeoutConfig

Properties

config

abstract override val config: RtbFabricClient.Config

RtbFabricClient's configuration

Functions

acceptLink

abstract suspend fun acceptLink(input: AcceptLinkRequest): AcceptLinkResponse

Accepts a link request between gateways.

createInboundExternalLink

abstract suspend fun createInboundExternalLink(input: CreateInboundExternalLinkRequest): CreateInboundExternalLinkResponse

Creates an inbound external link.

createLink

abstract suspend fun createLink(input: CreateLinkRequest): CreateLinkResponse

Creates a new link between gateways.

createOutboundExternalLink

abstract suspend fun createOutboundExternalLink(input: CreateOutboundExternalLinkRequest): CreateOutboundExternalLinkResponse

Creates an outbound external link.

createRequesterGateway

abstract suspend fun createRequesterGateway(input: CreateRequesterGatewayRequest): CreateRequesterGatewayResponse

Creates a requester gateway.

createResponderGateway

abstract suspend fun createResponderGateway(input: CreateResponderGatewayRequest): CreateResponderGatewayResponse

Creates a responder gateway.

deleteInboundExternalLink

abstract suspend fun deleteInboundExternalLink(input: DeleteInboundExternalLinkRequest): DeleteInboundExternalLinkResponse

Deletes an inbound external link.

deleteLink

abstract suspend fun deleteLink(input: DeleteLinkRequest): DeleteLinkResponse

Deletes a link between gateways.

deleteOutboundExternalLink

abstract suspend fun deleteOutboundExternalLink(input: DeleteOutboundExternalLinkRequest): DeleteOutboundExternalLinkResponse

Deletes an outbound external link.

deleteRequesterGateway

abstract suspend fun deleteRequesterGateway(input: DeleteRequesterGatewayRequest): DeleteRequesterGatewayResponse

Deletes a requester gateway.

deleteResponderGateway

abstract suspend fun deleteResponderGateway(input: DeleteResponderGatewayRequest): DeleteResponderGatewayResponse

Deletes a responder gateway.

getInboundExternalLink

abstract suspend fun getInboundExternalLink(input: GetInboundExternalLinkRequest): GetInboundExternalLinkResponse

Retrieves information about an inbound external link.

getLink

abstract suspend fun getLink(input: GetLinkRequest): GetLinkResponse

Retrieves information about a link between gateways.

getOutboundExternalLink

abstract suspend fun getOutboundExternalLink(input: GetOutboundExternalLinkRequest): GetOutboundExternalLinkResponse

Retrieves information about an outbound external link.

getRequesterGateway

abstract suspend fun getRequesterGateway(input: GetRequesterGatewayRequest): GetRequesterGatewayResponse

Retrieves information about a requester gateway.

getResponderGateway

abstract suspend fun getResponderGateway(input: GetResponderGatewayRequest): GetResponderGatewayResponse

Retrieves information about a responder gateway.

listLinks

abstract suspend fun listLinks(input: ListLinksRequest): ListLinksResponse

Lists links associated with gateways.

listRequesterGateways

abstract suspend fun listRequesterGateways(input: ListRequesterGatewaysRequest = ListRequesterGatewaysRequest { }): ListRequesterGatewaysResponse

Lists requester gateways.

listResponderGateways

abstract suspend fun listResponderGateways(input: ListResponderGatewaysRequest = ListResponderGatewaysRequest { }): ListResponderGatewaysResponse

Lists reponder gateways.

listTagsForResource

abstract suspend fun listTagsForResource(input: ListTagsForResourceRequest): ListTagsForResourceResponse

Lists tags for a resource.

rejectLink

abstract suspend fun rejectLink(input: RejectLinkRequest): RejectLinkResponse

Rejects a link request between gateways.

tagResource

abstract suspend fun tagResource(input: TagResourceRequest): TagResourceResponse

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

untagResource

abstract suspend fun untagResource(input: UntagResourceRequest): UntagResourceResponse

Removes a tag or tags from a resource.

updateLink

abstract suspend fun updateLink(input: UpdateLinkRequest): UpdateLinkResponse

Updates the configuration of a link between gateways.

updateLinkModuleFlow

abstract suspend fun updateLinkModuleFlow(input: UpdateLinkModuleFlowRequest): UpdateLinkModuleFlowResponse

Updates a link module flow.

updateRequesterGateway

abstract suspend fun updateRequesterGateway(input: UpdateRequesterGatewayRequest): UpdateRequesterGatewayResponse

Updates a requester gateway.

updateResponderGateway

abstract suspend fun updateResponderGateway(input: UpdateResponderGatewayRequest): UpdateResponderGatewayResponse

Updates a responder gateway.

Inherited functions

acceptLink

inline suspend fun RtbFabricClient.acceptLink(crossinline block: AcceptLinkRequest.Builder.() -> Unit): AcceptLinkResponse

Accepts a link request between gateways.

expect abstract fun close()

createInboundExternalLink

inline suspend fun RtbFabricClient.createInboundExternalLink(crossinline block: CreateInboundExternalLinkRequest.Builder.() -> Unit): CreateInboundExternalLinkResponse

Creates an inbound external link.

createLink

inline suspend fun RtbFabricClient.createLink(crossinline block: CreateLinkRequest.Builder.() -> Unit): CreateLinkResponse

Creates a new link between gateways.

createOutboundExternalLink

inline suspend fun RtbFabricClient.createOutboundExternalLink(crossinline block: CreateOutboundExternalLinkRequest.Builder.() -> Unit): CreateOutboundExternalLinkResponse

Creates an outbound external link.

createRequesterGateway

inline suspend fun RtbFabricClient.createRequesterGateway(crossinline block: CreateRequesterGatewayRequest.Builder.() -> Unit): CreateRequesterGatewayResponse

Creates a requester gateway.

createResponderGateway

inline suspend fun RtbFabricClient.createResponderGateway(crossinline block: CreateResponderGatewayRequest.Builder.() -> Unit): CreateResponderGatewayResponse

Creates a responder gateway.

deleteInboundExternalLink

inline suspend fun RtbFabricClient.deleteInboundExternalLink(crossinline block: DeleteInboundExternalLinkRequest.Builder.() -> Unit): DeleteInboundExternalLinkResponse

Deletes an inbound external link.

deleteLink

inline suspend fun RtbFabricClient.deleteLink(crossinline block: DeleteLinkRequest.Builder.() -> Unit): DeleteLinkResponse

Deletes a link between gateways.

deleteOutboundExternalLink

inline suspend fun RtbFabricClient.deleteOutboundExternalLink(crossinline block: DeleteOutboundExternalLinkRequest.Builder.() -> Unit): DeleteOutboundExternalLinkResponse

Deletes an outbound external link.

deleteRequesterGateway

inline suspend fun RtbFabricClient.deleteRequesterGateway(crossinline block: DeleteRequesterGatewayRequest.Builder.() -> Unit): DeleteRequesterGatewayResponse

Deletes a requester gateway.

deleteResponderGateway

inline suspend fun RtbFabricClient.deleteResponderGateway(crossinline block: DeleteResponderGatewayRequest.Builder.() -> Unit): DeleteResponderGatewayResponse

Deletes a responder gateway.

getInboundExternalLink

inline suspend fun RtbFabricClient.getInboundExternalLink(crossinline block: GetInboundExternalLinkRequest.Builder.() -> Unit): GetInboundExternalLinkResponse

Retrieves information about an inbound external link.

getLink

inline suspend fun RtbFabricClient.getLink(crossinline block: GetLinkRequest.Builder.() -> Unit): GetLinkResponse

Retrieves information about a link between gateways.

getOutboundExternalLink

inline suspend fun RtbFabricClient.getOutboundExternalLink(crossinline block: GetOutboundExternalLinkRequest.Builder.() -> Unit): GetOutboundExternalLinkResponse

Retrieves information about an outbound external link.

getRequesterGateway

inline suspend fun RtbFabricClient.getRequesterGateway(crossinline block: GetRequesterGatewayRequest.Builder.() -> Unit): GetRequesterGatewayResponse

Retrieves information about a requester gateway.

getResponderGateway

inline suspend fun RtbFabricClient.getResponderGateway(crossinline block: GetResponderGatewayRequest.Builder.() -> Unit): GetResponderGatewayResponse

Retrieves information about a responder gateway.

listLinks

inline suspend fun RtbFabricClient.listLinks(crossinline block: ListLinksRequest.Builder.() -> Unit): ListLinksResponse

Lists links associated with gateways.

listLinksPaginated

fun RtbFabricClient.listLinksPaginated(initialRequest: ListLinksRequest): Flow<ListLinksResponse>

fun RtbFabricClient.listLinksPaginated(block: ListLinksRequest.Builder.() -> Unit): Flow<ListLinksResponse>

Paginate over ListLinksResponse results.

listRequesterGateways

inline suspend fun RtbFabricClient.listRequesterGateways(crossinline block: ListRequesterGatewaysRequest.Builder.() -> Unit): ListRequesterGatewaysResponse

Lists requester gateways.

listRequesterGatewaysPaginated

fun RtbFabricClient.listRequesterGatewaysPaginated(initialRequest: ListRequesterGatewaysRequest = ListRequesterGatewaysRequest { }): Flow<ListRequesterGatewaysResponse>

fun RtbFabricClient.listRequesterGatewaysPaginated(block: ListRequesterGatewaysRequest.Builder.() -> Unit): Flow<ListRequesterGatewaysResponse>

Paginate over ListRequesterGatewaysResponse results.

listResponderGateways

inline suspend fun RtbFabricClient.listResponderGateways(crossinline block: ListResponderGatewaysRequest.Builder.() -> Unit): ListResponderGatewaysResponse

Lists reponder gateways.

listResponderGatewaysPaginated

fun RtbFabricClient.listResponderGatewaysPaginated(initialRequest: ListResponderGatewaysRequest = ListResponderGatewaysRequest { }): Flow<ListResponderGatewaysResponse>

fun RtbFabricClient.listResponderGatewaysPaginated(block: ListResponderGatewaysRequest.Builder.() -> Unit): Flow<ListResponderGatewaysResponse>

Paginate over ListResponderGatewaysResponse results.

listTagsForResource

inline suspend fun RtbFabricClient.listTagsForResource(crossinline block: ListTagsForResourceRequest.Builder.() -> Unit): ListTagsForResourceResponse

Lists tags for a resource.

rejectLink

inline suspend fun RtbFabricClient.rejectLink(crossinline block: RejectLinkRequest.Builder.() -> Unit): RejectLinkResponse

Rejects a link request between gateways.

tagResource

inline suspend fun RtbFabricClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

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

untagResource

inline suspend fun RtbFabricClient.untagResource(crossinline block: UntagResourceRequest.Builder.() -> Unit): UntagResourceResponse

Removes a tag or tags from a resource.

updateLink

inline suspend fun RtbFabricClient.updateLink(crossinline block: UpdateLinkRequest.Builder.() -> Unit): UpdateLinkResponse

Updates the configuration of a link between gateways.

updateLinkModuleFlow

inline suspend fun RtbFabricClient.updateLinkModuleFlow(crossinline block: UpdateLinkModuleFlowRequest.Builder.() -> Unit): UpdateLinkModuleFlowResponse

Updates a link module flow.

updateRequesterGateway

inline suspend fun RtbFabricClient.updateRequesterGateway(crossinline block: UpdateRequesterGatewayRequest.Builder.() -> Unit): UpdateRequesterGatewayResponse

Updates a requester gateway.

updateResponderGateway

inline suspend fun RtbFabricClient.updateResponderGateway(crossinline block: UpdateResponderGatewayRequest.Builder.() -> Unit): UpdateResponderGatewayResponse

Updates a responder gateway.

waitUntilInboundExternalLinkActive

suspend fun RtbFabricClient.waitUntilInboundExternalLinkActive(block: GetInboundExternalLinkRequest.Builder.() -> Unit): Outcome<GetInboundExternalLinkResponse>

suspend fun RtbFabricClient.waitUntilInboundExternalLinkActive(request: GetInboundExternalLinkRequest, retryStrategy: RetryStrategy? = null): Outcome<GetInboundExternalLinkResponse>

waitUntilLinkAccepted

suspend fun RtbFabricClient.waitUntilLinkAccepted(block: GetLinkRequest.Builder.() -> Unit): Outcome<GetLinkResponse>

suspend fun RtbFabricClient.waitUntilLinkAccepted(request: GetLinkRequest, retryStrategy: RetryStrategy? = null): Outcome<GetLinkResponse>

waitUntilLinkActive

suspend fun RtbFabricClient.waitUntilLinkActive(block: GetLinkRequest.Builder.() -> Unit): Outcome<GetLinkResponse>

suspend fun RtbFabricClient.waitUntilLinkActive(request: GetLinkRequest, retryStrategy: RetryStrategy? = null): Outcome<GetLinkResponse>

waitUntilOutboundExternalLinkActive

suspend fun RtbFabricClient.waitUntilOutboundExternalLinkActive(block: GetOutboundExternalLinkRequest.Builder.() -> Unit): Outcome<GetOutboundExternalLinkResponse>

suspend fun RtbFabricClient.waitUntilOutboundExternalLinkActive(request: GetOutboundExternalLinkRequest, retryStrategy: RetryStrategy? = null): Outcome<GetOutboundExternalLinkResponse>

waitUntilRequesterGatewayActive

suspend fun RtbFabricClient.waitUntilRequesterGatewayActive(block: GetRequesterGatewayRequest.Builder.() -> Unit): Outcome<GetRequesterGatewayResponse>

suspend fun RtbFabricClient.waitUntilRequesterGatewayActive(request: GetRequesterGatewayRequest, retryStrategy: RetryStrategy? = null): Outcome<GetRequesterGatewayResponse>

waitUntilRequesterGatewayDeleted

suspend fun RtbFabricClient.waitUntilRequesterGatewayDeleted(block: GetRequesterGatewayRequest.Builder.() -> Unit): Outcome<GetRequesterGatewayResponse>

suspend fun RtbFabricClient.waitUntilRequesterGatewayDeleted(request: GetRequesterGatewayRequest, retryStrategy: RetryStrategy? = null): Outcome<GetRequesterGatewayResponse>

waitUntilResponderGatewayActive

suspend fun RtbFabricClient.waitUntilResponderGatewayActive(block: GetResponderGatewayRequest.Builder.() -> Unit): Outcome<GetResponderGatewayResponse>

suspend fun RtbFabricClient.waitUntilResponderGatewayActive(request: GetResponderGatewayRequest, retryStrategy: RetryStrategy? = null): Outcome<GetResponderGatewayResponse>

waitUntilResponderGatewayDeleted

suspend fun RtbFabricClient.waitUntilResponderGatewayDeleted(block: GetResponderGatewayRequest.Builder.() -> Unit): Outcome<GetResponderGatewayResponse>

suspend fun RtbFabricClient.waitUntilResponderGatewayDeleted(request: GetResponderGatewayRequest, retryStrategy: RetryStrategy? = null): Outcome<GetResponderGatewayResponse>

withConfig

fun RtbFabricClient.withConfig(block: RtbFabricClient.Config.Builder.() -> Unit): RtbFabricClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.