@aws-sdk/client-applicationcostprofiler 3.295.0 → 3.297.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -7,6 +7,7 @@ import { ListReportDefinitionsCommandInput, ListReportDefinitionsCommandOutput }
7
7
  import { PutReportDefinitionCommandInput, PutReportDefinitionCommandOutput } from "./commands/PutReportDefinitionCommand";
8
8
  import { UpdateReportDefinitionCommandInput, UpdateReportDefinitionCommandOutput } from "./commands/UpdateReportDefinitionCommand";
9
9
  /**
10
+ * @public
10
11
  * <p>This reference provides descriptions of the AWS Application Cost Profiler API.</p>
11
12
  * <p>The AWS Application Cost Profiler API provides programmatic access to view, create, update, and delete
12
13
  * application cost report definitions, as well as to import your usage data into the Application Cost Profiler
@@ -16,6 +17,7 @@ import { UpdateReportDefinitionCommandInput, UpdateReportDefinitionCommandOutput
16
17
  */
17
18
  export declare class ApplicationCostProfiler extends ApplicationCostProfilerClient {
18
19
  /**
20
+ * @public
19
21
  * <p>Deletes the specified report definition in AWS Application Cost Profiler. This stops the report from being
20
22
  * generated.</p>
21
23
  */
@@ -23,12 +25,14 @@ export declare class ApplicationCostProfiler extends ApplicationCostProfilerClie
23
25
  deleteReportDefinition(args: DeleteReportDefinitionCommandInput, cb: (err: any, data?: DeleteReportDefinitionCommandOutput) => void): void;
24
26
  deleteReportDefinition(args: DeleteReportDefinitionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteReportDefinitionCommandOutput) => void): void;
25
27
  /**
28
+ * @public
26
29
  * <p>Retrieves the definition of a report already configured in AWS Application Cost Profiler.</p>
27
30
  */
28
31
  getReportDefinition(args: GetReportDefinitionCommandInput, options?: __HttpHandlerOptions): Promise<GetReportDefinitionCommandOutput>;
29
32
  getReportDefinition(args: GetReportDefinitionCommandInput, cb: (err: any, data?: GetReportDefinitionCommandOutput) => void): void;
30
33
  getReportDefinition(args: GetReportDefinitionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetReportDefinitionCommandOutput) => void): void;
31
34
  /**
35
+ * @public
32
36
  * <p>Ingests application usage data from Amazon Simple Storage Service (Amazon S3).</p>
33
37
  * <p>The data must already exist in the S3 location. As part of the action, AWS Application Cost Profiler
34
38
  * copies the object from your S3 bucket to an S3 bucket owned by Amazon for processing
@@ -38,6 +42,7 @@ export declare class ApplicationCostProfiler extends ApplicationCostProfilerClie
38
42
  importApplicationUsage(args: ImportApplicationUsageCommandInput, cb: (err: any, data?: ImportApplicationUsageCommandOutput) => void): void;
39
43
  importApplicationUsage(args: ImportApplicationUsageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ImportApplicationUsageCommandOutput) => void): void;
40
44
  /**
45
+ * @public
41
46
  * <p>Retrieves a list of all reports and their configurations for your AWS account.</p>
42
47
  * <p>The maximum number of reports is one.</p>
43
48
  */
@@ -45,12 +50,14 @@ export declare class ApplicationCostProfiler extends ApplicationCostProfilerClie
45
50
  listReportDefinitions(args: ListReportDefinitionsCommandInput, cb: (err: any, data?: ListReportDefinitionsCommandOutput) => void): void;
46
51
  listReportDefinitions(args: ListReportDefinitionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListReportDefinitionsCommandOutput) => void): void;
47
52
  /**
53
+ * @public
48
54
  * <p>Creates the report definition for a report in Application Cost Profiler.</p>
49
55
  */
50
56
  putReportDefinition(args: PutReportDefinitionCommandInput, options?: __HttpHandlerOptions): Promise<PutReportDefinitionCommandOutput>;
51
57
  putReportDefinition(args: PutReportDefinitionCommandInput, cb: (err: any, data?: PutReportDefinitionCommandOutput) => void): void;
52
58
  putReportDefinition(args: PutReportDefinitionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutReportDefinitionCommandOutput) => void): void;
