interconnect/aws.sdk.kotlin.services.interconnect/InterconnectClient

InterconnectClient

interface InterconnectClient

Provides managed connections between your AWS network resources and select partner network resources.

Types

Builder

class Builder

Companion

object Companion

Config

class Config

Properties

config

abstract val config: InterconnectClient.Config

InterconnectClient's configuration

Functions

acceptConnectionProposal

abstract suspend fun acceptConnectionProposal(input: AcceptConnectionProposalRequest): AcceptConnectionProposalResponse

Accepts a connection proposal which was generated at a supported partner's portal.

createConnection

abstract suspend fun createConnection(input: CreateConnectionRequest): CreateConnectionResponse

Initiates the process to create a Connection across the specified Environment.

deleteConnection

abstract suspend fun deleteConnection(input: DeleteConnectionRequest): DeleteConnectionResponse

Deletes an existing Connection with the supplied identifier.

describeConnectionProposal

abstract suspend fun describeConnectionProposal(input: DescribeConnectionProposalRequest): DescribeConnectionProposalResponse

Describes the details of a connection proposal generated at a partner's portal.

getConnection

abstract suspend fun getConnection(input: GetConnectionRequest): GetConnectionResponse

Describes the current state of a Connection resource as specified by the identifier.

getEnvironment

abstract suspend fun getEnvironment(input: GetEnvironmentRequest): GetEnvironmentResponse

Describes a specific Environment

listAttachPoints

abstract suspend fun listAttachPoints(input: ListAttachPointsRequest): ListAttachPointsResponse

Lists all Attach Points the caller has access to that are valid for the specified Environment.

listConnections

abstract suspend fun listConnections(input: ListConnectionsRequest = ListConnectionsRequest { }): ListConnectionsResponse

Lists all connection objects to which the caller has access.

listEnvironments

abstract suspend fun listEnvironments(input: ListEnvironmentsRequest = ListEnvironmentsRequest { }): ListEnvironmentsResponse

Lists all of the environments that can produce connections that will land in the called AWS region.

listTagsForResource

abstract suspend fun listTagsForResource(input: ListTagsForResourceRequest): ListTagsForResourceResponse

List all current tags on the specified resource. Currently this supports Connection resources.

tagResource

abstract suspend fun tagResource(input: TagResourceRequest): TagResourceResponse

Add new tags to the specified resource.

untagResource

abstract suspend fun untagResource(input: UntagResourceRequest): UntagResourceResponse

Removes tags from the specified resource.

updateConnection

abstract suspend fun updateConnection(input: UpdateConnectionRequest): UpdateConnectionResponse

Modifies an existing connection. Currently we support modifications to the connection's description and/or bandwidth.

Inherited functions

acceptConnectionProposal

inline suspend fun InterconnectClient.acceptConnectionProposal(crossinline block: AcceptConnectionProposalRequest.Builder.() -> Unit): AcceptConnectionProposalResponse

Accepts a connection proposal which was generated at a supported partner's portal.

createConnection

inline suspend fun InterconnectClient.createConnection(crossinline block: CreateConnectionRequest.Builder.() -> Unit): CreateConnectionResponse

Initiates the process to create a Connection across the specified Environment.

deleteConnection

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

Deletes an existing Connection with the supplied identifier.

describeConnectionProposal

inline suspend fun InterconnectClient.describeConnectionProposal(crossinline block: DescribeConnectionProposalRequest.Builder.() -> Unit): DescribeConnectionProposalResponse

Describes the details of a connection proposal generated at a partner's portal.

getConnection

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

Describes the current state of a Connection resource as specified by the identifier.

getEnvironment

inline suspend fun InterconnectClient.getEnvironment(crossinline block: GetEnvironmentRequest.Builder.() -> Unit): GetEnvironmentResponse

Describes a specific Environment

listAttachPoints

inline suspend fun InterconnectClient.listAttachPoints(crossinline block: ListAttachPointsRequest.Builder.() -> Unit): ListAttachPointsResponse

Lists all Attach Points the caller has access to that are valid for the specified Environment.

listAttachPointsPaginated

fun InterconnectClient.listAttachPointsPaginated(initialRequest: ListAttachPointsRequest): Flow<ListAttachPointsResponse>

fun InterconnectClient.listAttachPointsPaginated(block: ListAttachPointsRequest.Builder.() -> Unit): Flow<ListAttachPointsResponse>

Paginate over ListAttachPointsResponse results.

listConnections

inline suspend fun InterconnectClient.listConnections(crossinline block: ListConnectionsRequest.Builder.() -> Unit): ListConnectionsResponse

Lists all connection objects to which the caller has access.

listConnectionsPaginated

fun InterconnectClient.listConnectionsPaginated(initialRequest: ListConnectionsRequest = ListConnectionsRequest { }): Flow<ListConnectionsResponse>

fun InterconnectClient.listConnectionsPaginated(block: ListConnectionsRequest.Builder.() -> Unit): Flow<ListConnectionsResponse>

Paginate over ListConnectionsResponse results.

listEnvironments

inline suspend fun InterconnectClient.listEnvironments(crossinline block: ListEnvironmentsRequest.Builder.() -> Unit): ListEnvironmentsResponse

Lists all of the environments that can produce connections that will land in the called AWS region.

listEnvironmentsPaginated

fun InterconnectClient.listEnvironmentsPaginated(initialRequest: ListEnvironmentsRequest = ListEnvironmentsRequest { }): Flow<ListEnvironmentsResponse>

fun InterconnectClient.listEnvironmentsPaginated(block: ListEnvironmentsRequest.Builder.() -> Unit): Flow<ListEnvironmentsResponse>

Paginate over ListEnvironmentsResponse results.

listTagsForResource

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

List all current tags on the specified resource. Currently this supports Connection resources.

tagResource

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

Add new tags to the specified resource.

untagResource

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

Removes tags from the specified resource.

updateConnection

inline suspend fun InterconnectClient.updateConnection(crossinline block: UpdateConnectionRequest.Builder.() -> Unit): UpdateConnectionResponse

Modifies an existing connection. Currently we support modifications to the connection's description and/or bandwidth.

waitUntilConnectionAvailable

suspend fun InterconnectClient.waitUntilConnectionAvailable(block: GetConnectionRequest.Builder.() -> Unit): <Error class: unknown class><GetConnectionResponse>

suspend fun InterconnectClient.waitUntilConnectionAvailable(request: GetConnectionRequest, retryStrategy: <Error class: unknown class>? = null): <Error class: unknown class><GetConnectionResponse>

waitUntilConnectionDeleted

suspend fun InterconnectClient.waitUntilConnectionDeleted(block: GetConnectionRequest.Builder.() -> Unit): <Error class: unknown class><GetConnectionResponse>

suspend fun InterconnectClient.waitUntilConnectionDeleted(request: GetConnectionRequest, retryStrategy: <Error class: unknown class>? = null): <Error class: unknown class><GetConnectionResponse>

withConfig

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

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.