appintegrations/aws.sdk.kotlin.services.appintegrations/AppIntegrationsClient

AppIntegrationsClient

interface AppIntegrationsClient : SdkClient

The Amazon AppIntegrations service enables you to configure and reuse connections to external applications.

For information about how you can use external applications with Amazon Connect, see Set up pre-built integrations and Deliver information to agents using Amazon Connect Wisdom in the Amazon Connect Administrator Guide.

Types

Builder

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

Companion

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

Config

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

Properties

config

abstract override val config: AppIntegrationsClient.Config

AppIntegrationsClient's configuration

Functions

createApplication

abstract suspend fun createApplication(input: CreateApplicationRequest): CreateApplicationResponse

This API is in preview release and subject to change.

createDataIntegration

abstract suspend fun createDataIntegration(input: CreateDataIntegrationRequest): CreateDataIntegrationResponse

Creates and persists a DataIntegration resource.

createEventIntegration

abstract suspend fun createEventIntegration(input: CreateEventIntegrationRequest): CreateEventIntegrationResponse

Creates an EventIntegration, given a specified name, description, and a reference to an Amazon EventBridge bus in your account and a partner event source that pushes events to that bus. No objects are created in the your account, only metadata that is persisted on the EventIntegration control plane.

deleteApplication

abstract suspend fun deleteApplication(input: DeleteApplicationRequest): DeleteApplicationResponse

Deletes the Application. Only Applications that don't have any Application Associations can be deleted.

deleteDataIntegration

abstract suspend fun deleteDataIntegration(input: DeleteDataIntegrationRequest): DeleteDataIntegrationResponse

Deletes the DataIntegration. Only DataIntegrations that don't have any DataIntegrationAssociations can be deleted. Deleting a DataIntegration also deletes the underlying Amazon AppFlow flow and service linked role.

deleteEventIntegration

abstract suspend fun deleteEventIntegration(input: DeleteEventIntegrationRequest): DeleteEventIntegrationResponse

Deletes the specified existing event integration. If the event integration is associated with clients, the request is rejected.

getApplication

abstract suspend fun getApplication(input: GetApplicationRequest): GetApplicationResponse

This API is in preview release and subject to change.

getDataIntegration

abstract suspend fun getDataIntegration(input: GetDataIntegrationRequest): GetDataIntegrationResponse

Returns information about the DataIntegration.

getEventIntegration

abstract suspend fun getEventIntegration(input: GetEventIntegrationRequest): GetEventIntegrationResponse

Returns information about the event integration.

listApplicationAssociations

abstract suspend fun listApplicationAssociations(input: ListApplicationAssociationsRequest): ListApplicationAssociationsResponse

Returns a paginated list of application associations for an application.

listApplications

abstract suspend fun listApplications(input: ListApplicationsRequest = ListApplicationsRequest { }): ListApplicationsResponse

This API is in preview release and subject to change.

listDataIntegrationAssociations

abstract suspend fun listDataIntegrationAssociations(input: ListDataIntegrationAssociationsRequest): ListDataIntegrationAssociationsResponse

Returns a paginated list of DataIntegration associations in the account.

listDataIntegrations

abstract suspend fun listDataIntegrations(input: ListDataIntegrationsRequest = ListDataIntegrationsRequest { }): ListDataIntegrationsResponse

Returns a paginated list of DataIntegrations in the account.

listEventIntegrationAssociations

abstract suspend fun listEventIntegrationAssociations(input: ListEventIntegrationAssociationsRequest): ListEventIntegrationAssociationsResponse

Returns a paginated list of event integration associations in the account.

listEventIntegrations

abstract suspend fun listEventIntegrations(input: ListEventIntegrationsRequest = ListEventIntegrationsRequest { }): ListEventIntegrationsResponse

Returns a paginated list of event integrations in the account.

listTagsForResource

abstract suspend fun listTagsForResource(input: ListTagsForResourceRequest): ListTagsForResourceResponse

Lists the tags for the specified resource.

tagResource

abstract suspend fun tagResource(input: TagResourceRequest): TagResourceResponse

