@aws-sdk/client-bcm-data-exports 3.533.0 → 3.540.0

package/dist-types/models/models_0.d.ts

@@ -1,18 +1,18 @@
 import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
 import { BCMDataExportsServiceException as __BaseException } from "./BCMDataExportsServiceException";
 /**
- * @public
  * <p>The SQL query of column selections and row filters from the data table you want.</p>
+ * @public
  */
 export interface DataQuery {
     /**
-     * @public
      * <p>The query statement.</p>
+     * @public
      */
     QueryStatement: string | undefined;
     /**
-     * @public
      * <p>The table configuration.</p>
+     * @public
      */
     TableConfigurations?: Record<string, Record<string, string>>;
 }
@@ -64,69 +64,69 @@ export declare const OverwriteOption: {
  */
 export type OverwriteOption = (typeof OverwriteOption)[keyof typeof OverwriteOption];
 /**
- * @public
  * <p>The compression type, file format, and overwrite preference for the data export.</p>
+ * @public
  */
 export interface S3OutputConfigurations {
     /**
-     * @public
      * <p>The output type for the data export.</p>
+     * @public
      */
     OutputType: S3OutputType | undefined;
     /**
-     * @public
      * <p>The file format for the data export.</p>
+     * @public
      */
     Format: FormatOption | undefined;
     /**
-     * @public
      * <p>The compression type for the data export.</p>
+     * @public
      */
     Compression: CompressionOption | undefined;
     /**
-     * @public
      * <p>The rule to follow when generating a version of the data export file. You have the choice
      *       to overwrite the previous version or to be delivered in addition to the previous versions.
      *       Overwriting exports can save on Amazon S3 storage costs. Creating new export versions allows
      *       you to track the changes in cost and usage data over time.</p>
+     * @public
      */
     Overwrite: OverwriteOption | undefined;
 }
 /**
- * @public
  * <p>Describes the destination Amazon Simple Storage Service (Amazon S3) bucket name and object
  *       keys of a data exports file.</p>
+ * @public
  */
 export interface S3Destination {
     /**
-     * @public
      * <p>The name of the Amazon S3 bucket used as the destination of a data export file.</p>
+     * @public
      */
     S3Bucket: string | undefined;
     /**
-     * @public
      * <p>The S3 path prefix you want prepended to the name of your data export.</p>
+     * @public
      */
     S3Prefix: string | undefined;
     /**
-     * @public
      * <p>The S3 bucket Region.</p>
+     * @public
      */
     S3Region: string | undefined;
     /**
-     * @public
      * <p>The output configuration for the data export.</p>
+     * @public
      */
     S3OutputConfigurations: S3OutputConfigurations | undefined;
 }
 /**
- * @public
  * <p>The destinations used for data exports.</p>
+ * @public
  */
 export interface DestinationConfigurations {
     /**
-     * @public
      * <p>An object that describes the destination of the data exports file.</p>
+     * @public
      */
     S3Destination: S3Destination | undefined;
 }
@@ -142,66 +142,66 @@ export declare const FrequencyOption: {
  */
 export type FrequencyOption = (typeof FrequencyOption)[keyof typeof FrequencyOption];
 /**
- * @public
  * <p>The cadence for Amazon Web Services to update the data export in your S3 bucket.</p>
+ * @public
  */
 export interface RefreshCadence {
     /**
-     * @public
      * <p>The frequency that data exports are updated. The export refreshes each time the source
      *       data updates, up to three times daily.</p>
+     * @public
      */
     Frequency: FrequencyOption | undefined;
 }
 /**
- * @public
  * <p>The details that are available for an export.</p>
+ * @public
  */
 export interface Export {
     /**
-     * @public
      * <p>The Amazon Resource Name (ARN) for this export.</p>
+     * @public
      */
     ExportArn?: string;
     /**
-     * @public
      * <p>The name of this specific data export.</p>
+     * @public
      */
     Name: string | undefined;
     /**
-     * @public
      * <p>The description for this specific data export.</p>
+     * @public
      */
     Description?: string;
     /**
-     * @public
      * <p>The data query for this specific data export.</p>
+     * @public
      */
     DataQuery: DataQuery | undefined;
     /**
-     * @public
      * <p>The destination configuration for this specific data export.</p>
+     * @public
      */
     DestinationConfigurations: DestinationConfigurations | undefined;
     /**
-     * @public
      * <p>The cadence for Amazon Web Services to update the export in your S3 bucket.</p>
+     * @public
      */
     RefreshCadence: RefreshCadence | undefined;
 }
 /**
- * @public
  * <p>The tag structure that contains a tag key and value.</p>
+ * @public
  */
 export interface ResourceTag {
     /**
-     * @public
      * <p>The key that's associated with the tag.</p>
+     * @public
      */
     Key: string | undefined;
     /**
-     * @public
      * <p>The value that's associated with the tag.</p>
+     * @public
      */
     Value: string | undefined;
 }
@@ -210,15 +210,15 @@ export interface ResourceTag {
  */
 export interface CreateExportRequest {
     /**
-     * @public
      * <p>The details of the export, including data query, name, description, and destination
      *       configuration.</p>
+     * @public
      */
     Export: Export | undefined;
     /**
-     * @public
      * <p>An optional list of tags to associate with the specified export. Each tag consists of a
      *       key and a value, and each key must be unique for the resource.</p>
+     * @public
      */
     ResourceTags?: ResourceTag[];
 }
@@ -227,15 +227,15 @@ export interface CreateExportRequest {
  */
 export interface CreateExportResponse {
     /**
-     * @public
      * <p>The Amazon Resource Name (ARN) for this export.</p>
+     * @public
      */
     ExportArn?: string;
 }
 /**
- * @public
  * <p>An error on the server occurred during the processing of your request. Try again
  *       later.</p>
+ * @public
  */
 export declare class InternalServerException extends __BaseException {
     readonly name: "InternalServerException";
@@ -247,33 +247,33 @@ export declare class InternalServerException extends __BaseException {
     constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
 }
 /**
- * @public
  * <p>You've reached the limit on the number of resources you can create, or exceeded the size
  *       of an individual resource.</p>
+ * @public
  */
 export declare class ServiceQuotaExceededException extends __BaseException {
     readonly name: "ServiceQuotaExceededException";
     readonly $fault: "client";
     Message: string | undefined;
     /**
-     * @public
      * <p>The identifier of the resource that exceeded quota.</p>
+     * @public
      */
     ResourceId?: string;
     /**
-     * @public
      * <p>The type of the resource that exceeded quota.</p>
+     * @public
      */
     ResourceType?: string;
     /**
-     * @public
      * <p>The quota code that was exceeded.</p>
+     * @public
      */
     QuotaCode: string | undefined;
     /**
-     * @public
      * <p>The service code that exceeded quota. It will always be
      *       “AWSBillingAndCostManagementDataExports”.</p>
+     * @public
      */
     ServiceCode: string | undefined;
     /**
@@ -282,22 +282,22 @@ export declare class ServiceQuotaExceededException extends __BaseException {
     constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
 }
 /**
- * @public
  * <p>The request was denied due to request throttling.</p>
+ * @public
  */
 export declare class ThrottlingException extends __BaseException {
     readonly name: "ThrottlingException";
     readonly $fault: "client";
     Message: string | undefined;
     /**
-     * @public
      * <p>The quota code that exceeded the throttling limit.</p>
+     * @public
      */
     QuotaCode?: string;
     /**
-     * @public
      * <p>The service code that exceeded the throttling limit. It will always be
      *       “AWSBillingAndCostManagementDataExports”.</p>
+     * @public
      */
     ServiceCode?: string;
     /**
@@ -306,19 +306,19 @@ export declare class ThrottlingException extends __BaseException {
     constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
 }
 /**
- * @public
  * <p>The input failed to meet the constraints specified by the Amazon Web Services service in a
  *       specified field.</p>
+ * @public
  */
 export interface ValidationExceptionField {
     /**
-     * @public
      * <p>The field name where the invalid entry was detected.</p>
+     * @public
      */
     Name: string | undefined;
     /**
-     * @public
      * <p>A message with the reason for the validation exception error.</p>
+     * @public
      */
     Message: string | undefined;
 }
@@ -337,22 +337,22 @@ export declare const ValidationExceptionReason: {
  */
 export type ValidationExceptionReason = (typeof ValidationExceptionReason)[keyof typeof ValidationExceptionReason];
 /**
- * @public
  * <p>The input fails to satisfy the constraints specified by an Amazon Web Services
  *       service.</p>
+ * @public
  */
 export declare class ValidationException extends __BaseException {
     readonly name: "ValidationException";
     readonly $fault: "client";
     Message: string | undefined;
     /**
-     * @public
      * <p>The reason for the validation exception.</p>
+     * @public
      */
     Reason?: ValidationExceptionReason;
     /**
-     * @public
      * <p>The list of fields that are invalid.</p>
+     * @public
      */
     Fields?: ValidationExceptionField[];
     /**
@@ -365,8 +365,8 @@ export declare class ValidationException extends __BaseException {
  */
 export interface DeleteExportRequest {
     /**
-     * @public
      * <p>The Amazon Resource Name (ARN) for this export.</p>
+     * @public
      */
     ExportArn: string | undefined;
 }
@@ -375,27 +375,27 @@ export interface DeleteExportRequest {
  */
 export interface DeleteExportResponse {
     /**
-     * @public
      * <p>The Amazon Resource Name (ARN) for this export.</p>
+     * @public
      */
     ExportArn?: string;
 }
 /**
- * @public
  * <p>The specified Amazon Resource Name (ARN) in the request doesn't exist.</p>
+ * @public
  */
 export declare class ResourceNotFoundException extends __BaseException {
     readonly name: "ResourceNotFoundException";
     readonly $fault: "client";
     Message: string | undefined;
     /**
-     * @public
      * <p>The identifier of the resource that was not found.</p>
+     * @public
      */
     ResourceId: string | undefined;
     /**
-     * @public
      * <p>The type of the resource that was not found.</p>
+     * @public
      */
     ResourceType: string | undefined;
     /**
@@ -408,14 +408,14 @@ export declare class ResourceNotFoundException extends __BaseException {
  */
 export interface GetExecutionRequest {
     /**
-     * @public
      * <p>The Amazon Resource Name (ARN) of the Export object that generated this specific
      *       execution.</p>
+     * @public
      */
     ExportArn: string | undefined;
     /**
-     * @public
      * <p>The ID for this specific execution.</p>
+     * @public
      */
     ExecutionId: string | undefined;
 }
@@ -450,33 +450,33 @@ export declare const ExecutionStatusReason: {
  */
 export type ExecutionStatusReason = (typeof ExecutionStatusReason)[keyof typeof ExecutionStatusReason];
 /**
- * @public
  * <p>The status of the execution.</p>
+ * @public
  */
 export interface ExecutionStatus {
     /**
-     * @public
      * <p>The code for the status of the execution.</p>
+     * @public
      */
     StatusCode?: ExecutionStatusCode;
     /**
-     * @public
      * <p>The reason for the failed status.</p>
+     * @public
      */
     StatusReason?: ExecutionStatusReason;
     /**
-     * @public
      * <p>The time when the execution was created.</p>
+     * @public
      */
     CreatedAt?: Date;
     /**
-     * @public
      * <p>The time when the execution was completed.</p>
+     * @public
      */
     CompletedAt?: Date;
     /**
-     * @public
      * <p>The time when the execution was last updated.</p>
+     * @public
      */
     LastUpdatedAt?: Date;
 }
@@ -485,20 +485,20 @@ export interface ExecutionStatus {
  */
 export interface GetExecutionResponse {
     /**
-     * @public
      * <p>The ID for this specific execution.</p>
+     * @public
      */
     ExecutionId?: string;
     /**
-     * @public
      * <p>The export data for this specific execution. This export data is a snapshot from when the
      *       execution was generated. The data could be different from the current export data if the
      *       export was updated since the execution was generated.</p>
+     * @public
      */
     Export?: Export;
     /**
-     * @public
      * <p>The status of this specific execution.</p>
+     * @public
      */
     ExecutionStatus?: ExecutionStatus;
 }
@@ -507,8 +507,8 @@ export interface GetExecutionResponse {
  */
 export interface GetExportRequest {
     /**
-     * @public
      * <p>The Amazon Resource Name (ARN) for this export.</p>
+     * @public
      */
     ExportArn: string | undefined;
 }
@@ -525,33 +525,33 @@ export declare const ExportStatusCode: {
  */
 export type ExportStatusCode = (typeof ExportStatusCode)[keyof typeof ExportStatusCode];
 /**
- * @public
  * <p>The status of the data export.</p>
+ * @public
  */
 export interface ExportStatus {
     /**
-     * @public
      * <p>The status code for the request.</p>
+     * @public
      */
     StatusCode?: ExportStatusCode;
     /**
-     * @public
      * <p>The description for the status code.</p>
+     * @public
      */
     StatusReason?: ExecutionStatusReason;
     /**
-     * @public
      * <p>The timestamp of when the export  was created.</p>
+     * @public
      */
     CreatedAt?: Date;
     /**
-     * @public
      * <p>The timestamp of when the export  was updated.</p>
+     * @public
      */
     LastUpdatedAt?: Date;
     /**
-     * @public
      * <p>The timestamp of when the export was last generated.</p>
+     * @public
      */
     LastRefreshedAt?: Date;
 }
@@ -560,13 +560,13 @@ export interface ExportStatus {
  */
 export interface GetExportResponse {
     /**
-     * @public
      * <p>The data for this specific export.</p>
+     * @public
      */
     Export?: Export;
     /**
-     * @public
      * <p>The status of this specific export.</p>
+     * @public
      */
     ExportStatus?: ExportStatus;
 }
@@ -575,38 +575,38 @@ export interface GetExportResponse {
  */
 export interface GetTableRequest {
     /**
-     * @public
      * <p>The name of the table.</p>
+     * @public
      */
     TableName: string | undefined;
     /**
-     * @public
      * <p>TableProperties are additional configurations you can provide to change the data and
      *       schema of a table. Each table can have different TableProperties. Tables are not required to
      *       have any TableProperties. Each table property has a default value that it assumes if not
      *       specified.</p>
+     * @public
      */
     TableProperties?: Record<string, string>;
 }
 /**
- * @public
  * <p>Includes basic information for a data column such as its description, name, and
  *       type.</p>
+ * @public
  */
 export interface Column {
     /**
-     * @public
      * <p>The column name.</p>
+     * @public
      */
     Name?: string;
     /**
-     * @public
      * <p>The kind of data a column stores.</p>
+     * @public
      */
     Type?: string;
     /**
-     * @public
      * <p>The description for a column.</p>
+     * @public
      */
     Description?: string;
 }
@@ -615,26 +615,26 @@ export interface Column {
  */
 export interface GetTableResponse {
     /**
-     * @public
      * <p>The name of the table.</p>
+     * @public
      */
     TableName?: string;
     /**
-     * @public
      * <p>The table description.</p>
+     * @public
      */
     Description?: string;
     /**
-     * @public
      * <p>TableProperties are additional configurations you can provide to change the data and
      *       schema of a table. Each table can have different TableProperties. Tables are not required to
      *       have any TableProperties. Each table property has a default value that it assumes if not
      *       specified.</p>
+     * @public
      */
     TableProperties?: Record<string, string>;
     /**
-     * @public
      * <p>The schema of the table.</p>
+     * @public
      */
     Schema?: Column[];
 }
@@ -643,34 +643,34 @@ export interface GetTableResponse {
  */
 export interface ListExecutionsRequest {
     /**
-     * @public
      * <p>The Amazon Resource Name (ARN) for this export.</p>
+     * @public
      */
     ExportArn: string | undefined;
     /**
-     * @public
      * <p>The maximum number of objects that are returned for the request.</p>
+     * @public
      */
     MaxResults?: number;
     /**
-     * @public
      * <p>The token to retrieve the next set of results.</p>
+     * @public
      */
     NextToken?: string;
 }
 /**
- * @public
  * <p>The reference for the data export update.</p>
+ * @public
  */
 export interface ExecutionReference {
     /**
-     * @public
      * <p>The ID for this specific execution.</p>
+     * @public
      */
     ExecutionId: string | undefined;
     /**
-     * @public
      * <p>The status of this specific execution.</p>
+     * @public
      */
     ExecutionStatus: ExecutionStatus | undefined;
 }
@@ -679,13 +679,13 @@ export interface ExecutionReference {
  */
 export interface ListExecutionsResponse {
     /**
-     * @public
      * <p>The list of executions.</p>
+     * @public
      */
     Executions?: ExecutionReference[];
     /**
-     * @public
      * <p>The token to retrieve the next set of results.</p>
+     * @public
      */
     NextToken?: string;
 }
@@ -694,34 +694,34 @@ export interface ListExecutionsResponse {
  */
 export interface ListExportsRequest {
     /**
-     * @public
      * <p>The maximum number of objects that are returned for the request.</p>
+     * @public
      */
     MaxResults?: number;
     /**
-     * @public
      * <p>The token to retrieve the next set of results.</p>
+     * @public
      */
     NextToken?: string;
 }
 /**
- * @public
  * <p>The reference details for a given export.</p>
+ * @public
  */
 export interface ExportReference {
     /**
-     * @public
      * <p>The Amazon Resource Name (ARN) for this export.</p>
+     * @public
      */
     ExportArn: string | undefined;
     /**
-     * @public
      * <p>The name of this specific data export.</p>
+     * @public
      */
     ExportName: string | undefined;
     /**
-     * @public
      * <p>The status of this specific data export.</p>
+     * @public
      */
     ExportStatus: ExportStatus | undefined;
 }
@@ -730,13 +730,13 @@ export interface ExportReference {
  */
 export interface ListExportsResponse {
     /**
-     * @public
      * <p>The details of the exports, including name and export status.</p>
+     * @public
      */
     Exports?: ExportReference[];
     /**
-     * @public
      * <p>The token to retrieve the next set of results.</p>
+     * @public
      */
     NextToken?: string;
 }
@@ -745,60 +745,60 @@ export interface ListExportsResponse {
  */
 export interface ListTablesRequest {
     /**
-     * @public
      * <p>The token to retrieve the next set of results.</p>
+     * @public
      */
     NextToken?: string;
     /**
-     * @public
      * <p>The maximum number of objects that are returned for the request.</p>
+     * @public
      */
     MaxResults?: number;
 }
 /**
- * @public
  * <p>The properties for the data export table.</p>
+ * @public
  */
 export interface TablePropertyDescription {
     /**
-     * @public
      * <p>The name of the table.</p>
+     * @public
      */
     Name?: string;
     /**
-     * @public
      * <p>The valid values for the table.</p>
+     * @public
      */
     ValidValues?: string[];
     /**
-     * @public
      * <p>The default value for the table.</p>
+     * @public
      */
     DefaultValue?: string;
     /**
-     * @public
      * <p>The description for the table.</p>
+     * @public
      */
     Description?: string;
 }
 /**
- * @public
  * <p>The details for the data export table.</p>
+ * @public
  */
 export interface Table {
     /**
-     * @public
      * <p>The name of the table.</p>
+     * @public
      */
     TableName?: string;
     /**
-     * @public
      * <p>The description for the table.</p>
+     * @public
      */
     Description?: string;
     /**
-     * @public
      * <p>The properties for the table.</p>
+     * @public
      */
     TableProperties?: TablePropertyDescription[];
 }
@@ -807,13 +807,13 @@ export interface Table {
  */
 export interface ListTablesResponse {
     /**
-     * @public
      * <p>The list of tables.</p>
+     * @public
      */
     Tables?: Table[];
     /**
-     * @public
      * <p>The token to retrieve the next set of results.</p>
+     * @public
      */
     NextToken?: string;
 }
@@ -822,18 +822,18 @@ export interface ListTablesResponse {
  */
 export interface ListTagsForResourceRequest {
     /**
-     * @public
      * <p>The unique identifier for the resource.</p>
+     * @public
      */
     ResourceArn: string | undefined;
     /**
-     * @public
      * <p>The maximum number of objects that are returned for the request.</p>
+     * @public
      */
     MaxResults?: number;
     /**
-     * @public
      * <p>The token to retrieve the next set of results.</p>
+     * @public
      */
     NextToken?: string;
 }
@@ -842,14 +842,14 @@ export interface ListTagsForResourceRequest {
  */
 export interface ListTagsForResourceResponse {
     /**
-     * @public
      * <p>An optional list of tags to associate with the specified export. Each tag consists of a
      *       key and a value, and each key must be unique for the resource.</p>
+     * @public
      */
     ResourceTags?: ResourceTag[];
     /**
-     * @public
      * <p>The token to retrieve the next set of results.</p>
+     * @public
      */
     NextToken?: string;
 }
@@ -858,14 +858,14 @@ export interface ListTagsForResourceResponse {
  */
 export interface TagResourceRequest {
     /**
-     * @public
      * <p>The unique identifier for the resource.</p>
+     * @public
      */
     ResourceArn: string | undefined;
     /**
-     * @public
      * <p>The tags to associate with the resource. Each tag consists of a key and a value, and each
      *       key must be unique for the resource.</p>
+     * @public
      */
     ResourceTags: ResourceTag[] | undefined;
 }
@@ -879,13 +879,13 @@ export interface TagResourceResponse {
  */
 export interface UntagResourceRequest {
     /**
-     * @public
      * <p>The unique identifier for the resource.</p>
+     * @public
      */
     ResourceArn: string | undefined;
     /**
-     * @public
      * <p>The tag keys that are associated with the resource ARN.</p>
+     * @public
      */
     ResourceTagKeys: string[] | undefined;
 }
@@ -899,13 +899,13 @@ export interface UntagResourceResponse {
  */
 export interface UpdateExportRequest {
     /**
-     * @public
      * <p>The Amazon Resource Name (ARN) for this export.</p>
+     * @public
      */
     ExportArn: string | undefined;
     /**
-     * @public
      * <p>The name and query details for the export.</p>
+     * @public
      */
     Export: Export | undefined;
 }
@@ -914,8 +914,8 @@ export interface UpdateExportRequest {
  */
 export interface UpdateExportResponse {
     /**
-     * @public
      * <p>The Amazon Resource Name (ARN) for this export.</p>
+     * @public
      */
     ExportArn?: string;
 }