The AWS SDK for JavaScript v2 has reached end-of-support.

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

Class: AWS.AppFabric

Inherits:

AWS.Service

Object
AWS.Service
AWS.AppFabric

show all

Identifier:: appfabric

API Version:: 2023-05-19

Defined in:: (unknown)

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();

Version:

2023-05-19

Constructor Summary collapse

new AWS.AppFabric(options = {}) ⇒ Object constructor
Constructs a service object.

Property Summary collapse

endpoint ⇒ AWS.Endpoint readwrite
An Endpoint object representing the endpoint URL for service requests.

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

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.
.
connectAppAuthorization(params = {}, callback) ⇒ AWS.Request
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.
deleteAppBundle(params = {}, callback) ⇒ AWS.Request
Deletes an app bundle.
deleteIngestion(params = {}, callback) ⇒ AWS.Request
Deletes an ingestion.
deleteIngestionDestination(params = {}, callback) ⇒ AWS.Request
Deletes an ingestion destination.

This deletes the association between an ingestion and it's destination.
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.
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.

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.

Examples:

Constructing a AppFabric object

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

Options Hash (options):

params (map) —
An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.
endpoint (String|AWS.Endpoint) —
The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com' or an Endpoint object.
accessKeyId (String) —
your AWS access key ID.
secretAccessKey (String) —
your AWS secret access key.
sessionToken (AWS.Credentials) —
the optional AWS session token to sign requests with.
credentials (AWS.Credentials) —
the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.
credentialProvider (AWS.CredentialProviderChain) —
the provider chain used to resolve credentials if no static credentials property is set.
region (String) —
the region to send service requests to. See AWS.AppFabric.region for more information.
maxRetries (Integer) —
the maximum amount of retries to attempt with a request. See AWS.AppFabric.maxRetries for more information.
maxRedirects (Integer) —
the maximum amount of redirects to follow with a request. See AWS.AppFabric.maxRedirects for more information.
sslEnabled (Boolean) —
whether to enable SSL for requests.
paramValidation (Boolean|map) —
whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:
- min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
- max [Boolean] — Validates that a value meets the max constraint.
- pattern [Boolean] — Validates that a string value matches a regular expression.
- enum [Boolean] — Validates that a string value matches one of the allowable enum values.
computeChecksums (Boolean) —
whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)
convertResponseTypes (Boolean) —
whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.
correctClockSkew (Boolean) —
whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.
s3ForcePathStyle (Boolean) —
whether to force path style URLs for S3 objects.
s3BucketEndpoint (Boolean) —
whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.
s3DisableBodySigning (Boolean) —
whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.
s3UsEast1RegionalEndpoint ('legacy'|'regional') —
when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy
s3UseArnRegion (Boolean) —
whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to true
retryDelayOptions (map) —
A set of options to configure the retry delay on retryable errors. Currently supported options are:
- base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
- customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied. The function is only called for retryable errors.
httpOptions (map) —
A set of options to pass to the low-level HTTP request. Currently supported options are:
- proxy [String] — the URL to proxy requests through
- agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
- connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
- timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
- xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
- xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
apiVersion (String, Date) —
a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.
apiVersions (map<String, String|Date>) —
a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.
logger (#write, #log) —
an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests
systemClockOffset (Number) —
an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.
signatureVersion (String) —
the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.
signatureCache (Boolean) —
whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.
dynamoDbCrc32 (Boolean) —
whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.
useAccelerateEndpoint (Boolean) —
Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.
clientSideMonitoring (Boolean) —
whether to collect and publish this client's performance metrics of all its API requests.
endpointDiscoveryEnabled (Boolean|undefined) —
whether to call operations with endpoints given by service dynamically. Setting this
endpointCacheSize (Number) —
the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000
hostPrefixEnabled (Boolean) —
whether to marshal request parameters to the prefix of hostname. Defaults to true.
stsRegionalEndpoints ('legacy'|'regional') —
whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.
useFipsEndpoint (Boolean) —
Enables FIPS compatible endpoints. Defaults to false.
useDualstackEndpoint (Boolean) —
Enables IPv6 dualstack endpoint. Defaults to false.

Property Details

endpoint ⇒ `AWS.Endpoint` (readwrite)

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

Returns:

(AWS.Endpoint) —
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.

Service Reference:

BatchGetUserAccessTasks

Examples:

Calling the batchGetUserAccessTasks operation

var params = {
  appBundleIdentifier: 'STRING_VALUE', /* required */
  taskIdList: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
appfabric.batchGetUserAccessTasks(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- appBundleIdentifier — (String)
  The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.
- taskIdList — (Array<String>)
  The tasks IDs to use for the request.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - userAccessResultsList — (Array<map>)
    Contains a list of user access results.
    
    app — (String)
    The name of the application.
    
    tenantId — (String)
    The ID of the application tenant.
    
    tenantDisplayName — (String)
    The display name of the tenant.
    
    taskId — (String)
    The unique ID of the task.
    
    resultStatus — (String)
    The status of the user access result item.
    
    The following states are possible:
    
    IN_PROGRESS: The user access task is in progress.
    
    COMPLETED: The user access task completed successfully.
    
    FAILED: The user access task failed.
    
    EXPIRED: The user access task expired.
    
    Possible values include:
    
    "IN_PROGRESS"
    
    "COMPLETED"
    
    "FAILED"
    
    "EXPIRED"
    
    email — (String)
    The email address of the target user.
    
    userId — (String)
    The unique ID of user.
    
    userFullName — (String)
    The full name of the user.
    
    userFirstName — (String)
    The first name of the user.
    
    userLastName — (String)
    The last name of the user.
    
    userStatus — (String)
    The status of the user returned by the application.
    
    taskError — (map)
    Contains information about an error returned from a user access task.
    
    errorCode — (String)
    The code of the error.
    
    errorMessage — (String)
    The message of the error.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

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

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

Service Reference:

ConnectAppAuthorization

Examples:

Calling the connectAppAuthorization operation

var params = {
  appAuthorizationIdentifier: 'STRING_VALUE', /* required */
  appBundleIdentifier: 'STRING_VALUE', /* required */
  authRequest: {
    code: 'STRING_VALUE', /* required */
    redirectUri: 'STRING_VALUE' /* required */
  }
};
appfabric.connectAppAuthorization(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- appBundleIdentifier — (String)
  The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle that contains the app authorization to use for the request.
- appAuthorizationIdentifier — (String)
  The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app authorization to use for the request.
- authRequest — (map)
  Contains OAuth2 authorization information.
  
  This is required if the app authorization for the request is configured with an OAuth2 (oauth2) authorization type.
  - redirectUri — required — (String)
    The redirect URL that is specified in the AuthURL and the application client.
  - code — required — (String)
    The authorization code returned by the application after permission is granted in the application OAuth page (after clicking on the AuthURL).

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - appAuthorizationSummary — (map)
    Contains a summary of the app authorization.
    
    appAuthorizationArn — required — (String)
    The Amazon Resource Name (ARN) of the app authorization.
    
    appBundleArn — required — (String)
    The Amazon Resource Name (ARN) of the app bundle for the app authorization.
    
    app — required — (String)
    The name of the application.
    
    tenant — required — (map)
    Contains information about an application tenant, such as the application display name and identifier.
    
    tenantIdentifier — required — (String)
    The ID of the application tenant.
    
    tenantDisplayName — required — (String)
    The display name of the tenant.
    
    status — required — (String)
    The state of the app authorization.
    
    The following states are possible:
    
    PendingConnect: The initial state of the app authorization. The app authorization is created but not yet connected.
    
    Connected: The app authorization is connected to the application, and is ready to be used.
    
    ConnectionValidationFailed: The app authorization received a validation exception when trying to connect to the application. If the app authorization is in this state, you should verify the configured credentials and try to connect the app authorization again.
    
    TokenAutoRotationFailed: AppFabric failed to refresh the access token. If the app authorization is in this state, you should try to reconnect the app authorization.
    
    Possible values include:
    
    "PendingConnect"
    
    "Connected"
    
    "ConnectionValidationFailed"
    
    "TokenAutoRotationFailed"
    
    updatedAt — required — (Date)
    Timestamp for when the app authorization was last updated.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

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

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

Service Reference:

CreateAppAuthorization

Examples:

Calling the createAppAuthorization operation

var params = {
  app: 'STRING_VALUE', /* required */
  appBundleIdentifier: 'STRING_VALUE', /* required */
  authType: oauth2 | apiKey, /* required */
  credential: { /* required */
    apiKeyCredential: {
      apiKey: 'STRING_VALUE' /* required */
    },
    oauth2Credential: {
      clientId: 'STRING_VALUE', /* required */
      clientSecret: 'STRING_VALUE' /* required */
    }
  },
  tenant: { /* required */
    tenantDisplayName: 'STRING_VALUE', /* required */
    tenantIdentifier: 'STRING_VALUE' /* required */
  },
  clientToken: 'STRING_VALUE',
  tags: [
    {
      key: 'STRING_VALUE', /* required */
      value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
appfabric.createAppAuthorization(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- appBundleIdentifier — (String)
  The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.
- app — (String)
  The name of the application.
  
  Valid values are:
  - SLACK
  - ASANA
  - JIRA
  - M365
  - M365AUDITLOGS
  - ZOOM
  - ZENDESK
  - OKTA
  - GOOGLE
  - DROPBOX
  - SMARTSHEET
  - CISCO
- credential — (map)
  Contains credentials for the application, such as an API key or OAuth2 client ID and secret.
  
  Specify credentials that match the authorization type for your request. For example, if the authorization type for your request is OAuth2 (oauth2), then you should provide only the OAuth2 credentials.
  - oauth2Credential — (map)
    Contains OAuth2 client credential information.
    - clientId — required — (String)
      The client ID of the client application.
    - clientSecret — required — (String)
      The client secret of the client application.
  - apiKeyCredential — (map)
    Contains API key credential information.
    - apiKey — required — (String)
      An API key for an application.
- tenant — (map)
  Contains information about an application tenant, such as the application display name and identifier.
  - tenantIdentifier — required — (String)
    The ID of the application tenant.
  - tenantDisplayName — required — (String)
    The display name of the tenant.
- authType — (String)
  The authorization type for the app authorization.
  Possible values include:
  - "oauth2"
  - "apiKey"
- clientToken — (String)
  Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value.
  
  If you don't provide this value, then Amazon Web Services generates a random one for you.
  
  If you retry the operation with the same ClientToken, but with different parameters, the retry fails with an IdempotentParameterMismatch error.
  If a token is not provided, the SDK will use a version 4 UUID.
- tags — (Array<map>)
  A map of the key-value pairs of the tag or tags to assign to the resource.
  - key — required — (String)
    Tag key.
  - value — required — (String)
    Tag value.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - appAuthorization — (map)
    Contains information about an app authorization.
    
    appAuthorizationArn — required — (String)
    The Amazon Resource Name (ARN) of the app authorization.
    
    appBundleArn — required — (String)
    The Amazon Resource Name (ARN) of the app bundle for the app authorization.
    
    app — required — (String)
    The name of the application.
    
    tenant — required — (map)
    Contains information about an application tenant, such as the application display name and identifier.
    
    tenantIdentifier — required — (String)
    The ID of the application tenant.
    
    tenantDisplayName — required — (String)
    The display name of the tenant.
    
    authType — required — (String)
    The authorization type.
    Possible values include:
    
    "oauth2"
    
    "apiKey"
    
    status — required — (String)
    The state of the app authorization.
    
    The following states are possible:
    
    PendingConnect: The initial state of the app authorization. The app authorization is created but not yet connected.
    
    Connected: The app authorization is connected to the application, and is ready to be used.
    
    ConnectionValidationFailed: The app authorization received a validation exception when trying to connect to the application. If the app authorization is in this state, you should verify the configured credentials and try to connect the app authorization again.
    
    TokenAutoRotationFailed: AppFabric failed to refresh the access token. If the app authorization is in this state, you should try to reconnect the app authorization.
    
    Possible values include:
    
    "PendingConnect"
    
    "Connected"
    
    "ConnectionValidationFailed"
    
    "TokenAutoRotationFailed"
    
    createdAt — required — (Date)
    The timestamp of when the app authorization was created.
    
    updatedAt — required — (Date)
    The timestamp of when the app authorization was last updated.
    
    persona — (String)
    The user persona of the app authorization.
    
    This field should always be admin.
    Possible values include:
    
    "admin"
    
    "endUser"
    
    authUrl — (String)
    The application URL for the OAuth flow.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

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

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

Service Reference:

CreateAppBundle

Examples:

Calling the createAppBundle operation

var params = {
  clientToken: 'STRING_VALUE',
  customerManagedKeyIdentifier: 'STRING_VALUE',
  tags: [
    {
      key: 'STRING_VALUE', /* required */
      value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
appfabric.createAppBundle(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- clientToken — (String)
  Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value.
  
  If you don't provide this value, then Amazon Web Services generates a random one for you.
  
  If you retry the operation with the same ClientToken, but with different parameters, the retry fails with an IdempotentParameterMismatch error.
  If a token is not provided, the SDK will use a version 4 UUID.
- customerManagedKeyIdentifier — (String)
  The Amazon Resource Name (ARN) of the Key Management Service (KMS) key to use to encrypt the application data. If this is not specified, an Amazon Web Services owned key is used for encryption.
- tags — (Array<map>)
  A map of the key-value pairs of the tag or tags to assign to the resource.
  - key — required — (String)
    Tag key.
  - value — required — (String)
    Tag value.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - appBundle — (map)
    Contains information about an app bundle.
    
    arn — required — (String)
    The Amazon Resource Name (ARN) of the app bundle.
    
    customerManagedKeyArn — (String)
    The Amazon Resource Name (ARN) of the Key Management Service (KMS) key used to encrypt the application data.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

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

Creates a data ingestion for an application.

Service Reference:

CreateIngestion

Examples:

Calling the createIngestion operation

var params = {
  app: 'STRING_VALUE', /* required */
  appBundleIdentifier: 'STRING_VALUE', /* required */
  ingestionType: auditLog, /* required */
  tenantId: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE',
  tags: [
    {
      key: 'STRING_VALUE', /* required */
      value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
appfabric.createIngestion(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

Class: AWS.AppFabric

Overview

Service Description

Sending a Request Using AppFabric

Locking the API Version

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

Method Summary collapse

Methods inherited from AWS.Service

Constructor Details

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

Property Details

endpoint ⇒ AWS.Endpoint (readwrite)

Method Details

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

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

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

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

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

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

endpoint ⇒ `AWS.Endpoint` (readwrite)

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

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

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

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

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