Class: AWS.AppFabric

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.

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.

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.

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:

• 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

  • tenantId — (String)

    The ID of the application tenant.

  • ingestionType — (String)

    The ingestion type.

    Possible values include:
    • "auditLog"
  • 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:

    • ingestion — (map)

      Contains information about an ingestion.

      • arn — required — (String)

        The Amazon Resource Name (ARN) of the ingestion.

      • appBundleArn — required — (String)

        The Amazon Resource Name (ARN) of the app bundle for the ingestion.

      • app — required — (String)

        The name of the application.

      • tenantId — required — (String)

        The ID of the application tenant.

      • createdAt — required — (Date)

        The timestamp of when the ingestion was created.

      • updatedAt — required — (Date)

        The timestamp of when the ingestion was last updated.

      • state — required — (String)

        The status of the ingestion.

        Possible values include:
        • "enabled"
        • "disabled"
      • ingestionType — required — (String)

        The type of the ingestion.

        Possible values include:
        • "auditLog"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  appBundleIdentifier: 'STRING_VALUE', /* required */
  destinationConfiguration: { /* required */
    auditLog: {
      destination: { /* required */
        firehoseStream: {
          streamName: 'STRING_VALUE' /* required */
        },
        s3Bucket: {
          bucketName: 'STRING_VALUE', /* required */
          prefix: 'STRING_VALUE'
        }
      }
    }
  },
  ingestionIdentifier: 'STRING_VALUE', /* required */
  processingConfiguration: { /* required */
    auditLog: {
      format: json | parquet, /* required */
      schema: ocsf | raw /* required */
    }
  },
  clientToken: 'STRING_VALUE',
  tags: [
    {
      key: 'STRING_VALUE', /* required */
      value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
appfabric.createIngestionDestination(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.

  • ingestionIdentifier — (String)

    The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion to use for the request.

  • processingConfiguration — (map)

    Contains information about how ingested data is processed.

    • auditLog — (map)

      Contains information about an audit log processing configuration.

      • schema — required — (String)

        The event schema in which the audit logs need to be formatted.

        Possible values include:
        • "ocsf"
        • "raw"
      • format — required — (String)

        The format in which the audit logs need to be formatted.

        Possible values include:
        • "json"
        • "parquet"
  • destinationConfiguration — (map)

    Contains information about the destination of ingested data.

    • auditLog — (map)

      Contains information about an audit log destination configuration.

      • destination — required — (map)

        Contains information about an audit log destination.

        • s3Bucket — (map)

          Contains information about an Amazon S3 bucket.

          • bucketName — required — (String)

            The name of the Amazon S3 bucket.

          • prefix — (String)

            The object key to use.

        • firehoseStream — (map)

          Contains information about an Amazon Kinesis Data Firehose delivery stream.

          • streamName — required — (String)

            The name of the Amazon Kinesis Data Firehose delivery stream.

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

    • ingestionDestination — (map)

      Contains information about an ingestion destination.

      • arn — required — (String)

        The Amazon Resource Name (ARN) of the ingestion destination.

      • ingestionArn — required — (String)

        The Amazon Resource Name (ARN) of the ingestion.

      • processingConfiguration — required — (map)

        Contains information about how ingested data is processed.

        • auditLog — (map)

          Contains information about an audit log processing configuration.

          • schema — required — (String)

            The event schema in which the audit logs need to be formatted.

            Possible values include:
            • "ocsf"
            • "raw"
          • format — required — (String)

            The format in which the audit logs need to be formatted.

            Possible values include:
            • "json"
            • "parquet"
      • destinationConfiguration — required — (map)

        Contains information about the destination of ingested data.

        • auditLog — (map)

          Contains information about an audit log destination configuration.

          • destination — required — (map)

            Contains information about an audit log destination.

            • s3Bucket — (map)

              Contains information about an Amazon S3 bucket.

              • bucketName — required — (String)

                The name of the Amazon S3 bucket.

              • prefix — (String)

                The object key to use.

            • firehoseStream — (map)

              Contains information about an Amazon Kinesis Data Firehose delivery stream.

              • streamName — required — (String)

                The name of the Amazon Kinesis Data Firehose delivery stream.

      • status — (String)

        The state of the ingestion destination.

        The following states are possible:

        • Active: The ingestion destination is active and is ready to be used.

        • Failed: The ingestion destination has failed. If the ingestion destination is in this state, you should verify the ingestion destination configuration and try again.

        Possible values include:
        • "Active"
        • "Failed"
      • statusReason — (String)

        The reason for the current status of the ingestion destination.

        Only present when the status of ingestion destination is Failed.

      • createdAt — (Date)

        The timestamp of when the ingestion destination was created.

      • updatedAt — (Date)

        The timestamp of when the ingestion destination was last updated.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  appAuthorizationIdentifier: 'STRING_VALUE', /* required */
  appBundleIdentifier: 'STRING_VALUE' /* required */
};
appfabric.deleteAppAuthorization(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.

  • appAuthorizationIdentifier — (String)

    The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app authorization 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.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  appBundleIdentifier: 'STRING_VALUE' /* required */
};
appfabric.deleteAppBundle(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 ID or Amazon Resource Name (ARN) of the app bundle that needs to be deleted.

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.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  appBundleIdentifier: 'STRING_VALUE', /* required */
  ingestionIdentifier: 'STRING_VALUE' /* required */
};
appfabric.deleteIngestion(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.

  • ingestionIdentifier — (String)

    The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion 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.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  appBundleIdentifier: 'STRING_VALUE', /* required */
  ingestionDestinationIdentifier: 'STRING_VALUE', /* required */
  ingestionIdentifier: 'STRING_VALUE' /* required */
};
appfabric.deleteIngestionDestination(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.

  • ingestionIdentifier — (String)

    The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion to use for the request.

  • ingestionDestinationIdentifier — (String)

    The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion destination 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.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  appAuthorizationIdentifier: 'STRING_VALUE', /* required */
  appBundleIdentifier: 'STRING_VALUE' /* required */
};
appfabric.getAppAuthorization(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.

  • appAuthorizationIdentifier — (String)

    The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app authorization 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:

    • 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.

var params = {
  appBundleIdentifier: 'STRING_VALUE' /* required */
};
appfabric.getAppBundle(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.

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.

var params = {
  appBundleIdentifier: 'STRING_VALUE', /* required */
  ingestionIdentifier: 'STRING_VALUE' /* required */
};
appfabric.getIngestion(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.

  • ingestionIdentifier — (String)

    The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion 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:

    • ingestion — (map)

      Contains information about an ingestion.

      • arn — required — (String)

        The Amazon Resource Name (ARN) of the ingestion.

      • appBundleArn — required — (String)

        The Amazon Resource Name (ARN) of the app bundle for the ingestion.

      • app — required — (String)

        The name of the application.

      • tenantId — required — (String)

        The ID of the application tenant.

      • createdAt — required — (Date)

        The timestamp of when the ingestion was created.

      • updatedAt — required — (Date)

        The timestamp of when the ingestion was last updated.

      • state — required — (String)

        The status of the ingestion.

        Possible values include:
        • "enabled"
        • "disabled"
      • ingestionType — required — (String)

        The type of the ingestion.

        Possible values include:
        • "auditLog"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  appBundleIdentifier: 'STRING_VALUE', /* required */
  ingestionDestinationIdentifier: 'STRING_VALUE', /* required */
  ingestionIdentifier: 'STRING_VALUE' /* required */
};
appfabric.getIngestionDestination(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.

  • ingestionIdentifier — (String)

    The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion to use for the request.

  • ingestionDestinationIdentifier — (String)

    The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion destination 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:

    • ingestionDestination — (map)

      Contains information about an ingestion destination.

      • arn — required — (String)

        The Amazon Resource Name (ARN) of the ingestion destination.

      • ingestionArn — required — (String)

        The Amazon Resource Name (ARN) of the ingestion.

      • processingConfiguration — required — (map)

        Contains information about how ingested data is processed.

        • auditLog — (map)

          Contains information about an audit log processing configuration.

          • schema — required — (String)

            The event schema in which the audit logs need to be formatted.

            Possible values include:
            • "ocsf"
            • "raw"
          • format — required — (String)

            The format in which the audit logs need to be formatted.

            Possible values include:
            • "json"
            • "parquet"
      • destinationConfiguration — required — (map)

        Contains information about the destination of ingested data.

        • auditLog — (map)

          Contains information about an audit log destination configuration.

          • destination — required — (map)

            Contains information about an audit log destination.

            • s3Bucket — (map)

              Contains information about an Amazon S3 bucket.

              • bucketName — required — (String)

                The name of the Amazon S3 bucket.

              • prefix — (String)

                The object key to use.

            • firehoseStream — (map)

              Contains information about an Amazon Kinesis Data Firehose delivery stream.

              • streamName — required — (String)

                The name of the Amazon Kinesis Data Firehose delivery stream.

      • status — (String)

        The state of the ingestion destination.

        The following states are possible:

        • Active: The ingestion destination is active and is ready to be used.

        • Failed: The ingestion destination has failed. If the ingestion destination is in this state, you should verify the ingestion destination configuration and try again.

        Possible values include:
        • "Active"
        • "Failed"
      • statusReason — (String)

        The reason for the current status of the ingestion destination.

        Only present when the status of ingestion destination is Failed.

      • createdAt — (Date)

        The timestamp of when the ingestion destination was created.

      • updatedAt — (Date)

        The timestamp of when the ingestion destination was last updated.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  appBundleIdentifier: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
appfabric.listAppAuthorizations(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.

  • maxResults — (Integer)

    The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results.

    This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.

  • nextToken — (String)

    If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

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:

    • appAuthorizationSummaryList — (Array<map>)

      Contains a list of app authorization summaries.

      • 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.

    • nextToken — (String)

      If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
appfabric.listAppBundles(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: {}) —
  • maxResults — (Integer)

    The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results.

    This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.

  • nextToken — (String)

    If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

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:

    • appBundleSummaryList — (Array<map>)

      Contains a list of app bundle summaries.

      • arn — required — (String)

        The Amazon Resource Name (ARN) of the app bundle.

    • nextToken — (String)

      If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  appBundleIdentifier: 'STRING_VALUE', /* required */
  ingestionIdentifier: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
appfabric.listIngestionDestinations(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.

  • ingestionIdentifier — (String)

    The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion to use for the request.

  • maxResults — (Integer)

    The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results.

    This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.

  • nextToken — (String)

    If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

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:

    • ingestionDestinations — (Array<map>)

      Contains a list of ingestion destination summaries.

      • arn — required — (String)

        The Amazon Resource Name (ARN) of the ingestion destination.

    • nextToken — (String)

      If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  appBundleIdentifier: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
appfabric.listIngestions(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.

  • maxResults — (Integer)

    The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results.

    This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.

  • nextToken — (String)

    If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

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:

    • ingestions — (Array<map>)

      Contains a list of ingestion summaries.

      • arn — required — (String)

        The Amazon Resource Name (ARN) of the ingestion.

      • app — required — (String)

        The name of the application.

      • tenantId — required — (String)

        The ID of the application tenant.

      • state — required — (String)

        The status of the ingestion.

        Possible values include:
        • "enabled"
        • "disabled"
    • nextToken — (String)

      If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  resourceArn: 'STRING_VALUE' /* required */
};
appfabric.listTagsForResource(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: {}) —
  • resourceArn — (String)

    The Amazon Resource Name (ARN) of the resource for which you want to retrieve tags.

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:

    • tags — (Array<map>)

      A map of the key-value pairs for the tag or tags assigned to the specified resource.

      • key — required — (String)

        Tag key.

      • value — required — (String)

        Tag value.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  appBundleIdentifier: 'STRING_VALUE', /* required */
  ingestionIdentifier: 'STRING_VALUE' /* required */
};
appfabric.startIngestion(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: {}) —
  • ingestionIdentifier — (String)

    The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion to use for the request.

  • appBundleIdentifier — (String)

    The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle 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.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  appBundleIdentifier: 'STRING_VALUE', /* required */
  email: 'STRING_VALUE' /* required */
};
appfabric.startUserAccessTasks(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.

  • email — (String)

    The email address of the target user.

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:

    • userAccessTasksList — (Array<map>)

      Contains a list of user access task information.

      • app — required — (String)

        The name of the application.

      • tenantId — required — (String)

        The ID of the application tenant.

      • taskId — (String)

        The unique ID of the task.

      • error — (map)

        Error from the task, if any.

        • 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.

var params = {
  appBundleIdentifier: 'STRING_VALUE', /* required */
  ingestionIdentifier: 'STRING_VALUE' /* required */
};
appfabric.stopIngestion(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: {}) —
  • ingestionIdentifier — (String)

    The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion to use for the request.

  • appBundleIdentifier — (String)

    The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle 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.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tags: [ /* required */
    {
      key: 'STRING_VALUE', /* required */
      value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
appfabric.tagResource(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: {}) —
  • resourceArn — (String)

    The Amazon Resource Name (ARN) of the resource that you want to tag.

  • 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.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
appfabric.untagResource(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: {}) —
  • resourceArn — (String)

    The Amazon Resource Name (ARN) of the resource that you want to untag.

  • tagKeys — (Array<String>)

    The keys of the key-value pairs for the tag or tags you want to remove from the specified resource.

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.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  appAuthorizationIdentifier: 'STRING_VALUE', /* required */
  appBundleIdentifier: 'STRING_VALUE', /* required */
  credential: {
    apiKeyCredential: {
      apiKey: 'STRING_VALUE' /* required */
    },
    oauth2Credential: {
      clientId: 'STRING_VALUE', /* required */
      clientSecret: 'STRING_VALUE' /* required */
    }
  },
  tenant: {
    tenantDisplayName: 'STRING_VALUE', /* required */
    tenantIdentifier: 'STRING_VALUE' /* required */
  }
};
appfabric.updateAppAuthorization(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.

  • appAuthorizationIdentifier — (String)

    The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app authorization to use for the request.

  • 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 of the app authorization to update. For example, if the authorization type of the app authorization 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.

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.

var params = {
  appBundleIdentifier: 'STRING_VALUE', /* required */
  destinationConfiguration: { /* required */
    auditLog: {
      destination: { /* required */
        firehoseStream: {
          streamName: 'STRING_VALUE' /* required */
        },
        s3Bucket: {
          bucketName: 'STRING_VALUE', /* required */
          prefix: 'STRING_VALUE'
        }
      }
    }
  },
  ingestionDestinationIdentifier: 'STRING_VALUE', /* required */
  ingestionIdentifier: 'STRING_VALUE' /* required */
};
appfabric.updateIngestionDestination(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.

  • ingestionIdentifier — (String)

    The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion to use for the request.

  • ingestionDestinationIdentifier — (String)

    The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion destination to use for the request.

  • destinationConfiguration — (map)

    Contains information about the destination of ingested data.

    • auditLog — (map)

      Contains information about an audit log destination configuration.

      • destination — required — (map)

        Contains information about an audit log destination.

        • s3Bucket — (map)

          Contains information about an Amazon S3 bucket.

          • bucketName — required — (String)

            The name of the Amazon S3 bucket.

          • prefix — (String)

            The object key to use.

        • firehoseStream — (map)

          Contains information about an Amazon Kinesis Data Firehose delivery stream.

          • streamName — required — (String)

            The name of the Amazon Kinesis Data Firehose delivery stream.

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:

    • ingestionDestination — (map)

      Contains information about an ingestion destination.

      • arn — required — (String)

        The Amazon Resource Name (ARN) of the ingestion destination.

      • ingestionArn — required — (String)

        The Amazon Resource Name (ARN) of the ingestion.

      • processingConfiguration — required — (map)

        Contains information about how ingested data is processed.

        • auditLog — (map)

          Contains information about an audit log processing configuration.

          • schema — required — (String)

            The event schema in which the audit logs need to be formatted.

            Possible values include:
            • "ocsf"
            • "raw"
          • format — required — (String)

            The format in which the audit logs need to be formatted.

            Possible values include:
            • "json"
            • "parquet"
      • destinationConfiguration — required — (map)

        Contains information about the destination of ingested data.

        • auditLog — (map)

          Contains information about an audit log destination configuration.

          • destination — required — (map)

            Contains information about an audit log destination.

            • s3Bucket — (map)

              Contains information about an Amazon S3 bucket.

              • bucketName — required — (String)

                The name of the Amazon S3 bucket.

              • prefix — (String)

                The object key to use.

            • firehoseStream — (map)

              Contains information about an Amazon Kinesis Data Firehose delivery stream.

              • streamName — required — (String)

                The name of the Amazon Kinesis Data Firehose delivery stream.

      • status — (String)

        The state of the ingestion destination.

        The following states are possible:

        • Active: The ingestion destination is active and is ready to be used.

        • Failed: The ingestion destination has failed. If the ingestion destination is in this state, you should verify the ingestion destination configuration and try again.

        Possible values include:
        • "Active"
        • "Failed"
      • statusReason — (String)

        The reason for the current status of the ingestion destination.

        Only present when the status of ingestion destination is Failed.

      • createdAt — (Date)

        The timestamp of when the ingestion destination was created.

      • updatedAt — (Date)

        The timestamp of when the ingestion destination was last updated.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

Parameters:

• state (String) —

  the resource state to wait for. Available states for this service are listed in "Waiter Resource States" below.

• params (map) (defaults to: {}) —

  a list of parameters for the given state. See each waiter resource state for required parameters.

Callback (callback):

• function(err, data) { ... }

  Callback containing error and data information. See the respective resource state for the expected error or data information.

  If the waiter times out its requests, it will return a ResourceNotReady error.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.