@aws-sdk/client-freetier 3.458.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.
- package/LICENSE +201 -0
- package/README.md +223 -0
- package/dist-cjs/FreeTier.js +13 -0
- package/dist-cjs/FreeTierClient.js +43 -0
- package/dist-cjs/commands/GetFreeTierUsageCommand.js +50 -0
- package/dist-cjs/commands/index.js +4 -0
- package/dist-cjs/endpoint/EndpointParameters.js +11 -0
- package/dist-cjs/endpoint/endpointResolver.js +12 -0
- package/dist-cjs/endpoint/ruleset.js +7 -0
- package/dist-cjs/extensionConfiguration.js +2 -0
- package/dist-cjs/index.js +12 -0
- package/dist-cjs/models/FreeTierServiceException.js +12 -0
- package/dist-cjs/models/index.js +4 -0
- package/dist-cjs/models/models_0.js +59 -0
- package/dist-cjs/pagination/GetFreeTierUsagePaginator.js +29 -0
- package/dist-cjs/pagination/Interfaces.js +2 -0
- package/dist-cjs/pagination/index.js +5 -0
- package/dist-cjs/protocols/Aws_json1_0.js +202 -0
- package/dist-cjs/runtimeConfig.browser.js +39 -0
- package/dist-cjs/runtimeConfig.js +50 -0
- package/dist-cjs/runtimeConfig.native.js +15 -0
- package/dist-cjs/runtimeConfig.shared.js +24 -0
- package/dist-cjs/runtimeExtensions.js +22 -0
- package/dist-es/FreeTier.js +9 -0
- package/dist-es/FreeTierClient.js +39 -0
- package/dist-es/commands/GetFreeTierUsageCommand.js +46 -0
- package/dist-es/commands/index.js +1 -0
- package/dist-es/endpoint/EndpointParameters.js +7 -0
- package/dist-es/endpoint/endpointResolver.js +8 -0
- package/dist-es/endpoint/ruleset.js +4 -0
- package/dist-es/extensionConfiguration.js +1 -0
- package/dist-es/index.js +7 -0
- package/dist-es/models/FreeTierServiceException.js +8 -0
- package/dist-es/models/index.js +1 -0
- package/dist-es/models/models_0.js +53 -0
- package/dist-es/pagination/GetFreeTierUsagePaginator.js +25 -0
- package/dist-es/pagination/Interfaces.js +1 -0
- package/dist-es/pagination/index.js +2 -0
- package/dist-es/protocols/Aws_json1_0.js +197 -0
- package/dist-es/runtimeConfig.browser.js +34 -0
- package/dist-es/runtimeConfig.js +45 -0
- package/dist-es/runtimeConfig.native.js +11 -0
- package/dist-es/runtimeConfig.shared.js +20 -0
- package/dist-es/runtimeExtensions.js +18 -0
- package/dist-types/FreeTier.d.ts +27 -0
- package/dist-types/FreeTierClient.d.ts +180 -0
- package/dist-types/commands/GetFreeTierUsageCommand.d.ts +132 -0
- package/dist-types/commands/index.d.ts +1 -0
- package/dist-types/endpoint/EndpointParameters.d.ts +20 -0
- package/dist-types/endpoint/endpointResolver.d.ts +5 -0
- package/dist-types/endpoint/ruleset.d.ts +2 -0
- package/dist-types/extensionConfiguration.d.ts +8 -0
- package/dist-types/index.d.ts +25 -0
- package/dist-types/models/FreeTierServiceException.d.ts +13 -0
- package/dist-types/models/index.d.ts +1 -0
- package/dist-types/models/models_0.d.ts +254 -0
- package/dist-types/pagination/GetFreeTierUsagePaginator.d.ts +7 -0
- package/dist-types/pagination/Interfaces.d.ts +8 -0
- package/dist-types/pagination/index.d.ts +2 -0
- package/dist-types/protocols/Aws_json1_0.d.ts +11 -0
- package/dist-types/runtimeConfig.browser.d.ts +46 -0
- package/dist-types/runtimeConfig.d.ts +46 -0
- package/dist-types/runtimeConfig.native.d.ts +45 -0
- package/dist-types/runtimeConfig.shared.d.ts +19 -0
- package/dist-types/runtimeExtensions.d.ts +17 -0
- package/dist-types/ts3.4/FreeTier.d.ts +22 -0
- package/dist-types/ts3.4/FreeTierClient.d.ts +122 -0
- package/dist-types/ts3.4/commands/GetFreeTierUsageCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/index.d.ts +1 -0
- package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +31 -0
- package/dist-types/ts3.4/endpoint/endpointResolver.d.ts +8 -0
- package/dist-types/ts3.4/endpoint/ruleset.d.ts +2 -0
- package/dist-types/ts3.4/extensionConfiguration.d.ts +7 -0
- package/dist-types/ts3.4/index.d.ts +10 -0
- package/dist-types/ts3.4/models/FreeTierServiceException.d.ts +8 -0
- package/dist-types/ts3.4/models/index.d.ts +1 -0
- package/dist-types/ts3.4/models/models_0.d.ts +73 -0
- package/dist-types/ts3.4/pagination/GetFreeTierUsagePaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/Interfaces.d.ts +6 -0
- package/dist-types/ts3.4/pagination/index.d.ts +2 -0
- package/dist-types/ts3.4/protocols/Aws_json1_0.d.ts +17 -0
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +97 -0
- package/dist-types/ts3.4/runtimeConfig.d.ts +97 -0
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +88 -0
- package/dist-types/ts3.4/runtimeConfig.shared.d.ts +19 -0
- package/dist-types/ts3.4/runtimeExtensions.d.ts +11 -0
- package/package.json +102 -0
|
@@ -0,0 +1,132 @@
|
|
|
1
|
+
import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
|
|
2
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
3
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
|
|
4
|
+
import { FreeTierClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../FreeTierClient";
|
|
5
|
+
import { GetFreeTierUsageRequest, GetFreeTierUsageResponse } from "../models/models_0";
|
|
6
|
+
/**
|
|
7
|
+
* @public
|
|
8
|
+
*/
|
|
9
|
+
export { __MetadataBearer, $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link GetFreeTierUsageCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetFreeTierUsageCommandInput extends GetFreeTierUsageRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetFreeTierUsageCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetFreeTierUsageCommandOutput extends GetFreeTierUsageResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* @public
|
|
26
|
+
* <p>Returns a list of all Free Tier usage objects that match your filters.</p>
|
|
27
|
+
* @example
|
|
28
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
29
|
+
* ```javascript
|
|
30
|
+
* import { FreeTierClient, GetFreeTierUsageCommand } from "@aws-sdk/client-freetier"; // ES Modules import
|
|
31
|
+
* // const { FreeTierClient, GetFreeTierUsageCommand } = require("@aws-sdk/client-freetier"); // CommonJS import
|
|
32
|
+
* const client = new FreeTierClient(config);
|
|
33
|
+
* const input = { // GetFreeTierUsageRequest
|
|
34
|
+
* filter: { // Expression
|
|
35
|
+
* Or: [ // Expressions
|
|
36
|
+
* {
|
|
37
|
+
* Or: [
|
|
38
|
+
* "<Expression>",
|
|
39
|
+
* ],
|
|
40
|
+
* And: [
|
|
41
|
+
* "<Expression>",
|
|
42
|
+
* ],
|
|
43
|
+
* Not: "<Expression>",
|
|
44
|
+
* Dimensions: { // DimensionValues
|
|
45
|
+
* Key: "SERVICE" || "OPERATION" || "USAGE_TYPE" || "REGION" || "FREE_TIER_TYPE" || "DESCRIPTION" || "USAGE_PERCENTAGE", // required
|
|
46
|
+
* Values: [ // Values // required
|
|
47
|
+
* "STRING_VALUE",
|
|
48
|
+
* ],
|
|
49
|
+
* MatchOptions: [ // MatchOptions // required
|
|
50
|
+
* "EQUALS" || "STARTS_WITH" || "ENDS_WITH" || "CONTAINS" || "GREATER_THAN_OR_EQUAL",
|
|
51
|
+
* ],
|
|
52
|
+
* },
|
|
53
|
+
* },
|
|
54
|
+
* ],
|
|
55
|
+
* And: [
|
|
56
|
+
* "<Expression>",
|
|
57
|
+
* ],
|
|
58
|
+
* Not: "<Expression>",
|
|
59
|
+
* Dimensions: {
|
|
60
|
+
* Key: "SERVICE" || "OPERATION" || "USAGE_TYPE" || "REGION" || "FREE_TIER_TYPE" || "DESCRIPTION" || "USAGE_PERCENTAGE", // required
|
|
61
|
+
* Values: [ // required
|
|
62
|
+
* "STRING_VALUE",
|
|
63
|
+
* ],
|
|
64
|
+
* MatchOptions: [ // required
|
|
65
|
+
* "EQUALS" || "STARTS_WITH" || "ENDS_WITH" || "CONTAINS" || "GREATER_THAN_OR_EQUAL",
|
|
66
|
+
* ],
|
|
67
|
+
* },
|
|
68
|
+
* },
|
|
69
|
+
* maxResults: Number("int"),
|
|
70
|
+
* nextToken: "STRING_VALUE",
|
|
71
|
+
* };
|
|
72
|
+
* const command = new GetFreeTierUsageCommand(input);
|
|
73
|
+
* const response = await client.send(command);
|
|
74
|
+
* // { // GetFreeTierUsageResponse
|
|
75
|
+
* // freeTierUsages: [ // FreeTierUsages // required
|
|
76
|
+
* // { // FreeTierUsage
|
|
77
|
+
* // service: "STRING_VALUE",
|
|
78
|
+
* // operation: "STRING_VALUE",
|
|
79
|
+
* // usageType: "STRING_VALUE",
|
|
80
|
+
* // region: "STRING_VALUE",
|
|
81
|
+
* // actualUsageAmount: Number("double"),
|
|
82
|
+
* // forecastedUsageAmount: Number("double"),
|
|
83
|
+
* // limit: Number("double"),
|
|
84
|
+
* // unit: "STRING_VALUE",
|
|
85
|
+
* // description: "STRING_VALUE",
|
|
86
|
+
* // freeTierType: "STRING_VALUE",
|
|
87
|
+
* // },
|
|
88
|
+
* // ],
|
|
89
|
+
* // nextToken: "STRING_VALUE",
|
|
90
|
+
* // };
|
|
91
|
+
*
|
|
92
|
+
* ```
|
|
93
|
+
*
|
|
94
|
+
* @param GetFreeTierUsageCommandInput - {@link GetFreeTierUsageCommandInput}
|
|
95
|
+
* @returns {@link GetFreeTierUsageCommandOutput}
|
|
96
|
+
* @see {@link GetFreeTierUsageCommandInput} for command's `input` shape.
|
|
97
|
+
* @see {@link GetFreeTierUsageCommandOutput} for command's `response` shape.
|
|
98
|
+
* @see {@link FreeTierClientResolvedConfig | config} for FreeTierClient's `config` shape.
|
|
99
|
+
*
|
|
100
|
+
* @throws {@link InternalServerException} (server fault)
|
|
101
|
+
* <p>An unexpected error occurred during the processing of your request.</p>
|
|
102
|
+
*
|
|
103
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
104
|
+
* <p>The request was denied due to request throttling.</p>
|
|
105
|
+
*
|
|
106
|
+
* @throws {@link ValidationException} (client fault)
|
|
107
|
+
* <p>The input fails to satisfy the constraints specified by an Amazon Web Service.</p>
|
|
108
|
+
*
|
|
109
|
+
* @throws {@link FreeTierServiceException}
|
|
110
|
+
* <p>Base exception class for all service exceptions from FreeTier service.</p>
|
|
111
|
+
*
|
|
112
|
+
*/
|
|
113
|
+
export declare class GetFreeTierUsageCommand extends $Command<GetFreeTierUsageCommandInput, GetFreeTierUsageCommandOutput, FreeTierClientResolvedConfig> {
|
|
114
|
+
readonly input: GetFreeTierUsageCommandInput;
|
|
115
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
116
|
+
/**
|
|
117
|
+
* @public
|
|
118
|
+
*/
|
|
119
|
+
constructor(input: GetFreeTierUsageCommandInput);
|
|
120
|
+
/**
|
|
121
|
+
* @internal
|
|
122
|
+
*/
|
|
123
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: FreeTierClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetFreeTierUsageCommandInput, GetFreeTierUsageCommandOutput>;
|
|
124
|
+
/**
|
|
125
|
+
* @internal
|
|
126
|
+
*/
|
|
127
|
+
private serialize;
|
|
128
|
+
/**
|
|
129
|
+
* @internal
|
|
130
|
+
*/
|
|
131
|
+
private deserialize;
|
|
132
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export * from "./GetFreeTierUsageCommand";
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
import { Endpoint, EndpointParameters as __EndpointParameters, EndpointV2, Provider } from "@smithy/types";
|
|
2
|
+
/**
|
|
3
|
+
* @public
|
|
4
|
+
*/
|
|
5
|
+
export interface ClientInputEndpointParameters {
|
|
6
|
+
region?: string | Provider<string>;
|
|
7
|
+
useFipsEndpoint?: boolean | Provider<boolean>;
|
|
8
|
+
endpoint?: string | Provider<string> | Endpoint | Provider<Endpoint> | EndpointV2 | Provider<EndpointV2>;
|
|
9
|
+
}
|
|
10
|
+
export type ClientResolvedEndpointParameters = ClientInputEndpointParameters & {
|
|
11
|
+
defaultSigningName: string;
|
|
12
|
+
};
|
|
13
|
+
export declare const resolveClientEndpointParameters: <T>(options: T & ClientInputEndpointParameters) => T & ClientInputEndpointParameters & {
|
|
14
|
+
defaultSigningName: string;
|
|
15
|
+
};
|
|
16
|
+
export interface EndpointParameters extends __EndpointParameters {
|
|
17
|
+
Region?: string;
|
|
18
|
+
UseFIPS?: boolean;
|
|
19
|
+
Endpoint?: string;
|
|
20
|
+
}
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
import { AwsRegionExtensionConfiguration } from "@aws-sdk/types";
|
|
2
|
+
import { HttpHandlerExtensionConfiguration } from "@smithy/protocol-http";
|
|
3
|
+
import { DefaultExtensionConfiguration } from "@smithy/types";
|
|
4
|
+
/**
|
|
5
|
+
* @internal
|
|
6
|
+
*/
|
|
7
|
+
export interface FreeTierExtensionConfiguration extends HttpHandlerExtensionConfiguration, DefaultExtensionConfiguration, AwsRegionExtensionConfiguration {
|
|
8
|
+
}
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* <p>You can use the Amazon Web Services Free Tier API to query programmatically your Free Tier usage data.</p>
|
|
3
|
+
* <p>Free Tier tracks your monthly usage data for all free tier offers that are associated with your
|
|
4
|
+
* Amazon Web Services account. You can use the Free Tier API to filter and show only the data that you want.</p>
|
|
5
|
+
* <p>Service endpoint</p>
|
|
6
|
+
* <p>The Free Tier API provides the following endpoint:</p>
|
|
7
|
+
* <ul>
|
|
8
|
+
* <li>
|
|
9
|
+
* <p>https://freetier.us-east-1.api.aws</p>
|
|
10
|
+
* </li>
|
|
11
|
+
* </ul>
|
|
12
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/billing-free-tier.html">Using the Amazon Web Services Free Tier</a> in the <i>Billing User Guide</i>.</p>
|
|
13
|
+
*
|
|
14
|
+
* @packageDocumentation
|
|
15
|
+
*/
|
|
16
|
+
export * from "./FreeTierClient";
|
|
17
|
+
export * from "./FreeTier";
|
|
18
|
+
export { ClientInputEndpointParameters } from "./endpoint/EndpointParameters";
|
|
19
|
+
export { RuntimeExtension } from "./runtimeExtensions";
|
|
20
|
+
export { FreeTierExtensionConfiguration } from "./extensionConfiguration";
|
|
21
|
+
export * from "./commands";
|
|
22
|
+
export * from "./pagination";
|
|
23
|
+
export * from "./models";
|
|
24
|
+
import "@aws-sdk/util-endpoints";
|
|
25
|
+
export { FreeTierServiceException } from "./models/FreeTierServiceException";
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
import { ServiceException as __ServiceException, ServiceExceptionOptions as __ServiceExceptionOptions } from "@smithy/smithy-client";
|
|
2
|
+
export { __ServiceException, __ServiceExceptionOptions };
|
|
3
|
+
/**
|
|
4
|
+
* @public
|
|
5
|
+
*
|
|
6
|
+
* Base exception class for all service exceptions from FreeTier service.
|
|
7
|
+
*/
|
|
8
|
+
export declare class FreeTierServiceException extends __ServiceException {
|
|
9
|
+
/**
|
|
10
|
+
* @internal
|
|
11
|
+
*/
|
|
12
|
+
constructor(options: __ServiceExceptionOptions);
|
|
13
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export * from "./models_0";
|
|
@@ -0,0 +1,254 @@
|
|
|
1
|
+
import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
|
|
2
|
+
import { FreeTierServiceException as __BaseException } from "./FreeTierServiceException";
|
|
3
|
+
/**
|
|
4
|
+
* @public
|
|
5
|
+
* @enum
|
|
6
|
+
*/
|
|
7
|
+
export declare const Dimension: {
|
|
8
|
+
readonly DESCRIPTION: "DESCRIPTION";
|
|
9
|
+
readonly FREE_TIER_TYPE: "FREE_TIER_TYPE";
|
|
10
|
+
readonly OPERATION: "OPERATION";
|
|
11
|
+
readonly REGION: "REGION";
|
|
12
|
+
readonly SERVICE: "SERVICE";
|
|
13
|
+
readonly USAGE_PERCENTAGE: "USAGE_PERCENTAGE";
|
|
14
|
+
readonly USAGE_TYPE: "USAGE_TYPE";
|
|
15
|
+
};
|
|
16
|
+
/**
|
|
17
|
+
* @public
|
|
18
|
+
*/
|
|
19
|
+
export type Dimension = (typeof Dimension)[keyof typeof Dimension];
|
|
20
|
+
/**
|
|
21
|
+
* @public
|
|
22
|
+
* @enum
|
|
23
|
+
*/
|
|
24
|
+
export declare const MatchOption: {
|
|
25
|
+
readonly CONTAINS: "CONTAINS";
|
|
26
|
+
readonly ENDS_WITH: "ENDS_WITH";
|
|
27
|
+
readonly EQUALS: "EQUALS";
|
|
28
|
+
readonly GREATER_THAN_OR_EQUAL: "GREATER_THAN_OR_EQUAL";
|
|
29
|
+
readonly STARTS_WITH: "STARTS_WITH";
|
|
30
|
+
};
|
|
31
|
+
/**
|
|
32
|
+
* @public
|
|
33
|
+
*/
|
|
34
|
+
export type MatchOption = (typeof MatchOption)[keyof typeof MatchOption];
|
|
35
|
+
/**
|
|
36
|
+
* @public
|
|
37
|
+
* <p>Contains the specifications for the filters to use for your request.</p>
|
|
38
|
+
*/
|
|
39
|
+
export interface DimensionValues {
|
|
40
|
+
/**
|
|
41
|
+
* @public
|
|
42
|
+
* <p>The name of the dimension that you want to filter on.</p>
|
|
43
|
+
*/
|
|
44
|
+
Key: Dimension | undefined;
|
|
45
|
+
/**
|
|
46
|
+
* @public
|
|
47
|
+
* <p>The metadata values you can specify to filter upon, so that the results all match at least
|
|
48
|
+
* one of the specified values.</p>
|
|
49
|
+
*/
|
|
50
|
+
Values: string[] | undefined;
|
|
51
|
+
/**
|
|
52
|
+
* @public
|
|
53
|
+
* <p>The match options that you can use to filter your results. You can specify only one of
|
|
54
|
+
* these values in the array.</p>
|
|
55
|
+
*/
|
|
56
|
+
MatchOptions: MatchOption[] | undefined;
|
|
57
|
+
}
|
|
58
|
+
/**
|
|
59
|
+
* @public
|
|
60
|
+
* <p>Consists of a Amazon Web Services Free Tier offer’s metadata and your data usage for the offer.</p>
|
|
61
|
+
*/
|
|
62
|
+
export interface FreeTierUsage {
|
|
63
|
+
/**
|
|
64
|
+
* @public
|
|
65
|
+
* <p>The name of the Amazon Web Service providing the Free Tier offer. For example, this can be
|
|
66
|
+
* Amazon Elastic Compute Cloud.</p>
|
|
67
|
+
*/
|
|
68
|
+
service?: string;
|
|
69
|
+
/**
|
|
70
|
+
* @public
|
|
71
|
+
* <p>Describes <code>usageType</code> more granularly with the specific Amazon Web Service API
|
|
72
|
+
* operation. For example, this can be the <code>RunInstances</code> API operation for
|
|
73
|
+
* Amazon Elastic Compute Cloud.</p>
|
|
74
|
+
*/
|
|
75
|
+
operation?: string;
|
|
76
|
+
/**
|
|
77
|
+
* @public
|
|
78
|
+
* <p>Describes the usage details of the offer. For example, this might be
|
|
79
|
+
* <code>Global-BoxUsage:freetrial</code>.</p>
|
|
80
|
+
*/
|
|
81
|
+
usageType?: string;
|
|
82
|
+
/**
|
|
83
|
+
* @public
|
|
84
|
+
* <p>Describes the Amazon Web Services Region for which this offer is applicable</p>
|
|
85
|
+
*/
|
|
86
|
+
region?: string;
|
|
87
|
+
/**
|
|
88
|
+
* @public
|
|
89
|
+
* <p>Describes the actual usage accrued month-to-day (MTD) that you've used so far.</p>
|
|
90
|
+
*/
|
|
91
|
+
actualUsageAmount?: number;
|
|
92
|
+
/**
|
|
93
|
+
* @public
|
|
94
|
+
* <p>Describes the forecasted usage by the month that you're expected to use.</p>
|
|
95
|
+
*/
|
|
96
|
+
forecastedUsageAmount?: number;
|
|
97
|
+
/**
|
|
98
|
+
* @public
|
|
99
|
+
* <p>Describes the maximum usage allowed in Free Tier.</p>
|
|
100
|
+
*/
|
|
101
|
+
limit?: number;
|
|
102
|
+
/**
|
|
103
|
+
* @public
|
|
104
|
+
* <p>Describes the unit of the <code>usageType</code>, such as <code>Hrs</code>.</p>
|
|
105
|
+
*/
|
|
106
|
+
unit?: string;
|
|
107
|
+
/**
|
|
108
|
+
* @public
|
|
109
|
+
* <p>The description of the Free Tier offer.</p>
|
|
110
|
+
*/
|
|
111
|
+
description?: string;
|
|
112
|
+
/**
|
|
113
|
+
* @public
|
|
114
|
+
* <p>Describes the type of the Free Tier offer. For example, the offer can be <code>"12 Months
|
|
115
|
+
* Free"</code>, <code>"Always Free"</code>, and <code>"Free Trial"</code>.</p>
|
|
116
|
+
*/
|
|
117
|
+
freeTierType?: string;
|
|
118
|
+
}
|
|
119
|
+
/**
|
|
120
|
+
* @public
|
|
121
|
+
*/
|
|
122
|
+
export interface GetFreeTierUsageResponse {
|
|
123
|
+
/**
|
|
124
|
+
* @public
|
|
125
|
+
* <p>The list of Free Tier usage objects that meet your filter expression.</p>
|
|
126
|
+
*/
|
|
127
|
+
freeTierUsages: FreeTierUsage[] | undefined;
|
|
128
|
+
/**
|
|
129
|
+
* @public
|
|
130
|
+
* <p>The pagination token that indicates the next set of results to retrieve.</p>
|
|
131
|
+
*/
|
|
132
|
+
nextToken?: string;
|
|
133
|
+
}
|
|
134
|
+
/**
|
|
135
|
+
* @public
|
|
136
|
+
* <p>An unexpected error occurred during the processing of your request.</p>
|
|
137
|
+
*/
|
|
138
|
+
export declare class InternalServerException extends __BaseException {
|
|
139
|
+
readonly name: "InternalServerException";
|
|
140
|
+
readonly $fault: "server";
|
|
141
|
+
/**
|
|
142
|
+
* @internal
|
|
143
|
+
*/
|
|
144
|
+
constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
|
|
145
|
+
}
|
|
146
|
+
/**
|
|
147
|
+
* @public
|
|
148
|
+
* <p>The request was denied due to request throttling.</p>
|
|
149
|
+
*/
|
|
150
|
+
export declare class ThrottlingException extends __BaseException {
|
|
151
|
+
readonly name: "ThrottlingException";
|
|
152
|
+
readonly $fault: "client";
|
|
153
|
+
/**
|
|
154
|
+
* @internal
|
|
155
|
+
*/
|
|
156
|
+
constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
|
|
157
|
+
}
|
|
158
|
+
/**
|
|
159
|
+
* @public
|
|
160
|
+
* <p>The input fails to satisfy the constraints specified by an Amazon Web Service.</p>
|
|
161
|
+
*/
|
|
162
|
+
export declare class ValidationException extends __BaseException {
|
|
163
|
+
readonly name: "ValidationException";
|
|
164
|
+
readonly $fault: "client";
|
|
165
|
+
/**
|
|
166
|
+
* @internal
|
|
167
|
+
*/
|
|
168
|
+
constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
|
|
169
|
+
}
|
|
170
|
+
/**
|
|
171
|
+
* @public
|
|
172
|
+
* <p>Use <code>Expression</code> to filter in the <code>GetFreeTierUsage</code> API operation.</p>
|
|
173
|
+
* <p>You can use the following patterns:</p>
|
|
174
|
+
* <ul>
|
|
175
|
+
* <li>
|
|
176
|
+
* <p>Simple dimension values (<code>Dimensions</code> root operator)</p>
|
|
177
|
+
* </li>
|
|
178
|
+
* <li>
|
|
179
|
+
* <p>Complex expressions with logical operators (<code>AND</code>, <code>NOT</code>, and
|
|
180
|
+
* <code>OR</code> root operators).</p>
|
|
181
|
+
* </li>
|
|
182
|
+
* </ul>
|
|
183
|
+
* <p>For <i>simple dimension values</i>, you can set the dimension name, values,
|
|
184
|
+
* and match type for the filters that you plan to use.</p>
|
|
185
|
+
* <p>
|
|
186
|
+
* <b>Example for simple dimension values</b>
|
|
187
|
+
* </p>
|
|
188
|
+
* <p>You can filter to match exactly for <code>REGION==us-east-1 OR
|
|
189
|
+
* REGION==us-west-1</code>.</p>
|
|
190
|
+
* <p>The corresponding <code>Expression</code> appears like the following: <code>\{ "Dimensions": \{ "Key": "REGION", "Values": [ "us-east-1", "us-west-1" ], "MatchOptions": ["EQUALS"] \} \}</code>
|
|
191
|
+
* </p>
|
|
192
|
+
* <p>As shown in the previous example, lists of dimension values are combined with <code>OR</code> when
|
|
193
|
+
* you apply the filter.</p>
|
|
194
|
+
* <p>For <i>complex expressions with logical operators</i>, you can have nested
|
|
195
|
+
* expressions to use the logical operators and specify advanced filtering.</p>
|
|
196
|
+
* <p>
|
|
197
|
+
* <b>Example for complex expressions with logical operators</b>
|
|
198
|
+
* </p>
|
|
199
|
+
* <p>You can filter by <code>((REGION == us-east-1 OR REGION == us-west-1) OR (SERVICE CONTAINS
|
|
200
|
+
* AWSLambda)) AND (USAGE_TYPE !CONTAINS DataTransfer)</code>.</p>
|
|
201
|
+
* <p>The corresponding <code>Expression</code> appears like the following: <code>\{ "And": [
|
|
202
|
+
* \{"Or": [ \{"Dimensions": \{ "Key": "REGION", "Values": [ "us-east-1", "us-west-1" ],
|
|
203
|
+
* "MatchOptions": ["EQUALS"] \}\}, \{"Dimensions": \{ "Key": "SERVICE", "Values": ["AWSLambda"], "MatchOptions": ["CONTAINS"] \} \} ]\}, \{"Not": \{"Dimensions": \{ "Key": "USAGE_TYPE", "Values": ["DataTransfer"], "MatchOptions": ["CONTAINS"] \}\}\} ] \}</code>
|
|
204
|
+
* </p>
|
|
205
|
+
* <p>In the following <b>Contents</b>, you must specify exactly one of the
|
|
206
|
+
* following root operators.</p>
|
|
207
|
+
*/
|
|
208
|
+
export interface Expression {
|
|
209
|
+
/**
|
|
210
|
+
* @public
|
|
211
|
+
* <p>Return results that match any of the <code>Expressions</code> that you specified. in the
|
|
212
|
+
* array.</p>
|
|
213
|
+
*/
|
|
214
|
+
Or?: Expression[];
|
|
215
|
+
/**
|
|
216
|
+
* @public
|
|
217
|
+
* <p>Return results that match all <code>Expressions</code> that you specified in the
|
|
218
|
+
* array.</p>
|
|
219
|
+
*/
|
|
220
|
+
And?: Expression[];
|
|
221
|
+
/**
|
|
222
|
+
* @public
|
|
223
|
+
* <p>Return results that don’t match the <code>Expression</code> that you specified.</p>
|
|
224
|
+
*/
|
|
225
|
+
Not?: Expression;
|
|
226
|
+
/**
|
|
227
|
+
* @public
|
|
228
|
+
* <p>The specific dimension, values, and match type to filter objects with.</p>
|
|
229
|
+
*/
|
|
230
|
+
Dimensions?: DimensionValues;
|
|
231
|
+
}
|
|
232
|
+
/**
|
|
233
|
+
* @public
|
|
234
|
+
*/
|
|
235
|
+
export interface GetFreeTierUsageRequest {
|
|
236
|
+
/**
|
|
237
|
+
* @public
|
|
238
|
+
* <p>An expression that specifies the conditions that you want each <code>FreeTierUsage</code> object
|
|
239
|
+
* to meet.</p>
|
|
240
|
+
*/
|
|
241
|
+
filter?: Expression;
|
|
242
|
+
/**
|
|
243
|
+
* @public
|
|
244
|
+
* <p>The maximum number of results to return in the response. <code>MaxResults</code> means
|
|
245
|
+
* that there can be up to the specified number of values, but there might be fewer results based
|
|
246
|
+
* on your filters.</p>
|
|
247
|
+
*/
|
|
248
|
+
maxResults?: number;
|
|
249
|
+
/**
|
|
250
|
+
* @public
|
|
251
|
+
* <p>The pagination token that indicates the next set of results to retrieve.</p>
|
|
252
|
+
*/
|
|
253
|
+
nextToken?: string;
|
|
254
|
+
}
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import { Paginator } from "@smithy/types";
|
|
2
|
+
import { GetFreeTierUsageCommandInput, GetFreeTierUsageCommandOutput } from "../commands/GetFreeTierUsageCommand";
|
|
3
|
+
import { FreeTierPaginationConfiguration } from "./Interfaces";
|
|
4
|
+
/**
|
|
5
|
+
* @public
|
|
6
|
+
*/
|
|
7
|
+
export declare function paginateGetFreeTierUsage(config: FreeTierPaginationConfiguration, input: GetFreeTierUsageCommandInput, ...additionalArguments: any): Paginator<GetFreeTierUsageCommandOutput>;
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@smithy/protocol-http";
|
|
2
|
+
import { SerdeContext as __SerdeContext } from "@smithy/types";
|
|
3
|
+
import { GetFreeTierUsageCommandInput, GetFreeTierUsageCommandOutput } from "../commands/GetFreeTierUsageCommand";
|
|
4
|
+
/**
|
|
5
|
+
* serializeAws_json1_0GetFreeTierUsageCommand
|
|
6
|
+
*/
|
|
7
|
+
export declare const se_GetFreeTierUsageCommand: (input: GetFreeTierUsageCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
8
|
+
/**
|
|
9
|
+
* deserializeAws_json1_0GetFreeTierUsageCommand
|
|
10
|
+
*/
|
|
11
|
+
export declare const de_GetFreeTierUsageCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<GetFreeTierUsageCommandOutput>;
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
import { FetchHttpHandler as RequestHandler } from "@smithy/fetch-http-handler";
|
|
2
|
+
import { FreeTierClientConfig } from "./FreeTierClient";
|
|
3
|
+
/**
|
|
4
|
+
* @internal
|
|
5
|
+
*/
|
|
6
|
+
export declare const getRuntimeConfig: (config: FreeTierClientConfig) => {
|
|
7
|
+
runtime: string;
|
|
8
|
+
defaultsMode: import("@smithy/types").Provider<import("@smithy/smithy-client").ResolvedDefaultsMode>;
|
|
9
|
+
bodyLengthChecker: import("@smithy/types").BodyLengthCalculator;
|
|
10
|
+
credentialDefaultProvider: (input: any) => import("@smithy/types").Provider<import("@aws-sdk/types").Credentials>;
|
|
11
|
+
defaultUserAgentProvider: import("@smithy/types").Provider<import("@smithy/types").UserAgent>;
|
|
12
|
+
maxAttempts: number | import("@smithy/types").Provider<number>;
|
|
13
|
+
region: string | import("@smithy/types").Provider<any>;
|
|
14
|
+
requestHandler: (import("@smithy/types").RequestHandler<any, any, import("@smithy/types").HttpHandlerOptions> & import("@smithy/types").RequestHandler<import("@smithy/protocol-http").HttpRequest, import("@smithy/protocol-http").HttpResponse, import("@smithy/types").HttpHandlerOptions> & {
|
|
15
|
+
updateHttpClientConfig(key: never, value: never): void;
|
|
16
|
+
httpHandlerConfigs(): {};
|
|
17
|
+
}) | RequestHandler;
|
|
18
|
+
retryMode: string | import("@smithy/types").Provider<string>;
|
|
19
|
+
sha256: import("@smithy/types").HashConstructor;
|
|
20
|
+
streamCollector: import("@smithy/types").StreamCollector;
|
|
21
|
+
useDualstackEndpoint: boolean | import("@smithy/types").Provider<boolean>;
|
|
22
|
+
useFipsEndpoint: boolean | import("@smithy/types").Provider<boolean>;
|
|
23
|
+
apiVersion: string;
|
|
24
|
+
urlParser: import("@smithy/types").UrlParser;
|
|
25
|
+
base64Decoder: import("@smithy/types").Decoder;
|
|
26
|
+
base64Encoder: import("@smithy/types").Encoder;
|
|
27
|
+
utf8Decoder: import("@smithy/types").Decoder;
|
|
28
|
+
utf8Encoder: import("@smithy/types").Encoder;
|
|
29
|
+
disableHostPrefix: boolean;
|
|
30
|
+
serviceId: string;
|
|
31
|
+
logger: import("@smithy/types").Logger;
|
|
32
|
+
extensions: import("./runtimeExtensions").RuntimeExtension[];
|
|
33
|
+
endpoint?: ((string | import("@smithy/types").Endpoint | import("@smithy/types").Provider<import("@smithy/types").Endpoint> | import("@smithy/types").EndpointV2 | import("@smithy/types").Provider<import("@smithy/types").EndpointV2>) & (string | import("@smithy/types").Provider<string> | import("@smithy/types").Endpoint | import("@smithy/types").Provider<import("@smithy/types").Endpoint> | import("@smithy/types").EndpointV2 | import("@smithy/types").Provider<import("@smithy/types").EndpointV2>)) | undefined;
|
|
34
|
+
endpointProvider: (endpointParams: import("./endpoint/EndpointParameters").EndpointParameters, context?: {
|
|
35
|
+
logger?: import("@smithy/types").Logger | undefined;
|
|
36
|
+
}) => import("@smithy/types").EndpointV2;
|
|
37
|
+
tls?: boolean | undefined;
|
|
38
|
+
retryStrategy?: import("@smithy/types").RetryStrategy | import("@smithy/types").RetryStrategyV2 | undefined;
|
|
39
|
+
credentials?: import("@smithy/types").AwsCredentialIdentity | import("@smithy/types").Provider<import("@smithy/types").AwsCredentialIdentity> | undefined;
|
|
40
|
+
signer?: import("@smithy/types").RequestSigner | ((authScheme?: import("@smithy/types").AuthScheme | undefined) => Promise<import("@smithy/types").RequestSigner>) | undefined;
|
|
41
|
+
signingEscapePath?: boolean | undefined;
|
|
42
|
+
systemClockOffset?: number | undefined;
|
|
43
|
+
signingRegion?: string | undefined;
|
|
44
|
+
signerConstructor?: (new (options: import("@smithy/signature-v4").SignatureV4Init & import("@smithy/signature-v4").SignatureV4CryptoInit) => import("@smithy/types").RequestSigner) | undefined;
|
|
45
|
+
customUserAgent?: string | import("@smithy/types").UserAgent | undefined;
|
|
46
|
+
};
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
import { NodeHttpHandler as RequestHandler } from "@smithy/node-http-handler";
|
|
2
|
+
import { FreeTierClientConfig } from "./FreeTierClient";
|
|
3
|
+
/**
|
|
4
|
+
* @internal
|
|
5
|
+
*/
|
|
6
|
+
export declare const getRuntimeConfig: (config: FreeTierClientConfig) => {
|
|
7
|
+
runtime: string;
|
|
8
|
+
defaultsMode: import("@smithy/types").Provider<import("@smithy/smithy-client").ResolvedDefaultsMode>;
|
|
9
|
+
bodyLengthChecker: import("@smithy/types").BodyLengthCalculator;
|
|
10
|
+
credentialDefaultProvider: (input: any) => import("@smithy/types").Provider<import("@aws-sdk/types").Credentials>;
|
|
11
|
+
defaultUserAgentProvider: import("@smithy/types").Provider<import("@smithy/types").UserAgent>;
|
|
12
|
+
maxAttempts: number | import("@smithy/types").Provider<number>;
|
|
13
|
+
region: string | import("@smithy/types").Provider<string>;
|
|
14
|
+
requestHandler: (import("@smithy/types").RequestHandler<any, any, import("@smithy/types").HttpHandlerOptions> & import("@smithy/types").RequestHandler<import("@smithy/protocol-http").HttpRequest, import("@smithy/protocol-http").HttpResponse, import("@smithy/types").HttpHandlerOptions> & {
|
|
15
|
+
updateHttpClientConfig(key: never, value: never): void;
|
|
16
|
+
httpHandlerConfigs(): {};
|
|
17
|
+
}) | RequestHandler;
|
|
18
|
+
retryMode: string | import("@smithy/types").Provider<string>;
|
|
19
|
+
sha256: import("@smithy/types").HashConstructor;
|
|
20
|
+
streamCollector: import("@smithy/types").StreamCollector;
|
|
21
|
+
useDualstackEndpoint: boolean | import("@smithy/types").Provider<boolean>;
|
|
22
|
+
useFipsEndpoint: boolean | import("@smithy/types").Provider<boolean>;
|
|
23
|
+
apiVersion: string;
|
|
24
|
+
urlParser: import("@smithy/types").UrlParser;
|
|
25
|
+
base64Decoder: import("@smithy/types").Decoder;
|
|
26
|
+
base64Encoder: import("@smithy/types").Encoder;
|
|
27
|
+
utf8Decoder: import("@smithy/types").Decoder;
|
|
28
|
+
utf8Encoder: import("@smithy/types").Encoder;
|
|
29
|
+
disableHostPrefix: boolean;
|
|
30
|
+
serviceId: string;
|
|
31
|
+
logger: import("@smithy/types").Logger;
|
|
32
|
+
extensions: import("./runtimeExtensions").RuntimeExtension[];
|
|
33
|
+
endpoint?: ((string | import("@smithy/types").Endpoint | import("@smithy/types").Provider<import("@smithy/types").Endpoint> | import("@smithy/types").EndpointV2 | import("@smithy/types").Provider<import("@smithy/types").EndpointV2>) & (string | import("@smithy/types").Provider<string> | import("@smithy/types").Endpoint | import("@smithy/types").Provider<import("@smithy/types").Endpoint> | import("@smithy/types").EndpointV2 | import("@smithy/types").Provider<import("@smithy/types").EndpointV2>)) | undefined;
|
|
34
|
+
endpointProvider: (endpointParams: import("./endpoint/EndpointParameters").EndpointParameters, context?: {
|
|
35
|
+
logger?: import("@smithy/types").Logger | undefined;
|
|
36
|
+
}) => import("@smithy/types").EndpointV2;
|
|
37
|
+
tls?: boolean | undefined;
|
|
38
|
+
retryStrategy?: import("@smithy/types").RetryStrategy | import("@smithy/types").RetryStrategyV2 | undefined;
|
|
39
|
+
credentials?: import("@smithy/types").AwsCredentialIdentity | import("@smithy/types").Provider<import("@smithy/types").AwsCredentialIdentity> | undefined;
|
|
40
|
+
signer?: import("@smithy/types").RequestSigner | ((authScheme?: import("@smithy/types").AuthScheme | undefined) => Promise<import("@smithy/types").RequestSigner>) | undefined;
|
|
41
|
+
signingEscapePath?: boolean | undefined;
|
|
42
|
+
systemClockOffset?: number | undefined;
|
|
43
|
+
signingRegion?: string | undefined;
|
|
44
|
+
signerConstructor?: (new (options: import("@smithy/signature-v4").SignatureV4Init & import("@smithy/signature-v4").SignatureV4CryptoInit) => import("@smithy/types").RequestSigner) | undefined;
|
|
45
|
+
customUserAgent?: string | import("@smithy/types").UserAgent | undefined;
|
|
46
|
+
};
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
import { FreeTierClientConfig } from "./FreeTierClient";
|
|
2
|
+
/**
|
|
3
|
+
* @internal
|
|
4
|
+
*/
|
|
5
|
+
export declare const getRuntimeConfig: (config: FreeTierClientConfig) => {
|
|
6
|
+
runtime: string;
|
|
7
|
+
sha256: import("@smithy/types").HashConstructor;
|
|
8
|
+
requestHandler: (import("@smithy/types").RequestHandler<any, any, import("@smithy/types").HttpHandlerOptions> & import("@smithy/types").RequestHandler<import("@smithy/protocol-http").HttpRequest, import("@smithy/protocol-http").HttpResponse, import("@smithy/types").HttpHandlerOptions> & {
|
|
9
|
+
updateHttpClientConfig(key: never, value: never): void;
|
|
10
|
+
httpHandlerConfigs(): {};
|
|
11
|
+
}) | import("@smithy/fetch-http-handler").FetchHttpHandler;
|
|
12
|
+
apiVersion: string;
|
|
13
|
+
urlParser: import("@smithy/types").UrlParser;
|
|
14
|
+
bodyLengthChecker: import("@smithy/types").BodyLengthCalculator;
|
|
15
|
+
streamCollector: import("@smithy/types").StreamCollector;
|
|
16
|
+
base64Decoder: import("@smithy/types").Decoder;
|
|
17
|
+
base64Encoder: import("@smithy/types").Encoder;
|
|
18
|
+
utf8Decoder: import("@smithy/types").Decoder;
|
|
19
|
+
utf8Encoder: import("@smithy/types").Encoder;
|
|
20
|
+
disableHostPrefix: boolean;
|
|
21
|
+
serviceId: string;
|
|
22
|
+
useDualstackEndpoint: boolean | import("@smithy/types").Provider<boolean>;
|
|
23
|
+
useFipsEndpoint: boolean | import("@smithy/types").Provider<boolean>;
|
|
24
|
+
region: string | import("@smithy/types").Provider<any>;
|
|
25
|
+
credentialDefaultProvider: (input: any) => import("@smithy/types").Provider<import("@aws-sdk/types").Credentials>;
|
|
26
|
+
defaultUserAgentProvider: import("@smithy/types").Provider<import("@smithy/types").UserAgent>;
|
|
27
|
+
maxAttempts: number | import("@smithy/types").Provider<number>;
|
|
28
|
+
retryMode: string | import("@smithy/types").Provider<string>;
|
|
29
|
+
logger: import("@smithy/types").Logger;
|
|
30
|
+
extensions: import("./runtimeExtensions").RuntimeExtension[];
|
|
31
|
+
defaultsMode: import("@smithy/smithy-client").DefaultsMode | import("@smithy/types").Provider<import("@smithy/smithy-client").DefaultsMode>;
|
|
32
|
+
endpoint?: string | import("@smithy/types").Endpoint | import("@smithy/types").Provider<import("@smithy/types").Endpoint> | import("@smithy/types").EndpointV2 | import("@smithy/types").Provider<import("@smithy/types").EndpointV2> | undefined;
|
|
33
|
+
endpointProvider: (endpointParams: import("./endpoint/EndpointParameters").EndpointParameters, context?: {
|
|
34
|
+
logger?: import("@smithy/types").Logger | undefined;
|
|
35
|
+
}) => import("@smithy/types").EndpointV2;
|
|
36
|
+
tls?: boolean | undefined;
|
|
37
|
+
retryStrategy?: import("@smithy/types").RetryStrategy | import("@smithy/types").RetryStrategyV2 | undefined;
|
|
38
|
+
credentials?: import("@smithy/types").AwsCredentialIdentity | import("@smithy/types").Provider<import("@smithy/types").AwsCredentialIdentity> | undefined;
|
|
39
|
+
signer?: import("@smithy/types").RequestSigner | ((authScheme?: import("@smithy/types").AuthScheme | undefined) => Promise<import("@smithy/types").RequestSigner>) | undefined;
|
|
40
|
+
signingEscapePath?: boolean | undefined;
|
|
41
|
+
systemClockOffset?: number | undefined;
|
|
42
|
+
signingRegion?: string | undefined;
|
|
43
|
+
signerConstructor?: (new (options: import("@smithy/signature-v4").SignatureV4Init & import("@smithy/signature-v4").SignatureV4CryptoInit) => import("@smithy/types").RequestSigner) | undefined;
|
|
44
|
+
customUserAgent?: string | import("@smithy/types").UserAgent | undefined;
|
|
45
|
+
};
|