- Navigation GuideYou are on a Client landing page. Commands (operations) are listed on this page. The Client constructor type is linked at the bottom.
AppIntegrationsClient
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 the following topics in the Amazon Connect Administrator Guide:
Installation
npm install @aws-sdk/client-appintegrations
yarn add @aws-sdk/client-appintegrations
pnpm add @aws-sdk/client-appintegrations
AppIntegrationsClient Operations
Command | Summary |
---|
Command | Summary |
---|---|
CreateApplicationCommand | Creates and persists an Application resource. |
CreateDataIntegrationAssociationCommand | Creates and persists a DataIntegrationAssociation resource. |
CreateDataIntegrationCommand | Creates and persists a DataIntegration resource. You cannot create a DataIntegration association for a DataIntegration that has been previously associated. Use a different DataIntegration, or recreate the DataIntegration using the |
CreateEventIntegrationCommand | 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. |
DeleteApplicationCommand | Deletes the Application. Only Applications that don't have any Application Associations can be deleted. |
DeleteDataIntegrationCommand | 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. You cannot create a DataIntegration association for a DataIntegration that has been previously associated. Use a different DataIntegration, or recreate the DataIntegration using the CreateDataIntegration API. |
DeleteEventIntegrationCommand | Deletes the specified existing event integration. If the event integration is associated with clients, the request is rejected. |
GetApplicationCommand | Get an Application resource. |
GetDataIntegrationCommand | Returns information about the DataIntegration. You cannot create a DataIntegration association for a DataIntegration that has been previously associated. Use a different DataIntegration, or recreate the DataIntegration using the CreateDataIntegration API. |
GetEventIntegrationCommand | Returns information about the event integration. |
ListApplicationAssociationsCommand | Returns a paginated list of application associations for an application. |
ListApplicationsCommand | Lists applications in the account. |
ListDataIntegrationAssociationsCommand | Returns a paginated list of DataIntegration associations in the account. You cannot create a DataIntegration association for a DataIntegration that has been previously associated. Use a different DataIntegration, or recreate the DataIntegration using the CreateDataIntegration API. |
ListDataIntegrationsCommand | Returns a paginated list of DataIntegrations in the account. You cannot create a DataIntegration association for a DataIntegration that has been previously associated. Use a different DataIntegration, or recreate the DataIntegration using the CreateDataIntegration API. |
ListEventIntegrationAssociationsCommand | Returns a paginated list of event integration associations in the account. |
ListEventIntegrationsCommand | Returns a paginated list of event integrations in the account. |
ListTagsForResourceCommand | Lists the tags for the specified resource. |
TagResourceCommand | Adds the specified tags to the specified resource. |
UntagResourceCommand | Removes the specified tags from the specified resource. |
UpdateApplicationCommand | Updates and persists an Application resource. |
UpdateDataIntegrationAssociationCommand | Updates and persists a DataIntegrationAssociation resource. Updating a DataIntegrationAssociation with ExecutionConfiguration will rerun the on-demand job. |
UpdateDataIntegrationCommand | Updates the description of a DataIntegration. You cannot create a DataIntegration association for a DataIntegration that has been previously associated. Use a different DataIntegration, or recreate the DataIntegration using the CreateDataIntegration API. |
UpdateEventIntegrationCommand | Updates the description of an event integration. |
AppIntegrationsClient Configuration
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
defaultsMode Optional | DefaultsMode | Provider<DefaultsMode> | The @smithy/smithy-client#DefaultsMode that will be used to determine how certain default configuration options are resolved in the SDK. |
disableHostPrefix Optional | boolean | Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation. |
extensions Optional | RuntimeExtension[] | Optional extensions |
logger Optional | Logger | Optional logger for logging debug/info/warn/error. |
maxAttempts Optional | number | Provider<number> | Value for how many times a request will be made at most in case of retry. |
profile Optional | string | Setting a client profile is similar to setting a value for the AWS_PROFILE environment variable. Setting a profile on a client in code only affects the single client instance, unlike AWS_PROFILE.When set, and only for environments where an AWS configuration file exists, fields configurable by this file will be retrieved from the specified profile within that file. Conflicting code configuration and environment variables will still have higher priority.For client credential resolution that involves checking the AWS configuration file, the client's profile (this value) will be used unless a different profile is set in the credential provider options. |
region Optional | string | Provider<string> | The AWS region to which this client will send requests |
requestHandler Optional | __HttpHandlerUserInput | The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs. |
retryMode Optional | string | Provider<string> | Specifies which retry algorithm to use. |
useDualstackEndpoint Optional | boolean | Provider<boolean> | Enables IPv6/IPv4 dualstack endpoint. |
useFipsEndpoint Optional | boolean | Provider<boolean> | Enables FIPS compatible endpoints. |
Additional config fields are described in the full configuration type: AppIntegrationsClientConfig