AppFabricClient

Suggest an Edit

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 .

Installation

NPM
npm install @aws-sdk/client-appfabric
Yarn
yarn add @aws-sdk/client-appfabric
pnpm
pnpm add @aws-sdk/client-appfabric

AppFabricClient Operations

Command
Summary
BatchGetUserAccessTasksCommand

Gets user access details in a batch request.

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

ConnectAppAuthorizationCommand

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

CreateAppAuthorizationCommand

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

CreateAppBundleCommand

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

CreateIngestionCommand

Creates a data ingestion for an application.

CreateIngestionDestinationCommand

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

DeleteAppAuthorizationCommand

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

DeleteAppBundleCommand

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

DeleteIngestionCommand

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

DeleteIngestionDestinationCommand

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.

GetAppAuthorizationCommand

Returns information about an app authorization.

GetAppBundleCommand

Returns information about an app bundle.

GetIngestionCommand

Returns information about an ingestion.

GetIngestionDestinationCommand

Returns information about an ingestion destination.

ListAppAuthorizationsCommand

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

ListAppBundlesCommand

Returns a list of app bundles.

ListIngestionDestinationsCommand

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

ListIngestionsCommand

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

ListTagsForResourceCommand

Returns a list of tags for a resource.

StartIngestionCommand

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

StartUserAccessTasksCommand

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.

StopIngestionCommand

Stops (disables) an ingestion.

TagResourceCommand

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

UntagResourceCommand

Removes a tag or tags from a resource.

UpdateAppAuthorizationCommand

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.

UpdateIngestionDestinationCommand

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

AppFabricClient Configuration

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: AppFabricClientConfig