@datafire/amazonaws_cur

Client library for AWS Cost and Usage Report Service

Installation and Usage

npm install --save @datafire/amazonaws_cur

let amazonaws_cur = require('@datafire/amazonaws_cur').create({
  accessKeyId: "",
  secretAccessKey: "",
  region: ""
});

amazonaws_cur.DeleteReportDefinition({}).then(data => {
  console.log(data);
});

Description

All public APIs for AWS Cost and Usage Report service

Actions

DeleteReportDefinition

amazonaws_cur.DeleteReportDefinition({}, context)

Input

• input object
  • ReportName ReportName

Output

• output DeleteReportDefinitionResponse

DescribeReportDefinitions

amazonaws_cur.DescribeReportDefinitions({}, context)

Input

• input object
  • MaxResults string
  • NextToken string
  • MaxResults MaxResults
  • NextToken GenericString

Output

• output DescribeReportDefinitionsResponse

PutReportDefinition

amazonaws_cur.PutReportDefinition({
  "ReportDefinition": {
    "ReportName": "",
    "TimeUnit": "",
    "Format": "",
    "Compression": "",
    "AdditionalSchemaElements": [],
    "S3Bucket": "",
    "S3Prefix": "",
    "S3Region": ""
  }
}, context)

Input

• input object
  • ReportDefinition required ReportDefinition

Output

• output PutReportDefinitionResponse

Definitions

AWSRegion

• AWSRegion string (values: us-east-1, us-west-1, us-west-2, eu-central-1, eu-west-1, ap-southeast-1, ap-southeast-2, ap-northeast-1): Region of customer S3 bucket.

AdditionalArtifact

• AdditionalArtifact string (values: REDSHIFT, QUICKSIGHT): Enable support for Redshift and/or QuickSight.

AdditionalArtifactList

• AdditionalArtifactList array: A list of additional artifacts.
  • items AdditionalArtifact

CompressionFormat

• CompressionFormat string (values: ZIP, GZIP): Preferred compression format for report.

DeleteReportDefinitionRequest

• DeleteReportDefinitionRequest object: Request of DeleteReportDefinition
  • ReportName ReportName

DeleteReportDefinitionResponse

• DeleteReportDefinitionResponse object: Response of DeleteReportDefinition
  • ResponseMessage DeleteResponseMessage

DeleteResponseMessage

• DeleteResponseMessage string: A message indicates if the deletion is successful.

DescribeReportDefinitionsRequest

• DescribeReportDefinitionsRequest object: Request of DescribeReportDefinitions
  • MaxResults MaxResults
  • NextToken GenericString

DescribeReportDefinitionsResponse

• DescribeReportDefinitionsResponse object: Response of DescribeReportDefinitions
  • NextToken GenericString
  • ReportDefinitions ReportDefinitionList

DuplicateReportNameException

• DuplicateReportNameException object: This exception is thrown when putting a report preference with a name that already exists.
  • Message ErrorMessage

ErrorMessage

• ErrorMessage string: A message to show the detail of the exception.

GenericString

• GenericString string: A generic string.

InternalErrorException

• InternalErrorException object: This exception is thrown on a known dependency failure.
  • Message ErrorMessage

MaxResults

• MaxResults integer: The max number of results returned by the operation.

PutReportDefinitionRequest

• PutReportDefinitionRequest object: Request of PutReportDefinition
  • ReportDefinition required ReportDefinition

PutReportDefinitionResponse

• PutReportDefinitionResponse object: Response of PutReportDefinition

ReportDefinition

• ReportDefinition object: The definition of AWS Cost and Usage Report. Customer can specify the report name, time unit, report format, compression format, S3 bucket and additional artifacts and schema elements in the definition.
  • AdditionalArtifacts AdditionalArtifactList
  • AdditionalSchemaElements required SchemaElementList
  • Compression required CompressionFormat
  • Format required ReportFormat
  • ReportName required ReportName
  • S3Bucket required S3Bucket
  • S3Prefix required S3Prefix
  • S3Region required AWSRegion
  • TimeUnit required TimeUnit

ReportDefinitionList

• ReportDefinitionList array: A list of report definitions.
  • items ReportDefinition

ReportFormat

• ReportFormat string (values: textORcsv): Preferred format for report.

ReportLimitReachedException

• ReportLimitReachedException object: This exception is thrown when the number of report preference reaches max limit. The max number is 5.
  • Message ErrorMessage

ReportName

• ReportName string: Preferred name for a report, it has to be unique. Must starts with a number/letter, case sensitive. Limited to 256 characters.

S3Bucket

• S3Bucket string: Name of customer S3 bucket.

S3Prefix

• S3Prefix string: Preferred report path prefix. Limited to 256 characters.

SchemaElement

• SchemaElement string (values: RESOURCES): Preference of including Resource IDs. You can include additional details about individual resource IDs in your report.

SchemaElementList

• SchemaElementList array: A list of schema elements.
  • items SchemaElement

TimeUnit

• TimeUnit string (values: HOURLY, DAILY): The frequency on which report data are measured and displayed.

ValidationException

• ValidationException object: This exception is thrown when providing an invalid input. eg. Put a report preference with an invalid report name, or Delete a report preference with an empty report name.
  • Message ErrorMessage