cdk-comprehend-s3olap 2.0.141 → 2.0.143
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/.jsii +3 -3
- package/lib/cdk-comprehend-s3olap.js +2 -2
- package/lib/comprehend-lambdas.js +2 -2
- package/lib/iam-roles.js +4 -4
- package/node_modules/aws-sdk/CHANGELOG.md +13 -1
- package/node_modules/aws-sdk/README.md +1 -1
- package/node_modules/aws-sdk/apis/appflow-2020-08-23.min.json +178 -149
- package/node_modules/aws-sdk/apis/compute-optimizer-2019-11-01.min.json +60 -21
- package/node_modules/aws-sdk/apis/kendra-2019-02-03.min.json +137 -65
- package/node_modules/aws-sdk/apis/kms-2014-11-01.examples.json +197 -15
- package/node_modules/aws-sdk/apis/kms-2014-11-01.min.json +52 -19
- package/node_modules/aws-sdk/apis/resiliencehub-2020-04-30.min.json +71 -70
- package/node_modules/aws-sdk/apis/sagemaker-2017-07-24.min.json +893 -892
- package/node_modules/aws-sdk/clients/appflow.d.ts +26 -1
- package/node_modules/aws-sdk/clients/computeoptimizer.d.ts +58 -14
- package/node_modules/aws-sdk/clients/connect.d.ts +1 -1
- package/node_modules/aws-sdk/clients/ecs.d.ts +2 -2
- package/node_modules/aws-sdk/clients/kendra.d.ts +92 -5
- package/node_modules/aws-sdk/clients/kms.d.ts +76 -32
- package/node_modules/aws-sdk/clients/resiliencehub.d.ts +12 -3
- package/node_modules/aws-sdk/clients/sagemaker.d.ts +6 -1
- package/node_modules/aws-sdk/dist/aws-sdk-core-react-native.js +10 -1
- package/node_modules/aws-sdk/dist/aws-sdk-react-native.js +18 -10
- package/node_modules/aws-sdk/dist/aws-sdk.js +66 -25
- package/node_modules/aws-sdk/dist/aws-sdk.min.js +43 -43
- package/node_modules/aws-sdk/lib/core.js +1 -1
- package/node_modules/aws-sdk/lib/protocol/json.js +9 -0
- package/node_modules/aws-sdk/lib/services/sqs.js +2 -3
- package/node_modules/aws-sdk/package.json +1 -1
- package/package.json +3 -3
@@ -11,6 +11,14 @@ declare class Appflow extends Service {
|
|
11
11
|
*/
|
12
12
|
constructor(options?: Appflow.Types.ClientConfiguration)
|
13
13
|
config: Config & Appflow.Types.ClientConfiguration;
|
14
|
+
/**
|
15
|
+
* Cancels active runs for a flow. You can cancel all of the active runs for a flow, or you can cancel specific runs by providing their IDs. You can cancel a flow run only when the run is in progress. You can't cancel a run that has already completed or failed. You also can't cancel a run that's scheduled to occur but hasn't started yet. To prevent a scheduled run, you can deactivate the flow with the StopFlow action. You cannot resume a run after you cancel it. When you send your request, the status for each run becomes CancelStarted. When the cancellation completes, the status becomes Canceled. When you cancel a run, you still incur charges for any data that the run already processed before the cancellation. If the run had already written some data to the flow destination, then that data remains in the destination. If you configured the flow to use a batch API (such as the Salesforce Bulk API 2.0), then the run will finish reading or writing its entire batch of data after the cancellation. For these operations, the data processing charges for Amazon AppFlow apply. For the pricing information, see Amazon AppFlow pricing.
|
16
|
+
*/
|
17
|
+
cancelFlowExecutions(params: Appflow.Types.CancelFlowExecutionsRequest, callback?: (err: AWSError, data: Appflow.Types.CancelFlowExecutionsResponse) => void): Request<Appflow.Types.CancelFlowExecutionsResponse, AWSError>;
|
18
|
+
/**
|
19
|
+
* Cancels active runs for a flow. You can cancel all of the active runs for a flow, or you can cancel specific runs by providing their IDs. You can cancel a flow run only when the run is in progress. You can't cancel a run that has already completed or failed. You also can't cancel a run that's scheduled to occur but hasn't started yet. To prevent a scheduled run, you can deactivate the flow with the StopFlow action. You cannot resume a run after you cancel it. When you send your request, the status for each run becomes CancelStarted. When the cancellation completes, the status becomes Canceled. When you cancel a run, you still incur charges for any data that the run already processed before the cancellation. If the run had already written some data to the flow destination, then that data remains in the destination. If you configured the flow to use a batch API (such as the Salesforce Bulk API 2.0), then the run will finish reading or writing its entire batch of data after the cancellation. For these operations, the data processing charges for Amazon AppFlow apply. For the pricing information, see Amazon AppFlow pricing.
|
20
|
+
*/
|
21
|
+
cancelFlowExecutions(callback?: (err: AWSError, data: Appflow.Types.CancelFlowExecutionsResponse) => void): Request<Appflow.Types.CancelFlowExecutionsResponse, AWSError>;
|
14
22
|
/**
|
15
23
|
* Creates a new connector profile associated with your Amazon Web Services account. There is a soft quota of 100 connector profiles per Amazon Web Services account. If you need more connector profiles than this quota allows, you can submit a request to the Amazon AppFlow team through the Amazon AppFlow support channel. In each connector profile that you create, you can provide the credentials and properties for only one connector.
|
16
24
|
*/
|
@@ -322,6 +330,22 @@ declare namespace Appflow {
|
|
322
330
|
export type BucketName = string;
|
323
331
|
export type BucketPrefix = string;
|
324
332
|
export type BusinessUnitId = string;
|
333
|
+
export interface CancelFlowExecutionsRequest {
|
334
|
+
/**
|
335
|
+
* The name of a flow with active runs that you want to cancel.
|
336
|
+
*/
|
337
|
+
flowName: FlowName;
|
338
|
+
/**
|
339
|
+
* The ID of each active run to cancel. These runs must belong to the flow you specify in your request. If you omit this parameter, your request ends all active runs that belong to the flow.
|
340
|
+
*/
|
341
|
+
executionIds?: ExecutionIds;
|
342
|
+
}
|
343
|
+
export interface CancelFlowExecutionsResponse {
|
344
|
+
/**
|
345
|
+
* The IDs of runs that Amazon AppFlow couldn't cancel. These runs might be ineligible for canceling because they haven't started yet or have already completed.
|
346
|
+
*/
|
347
|
+
invalidExecutions?: ExecutionIds;
|
348
|
+
}
|
325
349
|
export type CatalogType = "GLUE"|string;
|
326
350
|
export type ClientCredentialsArn = string;
|
327
351
|
export type ClientId = string;
|
@@ -1597,6 +1621,7 @@ declare namespace Appflow {
|
|
1597
1621
|
mostRecentExecutionStatus?: ExecutionStatus;
|
1598
1622
|
}
|
1599
1623
|
export type ExecutionId = string;
|
1624
|
+
export type ExecutionIds = ExecutionId[];
|
1600
1625
|
export type ExecutionMessage = string;
|
1601
1626
|
export interface ExecutionRecord {
|
1602
1627
|
/**
|
@@ -1650,7 +1675,7 @@ declare namespace Appflow {
|
|
1650
1675
|
*/
|
1651
1676
|
recordsProcessed?: Long;
|
1652
1677
|
}
|
1653
|
-
export type ExecutionStatus = "InProgress"|"Successful"|"Error"|string;
|
1678
|
+
export type ExecutionStatus = "InProgress"|"Successful"|"Error"|"CancelStarted"|"Canceled"|string;
|
1654
1679
|
export type FieldType = string;
|
1655
1680
|
export interface FieldTypeDetails {
|
1656
1681
|
/**
|
@@ -270,7 +270,7 @@ declare namespace ComputeOptimizer {
|
|
270
270
|
*/
|
271
271
|
effectiveRecommendationPreferences?: EffectiveRecommendationPreferences;
|
272
272
|
/**
|
273
|
-
* The applications that might be running on the instances in the Auto Scaling group as inferred by Compute Optimizer. Compute Optimizer can infer if one of the following applications might be running on the instances: AmazonEmr - Infers that Amazon EMR might be running on the instances. ApacheCassandra - Infers that Apache Cassandra might be running on the instances. ApacheHadoop - Infers that Apache Hadoop might be running on the instances. Memcached - Infers that Memcached might be running on the instances. NGINX - Infers that NGINX might be running on the instances. PostgreSql - Infers that PostgreSQL might be running on the instances. Redis - Infers that Redis might be running on the instances.
|
273
|
+
* The applications that might be running on the instances in the Auto Scaling group as inferred by Compute Optimizer. Compute Optimizer can infer if one of the following applications might be running on the instances: AmazonEmr - Infers that Amazon EMR might be running on the instances. ApacheCassandra - Infers that Apache Cassandra might be running on the instances. ApacheHadoop - Infers that Apache Hadoop might be running on the instances. Memcached - Infers that Memcached might be running on the instances. NGINX - Infers that NGINX might be running on the instances. PostgreSql - Infers that PostgreSQL might be running on the instances. Redis - Infers that Redis might be running on the instances. Kafka - Infers that Kafka might be running on the instance. SQLServer - Infers that SQLServer might be running on the instance.
|
274
274
|
*/
|
275
275
|
inferredWorkloadTypes?: InferredWorkloadTypes;
|
276
276
|
}
|
@@ -409,7 +409,7 @@ declare namespace ComputeOptimizer {
|
|
409
409
|
export type DestinationKeyPrefix = string;
|
410
410
|
export interface EBSFilter {
|
411
411
|
/**
|
412
|
-
* The name of the filter. Specify Finding to return recommendations with a specific finding classification (for example, NotOptimized).
|
412
|
+
* The name of the filter. Specify Finding to return recommendations with a specific finding classification (for example, NotOptimized). You can filter your Amazon EBS volume recommendations by tag:key and tag-key tags. A tag:key is a key and value combination of a tag assigned to your Amazon EBS volume recommendations. Use the tag key in the filter name and the tag value as the filter value. For example, to find all Amazon EBS volume recommendations that have a tag with the key of Owner and the value of TeamA, specify tag:Owner for the filter name and TeamA for the filter value. A tag-key is the key of a tag assigned to your Amazon EBS volume recommendations. Use this filter to find all of your Amazon EBS volume recommendations that have a tag with a specific key. This doesn’t consider the tag value. For example, you can find your Amazon EBS volume recommendations with a tag key value of Owner or without any tag keys assigned.
|
413
413
|
*/
|
414
414
|
name?: EBSFilterName;
|
415
415
|
/**
|
@@ -522,10 +522,14 @@ declare namespace ComputeOptimizer {
|
|
522
522
|
* The risk of the current Amazon ECS service not meeting the performance needs of its workloads. The higher the risk, the more likely the current service can't meet the performance requirements of its workload.
|
523
523
|
*/
|
524
524
|
currentPerformanceRisk?: CurrentPerformanceRisk;
|
525
|
+
/**
|
526
|
+
* A list of tags assigned to your Amazon ECS service recommendations.
|
527
|
+
*/
|
528
|
+
tags?: Tags;
|
525
529
|
}
|
526
530
|
export interface ECSServiceRecommendationFilter {
|
527
531
|
/**
|
528
|
-
* The name of the filter. Specify Finding to return recommendations with a specific finding classification. Specify FindingReasonCode to return recommendations with a specific finding reason code.
|
532
|
+
* The name of the filter. Specify Finding to return recommendations with a specific finding classification. Specify FindingReasonCode to return recommendations with a specific finding reason code. You can filter your Amazon ECS service recommendations by tag:key and tag-key tags. A tag:key is a key and value combination of a tag assigned to your Amazon ECS service recommendations. Use the tag key in the filter name and the tag value as the filter value. For example, to find all Amazon ECS service recommendations that have a tag with the key of Owner and the value of TeamA, specify tag:Owner for the filter name and TeamA for the filter value. A tag-key is the key of a tag assigned to your Amazon ECS service recommendations. Use this filter to find all of your Amazon ECS service recommendations that have a tag with a specific key. This doesn’t consider the tag value. For example, you can find your Amazon ECS service recommendations with a tag key value of Owner or without any tag keys assigned.
|
529
533
|
*/
|
530
534
|
name?: ECSServiceRecommendationFilterName;
|
531
535
|
/**
|
@@ -808,13 +812,13 @@ declare namespace ComputeOptimizer {
|
|
808
812
|
}
|
809
813
|
export type ExportableAutoScalingGroupField = "AccountId"|"AutoScalingGroupArn"|"AutoScalingGroupName"|"Finding"|"UtilizationMetricsCpuMaximum"|"UtilizationMetricsMemoryMaximum"|"UtilizationMetricsEbsReadOpsPerSecondMaximum"|"UtilizationMetricsEbsWriteOpsPerSecondMaximum"|"UtilizationMetricsEbsReadBytesPerSecondMaximum"|"UtilizationMetricsEbsWriteBytesPerSecondMaximum"|"UtilizationMetricsDiskReadOpsPerSecondMaximum"|"UtilizationMetricsDiskWriteOpsPerSecondMaximum"|"UtilizationMetricsDiskReadBytesPerSecondMaximum"|"UtilizationMetricsDiskWriteBytesPerSecondMaximum"|"UtilizationMetricsNetworkInBytesPerSecondMaximum"|"UtilizationMetricsNetworkOutBytesPerSecondMaximum"|"UtilizationMetricsNetworkPacketsInPerSecondMaximum"|"UtilizationMetricsNetworkPacketsOutPerSecondMaximum"|"LookbackPeriodInDays"|"CurrentConfigurationInstanceType"|"CurrentConfigurationDesiredCapacity"|"CurrentConfigurationMinSize"|"CurrentConfigurationMaxSize"|"CurrentOnDemandPrice"|"CurrentStandardOneYearNoUpfrontReservedPrice"|"CurrentStandardThreeYearNoUpfrontReservedPrice"|"CurrentVCpus"|"CurrentMemory"|"CurrentStorage"|"CurrentNetwork"|"RecommendationOptionsConfigurationInstanceType"|"RecommendationOptionsConfigurationDesiredCapacity"|"RecommendationOptionsConfigurationMinSize"|"RecommendationOptionsConfigurationMaxSize"|"RecommendationOptionsProjectedUtilizationMetricsCpuMaximum"|"RecommendationOptionsProjectedUtilizationMetricsMemoryMaximum"|"RecommendationOptionsPerformanceRisk"|"RecommendationOptionsOnDemandPrice"|"RecommendationOptionsStandardOneYearNoUpfrontReservedPrice"|"RecommendationOptionsStandardThreeYearNoUpfrontReservedPrice"|"RecommendationOptionsVcpus"|"RecommendationOptionsMemory"|"RecommendationOptionsStorage"|"RecommendationOptionsNetwork"|"LastRefreshTimestamp"|"CurrentPerformanceRisk"|"RecommendationOptionsSavingsOpportunityPercentage"|"RecommendationOptionsEstimatedMonthlySavingsCurrency"|"RecommendationOptionsEstimatedMonthlySavingsValue"|"EffectiveRecommendationPreferencesCpuVendorArchitectures"|"EffectiveRecommendationPreferencesEnhancedInfrastructureMetrics"|"EffectiveRecommendationPreferencesInferredWorkloadTypes"|"InferredWorkloadTypes"|"RecommendationOptionsMigrationEffort"|string;
|
810
814
|
export type ExportableAutoScalingGroupFields = ExportableAutoScalingGroupField[];
|
811
|
-
export type ExportableECSServiceField = "AccountId"|"ServiceArn"|"LookbackPeriodInDays"|"LastRefreshTimestamp"|"LaunchType"|"CurrentPerformanceRisk"|"CurrentServiceConfigurationMemory"|"CurrentServiceConfigurationCpu"|"CurrentServiceConfigurationTaskDefinitionArn"|"CurrentServiceConfigurationAutoScalingConfiguration"|"CurrentServiceContainerConfigurations"|"UtilizationMetricsCpuMaximum"|"UtilizationMetricsMemoryMaximum"|"Finding"|"FindingReasonCodes"|"RecommendationOptionsMemory"|"RecommendationOptionsCpu"|"RecommendationOptionsSavingsOpportunityPercentage"|"RecommendationOptionsEstimatedMonthlySavingsCurrency"|"RecommendationOptionsEstimatedMonthlySavingsValue"|"RecommendationOptionsContainerRecommendations"|"RecommendationOptionsProjectedUtilizationMetricsCpuMaximum"|"RecommendationOptionsProjectedUtilizationMetricsMemoryMaximum"|string;
|
815
|
+
export type ExportableECSServiceField = "AccountId"|"ServiceArn"|"LookbackPeriodInDays"|"LastRefreshTimestamp"|"LaunchType"|"CurrentPerformanceRisk"|"CurrentServiceConfigurationMemory"|"CurrentServiceConfigurationCpu"|"CurrentServiceConfigurationTaskDefinitionArn"|"CurrentServiceConfigurationAutoScalingConfiguration"|"CurrentServiceContainerConfigurations"|"UtilizationMetricsCpuMaximum"|"UtilizationMetricsMemoryMaximum"|"Finding"|"FindingReasonCodes"|"RecommendationOptionsMemory"|"RecommendationOptionsCpu"|"RecommendationOptionsSavingsOpportunityPercentage"|"RecommendationOptionsEstimatedMonthlySavingsCurrency"|"RecommendationOptionsEstimatedMonthlySavingsValue"|"RecommendationOptionsContainerRecommendations"|"RecommendationOptionsProjectedUtilizationMetricsCpuMaximum"|"RecommendationOptionsProjectedUtilizationMetricsMemoryMaximum"|"Tags"|string;
|
812
816
|
export type ExportableECSServiceFields = ExportableECSServiceField[];
|
813
|
-
export type ExportableInstanceField = "AccountId"|"InstanceArn"|"InstanceName"|"Finding"|"FindingReasonCodes"|"LookbackPeriodInDays"|"CurrentInstanceType"|"UtilizationMetricsCpuMaximum"|"UtilizationMetricsMemoryMaximum"|"UtilizationMetricsEbsReadOpsPerSecondMaximum"|"UtilizationMetricsEbsWriteOpsPerSecondMaximum"|"UtilizationMetricsEbsReadBytesPerSecondMaximum"|"UtilizationMetricsEbsWriteBytesPerSecondMaximum"|"UtilizationMetricsDiskReadOpsPerSecondMaximum"|"UtilizationMetricsDiskWriteOpsPerSecondMaximum"|"UtilizationMetricsDiskReadBytesPerSecondMaximum"|"UtilizationMetricsDiskWriteBytesPerSecondMaximum"|"UtilizationMetricsNetworkInBytesPerSecondMaximum"|"UtilizationMetricsNetworkOutBytesPerSecondMaximum"|"UtilizationMetricsNetworkPacketsInPerSecondMaximum"|"UtilizationMetricsNetworkPacketsOutPerSecondMaximum"|"CurrentOnDemandPrice"|"CurrentStandardOneYearNoUpfrontReservedPrice"|"CurrentStandardThreeYearNoUpfrontReservedPrice"|"CurrentVCpus"|"CurrentMemory"|"CurrentStorage"|"CurrentNetwork"|"RecommendationOptionsInstanceType"|"RecommendationOptionsProjectedUtilizationMetricsCpuMaximum"|"RecommendationOptionsProjectedUtilizationMetricsMemoryMaximum"|"RecommendationOptionsPlatformDifferences"|"RecommendationOptionsPerformanceRisk"|"RecommendationOptionsVcpus"|"RecommendationOptionsMemory"|"RecommendationOptionsStorage"|"RecommendationOptionsNetwork"|"RecommendationOptionsOnDemandPrice"|"RecommendationOptionsStandardOneYearNoUpfrontReservedPrice"|"RecommendationOptionsStandardThreeYearNoUpfrontReservedPrice"|"RecommendationsSourcesRecommendationSourceArn"|"RecommendationsSourcesRecommendationSourceType"|"LastRefreshTimestamp"|"CurrentPerformanceRisk"|"RecommendationOptionsSavingsOpportunityPercentage"|"RecommendationOptionsEstimatedMonthlySavingsCurrency"|"RecommendationOptionsEstimatedMonthlySavingsValue"|"EffectiveRecommendationPreferencesCpuVendorArchitectures"|"EffectiveRecommendationPreferencesEnhancedInfrastructureMetrics"|"EffectiveRecommendationPreferencesInferredWorkloadTypes"|"InferredWorkloadTypes"|"RecommendationOptionsMigrationEffort"|"EffectiveRecommendationPreferencesExternalMetricsSource"|"InstanceState"|string;
|
817
|
+
export type ExportableInstanceField = "AccountId"|"InstanceArn"|"InstanceName"|"Finding"|"FindingReasonCodes"|"LookbackPeriodInDays"|"CurrentInstanceType"|"UtilizationMetricsCpuMaximum"|"UtilizationMetricsMemoryMaximum"|"UtilizationMetricsEbsReadOpsPerSecondMaximum"|"UtilizationMetricsEbsWriteOpsPerSecondMaximum"|"UtilizationMetricsEbsReadBytesPerSecondMaximum"|"UtilizationMetricsEbsWriteBytesPerSecondMaximum"|"UtilizationMetricsDiskReadOpsPerSecondMaximum"|"UtilizationMetricsDiskWriteOpsPerSecondMaximum"|"UtilizationMetricsDiskReadBytesPerSecondMaximum"|"UtilizationMetricsDiskWriteBytesPerSecondMaximum"|"UtilizationMetricsNetworkInBytesPerSecondMaximum"|"UtilizationMetricsNetworkOutBytesPerSecondMaximum"|"UtilizationMetricsNetworkPacketsInPerSecondMaximum"|"UtilizationMetricsNetworkPacketsOutPerSecondMaximum"|"CurrentOnDemandPrice"|"CurrentStandardOneYearNoUpfrontReservedPrice"|"CurrentStandardThreeYearNoUpfrontReservedPrice"|"CurrentVCpus"|"CurrentMemory"|"CurrentStorage"|"CurrentNetwork"|"RecommendationOptionsInstanceType"|"RecommendationOptionsProjectedUtilizationMetricsCpuMaximum"|"RecommendationOptionsProjectedUtilizationMetricsMemoryMaximum"|"RecommendationOptionsPlatformDifferences"|"RecommendationOptionsPerformanceRisk"|"RecommendationOptionsVcpus"|"RecommendationOptionsMemory"|"RecommendationOptionsStorage"|"RecommendationOptionsNetwork"|"RecommendationOptionsOnDemandPrice"|"RecommendationOptionsStandardOneYearNoUpfrontReservedPrice"|"RecommendationOptionsStandardThreeYearNoUpfrontReservedPrice"|"RecommendationsSourcesRecommendationSourceArn"|"RecommendationsSourcesRecommendationSourceType"|"LastRefreshTimestamp"|"CurrentPerformanceRisk"|"RecommendationOptionsSavingsOpportunityPercentage"|"RecommendationOptionsEstimatedMonthlySavingsCurrency"|"RecommendationOptionsEstimatedMonthlySavingsValue"|"EffectiveRecommendationPreferencesCpuVendorArchitectures"|"EffectiveRecommendationPreferencesEnhancedInfrastructureMetrics"|"EffectiveRecommendationPreferencesInferredWorkloadTypes"|"InferredWorkloadTypes"|"RecommendationOptionsMigrationEffort"|"EffectiveRecommendationPreferencesExternalMetricsSource"|"InstanceState"|"Tags"|string;
|
814
818
|
export type ExportableInstanceFields = ExportableInstanceField[];
|
815
|
-
export type ExportableLambdaFunctionField = "AccountId"|"FunctionArn"|"FunctionVersion"|"Finding"|"FindingReasonCodes"|"NumberOfInvocations"|"UtilizationMetricsDurationMaximum"|"UtilizationMetricsDurationAverage"|"UtilizationMetricsMemoryMaximum"|"UtilizationMetricsMemoryAverage"|"LookbackPeriodInDays"|"CurrentConfigurationMemorySize"|"CurrentConfigurationTimeout"|"CurrentCostTotal"|"CurrentCostAverage"|"RecommendationOptionsConfigurationMemorySize"|"RecommendationOptionsCostLow"|"RecommendationOptionsCostHigh"|"RecommendationOptionsProjectedUtilizationMetricsDurationLowerBound"|"RecommendationOptionsProjectedUtilizationMetricsDurationUpperBound"|"RecommendationOptionsProjectedUtilizationMetricsDurationExpected"|"LastRefreshTimestamp"|"CurrentPerformanceRisk"|"RecommendationOptionsSavingsOpportunityPercentage"|"RecommendationOptionsEstimatedMonthlySavingsCurrency"|"RecommendationOptionsEstimatedMonthlySavingsValue"|string;
|
819
|
+
export type ExportableLambdaFunctionField = "AccountId"|"FunctionArn"|"FunctionVersion"|"Finding"|"FindingReasonCodes"|"NumberOfInvocations"|"UtilizationMetricsDurationMaximum"|"UtilizationMetricsDurationAverage"|"UtilizationMetricsMemoryMaximum"|"UtilizationMetricsMemoryAverage"|"LookbackPeriodInDays"|"CurrentConfigurationMemorySize"|"CurrentConfigurationTimeout"|"CurrentCostTotal"|"CurrentCostAverage"|"RecommendationOptionsConfigurationMemorySize"|"RecommendationOptionsCostLow"|"RecommendationOptionsCostHigh"|"RecommendationOptionsProjectedUtilizationMetricsDurationLowerBound"|"RecommendationOptionsProjectedUtilizationMetricsDurationUpperBound"|"RecommendationOptionsProjectedUtilizationMetricsDurationExpected"|"LastRefreshTimestamp"|"CurrentPerformanceRisk"|"RecommendationOptionsSavingsOpportunityPercentage"|"RecommendationOptionsEstimatedMonthlySavingsCurrency"|"RecommendationOptionsEstimatedMonthlySavingsValue"|"Tags"|string;
|
816
820
|
export type ExportableLambdaFunctionFields = ExportableLambdaFunctionField[];
|
817
|
-
export type ExportableVolumeField = "AccountId"|"VolumeArn"|"Finding"|"UtilizationMetricsVolumeReadOpsPerSecondMaximum"|"UtilizationMetricsVolumeWriteOpsPerSecondMaximum"|"UtilizationMetricsVolumeReadBytesPerSecondMaximum"|"UtilizationMetricsVolumeWriteBytesPerSecondMaximum"|"LookbackPeriodInDays"|"CurrentConfigurationVolumeType"|"CurrentConfigurationVolumeBaselineIOPS"|"CurrentConfigurationVolumeBaselineThroughput"|"CurrentConfigurationVolumeBurstIOPS"|"CurrentConfigurationVolumeBurstThroughput"|"CurrentConfigurationVolumeSize"|"CurrentMonthlyPrice"|"RecommendationOptionsConfigurationVolumeType"|"RecommendationOptionsConfigurationVolumeBaselineIOPS"|"RecommendationOptionsConfigurationVolumeBaselineThroughput"|"RecommendationOptionsConfigurationVolumeBurstIOPS"|"RecommendationOptionsConfigurationVolumeBurstThroughput"|"RecommendationOptionsConfigurationVolumeSize"|"RecommendationOptionsMonthlyPrice"|"RecommendationOptionsPerformanceRisk"|"LastRefreshTimestamp"|"CurrentPerformanceRisk"|"RecommendationOptionsSavingsOpportunityPercentage"|"RecommendationOptionsEstimatedMonthlySavingsCurrency"|"RecommendationOptionsEstimatedMonthlySavingsValue"|"RootVolume"|string;
|
821
|
+
export type ExportableVolumeField = "AccountId"|"VolumeArn"|"Finding"|"UtilizationMetricsVolumeReadOpsPerSecondMaximum"|"UtilizationMetricsVolumeWriteOpsPerSecondMaximum"|"UtilizationMetricsVolumeReadBytesPerSecondMaximum"|"UtilizationMetricsVolumeWriteBytesPerSecondMaximum"|"LookbackPeriodInDays"|"CurrentConfigurationVolumeType"|"CurrentConfigurationVolumeBaselineIOPS"|"CurrentConfigurationVolumeBaselineThroughput"|"CurrentConfigurationVolumeBurstIOPS"|"CurrentConfigurationVolumeBurstThroughput"|"CurrentConfigurationVolumeSize"|"CurrentMonthlyPrice"|"RecommendationOptionsConfigurationVolumeType"|"RecommendationOptionsConfigurationVolumeBaselineIOPS"|"RecommendationOptionsConfigurationVolumeBaselineThroughput"|"RecommendationOptionsConfigurationVolumeBurstIOPS"|"RecommendationOptionsConfigurationVolumeBurstThroughput"|"RecommendationOptionsConfigurationVolumeSize"|"RecommendationOptionsMonthlyPrice"|"RecommendationOptionsPerformanceRisk"|"LastRefreshTimestamp"|"CurrentPerformanceRisk"|"RecommendationOptionsSavingsOpportunityPercentage"|"RecommendationOptionsEstimatedMonthlySavingsCurrency"|"RecommendationOptionsEstimatedMonthlySavingsValue"|"RootVolume"|"Tags"|string;
|
818
822
|
export type ExportableVolumeFields = ExportableVolumeField[];
|
819
823
|
export interface ExternalMetricsPreference {
|
820
824
|
/**
|
@@ -827,7 +831,7 @@ declare namespace ComputeOptimizer {
|
|
827
831
|
export type FileFormat = "Csv"|string;
|
828
832
|
export interface Filter {
|
829
833
|
/**
|
830
|
-
* The name of the filter. Specify Finding to return recommendations with a specific finding classification
|
834
|
+
* The name of the filter. Specify Finding to return recommendations with a specific finding classification. For example, Underprovisioned. Specify RecommendationSourceType to return recommendations of a specific resource type. For example, Ec2Instance. Specify FindingReasonCodes to return recommendations with a specific finding reason code. For example, CPUUnderprovisioned. Specify InferredWorkloadTypes to return recommendations of a specific inferred workload. For example, Redis. You can filter your EC2 instance recommendations by tag:key and tag-key tags. A tag:key is a key and value combination of a tag assigned to your recommendations. Use the tag key in the filter name and the tag value as the filter value. For example, to find all recommendations that have a tag with the key of Owner and the value of TeamA, specify tag:Owner for the filter name and TeamA for the filter value. A tag-key is the key of a tag assigned to your recommendations. Use this filter to find all of your recommendations that have a tag with a specific key. This doesn’t consider the tag value. For example, you can find your recommendations with a tag key value of Owner or without any tag keys assigned.
|
831
835
|
*/
|
832
836
|
name?: FilterName;
|
833
837
|
/**
|
@@ -835,7 +839,7 @@ declare namespace ComputeOptimizer {
|
|
835
839
|
*/
|
836
840
|
values?: FilterValues;
|
837
841
|
}
|
838
|
-
export type FilterName = "Finding"|"FindingReasonCodes"|"RecommendationSourceType"|string;
|
842
|
+
export type FilterName = "Finding"|"FindingReasonCodes"|"RecommendationSourceType"|"InferredWorkloadTypes"|string;
|
839
843
|
export type FilterValue = string;
|
840
844
|
export type FilterValues = FilterValue[];
|
841
845
|
export type Filters = Filter[];
|
@@ -1222,7 +1226,18 @@ declare namespace ComputeOptimizer {
|
|
1222
1226
|
export type High = number;
|
1223
1227
|
export type Identifier = string;
|
1224
1228
|
export type IncludeMemberAccounts = boolean;
|
1225
|
-
export
|
1229
|
+
export interface InferredWorkloadSaving {
|
1230
|
+
/**
|
1231
|
+
* The applications that might be running on the instance as inferred by Compute Optimizer. Compute Optimizer can infer if one of the following applications might be running on the instance: AmazonEmr - Infers that Amazon EMR might be running on the instance. ApacheCassandra - Infers that Apache Cassandra might be running on the instance. ApacheHadoop - Infers that Apache Hadoop might be running on the instance. Memcached - Infers that Memcached might be running on the instance. NGINX - Infers that NGINX might be running on the instance. PostgreSql - Infers that PostgreSQL might be running on the instance. Redis - Infers that Redis might be running on the instance. Kafka - Infers that Kafka might be running on the instance. SQLServer - Infers that SQLServer might be running on the instance.
|
1232
|
+
*/
|
1233
|
+
inferredWorkloadTypes?: InferredWorkloadTypes;
|
1234
|
+
/**
|
1235
|
+
* An object that describes the estimated monthly savings amount possible by adopting Compute Optimizer recommendations for a given resource. This is based on the On-Demand instance pricing.
|
1236
|
+
*/
|
1237
|
+
estimatedMonthlySavings?: EstimatedMonthlySavings;
|
1238
|
+
}
|
1239
|
+
export type InferredWorkloadSavings = InferredWorkloadSaving[];
|
1240
|
+
export type InferredWorkloadType = "AmazonEmr"|"ApacheCassandra"|"ApacheHadoop"|"Memcached"|"Nginx"|"PostgreSql"|"Redis"|"Kafka"|"SQLServer"|string;
|
1226
1241
|
export type InferredWorkloadTypes = InferredWorkloadType[];
|
1227
1242
|
export type InferredWorkloadTypesPreference = "Active"|"Inactive"|string;
|
1228
1243
|
export type InstanceArn = string;
|
@@ -1250,7 +1265,7 @@ declare namespace ComputeOptimizer {
|
|
1250
1265
|
*/
|
1251
1266
|
finding?: Finding;
|
1252
1267
|
/**
|
1253
|
-
* The reason for the finding classification of the instance. Finding reason codes for instances include: CPUOverprovisioned — The instance’s CPU configuration can be sized down while still meeting the performance requirements of your workload. This is identified by analyzing the CPUUtilization metric of the current instance during the look-back period. CPUUnderprovisioned — The instance’s CPU configuration doesn't meet the performance requirements of your workload and there is an alternative instance type that provides better CPU performance. This is identified by analyzing the CPUUtilization metric of the current instance during the look-back period. MemoryOverprovisioned — The instance’s memory configuration can be sized down while still meeting the performance requirements of your workload. This is identified by analyzing the memory utilization metric of the current instance during the look-back period. MemoryUnderprovisioned — The instance’s memory configuration doesn't meet the performance requirements of your workload and there is an alternative instance type that provides better memory performance. This is identified by analyzing the memory utilization metric of the current instance during the look-back period. Memory utilization is analyzed only for resources that have the unified CloudWatch agent installed on them. For more information, see Enabling memory utilization with the Amazon CloudWatch Agent in the Compute Optimizer User Guide. On Linux instances, Compute Optimizer analyses the mem_used_percent metric in the CWAgent namespace, or the legacy MemoryUtilization metric in the System/Linux namespace. On Windows instances, Compute Optimizer analyses the Memory % Committed Bytes In Use metric in the CWAgent namespace. EBSThroughputOverprovisioned — The instance’s EBS throughput configuration can be sized down while still meeting the performance requirements of your workload. This is identified by analyzing the VolumeReadBytes and VolumeWriteBytes metrics of EBS volumes attached to the current instance during the look-back period. EBSThroughputUnderprovisioned — The instance’s EBS throughput configuration doesn't meet the performance requirements of your workload and there is an alternative instance type that provides better EBS throughput performance. This is identified by analyzing the VolumeReadBytes and VolumeWriteBytes
|
1268
|
+
* The reason for the finding classification of the instance. Finding reason codes for instances include: CPUOverprovisioned — The instance’s CPU configuration can be sized down while still meeting the performance requirements of your workload. This is identified by analyzing the CPUUtilization metric of the current instance during the look-back period. CPUUnderprovisioned — The instance’s CPU configuration doesn't meet the performance requirements of your workload and there is an alternative instance type that provides better CPU performance. This is identified by analyzing the CPUUtilization metric of the current instance during the look-back period. MemoryOverprovisioned — The instance’s memory configuration can be sized down while still meeting the performance requirements of your workload. This is identified by analyzing the memory utilization metric of the current instance during the look-back period. MemoryUnderprovisioned — The instance’s memory configuration doesn't meet the performance requirements of your workload and there is an alternative instance type that provides better memory performance. This is identified by analyzing the memory utilization metric of the current instance during the look-back period. Memory utilization is analyzed only for resources that have the unified CloudWatch agent installed on them. For more information, see Enabling memory utilization with the Amazon CloudWatch Agent in the Compute Optimizer User Guide. On Linux instances, Compute Optimizer analyses the mem_used_percent metric in the CWAgent namespace, or the legacy MemoryUtilization metric in the System/Linux namespace. On Windows instances, Compute Optimizer analyses the Memory % Committed Bytes In Use metric in the CWAgent namespace. EBSThroughputOverprovisioned — The instance’s EBS throughput configuration can be sized down while still meeting the performance requirements of your workload. This is identified by analyzing the VolumeReadBytes and VolumeWriteBytes metrics of EBS volumes attached to the current instance during the look-back period. EBSThroughputUnderprovisioned — The instance’s EBS throughput configuration doesn't meet the performance requirements of your workload and there is an alternative instance type that provides better EBS throughput performance. This is identified by analyzing the VolumeReadBytes and VolumeWriteBytes metrics of EBS volumes attached to the current instance during the look-back period. EBSIOPSOverprovisioned — The instance’s EBS IOPS configuration can be sized down while still meeting the performance requirements of your workload. This is identified by analyzing the VolumeReadOps and VolumeWriteOps metric of EBS volumes attached to the current instance during the look-back period. EBSIOPSUnderprovisioned — The instance’s EBS IOPS configuration doesn't meet the performance requirements of your workload and there is an alternative instance type that provides better EBS IOPS performance. This is identified by analyzing the VolumeReadOps and VolumeWriteOps metric of EBS volumes attached to the current instance during the look-back period. NetworkBandwidthOverprovisioned — The instance’s network bandwidth configuration can be sized down while still meeting the performance requirements of your workload. This is identified by analyzing the NetworkIn and NetworkOut metrics of the current instance during the look-back period. NetworkBandwidthUnderprovisioned — The instance’s network bandwidth configuration doesn't meet the performance requirements of your workload and there is an alternative instance type that provides better network bandwidth performance. This is identified by analyzing the NetworkIn and NetworkOut metrics of the current instance during the look-back period. This finding reason happens when the NetworkIn or NetworkOut performance of an instance is impacted. NetworkPPSOverprovisioned — The instance’s network PPS (packets per second) configuration can be sized down while still meeting the performance requirements of your workload. This is identified by analyzing the NetworkPacketsIn and NetworkPacketsIn metrics of the current instance during the look-back period. NetworkPPSUnderprovisioned — The instance’s network PPS (packets per second) configuration doesn't meet the performance requirements of your workload and there is an alternative instance type that provides better network PPS performance. This is identified by analyzing the NetworkPacketsIn and NetworkPacketsIn metrics of the current instance during the look-back period. DiskIOPSOverprovisioned — The instance’s disk IOPS configuration can be sized down while still meeting the performance requirements of your workload. This is identified by analyzing the DiskReadOps and DiskWriteOps metrics of the current instance during the look-back period. DiskIOPSUnderprovisioned — The instance’s disk IOPS configuration doesn't meet the performance requirements of your workload and there is an alternative instance type that provides better disk IOPS performance. This is identified by analyzing the DiskReadOps and DiskWriteOps metrics of the current instance during the look-back period. DiskThroughputOverprovisioned — The instance’s disk throughput configuration can be sized down while still meeting the performance requirements of your workload. This is identified by analyzing the DiskReadBytes and DiskWriteBytes metrics of the current instance during the look-back period. DiskThroughputUnderprovisioned — The instance’s disk throughput configuration doesn't meet the performance requirements of your workload and there is an alternative instance type that provides better disk throughput performance. This is identified by analyzing the DiskReadBytes and DiskWriteBytes metrics of the current instance during the look-back period. For more information about instance metrics, see List the available CloudWatch metrics for your instances in the Amazon Elastic Compute Cloud User Guide. For more information about EBS volume metrics, see Amazon CloudWatch metrics for Amazon EBS in the Amazon Elastic Compute Cloud User Guide.
|
1254
1269
|
*/
|
1255
1270
|
findingReasonCodes?: InstanceRecommendationFindingReasonCodes;
|
1256
1271
|
/**
|
@@ -1282,13 +1297,17 @@ declare namespace ComputeOptimizer {
|
|
1282
1297
|
*/
|
1283
1298
|
effectiveRecommendationPreferences?: EffectiveRecommendationPreferences;
|
1284
1299
|
/**
|
1285
|
-
* The applications that might be running on the instance as inferred by Compute Optimizer. Compute Optimizer can infer if one of the following applications might be running on the instance: AmazonEmr - Infers that Amazon EMR might be running on the instance. ApacheCassandra - Infers that Apache Cassandra might be running on the instance. ApacheHadoop - Infers that Apache Hadoop might be running on the instance. Memcached - Infers that Memcached might be running on the instance. NGINX - Infers that NGINX might be running on the instance. PostgreSql - Infers that PostgreSQL might be running on the instance. Redis - Infers that Redis might be running on the instance. Kafka - Infers that Kafka might be running on the instance.
|
1300
|
+
* The applications that might be running on the instance as inferred by Compute Optimizer. Compute Optimizer can infer if one of the following applications might be running on the instance: AmazonEmr - Infers that Amazon EMR might be running on the instance. ApacheCassandra - Infers that Apache Cassandra might be running on the instance. ApacheHadoop - Infers that Apache Hadoop might be running on the instance. Memcached - Infers that Memcached might be running on the instance. NGINX - Infers that NGINX might be running on the instance. PostgreSql - Infers that PostgreSQL might be running on the instance. Redis - Infers that Redis might be running on the instance. Kafka - Infers that Kafka might be running on the instance. SQLServer - Infers that SQLServer might be running on the instance.
|
1286
1301
|
*/
|
1287
1302
|
inferredWorkloadTypes?: InferredWorkloadTypes;
|
1288
1303
|
/**
|
1289
1304
|
* The state of the instance when the recommendation was generated.
|
1290
1305
|
*/
|
1291
1306
|
instanceState?: InstanceState;
|
1307
|
+
/**
|
1308
|
+
* A list of tags assigned to your Amazon EC2 instance recommendations.
|
1309
|
+
*/
|
1310
|
+
tags?: Tags;
|
1292
1311
|
}
|
1293
1312
|
export type InstanceRecommendationFindingReasonCode = "CPUOverprovisioned"|"CPUUnderprovisioned"|"MemoryOverprovisioned"|"MemoryUnderprovisioned"|"EBSThroughputOverprovisioned"|"EBSThroughputUnderprovisioned"|"EBSIOPSOverprovisioned"|"EBSIOPSUnderprovisioned"|"NetworkBandwidthOverprovisioned"|"NetworkBandwidthUnderprovisioned"|"NetworkPPSOverprovisioned"|"NetworkPPSUnderprovisioned"|"DiskIOPSOverprovisioned"|"DiskIOPSUnderprovisioned"|"DiskThroughputOverprovisioned"|"DiskThroughputUnderprovisioned"|string;
|
1294
1313
|
export type InstanceRecommendationFindingReasonCodes = InstanceRecommendationFindingReasonCode[];
|
@@ -1427,10 +1446,14 @@ declare namespace ComputeOptimizer {
|
|
1427
1446
|
* The risk of the current Lambda function not meeting the performance needs of its workloads. The higher the risk, the more likely the current Lambda function requires more memory.
|
1428
1447
|
*/
|
1429
1448
|
currentPerformanceRisk?: CurrentPerformanceRisk;
|
1449
|
+
/**
|
1450
|
+
* A list of tags assigned to your Lambda function recommendations.
|
1451
|
+
*/
|
1452
|
+
tags?: Tags;
|
1430
1453
|
}
|
1431
1454
|
export interface LambdaFunctionRecommendationFilter {
|
1432
1455
|
/**
|
1433
|
-
* The name of the filter. Specify Finding to return recommendations with a specific finding classification (for example, NotOptimized). Specify FindingReasonCode to return recommendations with a specific finding reason code (for example, MemoryUnderprovisioned).
|
1456
|
+
* The name of the filter. Specify Finding to return recommendations with a specific finding classification (for example, NotOptimized). Specify FindingReasonCode to return recommendations with a specific finding reason code (for example, MemoryUnderprovisioned). You can filter your Lambda function recommendations by tag:key and tag-key tags. A tag:key is a key and value combination of a tag assigned to your Lambda function recommendations. Use the tag key in the filter name and the tag value as the filter value. For example, to find all Lambda function recommendations that have a tag with the key of Owner and the value of TeamA, specify tag:Owner for the filter name and TeamA for the filter value. A tag-key is the key of a tag assigned to your Lambda function recommendations. Use this filter to find all of your Lambda function recommendations that have a tag with a specific key. This doesn’t consider the tag value. For example, you can find your Lambda function recommendations with a tag key value of Owner or without any tag keys assigned.
|
1434
1457
|
*/
|
1435
1458
|
name?: LambdaFunctionRecommendationFilterName;
|
1436
1459
|
/**
|
@@ -1647,6 +1670,10 @@ declare namespace ComputeOptimizer {
|
|
1647
1670
|
* An object that describes the performance risk ratings for a given resource type.
|
1648
1671
|
*/
|
1649
1672
|
currentPerformanceRiskRatings?: CurrentPerformanceRiskRatings;
|
1673
|
+
/**
|
1674
|
+
* An array of objects that describes the estimated monthly saving amounts for the instances running on the specified inferredWorkloadTypes. The array contains the top three savings opportunites for the instances running inferred workload types.
|
1675
|
+
*/
|
1676
|
+
inferredWorkloadSavings?: InferredWorkloadSavings;
|
1650
1677
|
}
|
1651
1678
|
export type RecommendedInstanceType = string;
|
1652
1679
|
export interface RecommendedOptionProjectedMetric {
|
@@ -1697,7 +1724,7 @@ declare namespace ComputeOptimizer {
|
|
1697
1724
|
*/
|
1698
1725
|
savingsOpportunityPercentage?: SavingsOpportunityPercentage;
|
1699
1726
|
/**
|
1700
|
-
* An object that describes the estimated monthly savings amount possible
|
1727
|
+
* An object that describes the estimated monthly savings amount possible by adopting Compute Optimizer recommendations for a given resource. This is based on the On-Demand instance pricing..
|
1701
1728
|
*/
|
1702
1729
|
estimatedMonthlySavings?: EstimatedMonthlySavings;
|
1703
1730
|
}
|
@@ -1756,6 +1783,19 @@ declare namespace ComputeOptimizer {
|
|
1756
1783
|
reasonCodeSummaries?: ReasonCodeSummaries;
|
1757
1784
|
}
|
1758
1785
|
export type SummaryValue = number;
|
1786
|
+
export interface Tag {
|
1787
|
+
/**
|
1788
|
+
* One part of a key-value pair that makes up a tag. A key is a general label that acts like a category for more specific tag values.
|
1789
|
+
*/
|
1790
|
+
key?: TagKey;
|
1791
|
+
/**
|
1792
|
+
* One part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key). The value can be empty or null.
|
1793
|
+
*/
|
1794
|
+
value?: TagValue;
|
1795
|
+
}
|
1796
|
+
export type TagKey = string;
|
1797
|
+
export type TagValue = string;
|
1798
|
+
export type Tags = Tag[];
|
1759
1799
|
export type TaskDefinitionArn = string;
|
1760
1800
|
export type Timestamp = Date;
|
1761
1801
|
export type Timestamps = Timestamp[];
|
@@ -1870,6 +1910,10 @@ declare namespace ComputeOptimizer {
|
|
1870
1910
|
* The risk of the current EBS volume not meeting the performance needs of its workloads. The higher the risk, the more likely the current EBS volume doesn't have sufficient capacity.
|
1871
1911
|
*/
|
1872
1912
|
currentPerformanceRisk?: CurrentPerformanceRisk;
|
1913
|
+
/**
|
1914
|
+
* A list of tags assigned to your Amazon EBS volume recommendations.
|
1915
|
+
*/
|
1916
|
+
tags?: Tags;
|
1873
1917
|
}
|
1874
1918
|
export interface VolumeRecommendationOption {
|
1875
1919
|
/**
|
@@ -4222,7 +4222,7 @@ declare namespace Connect {
|
|
4222
4222
|
Name: EventBridgeActionName;
|
4223
4223
|
}
|
4224
4224
|
export type EventBridgeActionName = string;
|
4225
|
-
export type EventSourceName = "OnPostCallAnalysisAvailable"|"OnRealTimeCallAnalysisAvailable"|"OnPostChatAnalysisAvailable"|"OnZendeskTicketCreate"|"OnZendeskTicketStatusUpdate"|"OnSalesforceCaseCreate"|string;
|
4225
|
+
export type EventSourceName = "OnPostCallAnalysisAvailable"|"OnRealTimeCallAnalysisAvailable"|"OnPostChatAnalysisAvailable"|"OnZendeskTicketCreate"|"OnZendeskTicketStatusUpdate"|"OnSalesforceCaseCreate"|"OnContactEvaluationSubmit"|string;
|
4226
4226
|
export interface FilterV2 {
|
4227
4227
|
/**
|
4228
4228
|
* The key to use for filtering data. For example, QUEUE, ROUTING_PROFILE, AGENT, CHANNEL, AGENT_HIERARCHY_LEVEL_ONE, AGENT_HIERARCHY_LEVEL_TWO, AGENT_HIERARCHY_LEVEL_THREE, AGENT_HIERARCHY_LEVEL_FOUR, AGENT_HIERARCHY_LEVEL_FIVE. There must be at least 1 key and a maximum 5 keys.
|
@@ -2782,7 +2782,7 @@ declare namespace ECS {
|
|
2782
2782
|
*/
|
2783
2783
|
name: SettingName;
|
2784
2784
|
/**
|
2785
|
-
* The account setting value for the specified principal ARN. Accepted values are enabled and
|
2785
|
+
* The account setting value for the specified principal ARN. Accepted values are enabled, disabled, on, and off.
|
2786
2786
|
*/
|
2787
2787
|
value: String;
|
2788
2788
|
}
|
@@ -2798,7 +2798,7 @@ declare namespace ECS {
|
|
2798
2798
|
*/
|
2799
2799
|
name: SettingName;
|
2800
2800
|
/**
|
2801
|
-
* The account setting value for the specified principal ARN. Accepted values are enabled and
|
2801
|
+
* The account setting value for the specified principal ARN. Accepted values are enabled, disabled, on, and off.
|
2802
2802
|
*/
|
2803
2803
|
value: String;
|
2804
2804
|
/**
|
@@ -516,11 +516,11 @@ declare class Kendra extends Service {
|
|
516
516
|
*/
|
517
517
|
updateQuerySuggestionsBlockList(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
518
518
|
/**
|
519
|
-
* Updates the settings of query suggestions for an index. Amazon Kendra supports partial updates, so you only need to provide the fields you want to update. If an update is currently processing
|
519
|
+
* Updates the settings of query suggestions for an index. Amazon Kendra supports partial updates, so you only need to provide the fields you want to update. If an update is currently processing, you need to wait for the update to finish before making another update. Updates to query suggestions settings might not take effect right away. The time for your updated settings to take effect depends on the updates made and the number of search queries in your index. You can still enable/disable query suggestions at any time. UpdateQuerySuggestionsConfig is currently not supported in the Amazon Web Services GovCloud (US-West) region.
|
520
520
|
*/
|
521
521
|
updateQuerySuggestionsConfig(params: Kendra.Types.UpdateQuerySuggestionsConfigRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
522
522
|
/**
|
523
|
-
* Updates the settings of query suggestions for an index. Amazon Kendra supports partial updates, so you only need to provide the fields you want to update. If an update is currently processing
|
523
|
+
* Updates the settings of query suggestions for an index. Amazon Kendra supports partial updates, so you only need to provide the fields you want to update. If an update is currently processing, you need to wait for the update to finish before making another update. Updates to query suggestions settings might not take effect right away. The time for your updated settings to take effect depends on the updates made and the number of search queries in your index. You can still enable/disable query suggestions at any time. UpdateQuerySuggestionsConfig is currently not supported in the Amazon Web Services GovCloud (US-West) region.
|
524
524
|
*/
|
525
525
|
updateQuerySuggestionsConfig(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
526
526
|
/**
|
@@ -717,6 +717,45 @@ declare namespace Kendra {
|
|
717
717
|
LessThanOrEquals?: DocumentAttribute;
|
718
718
|
}
|
719
719
|
export type AttributeFilterList = AttributeFilter[];
|
720
|
+
export interface AttributeSuggestionsDescribeConfig {
|
721
|
+
/**
|
722
|
+
* The list of fields/attributes that you want to set as suggestible for query suggestions.
|
723
|
+
*/
|
724
|
+
SuggestableConfigList?: SuggestableConfigList;
|
725
|
+
/**
|
726
|
+
* The mode is set to either ACTIVE or INACTIVE. If the Mode for query history is set to ENABLED when calling UpdateQuerySuggestionsConfig and AttributeSuggestionsMode to use fields/attributes is set to ACTIVE, and you haven't set your SuggestionTypes preference to DOCUMENT_ATTRIBUTES, then Amazon Kendra uses the query history.
|
727
|
+
*/
|
728
|
+
AttributeSuggestionsMode?: AttributeSuggestionsMode;
|
729
|
+
}
|
730
|
+
export interface AttributeSuggestionsGetConfig {
|
731
|
+
/**
|
732
|
+
* The list of document field/attribute keys or field names to use for query suggestions. If the content within any of the fields match what your user starts typing as their query, then the field content is returned as a query suggestion.
|
733
|
+
*/
|
734
|
+
SuggestionAttributes?: DocumentAttributeKeyList;
|
735
|
+
/**
|
736
|
+
* The list of additional document field/attribute keys or field names to include in the response. You can use additional fields to provide extra information in the response. Additional fields are not used to based suggestions on.
|
737
|
+
*/
|
738
|
+
AdditionalResponseAttributes?: DocumentAttributeKeyList;
|
739
|
+
/**
|
740
|
+
* Filters the search results based on document fields/attributes.
|
741
|
+
*/
|
742
|
+
AttributeFilter?: AttributeFilter;
|
743
|
+
/**
|
744
|
+
* Applies user context filtering so that only users who are given access to certain documents see these document in their search results.
|
745
|
+
*/
|
746
|
+
UserContext?: UserContext;
|
747
|
+
}
|
748
|
+
export type AttributeSuggestionsMode = "ACTIVE"|"INACTIVE"|string;
|
749
|
+
export interface AttributeSuggestionsUpdateConfig {
|
750
|
+
/**
|
751
|
+
* The list of fields/attributes that you want to set as suggestible for query suggestions.
|
752
|
+
*/
|
753
|
+
SuggestableConfigList?: SuggestableConfigList;
|
754
|
+
/**
|
755
|
+
* You can set the mode to ACTIVE or INACTIVE. You must also set SuggestionTypes as either QUERY or DOCUMENT_ATTRIBUTES and then call GetQuerySuggestions. If Mode to use query history is set to ENABLED when calling UpdateQuerySuggestionsConfig and AttributeSuggestionsMode to use fields/attributes is set to ACTIVE, and you haven't set your SuggestionTypes preference to DOCUMENT_ATTRIBUTES, then Amazon Kendra uses the query history.
|
756
|
+
*/
|
757
|
+
AttributeSuggestionsMode?: AttributeSuggestionsMode;
|
758
|
+
}
|
720
759
|
export interface AuthenticationConfiguration {
|
721
760
|
/**
|
722
761
|
* The list of configuration information that's required to connect to and crawl a website host using basic authentication credentials. The list includes the name and port number of the website host.
|
@@ -2338,7 +2377,7 @@ declare namespace Kendra {
|
|
2338
2377
|
*/
|
2339
2378
|
MinimumQueryCount?: MinimumQueryCount;
|
2340
2379
|
/**
|
2341
|
-
* The Unix timestamp when query suggestions for an index was last updated.
|
2380
|
+
* The Unix timestamp when query suggestions for an index was last updated. Amazon Kendra automatically updates suggestions every 24 hours, after you change a setting or after you apply a block list.
|
2342
2381
|
*/
|
2343
2382
|
LastSuggestionsBuildTime?: Timestamp;
|
2344
2383
|
/**
|
@@ -2346,9 +2385,13 @@ declare namespace Kendra {
|
|
2346
2385
|
*/
|
2347
2386
|
LastClearTime?: Timestamp;
|
2348
2387
|
/**
|
2349
|
-
* The current total count of query suggestions for an index. This count can change when you update your query suggestions settings, if you filter out certain queries from suggestions using a block list, and as the query log accumulates more queries for Amazon Kendra to learn from.
|
2388
|
+
* The current total count of query suggestions for an index. This count can change when you update your query suggestions settings, if you filter out certain queries from suggestions using a block list, and as the query log accumulates more queries for Amazon Kendra to learn from. If the count is much lower than you expected, it could be because Amazon Kendra needs more queries in the query history to learn from or your current query suggestions settings are too strict.
|
2350
2389
|
*/
|
2351
2390
|
TotalSuggestionsCount?: Integer;
|
2391
|
+
/**
|
2392
|
+
* Configuration information for the document fields/attributes that you want to base query suggestions on.
|
2393
|
+
*/
|
2394
|
+
AttributeSuggestionsConfig?: AttributeSuggestionsDescribeConfig;
|
2352
2395
|
}
|
2353
2396
|
export interface DescribeThesaurusRequest {
|
2354
2397
|
/**
|
@@ -2994,6 +3037,14 @@ declare namespace Kendra {
|
|
2994
3037
|
* The maximum number of query suggestions you want to show to your users.
|
2995
3038
|
*/
|
2996
3039
|
MaxSuggestionsCount?: Integer;
|
3040
|
+
/**
|
3041
|
+
* The suggestions type to base query suggestions on. The suggestion types are query history or document fields/attributes. You can set one type or the other. If you set query history as your suggestions type, Amazon Kendra suggests queries relevant to your users based on popular queries in the query history. If you set document fields/attributes as your suggestions type, Amazon Kendra suggests queries relevant to your users based on the contents of document fields.
|
3042
|
+
*/
|
3043
|
+
SuggestionTypes?: SuggestionTypes;
|
3044
|
+
/**
|
3045
|
+
* Configuration information for the document fields/attributes that you want to base query suggestions on.
|
3046
|
+
*/
|
3047
|
+
AttributeSuggestionsConfig?: AttributeSuggestionsGetConfig;
|
2997
3048
|
}
|
2998
3049
|
export interface GetQuerySuggestionsResponse {
|
2999
3050
|
/**
|
@@ -4698,6 +4749,21 @@ declare namespace Kendra {
|
|
4698
4749
|
*/
|
4699
4750
|
SortOrder: SortOrder;
|
4700
4751
|
}
|
4752
|
+
export interface SourceDocument {
|
4753
|
+
/**
|
4754
|
+
* The identifier of the document used for a query suggestion.
|
4755
|
+
*/
|
4756
|
+
DocumentId?: String;
|
4757
|
+
/**
|
4758
|
+
* The document fields/attributes used for a query suggestion.
|
4759
|
+
*/
|
4760
|
+
SuggestionAttributes?: DocumentAttributeKeyList;
|
4761
|
+
/**
|
4762
|
+
* The additional fields/attributes to include in the response. You can use additional fields to provide extra information in the response. Additional fields are not used to based suggestions on.
|
4763
|
+
*/
|
4764
|
+
AdditionalAttributes?: DocumentAttributeList;
|
4765
|
+
}
|
4766
|
+
export type SourceDocuments = SourceDocument[];
|
4701
4767
|
export interface SpellCorrectedQuery {
|
4702
4768
|
/**
|
4703
4769
|
* The query with the suggested spell corrections.
|
@@ -4788,6 +4854,17 @@ declare namespace Kendra {
|
|
4788
4854
|
}
|
4789
4855
|
export type SubnetId = string;
|
4790
4856
|
export type SubnetIdList = SubnetId[];
|
4857
|
+
export interface SuggestableConfig {
|
4858
|
+
/**
|
4859
|
+
* The name of the document field/attribute.
|
4860
|
+
*/
|
4861
|
+
AttributeName?: DocumentAttributeKey;
|
4862
|
+
/**
|
4863
|
+
* TRUE means the document field/attribute is suggestible, so the contents within the field can be used for query suggestions.
|
4864
|
+
*/
|
4865
|
+
Suggestable?: ObjectBoolean;
|
4866
|
+
}
|
4867
|
+
export type SuggestableConfigList = SuggestableConfig[];
|
4791
4868
|
export type SuggestedQueryText = string;
|
4792
4869
|
export interface Suggestion {
|
4793
4870
|
/**
|
@@ -4798,6 +4875,10 @@ declare namespace Kendra {
|
|
4798
4875
|
* The value for the UUID (universally unique identifier) of a single query suggestion. The value is the text string of a suggestion.
|
4799
4876
|
*/
|
4800
4877
|
Value?: SuggestionValue;
|
4878
|
+
/**
|
4879
|
+
* The list of document IDs and their fields/attributes that are used for a single query suggestion, if document fields set to use for query suggestions.
|
4880
|
+
*/
|
4881
|
+
SourceDocuments?: SourceDocuments;
|
4801
4882
|
}
|
4802
4883
|
export interface SuggestionHighlight {
|
4803
4884
|
/**
|
@@ -4822,6 +4903,8 @@ declare namespace Kendra {
|
|
4822
4903
|
*/
|
4823
4904
|
Highlights?: SuggestionHighlightList;
|
4824
4905
|
}
|
4906
|
+
export type SuggestionType = "QUERY"|"DOCUMENT_ATTRIBUTES"|string;
|
4907
|
+
export type SuggestionTypes = SuggestionType[];
|
4825
4908
|
export interface SuggestionValue {
|
4826
4909
|
/**
|
4827
4910
|
* The SuggestionTextWithHighlights structure that contains the query suggestion text and highlights.
|
@@ -5076,7 +5159,7 @@ declare namespace Kendra {
|
|
5076
5159
|
*/
|
5077
5160
|
IndexId: IndexId;
|
5078
5161
|
/**
|
5079
|
-
* The identifier of the
|
5162
|
+
* The identifier of the set of featured results that you want to update.
|
5080
5163
|
*/
|
5081
5164
|
FeaturedResultsSetId: FeaturedResultsSetId;
|
5082
5165
|
/**
|
@@ -5195,6 +5278,10 @@ declare namespace Kendra {
|
|
5195
5278
|
* The the minimum number of times a query must be searched in order to be eligible to suggest to your users. Decreasing this number increases the number of suggestions. However, this affects the quality of suggestions as it sets a low bar for a query to be considered popular to suggest to users. How you tune this setting depends on your specific needs.
|
5196
5279
|
*/
|
5197
5280
|
MinimumQueryCount?: MinimumQueryCount;
|
5281
|
+
/**
|
5282
|
+
* Configuration information for the document fields/attributes that you want to base query suggestions on.
|
5283
|
+
*/
|
5284
|
+
AttributeSuggestionsConfig?: AttributeSuggestionsUpdateConfig;
|
5198
5285
|
}
|
5199
5286
|
export interface UpdateThesaurusRequest {
|
5200
5287
|
/**
|