-
Notifications
You must be signed in to change notification settings - Fork 545
/
ModifyReportDefinitionCommand.ts
168 lines (157 loc) · 6.76 KB
/
ModifyReportDefinitionCommand.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
// smithy-typescript generated code
import { EndpointParameterInstructions, getEndpointPlugin } from "@aws-sdk/middleware-endpoint";
import { getSerdePlugin } from "@aws-sdk/middleware-serde";
import { Command as $Command } from "@aws-sdk/smithy-client";
import {
FinalizeHandlerArguments,
Handler,
HandlerExecutionContext,
HttpHandlerOptions as __HttpHandlerOptions,
MetadataBearer as __MetadataBearer,
MiddlewareStack,
} from "@aws-sdk/types";
import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@smithy/protocol-http";
import { SerdeContext as __SerdeContext } from "@smithy/types";
import {
CostAndUsageReportServiceClientResolvedConfig,
ServiceInputTypes,
ServiceOutputTypes,
} from "../CostAndUsageReportServiceClient";
import { ModifyReportDefinitionRequest, ModifyReportDefinitionResponse } from "../models/models_0";
import { de_ModifyReportDefinitionCommand, se_ModifyReportDefinitionCommand } from "../protocols/Aws_json1_1";
/**
* @public
*/
export { __MetadataBearer, $Command };
/**
* @public
*
* The input for {@link ModifyReportDefinitionCommand}.
*/
export interface ModifyReportDefinitionCommandInput extends ModifyReportDefinitionRequest {}
/**
* @public
*
* The output of {@link ModifyReportDefinitionCommand}.
*/
export interface ModifyReportDefinitionCommandOutput extends ModifyReportDefinitionResponse, __MetadataBearer {}
/**
* @public
* <p>Allows you to programatically update your report preferences.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
* import { CostAndUsageReportServiceClient, ModifyReportDefinitionCommand } from "@aws-sdk/client-cost-and-usage-report-service"; // ES Modules import
* // const { CostAndUsageReportServiceClient, ModifyReportDefinitionCommand } = require("@aws-sdk/client-cost-and-usage-report-service"); // CommonJS import
* const client = new CostAndUsageReportServiceClient(config);
* const input = { // ModifyReportDefinitionRequest
* ReportName: "STRING_VALUE", // required
* ReportDefinition: { // ReportDefinition
* ReportName: "STRING_VALUE", // required
* TimeUnit: "HOURLY" || "DAILY" || "MONTHLY", // required
* Format: "textORcsv" || "Parquet", // required
* Compression: "ZIP" || "GZIP" || "Parquet", // required
* AdditionalSchemaElements: [ // SchemaElementList // required
* "RESOURCES" || "SPLIT_COST_ALLOCATION_DATA",
* ],
* S3Bucket: "STRING_VALUE", // required
* S3Prefix: "STRING_VALUE", // required
* S3Region: "af-south-1" || "ap-east-1" || "ap-south-1" || "ap-south-2" || "ap-southeast-1" || "ap-southeast-2" || "ap-southeast-3" || "ap-northeast-1" || "ap-northeast-2" || "ap-northeast-3" || "ca-central-1" || "eu-central-1" || "eu-central-2" || "eu-west-1" || "eu-west-2" || "eu-west-3" || "eu-north-1" || "eu-south-1" || "eu-south-2" || "me-central-1" || "me-south-1" || "sa-east-1" || "us-east-1" || "us-east-2" || "us-west-1" || "us-west-2" || "cn-north-1" || "cn-northwest-1", // required
* AdditionalArtifacts: [ // AdditionalArtifactList
* "REDSHIFT" || "QUICKSIGHT" || "ATHENA",
* ],
* RefreshClosedReports: true || false,
* ReportVersioning: "CREATE_NEW_REPORT" || "OVERWRITE_REPORT",
* BillingViewArn: "STRING_VALUE",
* },
* };
* const command = new ModifyReportDefinitionCommand(input);
* const response = await client.send(command);
* // {};
*
* ```
*
* @param ModifyReportDefinitionCommandInput - {@link ModifyReportDefinitionCommandInput}
* @returns {@link ModifyReportDefinitionCommandOutput}
* @see {@link ModifyReportDefinitionCommandInput} for command's `input` shape.
* @see {@link ModifyReportDefinitionCommandOutput} for command's `response` shape.
* @see {@link CostAndUsageReportServiceClientResolvedConfig | config} for CostAndUsageReportServiceClient's `config` shape.
*
* @throws {@link InternalErrorException} (server fault)
* <p>An error on the server occurred during the processing of your request. Try again later.</p>
*
* @throws {@link ValidationException} (client fault)
* <p>The input fails to satisfy the constraints specified by an AWS service.</p>
*
* @throws {@link CostAndUsageReportServiceServiceException}
* <p>Base exception class for all service exceptions from CostAndUsageReportService service.</p>
*
*/
export class ModifyReportDefinitionCommand extends $Command<
ModifyReportDefinitionCommandInput,
ModifyReportDefinitionCommandOutput,
CostAndUsageReportServiceClientResolvedConfig
> {
// Start section: command_properties
// End section: command_properties
public static getEndpointParameterInstructions(): EndpointParameterInstructions {
return {
UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" },
Endpoint: { type: "builtInParams", name: "endpoint" },
Region: { type: "builtInParams", name: "region" },
UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" },
};
}
/**
* @public
*/
constructor(readonly input: ModifyReportDefinitionCommandInput) {
// Start section: command_constructor
super();
// End section: command_constructor
}
/**
* @internal
*/
resolveMiddleware(
clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
configuration: CostAndUsageReportServiceClientResolvedConfig,
options?: __HttpHandlerOptions
): Handler<ModifyReportDefinitionCommandInput, ModifyReportDefinitionCommandOutput> {
this.middlewareStack.use(getSerdePlugin(configuration, this.serialize, this.deserialize));
this.middlewareStack.use(
getEndpointPlugin(configuration, ModifyReportDefinitionCommand.getEndpointParameterInstructions())
);
const stack = clientStack.concat(this.middlewareStack);
const { logger } = configuration;
const clientName = "CostAndUsageReportServiceClient";
const commandName = "ModifyReportDefinitionCommand";
const handlerExecutionContext: HandlerExecutionContext = {
logger,
clientName,
commandName,
inputFilterSensitiveLog: (_: any) => _,
outputFilterSensitiveLog: (_: any) => _,
};
const { requestHandler } = configuration;
return stack.resolve(
(request: FinalizeHandlerArguments<any>) =>
requestHandler.handle(request.request as __HttpRequest, options || {}),
handlerExecutionContext
);
}
/**
* @internal
*/
private serialize(input: ModifyReportDefinitionCommandInput, context: __SerdeContext): Promise<__HttpRequest> {
return se_ModifyReportDefinitionCommand(input, context);
}
/**
* @internal
*/
private deserialize(output: __HttpResponse, context: __SerdeContext): Promise<ModifyReportDefinitionCommandOutput> {
return de_ModifyReportDefinitionCommand(output, context);
}
// Start section: command_body_extra
// End section: command_body_extra
}