53
59
  /**
60
+ * @public
54
61
  * <p>Updates existing report in AWS Application Cost Profiler.</p>
55
62
  */
56
63
  updateReportDefinition(args: UpdateReportDefinitionCommandInput, options?: __HttpHandlerOptions): Promise<UpdateReportDefinitionCommandOutput>;
@@ -14,15 +14,24 @@ import { ListReportDefinitionsCommandInput, ListReportDefinitionsCommandOutput }
14
14
  import { PutReportDefinitionCommandInput, PutReportDefinitionCommandOutput } from "./commands/PutReportDefinitionCommand";
15
15
  import { UpdateReportDefinitionCommandInput, UpdateReportDefinitionCommandOutput } from "./commands/UpdateReportDefinitionCommand";
16
16
  import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
17
+ /**
18
+ * @public
19
+ */
17
20
  export type ServiceInputTypes = DeleteReportDefinitionCommandInput | GetReportDefinitionCommandInput | ImportApplicationUsageCommandInput | ListReportDefinitionsCommandInput | PutReportDefinitionCommandInput | UpdateReportDefinitionCommandInput;
21
+ /**
22
+ * @public
23
+ */
18
24
  export type ServiceOutputTypes = DeleteReportDefinitionCommandOutput | GetReportDefinitionCommandOutput | ImportApplicationUsageCommandOutput | ListReportDefinitionsCommandOutput | PutReportDefinitionCommandOutput | UpdateReportDefinitionCommandOutput;
25
+ /**
26
+ * @public
27
+ */
19
28
  export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
20
29
  /**
21
30
  * The HTTP handler to use. Fetch in browser and Https in Nodejs.
22
31
  */
23
32
  requestHandler?: __HttpHandler;
24
33
  /**
25
- * A constructor for a class implementing the {@link __Checksum} interface
34
+ * A constructor for a class implementing the {@link @aws-sdk/types#ChecksumConstructor} interface
26
35
  * that computes the SHA-256 HMAC or checksum of a string or binary buffer.
27
36
  * @internal
28
37
  */
@@ -112,23 +121,34 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
112
121
  */
113
122
  logger?: __Logger;
114
123
  /**
115
- * The {@link __DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
124
+ * The {@link @aws-sdk/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
116
125
  */
117
126
  defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
118
127
  }
128
+ /**
129
+ * @public
130
+ */
119
131
  type ApplicationCostProfilerClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig & ClientInputEndpointParameters;
120
132
  /**
121
- * The configuration interface of ApplicationCostProfilerClient class constructor that set the region, credentials and other options.
133
+ * @public
134
+ *
135
+ * The configuration interface of ApplicationCostProfilerClient class constructor that set the region, credentials and other options.
122
136
  */
123
137
  export interface ApplicationCostProfilerClientConfig extends ApplicationCostProfilerClientConfigType {
124
138
  }
139
+ /**
140
+ * @public
141
+ */
125
142
  type ApplicationCostProfilerClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters;
126
143
  /**
127
- * The resolved configuration interface of ApplicationCostProfilerClient class. This is resolved and normalized from the {@link ApplicationCostProfilerClientConfig | constructor configuration interface}.
144
+ * @public
145
+ *
146
+ * The resolved configuration interface of ApplicationCostProfilerClient class. This is resolved and normalized from the {@link ApplicationCostProfilerClientConfig | constructor configuration interface}.
128
147
  */
129
148
  export interface ApplicationCostProfilerClientResolvedConfig extends ApplicationCostProfilerClientResolvedConfigType {
130
149
  }
131
150
  /**
151
+ * @public
132
152
  * <p>This reference provides descriptions of the AWS Application Cost Profiler API.</p>
133
153
  * <p>The AWS Application Cost Profiler API provides programmatic access to view, create, update, and delete
134
154
  * application cost report definitions, as well as to import your usage data into the Application Cost Profiler
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ApplicationCostProfilerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ApplicationCostProfilerClient";
5
5
  import { DeleteReportDefinitionRequest, DeleteReportDefinitionResult } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteReportDefinitionCommand}.
8
10
  */
9
11
  export interface DeleteReportDefinitionCommandInput extends DeleteReportDefinitionRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteReportDefinitionCommand}.
13
17
  */
14
18
  export interface DeleteReportDefinitionCommandOutput extends DeleteReportDefinitionResult, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes the specified report definition in AWS Application Cost Profiler. This stops the report from being
