aws-sdk 2.1065.0 → 2.1069.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/CHANGELOG.md +25 -1
- package/README.md +1 -1
- package/apis/appconfig-2019-10-09.min.json +3 -1
- package/apis/appconfigdata-2021-11-11.min.json +11 -11
- package/apis/appflow-2020-08-23.min.json +677 -237
- package/apis/appflow-2020-08-23.paginators.json +7 -1
- package/apis/athena-2017-05-18.min.json +43 -30
- package/apis/comprehend-2017-11-27.min.json +167 -79
- package/apis/ec2-2016-11-15.min.json +122 -43
- package/apis/ec2-2016-11-15.paginators.json +6 -0
- package/apis/es-2015-01-01.min.json +125 -49
- package/apis/fis-2020-12-01.min.json +130 -30
- package/apis/fis-2020-12-01.paginators.json +5 -0
- package/apis/lakeformation-2017-03-31.min.json +0 -1
- package/apis/meteringmarketplace-2016-01-14.min.json +2 -1
- package/apis/personalize-2018-05-22.min.json +3 -0
- package/apis/robomaker-2018-06-29.min.json +135 -45
- package/apis/secretsmanager-2017-10-17.min.json +15 -10
- package/clients/appconfig.d.ts +13 -13
- package/clients/appconfigdata.d.ts +18 -18
- package/clients/appflow.d.ts +611 -3
- package/clients/athena.d.ts +31 -8
- package/clients/cognitoidentityserviceprovider.d.ts +287 -287
- package/clients/comprehend.d.ts +138 -0
- package/clients/costexplorer.d.ts +17 -17
- package/clients/dynamodb.d.ts +5 -5
- package/clients/ec2.d.ts +123 -9
- package/clients/elasticache.d.ts +3 -3
- package/clients/emr.d.ts +14 -14
- package/clients/es.d.ts +97 -0
- package/clients/fis.d.ts +119 -9
- package/clients/glue.d.ts +7 -7
- package/clients/iot.d.ts +1 -1
- package/clients/lakeformation.d.ts +1 -1
- package/clients/marketplacemetering.d.ts +17 -12
- package/clients/personalize.d.ts +7 -3
- package/clients/rbin.d.ts +41 -41
- package/clients/rds.d.ts +17 -17
- package/clients/robomaker.d.ts +30 -30
- package/clients/sagemaker.d.ts +1 -1
- package/clients/secretsmanager.d.ts +62 -48
- package/dist/aws-sdk-core-react-native.js +1 -1
- package/dist/aws-sdk-react-native.js +17 -17
- package/dist/aws-sdk.js +359 -165
- package/dist/aws-sdk.min.js +90 -90
- package/lib/core.js +1 -1
- package/lib/dynamodb/document_client.d.ts +1 -1
- package/package.json +1 -1
package/clients/comprehend.d.ts
CHANGED
|
@@ -115,6 +115,14 @@ declare class Comprehend extends Service {
|
|
|
115
115
|
* Deletes an entity recognizer. Only those recognizers that are in terminated states (IN_ERROR, TRAINED) will be deleted. If an active inference job is using the model, a ResourceInUseException will be returned. This is an asynchronous action that puts the recognizer into a DELETING state, and it is then removed by a background job. Once removed, the recognizer disappears from your account and is no longer available for use.
|
|
116
116
|
*/
|
|
117
117
|
deleteEntityRecognizer(callback?: (err: AWSError, data: Comprehend.Types.DeleteEntityRecognizerResponse) => void): Request<Comprehend.Types.DeleteEntityRecognizerResponse, AWSError>;
|
|
118
|
+
/**
|
|
119
|
+
* Deletes a resource-based policy that is attached to a custom model.
|
|
120
|
+
*/
|
|
121
|
+
deleteResourcePolicy(params: Comprehend.Types.DeleteResourcePolicyRequest, callback?: (err: AWSError, data: Comprehend.Types.DeleteResourcePolicyResponse) => void): Request<Comprehend.Types.DeleteResourcePolicyResponse, AWSError>;
|
|
122
|
+
/**
|
|
123
|
+
* Deletes a resource-based policy that is attached to a custom model.
|
|
124
|
+
*/
|
|
125
|
+
deleteResourcePolicy(callback?: (err: AWSError, data: Comprehend.Types.DeleteResourcePolicyResponse) => void): Request<Comprehend.Types.DeleteResourcePolicyResponse, AWSError>;
|
|
118
126
|
/**
|
|
119
127
|
* Gets the properties associated with a document classification job. Use this operation to get the status of a classification job.
|
|
120
128
|
*/
|
|
@@ -187,6 +195,14 @@ declare class Comprehend extends Service {
|
|
|
187
195
|
* Gets the properties associated with a PII entities detection job. For example, you can use this operation to get the job status.
|
|
188
196
|
*/
|
|
189
197
|
describePiiEntitiesDetectionJob(callback?: (err: AWSError, data: Comprehend.Types.DescribePiiEntitiesDetectionJobResponse) => void): Request<Comprehend.Types.DescribePiiEntitiesDetectionJobResponse, AWSError>;
|
|
198
|
+
/**
|
|
199
|
+
* Gets the details of a resource-based policy that is attached to a custom model, including the JSON body of the policy.
|
|
200
|
+
*/
|
|
201
|
+
describeResourcePolicy(params: Comprehend.Types.DescribeResourcePolicyRequest, callback?: (err: AWSError, data: Comprehend.Types.DescribeResourcePolicyResponse) => void): Request<Comprehend.Types.DescribeResourcePolicyResponse, AWSError>;
|
|
202
|
+
/**
|
|
203
|
+
* Gets the details of a resource-based policy that is attached to a custom model, including the JSON body of the policy.
|
|
204
|
+
*/
|
|
205
|
+
describeResourcePolicy(callback?: (err: AWSError, data: Comprehend.Types.DescribeResourcePolicyResponse) => void): Request<Comprehend.Types.DescribeResourcePolicyResponse, AWSError>;
|
|
190
206
|
/**
|
|
191
207
|
* Gets the properties associated with a sentiment detection job. Use this operation to get the status of a detection job.
|
|
192
208
|
*/
|
|
@@ -251,6 +267,14 @@ declare class Comprehend extends Service {
|
|
|
251
267
|
* Inspects text for syntax and the part of speech of words in the document. For more information, how-syntax.
|
|
252
268
|
*/
|
|
253
269
|
detectSyntax(callback?: (err: AWSError, data: Comprehend.Types.DetectSyntaxResponse) => void): Request<Comprehend.Types.DetectSyntaxResponse, AWSError>;
|
|
270
|
+
/**
|
|
271
|
+
* Creates a new custom model that replicates a source custom model that you import. The source model can be in your AWS account or another one. If the source model is in another AWS account, then it must have a resource-based policy that authorizes you to import it. The source model must be in the same AWS region that you're using when you import. You can't import a model that's in a different region.
|
|
272
|
+
*/
|
|
273
|
+
importModel(params: Comprehend.Types.ImportModelRequest, callback?: (err: AWSError, data: Comprehend.Types.ImportModelResponse) => void): Request<Comprehend.Types.ImportModelResponse, AWSError>;
|
|
274
|
+
/**
|
|
275
|
+
* Creates a new custom model that replicates a source custom model that you import. The source model can be in your AWS account or another one. If the source model is in another AWS account, then it must have a resource-based policy that authorizes you to import it. The source model must be in the same AWS region that you're using when you import. You can't import a model that's in a different region.
|
|
276
|
+
*/
|
|
277
|
+
importModel(callback?: (err: AWSError, data: Comprehend.Types.ImportModelResponse) => void): Request<Comprehend.Types.ImportModelResponse, AWSError>;
|
|
254
278
|
/**
|
|
255
279
|
* Gets a list of the documentation classification jobs that you have submitted.
|
|
256
280
|
*/
|
|
@@ -363,6 +387,14 @@ declare class Comprehend extends Service {
|
|
|
363
387
|
* Gets a list of the topic detection jobs that you have submitted.
|
|
364
388
|
*/
|
|
365
389
|
listTopicsDetectionJobs(callback?: (err: AWSError, data: Comprehend.Types.ListTopicsDetectionJobsResponse) => void): Request<Comprehend.Types.ListTopicsDetectionJobsResponse, AWSError>;
|
|
390
|
+
/**
|
|
391
|
+
* Attaches a resource-based policy to a custom model. You can use this policy to authorize an entity in another AWS account to import the custom model, which replicates it in Amazon Comprehend in their account.
|
|
392
|
+
*/
|
|
393
|
+
putResourcePolicy(params: Comprehend.Types.PutResourcePolicyRequest, callback?: (err: AWSError, data: Comprehend.Types.PutResourcePolicyResponse) => void): Request<Comprehend.Types.PutResourcePolicyResponse, AWSError>;
|
|
394
|
+
/**
|
|
395
|
+
* Attaches a resource-based policy to a custom model. You can use this policy to authorize an entity in another AWS account to import the custom model, which replicates it in Amazon Comprehend in their account.
|
|
396
|
+
*/
|
|
397
|
+
putResourcePolicy(callback?: (err: AWSError, data: Comprehend.Types.PutResourcePolicyResponse) => void): Request<Comprehend.Types.PutResourcePolicyResponse, AWSError>;
|
|
366
398
|
/**
|
|
367
399
|
* Starts an asynchronous document classification job. Use the operation to track the progress of the job.
|
|
368
400
|
*/
|
|
@@ -855,6 +887,10 @@ declare namespace Comprehend {
|
|
|
855
887
|
* ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt trained custom models. The ModelKmsKeyId can be either of the following formats: KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab" Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
|
|
856
888
|
*/
|
|
857
889
|
ModelKmsKeyId?: KmsKeyId;
|
|
890
|
+
/**
|
|
891
|
+
* The resource-based policy to attach to your custom document classifier model. You can use this policy to allow another AWS account to import your custom model. Provide your policy as a JSON body that you enter as a UTF-8 encoded string without line breaks. To provide valid JSON, enclose the attribute names and values in double quotes. If the JSON body is also enclosed in double quotes, then you must escape the double quotes that are inside the policy: "{\"attribute\": \"value\", \"attribute\": [\"value\"]}" To avoid escaping quotes, you can use single quotes to enclose the policy and double quotes to enclose the JSON names and values: '{"attribute": "value", "attribute": ["value"]}'
|
|
892
|
+
*/
|
|
893
|
+
ModelPolicy?: Policy;
|
|
858
894
|
}
|
|
859
895
|
export interface CreateDocumentClassifierResponse {
|
|
860
896
|
/**
|
|
@@ -935,6 +971,10 @@ declare namespace Comprehend {
|
|
|
935
971
|
* ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt trained custom models. The ModelKmsKeyId can be either of the following formats KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab" Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
|
|
936
972
|
*/
|
|
937
973
|
ModelKmsKeyId?: KmsKeyId;
|
|
974
|
+
/**
|
|
975
|
+
* The JSON resource-based policy to attach to your custom entity recognizer model. You can use this policy to allow another AWS account to import your custom model. Provide your JSON as a UTF-8 encoded string without line breaks. To provide valid JSON for your policy, enclose the attribute names and values in double quotes. If the JSON body is also enclosed in double quotes, then you must escape the double quotes that are inside the policy: "{\"attribute\": \"value\", \"attribute\": [\"value\"]}" To avoid escaping quotes, you can use single quotes to enclose the policy and double quotes to enclose the JSON names and values: '{"attribute": "value", "attribute": ["value"]}'
|
|
976
|
+
*/
|
|
977
|
+
ModelPolicy?: Policy;
|
|
938
978
|
}
|
|
939
979
|
export interface CreateEntityRecognizerResponse {
|
|
940
980
|
/**
|
|
@@ -968,6 +1008,18 @@ declare namespace Comprehend {
|
|
|
968
1008
|
}
|
|
969
1009
|
export interface DeleteEntityRecognizerResponse {
|
|
970
1010
|
}
|
|
1011
|
+
export interface DeleteResourcePolicyRequest {
|
|
1012
|
+
/**
|
|
1013
|
+
* The Amazon Resource Name (ARN) of the custom model version that has the policy to delete.
|
|
1014
|
+
*/
|
|
1015
|
+
ResourceArn: ComprehendModelArn;
|
|
1016
|
+
/**
|
|
1017
|
+
* The revision ID of the policy to delete.
|
|
1018
|
+
*/
|
|
1019
|
+
PolicyRevisionId?: PolicyRevisionId;
|
|
1020
|
+
}
|
|
1021
|
+
export interface DeleteResourcePolicyResponse {
|
|
1022
|
+
}
|
|
971
1023
|
export interface DescribeDocumentClassificationJobRequest {
|
|
972
1024
|
/**
|
|
973
1025
|
* The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its response.
|
|
@@ -1073,6 +1125,30 @@ declare namespace Comprehend {
|
|
|
1073
1125
|
export interface DescribePiiEntitiesDetectionJobResponse {
|
|
1074
1126
|
PiiEntitiesDetectionJobProperties?: PiiEntitiesDetectionJobProperties;
|
|
1075
1127
|
}
|
|
1128
|
+
export interface DescribeResourcePolicyRequest {
|
|
1129
|
+
/**
|
|
1130
|
+
* The Amazon Resource Name (ARN) of the policy to describe.
|
|
1131
|
+
*/
|
|
1132
|
+
ResourceArn: ComprehendModelArn;
|
|
1133
|
+
}
|
|
1134
|
+
export interface DescribeResourcePolicyResponse {
|
|
1135
|
+
/**
|
|
1136
|
+
* The JSON body of the resource-based policy.
|
|
1137
|
+
*/
|
|
1138
|
+
ResourcePolicy?: Policy;
|
|
1139
|
+
/**
|
|
1140
|
+
* The time at which the policy was created.
|
|
1141
|
+
*/
|
|
1142
|
+
CreationTime?: Timestamp;
|
|
1143
|
+
/**
|
|
1144
|
+
* The time at which the policy was last modified.
|
|
1145
|
+
*/
|
|
1146
|
+
LastModifiedTime?: Timestamp;
|
|
1147
|
+
/**
|
|
1148
|
+
* The revision ID of the policy. Each time you modify a policy, Amazon Comprehend assigns a new revision ID, and it deletes the prior version of the policy.
|
|
1149
|
+
*/
|
|
1150
|
+
PolicyRevisionId?: PolicyRevisionId;
|
|
1151
|
+
}
|
|
1076
1152
|
export interface DescribeSentimentDetectionJobRequest {
|
|
1077
1153
|
/**
|
|
1078
1154
|
* The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its response.
|
|
@@ -1404,6 +1480,10 @@ declare namespace Comprehend {
|
|
|
1404
1480
|
* The version name that you assigned to the document classifier.
|
|
1405
1481
|
*/
|
|
1406
1482
|
VersionName?: VersionName;
|
|
1483
|
+
/**
|
|
1484
|
+
* The Amazon Resource Name (ARN) of the source model. This model was imported from a different AWS account to create the document classifier model in your AWS account.
|
|
1485
|
+
*/
|
|
1486
|
+
SourceModelArn?: DocumentClassifierArn;
|
|
1407
1487
|
}
|
|
1408
1488
|
export type DocumentClassifierPropertiesList = DocumentClassifierProperties[];
|
|
1409
1489
|
export type DocumentClassifierSummariesList = DocumentClassifierSummary[];
|
|
@@ -1897,6 +1977,10 @@ declare namespace Comprehend {
|
|
|
1897
1977
|
* The version name you assigned to the entity recognizer.
|
|
1898
1978
|
*/
|
|
1899
1979
|
VersionName?: VersionName;
|
|
1980
|
+
/**
|
|
1981
|
+
* The Amazon Resource Name (ARN) of the source model. This model was imported from a different AWS account to create the entity recognizer model in your AWS account.
|
|
1982
|
+
*/
|
|
1983
|
+
SourceModelArn?: EntityRecognizerArn;
|
|
1900
1984
|
}
|
|
1901
1985
|
export type EntityRecognizerPropertiesList = EntityRecognizerProperties[];
|
|
1902
1986
|
export type EntityRecognizerSummariesList = EntityRecognizerSummary[];
|
|
@@ -2017,6 +2101,38 @@ declare namespace Comprehend {
|
|
|
2017
2101
|
export type EventsDetectionJobPropertiesList = EventsDetectionJobProperties[];
|
|
2018
2102
|
export type Float = number;
|
|
2019
2103
|
export type IamRoleArn = string;
|
|
2104
|
+
export interface ImportModelRequest {
|
|
2105
|
+
/**
|
|
2106
|
+
* The Amazon Resource Name (ARN) of the custom model to import.
|
|
2107
|
+
*/
|
|
2108
|
+
SourceModelArn: ComprehendModelArn;
|
|
2109
|
+
/**
|
|
2110
|
+
* The name to assign to the custom model that is created in Amazon Comprehend by this import.
|
|
2111
|
+
*/
|
|
2112
|
+
ModelName?: ComprehendArnName;
|
|
2113
|
+
/**
|
|
2114
|
+
* The version name given to the custom model that is created by this import. Version names can have a maximum of 256 characters. Alphanumeric characters, hyphens (-) and underscores (_) are allowed. The version name must be unique among all models with the same classifier name in the account/AWS Region.
|
|
2115
|
+
*/
|
|
2116
|
+
VersionName?: VersionName;
|
|
2117
|
+
/**
|
|
2118
|
+
* ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt trained custom models. The ModelKmsKeyId can be either of the following formats: KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab" Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
|
|
2119
|
+
*/
|
|
2120
|
+
ModelKmsKeyId?: KmsKeyId;
|
|
2121
|
+
/**
|
|
2122
|
+
* The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that allows Amazon Comprehend to use Amazon Key Management Service (KMS) to encrypt or decrypt the custom model.
|
|
2123
|
+
*/
|
|
2124
|
+
DataAccessRoleArn?: IamRoleArn;
|
|
2125
|
+
/**
|
|
2126
|
+
* Tags to be associated with the custom model that is created by this import. A tag is a key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.
|
|
2127
|
+
*/
|
|
2128
|
+
Tags?: TagList;
|
|
2129
|
+
}
|
|
2130
|
+
export interface ImportModelResponse {
|
|
2131
|
+
/**
|
|
2132
|
+
* The Amazon Resource Name (ARN) of the custom model being imported.
|
|
2133
|
+
*/
|
|
2134
|
+
ModelArn?: ComprehendModelArn;
|
|
2135
|
+
}
|
|
2020
2136
|
export type InferenceUnitsInteger = number;
|
|
2021
2137
|
export interface InputDataConfig {
|
|
2022
2138
|
/**
|
|
@@ -2595,6 +2711,28 @@ declare namespace Comprehend {
|
|
|
2595
2711
|
*/
|
|
2596
2712
|
KmsKeyId?: KmsKeyId;
|
|
2597
2713
|
}
|
|
2714
|
+
export type Policy = string;
|
|
2715
|
+
export type PolicyRevisionId = string;
|
|
2716
|
+
export interface PutResourcePolicyRequest {
|
|
2717
|
+
/**
|
|
2718
|
+
* The Amazon Resource Name (ARN) of the custom model to attach the policy to.
|
|
2719
|
+
*/
|
|
2720
|
+
ResourceArn: ComprehendModelArn;
|
|
2721
|
+
/**
|
|
2722
|
+
* The JSON resource-based policy to attach to your custom model. Provide your JSON as a UTF-8 encoded string without line breaks. To provide valid JSON for your policy, enclose the attribute names and values in double quotes. If the JSON body is also enclosed in double quotes, then you must escape the double quotes that are inside the policy: "{\"attribute\": \"value\", \"attribute\": [\"value\"]}" To avoid escaping quotes, you can use single quotes to enclose the policy and double quotes to enclose the JSON names and values: '{"attribute": "value", "attribute": ["value"]}'
|
|
2723
|
+
*/
|
|
2724
|
+
ResourcePolicy: Policy;
|
|
2725
|
+
/**
|
|
2726
|
+
* The revision ID that Amazon Comprehend assigned to the policy that you are updating. If you are creating a new policy that has no prior version, don't use this parameter. Amazon Comprehend creates the revision ID for you.
|
|
2727
|
+
*/
|
|
2728
|
+
PolicyRevisionId?: PolicyRevisionId;
|
|
2729
|
+
}
|
|
2730
|
+
export interface PutResourcePolicyResponse {
|
|
2731
|
+
/**
|
|
2732
|
+
* The revision ID of the policy. Each time you modify a policy, Amazon Comprehend assigns a new revision ID, and it deletes the prior version of the policy.
|
|
2733
|
+
*/
|
|
2734
|
+
PolicyRevisionId?: PolicyRevisionId;
|
|
2735
|
+
}
|
|
2598
2736
|
export interface RedactionConfig {
|
|
2599
2737
|
/**
|
|
2600
2738
|
* An array of the types of PII entities that Amazon Comprehend detects in the input text for your request.
|
|
@@ -164,11 +164,11 @@ declare class CostExplorer extends Service {
|
|
|
164
164
|
*/
|
|
165
165
|
getRightsizingRecommendation(callback?: (err: AWSError, data: CostExplorer.Types.GetRightsizingRecommendationResponse) => void): Request<CostExplorer.Types.GetRightsizingRecommendationResponse, AWSError>;
|
|
166
166
|
/**
|
|
167
|
-
* Retrieves the Savings Plans covered for your account. This enables you to see how much of your cost is covered by a Savings Plan. An organization’s management account can see the coverage of the associated member accounts. This supports dimensions, Cost Categories, and nested expressions. For any time period, you can filter data for Savings Plans usage with the following dimensions: LINKED_ACCOUNT REGION SERVICE INSTANCE_FAMILY
|
|
167
|
+
* Retrieves the Savings Plans covered for your account. This enables you to see how much of your cost is covered by a Savings Plan. An organization’s management account can see the coverage of the associated member accounts. This supports dimensions, Cost Categories, and nested expressions. For any time period, you can filter data for Savings Plans usage with the following dimensions: LINKED_ACCOUNT REGION SERVICE INSTANCE_FAMILY To determine valid values for a dimension, use the GetDimensionValues operation.
|
|
168
168
|
*/
|
|
169
169
|
getSavingsPlansCoverage(params: CostExplorer.Types.GetSavingsPlansCoverageRequest, callback?: (err: AWSError, data: CostExplorer.Types.GetSavingsPlansCoverageResponse) => void): Request<CostExplorer.Types.GetSavingsPlansCoverageResponse, AWSError>;
|
|
170
170
|
/**
|
|
171
|
-
* Retrieves the Savings Plans covered for your account. This enables you to see how much of your cost is covered by a Savings Plan. An organization’s management account can see the coverage of the associated member accounts. This supports dimensions, Cost Categories, and nested expressions. For any time period, you can filter data for Savings Plans usage with the following dimensions: LINKED_ACCOUNT REGION SERVICE INSTANCE_FAMILY
|
|
171
|
+
* Retrieves the Savings Plans covered for your account. This enables you to see how much of your cost is covered by a Savings Plan. An organization’s management account can see the coverage of the associated member accounts. This supports dimensions, Cost Categories, and nested expressions. For any time period, you can filter data for Savings Plans usage with the following dimensions: LINKED_ACCOUNT REGION SERVICE INSTANCE_FAMILY To determine valid values for a dimension, use the GetDimensionValues operation.
|
|
172
172
|
*/
|
|
173
173
|
getSavingsPlansCoverage(callback?: (err: AWSError, data: CostExplorer.Types.GetSavingsPlansCoverageResponse) => void): Request<CostExplorer.Types.GetSavingsPlansCoverageResponse, AWSError>;
|
|
174
174
|
/**
|
|
@@ -180,19 +180,19 @@ declare class CostExplorer extends Service {
|
|
|
180
180
|
*/
|
|
181
181
|
getSavingsPlansPurchaseRecommendation(callback?: (err: AWSError, data: CostExplorer.Types.GetSavingsPlansPurchaseRecommendationResponse) => void): Request<CostExplorer.Types.GetSavingsPlansPurchaseRecommendationResponse, AWSError>;
|
|
182
182
|
/**
|
|
183
|
-
* Retrieves the Savings Plans utilization for your account across date ranges with daily or monthly granularity. Management account in an organization have access to member accounts. You can use GetDimensionValues in SAVINGS_PLANS to determine the possible dimension values. You cannot group by any dimension values for GetSavingsPlansUtilization.
|
|
183
|
+
* Retrieves the Savings Plans utilization for your account across date ranges with daily or monthly granularity. Management account in an organization have access to member accounts. You can use GetDimensionValues in SAVINGS_PLANS to determine the possible dimension values. You cannot group by any dimension values for GetSavingsPlansUtilization.
|
|
184
184
|
*/
|
|
185
185
|
getSavingsPlansUtilization(params: CostExplorer.Types.GetSavingsPlansUtilizationRequest, callback?: (err: AWSError, data: CostExplorer.Types.GetSavingsPlansUtilizationResponse) => void): Request<CostExplorer.Types.GetSavingsPlansUtilizationResponse, AWSError>;
|
|
186
186
|
/**
|
|
187
|
-
* Retrieves the Savings Plans utilization for your account across date ranges with daily or monthly granularity. Management account in an organization have access to member accounts. You can use GetDimensionValues in SAVINGS_PLANS to determine the possible dimension values. You cannot group by any dimension values for GetSavingsPlansUtilization.
|
|
187
|
+
* Retrieves the Savings Plans utilization for your account across date ranges with daily or monthly granularity. Management account in an organization have access to member accounts. You can use GetDimensionValues in SAVINGS_PLANS to determine the possible dimension values. You cannot group by any dimension values for GetSavingsPlansUtilization.
|
|
188
188
|
*/
|
|
189
189
|
getSavingsPlansUtilization(callback?: (err: AWSError, data: CostExplorer.Types.GetSavingsPlansUtilizationResponse) => void): Request<CostExplorer.Types.GetSavingsPlansUtilizationResponse, AWSError>;
|
|
190
190
|
/**
|
|
191
|
-
* Retrieves attribute data along with aggregate utilization and savings data for a given time period. This doesn't support granular or grouped data (daily/monthly) in response. You can't retrieve data by dates in a single response similar to GetSavingsPlanUtilization, but you have the option to make multiple calls to GetSavingsPlanUtilizationDetails by providing individual dates. You can use GetDimensionValues in SAVINGS_PLANS to determine the possible dimension values. GetSavingsPlanUtilizationDetails internally groups data by SavingsPlansArn.
|
|
191
|
+
* Retrieves attribute data along with aggregate utilization and savings data for a given time period. This doesn't support granular or grouped data (daily/monthly) in response. You can't retrieve data by dates in a single response similar to GetSavingsPlanUtilization, but you have the option to make multiple calls to GetSavingsPlanUtilizationDetails by providing individual dates. You can use GetDimensionValues in SAVINGS_PLANS to determine the possible dimension values. GetSavingsPlanUtilizationDetails internally groups data by SavingsPlansArn.
|
|
192
192
|
*/
|
|
193
193
|
getSavingsPlansUtilizationDetails(params: CostExplorer.Types.GetSavingsPlansUtilizationDetailsRequest, callback?: (err: AWSError, data: CostExplorer.Types.GetSavingsPlansUtilizationDetailsResponse) => void): Request<CostExplorer.Types.GetSavingsPlansUtilizationDetailsResponse, AWSError>;
|
|
194
194
|
/**
|
|
195
|
-
* Retrieves attribute data along with aggregate utilization and savings data for a given time period. This doesn't support granular or grouped data (daily/monthly) in response. You can't retrieve data by dates in a single response similar to GetSavingsPlanUtilization, but you have the option to make multiple calls to GetSavingsPlanUtilizationDetails by providing individual dates. You can use GetDimensionValues in SAVINGS_PLANS to determine the possible dimension values. GetSavingsPlanUtilizationDetails internally groups data by SavingsPlansArn.
|
|
195
|
+
* Retrieves attribute data along with aggregate utilization and savings data for a given time period. This doesn't support granular or grouped data (daily/monthly) in response. You can't retrieve data by dates in a single response similar to GetSavingsPlanUtilization, but you have the option to make multiple calls to GetSavingsPlanUtilizationDetails by providing individual dates. You can use GetDimensionValues in SAVINGS_PLANS to determine the possible dimension values. GetSavingsPlanUtilizationDetails internally groups data by SavingsPlansArn.
|
|
196
196
|
*/
|
|
197
197
|
getSavingsPlansUtilizationDetails(callback?: (err: AWSError, data: CostExplorer.Types.GetSavingsPlansUtilizationDetailsResponse) => void): Request<CostExplorer.Types.GetSavingsPlansUtilizationDetailsResponse, AWSError>;
|
|
198
198
|
/**
|
|
@@ -760,7 +760,7 @@ declare namespace CostExplorer {
|
|
|
760
760
|
export interface DescribeCostCategoryDefinitionResponse {
|
|
761
761
|
CostCategory?: CostCategory;
|
|
762
762
|
}
|
|
763
|
-
export type Dimension = "AZ"|"INSTANCE_TYPE"|"LINKED_ACCOUNT"|"LINKED_ACCOUNT_NAME"|"OPERATION"|"PURCHASE_TYPE"|"REGION"|"SERVICE"|"SERVICE_CODE"|"USAGE_TYPE"|"USAGE_TYPE_GROUP"|"RECORD_TYPE"|"OPERATING_SYSTEM"|"TENANCY"|"SCOPE"|"PLATFORM"|"SUBSCRIPTION_ID"|"LEGAL_ENTITY_NAME"|"DEPLOYMENT_OPTION"|"DATABASE_ENGINE"|"CACHE_ENGINE"|"INSTANCE_TYPE_FAMILY"|"BILLING_ENTITY"|"RESERVATION_ID"|"RESOURCE_ID"|"RIGHTSIZING_TYPE"|"SAVINGS_PLANS_TYPE"|"SAVINGS_PLAN_ARN"|"PAYMENT_OPTION"|"AGREEMENT_END_DATE_TIME_AFTER"|"AGREEMENT_END_DATE_TIME_BEFORE"|string;
|
|
763
|
+
export type Dimension = "AZ"|"INSTANCE_TYPE"|"LINKED_ACCOUNT"|"LINKED_ACCOUNT_NAME"|"OPERATION"|"PURCHASE_TYPE"|"REGION"|"SERVICE"|"SERVICE_CODE"|"USAGE_TYPE"|"USAGE_TYPE_GROUP"|"RECORD_TYPE"|"OPERATING_SYSTEM"|"TENANCY"|"SCOPE"|"PLATFORM"|"SUBSCRIPTION_ID"|"LEGAL_ENTITY_NAME"|"INVOICING_ENTITY"|"DEPLOYMENT_OPTION"|"DATABASE_ENGINE"|"CACHE_ENGINE"|"INSTANCE_TYPE_FAMILY"|"BILLING_ENTITY"|"RESERVATION_ID"|"RESOURCE_ID"|"RIGHTSIZING_TYPE"|"SAVINGS_PLANS_TYPE"|"SAVINGS_PLAN_ARN"|"PAYMENT_OPTION"|"AGREEMENT_END_DATE_TIME_AFTER"|"AGREEMENT_END_DATE_TIME_BEFORE"|string;
|
|
764
764
|
export interface DimensionValues {
|
|
765
765
|
/**
|
|
766
766
|
* The names of the metadata types that you can use to filter and group your results. For example, AZ returns a list of Availability Zones.
|
|
@@ -1125,7 +1125,7 @@ declare namespace CostExplorer {
|
|
|
1125
1125
|
*/
|
|
1126
1126
|
Granularity: Granularity;
|
|
1127
1127
|
/**
|
|
1128
|
-
* Filters Amazon Web Services costs by different dimensions. For example, you can specify SERVICE and LINKED_ACCOUNT and get the costs that are associated with that account's usage of that service. You can nest Expression objects to define any combination of dimension filters. For more information, see Expression.
|
|
1128
|
+
* Filters Amazon Web Services costs by different dimensions. For example, you can specify SERVICE and LINKED_ACCOUNT and get the costs that are associated with that account's usage of that service. You can nest Expression objects to define any combination of dimension filters. For more information, see Expression. Valid values for MatchOptions for CostCategories and Tags are EQUALS, ABSENT, and CASE_SENSITIVE. The default values are EQUALS and CASE_SENSITIVE. Valid values for MatchOptions for Dimensions are EQUALS and CASE_SENSITIVE.
|
|
1129
1129
|
*/
|
|
1130
1130
|
Filter?: Expression;
|
|
1131
1131
|
/**
|
|
@@ -1133,7 +1133,7 @@ declare namespace CostExplorer {
|
|
|
1133
1133
|
*/
|
|
1134
1134
|
Metrics: MetricNames;
|
|
1135
1135
|
/**
|
|
1136
|
-
* You can group Amazon Web Services costs using up to two different groups, either dimensions, tag keys, cost categories, or any two group by types. Valid values for the DIMENSION type are AZ, INSTANCE_TYPE, LEGAL_ENTITY_NAME, LINKED_ACCOUNT, OPERATION, PLATFORM, PURCHASE_TYPE, SERVICE, TENANCY, RECORD_TYPE, and USAGE_TYPE. When you group by the TAG type and include a valid tag key, you get all tag values, including empty strings.
|
|
1136
|
+
* You can group Amazon Web Services costs using up to two different groups, either dimensions, tag keys, cost categories, or any two group by types. Valid values for the DIMENSION type are AZ, INSTANCE_TYPE, LEGAL_ENTITY_NAME, INVOICING_ENTITY, LINKED_ACCOUNT, OPERATION, PLATFORM, PURCHASE_TYPE, SERVICE, TENANCY, RECORD_TYPE, and USAGE_TYPE. When you group by the TAG type and include a valid tag key, you get all tag values, including empty strings.
|
|
1137
1137
|
*/
|
|
1138
1138
|
GroupBy?: GroupDefinitions;
|
|
1139
1139
|
/**
|
|
@@ -1169,7 +1169,7 @@ declare namespace CostExplorer {
|
|
|
1169
1169
|
*/
|
|
1170
1170
|
Granularity: Granularity;
|
|
1171
1171
|
/**
|
|
1172
|
-
* Filters Amazon Web Services costs by different dimensions. For example, you can specify SERVICE and LINKED_ACCOUNT and get the costs that are associated with that account's usage of that service. You can nest Expression objects to define any combination of dimension filters. For more information, see Expression. The GetCostAndUsageWithResources operation requires that you either group by or filter by a ResourceId. It requires the Expression "SERVICE = Amazon Elastic Compute Cloud - Compute" in the filter.
|
|
1172
|
+
* Filters Amazon Web Services costs by different dimensions. For example, you can specify SERVICE and LINKED_ACCOUNT and get the costs that are associated with that account's usage of that service. You can nest Expression objects to define any combination of dimension filters. For more information, see Expression. The GetCostAndUsageWithResources operation requires that you either group by or filter by a ResourceId. It requires the Expression "SERVICE = Amazon Elastic Compute Cloud - Compute" in the filter. Valid values for MatchOptions for CostCategories and Tags are EQUALS, ABSENT, and CASE_SENSITIVE. The default values are EQUALS and CASE_SENSITIVE. Valid values for MatchOptions for Dimensions are EQUALS and CASE_SENSITIVE.
|
|
1173
1173
|
*/
|
|
1174
1174
|
Filter: Expression;
|
|
1175
1175
|
/**
|
|
@@ -1292,7 +1292,7 @@ declare namespace CostExplorer {
|
|
|
1292
1292
|
*/
|
|
1293
1293
|
Dimension: Dimension;
|
|
1294
1294
|
/**
|
|
1295
|
-
* The context for the call to GetDimensionValues. This can be RESERVATIONS or COST_AND_USAGE. The default value is COST_AND_USAGE. If the context is set to RESERVATIONS, the resulting dimension values can be used in the GetReservationUtilization operation. If the context is set to COST_AND_USAGE, the resulting dimension values can be used in the GetCostAndUsage operation. If you set the context to COST_AND_USAGE, you can use the following dimensions for searching: AZ - The Availability Zone. An example is us-east-1a. DATABASE_ENGINE - The Amazon Relational Database Service database. Examples are Aurora or MySQL. INSTANCE_TYPE - The type of Amazon EC2 instance. An example is m4.xlarge. LEGAL_ENTITY_NAME - The name of the organization that sells you Amazon Web Services services, such as Amazon Web Services. LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value field contains the Amazon Web Services ID of the member account. OPERATING_SYSTEM - The operating system. Examples are Windows or Linux. OPERATION - The action performed. Examples include RunInstance and CreateBucket. PLATFORM - The Amazon EC2 operating system. Examples are Windows or Linux. PURCHASE_TYPE - The reservation type of the purchase to which this usage is related. Examples include On-Demand Instances and Standard Reserved Instances. SERVICE - The Amazon Web Services service such as Amazon DynamoDB. USAGE_TYPE - The type of usage. An example is DataTransfer-In-Bytes. The response for the GetDimensionValues operation includes a unit attribute. Examples include GB and Hrs. USAGE_TYPE_GROUP - The grouping of common usage types. An example is Amazon EC2: CloudWatch – Alarms. The response for this operation includes a unit attribute. REGION - The Amazon Web Services Region. RECORD_TYPE - The different types of charges such as RI fees, usage costs, tax refunds, and credits. RESOURCE_ID - The unique identifier of the resource. ResourceId is an opt-in feature only available for last 14 days for EC2-Compute Service. If you set the context to RESERVATIONS, you can use the following dimensions for searching: AZ - The Availability Zone. An example is us-east-1a. CACHE_ENGINE - The Amazon ElastiCache operating system. Examples are Windows or Linux. DEPLOYMENT_OPTION - The scope of Amazon Relational Database Service deployments. Valid values are SingleAZ and MultiAZ. INSTANCE_TYPE - The type of Amazon EC2 instance. An example is m4.xlarge. LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value field contains the Amazon Web Services ID of the member account. PLATFORM - The Amazon EC2 operating system. Examples are Windows or Linux. REGION - The Amazon Web Services Region. SCOPE (Utilization only) - The scope of a Reserved Instance (RI). Values are regional or a single Availability Zone. TAG (Coverage only) - The tags that are associated with a Reserved Instance (RI). TENANCY - The tenancy of a resource. Examples are shared or dedicated. If you set the context to SAVINGS_PLANS, you can use the following dimensions for searching: SAVINGS_PLANS_TYPE - Type of Savings Plans (EC2 Instance or Compute) PAYMENT_OPTION - Payment option for the given Savings Plans (for example, All Upfront) REGION - The Amazon Web Services Region. INSTANCE_TYPE_FAMILY - The family of instances (For example, m5) LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value field contains the Amazon Web Services ID of the member account. SAVINGS_PLAN_ARN - The unique identifier for your Savings
|
|
1295
|
+
* The context for the call to GetDimensionValues. This can be RESERVATIONS or COST_AND_USAGE. The default value is COST_AND_USAGE. If the context is set to RESERVATIONS, the resulting dimension values can be used in the GetReservationUtilization operation. If the context is set to COST_AND_USAGE, the resulting dimension values can be used in the GetCostAndUsage operation. If you set the context to COST_AND_USAGE, you can use the following dimensions for searching: AZ - The Availability Zone. An example is us-east-1a. BILLING_ENTITY - The Amazon Web Services seller that your account is with. Possible values are the following: - Amazon Web Services(Amazon Web Services): The entity that sells Amazon Web Services services. - AISPL (Amazon Internet Services Pvt. Ltd.): The local Indian entity that is an acting reseller for Amazon Web Services services in India. - Amazon Web Services Marketplace: The entity that supports the sale of solutions built on Amazon Web Services by third-party software providers. CACHE_ENGINE - The Amazon ElastiCache operating system. Examples are Windows or Linux. DEPLOYMENT_OPTION - The scope of Amazon Relational Database Service deployments. Valid values are SingleAZ and MultiAZ. DATABASE_ENGINE - The Amazon Relational Database Service database. Examples are Aurora or MySQL. INSTANCE_TYPE - The type of Amazon EC2 instance. An example is m4.xlarge. INSTANCE_TYPE_FAMILY - A family of instance types optimized to fit different use cases. Examples are Compute Optimized (C4, C5, C6g, C7g etc.), Memory Optimization (R4, R5n, R5b, R6g etc). INVOICING_ENTITY - The name of the entity issuing the Amazon Web Services invoice. LEGAL_ENTITY_NAME - The name of the organization that sells you Amazon Web Services services, such as Amazon Web Services. LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value field contains the Amazon Web Services ID of the member account. OPERATING_SYSTEM - The operating system. Examples are Windows or Linux. OPERATION - The action performed. Examples include RunInstance and CreateBucket. PLATFORM - The Amazon EC2 operating system. Examples are Windows or Linux. PURCHASE_TYPE - The reservation type of the purchase to which this usage is related. Examples include On-Demand Instances and Standard Reserved Instances. RESERVATION_ID - The unique identifier for an Amazon Web Services Reservation Instance. SAVINGS_PLAN_ARN - The unique identifier for your Savings Plans. SAVINGS_PLANS_TYPE - Type of Savings Plans (EC2 Instance or Compute). SERVICE - The Amazon Web Services service such as Amazon DynamoDB. TENANCY - The tenancy of a resource. Examples are shared or dedicated. USAGE_TYPE - The type of usage. An example is DataTransfer-In-Bytes. The response for the GetDimensionValues operation includes a unit attribute. Examples include GB and Hrs. USAGE_TYPE_GROUP - The grouping of common usage types. An example is Amazon EC2: CloudWatch – Alarms. The response for this operation includes a unit attribute. REGION - The Amazon Web Services Region. RECORD_TYPE - The different types of charges such as RI fees, usage costs, tax refunds, and credits. RESOURCE_ID - The unique identifier of the resource. ResourceId is an opt-in feature only available for last 14 days for EC2-Compute Service. If you set the context to RESERVATIONS, you can use the following dimensions for searching: AZ - The Availability Zone. An example is us-east-1a. CACHE_ENGINE - The Amazon ElastiCache operating system. Examples are Windows or Linux. DEPLOYMENT_OPTION - The scope of Amazon Relational Database Service deployments. Valid values are SingleAZ and MultiAZ. INSTANCE_TYPE - The type of Amazon EC2 instance. An example is m4.xlarge. LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value field contains the Amazon Web Services ID of the member account. PLATFORM - The Amazon EC2 operating system. Examples are Windows or Linux. REGION - The Amazon Web Services Region. SCOPE (Utilization only) - The scope of a Reserved Instance (RI). Values are regional or a single Availability Zone. TAG (Coverage only) - The tags that are associated with a Reserved Instance (RI). TENANCY - The tenancy of a resource. Examples are shared or dedicated. If you set the context to SAVINGS_PLANS, you can use the following dimensions for searching: SAVINGS_PLANS_TYPE - Type of Savings Plans (EC2 Instance or Compute) PAYMENT_OPTION - Payment option for the given Savings Plans (for example, All Upfront) REGION - The Amazon Web Services Region. INSTANCE_TYPE_FAMILY - The family of instances (For example, m5) LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value field contains the Amazon Web Services ID of the member account. SAVINGS_PLAN_ARN - The unique identifier for your Savings Plans.
|
|
1296
1296
|
*/
|
|
1297
1297
|
Context?: Context;
|
|
1298
1298
|
Filter?: Expression;
|
|
@@ -1333,7 +1333,7 @@ declare namespace CostExplorer {
|
|
|
1333
1333
|
*/
|
|
1334
1334
|
TimePeriod: DateInterval;
|
|
1335
1335
|
/**
|
|
1336
|
-
* You can group the data by the following attributes: AZ CACHE_ENGINE DATABASE_ENGINE DEPLOYMENT_OPTION INSTANCE_TYPE LINKED_ACCOUNT OPERATING_SYSTEM PLATFORM REGION TENANCY
|
|
1336
|
+
* You can group the data by the following attributes: AZ CACHE_ENGINE DATABASE_ENGINE DEPLOYMENT_OPTION INSTANCE_TYPE INVOICING_ENTITY LINKED_ACCOUNT OPERATING_SYSTEM PLATFORM REGION TENANCY
|
|
1337
1337
|
*/
|
|
1338
1338
|
GroupBy?: GroupDefinitions;
|
|
1339
1339
|
/**
|
|
@@ -1341,7 +1341,7 @@ declare namespace CostExplorer {
|
|
|
1341
1341
|
*/
|
|
1342
1342
|
Granularity?: Granularity;
|
|
1343
1343
|
/**
|
|
1344
|
-
* Filters utilization data by dimensions. You can filter by the following dimensions: AZ CACHE_ENGINE DATABASE_ENGINE DEPLOYMENT_OPTION INSTANCE_TYPE LINKED_ACCOUNT OPERATING_SYSTEM PLATFORM REGION SERVICE TAG TENANCY GetReservationCoverage uses the same Expression object as the other operations, but only AND is supported among each dimension. You can nest only one level deep. If you don't provide a SERVICE filter, Cost Explorer defaults to EC2. Cost category is also supported.
|
|
1344
|
+
* Filters utilization data by dimensions. You can filter by the following dimensions: AZ CACHE_ENGINE DATABASE_ENGINE DEPLOYMENT_OPTION INSTANCE_TYPE LINKED_ACCOUNT OPERATING_SYSTEM PLATFORM REGION SERVICE TAG TENANCY GetReservationCoverage uses the same Expression object as the other operations, but only AND is supported among each dimension. You can nest only one level deep. If there are multiple values for a dimension, they are OR'd together. If you don't provide a SERVICE filter, Cost Explorer defaults to EC2. Cost category is also supported.
|
|
1345
1345
|
*/
|
|
1346
1346
|
Filter?: Expression;
|
|
1347
1347
|
/**
|
|
@@ -1442,7 +1442,7 @@ declare namespace CostExplorer {
|
|
|
1442
1442
|
*/
|
|
1443
1443
|
Granularity?: Granularity;
|
|
1444
1444
|
/**
|
|
1445
|
-
* Filters utilization data by dimensions. You can filter by the following dimensions: AZ CACHE_ENGINE DEPLOYMENT_OPTION INSTANCE_TYPE LINKED_ACCOUNT OPERATING_SYSTEM PLATFORM REGION SERVICE SCOPE TENANCY GetReservationUtilization uses the same Expression object as the other operations, but only AND is supported among each dimension, and nesting is supported up to only one level deep.
|
|
1445
|
+
* Filters utilization data by dimensions. You can filter by the following dimensions: AZ CACHE_ENGINE DEPLOYMENT_OPTION INSTANCE_TYPE LINKED_ACCOUNT OPERATING_SYSTEM PLATFORM REGION SERVICE SCOPE TENANCY GetReservationUtilization uses the same Expression object as the other operations, but only AND is supported among each dimension, and nesting is supported up to only one level deep. If there are multiple values for a dimension, they are OR'd together.
|
|
1446
1446
|
*/
|
|
1447
1447
|
Filter?: Expression;
|
|
1448
1448
|
/**
|
|
@@ -1527,7 +1527,7 @@ declare namespace CostExplorer {
|
|
|
1527
1527
|
*/
|
|
1528
1528
|
Granularity?: Granularity;
|
|
1529
1529
|
/**
|
|
1530
|
-
* Filters Savings Plans coverage data by dimensions. You can filter data for Savings Plans usage with the following dimensions: LINKED_ACCOUNT REGION SERVICE INSTANCE_FAMILY GetSavingsPlansCoverage uses the same Expression object as the other operations, but only AND is supported among each dimension.
|
|
1530
|
+
* Filters Savings Plans coverage data by dimensions. You can filter data for Savings Plans usage with the following dimensions: LINKED_ACCOUNT REGION SERVICE INSTANCE_FAMILY GetSavingsPlansCoverage uses the same Expression object as the other operations, but only AND is supported among each dimension. If there are multiple values for a dimension, they are OR'd together. Cost category is also supported.
|
|
1531
1531
|
*/
|
|
1532
1532
|
Filter?: Expression;
|
|
1533
1533
|
/**
|
|
@@ -1611,7 +1611,7 @@ declare namespace CostExplorer {
|
|
|
1611
1611
|
*/
|
|
1612
1612
|
TimePeriod: DateInterval;
|
|
1613
1613
|
/**
|
|
1614
|
-
* Filters Savings Plans utilization coverage data for active Savings Plans dimensions. You can filter data with the following dimensions: LINKED_ACCOUNT SAVINGS_PLAN_ARN REGION PAYMENT_OPTION INSTANCE_TYPE_FAMILY GetSavingsPlansUtilizationDetails uses the same Expression object as the other operations, but only AND is supported among each dimension.
|
|
1614
|
+
* Filters Savings Plans utilization coverage data for active Savings Plans dimensions. You can filter data with the following dimensions: LINKED_ACCOUNT SAVINGS_PLAN_ARN REGION PAYMENT_OPTION INSTANCE_TYPE_FAMILY GetSavingsPlansUtilizationDetails uses the same Expression object as the other operations, but only AND is supported among each dimension.
|
|
1615
1615
|
*/
|
|
1616
1616
|
Filter?: Expression;
|
|
1617
1617
|
/**
|
|
@@ -1656,7 +1656,7 @@ declare namespace CostExplorer {
|
|
|
1656
1656
|
*/
|
|
1657
1657
|
Granularity?: Granularity;
|
|
1658
1658
|
/**
|
|
1659
|
-
* Filters Savings Plans utilization coverage data for active Savings Plans dimensions. You can filter data with the following dimensions: LINKED_ACCOUNT SAVINGS_PLAN_ARN SAVINGS_PLANS_TYPE REGION PAYMENT_OPTION INSTANCE_TYPE_FAMILY GetSavingsPlansUtilization uses the same Expression object as the other operations, but only AND is supported among each dimension.
|
|
1659
|
+
* Filters Savings Plans utilization coverage data for active Savings Plans dimensions. You can filter data with the following dimensions: LINKED_ACCOUNT SAVINGS_PLAN_ARN SAVINGS_PLANS_TYPE REGION PAYMENT_OPTION INSTANCE_TYPE_FAMILY GetSavingsPlansUtilization uses the same Expression object as the other operations, but only AND is supported among each dimension.
|
|
1660
1660
|
*/
|
|
1661
1661
|
Filter?: Expression;
|
|
1662
1662
|
/**
|
package/clients/dynamodb.d.ts
CHANGED
|
@@ -31,11 +31,11 @@ declare class DynamoDB extends DynamoDBCustomizations {
|
|
|
31
31
|
*/
|
|
32
32
|
batchGetItem(callback?: (err: AWSError, data: DynamoDB.Types.BatchGetItemOutput) => void): Request<DynamoDB.Types.BatchGetItemOutput, AWSError>;
|
|
33
33
|
/**
|
|
34
|
-
* The BatchWriteItem operation puts or deletes multiple items in one or more tables. A single call to BatchWriteItem can
|
|
34
|
+
* The BatchWriteItem operation puts or deletes multiple items in one or more tables. A single call to BatchWriteItem can transmit up to 16MB of data over the network, consisting of up to 25 item put or delete operations. While individual items can be up to 400 KB once stored, it's important to note that an item's representation might be greater than 400KB while being sent in DynamoDB's JSON format for the API call. For more details on this distinction, see Naming Rules and Data Types. BatchWriteItem cannot update items. To update items, use the UpdateItem action. The individual PutItem and DeleteItem operations specified in BatchWriteItem are atomic; however BatchWriteItem as a whole is not. If any requested operations fail because the table's provisioned throughput is exceeded or an internal processing failure occurs, the failed operations are returned in the UnprocessedItems response parameter. You can investigate and optionally resend the requests. Typically, you would call BatchWriteItem in a loop. Each iteration would check for unprocessed items and submit a new BatchWriteItem request with those unprocessed items until all items have been processed. If none of the items can be processed due to insufficient provisioned throughput on all of the tables in the request, then BatchWriteItem returns a ProvisionedThroughputExceededException. If DynamoDB returns any unprocessed items, you should retry the batch operation on those items. However, we strongly recommend that you use an exponential backoff algorithm. If you retry the batch operation immediately, the underlying read or write requests can still fail due to throttling on the individual tables. If you delay the batch operation using exponential backoff, the individual requests in the batch are much more likely to succeed. For more information, see Batch Operations and Error Handling in the Amazon DynamoDB Developer Guide. With BatchWriteItem, you can efficiently write or delete large amounts of data, such as from Amazon EMR, or copy data from another database into DynamoDB. In order to improve performance with these large-scale operations, BatchWriteItem does not behave in the same way as individual PutItem and DeleteItem calls would. For example, you cannot specify conditions on individual put and delete requests, and BatchWriteItem does not return deleted items in the response. If you use a programming language that supports concurrency, you can use threads to write items in parallel. Your application must include the necessary logic to manage the threads. With languages that don't support threading, you must update or delete the specified items one at a time. In both situations, BatchWriteItem performs the specified put and delete operations in parallel, giving you the power of the thread pool approach without having to introduce complexity into your application. Parallel processing reduces latency, but each specified put and delete request consumes the same number of write capacity units whether it is processed in parallel or not. Delete operations on nonexistent items consume one write capacity unit. If one or more of the following is true, DynamoDB rejects the entire batch write operation: One or more tables specified in the BatchWriteItem request does not exist. Primary key attributes specified on an item in the request do not match those in the corresponding table's primary key schema. You try to perform multiple operations on the same item in the same BatchWriteItem request. For example, you cannot put and delete the same item in the same BatchWriteItem request. Your request contains at least two items with identical hash and range keys (which essentially is two put operations). There are more than 25 requests in the batch. Any individual item in a batch exceeds 400 KB. The total request size exceeds 16 MB.
|
|
35
35
|
*/
|
|
36
36
|
batchWriteItem(params: DynamoDB.Types.BatchWriteItemInput, callback?: (err: AWSError, data: DynamoDB.Types.BatchWriteItemOutput) => void): Request<DynamoDB.Types.BatchWriteItemOutput, AWSError>;
|
|
37
37
|
/**
|
|
38
|
-
* The BatchWriteItem operation puts or deletes multiple items in one or more tables. A single call to BatchWriteItem can
|
|
38
|
+
* The BatchWriteItem operation puts or deletes multiple items in one or more tables. A single call to BatchWriteItem can transmit up to 16MB of data over the network, consisting of up to 25 item put or delete operations. While individual items can be up to 400 KB once stored, it's important to note that an item's representation might be greater than 400KB while being sent in DynamoDB's JSON format for the API call. For more details on this distinction, see Naming Rules and Data Types. BatchWriteItem cannot update items. To update items, use the UpdateItem action. The individual PutItem and DeleteItem operations specified in BatchWriteItem are atomic; however BatchWriteItem as a whole is not. If any requested operations fail because the table's provisioned throughput is exceeded or an internal processing failure occurs, the failed operations are returned in the UnprocessedItems response parameter. You can investigate and optionally resend the requests. Typically, you would call BatchWriteItem in a loop. Each iteration would check for unprocessed items and submit a new BatchWriteItem request with those unprocessed items until all items have been processed. If none of the items can be processed due to insufficient provisioned throughput on all of the tables in the request, then BatchWriteItem returns a ProvisionedThroughputExceededException. If DynamoDB returns any unprocessed items, you should retry the batch operation on those items. However, we strongly recommend that you use an exponential backoff algorithm. If you retry the batch operation immediately, the underlying read or write requests can still fail due to throttling on the individual tables. If you delay the batch operation using exponential backoff, the individual requests in the batch are much more likely to succeed. For more information, see Batch Operations and Error Handling in the Amazon DynamoDB Developer Guide. With BatchWriteItem, you can efficiently write or delete large amounts of data, such as from Amazon EMR, or copy data from another database into DynamoDB. In order to improve performance with these large-scale operations, BatchWriteItem does not behave in the same way as individual PutItem and DeleteItem calls would. For example, you cannot specify conditions on individual put and delete requests, and BatchWriteItem does not return deleted items in the response. If you use a programming language that supports concurrency, you can use threads to write items in parallel. Your application must include the necessary logic to manage the threads. With languages that don't support threading, you must update or delete the specified items one at a time. In both situations, BatchWriteItem performs the specified put and delete operations in parallel, giving you the power of the thread pool approach without having to introduce complexity into your application. Parallel processing reduces latency, but each specified put and delete request consumes the same number of write capacity units whether it is processed in parallel or not. Delete operations on nonexistent items consume one write capacity unit. If one or more of the following is true, DynamoDB rejects the entire batch write operation: One or more tables specified in the BatchWriteItem request does not exist. Primary key attributes specified on an item in the request do not match those in the corresponding table's primary key schema. You try to perform multiple operations on the same item in the same BatchWriteItem request. For example, you cannot put and delete the same item in the same BatchWriteItem request. Your request contains at least two items with identical hash and range keys (which essentially is two put operations). There are more than 25 requests in the batch. Any individual item in a batch exceeds 400 KB. The total request size exceeds 16 MB.
|
|
39
39
|
*/
|
|
40
40
|
batchWriteItem(callback?: (err: AWSError, data: DynamoDB.Types.BatchWriteItemOutput) => void): Request<DynamoDB.Types.BatchWriteItemOutput, AWSError>;
|
|
41
41
|
/**
|
|
@@ -359,11 +359,11 @@ declare class DynamoDB extends DynamoDBCustomizations {
|
|
|
359
359
|
*/
|
|
360
360
|
updateContinuousBackups(callback?: (err: AWSError, data: DynamoDB.Types.UpdateContinuousBackupsOutput) => void): Request<DynamoDB.Types.UpdateContinuousBackupsOutput, AWSError>;
|
|
361
361
|
/**
|
|
362
|
-
* Updates the status for contributor insights for a specific table or index. CloudWatch Contributor Insights for DynamoDB graphs display the partition key and (if applicable) sort key of frequently accessed items and frequently throttled items in plaintext. If you require the use of
|
|
362
|
+
* Updates the status for contributor insights for a specific table or index. CloudWatch Contributor Insights for DynamoDB graphs display the partition key and (if applicable) sort key of frequently accessed items and frequently throttled items in plaintext. If you require the use of Amazon Web Services Key Management Service (KMS) to encrypt this table’s partition key and sort key data with an Amazon Web Services managed key or customer managed key, you should not enable CloudWatch Contributor Insights for DynamoDB for this table.
|
|
363
363
|
*/
|
|
364
364
|
updateContributorInsights(params: DynamoDB.Types.UpdateContributorInsightsInput, callback?: (err: AWSError, data: DynamoDB.Types.UpdateContributorInsightsOutput) => void): Request<DynamoDB.Types.UpdateContributorInsightsOutput, AWSError>;
|
|
365
365
|
/**
|
|
366
|
-
* Updates the status for contributor insights for a specific table or index. CloudWatch Contributor Insights for DynamoDB graphs display the partition key and (if applicable) sort key of frequently accessed items and frequently throttled items in plaintext. If you require the use of
|
|
366
|
+
* Updates the status for contributor insights for a specific table or index. CloudWatch Contributor Insights for DynamoDB graphs display the partition key and (if applicable) sort key of frequently accessed items and frequently throttled items in plaintext. If you require the use of Amazon Web Services Key Management Service (KMS) to encrypt this table’s partition key and sort key data with an Amazon Web Services managed key or customer managed key, you should not enable CloudWatch Contributor Insights for DynamoDB for this table.
|
|
367
367
|
*/
|
|
368
368
|
updateContributorInsights(callback?: (err: AWSError, data: DynamoDB.Types.UpdateContributorInsightsOutput) => void): Request<DynamoDB.Types.UpdateContributorInsightsOutput, AWSError>;
|
|
369
369
|
/**
|
|
@@ -2191,7 +2191,7 @@ declare namespace DynamoDB {
|
|
|
2191
2191
|
export type PartiQLStatement = string;
|
|
2192
2192
|
export interface PointInTimeRecoveryDescription {
|
|
2193
2193
|
/**
|
|
2194
|
-
* The current state of point in time recovery:
|
|
2194
|
+
* The current state of point in time recovery: ENABLED - Point in time recovery is enabled. DISABLED - Point in time recovery is disabled.
|
|
2195
2195
|
*/
|
|
2196
2196
|
PointInTimeRecoveryStatus?: PointInTimeRecoveryStatus;
|
|
2197
2197
|
/**
|