Class: AWS.CUR

/* The following example lists the AWS Cost and Usage reports for the account. */

 var params = {
  MaxResults: 5
 };
 cur.describeReportDefinitions(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    ReportDefinitions: [
       {
      AdditionalArtifacts: [
         "QUICKSIGHT"
      ], 
      AdditionalSchemaElements: [
         "RESOURCES"
      ], 
      Compression: "GZIP", 
      Format: "textORcsv", 
      ReportName: "ExampleReport", 
      S3Bucket: "example-s3-bucket", 
      S3Prefix: "exampleprefix", 
      S3Region: "us-east-1", 
      TimeUnit: "HOURLY"
     }, 
       {
      AdditionalArtifacts: [
         "QUICKSIGHT"
      ], 
      AdditionalSchemaElements: [
         "RESOURCES"
      ], 
      Compression: "GZIP", 
      Format: "textORcsv", 
      ReportName: "ExampleReport2", 
      S3Bucket: "example-s3-bucket", 
      S3Prefix: "exampleprefix", 
      S3Region: "us-east-1", 
      TimeUnit: "HOURLY"
     }
    ]
   }
   */
 });

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
cur.describeReportDefinitions(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 Amazon Web Services returns for the operation.

  • NextToken — (String)

    A generic string.

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:

    • ReportDefinitions — (Array<map>)

      An Amazon Web Services Cost and Usage Report list owned by the account.

      • ReportName — required — (String)

        The name of the report that you want to create. The name must be unique, is case sensitive, and can't include spaces.

      • TimeUnit — required — (String)

        The length of time covered by the report.

        Possible values include:
        • "HOURLY"
        • "DAILY"
        • "MONTHLY"
      • Format — required — (String)

        The format that Amazon Web Services saves the report in.

        Possible values include:
        • "textORcsv"
        • "Parquet"
      • Compression — required — (String)

        The compression format that Amazon Web Services uses for the report.

        Possible values include:
        • "ZIP"
        • "GZIP"
        • "Parquet"
      • AdditionalSchemaElements — required — (Array<String>)

        A list of strings that indicate additional content that Amazon Web Services includes in the report, such as individual resource IDs.

      • S3Bucket — required — (String)

        The S3 bucket where Amazon Web Services delivers the report.

      • S3Prefix — required — (String)

        The prefix that Amazon Web Services adds to the report name when Amazon Web Services delivers the report. Your prefix can't include spaces.

      • S3Region — required — (String)

        The region of the S3 bucket that Amazon Web Services delivers the report into.

        Possible values include:
        • "af-south-1"
        • "ap-east-1"
        • "ap-south-1"
        • "ap-south-2"
        • "ap-southeast-1"
        • "ap-southeast-2"
        • "ap-southeast-3"
        • "ap-northeast-1"
        • "ap-northeast-2"
        • "ap-northeast-3"
        • "ca-central-1"
        • "eu-central-1"
        • "eu-central-2"
        • "eu-west-1"
        • "eu-west-2"
        • "eu-west-3"
        • "eu-north-1"
        • "eu-south-1"
        • "eu-south-2"
        • "me-central-1"
        • "me-south-1"
        • "sa-east-1"
        • "us-east-1"
        • "us-east-2"
        • "us-west-1"
        • "us-west-2"
        • "cn-north-1"
        • "cn-northwest-1"
      • AdditionalArtifacts — (Array<String>)

        A list of manifests that you want Amazon Web Services to create for this report.

      • RefreshClosedReports — (Boolean)

        Whether you want Amazon Web Services to update your reports after they have been finalized if Amazon Web Services detects charges related to previous months. These charges can include refunds, credits, or support fees.

      • ReportVersioning — (String)

        Whether you want Amazon Web Services to overwrite the previous version of each report or to deliver the report in addition to the previous versions.

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

        The Amazon resource name of the billing view. The BillingViewArn is needed to create Amazon Web Services Cost and Usage Report for each billing group maintained in the Amazon Web Services Billing Conductor service. The BillingViewArn for a billing group can be constructed as: arn:aws:billing::payer-account-id:billingview/billing-group-primary-account-id

      • ReportStatus — (map)

        The status of the report.

        • lastDelivery — (String)

          A timestamp that gives the date of a report delivery.

        • lastStatus — (String)

          An enum that gives the status of a report delivery.

          Possible values include:
          • "SUCCESS"
          • "ERROR_PERMISSIONS"
          • "ERROR_NO_BUCKET"
    • NextToken — (String)

      A generic string.

Returns:

• (AWS.Request) —

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

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

    The report name of the report definition that tags are to be returned for.

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

      The tags assigned to the report definition resource.

      • Key — required — (String)

        The key of the tag. Tag keys are case sensitive. Each report definition can only have up to one tag with the same key. If you try to add an existing tag with the same key, the existing tag value will be updated to the new value.

      • Value — required — (String)

        The value of the tag. Tag values are case-sensitive. This can be an empty string.

Returns:

• (AWS.Request) —

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

var params = {
  ReportDefinition: { /* required */
    AdditionalSchemaElements: [ /* required */
      RESOURCES | SPLIT_COST_ALLOCATION_DATA | MANUAL_DISCOUNT_COMPATIBILITY,
      /* more items */
    ],
    Compression: ZIP | GZIP | Parquet, /* required */
    Format: textORcsv | Parquet, /* required */
    ReportName: 'STRING_VALUE', /* required */
    S3Bucket: 'STRING_VALUE', /* required */
    S3Prefix: 'STRING_VALUE', /* required */
    S3Region: af-south-1 | ap-east-1 | ap-south-1 | ap-south-2 | ap-southeast-1 | ap-southeast-2 | ap-southeast-3 | ap-northeast-1 | ap-northeast-2 | ap-northeast-3 | ca-central-1 | eu-central-1 | eu-central-2 | eu-west-1 | eu-west-2 | eu-west-3 | eu-north-1 | eu-south-1 | eu-south-2 | me-central-1 | me-south-1 | sa-east-1 | us-east-1 | us-east-2 | us-west-1 | us-west-2 | cn-north-1 | cn-northwest-1, /* required */
    TimeUnit: HOURLY | DAILY | MONTHLY, /* required */
    AdditionalArtifacts: [
      REDSHIFT | QUICKSIGHT | ATHENA,
      /* more items */
    ],
    BillingViewArn: 'STRING_VALUE',
    RefreshClosedReports: true || false,
    ReportStatus: {
      lastDelivery: 'STRING_VALUE',
      lastStatus: SUCCESS | ERROR_PERMISSIONS | ERROR_NO_BUCKET
    },
    ReportVersioning: CREATE_NEW_REPORT | OVERWRITE_REPORT
  },
  ReportName: 'STRING_VALUE' /* required */
};
cur.modifyReportDefinition(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: {}) —
  • ReportName — (String)

    The name of the report that you want to create. The name must be unique, is case sensitive, and can't include spaces.

  • ReportDefinition — (map)

    The definition of Amazon Web Services Cost and Usage Report. You can specify the report name, time unit, report format, compression format, S3 bucket, additional artifacts, and schema elements in the definition.

    • ReportName — required — (String)

      The name of the report that you want to create. The name must be unique, is case sensitive, and can't include spaces.

    • TimeUnit — required — (String)

      The length of time covered by the report.

      Possible values include:
      • "HOURLY"
      • "DAILY"
      • "MONTHLY"
    • Format — required — (String)

      The format that Amazon Web Services saves the report in.

      Possible values include:
      • "textORcsv"
      • "Parquet"
    • Compression — required — (String)

      The compression format that Amazon Web Services uses for the report.

      Possible values include:
      • "ZIP"
      • "GZIP"
      • "Parquet"
    • AdditionalSchemaElements — required — (Array<String>)

      A list of strings that indicate additional content that Amazon Web Services includes in the report, such as individual resource IDs.

    • S3Bucket — required — (String)

      The S3 bucket where Amazon Web Services delivers the report.

    • S3Prefix — required — (String)

      The prefix that Amazon Web Services adds to the report name when Amazon Web Services delivers the report. Your prefix can't include spaces.

    • S3Region — required — (String)

      The region of the S3 bucket that Amazon Web Services delivers the report into.

      Possible values include:
      • "af-south-1"
      • "ap-east-1"
      • "ap-south-1"
      • "ap-south-2"
      • "ap-southeast-1"
      • "ap-southeast-2"
      • "ap-southeast-3"
      • "ap-northeast-1"
      • "ap-northeast-2"
      • "ap-northeast-3"
      • "ca-central-1"
      • "eu-central-1"
      • "eu-central-2"
      • "eu-west-1"
      • "eu-west-2"
      • "eu-west-3"
      • "eu-north-1"
      • "eu-south-1"
      • "eu-south-2"
      • "me-central-1"
      • "me-south-1"
      • "sa-east-1"
      • "us-east-1"
      • "us-east-2"
      • "us-west-1"
      • "us-west-2"
      • "cn-north-1"
      • "cn-northwest-1"
    • AdditionalArtifacts — (Array<String>)

      A list of manifests that you want Amazon Web Services to create for this report.

    • RefreshClosedReports — (Boolean)

      Whether you want Amazon Web Services to update your reports after they have been finalized if Amazon Web Services detects charges related to previous months. These charges can include refunds, credits, or support fees.

    • ReportVersioning — (String)

      Whether you want Amazon Web Services to overwrite the previous version of each report or to deliver the report in addition to the previous versions.

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

      The Amazon resource name of the billing view. The BillingViewArn is needed to create Amazon Web Services Cost and Usage Report for each billing group maintained in the Amazon Web Services Billing Conductor service. The BillingViewArn for a billing group can be constructed as: arn:aws:billing::payer-account-id:billingview/billing-group-primary-account-id

    • ReportStatus — (map)

      The status of the report.

      • lastDelivery — (String)

        A timestamp that gives the date of a report delivery.

      • lastStatus — (String)

        An enum that gives the status of a report delivery.

        Possible values include:
        • "SUCCESS"
        • "ERROR_PERMISSIONS"
        • "ERROR_NO_BUCKET"

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.

/* The following example creates a AWS Cost and Usage report named ExampleReport. */

 var params = {
  ReportDefinition: {
   AdditionalArtifacts: [
      "REDSHIFT", 
      "QUICKSIGHT"
   ], 
   AdditionalSchemaElements: [
      "RESOURCES"
   ], 
   Compression: "ZIP", 
   Format: "textORcsv", 
   ReportName: "ExampleReport", 
   S3Bucket: "example-s3-bucket", 
   S3Prefix: "exampleprefix", 
   S3Region: "us-east-1", 
   TimeUnit: "DAILY"
  }
 };
 cur.putReportDefinition(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
   }
   */
 });