18
23
  * generated.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface DeleteReportDefinitionCommandOutput extends DeleteReportDefinit
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param DeleteReportDefinitionCommandInput - {@link DeleteReportDefinitionCommandInput}
35
+ * @returns {@link DeleteReportDefinitionCommandOutput}
29
36
  * @see {@link DeleteReportDefinitionCommandInput} for command's `input` shape.
30
37
  * @see {@link DeleteReportDefinitionCommandOutput} for command's `response` shape.
31
38
  * @see {@link ApplicationCostProfilerClientResolvedConfig | config} for ApplicationCostProfilerClient's `config` shape.
@@ -47,11 +54,20 @@ export interface DeleteReportDefinitionCommandOutput extends DeleteReportDefinit
47
54
  export declare class DeleteReportDefinitionCommand extends $Command<DeleteReportDefinitionCommandInput, DeleteReportDefinitionCommandOutput, ApplicationCostProfilerClientResolvedConfig> {
48
55
  readonly input: DeleteReportDefinitionCommandInput;
49
56
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
57
+ /**
58
+ * @public
59
+ */
50
60
  constructor(input: DeleteReportDefinitionCommandInput);
51
61
  /**
52
62
  * @internal
53
63
  */
54
64
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ApplicationCostProfilerClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteReportDefinitionCommandInput, DeleteReportDefinitionCommandOutput>;
65
+ /**
66
+ * @internal
67
+ */
55
68
  private serialize;
69
+ /**
70
+ * @internal
71
+ */
56
72
  private deserialize;
57
73
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ApplicationCostProfilerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ApplicationCostProfilerClient";
5
5
  import { GetReportDefinitionRequest, GetReportDefinitionResult } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetReportDefinitionCommand}.
8
10
  */
9
11
  export interface GetReportDefinitionCommandInput extends GetReportDefinitionRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetReportDefinitionCommand}.
13
17
  */
14
18
  export interface GetReportDefinitionCommandOutput extends GetReportDefinitionResult, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieves the definition of a report already configured in AWS Application Cost Profiler.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface GetReportDefinitionCommandOutput extends GetReportDefinitionRes
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param GetReportDefinitionCommandInput - {@link GetReportDefinitionCommandInput}
34
+ * @returns {@link GetReportDefinitionCommandOutput}
28
35
  * @see {@link GetReportDefinitionCommandInput} for command's `input` shape.
29
36
  * @see {@link GetReportDefinitionCommandOutput} for command's `response` shape.
30
37
  * @see {@link ApplicationCostProfilerClientResolvedConfig | config} for ApplicationCostProfilerClient's `config` shape.
@@ -46,11 +53,20 @@ export interface GetReportDefinitionCommandOutput extends GetReportDefinitionRes
46
53
  export declare class GetReportDefinitionCommand extends $Command<GetReportDefinitionCommandInput, GetReportDefinitionCommandOutput, ApplicationCostProfilerClientResolvedConfig> {
47
54
  readonly input: GetReportDefinitionCommandInput;
48
55
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
56
+ /**
57
+ * @public
58
+ */
49
59
  constructor(input: GetReportDefinitionCommandInput);
50
60
  /**
51
61
  * @internal
52
62
  */
53
63
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ApplicationCostProfilerClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetReportDefinitionCommandInput, GetReportDefinitionCommandOutput>;
64
+ /**
65
+ * @internal
66
+ */
54
67
  private serialize;
68
+ /**
69
+ * @internal
70
+ */
55
71
  private deserialize;
56
72
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ApplicationCostProfilerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ApplicationCostProfilerClient";
5
5
  import { ImportApplicationUsageRequest, ImportApplicationUsageResult } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ImportApplicationUsageCommand}.
8
10
  */
9
11
  export interface ImportApplicationUsageCommandInput extends ImportApplicationUsageRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ImportApplicationUsageCommand}.
13
17
  */
14
18
  export interface ImportApplicationUsageCommandOutput extends ImportApplicationUsageResult, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Ingests application usage data from Amazon Simple Storage Service (Amazon S3).</p>
18
23
  * <p>The data must already exist in the S3 location. As part of the action, AWS Application Cost Profiler
19
24
  * copies the object from your S3 bucket to an S3 bucket owned by Amazon for processing
