Class: AWS.BCMDataExports

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

    The Amazon Resource Name (ARN) for this export.

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:

    • ExportArn — (String)

      The Amazon Resource Name (ARN) for this export.

Returns:

• (AWS.Request) —

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

var params = {
  ExecutionId: 'STRING_VALUE', /* required */
  ExportArn: 'STRING_VALUE' /* required */
};
bcmdataexports.getExecution(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: {}) —
  • ExecutionId — (String)

    The ID for this specific execution.

  • ExportArn — (String)

    The Amazon Resource Name (ARN) of the Export object that generated this specific execution.

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:

    • ExecutionId — (String)

      The ID for this specific execution.

    • ExecutionStatus — (map)

      The status of this specific execution.

      • CompletedAt — (Date)

        The time when the execution was completed.

      • CreatedAt — (Date)

        The time when the execution was created.

      • LastUpdatedAt — (Date)

        The time when the execution was last updated.

      • StatusCode — (String)

        The code for the status of the execution.

        Possible values include:
        • "INITIATION_IN_PROCESS"
        • "QUERY_QUEUED"
        • "QUERY_IN_PROCESS"
        • "QUERY_FAILURE"
        • "DELIVERY_IN_PROCESS"
        • "DELIVERY_SUCCESS"
        • "DELIVERY_FAILURE"
      • StatusReason — (String)

        The reason for the failed status.

        Possible values include:
        • "INSUFFICIENT_PERMISSION"
        • "BILL_OWNER_CHANGED"
        • "INTERNAL_FAILURE"
    • Export — (map)

      The export data for this specific execution. This export data is a snapshot from when the execution was generated. The data could be different from the current export data if the export was updated since the execution was generated.

      • DataQuery — required — (map)

        The data query for this specific data export.

        • QueryStatement — required — (String)

          The query statement.

        • TableConfigurations — (map<map<String>>)

          The table configuration.

      • Description — (String)

        The description for this specific data export.

      • DestinationConfigurations — required — (map)

        The destination configuration for this specific data export.

        • S3Destination — required — (map)

          An object that describes the destination of the data exports file.

          • S3Bucket — required — (String)

            The name of the Amazon S3 bucket used as the destination of a data export file.

          • S3OutputConfigurations — required — (map)

            The output configuration for the data export.

            • Compression — required — (String)

              The compression type for the data export.

              Possible values include:
              • "GZIP"
              • "PARQUET"
            • Format — required — (String)

              The file format for the data export.

              Possible values include:
              • "TEXT_OR_CSV"
              • "PARQUET"
            • OutputType — required — (String)

              The output type for the data export.

              Possible values include:
              • "CUSTOM"
            • Overwrite — required — (String)

              The rule to follow when generating a version of the data export file. You have the choice to overwrite the previous version or to be delivered in addition to the previous versions. Overwriting exports can save on Amazon S3 storage costs. Creating new export versions allows you to track the changes in cost and usage data over time.

              Possible values include:
              • "CREATE_NEW_REPORT"
              • "OVERWRITE_REPORT"
          • S3Prefix — required — (String)

            The S3 path prefix you want prepended to the name of your data export.

          • S3Region — required — (String)

            The S3 bucket Region.

      • ExportArn — (String)

        The Amazon Resource Name (ARN) for this export.

      • Name — required — (String)

        The name of this specific data export.

      • RefreshCadence — required — (map)

        The cadence for Amazon Web Services to update the export in your S3 bucket.

        • Frequency — required — (String)

          The frequency that data exports are updated. The export refreshes each time the source data updates, up to three times daily.

          Possible values include:
          • "SYNCHRONOUS"

Returns:

• (AWS.Request) —

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

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

    The Amazon Resource Name (ARN) for this export.

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:

    • Export — (map)

      The data for this specific export.

      • DataQuery — required — (map)

        The data query for this specific data export.

        • QueryStatement — required — (String)

          The query statement.

        • TableConfigurations — (map<map<String>>)

          The table configuration.

      • Description — (String)

        The description for this specific data export.

      • DestinationConfigurations — required — (map)

        The destination configuration for this specific data export.

        • S3Destination — required — (map)

          An object that describes the destination of the data exports file.

          • S3Bucket — required — (String)

            The name of the Amazon S3 bucket used as the destination of a data export file.

          • S3OutputConfigurations — required — (map)

            The output configuration for the data export.

            • Compression — required — (String)

              The compression type for the data export.

              Possible values include:
              • "GZIP"
              • "PARQUET"
            • Format — required — (String)

              The file format for the data export.

              Possible values include:
              • "TEXT_OR_CSV"
              • "PARQUET"
            • OutputType — required — (String)

              The output type for the data export.

              Possible values include:
              • "CUSTOM"
            • Overwrite — required — (String)

              The rule to follow when generating a version of the data export file. You have the choice to overwrite the previous version or to be delivered in addition to the previous versions. Overwriting exports can save on Amazon S3 storage costs. Creating new export versions allows you to track the changes in cost and usage data over time.

              Possible values include:
              • "CREATE_NEW_REPORT"
              • "OVERWRITE_REPORT"
          • S3Prefix — required — (String)

            The S3 path prefix you want prepended to the name of your data export.

          • S3Region — required — (String)

            The S3 bucket Region.

      • ExportArn — (String)

        The Amazon Resource Name (ARN) for this export.

      • Name — required — (String)

        The name of this specific data export.

      • RefreshCadence — required — (map)

        The cadence for Amazon Web Services to update the export in your S3 bucket.

        • Frequency — required — (String)

          The frequency that data exports are updated. The export refreshes each time the source data updates, up to three times daily.

          Possible values include:
          • "SYNCHRONOUS"
    • ExportStatus — (map)

      The status of this specific export.

      • CreatedAt — (Date)

        The timestamp of when the export was created.

      • LastRefreshedAt — (Date)

        The timestamp of when the export was last generated.

      • LastUpdatedAt — (Date)

        The timestamp of when the export was updated.

      • StatusCode — (String)

        The status code for the request.

        Possible values include:
        • "HEALTHY"
        • "UNHEALTHY"
      • StatusReason — (String)

        The description for the status code.

        Possible values include:
        • "INSUFFICIENT_PERMISSION"
        • "BILL_OWNER_CHANGED"
        • "INTERNAL_FAILURE"

