Retrieves AWS cloud account usage cost from cost explorer.

POST 
/v1/clouds/aws/cost

Retrieves AWS cloud account usage cost from cost explorer.

Request

Header Parameters

ProjectUid string

Scope the request to the specified project uid

application/json

Body

required

Request payload for AWS cloud cost

accountIdstring

AccountId of AWS cloud cost

credentials

object

required

AWS cloud account which includes access key and secret key in case of 'secret' credentials type. It includes policyARNS, ARN and externalId in case of sts. Partition is a group of AWS Region and Service objects

accessKeystring

AWS account access key

credentialTypestring

Possible values: [secret, sts]

Default value: secret

Allowed Values [secret, sts]. STS type will be used for role assumption for sts type, accessKey/secretKey contains the source account, Arn is the target account.

partitionstring

Possible values: [aws, aws-us-gov]

Default value: aws

AWS accounts are scoped to a single partition. Allowed values [aws, aws-us-gov], Default values

policyARNsstring[]

List of policy ARNs required in case of credentialType sts.

secretKeystring

AWS account secret key

sts

object

Aws sts credentials

arnstring

Arn for the aws sts credentials in cloud account

externalIdstring

ExternalId for the aws sts credentials in cloud account

filter

object

Aws cloud account usage cost payload filter. startTime and endTime should be within 12 months range from now.

endTimedate-time

Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

iamUserIdstring

IAM UserId of AWS account

startTimedate-timerequired

Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

Responses

200

(empty)

application/json

Schema

Schema

cost

object

AWS cloud account usage cost summary of monthlyCosts and totalCost

monthlyCosts

object[]

Monthly cost of AWS cost

Array [

amountfloat64

Amount for aws cloud cost

timestampinteger

Time duration for aws cloud cost

]

totalfloat64

Total cost of AWS cost

Example (from schema)

{
  "cost": {
    "monthlyCosts": [
      {
        "amount": 0,
        "timestamp": 0
      }
    ],
    "total": 0
  }
}

Loading...