@@ -28,6 +33,8 @@ export interface ImportApplicationUsageCommandOutput extends ImportApplicationUs
28
33
  * const response = await client.send(command);
29
34
  * ```
30
35
  *
36
+ * @param ImportApplicationUsageCommandInput - {@link ImportApplicationUsageCommandInput}
37
+ * @returns {@link ImportApplicationUsageCommandOutput}
31
38
  * @see {@link ImportApplicationUsageCommandInput} for command's `input` shape.
32
39
  * @see {@link ImportApplicationUsageCommandOutput} for command's `response` shape.
33
40
  * @see {@link ApplicationCostProfilerClientResolvedConfig | config} for ApplicationCostProfilerClient's `config` shape.
@@ -49,11 +56,20 @@ export interface ImportApplicationUsageCommandOutput extends ImportApplicationUs
49
56
  export declare class ImportApplicationUsageCommand extends $Command<ImportApplicationUsageCommandInput, ImportApplicationUsageCommandOutput, ApplicationCostProfilerClientResolvedConfig> {
50
57
  readonly input: ImportApplicationUsageCommandInput;
51
58
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
59
+ /**
60
+ * @public
61
+ */
52
62
  constructor(input: ImportApplicationUsageCommandInput);
53
63
  /**
54
64
  * @internal
55
65
  */
56
66
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ApplicationCostProfilerClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ImportApplicationUsageCommandInput, ImportApplicationUsageCommandOutput>;
67
+ /**
68
+ * @internal
69
+ */
57
70
  private serialize;
71
+ /**
72
+ * @internal
73
+ */
58
74
  private deserialize;
59
75
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ApplicationCostProfilerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ApplicationCostProfilerClient";
5
5
  import { ListReportDefinitionsRequest, ListReportDefinitionsResult } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListReportDefinitionsCommand}.
8
10
  */
9
11
  export interface ListReportDefinitionsCommandInput extends ListReportDefinitionsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListReportDefinitionsCommand}.
13
17
  */
14
18
  export interface ListReportDefinitionsCommandOutput extends ListReportDefinitionsResult, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieves a list of all reports and their configurations for your AWS account.</p>
18
23
  * <p>The maximum number of reports is one.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface ListReportDefinitionsCommandOutput extends ListReportDefinition
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param ListReportDefinitionsCommandInput - {@link ListReportDefinitionsCommandInput}
35
+ * @returns {@link ListReportDefinitionsCommandOutput}
29
36
  * @see {@link ListReportDefinitionsCommandInput} for command's `input` shape.
30
37
  * @see {@link ListReportDefinitionsCommandOutput} for command's `response` shape.
31
38
  * @see {@link ApplicationCostProfilerClientResolvedConfig | config} for ApplicationCostProfilerClient's `config` shape.
@@ -47,11 +54,20 @@ export interface ListReportDefinitionsCommandOutput extends ListReportDefinition
47
54
  export declare class ListReportDefinitionsCommand extends $Command<ListReportDefinitionsCommandInput, ListReportDefinitionsCommandOutput, ApplicationCostProfilerClientResolvedConfig> {
48
55
  readonly input: ListReportDefinitionsCommandInput;
49
56
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
57
+ /**
58
+ * @public
59
+ */
50
60
  constructor(input: ListReportDefinitionsCommandInput);
51
61
  /**
52
62
  * @internal
53
63
  */
54
64
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ApplicationCostProfilerClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListReportDefinitionsCommandInput, ListReportDefinitionsCommandOutput>;
65
+ /**
66
+ * @internal
67
+ */
55
68
  private serialize;
69
+ /**
70
+ * @internal
71
+ */
56
72
  private deserialize;
57
73
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ApplicationCostProfilerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ApplicationCostProfilerClient";
5
5
  import { PutReportDefinitionRequest, PutReportDefinitionResult } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link PutReportDefinitionCommand}.
8
10
  */
9
11
  export interface PutReportDefinitionCommandInput extends PutReportDefinitionRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link PutReportDefinitionCommand}.
13
17
  */
14
18
  export interface PutReportDefinitionCommandOutput extends PutReportDefinitionResult, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates the report definition for a report in Application Cost Profiler.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface PutReportDefinitionCommandOutput extends PutReportDefinitionRes
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param PutReportDefinitionCommandInput - {@link PutReportDefinitionCommandInput}
34
+ * @returns {@link PutReportDefinitionCommandOutput}
28
35
  * @see {@link PutReportDefinitionCommandInput} for command's `input` shape.
29
36
  * @see {@link PutReportDefinitionCommandOutput} for command's `response` shape.
30
37
  * @see {@link ApplicationCostProfilerClientResolvedConfig | config} for ApplicationCostProfilerClient's `config` shape.
@@ -49,11 +56,20 @@ export interface PutReportDefinitionCommandOutput extends PutReportDefinitionRes
49
56
  export declare class PutReportDefinitionCommand extends $Command<PutReportDefinitionCommandInput, PutReportDefinitionCommandOutput, ApplicationCostProfilerClientResolvedConfig> {
50
57
  readonly input: PutReportDefinitionCommandInput;
51
58
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
59
+ /**
60
+ * @public
61
+ */
52
62
  constructor(input: PutReportDefinitionCommandInput);
53
63
  /**
54
64
  * @internal
55
65
  */
56
66
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ApplicationCostProfilerClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PutReportDefinitionCommandInput, PutReportDefinitionCommandOutput>;
67
+ /**
68
+ * @internal
69
+ */
57
70
  private serialize;
71
+ /**
72
+ * @internal
73
+ */
58
74
  private deserialize;
59
75
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ApplicationCostProfilerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ApplicationCostProfilerClient";
5
5
  import { UpdateReportDefinitionRequest, UpdateReportDefinitionResult } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link UpdateReportDefinitionCommand}.
8
10
  */
9
11
  export interface UpdateReportDefinitionCommandInput extends UpdateReportDefinitionRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link UpdateReportDefinitionCommand}.
13
17
  */
14
18
  export interface UpdateReportDefinitionCommandOutput extends UpdateReportDefinitionResult, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Updates existing report in AWS Application Cost Profiler.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface UpdateReportDefinitionCommandOutput extends UpdateReportDefinit
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param UpdateReportDefinitionCommandInput - {@link UpdateReportDefinitionCommandInput}
34
+ * @returns {@link UpdateReportDefinitionCommandOutput}
28
35
  * @see {@link UpdateReportDefinitionCommandInput} for command's `input` shape.
29
36
  * @see {@link UpdateReportDefinitionCommandOutput} for command's `response` shape.
30
37
  * @see {@link ApplicationCostProfilerClientResolvedConfig | config} for ApplicationCostProfilerClient's `config` shape.
@@ -46,11 +53,20 @@ export interface UpdateReportDefinitionCommandOutput extends UpdateReportDefinit
46
53
  export declare class UpdateReportDefinitionCommand extends $Command<UpdateReportDefinitionCommandInput, UpdateReportDefinitionCommandOutput, ApplicationCostProfilerClientResolvedConfig> {
47
54
  readonly input: UpdateReportDefinitionCommandInput;
48
55
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
56
+ /**
57
+ * @public
58
+ */
49
59
  constructor(input: UpdateReportDefinitionCommandInput);
50
60
  /**
51
61
  * @internal
52
62
  */
53
63
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ApplicationCostProfilerClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateReportDefinitionCommandInput, UpdateReportDefinitionCommandOutput>;
64
+ /**
65
+ * @internal
66
+ */
54
67
  private serialize;
68
+ /**
69
+ * @internal
70
+ */
55
71
  private deserialize;
56
72
  }
@@ -1,5 +1,7 @@
1
1
  import { ServiceException as __ServiceException, ServiceExceptionOptions as __ServiceExceptionOptions } from "@aws-sdk/smithy-client";
2
2
  /**
3
+ * @public
4
+ *
3
5
  * Base exception class for all service exceptions from ApplicationCostProfiler service.
4
6
  */
5
7
  export declare class ApplicationCostProfilerServiceException extends __ServiceException {
@@ -1,6 +1,7 @@
1
1
  import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
2
2
  import { ApplicationCostProfilerServiceException as __BaseException } from "./ApplicationCostProfilerServiceException";
3
3
  /**
4
+ * @public
4
5
  * <p>You do not have permission to perform this action.</p>
5
6
  */
6
7
  export declare class AccessDeniedException extends __BaseException {
@@ -11,12 +12,18 @@ export declare class AccessDeniedException extends __BaseException {
11
12
  */
12
13
  constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
13
14
  }
15
+ /**
16
+ * @public
17
+ */
14
18
  export interface DeleteReportDefinitionRequest {
15
19
  /**
16
20
  * <p>Required. ID of the report to delete.</p>
17
21
  */
18
22
  reportId: string | undefined;
19
23
  }
24
+ /**
25
+ * @public
26
+ */
20
27
  export interface DeleteReportDefinitionResult {
21
28
  /**
22
29
  * <p>ID of the report that was deleted.</p>
@@ -24,6 +31,7 @@ export interface DeleteReportDefinitionResult {
24
31
  reportId?: string;
25
32
  }
26
33
  /**
34
+ * @public
27
35
  * <p>An internal server error occurred. Retry your request.</p>
28
36
  */
29
37
  export declare class InternalServerException extends __BaseException {
@@ -35,6 +43,7 @@ export declare class InternalServerException extends __BaseException {
35
43
  constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
36
44
  }
37
45
  /**
46
+ * @public
38
47
  * <p>The calls to AWS Application Cost Profiler API are throttled. The request was denied.</p>
39
48
  */
40
49
  export declare class ThrottlingException extends __BaseException {
@@ -46,6 +55,7 @@ export declare class ThrottlingException extends __BaseException {
46
55
  constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
47
56
  }
48
57
  /**
58
+ * @public
49
59
  * <p>The input fails to satisfy the constraints for the API.</p>
50
60
  */
51
61
  export declare class ValidationException extends __BaseException {
@@ -56,6 +66,9 @@ export declare class ValidationException extends __BaseException {
56
66
  */
57
67
  constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
58
68
  }
69
+ /**
70
+ * @public
71
+ */
59
72
  export interface GetReportDefinitionRequest {
60
73
  /**
61
74
  * <p>ID of the report to retrieve.</p>
@@ -63,6 +76,7 @@ export interface GetReportDefinitionRequest {
63
76
  reportId: string | undefined;
64
77
  }
65
78
  /**
79
+ * @public
66
80
  * <p>Represents the Amazon Simple Storage Service (Amazon S3) location where AWS Application Cost Profiler
67
81
  * reports are generated and then written to.</p>
68
82
  */
@@ -76,15 +90,24 @@ export interface S3Location {
76
90
  */
77
91
  prefix: string | undefined;
78
92
  }
93
+ /**
94
+ * @public
95
+ */
79
96
  export declare enum Format {
80
97
  CSV = "CSV",
81
98
  PARQUET = "PARQUET"
82
99
  }
100
+ /**
101
+ * @public
102
+ */
83
103
  export declare enum ReportFrequency {
84
104
  ALL = "ALL",
85
105
  DAILY = "DAILY",
86
106
  MONTHLY = "MONTHLY"
87
107
  }
108
+ /**
109
+ * @public
110
+ */
88
111
  export interface GetReportDefinitionResult {
89
112
  /**
90
113
  * <p>ID of the report retrieved.</p>
@@ -115,6 +138,9 @@ export interface GetReportDefinitionResult {
115
138
  */
116
139
  lastUpdated: Date | undefined;
117
140
  }
141
+ /**
142
+ * @public
143
+ */
118
144
  export declare enum S3BucketRegion {
119
145
  AF_SOUTH_1 = "af-south-1",
120
146
  AP_EAST_1 = "ap-east-1",
@@ -122,6 +148,7 @@ export declare enum S3BucketRegion {
122
148
  ME_SOUTH_1 = "me-south-1"
123
149
  }
124
150
  /**
151
+ * @public
125
152
  * <p>Represents the Amazon Simple Storage Service (Amazon S3) location where usage data is read
126
153
  * from.</p>
127
154
  */
@@ -141,18 +168,27 @@ export interface SourceS3Location {
141
168
  */
142
169
  region?: S3BucketRegion | string;
143
170
  }
171
+ /**
172
+ * @public
173
+ */
144
174
  export interface ImportApplicationUsageRequest {
145
175
  /**
146
176
  * <p>Amazon S3 location to import application usage data from.</p>
147
177
  */
148
178
  sourceS3Location: SourceS3Location | undefined;
149
179
  }
180
+ /**
181
+ * @public
182
+ */
150
183
  export interface ImportApplicationUsageResult {
151
184
  /**
152
185
  * <p>ID of the import request.</p>
153
186
  */
154
187
  importId: string | undefined;
155
188
  }
189
+ /**
190
+ * @public
191
+ */
156
192
  export interface ListReportDefinitionsRequest {
157
193
  /**
158
194
  * <p>The token value from a previous call to access the next page of results.</p>
@@ -164,6 +200,7 @@ export interface ListReportDefinitionsRequest {
164
200
  maxResults?: number;
165
201
  }
166
202
  /**
203
+ * @public
167
204
  * <p>The configuration of a report in AWS Application Cost Profiler.</p>
168
205
  */
169
206
  export interface ReportDefinition {
@@ -196,6 +233,9 @@ export interface ReportDefinition {
196
233
  */
197
234
  lastUpdatedAt?: Date;
198
235
  }
236
+ /**
237
+ * @public
238
+ */
199
239
  export interface ListReportDefinitionsResult {
200
240
  /**
201
241
  * <p>The retrieved reports.</p>
@@ -206,6 +246,9 @@ export interface ListReportDefinitionsResult {
206
246
  */
207
247
  nextToken?: string;
208
248
  }
249
+ /**
250
+ * @public
251
+ */
209
252
  export interface PutReportDefinitionRequest {
210
253
  /**
211
254
  * <p>Required. ID of the report. You can choose any valid string matching the pattern for the
@@ -230,6 +273,9 @@ export interface PutReportDefinitionRequest {
230
273
  */
231
274
  destinationS3Location: S3Location | undefined;
232
275
  }
276
+ /**
277
+ * @public
278
+ */
233
279
  export interface PutReportDefinitionResult {
234
280
  /**
235
281
  * <p>ID of the report.</p>
@@ -237,6 +283,7 @@ export interface PutReportDefinitionResult {
237
283
  reportId?: string;
238
284
  }
239
285
  /**
286
+ * @public
240
287
  * <p>Your request exceeds one or more of the service quotas.</p>
241
288
  */
242
289
  export declare class ServiceQuotaExceededException extends __BaseException {
@@ -247,6 +294,9 @@ export declare class ServiceQuotaExceededException extends __BaseException {
247
294
  */
248
295
  constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
249
296
  }
297
+ /**
298
+ * @public
299
+ */
250
300
  export interface UpdateReportDefinitionRequest {
251
301
  /**
252
302
  * <p>Required. ID of the report to update.</p>
@@ -270,6 +320,9 @@ export interface UpdateReportDefinitionRequest {
270
320
  */
271
321
  destinationS3Location: S3Location | undefined;
272
322
  }
323
+ /**
324
+ * @public
325
+ */
273
326
  export interface UpdateReportDefinitionResult {
274
327
  /**
275
328
  * <p>ID of the report.</p>
@@ -1,5 +1,8 @@
1
1
  import { PaginationConfiguration } from "@aws-sdk/types";
2
2
  import { ApplicationCostProfilerClient } from "../ApplicationCostProfilerClient";
3
+ /**
4
+ * @public
5
+ */
3
6
  export interface ApplicationCostProfilerPaginationConfiguration extends PaginationConfiguration {
4
7
  client: ApplicationCostProfilerClient;
5
8
  }
@@ -1,4 +1,7 @@
1
1
  import { Paginator } from "@aws-sdk/types";
2
2
  import { ListReportDefinitionsCommandInput, ListReportDefinitionsCommandOutput } from "../commands/ListReportDefinitionsCommand";
3
3
  import { ApplicationCostProfilerPaginationConfiguration } from "./Interfaces";
4
+ /**
5
+ * @public
6
+ */
4
7
  export declare function paginateListReportDefinitions(config: ApplicationCostProfilerPaginationConfiguration, input: ListReportDefinitionsCommandInput, ...additionalArguments: any): Paginator<ListReportDefinitionsCommandOutput>;
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-applicationcostprofiler",
3
3
  "description": "AWS SDK for JavaScript Applicationcostprofiler Client for Node.js, Browser and React Native",
4
- "version": "3.295.0",
4
+ "version": "3.297.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -20,37 +20,37 @@
20
20
  "dependencies": {
21
21
  "@aws-crypto/sha256-browser": "3.0.0",
22
22
  "@aws-crypto/sha256-js": "3.0.0",
23
- "@aws-sdk/client-sts": "3.295.0",
24
- "@aws-sdk/config-resolver": "3.295.0",
25
- "@aws-sdk/credential-provider-node": "3.295.0",
26
- "@aws-sdk/fetch-http-handler": "3.295.0",
27
- "@aws-sdk/hash-node": "3.295.0",
28
- "@aws-sdk/invalid-dependency": "3.295.0",
29
- "@aws-sdk/middleware-content-length": "3.295.0",
30
- "@aws-sdk/middleware-endpoint": "3.295.0",
31
- "@aws-sdk/middleware-host-header": "3.295.0",
32
- "@aws-sdk/middleware-logger": "3.295.0",
33
- "@aws-sdk/middleware-recursion-detection": "3.295.0",
34
- "@aws-sdk/middleware-retry": "3.295.0",
35
- "@aws-sdk/middleware-serde": "3.295.0",
36
- "@aws-sdk/middleware-signing": "3.295.0",
37
- "@aws-sdk/middleware-stack": "3.295.0",
38
- "@aws-sdk/middleware-user-agent": "3.295.0",
39
- "@aws-sdk/node-config-provider": "3.295.0",
40
- "@aws-sdk/node-http-handler": "3.295.0",
41
- "@aws-sdk/protocol-http": "3.295.0",
42
- "@aws-sdk/smithy-client": "3.295.0",
43
- "@aws-sdk/types": "3.295.0",
44
- "@aws-sdk/url-parser": "3.295.0",
23
+ "@aws-sdk/client-sts": "3.297.0",
24
+ "@aws-sdk/config-resolver": "3.296.0",
25
+ "@aws-sdk/credential-provider-node": "3.297.0",
26
+ "@aws-sdk/fetch-http-handler": "3.296.0",
27
+ "@aws-sdk/hash-node": "3.296.0",
28
+ "@aws-sdk/invalid-dependency": "3.296.0",
29
+ "@aws-sdk/middleware-content-length": "3.296.0",
30
+ "@aws-sdk/middleware-endpoint": "3.296.0",
31
+ "@aws-sdk/middleware-host-header": "3.296.0",
32
+ "@aws-sdk/middleware-logger": "3.296.0",
33
+ "@aws-sdk/middleware-recursion-detection": "3.296.0",
34
+ "@aws-sdk/middleware-retry": "3.296.0",
35
+ "@aws-sdk/middleware-serde": "3.296.0",
36
+ "@aws-sdk/middleware-signing": "3.296.0",
37
+ "@aws-sdk/middleware-stack": "3.296.0",
38
+ "@aws-sdk/middleware-user-agent": "3.296.0",
39
+ "@aws-sdk/node-config-provider": "3.296.0",
40
+ "@aws-sdk/node-http-handler": "3.296.0",
41
+ "@aws-sdk/protocol-http": "3.296.0",
42
+ "@aws-sdk/smithy-client": "3.296.0",
43
+ "@aws-sdk/types": "3.296.0",
44
+ "@aws-sdk/url-parser": "3.296.0",
45
45
  "@aws-sdk/util-base64": "3.295.0",
46
46
  "@aws-sdk/util-body-length-browser": "3.295.0",
47
47
  "@aws-sdk/util-body-length-node": "3.295.0",
48
- "@aws-sdk/util-defaults-mode-browser": "3.295.0",
49
- "@aws-sdk/util-defaults-mode-node": "3.295.0",
50
- "@aws-sdk/util-endpoints": "3.295.0",
51
- "@aws-sdk/util-retry": "3.295.0",
52
- "@aws-sdk/util-user-agent-browser": "3.295.0",
53
- "@aws-sdk/util-user-agent-node": "3.295.0",
48
+ "@aws-sdk/util-defaults-mode-browser": "3.296.0",
49
+ "@aws-sdk/util-defaults-mode-node": "3.296.0",
50
+ "@aws-sdk/util-endpoints": "3.296.0",
51
+ "@aws-sdk/util-retry": "3.296.0",
52
+ "@aws-sdk/util-user-agent-browser": "3.296.0",
53
+ "@aws-sdk/util-user-agent-node": "3.296.0",
54
54
  "@aws-sdk/util-utf8": "3.295.0",
55
55
  "tslib": "^2.5.0"
56
56
  },