Adds the specified tags to the specified resource.

untagResource

abstract suspend fun untagResource(input: UntagResourceRequest): UntagResourceResponse

Removes the specified tags from the specified resource.

updateApplication

abstract suspend fun updateApplication(input: UpdateApplicationRequest): UpdateApplicationResponse

This API is in preview release and subject to change.

updateDataIntegration

abstract suspend fun updateDataIntegration(input: UpdateDataIntegrationRequest): UpdateDataIntegrationResponse

Updates the description of a DataIntegration.

updateEventIntegration

abstract suspend fun updateEventIntegration(input: UpdateEventIntegrationRequest): UpdateEventIntegrationResponse

Updates the description of an event integration.

Inherited functions

expect abstract fun close()

createApplication

inline suspend fun AppIntegrationsClient.createApplication(crossinline block: CreateApplicationRequest.Builder.() -> Unit): CreateApplicationResponse

This API is in preview release and subject to change.

createDataIntegration

inline suspend fun AppIntegrationsClient.createDataIntegration(crossinline block: CreateDataIntegrationRequest.Builder.() -> Unit): CreateDataIntegrationResponse

Creates and persists a DataIntegration resource.

createEventIntegration

inline suspend fun AppIntegrationsClient.createEventIntegration(crossinline block: CreateEventIntegrationRequest.Builder.() -> Unit): CreateEventIntegrationResponse

deleteApplication

inline suspend fun AppIntegrationsClient.deleteApplication(crossinline block: DeleteApplicationRequest.Builder.() -> Unit): DeleteApplicationResponse

Deletes the Application. Only Applications that don't have any Application Associations can be deleted.

deleteDataIntegration

inline suspend fun AppIntegrationsClient.deleteDataIntegration(crossinline block: DeleteDataIntegrationRequest.Builder.() -> Unit): DeleteDataIntegrationResponse

deleteEventIntegration

inline suspend fun AppIntegrationsClient.deleteEventIntegration(crossinline block: DeleteEventIntegrationRequest.Builder.() -> Unit): DeleteEventIntegrationResponse

Deletes the specified existing event integration. If the event integration is associated with clients, the request is rejected.

getApplication

inline suspend fun AppIntegrationsClient.getApplication(crossinline block: GetApplicationRequest.Builder.() -> Unit): GetApplicationResponse

This API is in preview release and subject to change.

getDataIntegration

inline suspend fun AppIntegrationsClient.getDataIntegration(crossinline block: GetDataIntegrationRequest.Builder.() -> Unit): GetDataIntegrationResponse

Returns information about the DataIntegration.

getEventIntegration

inline suspend fun AppIntegrationsClient.getEventIntegration(crossinline block: GetEventIntegrationRequest.Builder.() -> Unit): GetEventIntegrationResponse

Returns information about the event integration.

listApplicationAssociations

inline suspend fun AppIntegrationsClient.listApplicationAssociations(crossinline block: ListApplicationAssociationsRequest.Builder.() -> Unit): ListApplicationAssociationsResponse

Returns a paginated list of application associations for an application.

listApplicationAssociationsPaginated

fun AppIntegrationsClient.listApplicationAssociationsPaginated(initialRequest: ListApplicationAssociationsRequest): Flow<ListApplicationAssociationsResponse>

fun AppIntegrationsClient.listApplicationAssociationsPaginated(block: ListApplicationAssociationsRequest.Builder.() -> Unit): Flow<ListApplicationAssociationsResponse>

Paginate over ListApplicationAssociationsResponse results.

listApplications

inline suspend fun AppIntegrationsClient.listApplications(crossinline block: ListApplicationsRequest.Builder.() -> Unit): ListApplicationsResponse

This API is in preview release and subject to change.

listApplicationsPaginated

fun AppIntegrationsClient.listApplicationsPaginated(initialRequest: ListApplicationsRequest = ListApplicationsRequest { }): Flow<ListApplicationsResponse>

fun AppIntegrationsClient.listApplicationsPaginated(block: ListApplicationsRequest.Builder.() -> Unit): Flow<ListApplicationsResponse>

