AWS.AppFabric — AWS SDK for JavaScript (original) (raw)

We recommend that you migrate to AWS SDK for JavaScript v3. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

Class: AWS.AppFabric

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

Amazon Web Services AppFabric quickly connects software as a service (SaaS) applications across your organization. This allows IT and security teams to easily manage and secure applications using a standard schema, and employees can complete everyday tasks faster using generative artificial intelligence (AI). You can use these APIs to complete AppFabric tasks, such as setting up audit log ingestions or viewing user access. For more information about AppFabric, including the required permissions to use the service, see the Amazon Web Services AppFabric Administration Guide. For more information about using the Command Line Interface (CLI) to manage your AppFabric resources, see the AppFabric section of the CLI Reference.

Sending a Request Using AppFabric

var appfabric = new AWS.AppFabric();
appfabric.batchGetUserAccessTasks(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the AppFabric object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var appfabric = new AWS.AppFabric({apiVersion: '2023-05-19'});

You can also set the API version globally in AWS.config.apiVersions using the appfabric service identifier:

AWS.config.apiVersions = {
  appfabric: '2023-05-19',
  // other service API versions
};

var appfabric = new AWS.AppFabric();

Constructor Summarycollapse

Property Summarycollapse

Properties inherited from AWS.Service

apiVersions

Method Summarycollapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, setupRequestListeners, defineService

Constructor Details

new AWS.AppFabric(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Property Details

endpoint ⇒ AWS.Endpoint

Returns an Endpoint object representing the endpoint URL for service requests.

Method Details

batchGetUserAccessTasks(params = {}, callback) ⇒ AWS.Request

Gets user access details in a batch request.

This action polls data from the tasks that are kicked off by the StartUserAccessTasks action.

Establishes a connection between Amazon Web Services AppFabric and an application, which allows AppFabric to call the APIs of the application.

createAppAuthorization(params = {}, callback) ⇒ AWS.Request

Creates an app authorization within an app bundle, which allows AppFabric to connect to an application.

createAppBundle(params = {}, callback) ⇒ AWS.Request

Creates an app bundle to collect data from an application using AppFabric.

createIngestion(params = {}, callback) ⇒ AWS.Request

Creates a data ingestion for an application.

createIngestionDestination(params = {}, callback) ⇒ AWS.Request

Creates an ingestion destination, which specifies how an application's ingested data is processed by Amazon Web Services AppFabric and where it's delivered.

deleteAppAuthorization(params = {}, callback) ⇒ AWS.Request

Deletes an app authorization. You must delete the associated ingestion before you can delete an app authorization.

deleteAppBundle(params = {}, callback) ⇒ AWS.Request

Deletes an app bundle. You must delete all associated app authorizations before you can delete an app bundle.

deleteIngestion(params = {}, callback) ⇒ AWS.Request

Deletes an ingestion. You must stop (disable) the ingestion and you must delete all associated ingestion destinations before you can delete an app ingestion.

deleteIngestionDestination(params = {}, callback) ⇒ AWS.Request

Deletes an ingestion destination.

This deletes the association between an ingestion and it's destination. It doesn't delete previously ingested data or the storage destination, such as the Amazon S3 bucket where the data is delivered. If the ingestion destination is deleted while the associated ingestion is enabled, the ingestion will fail and is eventually disabled.

getAppAuthorization(params = {}, callback) ⇒ AWS.Request

Returns information about an app authorization.

getAppBundle(params = {}, callback) ⇒ AWS.Request

Returns information about an app bundle.

getIngestion(params = {}, callback) ⇒ AWS.Request

Returns information about an ingestion.

getIngestionDestination(params = {}, callback) ⇒ AWS.Request

Returns information about an ingestion destination.

listAppAuthorizations(params = {}, callback) ⇒ AWS.Request

Returns a list of all app authorizations configured for an app bundle.

listAppBundles(params = {}, callback) ⇒ AWS.Request

Returns a list of app bundles.

listIngestionDestinations(params = {}, callback) ⇒ AWS.Request

Returns a list of all ingestion destinations configured for an ingestion.

listIngestions(params = {}, callback) ⇒ AWS.Request

Returns a list of all ingestions configured for an app bundle.

listTagsForResource(params = {}, callback) ⇒ AWS.Request

Returns a list of tags for a resource.

startIngestion(params = {}, callback) ⇒ AWS.Request

Starts (enables) an ingestion, which collects data from an application.

startUserAccessTasks(params = {}, callback) ⇒ AWS.Request

Starts the tasks to search user access status for a specific email address.

The tasks are stopped when the user access status data is found. The tasks are terminated when the API calls to the application time out.

stopIngestion(params = {}, callback) ⇒ AWS.Request

Stops (disables) an ingestion.

tagResource(params = {}, callback) ⇒ AWS.Request

Assigns one or more tags (key-value pairs) to the specified resource.

untagResource(params = {}, callback) ⇒ AWS.Request

Removes a tag or tags from a resource.

updateAppAuthorization(params = {}, callback) ⇒ AWS.Request

Updates an app authorization within an app bundle, which allows AppFabric to connect to an application.

If the app authorization was in a connected state, updating the app authorization will set it back to a PendingConnect state.

updateIngestionDestination(params = {}, callback) ⇒ AWS.Request

Updates an ingestion destination, which specifies how an application's ingested data is processed by Amazon Web Services AppFabric and where it's delivered.

waitFor(state, params = {}, callback) ⇒ AWS.Request

Waits for a given AppFabric resource. The final callback or'complete' event will be fired only when the resource is either in its final state or the waiter has timed out and stopped polling for the final state.