openapi: 3.2.0 info: title: CoreStack External Billing API version: 1.0.0 termsOfService: http://corestack.io/ license: name: CoreStack Inc License url: http://corestack.io/licenses/LICENSE-2.0.html description: Cost Management servers: - url: / tags: - name: Billing description: Cost Management paths: /v2/billing/aggregation: post: responses: '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ModelError' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ModelError' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ModelError' '200': description: Success content: application/json: schema: type: array items: $ref: '#/components/schemas/BillingAggregationResult' summary: Aggregate costs based on input criteria description: Generate cost aggregation. operationId: GetCostAggregation security: - auth_token: [] tags: - Billing requestBody: content: application/json: schema: $ref: '#/components/schemas/BillingAggregationRequest' required: true /v2/billing/aggregation/batch: post: responses: '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ModelError' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ModelError' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ModelError' '200': description: Success content: application/json: schema: $ref: '#/components/schemas/BillingAggregationResponseBatch' summary: Aggregate costs based on input criteria description: Generate cost aggregations in a batch. operationId: GetCostAggregationBatch security: - auth_token: [] tags: - Billing requestBody: content: application/json: schema: $ref: '#/components/schemas/BillingAggregationRequestBatch' required: true /v2/billing/aggregation/trend: post: responses: '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ModelError' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ModelError' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ModelError' '200': description: Success content: application/json: schema: type: array items: $ref: '#/components/schemas/BillingAggregationTrendResult' summary: Aggregate costs in a trend based on input criteria description: Generate cost aggregation trend. operationId: GetCostAggregationTrend security: - auth_token: [] tags: - Billing requestBody: content: application/json: schema: $ref: '#/components/schemas/BillingAggregationTrendRequest' required: true /v2/billing/cost_and_usage/aggregation/trend: post: responses: '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ModelError' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ModelError' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ModelError' '200': description: Success content: application/json: schema: type: array items: $ref: '#/components/schemas/BillingCostAndUsageAggregationTrendResult' summary: Retrieves the aggregated trend of usage, rate and cost over a specified time period description: Generate cost and usage aggregation trend. operationId: CostAndUsageAggregationTrend security: - auth_token: [] tags: - Billing requestBody: content: application/json: schema: $ref: '#/components/schemas/BillingCostAndUsageAggregationRequest' required: true /v2/billing/description/aggregation/trend: post: responses: '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ModelError' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ModelError' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ModelError' '200': description: Success content: application/json: schema: type: array items: $ref: '#/components/schemas/BillingDescriptionsTrendResult' summary: Get description trend results description: Generate description trend. operationId: GetDescriptionTrend security: - auth_token: [] tags: - Billing requestBody: content: application/json: schema: $ref: '#/components/schemas/BillingAggregationRequest' required: true /v2/billing/extras: post: responses: '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ModelError' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ModelError' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ModelError' '200': description: Success content: application/json: schema: type: array description: List of tag key/value pairs by service account items: $ref: '#/components/schemas/ServiceAccountKeyValues' summary: List extra keys used in service accounts description: List extra keys for service accounts. operationId: GetExtraKeysByServiceAccounts security: - auth_token: [] tags: - Billing requestBody: content: application/json: schema: $ref: '#/components/schemas/BillingExtraKeysRequest' required: true /v2/billing/identities: post: responses: '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ModelError' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ModelError' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ModelError' '200': description: Success content: application/json: schema: type: array items: $ref: '#/components/schemas/BillingIdentitiesResult' summary: Return distinct billing line-item identities including tags, without time-series data description: Return distinct line-item identities (with tags) matching the request, without timestamps or cost values. operationId: GetBillingIdentities security: - auth_token: [] tags: - Billing requestBody: content: application/json: schema: $ref: '#/components/schemas/BillingIdentitiesRequest' required: true /v2/billing/line_items_summary: post: responses: '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ModelError' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ModelError' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ModelError' '200': description: Success content: application/json: schema: type: array description: List of tag key/value pairs by service account items: $ref: '#/components/schemas/ServiceAccountKeyValues' summary: List values for group_by key used in service accounts description: List values for group_by keys. operationId: GetLineItemSummary security: - auth_token: [] tags: - Billing requestBody: content: application/json: schema: $ref: '#/components/schemas/BillingLineItemSummaryRequest' required: true /v2/billing/platform/tags: post: responses: '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ModelError' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ModelError' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ModelError' '200': description: Success content: application/json: schema: type: array description: List of tag key/value pairs by service account items: $ref: '#/components/schemas/ServiceAccountPlatformKeyValues' summary: List tag keys used in service accounts description: List tag keys values and kind for platform service accounts. operationId: GetPlatformServiceAccountTagsDetails security: - auth_token: [] tags: - Billing requestBody: content: application/json: schema: $ref: '#/components/schemas/BillingPlatformTagKeysRequest' required: true /v2/billing/rate/aggregation/trend: post: responses: '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ModelError' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ModelError' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ModelError' '200': description: Success content: application/json: schema: type: array items: $ref: '#/components/schemas/BillingRateAggregationTrendResult' summary: Aggregate rate in a trend based on input criteria description: Generate Rate aggregation trend. operationId: GetRateAggregationTrend security: - auth_token: [] tags: - Billing requestBody: content: application/json: schema: $ref: '#/components/schemas/BillingRateAggregationTrendRequest' required: true /v2/billing/tags: post: responses: '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ModelError' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ModelError' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ModelError' '200': description: Success content: application/json: schema: type: array description: List of tag key/value pairs by service account items: $ref: '#/components/schemas/ServiceAccountKeyValues' summary: List tag keys used in service accounts description: List tag keys for service accounts. operationId: GetTagKeysByServiceAccounts security: - auth_token: [] tags: - Billing requestBody: content: application/json: schema: $ref: '#/components/schemas/BillingTagKeysRequest' required: true /v2/billing/usage/aggregation/trend: post: responses: '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ModelError' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ModelError' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ModelError' '200': description: Success content: application/json: schema: type: array items: $ref: '#/components/schemas/BillingUsageAggregationTrendResult' summary: Aggregate usage in a trend based on input criteria description: Generate usage aggregation trend. operationId: GetUsageAggregationTrend security: - auth_token: [] tags: - Billing requestBody: content: application/json: schema: $ref: '#/components/schemas/BillingUsageAggregationTrendRequest' required: true /v2/billing_info/batch: post: responses: '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ModelError' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ModelError' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ModelError' '200': description: Success content: application/json: schema: $ref: '#/components/schemas/BillingInformationBatchResponse' summary: Fetch Billing Information description: Fetch Billing Info. operationId: BatchBillingInfoByServiceAccount security: - auth_token: [] tags: - Billing requestBody: content: application/json: schema: $ref: '#/components/schemas/BillingInformationRequest' required: true components: schemas: BillingCostAndUsageAggregationRequest: allOf: - $ref: '#/components/schemas/BillingAggregationBase' - required: - billing_source - granularity - group_by properties: granularity: type: integer description: Number of seconds between steps billing_source: type: string description: Billing plan to select data from group_by: type: array description: If set, the dimensions to group results by items: $ref: '#/components/schemas/BillingGroupByDetails' include_charge_description: type: boolean description: If set, the descriptions of line items will be included in the results. limit: type: integer description: If set, limits the results to given number. type: object BillingAggregationRequest: allOf: - $ref: '#/components/schemas/BillingAggregationBase' - required: - billing_source properties: billing_source: type: string description: Billing plan to select data from group_by: type: array description: If set, the dimensions to group results by items: $ref: '#/components/schemas/BillingGroupByDetails' limit: type: integer description: If set, limits the results to given number. billing_mode: type: boolean description: If set, results for cost data gets computed based on billing period start dates that falls in the range of the start date and end date. include_resource_children: type: boolean description: If set, intercept the query operators to manipulate platform specific accounts. This is only applicable for ServiceAccountQueryOperator manipulation when the visitor is platform and call made through billing plans. type: object BillingInformationBatchResponse: properties: results: type: object description: Map from identifier to response model additionalProperties: $ref: '#/components/schemas/BillingInformationBase' type: object BillingLineItemSummaryRequest: allOf: - $ref: '#/components/schemas/BillingSummaryBase' - required: - key properties: key: description: Field to return results for $ref: '#/components/schemas/BillingGroupByDetails' type: object BillingIdentitiesRequest: required: - end_date - start_date properties: service_account_ids: type: array description: Service Account IDs items: type: string x-cs-type: ObjectId filters: description: Query expression to filter line items $ref: '#/components/schemas/QueryOperator' start_date: type: string format: date-time description: start of the spend period end_date: type: string format: date-time description: end of the spend period type: object BillingPlatformTagKeysRequest: allOf: - $ref: '#/components/schemas/BillingTagKeysRequest' - properties: kinds: type: array description: Billing Platform kinds items: type: string type: object BillingAggregationRequestBatch: properties: requests: type: array description: Batch of aggregation requests items: $ref: '#/components/schemas/BillingAggregationRequest' type: object ServiceAccountKeyValues: properties: service_account_id: type: string description: Service Account ID x-cs-type: ObjectId values_by_key: type: array description: List of tag key/value pairs for an account items: $ref: '#/components/schemas/KeyValues' type: object BillingExtraKeysRequest: allOf: - $ref: '#/components/schemas/BillingSummaryBase' - properties: extra_keys: type: array description: If set, the subset of keys to return items: type: string include_values: type: boolean description: If set, include values, not just keys type: object BillingInformationBase: required: - type properties: {} discriminator: propertyName: type type: object x-cs-subtypes: - subtype_model: BillingInformationDetailForAws subtype_name: BillingInformationDetailForAws - subtype_model: BillingInformationDetailForAzureCsp subtype_name: BillingInformationDetailForAzureCsp - subtype_model: BillingInformationDetailForAzureEa subtype_name: BillingInformationDetailForAzureEa - subtype_model: BillingInformationDetailForAzureMca subtype_name: BillingInformationDetailForAzureMca - subtype_model: BillingInformationDetailForAzureSubscription subtype_name: BillingInformationDetailForAzureSubscription - subtype_model: BillingInformationDetailForSaas subtype_name: BillingInformationDetailForSaas BillingGroupByDetails: required: - selector properties: selector: type: string description: Dimension to group results by example: service_account_tags enum: - service_account_tags - service_name - tenant_id - tenant_tags - service_account_id - delegate_service_account_id - availability_zone - billing_entity - line_item_type - location - meter_sub_category - pricing_category - pricing_purchase_option - product_category - product_family - product_service_code - product_sku - publisher - resource_category - resource_group - resource_id - resource_name - resource_operation - extras - tags - hierarchy - dimension - compartment_name - compartment_id - resource_type - utilization_type x-cs-enum-type: BillingGroupBySelector key: type: string description: Key to use with Extras, Tags, Hierarchy, and Dimension value: type: string description: Value to use with Extras, Tags and Hierarchy kind: type: string description: Value to use in Tags groups: type: array description: List of custom groups to use with Dimension items: $ref: '#/components/schemas/BillingCustomGroup' type: object BillingDescriptionsTrendResult: allOf: - $ref: '#/components/schemas/BillingAggregationTrendResult' - properties: descriptions: type: array items: type: string description: Descriptions of line items type: object BillingUsageAggregationTrendRequest: allOf: - $ref: '#/components/schemas/BillingAggregationBase' - required: - granularity properties: granularity: type: integer description: Number of seconds between steps group_by: type: array description: If set, the dimensions to group results by items: $ref: '#/components/schemas/BillingGroupByDetails' limit: type: integer description: If set, limits the results to given number. type: object BillingAggregationBase: required: - end_date - start_date properties: service_account_ids: type: array description: Service Account IDs items: type: string x-cs-type: ObjectId filters: description: Query expression to filter line items $ref: '#/components/schemas/QueryOperator' start_date: type: string format: date-time description: start of the spend period end_date: type: string format: date-time description: end of the spend period time_zone: type: string description: Optional timezone of the caller platform: type: string description: Platforms example: kubernetes enum: - kubernetes x-cs-enum-type: Platforms skip_service_account_grouping: type: boolean description: If set, do not group by service account type: object BillingRateAggregationTrendRequest: allOf: - $ref: '#/components/schemas/BillingAggregationBase' - required: - billing_source properties: billing_source: type: string description: Billing plan to select data from group_by: type: array description: If set, group results by the given group of fields items: $ref: '#/components/schemas/BillingGroupByDetails' type: object BillingUsageAggregationTrendResult: allOf: - $ref: '#/components/schemas/BillingAggregationTrendResult' - properties: {} type: object ModelError: required: - message properties: message: type: string description: Error response message. type: object BillingInformationRequest: properties: service_account_ids: type: array description: Service Account IDs items: type: string x-cs-type: ObjectId start_date: type: string format: date-time description: start of the spend period end_date: type: string format: date-time description: end of the spend period type: object BillingIdentitiesResult: properties: identity: description: Identity of the line item group, including tags $ref: '#/components/schemas/BillingLineItemIdentityPlus' type: object PlatformKeyValues: allOf: - $ref: '#/components/schemas/KeyValues' - required: - kind properties: kind: type: string description: Type of the platform kind (e.g. namespace, deployment, node) type: object KeyValuePair: properties: key: type: string description: Key of the pair value: type: string description: Value of the pair type: object BillingRateAggregationTrendResult: allOf: - $ref: '#/components/schemas/BillingAggregationTrendResult' - properties: {} type: object BillingAggregationResponseBatch: properties: results: type: array description: Batch of aggregation requests items: type: array items: $ref: '#/components/schemas/BillingAggregationResult' type: object BillingAggregationTrendResult: properties: identity: description: Identity of the result group $ref: '#/components/schemas/BillingLineItemIdentityPlus' timestamps: type: array items: type: string format: date-time description: Time of results values: type: array items: type: number description: Results of aggregation type: object QueryOperator: required: - __type properties: {} discriminator: propertyName: __type type: object x-cs-subtypes: - subtype_model: QueryOperatorTrue subtype_name: QueryOperatorTrue - subtype_model: QueryOperatorFalse subtype_name: QueryOperatorFalse - subtype_model: QueryOperatorBinary subtype_name: QueryOperatorBinary - subtype_model: QueryOperatorBinaryLogic subtype_name: QueryOperatorBinaryLogic - subtype_model: QueryOperatorNary subtype_name: QueryOperatorNary - subtype_model: QueryOperatorNaryLogic subtype_name: QueryOperatorNaryLogic - subtype_model: QueryOperatorComparator subtype_name: QueryOperatorComparator - subtype_model: QueryOperatorComparatorLogic subtype_name: QueryOperatorComparatorLogic - subtype_model: QueryOperatorUnary subtype_name: QueryOperatorUnary - subtype_model: QueryOperatorUnaryNot subtype_name: QueryOperatorUnaryNot - subtype_model: QueryOperatorBinaryForGraph subtype_name: QueryOperatorBinaryForGraph - subtype_model: QueryOperatorBinaryLogicForGraph subtype_name: QueryOperatorBinaryLogicForGraph - subtype_model: QueryOperatorNaryForGraph subtype_name: QueryOperatorNaryForGraph - subtype_model: QueryOperatorNaryLogicForGraph subtype_name: QueryOperatorNaryLogicForGraph - subtype_model: QueryOperatorUnaryForGraph subtype_name: QueryOperatorUnaryForGraph - subtype_model: QueryOperatorUnaryNotForGraph subtype_name: QueryOperatorUnaryNotForGraph - subtype_model: ServiceAccountQueryOperator subtype_name: ServiceAccountQueryOperator - subtype_model: TenantQueryOperator subtype_name: TenantQueryOperator - subtype_model: DescendantServiceAccountQueryOperator subtype_name: DescendantServiceAccountQueryOperator - subtype_model: DescendantServiceAccountInTenantQueryOperator subtype_name: DescendantServiceAccountInTenantQueryOperator - subtype_model: TenantTagKeyQueryOperator subtype_name: TenantTagKeyQueryOperator - subtype_model: TenantTagKeyValueQueryOperator subtype_name: TenantTagKeyValueQueryOperator - subtype_model: LocationQueryOperator subtype_name: LocationQueryOperator - subtype_model: AvailabilityZoneQueryOperator subtype_name: AvailabilityZoneQueryOperator - subtype_model: BillingSourceQueryOperator subtype_name: BillingSourceQueryOperator - subtype_model: CurrencyQueryOperator subtype_name: CurrencyQueryOperator - subtype_model: ProductCategoryQueryOperator subtype_name: ProductCategoryQueryOperator - subtype_model: ProductFamilyQueryOperator subtype_name: ProductFamilyQueryOperator - subtype_model: ProductServiceCodeQueryOperator subtype_name: ProductServiceCodeQueryOperator - subtype_model: ProductSkuQueryOperator subtype_name: ProductSkuQueryOperator - subtype_model: PublisherQueryOperator subtype_name: PublisherQueryOperator - subtype_model: ResourceCategoryQueryOperator subtype_name: ResourceCategoryQueryOperator - subtype_model: ResourceIdQueryOperator subtype_name: ResourceIdQueryOperator - subtype_model: ResourceGroupQueryOperator subtype_name: ResourceGroupQueryOperator - subtype_model: ResourceNameQueryOperator subtype_name: ResourceNameQueryOperator - subtype_model: ResourceOperationQueryOperator subtype_name: ResourceOperationQueryOperator - subtype_model: ResourceQueryExtraPresence subtype_name: ResourceQueryExtraPresence - subtype_model: ResourceQueryExtraKey subtype_name: ResourceQueryExtraKey - subtype_model: ScopeContainsTenantQueryOperator subtype_name: ScopeContainsTenantQueryOperator - subtype_model: ScopeContainsServiceAccountQueryOperator subtype_name: ScopeContainsServiceAccountQueryOperator - subtype_model: ScopeIsQueryOperator subtype_name: ScopeIsQueryOperator - subtype_model: ServiceCategoryQueryOperator subtype_name: ServiceCategoryQueryOperator - subtype_model: ServiceTypeQueryOperator subtype_name: ServiceTypeQueryOperator - subtype_model: CompartmentNameQueryOperator subtype_name: CompartmentNameQueryOperator - subtype_model: ResourceQueryExtraKeyValue subtype_name: ResourceQueryExtraKeyValue - subtype_model: WorkFlowIdQueryOperator subtype_name: WorkFlowIdQueryOperator - subtype_model: RecommendationSubClassificationQueryOperator subtype_name: RecommendationSubClassificationQueryOperator - subtype_model: ServiceNowCmdbQuerySyncLogResourceId subtype_name: ServiceNowCmdbQuerySyncLogResourceId - subtype_model: ServiceNowCmdbQuerySyncLogResourceType subtype_name: ServiceNowCmdbQuerySyncLogResourceType - subtype_model: ServiceNowCmdbQuerySyncLogAction subtype_name: ServiceNowCmdbQuerySyncLogAction - subtype_model: ServiceNowCmdbQuerySyncLogStatus subtype_name: ServiceNowCmdbQuerySyncLogStatus - subtype_model: ServiceNowCmdbQuerySyncLogService subtype_name: ServiceNowCmdbQuerySyncLogService - subtype_model: ServiceAccountNativeDetailsQueryOperator subtype_name: ServiceAccountNativeDetailsQueryOperator - subtype_model: ServiceAccountStatusQueryOperator subtype_name: ServiceAccountStatusQueryOperator - subtype_model: ServiceAccountTagKeyQueryOperator subtype_name: ServiceAccountTagKeyQueryOperator - subtype_model: ServiceAccountTagKeyRegexQueryOperator subtype_name: ServiceAccountTagKeyRegexQueryOperator - subtype_model: ServiceAccountTagKeyValueQueryOperator subtype_name: ServiceAccountTagKeyValueQueryOperator - subtype_model: ApplicableHealthMetricsQueryOperator subtype_name: ApplicableHealthMetricsQueryOperator - subtype_model: EpssScoreRangeQueryOperator subtype_name: EpssScoreRangeQueryOperator - subtype_model: CvssMetricScoreRangeQueryOperator subtype_name: CvssMetricScoreRangeQueryOperator - subtype_model: GraphionScoreRangeQueryOperator subtype_name: GraphionScoreRangeQueryOperator - subtype_model: AppSecopsApplicationIdQueryOperator subtype_name: AppSecopsApplicationIdQueryOperator - subtype_model: AppSecopsPortfolioIdQueryOperator subtype_name: AppSecopsPortfolioIdQueryOperator - subtype_model: AppSecopsProjectIdQueryOperator subtype_name: AppSecopsProjectIdQueryOperator - subtype_model: AppSecopsSbomComponentIdQueryOperator subtype_name: AppSecopsSbomComponentIdQueryOperator - subtype_model: AppSecopsSbomVersionIdQueryOperator subtype_name: AppSecopsSbomVersionIdQueryOperator - subtype_model: AppSecopsComponentProductQueryOperator subtype_name: AppSecopsComponentProductQueryOperator - subtype_model: AppSecopsSbomComponentTypeQueryOperator subtype_name: AppSecopsSbomComponentTypeQueryOperator - subtype_model: AppSecopsSbomVersionSubmittedByQueryOperator subtype_name: AppSecopsSbomVersionSubmittedByQueryOperator - subtype_model: AppSecopsSbomVersionSubmittedDateQueryOperator subtype_name: AppSecopsSbomVersionSubmittedDateQueryOperator - subtype_model: AppSecopsSbomVersionBuildIdQueryOperator subtype_name: AppSecopsSbomVersionBuildIdQueryOperator - subtype_model: AppSecopsSbomNameQueryOperator subtype_name: AppSecopsSbomNameQueryOperator - subtype_model: AppSecopsCveIdQueryOperator subtype_name: AppSecopsCveIdQueryOperator - subtype_model: AppSecopsEpssScoreQueryOperator subtype_name: AppSecopsEpssScoreQueryOperator - subtype_model: AppSecopsCvssScoreQueryOperator subtype_name: AppSecopsCvssScoreQueryOperator - subtype_model: AppSecopsGraphionScoreQueryOperator subtype_name: AppSecopsGraphionScoreQueryOperator - subtype_model: SecopsVulnerabilitySeverityQueryOperator subtype_name: SecopsVulnerabilitySeverityQueryOperator - subtype_model: AppSecopsIsKnownExploitedVulnerabilityQueryOperator subtype_name: AppSecopsIsKnownExploitedVulnerabilityQueryOperator - subtype_model: AppSecopsVulnerabilityExploitabilityMetricAttackVectorV31QueryOperator subtype_name: AppSecopsVulnerabilityExploitabilityMetricAttackVectorV31QueryOperator - subtype_model: AppSecopsFixAvailableQueryOperator subtype_name: AppSecopsFixAvailableQueryOperator - subtype_model: AppSecopsVulnerabilityExploitabilityMetricAttackComplexityV31QueryOperator subtype_name: AppSecopsVulnerabilityExploitabilityMetricAttackComplexityV31QueryOperator - subtype_model: AppSecopsVulnerabilityExploitabilityMetricPrivilegesRequiredV31QueryOperator subtype_name: AppSecopsVulnerabilityExploitabilityMetricPrivilegesRequiredV31QueryOperator - subtype_model: AppSecopsVulnerabilityExploitabilityMetricScopeV31QueryOperator subtype_name: AppSecopsVulnerabilityExploitabilityMetricScopeV31QueryOperator - subtype_model: AppSecopsVulnerabilityExploitabilityUserInteractionV31QueryOperator subtype_name: AppSecopsVulnerabilityExploitabilityUserInteractionV31QueryOperator - subtype_model: AppSecopsVulnerabilityImpactMetricConfidentialityImpactV31QueryOperator subtype_name: AppSecopsVulnerabilityImpactMetricConfidentialityImpactV31QueryOperator - subtype_model: AppSecopsVulnerabilityImpactMetricIntegrityImpactV31QueryOperator subtype_name: AppSecopsVulnerabilityImpactMetricIntegrityImpactV31QueryOperator - subtype_model: AppSecopsVulnerabilityImpactMetricAvailabilityImpactV31QueryOperator subtype_name: AppSecopsVulnerabilityImpactMetricAvailabilityImpactV31QueryOperator - subtype_model: AppSecopsContainerFindingsSBOMVersionIdsQueryOperator subtype_name: AppSecopsContainerFindingsSBOMVersionIdsQueryOperator - subtype_model: AppSecopsContainerFindingsCategoryQueryOperator subtype_name: AppSecopsContainerFindingsCategoryQueryOperator - subtype_model: AppSecopsContainerFindingsExecutionPhaseQueryOperator subtype_name: AppSecopsContainerFindingsExecutionPhaseQueryOperator - subtype_model: AppSecopsContainerFindingsSeverityQueryOperator subtype_name: AppSecopsContainerFindingsSeverityQueryOperator - subtype_model: AppSecopsContainerFindingsStatusQueryOperator subtype_name: AppSecopsContainerFindingsStatusQueryOperator - subtype_model: DimensionSourceQueryOperator subtype_name: DimensionSourceQueryOperator - subtype_model: DimensionQueryOperator subtype_name: DimensionQueryOperator - subtype_model: ResourceTypeQueryOperator subtype_name: ResourceTypeQueryOperator - subtype_model: PodIdRegexQueryOperator subtype_name: PodIdRegexQueryOperator - subtype_model: PodNameRegexQueryOperator subtype_name: PodNameRegexQueryOperator - subtype_model: ContainerIdRegexQueryOperator subtype_name: ContainerIdRegexQueryOperator - subtype_model: PodNamesQueryOperator subtype_name: PodNamesQueryOperator - subtype_model: PodIdsQueryOperator subtype_name: PodIdsQueryOperator - subtype_model: UtilizationTypeQueryOperator subtype_name: UtilizationTypeQueryOperator - subtype_model: ResourceIdRegexQueryOperator subtype_name: ResourceIdRegexQueryOperator - subtype_model: ResourceNameRegexQueryOperator subtype_name: ResourceNameRegexQueryOperator - subtype_model: ExtrasValueRegexQueryOperator subtype_name: ExtrasValueRegexQueryOperator - subtype_model: TagKeyValueRegexQueryOperator subtype_name: TagKeyValueRegexQueryOperator - subtype_model: ResourceQueryTagKeyKind subtype_name: ResourceQueryTagKeyKind - subtype_model: ResourceQueryTagKeyValuesKind subtype_name: ResourceQueryTagKeyValuesKind - subtype_model: TagKeyStringValueRegexQueryOperator subtype_name: TagKeyStringValueRegexQueryOperator - subtype_model: TagKindStringKeyRegexQueryOperator subtype_name: TagKindStringKeyRegexQueryOperator - subtype_model: ServiceAccountNameRegexQueryOperator subtype_name: ServiceAccountNameRegexQueryOperator - subtype_model: TenantNameRegexQueryOperator subtype_name: TenantNameRegexQueryOperator - subtype_model: PlatFormAccountQueryOperator subtype_name: PlatFormAccountQueryOperator - subtype_model: BillingLineItemTypeQueryOperator subtype_name: BillingLineItemTypeQueryOperator - subtype_model: BillingEntityQueryOperator subtype_name: BillingEntityQueryOperator - subtype_model: LineItemDescriptionQueryOperator subtype_name: LineItemDescriptionQueryOperator - subtype_model: LineItemDescriptionRegexQueryOperator subtype_name: LineItemDescriptionRegexQueryOperator - subtype_model: MeterSubCategoryQueryOperator subtype_name: MeterSubCategoryQueryOperator - subtype_model: PricingCategoryQueryOperator subtype_name: PricingCategoryQueryOperator - subtype_model: PricingPurchaseOptionQueryOperator subtype_name: PricingPurchaseOptionQueryOperator - subtype_model: TagKeyRegexQueryOperator subtype_name: TagKeyRegexQueryOperator - subtype_model: BillingLineItemTypeRegexQueryOperator subtype_name: BillingLineItemTypeRegexQueryOperator - subtype_model: ResourceGroupRegexQueryOperator subtype_name: ResourceGroupRegexQueryOperator - subtype_model: ResourceCategoryRegexQueryOperator subtype_name: ResourceCategoryRegexQueryOperator - subtype_model: ProductCategoryRegexQueryOperator subtype_name: ProductCategoryRegexQueryOperator - subtype_model: BillingEntityRegexQueryOperator subtype_name: BillingEntityRegexQueryOperator - subtype_model: ResourceOperationRegexQueryOperator subtype_name: ResourceOperationRegexQueryOperator - subtype_model: ResourceQueryFieldPresence subtype_name: ResourceQueryFieldPresence - subtype_model: AssessmentRunReportDetailQuerySection subtype_name: AssessmentRunReportDetailQuerySection - subtype_model: AssessmentRunReportSummaryQuerySection subtype_name: AssessmentRunReportSummaryQuerySection - subtype_model: AssessmentQueryAssessmentName subtype_name: AssessmentQueryAssessmentName - subtype_model: AssessmentQueryAssessmentOwner subtype_name: AssessmentQueryAssessmentOwner - subtype_model: AssessmentQueryAssessmentApprover subtype_name: AssessmentQueryAssessmentApprover - subtype_model: AssessmentQueryWorkload subtype_name: AssessmentQueryWorkload - subtype_model: AssessmentQueryFramework subtype_name: AssessmentQueryFramework - subtype_model: AssessmentQueryPillar subtype_name: AssessmentQueryPillar - subtype_model: AssessmentViewQueryNature subtype_name: AssessmentViewQueryNature - subtype_model: AssessmentViewQueryQuestionRisk subtype_name: AssessmentViewQueryQuestionRisk - subtype_model: AssessmentViewQueryBestPracticeRisk subtype_name: AssessmentViewQueryBestPracticeRisk - subtype_model: AssessmentViewQueryQuestionStatus subtype_name: AssessmentViewQueryQuestionStatus - subtype_model: AssessmentViewQueryBestPracticeStatus subtype_name: AssessmentViewQueryBestPracticeStatus - subtype_model: AssessmentViewQueryOwner subtype_name: AssessmentViewQueryOwner - subtype_model: AssessmentViewQueryAssignedTo subtype_name: AssessmentViewQueryAssignedTo - subtype_model: AssessmentViewQueryComment subtype_name: AssessmentViewQueryComment - subtype_model: AssessmentReportQueryAssessmentName subtype_name: AssessmentReportQueryAssessmentName - subtype_model: AssessmentReportQueryFramework subtype_name: AssessmentReportQueryFramework - subtype_model: AssessmentReportQueryReportType subtype_name: AssessmentReportQueryReportType - subtype_model: AssessmentReportQueryWorkloadId subtype_name: AssessmentReportQueryWorkloadId - subtype_model: ScheduleQueryName subtype_name: ScheduleQueryName - subtype_model: ScheduleQueryCreatedBy subtype_name: ScheduleQueryCreatedBy - subtype_model: ScheduleQueryEmailRecipients subtype_name: ScheduleQueryEmailRecipients - subtype_model: ScheduleQueryRecurrence subtype_name: ScheduleQueryRecurrence - subtype_model: ScheduleQueryReportType subtype_name: ScheduleQueryReportType - subtype_model: ScheduleQueryNextGenReportType subtype_name: ScheduleQueryNextGenReportType - subtype_model: ScheduleQueryAssessmentAgentReportType subtype_name: ScheduleQueryAssessmentAgentReportType - subtype_model: AutomationTemplateQueryEngineType subtype_name: AutomationTemplateQueryEngineType - subtype_model: AutomationTemplateQueryRepoType subtype_name: AutomationTemplateQueryRepoType - subtype_model: AutomationTemplateQueryService subtype_name: AutomationTemplateQueryService - subtype_model: AutomationTemplateQueryTenant subtype_name: AutomationTemplateQueryTenant - subtype_model: AwsSecurityHubFindingQueryLocation subtype_name: AwsSecurityHubFindingQueryLocation - subtype_model: AwsSecurityHubFindingQuerySeverity subtype_name: AwsSecurityHubFindingQuerySeverity - subtype_model: AwsSecurityHubFindingQueryProductName subtype_name: AwsSecurityHubFindingQueryProductName - subtype_model: AwsSecurityHubFindingQueryResource subtype_name: AwsSecurityHubFindingQueryResource - subtype_model: AwsSecurityHubFindingQueryCloudAccount subtype_name: AwsSecurityHubFindingQueryCloudAccount - subtype_model: AwsSecurityHubFindingQueryRecordState subtype_name: AwsSecurityHubFindingQueryRecordState - subtype_model: AwsSsmDocumentQueryCloudAccount subtype_name: AwsSsmDocumentQueryCloudAccount - subtype_model: AwsSsmDocumentQueryRegion subtype_name: AwsSsmDocumentQueryRegion - subtype_model: AwsSsmDocumentQueryOwner subtype_name: AwsSsmDocumentQueryOwner - subtype_model: AwsSsmDocumentQueryCategory subtype_name: AwsSsmDocumentQueryCategory - subtype_model: AwsSsmDocumentQueryStatus subtype_name: AwsSsmDocumentQueryStatus - subtype_model: AwsSsmDocumentQueryName subtype_name: AwsSsmDocumentQueryName - subtype_model: AwsSsmDocumentQueryExecutedBy subtype_name: AwsSsmDocumentQueryExecutedBy - subtype_model: ComplianceURIQueryOperator subtype_name: ComplianceURIQueryOperator - subtype_model: DurationInMonthsQueryOperator subtype_name: DurationInMonthsQueryOperator - subtype_model: UniqueIdQueryOperator subtype_name: UniqueIdQueryOperator - subtype_model: ThreatVulnerabilityStatusQueryOperator subtype_name: ThreatVulnerabilityStatusQueryOperator - subtype_model: ThreatVulnerabilitySeverityQueryOperator subtype_name: ThreatVulnerabilitySeverityQueryOperator - subtype_model: ThreatVulnerabilityIssueTypeQueryOperator subtype_name: ThreatVulnerabilityIssueTypeQueryOperator - subtype_model: ThreatIntentQueryOperator subtype_name: ThreatIntentQueryOperator - subtype_model: VulnerabilityReferenceIdQueryOperator subtype_name: VulnerabilityReferenceIdQueryOperator - subtype_model: CostAnomalyStatusQueryOperator subtype_name: CostAnomalyStatusQueryOperator - subtype_model: CurrencyExchangeConfigurationQuerySourceCurrency subtype_name: CurrencyExchangeConfigurationQuerySourceCurrency - subtype_model: CurrencyExchangeConfigurationQueryTargetCurrency subtype_name: CurrencyExchangeConfigurationQueryTargetCurrency - subtype_model: CurrencyExchangeConfigurationQueryScope subtype_name: CurrencyExchangeConfigurationQueryScope - subtype_model: MetricValuesOperator subtype_name: MetricValuesOperator - subtype_model: PatchReadinessStatusQueryOperator subtype_name: PatchReadinessStatusQueryOperator - subtype_model: MasterAccountBillingQueryMasterAccounts subtype_name: MasterAccountBillingQueryMasterAccounts - subtype_model: MasterAccountBillingQueryTenants subtype_name: MasterAccountBillingQueryTenants - subtype_model: MasterAccountBillingQueryUsers subtype_name: MasterAccountBillingQueryUsers - subtype_model: MasterAccountBillingQueryConversations subtype_name: MasterAccountBillingQueryConversations - subtype_model: MasterAccountBillingQueryTransactionType subtype_name: MasterAccountBillingQueryTransactionType - subtype_model: PolicyResourceRecommendationStatusQueryOperator subtype_name: PolicyResourceRecommendationStatusQueryOperator - subtype_model: PolicyResourceRecommendationPolicyIdsQueryOperator subtype_name: PolicyResourceRecommendationPolicyIdsQueryOperator - subtype_model: PolicyResourceRecommendationSeverityQueryOperator subtype_name: PolicyResourceRecommendationSeverityQueryOperator - subtype_model: PolicyRecommendationClassificationQueryOperator subtype_name: PolicyRecommendationClassificationQueryOperator - subtype_model: InfraResourceTrendResourceChangeStatusQueryOperator subtype_name: InfraResourceTrendResourceChangeStatusQueryOperator - subtype_model: VmAgentsQueryOsTypes subtype_name: VmAgentsQueryOsTypes - subtype_model: VmAgentsQueryInstantState subtype_name: VmAgentsQueryInstantState - subtype_model: VmAgentsQueryQualysStatus subtype_name: VmAgentsQueryQualysStatus - subtype_model: VmAgentsQueryCrowdStrikeStatus subtype_name: VmAgentsQueryCrowdStrikeStatus - subtype_model: VmAgentsQuerySplunkStatus subtype_name: VmAgentsQuerySplunkStatus - subtype_model: StacksMarketplaceStackQueryArchived subtype_name: StacksMarketplaceStackQueryArchived - subtype_model: StacksMarketplaceStackQueryAutoApproved subtype_name: StacksMarketplaceStackQueryAutoApproved - subtype_model: StacksMarketplaceStackQueryOwner subtype_name: StacksMarketplaceStackQueryOwner - subtype_model: StacksMarketplaceStackQueryName subtype_name: StacksMarketplaceStackQueryName - subtype_model: StacksMarketplaceStackQueryProduct subtype_name: StacksMarketplaceStackQueryProduct - subtype_model: StacksMarketplaceDeploymentQueryName subtype_name: StacksMarketplaceDeploymentQueryName - subtype_model: StacksMarketplaceDeploymentQueryStack subtype_name: StacksMarketplaceDeploymentQueryStack - subtype_model: StacksMarketplaceDeploymentQueryAccount subtype_name: StacksMarketplaceDeploymentQueryAccount - subtype_model: StacksMarketplaceDeploymentQueryRegion subtype_name: StacksMarketplaceDeploymentQueryRegion - subtype_model: StacksMarketplaceStackDeploymentQueryExecutionStatus subtype_name: StacksMarketplaceStackDeploymentQueryExecutionStatus - subtype_model: MetricNameQueryOperator subtype_name: MetricNameQueryOperator - subtype_model: ResourceQueryCategory subtype_name: ResourceQueryCategory - subtype_model: ResourceQueryLocation subtype_name: ResourceQueryLocation - subtype_model: ResourceQueryResource subtype_name: ResourceQueryResource - subtype_model: ResourceQueryResourceGroup subtype_name: ResourceQueryResourceGroup - subtype_model: ResourceQueryResourceName subtype_name: ResourceQueryResourceName - subtype_model: ResourceQueryResourceType subtype_name: ResourceQueryResourceType - subtype_model: ResourceQueryTagPresence subtype_name: ResourceQueryTagPresence - subtype_model: ResourceQueryTagKey subtype_name: ResourceQueryTagKey - subtype_model: ResourceQueryTagKeyValue subtype_name: ResourceQueryTagKeyValue - subtype_model: WorkloadQueryWorkloadName subtype_name: WorkloadQueryWorkloadName - subtype_model: WorkloadQueryWorkloadOwner subtype_name: WorkloadQueryWorkloadOwner - subtype_model: WorkloadQueryCloud subtype_name: WorkloadQueryCloud - subtype_model: WorkloadQueryCloudAccount subtype_name: WorkloadQueryCloudAccount - subtype_model: WorkloadQueryWorkloadType subtype_name: WorkloadQueryWorkloadType - subtype_model: WorkloadQueryWorkloadId subtype_name: WorkloadQueryWorkloadId ServiceAccountPlatformKeyValues: properties: service_account_id: type: string description: Service Account ID x-cs-type: ObjectId values_by_key: type: array description: List of platform tag key/value pairs for an account items: $ref: '#/components/schemas/PlatformKeyValues' type: object BillingSummaryBase: properties: service_account_ids: type: array description: Service Account IDs items: type: string x-cs-type: ObjectId descendant_service_account_query: description: Descendant service account query filter $ref: '#/components/schemas/DescendantServiceAccountQuery' for_platform: type: boolean description: If set, redirect the query to billing platform line items summary collection skip_service_account_grouping: type: boolean description: If set, do not group by service account type: object BillingAggregationTrendRequest: allOf: - $ref: '#/components/schemas/BillingAggregationRequest' - required: - granularity properties: granularity: type: integer description: Number of seconds between steps compute_forecast: type: boolean description: If set, results for future dates will be computed based on a forecast. type: object DescendantServiceAccountQuery: required: - service_account_ids properties: service_account_ids: type: array description: Service account IDs that belong to the ancestors of matching accounts. items: type: string x-cs-type: ObjectId include_self: type: boolean description: Include the given service accounts in the result set include_billing_as_parent: type: boolean description: Also include accounts whose billing_account_id matches any of the given accounts. include_resource_as_parent: type: boolean description: Also include accounts whose resource_service_account_id matches any of the given accounts. include_commercial_as_parent: type: boolean description: Also include AWS GovCloud accounts whose commercial_account_id matches any of the given accounts. exclude_service_account_ids: type: array description: Service account IDs to excluded with descendants. items: type: string x-cs-type: ObjectId type: object DimensionMembershipKeyValuePair: required: - dimension_id - grouping_rule_id properties: dimension_id: type: string description: Dimension ID grouping_rule_id: type: string description: Grouping Rule ID type: object BillingLineItemIdentity: properties: service_account_id: type: string description: Service Account the line item belongs to x-cs-type: ObjectId delegate_service_account_id: type: string description: Service Account internally responsible for creating, updating, or deleting the line item x-cs-type: ObjectId line_item_type: type: string description: Line item type availability_zone: type: string description: Availability Zone billing_entity: type: string description: Billing Entity currency: type: string description: currency of the cost. Example 'currency':'USD' example: AED enum: - AED - ALL - ARS - AUD - BAM - BDT - BGN - BHD - BRL - CAD - CHF - CLP - CNY - COP - CRC - CZK - DKK - EGP - EUR - GBP - HKD - HRK - HUF - IDR - ILS - INR - ISK - JPY - KES - KRW - KWD - KZT - MOP - MVR - MXN - MYR - NOK - NZD - OMR - PEN - PHP - PKR - PLN - QAR - RON - RSD - RUB - SAR - SEK - SGD - THB - TRY - TWD - USD - VND - ZAR x-cs-enum-type: Currency location: type: string description: Line item location meter_sub_category: type: string description: Meter Sub Category pricing_category: type: string description: Pricing Category pricing_purchase_option: type: string description: Pricing Purchase Option product_category: type: string description: Product category product_family: type: string description: Product family product_service_code: type: string description: Product service code product_sku: type: string description: Product SKU publisher: type: string description: Publisher resource_category: type: string description: Resource category resource_group: type: string description: Resource group resource_id: type: string description: Resource ID resource_name: type: string description: Resource name resource_operation: type: string description: Resource operation resource_type: type: string description: Resource type utilization_type: type: string description: Utilization type extras: type: array description: List of tag key/value pairs items: $ref: '#/components/schemas/KeyValuePair' tags: type: array description: List of tag key/value pairs items: $ref: '#/components/schemas/KeyValuePair' hierarchy: type: array description: List of tag key/value pairs items: $ref: '#/components/schemas/KeyValuePair' custom: type: array description: List of tag key/value pairs items: $ref: '#/components/schemas/KeyValuePair' dimension_memberships: type: array description: List of Dimension Membership Key-Value Pairs items: $ref: '#/components/schemas/DimensionMembershipKeyValuePair' compartment_id: type: string description: Compartment ID compartment_name: type: string description: Compartment Name type: object BillingTagKeysRequest: allOf: - $ref: '#/components/schemas/BillingSummaryBase' - properties: tag_keys: type: array description: If set, the subset of keys to return items: type: string include_values: type: boolean description: If set, include values, not just keys type: object BillingAggregationResult: properties: identity: description: Identity of the result group $ref: '#/components/schemas/BillingLineItemIdentityPlus' value: type: number description: Result of aggregation type: object BillingCustomGroup: properties: attribute_value: type: string description: Value for the group attribute_key: type: string description: Key for the group filter: description: Filter for the custom group $ref: '#/components/schemas/QueryOperator' grouping_rule_id: type: string description: Grouping Rule ID dimension_id: type: string description: Dimension ID type: object BillingLineItemIdentityPlus: allOf: - $ref: '#/components/schemas/BillingLineItemIdentity' - properties: service_name: type: string description: Service name tenant_id: type: string description: Tenant ID type: object BillingCostAndUsageAggregationTrendResult: allOf: - $ref: '#/components/schemas/BillingAggregationTrendResult' - properties: rates: type: array items: type: number description: Rate Results of aggregation usages: type: array items: type: number description: Usage Results of aggregation descriptions: type: array items: type: string description: Descriptions of line items type: object KeyValues: properties: key: type: string description: Key of the pair values: type: array description: Values of the key items: type: string type: object securitySchemes: auth_token: type: apiKey in: header name: X-Auth-Token