apigatewaymanagementapi/aws.sdk.kotlin.services.apigatewaymanagementapi/ApiGatewayManagementClient

ApiGatewayManagementClient

interface ApiGatewayManagementClient : SdkClient

The Amazon API Gateway Management API allows you to directly manage runtime aspects of your deployed APIs. To use it, you must explicitly set the SDK's endpoint to point to the endpoint of your deployed API. The endpoint will be of the form https://{api-id}.execute-api.{region}.amazonaws.com/{stage}, or will be the endpoint corresponding to your API's custom domain and base path, if applicable.

Types

Builder

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

Companion

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

Config

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

Properties

config

abstract override val config: ApiGatewayManagementClient.Config

ApiGatewayManagementClient's configuration

Functions

deleteConnection

abstract suspend fun deleteConnection(input: DeleteConnectionRequest): DeleteConnectionResponse

Delete the connection with the provided id.

getConnection

abstract suspend fun getConnection(input: GetConnectionRequest): GetConnectionResponse

Get information about the connection with the provided id.

postToConnection

abstract suspend fun postToConnection(input: PostToConnectionRequest): PostToConnectionResponse

Sends the provided data to the specified connection.

Inherited functions

expect abstract fun close()

deleteConnection

inline suspend fun ApiGatewayManagementClient.deleteConnection(crossinline block: DeleteConnectionRequest.Builder.() -> Unit): DeleteConnectionResponse

Delete the connection with the provided id.

getConnection

inline suspend fun ApiGatewayManagementClient.getConnection(crossinline block: GetConnectionRequest.Builder.() -> Unit): GetConnectionResponse

Get information about the connection with the provided id.

postToConnection

inline suspend fun ApiGatewayManagementClient.postToConnection(crossinline block: PostToConnectionRequest.Builder.() -> Unit): PostToConnectionResponse

Sends the provided data to the specified connection.

withConfig

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

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.