var params = {
  ReportDefinition: { /* required */
    AdditionalSchemaElements: [ /* required */
      RESOURCES | SPLIT_COST_ALLOCATION_DATA | MANUAL_DISCOUNT_COMPATIBILITY,
      /* more items */
    ],
    Compression: ZIP | GZIP | Parquet, /* required */
    Format: textORcsv | Parquet, /* required */
    ReportName: 'STRING_VALUE', /* required */
    S3Bucket: 'STRING_VALUE', /* required */
    S3Prefix: 'STRING_VALUE', /* required */
    S3Region: af-south-1 | ap-east-1 | ap-south-1 | ap-south-2 | ap-southeast-1 | ap-southeast-2 | ap-southeast-3 | ap-northeast-1 | ap-northeast-2 | ap-northeast-3 | ca-central-1 | eu-central-1 | eu-central-2 | eu-west-1 | eu-west-2 | eu-west-3 | eu-north-1 | eu-south-1 | eu-south-2 | me-central-1 | me-south-1 | sa-east-1 | us-east-1 | us-east-2 | us-west-1 | us-west-2 | cn-north-1 | cn-northwest-1, /* required */
    TimeUnit: HOURLY | DAILY | MONTHLY, /* required */
    AdditionalArtifacts: [
      REDSHIFT | QUICKSIGHT | ATHENA,
      /* more items */
    ],
    BillingViewArn: 'STRING_VALUE',
    RefreshClosedReports: true || false,
    ReportStatus: {
      lastDelivery: 'STRING_VALUE',
      lastStatus: SUCCESS | ERROR_PERMISSIONS | ERROR_NO_BUCKET
    },
    ReportVersioning: CREATE_NEW_REPORT | OVERWRITE_REPORT
  },
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
cur.putReportDefinition(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: {}) —
  • ReportDefinition — (map)

    Represents the output of the PutReportDefinition operation. The content consists of the detailed metadata and data file information.

    • ReportName — required — (String)

      The name of the report that you want to create. The name must be unique, is case sensitive, and can't include spaces.

    • TimeUnit — required — (String)

      The length of time covered by the report.

      Possible values include:
      • "HOURLY"
      • "DAILY"
      • "MONTHLY"
    • Format — required — (String)

      The format that Amazon Web Services saves the report in.

      Possible values include:
      • "textORcsv"
      • "Parquet"
    • Compression — required — (String)

      The compression format that Amazon Web Services uses for the report.

      Possible values include:
      • "ZIP"
      • "GZIP"
      • "Parquet"
    • AdditionalSchemaElements — required — (Array<String>)

      A list of strings that indicate additional content that Amazon Web Services includes in the report, such as individual resource IDs.

    • S3Bucket — required — (String)

      The S3 bucket where Amazon Web Services delivers the report.

    • S3Prefix — required — (String)

      The prefix that Amazon Web Services adds to the report name when Amazon Web Services delivers the report. Your prefix can't include spaces.

    • S3Region — required — (String)

      The region of the S3 bucket that Amazon Web Services delivers the report into.

      Possible values include:
      • "af-south-1"
      • "ap-east-1"
      • "ap-south-1"
      • "ap-south-2"
      • "ap-southeast-1"
      • "ap-southeast-2"
      • "ap-southeast-3"
      • "ap-northeast-1"
      • "ap-northeast-2"
      • "ap-northeast-3"
      • "ca-central-1"
      • "eu-central-1"
      • "eu-central-2"
      • "eu-west-1"
      • "eu-west-2"
      • "eu-west-3"
      • "eu-north-1"
      • "eu-south-1"
      • "eu-south-2"
      • "me-central-1"
      • "me-south-1"
      • "sa-east-1"
      • "us-east-1"
      • "us-east-2"
      • "us-west-1"
      • "us-west-2"
      • "cn-north-1"
      • "cn-northwest-1"
    • AdditionalArtifacts — (Array<String>)

      A list of manifests that you want Amazon Web Services to create for this report.

    • RefreshClosedReports — (Boolean)

      Whether you want Amazon Web Services to update your reports after they have been finalized if Amazon Web Services detects charges related to previous months. These charges can include refunds, credits, or support fees.

    • ReportVersioning — (String)

      Whether you want Amazon Web Services to overwrite the previous version of each report or to deliver the report in addition to the previous versions.

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

      The Amazon resource name of the billing view. The BillingViewArn is needed to create Amazon Web Services Cost and Usage Report for each billing group maintained in the Amazon Web Services Billing Conductor service. The BillingViewArn for a billing group can be constructed as: arn:aws:billing::payer-account-id:billingview/billing-group-primary-account-id

    • ReportStatus — (map)

      The status of the report.

      • lastDelivery — (String)

        A timestamp that gives the date of a report delivery.

      • lastStatus — (String)

        An enum that gives the status of a report delivery.

        Possible values include:
        • "SUCCESS"
        • "ERROR_PERMISSIONS"
        • "ERROR_NO_BUCKET"
  • Tags — (Array<map>)

    The tags to be assigned to the report definition resource.

    • Key — required — (String)

      The key of the tag. Tag keys are case sensitive. Each report definition can only have up to one tag with the same key. If you try to add an existing tag with the same key, the existing tag value will be updated to the new value.

    • Value — required — (String)

      The value of the tag. Tag values are case-sensitive. This can be an empty string.

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 = {
  ReportName: 'STRING_VALUE', /* required */
  Tags: [ /* required */
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
cur.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: {}) —
  • ReportName — (String)

    The report name of the report definition that tags are to be associated with.

  • Tags — (Array<map>)

    The tags to be assigned to the report definition resource.

    • Key — required — (String)

      The key of the tag. Tag keys are case sensitive. Each report definition can only have up to one tag with the same key. If you try to add an existing tag with the same key, the existing tag value will be updated to the new value.

    • Value — required — (String)

      The value of the tag. Tag values are case-sensitive. This can be an empty string.

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 = {
  ReportName: 'STRING_VALUE', /* required */
  TagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
cur.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: {}) —
  • ReportName — (String)

    The report name of the report definition that tags are to be disassociated from.

  • TagKeys — (Array<String>)

    The tags to be disassociated from the report definition 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.