+You can use the Billing API to programatically list the billing views available to you for a given time period. A billing view represents a set of billing data. +
+The Billing API provides the following endpoint:
+
+https://billing.us-east-1.api.aws
+
+ * You can use the Billing API to programatically list the billing views available to you for a given time period. A billing view represents a set of billing data. + *
+ *The Billing API provides the following endpoint:
+ *
+ * https://billing.us-east-1.api.aws
+ *
+ * You can use the Billing API to programatically list the billing views available to you for a given time period. A billing view represents a set of billing data. + *
+ *The Billing API provides the following endpoint:
+ *
+ * https://billing.us-east-1.api.aws
+ *
Lists the billing views available for a given time period. + *
+ *Every Amazon Web Services account has a unique PRIMARY billing view that represents the billing data available by default. Accounts that use Billing Conductor also have BILLING_GROUP billing views representing pro forma costs associated with each created billing group.
You don't have sufficient access to perform this action.
+ * + * @throws {@link InternalServerException} (server fault) + *The request processing failed because of an unknown error, exception, or failure. + *
+ * + * @throws {@link ThrottlingException} (client fault) + *The request was denied due to request throttling. + *
+ * + * @throws {@link ValidationException} (client fault) + *The input fails to satisfy the constraints specified by an Amazon Web Services service. + *
+ * + * @throws {@link BillingServiceException} + *Base exception class for all service exceptions from Billing service.
+ * + * @public + * @example Invoke ListBillingViews + * ```javascript + * // + * const input = { + * "activeTimeRange": { + * "activeAfterInclusive": 1719792000, + * "activeBeforeInclusive": 1722470399.999 + * } + * }; + * const command = new ListBillingViewsCommand(input); + * const response = await client.send(command); + * /* response == + * { + * "billingViews": [ + * { + * "name": "Primary Billing View Account 123456789101", + * "arn": "arn:aws:billing::123456789101:billingview/primary", + * "billingViewType": "PRIMARY", + * "ownerAccountId": "123456789101" + * } + * ] + * } + * *\/ + * // example id: example-1 + * ``` + * + * @example Error example for ListBillingViews + * ```javascript + * // + * const input = { + * "activeTimeRange": { + * "activeAfterInclusive": 1719792001, + * "activeBeforeInclusive": 1719792000 + * } + * }; + * const command = new ListBillingViewsCommand(input); + * await client.send(command); + * // example id: example-2 + * ``` + * + */ +export class ListBillingViewsCommand extends $Command + .classBuilder< + ListBillingViewsCommandInput, + ListBillingViewsCommandOutput, + BillingClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: BillingClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("AWSBilling", "ListBillingViews", {}) + .n("BillingClient", "ListBillingViewsCommand") + .f(void 0, ListBillingViewsResponseFilterSensitiveLog) + .ser(se_ListBillingViewsCommand) + .de(de_ListBillingViewsCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: ListBillingViewsRequest; + output: ListBillingViewsResponse; + }; + sdk: { + input: ListBillingViewsCommandInput; + output: ListBillingViewsCommandOutput; + }; + }; +} diff --git a/clients/client-billing/src/commands/index.ts b/clients/client-billing/src/commands/index.ts new file mode 100644 index 000000000000..853515c0fc64 --- /dev/null +++ b/clients/client-billing/src/commands/index.ts @@ -0,0 +1,2 @@ +// smithy-typescript generated code +export * from "./ListBillingViewsCommand"; diff --git a/clients/client-billing/src/endpoint/EndpointParameters.ts b/clients/client-billing/src/endpoint/EndpointParameters.ts new file mode 100644 index 000000000000..b7b7b1be8bd6 --- /dev/null +++ b/clients/client-billing/src/endpoint/EndpointParameters.ts @@ -0,0 +1,37 @@ +// smithy-typescript generated code +import { Endpoint, EndpointParameters as __EndpointParameters, EndpointV2, Provider } from "@smithy/types"; + +/** + * @public + */ +export interface ClientInputEndpointParameters { + useFipsEndpoint?: boolean | Provider+ * You can use the Billing API to programatically list the billing views available to you for a given time period. A billing view represents a set of billing data. + *
+ *The Billing API provides the following endpoint:
+ *
+ * https://billing.us-east-1.api.aws
+ *
You don't have sufficient access to perform this action.
+ * @public + */ +export class AccessDeniedException extends __BaseException { + readonly name: "AccessDeniedException" = "AccessDeniedException"; + readonly $fault: "client" = "client"; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeA time range with a start and end time.
+ * @public + */ +export interface ActiveTimeRange { + /** + *The inclusive time range start date.
+ * @public + */ + activeAfterInclusive: Date | undefined; + + /** + *+ * The inclusive time range end date. + *
+ * @public + */ + activeBeforeInclusive: Date | undefined; +} + +/** + *The request processing failed because of an unknown error, exception, or failure. + *
+ * @public + */ +export class InternalServerException extends __BaseException { + readonly name: "InternalServerException" = "InternalServerException"; + readonly $fault: "server" = "server"; + /** + * @internal + */ + constructor(opts: __ExceptionOptionType
+ * The time range for the billing views listed. PRIMARY billing view is always listed. BILLING_GROUP billing views are listed for time ranges when the associated billing group resource in Billing Conductor is active. The time range must be within one calendar month.
+ *
The maximum number of billing views to retrieve. Default is 100. + *
+ * @public + */ + maxResults?: number | undefined; + + /** + *The pagination token that is used on subsequent calls to list billing views.
+ * @public + */ + nextToken?: string | undefined; +} + +/** + * @public + * @enum + */ +export const BillingViewType = { + BILLING_GROUP: "BILLING_GROUP", + PRIMARY: "PRIMARY", +} as const; + +/** + * @public + */ +export type BillingViewType = (typeof BillingViewType)[keyof typeof BillingViewType]; + +/** + *A representation of a billing view.
+ * @public + */ +export interface BillingViewListElement { + /** + *The Amazon Resource Name (ARN) that can be used to uniquely identify the billing view. + *
+ * @public + */ + arn?: string | undefined; + + /** + *+ * A list of names of the Billing view. + *
+ * @public + */ + name?: string | undefined; + + /** + *+ * The list of owners of the Billing view. + *
+ * @public + */ + ownerAccountId?: string | undefined; + + /** + *The type of billing view.
+ * @public + */ + billingViewType?: BillingViewType | undefined; +} + +/** + * @public + */ +export interface ListBillingViewsResponse { + /** + *A list of BillingViewListElement retrieved.
The pagination token to use on subsequent calls to list billing views. + *
+ * @public + */ + nextToken?: string | undefined; +} + +/** + *The request was denied due to request throttling. + *
+ * @public + */ +export class ThrottlingException extends __BaseException { + readonly name: "ThrottlingException" = "ThrottlingException"; + readonly $fault: "client" = "client"; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeThe field's information of a request that resulted in an exception. + *
+ * @public + */ +export interface ValidationExceptionField { + /** + *The name of the field.
+ * @public + */ + name: string | undefined; + + /** + *The message describing why the field failed validation.
+ * @public + */ + message: string | undefined; +} + +/** + * @public + * @enum + */ +export const ValidationExceptionReason = { + CANNOT_PARSE: "cannotParse", + FIELD_VALIDATION_FAILED: "fieldValidationFailed", + OTHER: "other", + UNKNOWN_OPERATION: "unknownOperation", +} as const; + +/** + * @public + */ +export type ValidationExceptionReason = (typeof ValidationExceptionReason)[keyof typeof ValidationExceptionReason]; + +/** + *The input fails to satisfy the constraints specified by an Amazon Web Services service. + *
+ * @public + */ +export class ValidationException extends __BaseException { + readonly name: "ValidationException" = "ValidationException"; + readonly $fault: "client" = "client"; + /** + *The input fails to satisfy the constraints specified by an Amazon Web Services service.
+ * @public + */ + reason: ValidationExceptionReason | undefined; + + /** + *The input fails to satisfy the constraints specified by an Amazon Web Services service.
+ * @public + */ + fieldList?: ValidationExceptionField[] | undefined; + + /** + * @internal + */ + constructor(opts: __ExceptionOptionType\n You can use the Billing API to programatically list the billing views available to you for a given time period. A billing view represents a set of billing data.\n
\nThe Billing API provides the following endpoint:
\n\n https://billing.us-east-1.api.aws\n
You don't have sufficient access to perform this action.
", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.billing#AccountId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[0-9]{12}$" + } + }, + "com.amazonaws.billing#ActiveTimeRange": { + "type": "structure", + "members": { + "activeAfterInclusive": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The inclusive time range start date.
", + "smithy.api#required": {} + } + }, + "activeBeforeInclusive": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "\n The inclusive time range end date.\n
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A time range with a start and end time.
" + } + }, + "com.amazonaws.billing#BillingViewArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:aws[a-z-]*:(billing)::[0-9]{12}:billingview/[a-zA-Z0-9_\\+=\\.\\-@]{1,43}$" + } + }, + "com.amazonaws.billing#BillingViewList": { + "type": "list", + "member": { + "target": "com.amazonaws.billing#BillingViewListElement" + } + }, + "com.amazonaws.billing#BillingViewListElement": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.billing#BillingViewArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) that can be used to uniquely identify the billing view.\n
" + } + }, + "name": { + "target": "com.amazonaws.billing#BillingViewName", + "traits": { + "smithy.api#documentation": "\n A list of names of the Billing view.\n
" + } + }, + "ownerAccountId": { + "target": "com.amazonaws.billing#AccountId", + "traits": { + "smithy.api#documentation": "\n The list of owners of the Billing view.\n
" + } + }, + "billingViewType": { + "target": "com.amazonaws.billing#BillingViewType", + "traits": { + "smithy.api#documentation": "The type of billing view.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A representation of a billing view.
" + } + }, + "com.amazonaws.billing#BillingViewName": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[ a-zA-Z0-9_\\+=\\.\\-@]+$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.billing#BillingViewType": { + "type": "enum", + "members": { + "PRIMARY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PRIMARY" + } + }, + "BILLING_GROUP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BILLING_GROUP" + } + } + } + }, + "com.amazonaws.billing#BillingViewsMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.billing#ErrorMessage": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 1024 + } + } + }, + "com.amazonaws.billing#FieldName": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 100 + } + } + }, + "com.amazonaws.billing#InternalServerException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.billing#ErrorMessage", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "BillingInternalServer", + "httpResponseCode": 500 + }, + "smithy.api#documentation": "The request processing failed because of an unknown error, exception, or failure.\n
", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.billing#ListBillingViews": { + "type": "operation", + "input": { + "target": "com.amazonaws.billing#ListBillingViewsRequest" + }, + "output": { + "target": "com.amazonaws.billing#ListBillingViewsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.billing#AccessDeniedException" + }, + { + "target": "com.amazonaws.billing#InternalServerException" + }, + { + "target": "com.amazonaws.billing#ThrottlingException" + }, + { + "target": "com.amazonaws.billing#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists the billing views available for a given time period.\n
\nEvery Amazon Web Services account has a unique PRIMARY billing view that represents the billing data available by default. Accounts that use Billing Conductor also have BILLING_GROUP billing views representing pro forma costs associated with each created billing group.
\n The time range for the billing views listed. PRIMARY billing view is always listed. BILLING_GROUP billing views are listed for time ranges when the associated billing group resource in Billing Conductor is active. The time range must be within one calendar month.\n
The maximum number of billing views to retrieve. Default is 100.\n
" + } + }, + "nextToken": { + "target": "com.amazonaws.billing#PageToken", + "traits": { + "smithy.api#documentation": "The pagination token that is used on subsequent calls to list billing views.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.billing#ListBillingViewsResponse": { + "type": "structure", + "members": { + "billingViews": { + "target": "com.amazonaws.billing#BillingViewList", + "traits": { + "smithy.api#documentation": "A list of BillingViewListElement retrieved.
The pagination token to use on subsequent calls to list billing views.\n
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.billing#PageToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2047 + } + } + }, + "com.amazonaws.billing#ThrottlingException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.billing#ErrorMessage", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "BillingThrottling", + "httpResponseCode": 429 + }, + "smithy.api#documentation": "The request was denied due to request throttling.\n
", + "smithy.api#error": "client", + "smithy.api#httpError": 429 + } + }, + "com.amazonaws.billing#ValidationException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.billing#ErrorMessage", + "traits": { + "smithy.api#required": {} + } + }, + "reason": { + "target": "com.amazonaws.billing#ValidationExceptionReason", + "traits": { + "smithy.api#documentation": "The input fails to satisfy the constraints specified by an Amazon Web Services service.
", + "smithy.api#required": {} + } + }, + "fieldList": { + "target": "com.amazonaws.billing#ValidationExceptionFieldList", + "traits": { + "smithy.api#documentation": "The input fails to satisfy the constraints specified by an Amazon Web Services service.
" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "BillingValidation", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "The input fails to satisfy the constraints specified by an Amazon Web Services service.\n
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.billing#ValidationExceptionField": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.billing#FieldName", + "traits": { + "smithy.api#documentation": "The name of the field.
", + "smithy.api#required": {} + } + }, + "message": { + "target": "com.amazonaws.billing#ErrorMessage", + "traits": { + "smithy.api#documentation": "The message describing why the field failed validation.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The field's information of a request that resulted in an exception.\n
" + } + }, + "com.amazonaws.billing#ValidationExceptionFieldList": { + "type": "list", + "member": { + "target": "com.amazonaws.billing#ValidationExceptionField" + } + }, + "com.amazonaws.billing#ValidationExceptionReason": { + "type": "enum", + "members": { + "UNKNOWN_OPERATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "unknownOperation" + } + }, + "CANNOT_PARSE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "cannotParse" + } + }, + "FIELD_VALIDATION_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "fieldValidationFailed" + } + }, + "OTHER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "other" + } + } + } + } + } +}