Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@datafire/amazonaws_appintegrations

DataFire2MIT5.0.0

DataFire integration for Amazon AppIntegrations Service

readme

@datafire/amazonaws_appintegrations

Client library for Amazon AppIntegrations Service

Installation and Usage

npm install --save @datafire/amazonaws_appintegrations
let amazonaws_appintegrations = require('@datafire/amazonaws_appintegrations').create({
  accessKeyId: "",
  secretAccessKey: "",
  region: ""
});

.then(data => {
  console.log(data);
});

Description

The Amazon AppIntegrations APIs are in preview release and are subject to change.

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 in the Amazon Connect Administrator Guide.

Actions

ListEventIntegrations

amazonaws_appintegrations.ListEventIntegrations({}, context)

Input

  • input object
    • nextToken string
    • maxResults integer

Output

CreateEventIntegration

amazonaws_appintegrations.CreateEventIntegration({
  "Name": "",
  "EventFilter": {},
  "EventBridgeBus": ""
}, context)

Input

  • input object
    • ClientToken string: A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
    • Description string: The description of the event integration.
    • EventBridgeBus required string: The Eventbridge bus.
    • EventFilter required object:

      The Amazon AppIntegrations APIs are in preview release and are subject to change.

      The event filter.

      • Source
    • Name required string: The name of the event integration.
    • Tags object: One or more tags.

Output

DeleteEventIntegration

amazonaws_appintegrations.DeleteEventIntegration({
  "Name": ""
}, context)

Input

  • input object
    • Name required string

Output

GetEventIntegration

amazonaws_appintegrations.GetEventIntegration({
  "Name": ""
}, context)

Input

  • input object
    • Name required string

Output

UpdateEventIntegration

amazonaws_appintegrations.UpdateEventIntegration({
  "Name": ""
}, context)

Input

  • input object
    • Name required string
    • Description string: The description of the event inegration.

Output

ListEventIntegrationAssociations

amazonaws_appintegrations.ListEventIntegrationAssociations({
  "Name": ""
}, context)

Input

  • input object
    • Name required string
    • nextToken string
    • maxResults integer

Output

ListTagsForResource

amazonaws_appintegrations.ListTagsForResource({
  "resourceArn": ""
}, context)

Input

  • input object
    • resourceArn required string

Output

TagResource

amazonaws_appintegrations.TagResource({
  "resourceArn": "",
  "tags": {}
}, context)

Input

  • input object
    • resourceArn required string
    • tags required object: One or more tags.

Output

UntagResource

amazonaws_appintegrations.UntagResource({
  "resourceArn": "",
  "tagKeys": []
}, context)

Input

  • input object
    • resourceArn required string
    • tagKeys required array

Output

Definitions

AccessDeniedException

Arn

  • Arn string

ClientAssociationMetadata

  • ClientAssociationMetadata object

ClientId

  • ClientId string

CreateEventIntegrationRequest

  • CreateEventIntegrationRequest object
    • ClientToken
    • Description
    • EventBridgeBus required
    • EventFilter required
      • Source required
    • Name required
    • Tags

CreateEventIntegrationResponse

  • CreateEventIntegrationResponse object
    • EventIntegrationArn

DeleteEventIntegrationRequest

  • DeleteEventIntegrationRequest object

DeleteEventIntegrationResponse

  • DeleteEventIntegrationResponse object

Description

  • Description string

DuplicateResourceException

EventBridgeBus

  • EventBridgeBus string

EventBridgeRuleName

  • EventBridgeRuleName string

EventFilter

  • EventFilter object:

    The Amazon AppIntegrations APIs are in preview release and are subject to change.

    The event filter.

    • Source required

EventIntegration

  • EventIntegration object:

    The Amazon AppIntegrations APIs are in preview release and are subject to change.

    The event integration.

    • Description
    • EventBridgeBus
    • EventFilter
      • Source required
    • EventIntegrationArn
    • Name
    • Tags

EventIntegrationAssociation

  • EventIntegrationAssociation object:

    The Amazon AppIntegrations APIs are in preview release and are subject to change.

    The event integration association.

    • ClientAssociationMetadata
    • ClientId
    • EventBridgeRuleName
    • EventIntegrationAssociationArn
    • EventIntegrationAssociationId
    • EventIntegrationName

EventIntegrationAssociationsList

EventIntegrationsList

GetEventIntegrationRequest

  • GetEventIntegrationRequest object

GetEventIntegrationResponse

  • GetEventIntegrationResponse object
    • Description
    • EventBridgeBus
    • EventFilter
      • Source required
    • EventIntegrationArn
    • Name
    • Tags

IdempotencyToken

  • IdempotencyToken string

InternalServiceError

InvalidRequestException

ListEventIntegrationAssociationsRequest

  • ListEventIntegrationAssociationsRequest object

ListEventIntegrationAssociationsResponse

ListEventIntegrationsRequest

  • ListEventIntegrationsRequest object

ListEventIntegrationsResponse

  • ListEventIntegrationsResponse object

ListTagsForResourceRequest

  • ListTagsForResourceRequest object

ListTagsForResourceResponse

  • ListTagsForResourceResponse object
    • tags

MaxResults

  • MaxResults integer

Name

  • Name string

NextToken

  • NextToken string

NonBlankString

  • NonBlankString string

ResourceNotFoundException

ResourceQuotaExceededException

Source

  • Source string

TagKey

  • TagKey string

TagKeyList

  • TagKeyList array

TagMap

  • TagMap object

TagResourceRequest

  • TagResourceRequest object
    • tags required

TagResourceResponse

  • TagResourceResponse object

TagValue

  • TagValue string

ThrottlingException

UUID

  • UUID string

UntagResourceRequest

  • UntagResourceRequest object

UntagResourceResponse

  • UntagResourceResponse object

UpdateEventIntegrationRequest

  • UpdateEventIntegrationRequest object
    • Description

UpdateEventIntegrationResponse

  • UpdateEventIntegrationResponse object