Paginate over ListApplicationsResponse results.

listDataIntegrationAssociations

inline suspend fun AppIntegrationsClient.listDataIntegrationAssociations(crossinline block: ListDataIntegrationAssociationsRequest.Builder.() -> Unit): ListDataIntegrationAssociationsResponse

Returns a paginated list of DataIntegration associations in the account.

listDataIntegrationAssociationsPaginated

fun AppIntegrationsClient.listDataIntegrationAssociationsPaginated(initialRequest: ListDataIntegrationAssociationsRequest): Flow<ListDataIntegrationAssociationsResponse>

fun AppIntegrationsClient.listDataIntegrationAssociationsPaginated(block: ListDataIntegrationAssociationsRequest.Builder.() -> Unit): Flow<ListDataIntegrationAssociationsResponse>

Paginate over ListDataIntegrationAssociationsResponse results.

listDataIntegrations

inline suspend fun AppIntegrationsClient.listDataIntegrations(crossinline block: ListDataIntegrationsRequest.Builder.() -> Unit): ListDataIntegrationsResponse

Returns a paginated list of DataIntegrations in the account.

listDataIntegrationsPaginated

fun AppIntegrationsClient.listDataIntegrationsPaginated(initialRequest: ListDataIntegrationsRequest = ListDataIntegrationsRequest { }): Flow<ListDataIntegrationsResponse>

fun AppIntegrationsClient.listDataIntegrationsPaginated(block: ListDataIntegrationsRequest.Builder.() -> Unit): Flow<ListDataIntegrationsResponse>

Paginate over ListDataIntegrationsResponse results.

listEventIntegrationAssociations

inline suspend fun AppIntegrationsClient.listEventIntegrationAssociations(crossinline block: ListEventIntegrationAssociationsRequest.Builder.() -> Unit): ListEventIntegrationAssociationsResponse

Returns a paginated list of event integration associations in the account.

listEventIntegrationAssociationsPaginated

fun AppIntegrationsClient.listEventIntegrationAssociationsPaginated(initialRequest: ListEventIntegrationAssociationsRequest): Flow<ListEventIntegrationAssociationsResponse>

fun AppIntegrationsClient.listEventIntegrationAssociationsPaginated(block: ListEventIntegrationAssociationsRequest.Builder.() -> Unit): Flow<ListEventIntegrationAssociationsResponse>

Paginate over ListEventIntegrationAssociationsResponse results.

listEventIntegrations

inline suspend fun AppIntegrationsClient.listEventIntegrations(crossinline block: ListEventIntegrationsRequest.Builder.() -> Unit): ListEventIntegrationsResponse

Returns a paginated list of event integrations in the account.

listEventIntegrationsPaginated

fun AppIntegrationsClient.listEventIntegrationsPaginated(initialRequest: ListEventIntegrationsRequest = ListEventIntegrationsRequest { }): Flow<ListEventIntegrationsResponse>

fun AppIntegrationsClient.listEventIntegrationsPaginated(block: ListEventIntegrationsRequest.Builder.() -> Unit): Flow<ListEventIntegrationsResponse>

Paginate over ListEventIntegrationsResponse results.

listTagsForResource

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

Lists the tags for the specified resource.

tagResource

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

Adds the specified tags to the specified resource.

untagResource

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

Removes the specified tags from the specified resource.

updateApplication

inline suspend fun AppIntegrationsClient.updateApplication(crossinline block: UpdateApplicationRequest.Builder.() -> Unit): UpdateApplicationResponse

This API is in preview release and subject to change.

updateDataIntegration

inline suspend fun AppIntegrationsClient.updateDataIntegration(crossinline block: UpdateDataIntegrationRequest.Builder.() -> Unit): UpdateDataIntegrationResponse

Updates the description of a DataIntegration.

updateEventIntegration

inline suspend fun AppIntegrationsClient.updateEventIntegration(crossinline block: UpdateEventIntegrationRequest.Builder.() -> Unit): UpdateEventIntegrationResponse

Updates the description of an event integration.

withConfig

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

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.