Returns:

• (AWS.Request) —

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

var params = {
  TableName: 'STRING_VALUE', /* required */
  TableProperties: {
    '<TableProperty>': 'STRING_VALUE',
    /* '<TableProperty>': ... */
  }
};
bcmdataexports.getTable(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: {}) —
  • TableName — (String)

    The name of the table.

  • TableProperties — (map<String>)

    TableProperties are additional configurations you can provide to change the data and schema of a table. Each table can have different TableProperties. Tables are not required to have any TableProperties. Each table property has a default value that it assumes if not specified.

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:

    • Description — (String)

      The table description.

    • Schema — (Array<map>)

      The schema of the table.

      • Description — (String)

        The description for a column.

      • Name — (String)

        The column name.

      • Type — (String)

        The kind of data a column stores.

    • TableName — (String)

      The name of the table.

    • TableProperties — (map<String>)

      TableProperties are additional configurations you can provide to change the data and schema of a table. Each table can have different TableProperties. Tables are not required to have any TableProperties. Each table property has a default value that it assumes if not specified.

Returns:

• (AWS.Request) —

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

var params = {
  ExportArn: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
bcmdataexports.listExecutions(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: {}) —
  • ExportArn — (String)

    The Amazon Resource Name (ARN) for this export.

  • MaxResults — (Integer)

    The maximum number of objects that are returned for the request.

  • NextToken — (String)

    The token to retrieve the next set of results.

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:

    • Executions — (Array<map>)

      The list of executions.

      • ExecutionId — required — (String)

        The ID for this specific execution.

      • ExecutionStatus — required — (map)

        The status of this specific execution.

        • CompletedAt — (Date)

          The time when the execution was completed.

        • CreatedAt — (Date)

          The time when the execution was created.

        • LastUpdatedAt — (Date)

          The time when the execution was last updated.

        • StatusCode — (String)

          The code for the status of the execution.

          Possible values include:
          • "INITIATION_IN_PROCESS"
          • "QUERY_QUEUED"
          • "QUERY_IN_PROCESS"
          • "QUERY_FAILURE"
          • "DELIVERY_IN_PROCESS"
          • "DELIVERY_SUCCESS"
          • "DELIVERY_FAILURE"
        • StatusReason — (String)

          The reason for the failed status.

          Possible values include:
          • "INSUFFICIENT_PERMISSION"
          • "BILL_OWNER_CHANGED"
          • "INTERNAL_FAILURE"
    • NextToken — (String)

      The token to retrieve the next set of results.

Returns:

• (AWS.Request) —

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

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
bcmdataexports.listExports(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 objects that are returned for the request.

  • NextToken — (String)

    The token to retrieve the next set of results.

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:

    • Exports — (Array<map>)

      The details of the exports, including name and export status.

      • ExportArn — required — (String)

        The Amazon Resource Name (ARN) for this export.

      • ExportName — required — (String)

        The name of this specific data export.

      • ExportStatus — required — (map)

        The status of this specific data export.

        • CreatedAt — (Date)

          The timestamp of when the export was created.

        • LastRefreshedAt — (Date)

          The timestamp of when the export was last generated.

        • LastUpdatedAt — (Date)

          The timestamp of when the export was updated.

        • StatusCode — (String)

          The status code for the request.

          Possible values include:
          • "HEALTHY"
          • "UNHEALTHY"
        • StatusReason — (String)

          The description for the status code.

          Possible values include:
          • "INSUFFICIENT_PERMISSION"
          • "BILL_OWNER_CHANGED"
          • "INTERNAL_FAILURE"
    • NextToken — (String)

      The token to retrieve the next set of results.

Returns:

• (AWS.Request) —

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

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
bcmdataexports.listTables(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 objects that are returned for the request.

  • NextToken — (String)

    The token to retrieve the next set of results.

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:

    • NextToken — (String)

      The token to retrieve the next set of results.

    • Tables — (Array<map>)

      The list of tables.

      • Description — (String)

        The description for the table.

      • TableName — (String)

        The name of the table.

      • TableProperties — (Array<map>)

        The properties for the table.

        • DefaultValue — (String)

          The default value for the table.

        • Description — (String)

          The description for the table.

        • Name — (String)

          The name of the table.

        • ValidValues — (Array<String>)

          The valid values for the table.

Returns:

• (AWS.Request) —

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

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
bcmdataexports.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: {}) —
  • MaxResults — (Integer)

    The maximum number of objects that are returned for the request.

  • NextToken — (String)

    The token to retrieve the next set of results.

  • ResourceArn — (String)

    The unique identifier for the 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. The data object has the following properties:

    • NextToken — (String)

      The token to retrieve the next set of results.

    • ResourceTags — (Array<map>)

      An optional list of tags to associate with the specified export. Each tag consists of a key and a value, and each key must be unique for the resource.

      • Key — required — (String)

        The key that's associated with the tag.

      • Value — required — (String)

        The value that's associated with the tag.

Returns:

• (AWS.Request) —

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

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  ResourceTags: [ /* required */
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
bcmdataexports.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 unique identifier for the resource.

  • ResourceTags — (Array<map>)

    The tags to associate with the resource. Each tag consists of a key and a value, and each key must be unique for the resource.

    • Key — required — (String)

      The key that's associated with the tag.

    • Value — required — (String)

      The value that's associated with the tag.

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 */
  ResourceTagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
bcmdataexports.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 unique identifier for the resource.

  • ResourceTagKeys — (Array<String>)

    The tag keys that are associated with the resource ARN.

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 = {
  Export: { /* required */
    DataQuery: { /* required */
      QueryStatement: 'STRING_VALUE', /* required */
      TableConfigurations: {
        '<TableName>': {
          '<TableProperty>': 'STRING_VALUE',
          /* '<TableProperty>': ... */
        },
        /* '<TableName>': ... */
      }
    },
    DestinationConfigurations: { /* required */
      S3Destination: { /* required */
        S3Bucket: 'STRING_VALUE', /* required */
        S3OutputConfigurations: { /* required */
          Compression: GZIP | PARQUET, /* required */
          Format: TEXT_OR_CSV | PARQUET, /* required */
          OutputType: CUSTOM, /* required */
          Overwrite: CREATE_NEW_REPORT | OVERWRITE_REPORT /* required */
        },
        S3Prefix: 'STRING_VALUE', /* required */
        S3Region: 'STRING_VALUE' /* required */
      }
    },
    Name: 'STRING_VALUE', /* required */
    RefreshCadence: { /* required */
      Frequency: SYNCHRONOUS /* required */
    },
    Description: 'STRING_VALUE',
    ExportArn: 'STRING_VALUE'
  },
  ExportArn: 'STRING_VALUE' /* required */
};
bcmdataexports.updateExport(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: {}) —
  • Export — (map)

    The name and query details for the export.

    • DataQuery — required — (map)

      The data query for this specific data export.

      • QueryStatement — required — (String)

        The query statement.

      • TableConfigurations — (map<map<String>>)

        The table configuration.

    • Description — (String)

      The description for this specific data export.

    • DestinationConfigurations — required — (map)

      The destination configuration for this specific data export.

      • S3Destination — required — (map)

        An object that describes the destination of the data exports file.

        • S3Bucket — required — (String)

          The name of the Amazon S3 bucket used as the destination of a data export file.

        • S3OutputConfigurations — required — (map)

          The output configuration for the data export.

          • Compression — required — (String)

            The compression type for the data export.

            Possible values include:
            • "GZIP"
            • "PARQUET"
          • Format — required — (String)

            The file format for the data export.

            Possible values include:
            • "TEXT_OR_CSV"
            • "PARQUET"
          • OutputType — required — (String)

            The output type for the data export.

            Possible values include:
            • "CUSTOM"
          • Overwrite — required — (String)

            The rule to follow when generating a version of the data export file. You have the choice to overwrite the previous version or to be delivered in addition to the previous versions. Overwriting exports can save on Amazon S3 storage costs. Creating new export versions allows you to track the changes in cost and usage data over time.

            Possible values include:
            • "CREATE_NEW_REPORT"
            • "OVERWRITE_REPORT"
        • S3Prefix — required — (String)

          The S3 path prefix you want prepended to the name of your data export.

        • S3Region — required — (String)

          The S3 bucket Region.

    • ExportArn — (String)

      The Amazon Resource Name (ARN) for this export.

    • Name — required — (String)

      The name of this specific data export.

    • RefreshCadence — required — (map)

      The cadence for Amazon Web Services to update the export in your S3 bucket.

      • Frequency — required — (String)

        The frequency that data exports are updated. The export refreshes each time the source data updates, up to three times daily.

        Possible values include:
        • "SYNCHRONOUS"
  • ExportArn — (String)

    The Amazon Resource Name (ARN) for this export.

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:

    • ExportArn — (String)

      The Amazon Resource Name (ARN) for this export.

Returns:

• (AWS.Request) —

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