Disables the event data store specified by EventDataStore, which accepts an event data store ARN.
- * After you run DeleteEventDataStore, the event data store is automatically deleted after a wait period of
+ * After you run DeleteEventDataStore, the event data store enters a PENDING_DELETION state, and is automatically deleted after a wait period of
* seven days. TerminationProtectionEnabled must be set to False on the event data store; this
* operation cannot work if TerminationProtectionEnabled is True.
After you run DeleteEventDataStore on an event data store, you cannot run ListQueries,
* DescribeQuery, or GetQueryResults on queries that are using an event data store in a
- * PENDING_DELETION state.
PENDING_DELETION state. An event data store in the PENDING_DELETION state does not incur costs.
*/
public deleteEventDataStore(
args: DeleteEventDataStoreCommandInput,
diff --git a/clients/client-cloudtrail/src/commands/DeleteEventDataStoreCommand.ts b/clients/client-cloudtrail/src/commands/DeleteEventDataStoreCommand.ts
index 130a8e84969ce..b05a8c9af38bf 100644
--- a/clients/client-cloudtrail/src/commands/DeleteEventDataStoreCommand.ts
+++ b/clients/client-cloudtrail/src/commands/DeleteEventDataStoreCommand.ts
@@ -23,12 +23,12 @@ export interface DeleteEventDataStoreCommandOutput extends DeleteEventDataStoreR
/**
* Disables the event data store specified by EventDataStore, which accepts an event data store ARN.
- * After you run DeleteEventDataStore, the event data store is automatically deleted after a wait period of
+ * After you run DeleteEventDataStore, the event data store enters a PENDING_DELETION state, and is automatically deleted after a wait period of
* seven days. TerminationProtectionEnabled must be set to False on the event data store; this
* operation cannot work if TerminationProtectionEnabled is True.
After you run DeleteEventDataStore on an event data store, you cannot run ListQueries,
* DescribeQuery, or GetQueryResults on queries that are using an event data store in a
- * PENDING_DELETION state.
PENDING_DELETION state. An event data store in the PENDING_DELETION state does not incur costs.
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
diff --git a/clients/client-cloudtrail/src/models/models_0.ts b/clients/client-cloudtrail/src/models/models_0.ts
index 927c8d246aa54..90fe9671654c3 100644
--- a/clients/client-cloudtrail/src/models/models_0.ts
+++ b/clients/client-cloudtrail/src/models/models_0.ts
@@ -251,8 +251,9 @@ export interface AdvancedFieldSelector {
*
* readOnly
* - Optional. Can be set to Equals a value of true
- * or false. A value of false logs both read and
- * write events.
+ * or false. If you do not add this field, CloudTrail logs both both read and
+ * write events. A value of true logs only read events. A value of false
+ * logs only write events.
*
*
@@ -330,6 +331,11 @@ export interface AdvancedFieldSelector {
* AWS::DynamoDB::Stream
*
+ * AWS::Glue::Table
+ *
* You can have only one resources.type field per selector. To log data
@@ -445,6 +451,15 @@ export interface AdvancedFieldSelector {
*
When resources.type equals AWS::Glue::Table, and the operator is set to
+ * Equals or NotEquals, the ARN must be in the following format:
+ * arn:
+ *
The following resource types are also availble through advanced event selectors.
* Basic event selector resource types are valid in advanced event selectors, but
* advanced event selector resource types are not valid in basic event selectors.
@@ -1910,6 +1926,11 @@ export interface DataResource {
* AWS::DynamoDB::Stream
*
+ * AWS::Glue::Table
+ *
An optional list of service event sources from which you do not want management events to be logged on your trail. In this release, the list can be empty (disables the filter),
* or it can filter out Key Management Service or Amazon RDS Data API events by
* containing kms.amazonaws.com or rdsdata.amazonaws.com. By default, ExcludeManagementEventSources is empty, and KMS and
- * Amazon RDS Data API events are logged to your trail.
Describes the effective recommendation preferences for a resource.
*/ @@ -136,9 +141,21 @@ export interface EffectiveRecommendationPreferences { * preference. *A status of Active confirms that the preference is applied in the latest
* recommendation refresh, and a status of Inactive confirms that it's not yet
- * applied.
For more information, see Enhanced + * infrastructure metrics in the Compute Optimizer User + * Guide.
*/ enhancedInfrastructureMetrics?: EnhancedInfrastructureMetrics | string; + + /** + *Describes the activation status of the inferred workload types preference.
+ * + *A status of Active confirms that the preference is applied in the latest
+ * recommendation refresh. A status of Inactive confirms that it's not yet
+ * applied to recommendations.
Describes the estimated monthly savings amount possible for a given resource based on - * On-Demand instance pricing
+ *Describes the estimated monthly savings amount possible, based on On-Demand instance + * pricing, by adopting Compute Optimizer recommendations for a given resource.
*For more information, see Estimated monthly savings and savings opportunities in the * Compute Optimizer User Guide.
*/ @@ -384,13 +418,15 @@ export namespace EstimatedMonthlySavings { */ export interface SavingsOpportunity { /** - *The estimated monthly savings possible as a percentage of monthly cost.
+ *The estimated monthly savings possible as a percentage of monthly cost by adopting + * Compute Optimizer recommendations for a given resource.
*/ savingsOpportunityPercentage?: number; /** - *An object that describes the estimated monthly savings amount possible based on - * On-Demand instance pricing.
+ *An object that describes the estimated monthly savings amount possible, based on + * On-Demand instance pricing, by adopting Compute Optimizer recommendations for a given + * resource.
*/ estimatedMonthlySavings?: EstimatedMonthlySavings; } @@ -456,6 +492,19 @@ export interface AutoScalingGroupRecommendationOption { * and percentage. */ savingsOpportunity?: SavingsOpportunity; + + /** + *The level of effort required to migrate from the current instance type to the + * recommended instance type.
+ * + *For example, the migration effort is Low if Amazon EMR is the
+ * inferred workload type and an Amazon Web Services Graviton instance type is recommended.
+ * The migration effort is Medium if a workload type couldn't be inferred but
+ * an Amazon Web Services Graviton instance type is recommended. The migration effort is
+ * VeryLow if both the current and recommended instance types are of the
+ * same CPU architecture.
An object that describes the effective recommendation preferences for the Auto Scaling group.
*/ effectiveRecommendationPreferences?: EffectiveRecommendationPreferences; + + /** + *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.
ResourceArn and a scope value of the Auto Scaling group Amazon
* Resource Name (ARN). This will configure the preference for all instances that are
- * part of the specified the Auto Scaling group.
+ * part of the specified Auto Scaling group. You also cannot create recommendation
+ * preferences at the resource level for instances that are part of an Auto Scaling group. You can create recommendation preferences at the resource level only for
+ * standalone instances.
*
*/
export interface Scope {
@@ -1010,7 +1110,9 @@ export enum ExportableAutoScalingGroupField {
CURRENT_VCPUS = "CurrentVCpus",
EFFECTIVE_RECOMMENDATION_PREFERENCES_CPU_VENDOR_ARCHITECTURES = "EffectiveRecommendationPreferencesCpuVendorArchitectures",
EFFECTIVE_RECOMMENDATION_PREFERENCES_ENHANCED_INFRASTRUCTURE_METRICS = "EffectiveRecommendationPreferencesEnhancedInfrastructureMetrics",
+ EFFECTIVE_RECOMMENDATION_PREFERENCES_INFERRED_WORKLOAD_TYPES = "EffectiveRecommendationPreferencesInferredWorkloadTypes",
FINDING = "Finding",
+ INFERRED_WORKLOAD_TYPES = "InferredWorkloadTypes",
LAST_REFRESH_TIMESTAMP = "LastRefreshTimestamp",
LOOKBACK_PERIOD_IN_DAYS = "LookbackPeriodInDays",
RECOMMENDATION_OPTIONS_CONFIGURATION_DESIRED_CAPACITY = "RecommendationOptionsConfigurationDesiredCapacity",
@@ -1020,6 +1122,7 @@ export enum ExportableAutoScalingGroupField {
RECOMMENDATION_OPTIONS_ESTIMATED_MONTHLY_SAVINGS_CURRENCY = "RecommendationOptionsEstimatedMonthlySavingsCurrency",
RECOMMENDATION_OPTIONS_ESTIMATED_MONTHLY_SAVINGS_VALUE = "RecommendationOptionsEstimatedMonthlySavingsValue",
RECOMMENDATION_OPTIONS_MEMORY = "RecommendationOptionsMemory",
+ RECOMMENDATION_OPTIONS_MIGRATION_EFFORT = "RecommendationOptionsMigrationEffort",
RECOMMENDATION_OPTIONS_NETWORK = "RecommendationOptionsNetwork",
RECOMMENDATION_OPTIONS_ON_DEMAND_PRICE = "RecommendationOptionsOnDemandPrice",
RECOMMENDATION_OPTIONS_PERFORMANCE_RISK = "RecommendationOptionsPerformanceRisk",
@@ -1606,8 +1709,10 @@ export enum ExportableInstanceField {
CURRENT_VCPUS = "CurrentVCpus",
EFFECTIVE_RECOMMENDATION_PREFERENCES_CPU_VENDOR_ARCHITECTURES = "EffectiveRecommendationPreferencesCpuVendorArchitectures",
EFFECTIVE_RECOMMENDATION_PREFERENCES_ENHANCED_INFRASTRUCTURE_METRICS = "EffectiveRecommendationPreferencesEnhancedInfrastructureMetrics",
+ EFFECTIVE_RECOMMENDATION_PREFERENCES_INFERRED_WORKLOAD_TYPES = "EffectiveRecommendationPreferencesInferredWorkloadTypes",
FINDING = "Finding",
Finding_Reason_Codes = "FindingReasonCodes",
+ INFERRED_WORKLOAD_TYPES = "InferredWorkloadTypes",
INSTANCE_ARN = "InstanceArn",
INSTANCE_NAME = "InstanceName",
LAST_REFRESH_TIMESTAMP = "LastRefreshTimestamp",
@@ -1618,6 +1723,7 @@ export enum ExportableInstanceField {
RECOMMENDATION_OPTIONS_ESTIMATED_MONTHLY_SAVINGS_VALUE = "RecommendationOptionsEstimatedMonthlySavingsValue",
RECOMMENDATION_OPTIONS_INSTANCE_TYPE = "RecommendationOptionsInstanceType",
RECOMMENDATION_OPTIONS_MEMORY = "RecommendationOptionsMemory",
+ RECOMMENDATION_OPTIONS_MIGRATION_EFFORT = "RecommendationOptionsMigrationEffort",
RECOMMENDATION_OPTIONS_NETWORK = "RecommendationOptionsNetwork",
RECOMMENDATION_OPTIONS_ON_DEMAND_PRICE = "RecommendationOptionsOnDemandPrice",
RECOMMENDATION_OPTIONS_PERFORMANCE_RISK = "RecommendationOptionsPerformanceRisk",
@@ -2602,6 +2708,19 @@ export interface InstanceRecommendationOption {
* percentage.
*/
savingsOpportunity?: SavingsOpportunity;
+
+ /**
+ * The level of effort required to migrate from the current instance type to the + * recommended instance type.
+ * + *For example, the migration effort is Low if Amazon EMR is the
+ * inferred workload type and an Amazon Web Services Graviton instance type is recommended.
+ * The migration effort is Medium if a workload type couldn't be inferred but
+ * an Amazon Web Services Graviton instance type is recommended. The migration effort is
+ * VeryLow if both the current and recommended instance types are of the
+ * same CPU architecture.
The risk of the current instance not meeting the performance needs of its workloads. - * The higher the risk, the more likely the current Lambda function requires - * more memory.
+ * The higher the risk, the more likely the current instance cannot meet the performance + * requirements of its workload. */ currentPerformanceRisk?: CurrentPerformanceRisk | string; @@ -2945,6 +3064,52 @@ export interface InstanceRecommendation { * instance. */ effectiveRecommendationPreferences?: EffectiveRecommendationPreferences; + + /** + *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.
A status of Active confirms that the preference is applied in the latest
* recommendation refresh, and a status of Inactive confirms that it's not yet
- * applied.
To validate whether the preference is applied to your last generated set of
* recommendations, review the effectiveRecommendationPreferences value in the
* response of the GetAutoScalingGroupRecommendations and GetEC2InstanceRecommendations actions.
For more information, see Enhanced + * infrastructure metrics in the Compute Optimizer User + * Guide.
*/ enhancedInfrastructureMetrics?: EnhancedInfrastructureMetrics | string; } @@ -3692,7 +3860,7 @@ export interface LambdaFunctionRecommendation { /** *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 configuration is underperforming in its workload.
+ * function requires more memory. */ currentPerformanceRisk?: CurrentPerformanceRisk | string; } @@ -3798,9 +3966,21 @@ export interface RecommendationPreferencesDetail { *The status of the enhanced infrastructure metrics recommendation preference.
*A status of Active confirms that the preference is applied in the latest
* recommendation refresh, and a status of Inactive confirms that it's not yet
- * applied.
For more information, see Enhanced + * infrastructure metrics in the Compute Optimizer User + * Guide.
*/ enhancedInfrastructureMetrics?: EnhancedInfrastructureMetrics | string; + + /** + *The status of the inferred workload types recommendation preference.
+ * + *A status of Active confirms that the preference is applied in the latest
+ * recommendation refresh. A status of Inactive confirms that it's not yet
+ * applied to recommendations.
ResourceArn and a scope value of the Auto Scaling group Amazon
* Resource Name (ARN). This will configure the preference for all instances that are
- * part of the specified the Auto Scaling group.
+ * part of the specified Auto Scaling group. You also cannot create recommendation
+ * preferences at the resource level for instances that are part of an Auto Scaling group. You can create recommendation preferences at the resource level only for
+ * standalone instances.
*
*/
scope?: Scope;
@@ -4057,11 +4239,30 @@ export interface PutRecommendationPreferencesRequest {
/**
* The status of the enhanced infrastructure metrics recommendation preference to create * or update.
- *A status of Active confirms that the preference is applied in the latest
- * recommendation refresh, and a status of Inactive confirms that it's not yet
- * applied.
Specify the Active status to activate the preference, or specify
+ * Inactive to deactivate the preference.
For more information, see Enhanced + * infrastructure metrics in the Compute Optimizer User + * Guide.
*/ enhancedInfrastructureMetrics?: EnhancedInfrastructureMetrics | string; + + /** + *The status of the inferred workload types recommendation preference to create or + * update.
+ * + *The inferred workload type feature is active by default. To deactivate it, create + * a recommendation preference.
+ *Specify the Inactive status to deactivate the feature, or specify
+ * Active to activate it.
For more information, see Inferred workload + * types in the Compute Optimizer User Guide.
+ */ + inferredWorkloadTypes?: InferredWorkloadTypesPreference | string; } export namespace PutRecommendationPreferencesRequest { diff --git a/clients/client-compute-optimizer/src/protocols/Aws_json1_0.ts b/clients/client-compute-optimizer/src/protocols/Aws_json1_0.ts index 1492eb3c7133c..cc533d0ef8140 100644 --- a/clients/client-compute-optimizer/src/protocols/Aws_json1_0.ts +++ b/clients/client-compute-optimizer/src/protocols/Aws_json1_0.ts @@ -142,6 +142,7 @@ import { GetRecommendationPreferencesResponse, GetRecommendationSummariesRequest, GetRecommendationSummariesResponse, + InferredWorkloadType, InstanceRecommendation, InstanceRecommendationFindingReasonCode, InstanceRecommendationOption, @@ -3021,6 +3022,8 @@ const serializeAws_json1_0PutRecommendationPreferencesRequest = ( input.enhancedInfrastructureMetrics !== null && { enhancedInfrastructureMetrics: input.enhancedInfrastructureMetrics, }), + ...(input.inferredWorkloadTypes !== undefined && + input.inferredWorkloadTypes !== null && { inferredWorkloadTypes: input.inferredWorkloadTypes }), ...(input.resourceType !== undefined && input.resourceType !== null && { resourceType: input.resourceType }), ...(input.scope !== undefined && input.scope !== null && { scope: serializeAws_json1_0Scope(input.scope, context) }), @@ -3154,6 +3157,10 @@ const deserializeAws_json1_0AutoScalingGroupRecommendation = ( ? deserializeAws_json1_0EffectiveRecommendationPreferences(output.effectiveRecommendationPreferences, context) : undefined, finding: __expectString(output.finding), + inferredWorkloadTypes: + output.inferredWorkloadTypes !== undefined && output.inferredWorkloadTypes !== null + ? deserializeAws_json1_0InferredWorkloadTypes(output.inferredWorkloadTypes, context) + : undefined, lastRefreshTimestamp: output.lastRefreshTimestamp !== undefined && output.lastRefreshTimestamp !== null ? __expectNonNull(__parseEpochTimestamp(__expectNumber(output.lastRefreshTimestamp))) @@ -3179,6 +3186,7 @@ const deserializeAws_json1_0AutoScalingGroupRecommendationOption = ( output.configuration !== undefined && output.configuration !== null ? deserializeAws_json1_0AutoScalingGroupConfiguration(output.configuration, context) : undefined, + migrationEffort: __expectString(output.migrationEffort), performanceRisk: __limitedParseDouble(output.performanceRisk), projectedUtilizationMetrics: output.projectedUtilizationMetrics !== undefined && output.projectedUtilizationMetrics !== null @@ -3295,6 +3303,7 @@ const deserializeAws_json1_0EffectiveRecommendationPreferences = ( ? deserializeAws_json1_0CpuVendorArchitectures(output.cpuVendorArchitectures, context) : undefined, enhancedInfrastructureMetrics: __expectString(output.enhancedInfrastructureMetrics), + inferredWorkloadTypes: __expectString(output.inferredWorkloadTypes), } as any; }; @@ -3531,6 +3540,20 @@ const deserializeAws_json1_0GetRecommendationSummariesResponse = ( } as any; }; +const deserializeAws_json1_0InferredWorkloadTypes = ( + output: any, + context: __SerdeContext +): (InferredWorkloadType | string)[] => { + return (output || []) + .filter((e: any) => e != null) + .map((entry: any) => { + if (entry === null) { + return null as any; + } + return __expectString(entry) as any; + }); +}; + const deserializeAws_json1_0InstanceRecommendation = (output: any, context: __SerdeContext): InstanceRecommendation => { return { accountId: __expectString(output.accountId), @@ -3545,6 +3568,10 @@ const deserializeAws_json1_0InstanceRecommendation = (output: any, context: __Se output.findingReasonCodes !== undefined && output.findingReasonCodes !== null ? deserializeAws_json1_0InstanceRecommendationFindingReasonCodes(output.findingReasonCodes, context) : undefined, + inferredWorkloadTypes: + output.inferredWorkloadTypes !== undefined && output.inferredWorkloadTypes !== null + ? deserializeAws_json1_0InferredWorkloadTypes(output.inferredWorkloadTypes, context) + : undefined, instanceArn: __expectString(output.instanceArn), instanceName: __expectString(output.instanceName), lastRefreshTimestamp: @@ -3587,6 +3614,7 @@ const deserializeAws_json1_0InstanceRecommendationOption = ( ): InstanceRecommendationOption => { return { instanceType: __expectString(output.instanceType), + migrationEffort: __expectString(output.migrationEffort), performanceRisk: __limitedParseDouble(output.performanceRisk), platformDifferences: output.platformDifferences !== undefined && output.platformDifferences !== null @@ -3949,6 +3977,7 @@ const deserializeAws_json1_0RecommendationPreferencesDetail = ( ): RecommendationPreferencesDetail => { return { enhancedInfrastructureMetrics: __expectString(output.enhancedInfrastructureMetrics), + inferredWorkloadTypes: __expectString(output.inferredWorkloadTypes), resourceType: __expectString(output.resourceType), scope: output.scope !== undefined && output.scope !== null diff --git a/clients/client-config-service/src/models/models_0.ts b/clients/client-config-service/src/models/models_0.ts index 8f33557dcc9ad..64ab3cab7b5c2 100644 --- a/clients/client-config-service/src/models/models_0.ts +++ b/clients/client-config-service/src/models/models_0.ts @@ -618,6 +618,9 @@ export enum ResourceType { ClusterSecurityGroup = "AWS::Redshift::ClusterSecurityGroup", ClusterSnapshot = "AWS::Redshift::ClusterSnapshot", ClusterSubnetGroup = "AWS::Redshift::ClusterSubnetGroup", + CodeDeployApplication = "AWS::CodeDeploy::Application", + CodeDeployDeploymentConfig = "AWS::CodeDeploy::DeploymentConfig", + CodeDeployDeploymentGroup = "AWS::CodeDeploy::DeploymentGroup", ConformancePackCompliance = "AWS::Config::ConformancePackCompliance", CustomerGateway = "AWS::EC2::CustomerGateway", DBCluster = "AWS::RDS::DBCluster", @@ -649,6 +652,8 @@ export enum ResourceType { Instance = "AWS::EC2::Instance", InternetGateway = "AWS::EC2::InternetGateway", Key = "AWS::KMS::Key", + KinesisStream = "AWS::Kinesis::Stream", + KinesisStreamConsumer = "AWS::Kinesis::StreamConsumer", LaunchConfiguration = "AWS::AutoScaling::LaunchConfiguration", LoadBalancer = "AWS::ElasticLoadBalancing::LoadBalancer", LoadBalancerV2 = "AWS::ElasticLoadBalancingV2::LoadBalancer", @@ -697,6 +702,7 @@ export enum ResourceType { Table = "AWS::DynamoDB::Table", Topic = "AWS::SNS::Topic", Trail = "AWS::CloudTrail::Trail", + TransitGateway = "AWS::EC2::TransitGateway", User = "AWS::IAM::User", VPC = "AWS::EC2::VPC", VPCEndpoint = "AWS::EC2::VPCEndpoint", diff --git a/clients/client-connect/README.md b/clients/client-connect/README.md index 90cacbeeadefe..5a061497dac93 100644 --- a/clients/client-connect/README.md +++ b/clients/client-connect/README.md @@ -15,7 +15,7 @@ appropriate agents.There are limits to the number of Amazon Connect resources that you can create. There are also limits to the number of requests that you can make per second. For more information, see Amazon Connect Service Quotas in the Amazon Connect Administrator Guide.
-You can connect programmatically to an AWS service by using an endpoint. For a list of Amazon Connect +
You can connect programmatically to an Amazon Web Services service by using an endpoint. For a list of Amazon Connect endpoints, see Amazon Connect Endpoints.
There are limits to the number of Amazon Connect resources that you can create. There are also limits * to the number of requests that you can make per second. For more information, see Amazon Connect * Service Quotas in the Amazon Connect Administrator Guide.
- *You can connect programmatically to an AWS service by using an endpoint. For a list of Amazon Connect + *
You can connect programmatically to an Amazon Web Services service by using an endpoint. For a list of Amazon Connect * endpoints, see Amazon Connect * Endpoints.
*Creates an AWS resource association with an Amazon Connect instance.
+ *Creates an Amazon Web Services resource association with an Amazon Connect instance.
*/ public createIntegrationAssociation( args: CreateIntegrationAssociationCommandInput, @@ -1436,7 +1436,7 @@ export class Connect extends ConnectClient { } /** - *Deletes an AWS resource association from an Amazon Connect instance. The association must not have + *
Deletes an Amazon Web Services resource association from an Amazon Connect instance. The association must not have * any use cases associated with it.
*/ public deleteIntegrationAssociation( @@ -2866,7 +2866,7 @@ export class Connect extends ConnectClient { } /** - *Provides summary information about the AWS resource associations for the specified Amazon Connect + *
Provides summary information about the Amazon Web Services resource associations for the specified Amazon Connect * instance.
*/ public listIntegrationAssociations( diff --git a/clients/client-connect/src/ConnectClient.ts b/clients/client-connect/src/ConnectClient.ts index 349628570fd20..55c935fb50111 100644 --- a/clients/client-connect/src/ConnectClient.ts +++ b/clients/client-connect/src/ConnectClient.ts @@ -857,7 +857,7 @@ export interface ConnectClientResolvedConfig extends ConnectClientResolvedConfig *There are limits to the number of Amazon Connect resources that you can create. There are also limits * to the number of requests that you can make per second. For more information, see Amazon Connect * Service Quotas in the Amazon Connect Administrator Guide.
- *You can connect programmatically to an AWS service by using an endpoint. For a list of Amazon Connect + *
You can connect programmatically to an Amazon Web Services service by using an endpoint. For a list of Amazon Connect * endpoints, see Amazon Connect * Endpoints.
*Creates an AWS resource association with an Amazon Connect instance.
+ *Creates an Amazon Web Services resource association with an Amazon Connect instance.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-connect/src/commands/DeleteIntegrationAssociationCommand.ts b/clients/client-connect/src/commands/DeleteIntegrationAssociationCommand.ts index 61ad8bd04595a..0001ef05059e9 100644 --- a/clients/client-connect/src/commands/DeleteIntegrationAssociationCommand.ts +++ b/clients/client-connect/src/commands/DeleteIntegrationAssociationCommand.ts @@ -22,7 +22,7 @@ export interface DeleteIntegrationAssociationCommandInput extends DeleteIntegrat export interface DeleteIntegrationAssociationCommandOutput extends __MetadataBearer {} /** - *Deletes an AWS resource association from an Amazon Connect instance. The association must not have + *
Deletes an Amazon Web Services resource association from an Amazon Connect instance. The association must not have * any use cases associated with it.
* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-connect/src/commands/ListIntegrationAssociationsCommand.ts b/clients/client-connect/src/commands/ListIntegrationAssociationsCommand.ts index 0eb674db8f79c..0dd04a73306d2 100644 --- a/clients/client-connect/src/commands/ListIntegrationAssociationsCommand.ts +++ b/clients/client-connect/src/commands/ListIntegrationAssociationsCommand.ts @@ -24,7 +24,7 @@ export interface ListIntegrationAssociationsCommandOutput __MetadataBearer {} /** - *Provides summary information about the AWS resource associations for the specified Amazon Connect + *
Provides summary information about the Amazon Web Services resource associations for the specified Amazon Connect * instance.
* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-connect/src/models/models_0.ts b/clients/client-connect/src/models/models_0.ts index 410f8e93e984a..907f2c80e5fb7 100644 --- a/clients/client-connect/src/models/models_0.ts +++ b/clients/client-connect/src/models/models_0.ts @@ -1930,6 +1930,11 @@ export interface CreateUserHierarchyGroupRequest { *The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
*/ InstanceId: string | undefined; + + /** + *The tags used to organize, track, or control access for this resource.
+ */ + Tags?: { [key: string]: string }; } export namespace CreateUserHierarchyGroupRequest { @@ -3512,6 +3517,11 @@ export interface HierarchyGroup { *Information about the levels in the hierarchy group.
*/ HierarchyPath?: HierarchyPath; + + /** + *The tags used to organize, track, or control access for this resource.
+ */ + Tags?: { [key: string]: string }; } export namespace HierarchyGroup { @@ -3921,8 +3931,8 @@ export namespace CurrentMetric { */ export interface Filters { /** - *The queues to use to filter the metrics. You can specify up to 100 queues per - * request.
+ *The queues to use to filter the metrics. You should specify at least one queue, and can specify up to 100 queues per
+ * request. The GetCurrentMetricsData API in particular requires a queue when you include a Filter in your request.
The type of attribute.
*Only allowlisted customers can consume USE_CUSTOM_TTS_VOICES. To access this feature, contact AWS Support for allowlisting.
+ *Only allowlisted customers can consume USE_CUSTOM_TTS_VOICES. To access this feature, contact Amazon Web Services Support for allowlisting.
*
+ * GetSavingsPlansCoverage doesn't support filtering by tags. GetSavingsPlansCoverage also doesn't support the OR operator between filter dimensions. For the full request syntax with supported parameters, see Examples.
To determine valid values for a dimension, use the GetDimensionValues operation.
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.
+ * GetSavingsPlansUtilization doesn't support filtering by tags. GetSavingsPlansUtilization also doesn't support the OR operator between filter dimensions. For the full request syntax with supported parameters, see Examples.
* GetSavingsPlanUtilizationDetails internally groups data by SavingsPlansArn.
+ * GetSavingsPlansUtilizationDetails doesn't support filtering by tags. GetSavingsPlansUtilizationDetails also doesn't support the OR operator between filter dimensions. For the full request syntax with supported parameters, see Examples.
+ * GetSavingsPlansCoverage doesn't support filtering by tags. GetSavingsPlansCoverage also doesn't support the OR operator between filter dimensions. For the full request syntax with supported parameters, see Examples.
To determine valid values for a dimension, use the GetDimensionValues operation.
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.
+ * GetSavingsPlansUtilization doesn't support filtering by tags. GetSavingsPlansUtilization also doesn't support the OR operator between filter dimensions. For the full request syntax with supported parameters, see Examples.
* GetSavingsPlanUtilizationDetails internally groups data by SavingsPlansArn.
+ * GetSavingsPlansUtilizationDetails doesn't support filtering by tags. GetSavingsPlansUtilizationDetails also doesn't support the OR operator between filter dimensions. For the full request syntax with supported parameters, see Examples.
Details about the Amazon ES instances that Amazon Web Services recommends that you + *
Details about the Amazon OpenSearch Service instances that Amazon Web Services recommends that you * purchase.
*/ export interface ESInstanceDetails { @@ -2152,7 +2152,7 @@ export interface InstanceDetails { ElastiCacheInstanceDetails?: ElastiCacheInstanceDetails; /** - *The Amazon ES instances that Amazon Web Services recommends that you purchase.
+ *The Amazon OpenSearch Service instances that Amazon Web Services recommends that you purchase.
*/ ESInstanceDetails?: ESInstanceDetails; } @@ -4568,6 +4568,8 @@ export interface GetCostAndUsageRequest { * and get the costs that are associated with that account's usage of that service. You can nestExpression objects
* to define any combination of dimension filters. For more information, see
* Expression.
+ * The default values are EQUALS and CASE_SENSITIVE. Valid values for MatchOptions for Dimensions are EQUALS and CASE_SENSITIVE.
Valid values for MatchOptions for CostCategories and Tags are EQUALS, ABSENT, and CASE_SENSITIVE.
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.
The default values are EQUALS and CASE_SENSITIVE. Valid values for MatchOptions for Dimensions are EQUALS and CASE_SENSITIVE.
Valid values for MatchOptions for CostCategories and Tags are EQUALS, ABSENT, and CASE_SENSITIVE.
The name of the dimension. Each Dimension is available for a different Context.
- * For more information, see Context.
+ * For more information, see Context.
*
*
* 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.
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.
*/ @@ -5635,7 +5638,7 @@ export interface GetReservationUtilizationRequest { *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.
+ * only one level deep.
*/
Filter?: Expression;
@@ -5894,8 +5897,8 @@ export interface GetSavingsPlansCoverageRequest {
*
* 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.
+ * as the other operations, but onlyAND is supported among each dimension.
+ * Cost category is supported. Tags are not supported.
*/ Filter?: Expression; @@ -6070,6 +6073,7 @@ export interface GetSavingsPlansUtilizationDetailsRequest { *GetSavingsPlansUtilizationDetails uses the same
* Expression object
* as the other operations, but only AND is supported among each dimension.
+ * Filtering by tags isn't supported.
*/ Filter?: Expression; @@ -6194,6 +6198,7 @@ export interface GetSavingsPlansUtilizationRequest { *GetSavingsPlansUtilization uses the same
* Expression object
* as the other operations, but only AND is supported among each dimension.
+ * Filtering by tags isn't supported.
*/ Filter?: Expression; diff --git a/clients/client-database-migration-service/src/endpoints.ts b/clients/client-database-migration-service/src/endpoints.ts index a101ed3f50b97..e6baf1d17f8bb 100644 --- a/clients/client-database-migration-service/src/endpoints.ts +++ b/clients/client-database-migration-service/src/endpoints.ts @@ -42,6 +42,14 @@ const regionHash: RegionHash = { }, ], }, + "us-iso-west-1": { + variants: [ + { + hostname: "dms.us-iso-west-1.c2s.ic.gov", + tags: ["fips"], + }, + ], + }, "us-isob-east-1": { variants: [ { @@ -143,7 +151,7 @@ const partitionHash: PartitionHash = { ], }, "aws-iso": { - regions: ["dms", "dms-fips", "us-iso-east-1", "us-iso-east-1-fips", "us-iso-west-1"], + regions: ["dms", "dms-fips", "us-iso-east-1", "us-iso-east-1-fips", "us-iso-west-1", "us-iso-west-1-fips"], regionRegex: "^us\\-iso\\-\\w+\\-\\d+$", variants: [ { diff --git a/clients/client-databrew/src/models/models_0.ts b/clients/client-databrew/src/models/models_0.ts index 52e4730e2498c..391db4fda66cf 100644 --- a/clients/client-databrew/src/models/models_0.ts +++ b/clients/client-databrew/src/models/models_0.ts @@ -253,7 +253,7 @@ export namespace FormatOptions { } /** - *Represents an Amazon S3 location (bucket name and object key) where DataBrew can read + *
Represents an Amazon S3 location (bucket name, bucket owner, and object key) where DataBrew can read * input data, or write output from a job.
*/ export interface S3Location { @@ -266,6 +266,11 @@ export interface S3Location { *The unique name of the object in the bucket.
*/ Key?: string; + + /** + *The Amazon Web Services account ID of the bucket owner.
+ */ + BucketOwner?: string; } export namespace S3Location { @@ -293,7 +298,7 @@ export interface DatabaseInputDefinition { DatabaseTableName?: string; /** - *Represents an Amazon S3 location (bucket name and object key) where DataBrew can read + *
Represents an Amazon S3 location (bucket name, bucket owner, and object key) where DataBrew can read * input data, or write output from a job.
*/ TempDirectory?: S3Location; @@ -1036,7 +1041,7 @@ export interface CreateProfileJobRequest { MaxRetries?: number; /** - *Represents an Amazon S3 location (bucket name and object key) where DataBrew can read + *
Represents an Amazon S3 location (bucket name, bucket owner, and object key) where DataBrew can read * input data, or write output from a job.
*/ OutputLocation: S3Location | undefined; @@ -1802,6 +1807,8 @@ export interface Rule { * rule should be null. If ColumnSelectors has been defined, then there should be no * columnn reference in the left side of a condition, for example, *is_between :val1 and :val2.
+ * For more information, see Available checks + *
*/ CheckExpression: string | undefined; @@ -4490,7 +4497,7 @@ export interface UpdateProfileJobRequest { MaxRetries?: number; /** - *Represents an Amazon S3 location (bucket name and object key) where DataBrew can read + *
Represents an Amazon S3 location (bucket name, bucket owner, and object key) where DataBrew can read * input data, or write output from a job.
*/ OutputLocation: S3Location | undefined; diff --git a/clients/client-databrew/src/protocols/Aws_restJson1.ts b/clients/client-databrew/src/protocols/Aws_restJson1.ts index 6f15d45c8a08a..01204713541f8 100644 --- a/clients/client-databrew/src/protocols/Aws_restJson1.ts +++ b/clients/client-databrew/src/protocols/Aws_restJson1.ts @@ -5633,6 +5633,7 @@ const serializeAws_restJson1RuleList = (input: Rule[], context: __SerdeContext): const serializeAws_restJson1S3Location = (input: S3Location, context: __SerdeContext): any => { return { ...(input.Bucket !== undefined && input.Bucket !== null && { Bucket: input.Bucket }), + ...(input.BucketOwner !== undefined && input.BucketOwner !== null && { BucketOwner: input.BucketOwner }), ...(input.Key !== undefined && input.Key !== null && { Key: input.Key }), }; }; @@ -6646,6 +6647,7 @@ const deserializeAws_restJson1RulesetItemList = (output: any, context: __SerdeCo const deserializeAws_restJson1S3Location = (output: any, context: __SerdeContext): S3Location => { return { Bucket: __expectString(output.Bucket), + BucketOwner: __expectString(output.BucketOwner), Key: __expectString(output.Key), } as any; }; diff --git a/clients/client-ec2-instance-connect/src/models/models_0.ts b/clients/client-ec2-instance-connect/src/models/models_0.ts index 299f0ca5df6c4..4529713452f4d 100644 --- a/clients/client-ec2-instance-connect/src/models/models_0.ts +++ b/clients/client-ec2-instance-connect/src/models/models_0.ts @@ -18,6 +18,17 @@ export interface EC2InstanceNotFoundException extends __SmithyException, $Metada Message?: string; } +/** + *Unable to connect because the instance is not in a valid state. + * Connecting to a stopped or terminated instance is not supported. If the instance is stopped, + * start your instance, and try to connect again.
+ */ +export interface EC2InstanceStateInvalidException extends __SmithyException, $MetadataBearer { + name: "EC2InstanceStateInvalidException"; + $fault: "client"; + Message?: string; +} + /** *The instance type is not supported for connecting via the serial console. Only Nitro * instance types are currently supported.
@@ -154,7 +165,7 @@ export interface SendSSHPublicKeyRequest { /** *The Availability Zone in which the EC2 instance was launched.
*/ - AvailabilityZone: string | undefined; + AvailabilityZone?: string; } export namespace SendSSHPublicKeyRequest { diff --git a/clients/client-ec2-instance-connect/src/protocols/Aws_json1_1.ts b/clients/client-ec2-instance-connect/src/protocols/Aws_json1_1.ts index 79229d6c49a44..29432b5579abe 100644 --- a/clients/client-ec2-instance-connect/src/protocols/Aws_json1_1.ts +++ b/clients/client-ec2-instance-connect/src/protocols/Aws_json1_1.ts @@ -17,6 +17,7 @@ import { SendSSHPublicKeyCommandInput, SendSSHPublicKeyCommandOutput } from "../ import { AuthException, EC2InstanceNotFoundException, + EC2InstanceStateInvalidException, EC2InstanceTypeInvalidException, InvalidArgsException, SendSerialConsoleSSHPublicKeyRequest, @@ -101,6 +102,14 @@ const deserializeAws_json1_1SendSerialConsoleSSHPublicKeyCommandError = async ( $metadata: deserializeMetadata(output), }; break; + case "EC2InstanceStateInvalidException": + case "com.amazonaws.ec2instanceconnect#EC2InstanceStateInvalidException": + response = { + ...(await deserializeAws_json1_1EC2InstanceStateInvalidExceptionResponse(parsedOutput, context)), + name: errorCode, + $metadata: deserializeMetadata(output), + }; + break; case "EC2InstanceTypeInvalidException": case "com.amazonaws.ec2instanceconnect#EC2InstanceTypeInvalidException": response = { @@ -219,6 +228,14 @@ const deserializeAws_json1_1SendSSHPublicKeyCommandError = async ( $metadata: deserializeMetadata(output), }; break; + case "EC2InstanceStateInvalidException": + case "com.amazonaws.ec2instanceconnect#EC2InstanceStateInvalidException": + response = { + ...(await deserializeAws_json1_1EC2InstanceStateInvalidExceptionResponse(parsedOutput, context)), + name: errorCode, + $metadata: deserializeMetadata(output), + }; + break; case "InvalidArgsException": case "com.amazonaws.ec2instanceconnect#InvalidArgsException": response = { @@ -290,6 +307,21 @@ const deserializeAws_json1_1EC2InstanceNotFoundExceptionResponse = async ( return contents; }; +const deserializeAws_json1_1EC2InstanceStateInvalidExceptionResponse = async ( + parsedOutput: any, + context: __SerdeContext +): PromiseDescribe details for Windows AMIs that are configured for faster launching.
+ */ + public describeFastLaunchImages( + args: DescribeFastLaunchImagesCommandInput, + options?: __HttpHandlerOptions + ): PromiseDescribes the state of fast snapshot restores for your snapshots.
*/ @@ -14282,6 +14329,40 @@ export class EC2 extends EC2Client { } } + /** + *Discontinue faster launching for a Windows AMI, and clean up existing pre-provisioned snapshots. + * When you disable faster launching, the AMI uses the standard launch process for each + * instance. All pre-provisioned snapshots must be removed before you can enable faster launching again.
+ */ + public disableFastLaunch( + args: DisableFastLaunchCommandInput, + options?: __HttpHandlerOptions + ): PromiseDisables fast snapshot restores for the specified snapshots in the specified Availability Zones.
*/ @@ -14992,6 +15073,43 @@ export class EC2 extends EC2Client { } } + /** + *When you enable faster launching for a Windows AMI, images are pre-provisioned, + * using snapshots to launch instances up to 65% faster. To create the optimized Windows + * image, Amazon EC2 launches an instance and runs through Sysprep steps, rebooting as required. + * Then it creates a set of reserved snapshots that are used for subsequent launches. The + * reserved snapshots are automatically replenished as they are used, depending on your + * settings for launch frequency.
+ */ + public enableFastLaunch( + args: EnableFastLaunchCommandInput, + options?: __HttpHandlerOptions + ): PromiseEnables fast snapshot restores for the specified snapshots in the specified Availability Zones.
*You get the full benefit of fast snapshot restores after they enter the enabled state.
diff --git a/clients/client-ec2/src/EC2Client.ts b/clients/client-ec2/src/EC2Client.ts
index f70ec6c73cd2a..5f8f66df9891c 100644
--- a/clients/client-ec2/src/EC2Client.ts
+++ b/clients/client-ec2/src/EC2Client.ts
@@ -716,6 +716,10 @@ import {
DescribeExportTasksCommandInput,
DescribeExportTasksCommandOutput,
} from "./commands/DescribeExportTasksCommand";
+import {
+ DescribeFastLaunchImagesCommandInput,
+ DescribeFastLaunchImagesCommandOutput,
+} from "./commands/DescribeFastLaunchImagesCommand";
import {
DescribeFastSnapshotRestoresCommandInput,
DescribeFastSnapshotRestoresCommandOutput,
@@ -1112,6 +1116,7 @@ import {
DisableEbsEncryptionByDefaultCommandInput,
DisableEbsEncryptionByDefaultCommandOutput,
} from "./commands/DisableEbsEncryptionByDefaultCommand";
+import { DisableFastLaunchCommandInput, DisableFastLaunchCommandOutput } from "./commands/DisableFastLaunchCommand";
import {
DisableFastSnapshotRestoresCommandInput,
DisableFastSnapshotRestoresCommandOutput,
@@ -1192,6 +1197,7 @@ import {
EnableEbsEncryptionByDefaultCommandInput,
EnableEbsEncryptionByDefaultCommandOutput,
} from "./commands/EnableEbsEncryptionByDefaultCommand";
+import { EnableFastLaunchCommandInput, EnableFastLaunchCommandOutput } from "./commands/EnableFastLaunchCommand";
import {
EnableFastSnapshotRestoresCommandInput,
EnableFastSnapshotRestoresCommandOutput,
@@ -1982,6 +1988,7 @@ export type ServiceInputTypes =
| DescribeElasticGpusCommandInput
| DescribeExportImageTasksCommandInput
| DescribeExportTasksCommandInput
+ | DescribeFastLaunchImagesCommandInput
| DescribeFastSnapshotRestoresCommandInput
| DescribeFleetHistoryCommandInput
| DescribeFleetInstancesCommandInput
@@ -2096,6 +2103,7 @@ export type ServiceInputTypes =
| DetachVolumeCommandInput
| DetachVpnGatewayCommandInput
| DisableEbsEncryptionByDefaultCommandInput
+ | DisableFastLaunchCommandInput
| DisableFastSnapshotRestoresCommandInput
| DisableImageDeprecationCommandInput
| DisableIpamOrganizationAdminAccountCommandInput
@@ -2116,6 +2124,7 @@ export type ServiceInputTypes =
| DisassociateTrunkInterfaceCommandInput
| DisassociateVpcCidrBlockCommandInput
| EnableEbsEncryptionByDefaultCommandInput
+ | EnableFastLaunchCommandInput
| EnableFastSnapshotRestoresCommandInput
| EnableImageDeprecationCommandInput
| EnableIpamOrganizationAdminAccountCommandInput
@@ -2500,6 +2509,7 @@ export type ServiceOutputTypes =
| DescribeElasticGpusCommandOutput
| DescribeExportImageTasksCommandOutput
| DescribeExportTasksCommandOutput
+ | DescribeFastLaunchImagesCommandOutput
| DescribeFastSnapshotRestoresCommandOutput
| DescribeFleetHistoryCommandOutput
| DescribeFleetInstancesCommandOutput
@@ -2614,6 +2624,7 @@ export type ServiceOutputTypes =
| DetachVolumeCommandOutput
| DetachVpnGatewayCommandOutput
| DisableEbsEncryptionByDefaultCommandOutput
+ | DisableFastLaunchCommandOutput
| DisableFastSnapshotRestoresCommandOutput
| DisableImageDeprecationCommandOutput
| DisableIpamOrganizationAdminAccountCommandOutput
@@ -2634,6 +2645,7 @@ export type ServiceOutputTypes =
| DisassociateTrunkInterfaceCommandOutput
| DisassociateVpcCidrBlockCommandOutput
| EnableEbsEncryptionByDefaultCommandOutput
+ | EnableFastLaunchCommandOutput
| EnableFastSnapshotRestoresCommandOutput
| EnableImageDeprecationCommandOutput
| EnableIpamOrganizationAdminAccountCommandOutput
diff --git a/clients/client-ec2/src/commands/DescribeFastLaunchImagesCommand.ts b/clients/client-ec2/src/commands/DescribeFastLaunchImagesCommand.ts
new file mode 100644
index 0000000000000..2c9b945c72862
--- /dev/null
+++ b/clients/client-ec2/src/commands/DescribeFastLaunchImagesCommand.ts
@@ -0,0 +1,95 @@
+import { getSerdePlugin } from "@aws-sdk/middleware-serde";
+import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@aws-sdk/protocol-http";
+import { Command as $Command } from "@aws-sdk/smithy-client";
+import {
+ FinalizeHandlerArguments,
+ Handler,
+ HandlerExecutionContext,
+ HttpHandlerOptions as __HttpHandlerOptions,
+ MetadataBearer as __MetadataBearer,
+ MiddlewareStack,
+ SerdeContext as __SerdeContext,
+} from "@aws-sdk/types";
+
+import { EC2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../EC2Client";
+import { DescribeFastLaunchImagesRequest, DescribeFastLaunchImagesResult } from "../models/models_3";
+import {
+ deserializeAws_ec2DescribeFastLaunchImagesCommand,
+ serializeAws_ec2DescribeFastLaunchImagesCommand,
+} from "../protocols/Aws_ec2";
+
+export interface DescribeFastLaunchImagesCommandInput extends DescribeFastLaunchImagesRequest {}
+export interface DescribeFastLaunchImagesCommandOutput extends DescribeFastLaunchImagesResult, __MetadataBearer {}
+
+/**
+ *
Describe details for Windows AMIs that are configured for faster launching.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DescribeFastLaunchImagesCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DescribeFastLaunchImagesCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DescribeFastLaunchImagesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeFastLaunchImagesCommandInput} for command's `input` shape. + * @see {@link DescribeFastLaunchImagesCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for EC2Client's `config` shape. + * + */ +export class DescribeFastLaunchImagesCommand extends $Command< + DescribeFastLaunchImagesCommandInput, + DescribeFastLaunchImagesCommandOutput, + EC2ClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + constructor(readonly input: DescribeFastLaunchImagesCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackDiscontinue faster launching for a Windows AMI, and clean up existing pre-provisioned snapshots. + * When you disable faster launching, the AMI uses the standard launch process for each + * instance. All pre-provisioned snapshots must be removed before you can enable faster launching again.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DisableFastLaunchCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DisableFastLaunchCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DisableFastLaunchCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisableFastLaunchCommandInput} for command's `input` shape. + * @see {@link DisableFastLaunchCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for EC2Client's `config` shape. + * + */ +export class DisableFastLaunchCommand extends $Command< + DisableFastLaunchCommandInput, + DisableFastLaunchCommandOutput, + EC2ClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + constructor(readonly input: DisableFastLaunchCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackWhen you enable faster launching for a Windows AMI, images are pre-provisioned, + * using snapshots to launch instances up to 65% faster. To create the optimized Windows + * image, Amazon EC2 launches an instance and runs through Sysprep steps, rebooting as required. + * Then it creates a set of reserved snapshots that are used for subsequent launches. The + * reserved snapshots are automatically replenished as they are used, depending on your + * settings for launch frequency.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, EnableFastLaunchCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, EnableFastLaunchCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new EnableFastLaunchCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link EnableFastLaunchCommandInput} for command's `input` shape. + * @see {@link EnableFastLaunchCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for EC2Client's `config` shape. + * + */ +export class EnableFastLaunchCommand extends $Command< + EnableFastLaunchCommandInput, + EnableFastLaunchCommandOutput, + EC2ClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + constructor(readonly input: EnableFastLaunchCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackChecks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
DryRunOperation. Otherwise, it is UnauthorizedOperation.
*/
DryRun?: boolean;
}
@@ -5132,8 +5132,8 @@ export interface CancelBundleTaskRequest {
/**
* Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
DryRunOperation. Otherwise, it is UnauthorizedOperation.
*/
DryRun?: boolean;
}
@@ -6015,8 +6015,8 @@ export interface CopyImageRequest {
/**
* Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
DryRunOperation. Otherwise, it is UnauthorizedOperation.
*/
DryRun?: boolean;
}
@@ -6192,6 +6192,12 @@ export enum CapacityReservationInstancePlatform {
LINUX_WITH_SQL_SERVER_STANDARD = "Linux with SQL Server Standard",
LINUX_WITH_SQL_SERVER_WEB = "Linux with SQL Server Web",
RED_HAT_ENTERPRISE_LINUX = "Red Hat Enterprise Linux",
+ RHEL_WITH_HA = "RHEL with HA",
+ RHEL_WITH_HA_AND_SQL_SERVER_ENTERPRISE = "RHEL with HA and SQL Server Enterprise",
+ RHEL_WITH_HA_AND_SQL_SERVER_STANDARD = "RHEL with HA and SQL Server Standard",
+ RHEL_WITH_SQL_SERVER_ENTERPRISE = "RHEL with SQL Server Enterprise",
+ RHEL_WITH_SQL_SERVER_STANDARD = "RHEL with SQL Server Standard",
+ RHEL_WITH_SQL_SERVER_WEB = "RHEL with SQL Server Web",
SUSE_LINUX = "SUSE Linux",
WINDOWS = "Windows",
WINDOWS_WITH_SQL_SERVER = "Windows with SQL Server",
@@ -6667,6 +6673,7 @@ export type _InstanceType =
| "c6i.4xlarge"
| "c6i.8xlarge"
| "c6i.large"
+ | "c6i.metal"
| "c6i.xlarge"
| "cc1.4xlarge"
| "cc2.8xlarge"
@@ -6727,6 +6734,7 @@ export type _InstanceType =
| "h1.4xlarge"
| "h1.8xlarge"
| "hi1.4xlarge"
+ | "hpc6a.48xlarge"
| "hs1.8xlarge"
| "i2.2xlarge"
| "i2.4xlarge"
@@ -6875,6 +6883,7 @@ export type _InstanceType =
| "m6i.4xlarge"
| "m6i.8xlarge"
| "m6i.large"
+ | "m6i.metal"
| "m6i.xlarge"
| "mac1.metal"
| "p2.16xlarge"
@@ -6975,6 +6984,16 @@ export type _InstanceType =
| "r6gd.medium"
| "r6gd.metal"
| "r6gd.xlarge"
+ | "r6i.12xlarge"
+ | "r6i.16xlarge"
+ | "r6i.24xlarge"
+ | "r6i.2xlarge"
+ | "r6i.32xlarge"
+ | "r6i.4xlarge"
+ | "r6i.8xlarge"
+ | "r6i.large"
+ | "r6i.metal"
+ | "r6i.xlarge"
| "t1.micro"
| "t2.2xlarge"
| "t2.large"
@@ -7560,6 +7579,20 @@ export namespace ClientConnectOptions {
});
}
+export interface ClientLoginBannerOptions {
+ Enabled?: boolean;
+ BannerText?: string;
+}
+
+export namespace ClientLoginBannerOptions {
+ /**
+ * @internal
+ */
+ export const filterSensitiveLog = (obj: ClientLoginBannerOptions): any => ({
+ ...obj,
+ });
+}
+
/**
* Describes the client connection logging options for the Client VPN endpoint.
*/ @@ -7702,6 +7735,9 @@ export interface CreateClientVpnEndpointRequest { *The options for managing connection authorization for new client connections.
*/ ClientConnectOptions?: ClientConnectOptions; + + SessionTimeoutHours?: number; + ClientLoginBannerOptions?: ClientLoginBannerOptions; } export namespace CreateClientVpnEndpointRequest { @@ -8688,8 +8724,3 @@ export enum LocalStorage { INCLUDED = "included", REQUIRED = "required", } - -export enum LocalStorageType { - HDD = "hdd", - SSD = "ssd", -} diff --git a/clients/client-ec2/src/models/models_1.ts b/clients/client-ec2/src/models/models_1.ts index 5ab5fed09d47d..befc00275856c 100644 --- a/clients/client-ec2/src/models/models_1.ts +++ b/clients/client-ec2/src/models/models_1.ts @@ -29,7 +29,6 @@ import { InternetGatewayAttachment, Ipv4PrefixSpecification, LocalStorage, - LocalStorageType, PortRange, Protocol, ReservedInstancesListing, @@ -44,6 +43,11 @@ import { WeekDay, } from "./models_0"; +export enum LocalStorageType { + HDD = "hdd", + SSD = "ssd", +} + /** *The minimum and maximum amount of memory per vCPU, in GiB.
*/ @@ -2304,8 +2308,8 @@ export interface CreateImageRequest { /** *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
DryRunOperation. Otherwise, it is UnauthorizedOperation.
*/
DryRun?: boolean;
@@ -8011,8 +8015,8 @@ export interface CreateRestoreImageTaskRequest {
/**
* Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
DryRunOperation. Otherwise, it is UnauthorizedOperation.
*/
DryRun?: boolean;
}
@@ -9012,8 +9016,8 @@ export interface CreateStoreImageTaskRequest {
/**
* Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
DryRunOperation. Otherwise, it is UnauthorizedOperation.
*/
DryRun?: boolean;
}
@@ -10332,5 +10336,3 @@ export namespace CreateTransitGatewayConnectPeerRequest {
...obj,
});
}
-
-export type BgpStatus = "down" | "up";
diff --git a/clients/client-ec2/src/models/models_2.ts b/clients/client-ec2/src/models/models_2.ts
index 9fb0cfcb1a545..997b9a0c21ea4 100644
--- a/clients/client-ec2/src/models/models_2.ts
+++ b/clients/client-ec2/src/models/models_2.ts
@@ -36,7 +36,6 @@ import {
VpcPeeringConnection,
} from "./models_0";
import {
- BgpStatus,
DiskImageFormat,
GroupIdentifier,
Ipam,
@@ -46,7 +45,6 @@ import {
LocalGatewayRoute,
LocalGatewayRouteTableVpcAssociation,
ManagedPrefixList,
- PlatformValues,
ProtocolValue,
SubnetCidrReservation,
TransitGateway,
@@ -54,6 +52,8 @@ import {
VolumeType,
} from "./models_1";
+export type BgpStatus = "down" | "up";
+
/**
* The BGP configuration information.
*/ @@ -5870,8 +5870,8 @@ export interface DeregisterImageRequest { /** *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
DryRunOperation. Otherwise, it is UnauthorizedOperation.
*/
DryRun?: boolean;
}
@@ -6702,8 +6702,8 @@ export interface DescribeBundleTasksRequest {
/**
* Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
DryRunOperation. Otherwise, it is UnauthorizedOperation.
*/
DryRun?: boolean;
}
@@ -7907,6 +7907,20 @@ export namespace ClientConnectResponseOptions {
});
}
+export interface ClientLoginBannerResponseOptions {
+ Enabled?: boolean;
+ BannerText?: string;
+}
+
+export namespace ClientLoginBannerResponseOptions {
+ /**
+ * @internal
+ */
+ export const filterSensitiveLog = (obj: ClientLoginBannerResponseOptions): any => ({
+ ...obj,
+ });
+}
+
/**
* Information about the client connection logging options for a Client VPN endpoint.
*/ @@ -8050,6 +8064,9 @@ export interface ClientVpnEndpoint { *The options for managing connection authorization for new client connections.
*/ ClientConnectOptions?: ClientConnectResponseOptions; + + SessionTimeoutHours?: number; + ClientLoginBannerOptions?: ClientLoginBannerResponseOptions; } export namespace ClientVpnEndpoint { @@ -8521,86 +8538,3 @@ export namespace DiskImageVolumeDescription { ...obj, }); } - -/** - *Describes an import volume task.
- */ -export interface ImportInstanceVolumeDetailItem { - /** - *The Availability Zone where the resulting instance will reside.
- */ - AvailabilityZone?: string; - - /** - *The number of bytes converted so far.
- */ - BytesConverted?: number; - - /** - *A description of the task.
- */ - Description?: string; - - /** - *The image.
- */ - Image?: DiskImageDescription; - - /** - *The status of the import of this particular disk image.
- */ - Status?: string; - - /** - *The status information or errors related to the disk image.
- */ - StatusMessage?: string; - - /** - *The volume.
- */ - Volume?: DiskImageVolumeDescription; -} - -export namespace ImportInstanceVolumeDetailItem { - /** - * @internal - */ - export const filterSensitiveLog = (obj: ImportInstanceVolumeDetailItem): any => ({ - ...obj, - }); -} - -/** - *Describes an import instance task.
- */ -export interface ImportInstanceTaskDetails { - /** - *A description of the task.
- */ - Description?: string; - - /** - *The ID of the instance.
- */ - InstanceId?: string; - - /** - *The instance operating system.
- */ - Platform?: PlatformValues | string; - - /** - *The volumes.
- */ - Volumes?: ImportInstanceVolumeDetailItem[]; -} - -export namespace ImportInstanceTaskDetails { - /** - * @internal - */ - export const filterSensitiveLog = (obj: ImportInstanceTaskDetails): any => ({ - ...obj, - }); -} diff --git a/clients/client-ec2/src/models/models_3.ts b/clients/client-ec2/src/models/models_3.ts index 75d58582f164b..81a1d708dc35f 100644 --- a/clients/client-ec2/src/models/models_3.ts +++ b/clients/client-ec2/src/models/models_3.ts @@ -23,9 +23,7 @@ import { InstanceEventWindow, PathComponent, PortRange, - ReservedInstancesListing, Tag, - Tenancy, } from "./models_0"; import { BlockDeviceMapping, @@ -77,10 +75,92 @@ import { Filter, FleetStateCode, IdFormat, - ImportInstanceTaskDetails, InstanceTagNotificationAttribute, } from "./models_2"; +/** + *Describes an import volume task.
+ */ +export interface ImportInstanceVolumeDetailItem { + /** + *The Availability Zone where the resulting instance will reside.
+ */ + AvailabilityZone?: string; + + /** + *The number of bytes converted so far.
+ */ + BytesConverted?: number; + + /** + *A description of the task.
+ */ + Description?: string; + + /** + *The image.
+ */ + Image?: DiskImageDescription; + + /** + *The status of the import of this particular disk image.
+ */ + Status?: string; + + /** + *The status information or errors related to the disk image.
+ */ + StatusMessage?: string; + + /** + *The volume.
+ */ + Volume?: DiskImageVolumeDescription; +} + +export namespace ImportInstanceVolumeDetailItem { + /** + * @internal + */ + export const filterSensitiveLog = (obj: ImportInstanceVolumeDetailItem): any => ({ + ...obj, + }); +} + +/** + *Describes an import instance task.
+ */ +export interface ImportInstanceTaskDetails { + /** + *A description of the task.
+ */ + Description?: string; + + /** + *The ID of the instance.
+ */ + InstanceId?: string; + + /** + *The instance operating system.
+ */ + Platform?: PlatformValues | string; + + /** + *The volumes.
+ */ + Volumes?: ImportInstanceVolumeDetailItem[]; +} + +export namespace ImportInstanceTaskDetails { + /** + * @internal + */ + export const filterSensitiveLog = (obj: ImportInstanceTaskDetails): any => ({ + ...obj, + }); +} + /** *Describes an import volume task.
*/ @@ -785,6 +865,211 @@ export namespace DescribeExportTasksResult { }); } +export interface DescribeFastLaunchImagesRequest { + /** + *Details for one or more Windows AMI image IDs.
+ */ + ImageIds?: string[]; + + /** + *Use the following filters to streamline results.
+ *
+ * resource-type - The resource type for pre-provisioning.
+ * launch-template - The launch template that is associated with the pre-provisioned Windows AMI.
+ * owner-id - The owner ID for the pre-provisioning resource.
+ * state - The current state of fast launching for the Windows AMI.
The maximum number of results to return in a single call. To retrieve the remaining results, + * make another request with the returned NextToken value. If this parameter is not specified, + * then all results are returned.
+ */ + MaxResults?: number; + + /** + *The token for the next set of results.
+ */ + NextToken?: string; + + /** + *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is
+ * DryRunOperation. Otherwise, it is UnauthorizedOperation.
Identifies the launch template to use for faster launching of the Windows AMI.
+ */ +export interface FastLaunchLaunchTemplateSpecificationResponse { + /** + *The ID of the launch template for faster launching of the associated Windows AMI.
+ */ + LaunchTemplateId?: string; + + /** + *The name of the launch template for faster launching of the associated Windows AMI.
+ */ + LaunchTemplateName?: string; + + /** + *The version of the launch template for faster launching of the associated Windows AMI.
+ */ + Version?: string; +} + +export namespace FastLaunchLaunchTemplateSpecificationResponse { + /** + * @internal + */ + export const filterSensitiveLog = (obj: FastLaunchLaunchTemplateSpecificationResponse): any => ({ + ...obj, + }); +} + +export enum FastLaunchResourceType { + SNAPSHOT = "snapshot", +} + +/** + *Configuration settings for creating and managing pre-provisioned snapshots for a fast-launch enabled Windows AMI.
+ */ +export interface FastLaunchSnapshotConfigurationResponse { + /** + *The number of pre-provisioned snapshots requested to keep on hand for a fast-launch enabled Windows AMI.
+ */ + TargetResourceCount?: number; +} + +export namespace FastLaunchSnapshotConfigurationResponse { + /** + * @internal + */ + export const filterSensitiveLog = (obj: FastLaunchSnapshotConfigurationResponse): any => ({ + ...obj, + }); +} + +export enum FastLaunchStateCode { + disabling = "disabling", + disabling_failed = "disabling-failed", + enabled = "enabled", + enabled_failed = "enabled-failed", + enabling = "enabling", + enabling_failed = "enabling-failed", +} + +/** + *Describe details about a fast-launch enabled Windows image that meets the requested
+ * criteria. Criteria are defined by the DescribeFastLaunchImages action filters.
The image ID that identifies the fast-launch enabled Windows image.
+ */ + ImageId?: string; + + /** + *The resource type that is used for pre-provisioning the Windows AMI. Supported values
+ * include: snapshot.
A group of parameters that are used for pre-provisioning the associated + * Windows AMI using snapshots.
+ */ + SnapshotConfiguration?: FastLaunchSnapshotConfigurationResponse; + + /** + *The launch template that the fast-launch enabled Windows AMI uses when it launches + * Windows instances from pre-provisioned snapshots.
+ */ + LaunchTemplate?: FastLaunchLaunchTemplateSpecificationResponse; + + /** + *The maximum number of parallel instances that are launched for creating resources.
+ */ + MaxParallelLaunches?: number; + + /** + *The owner ID for the fast-launch enabled Windows AMI.
+ */ + OwnerId?: string; + + /** + *The current state of faster launching for the specified Windows AMI.
+ */ + State?: FastLaunchStateCode | string; + + /** + *The reason that faster launching for the Windows AMI changed to the current state.
+ */ + StateTransitionReason?: string; + + /** + *The time that faster launching for the Windows AMI changed to the current state.
+ */ + StateTransitionTime?: Date; +} + +export namespace DescribeFastLaunchImagesSuccessItem { + /** + * @internal + */ + export const filterSensitiveLog = (obj: DescribeFastLaunchImagesSuccessItem): any => ({ + ...obj, + }); +} + +export interface DescribeFastLaunchImagesResult { + /** + *A collection of details about the fast-launch enabled Windows images that meet + * the requested criteria.
+ */ + FastLaunchImages?: DescribeFastLaunchImagesSuccessItem[]; + + /** + *The token to use for the next set of results. This value is null when there are + * no more results to return.
+ */ + NextToken?: string; +} + +export namespace DescribeFastLaunchImagesResult { + /** + * @internal + */ + export const filterSensitiveLog = (obj: DescribeFastLaunchImagesResult): any => ({ + ...obj, + }); +} + export interface DescribeFastSnapshotRestoresRequest { /** *The filters. The possible values are:
@@ -3440,8 +3725,8 @@ export interface DescribeImageAttributeRequest { /** *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
DryRunOperation. Otherwise, it is UnauthorizedOperation.
*/
DryRun?: boolean;
}
@@ -3750,8 +4035,8 @@ export interface DescribeImagesRequest {
/**
* Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
DryRunOperation. Otherwise, it is UnauthorizedOperation.
*/
DryRun?: boolean;
}
@@ -11679,357 +11964,3 @@ export namespace DescribeReservedInstancesRequest {
export type RIProductDescription = "Linux/UNIX" | "Linux/UNIX (Amazon VPC)" | "Windows" | "Windows (Amazon VPC)";
export type RecurringChargeFrequency = "Hourly";
-
-/**
- * Describes a recurring charge.
- */ -export interface RecurringCharge { - /** - *The amount of the recurring charge.
- */ - Amount?: number; - - /** - *The frequency of the recurring charge.
- */ - Frequency?: RecurringChargeFrequency | string; -} - -export namespace RecurringCharge { - /** - * @internal - */ - export const filterSensitiveLog = (obj: RecurringCharge): any => ({ - ...obj, - }); -} - -export enum Scope { - AVAILABILITY_ZONE = "Availability Zone", - REGIONAL = "Region", -} - -export type ReservedInstanceState = - | "active" - | "payment-failed" - | "payment-pending" - | "queued" - | "queued-deleted" - | "retired"; - -/** - *Describes a Reserved Instance.
- */ -export interface ReservedInstances { - /** - *The Availability Zone in which the Reserved Instance can be used.
- */ - AvailabilityZone?: string; - - /** - *The duration of the Reserved Instance, in seconds.
- */ - Duration?: number; - - /** - *The time when the Reserved Instance expires.
- */ - End?: Date; - - /** - *The purchase price of the Reserved Instance.
- */ - FixedPrice?: number; - - /** - *The number of reservations purchased.
- */ - InstanceCount?: number; - - /** - *The instance type on which the Reserved Instance can be used.
- */ - InstanceType?: _InstanceType | string; - - /** - *The Reserved Instance product platform description.
- */ - ProductDescription?: RIProductDescription | string; - - /** - *The ID of the Reserved Instance.
- */ - ReservedInstancesId?: string; - - /** - *The date and time the Reserved Instance started.
- */ - Start?: Date; - - /** - *The state of the Reserved Instance purchase.
- */ - State?: ReservedInstanceState | string; - - /** - *The usage price of the Reserved Instance, per hour.
- */ - UsagePrice?: number; - - /** - *The currency of the Reserved Instance. It's specified using ISO 4217 standard currency codes.
- * At this time, the only supported currency is USD.
The tenancy of the instance.
- */ - InstanceTenancy?: Tenancy | string; - - /** - *The offering class of the Reserved Instance.
- */ - OfferingClass?: OfferingClassType | string; - - /** - *The Reserved Instance offering type.
- */ - OfferingType?: OfferingTypeValues | string; - - /** - *The recurring charge tag assigned to the resource.
- */ - RecurringCharges?: RecurringCharge[]; - - /** - *The scope of the Reserved Instance.
- */ - Scope?: Scope | string; - - /** - *Any tags assigned to the resource.
- */ - Tags?: Tag[]; -} - -export namespace ReservedInstances { - /** - * @internal - */ - export const filterSensitiveLog = (obj: ReservedInstances): any => ({ - ...obj, - }); -} - -/** - *Contains the output for DescribeReservedInstances.
- */ -export interface DescribeReservedInstancesResult { - /** - *A list of Reserved Instances.
- */ - ReservedInstances?: ReservedInstances[]; -} - -export namespace DescribeReservedInstancesResult { - /** - * @internal - */ - export const filterSensitiveLog = (obj: DescribeReservedInstancesResult): any => ({ - ...obj, - }); -} - -/** - *Contains the parameters for DescribeReservedInstancesListings.
- */ -export interface DescribeReservedInstancesListingsRequest { - /** - *One or more filters.
- *
- * reserved-instances-id - The ID of the Reserved Instances.
- * reserved-instances-listing-id - The ID of the Reserved Instances listing.
- * status - The status of the Reserved Instance listing (pending | active |
- * cancelled | closed).
- * status-message - The reason for the status.
One or more Reserved Instance IDs.
- */ - ReservedInstancesId?: string; - - /** - *One or more Reserved Instance listing IDs.
- */ - ReservedInstancesListingId?: string; -} - -export namespace DescribeReservedInstancesListingsRequest { - /** - * @internal - */ - export const filterSensitiveLog = (obj: DescribeReservedInstancesListingsRequest): any => ({ - ...obj, - }); -} - -/** - *Contains the output of DescribeReservedInstancesListings.
- */ -export interface DescribeReservedInstancesListingsResult { - /** - *Information about the Reserved Instance listing.
- */ - ReservedInstancesListings?: ReservedInstancesListing[]; -} - -export namespace DescribeReservedInstancesListingsResult { - /** - * @internal - */ - export const filterSensitiveLog = (obj: DescribeReservedInstancesListingsResult): any => ({ - ...obj, - }); -} - -/** - *Contains the parameters for DescribeReservedInstancesModifications.
- */ -export interface DescribeReservedInstancesModificationsRequest { - /** - *One or more filters.
- *
- * client-token - The idempotency token for the modification request.
- * create-date - The time when the modification request was created.
- * effective-date - The time when the modification becomes effective.
- * modification-result.reserved-instances-id - The ID for the Reserved Instances created as part of the modification request. This ID is only available when the status of the modification is fulfilled.
- * modification-result.target-configuration.availability-zone - The Availability Zone for the new Reserved Instances.
- * modification-result.target-configuration.instance-count - The number of new Reserved Instances.
- * modification-result.target-configuration.instance-type - The instance type of the new Reserved Instances.
- * modification-result.target-configuration.platform - The network platform of the new Reserved Instances (EC2-Classic | EC2-VPC).
- * reserved-instances-id - The ID of the Reserved Instances modified.
- * reserved-instances-modification-id - The ID of the modification request.
- * status - The status of the Reserved Instances modification request
- * (processing | fulfilled | failed).
- * status-message - The reason for the status.
- * update-date - The time when the modification request was last updated.
IDs for the submitted modification request.
- */ - ReservedInstancesModificationIds?: string[]; - - /** - *The token to retrieve the next page of results.
- */ - NextToken?: string; -} - -export namespace DescribeReservedInstancesModificationsRequest { - /** - * @internal - */ - export const filterSensitiveLog = (obj: DescribeReservedInstancesModificationsRequest): any => ({ - ...obj, - }); -} - -/** - *Describes the configuration settings for the modified Reserved Instances.
- */ -export interface ReservedInstancesConfiguration { - /** - *The Availability Zone for the modified Reserved Instances.
- */ - AvailabilityZone?: string; - - /** - *The number of modified Reserved Instances.
- *This is a required field for a request.
- *The instance type for the modified Reserved Instances.
- */ - InstanceType?: _InstanceType | string; - - /** - *The network platform of the modified Reserved Instances, which is either EC2-Classic or EC2-VPC.
- */ - Platform?: string; - - /** - *Whether the Reserved Instance is applied to instances in a Region or instances in a specific Availability Zone.
- */ - Scope?: Scope | string; -} - -export namespace ReservedInstancesConfiguration { - /** - * @internal - */ - export const filterSensitiveLog = (obj: ReservedInstancesConfiguration): any => ({ - ...obj, - }); -} diff --git a/clients/client-ec2/src/models/models_4.ts b/clients/client-ec2/src/models/models_4.ts index f26ae106d0ffd..b4f9a7d761a15 100644 --- a/clients/client-ec2/src/models/models_4.ts +++ b/clients/client-ec2/src/models/models_4.ts @@ -11,8 +11,8 @@ import { IamInstanceProfileAssociation, IamInstanceProfileSpecification, InstanceEventWindow, - IpamPoolAllocation, IpPermission, + ReservedInstancesListing, ResourceType, SecurityGroupRule, Subnet, @@ -47,7 +47,6 @@ import { Ipv4PrefixSpecificationRequest, Ipv6PrefixSpecificationRequest, PrivateIpAddressSpecification, - RequestIpamResourceTag, RouteTable, Snapshot, SnapshotState, @@ -68,7 +67,6 @@ import { DnsEntry, DnsNameState, Filter, - IpamPoolCidr, PayerResponsibility, ServiceConfiguration, ServiceTypeDetail, @@ -86,290 +84,646 @@ import { AttributeBooleanValue, EventInformation, ExportTaskS3Location, + FastLaunchLaunchTemplateSpecificationResponse, + FastLaunchResourceType, + FastLaunchSnapshotConfigurationResponse, + FastLaunchStateCode, FastSnapshotRestoreStateCode, OfferingClassType, OfferingTypeValues, PaymentOption, PermissionGroup, ProductCode, - RecurringCharge, - ReservedInstancesConfiguration, + RecurringChargeFrequency, RIProductDescription, - Scope, VirtualizationType, } from "./models_3"; /** - *Describes the modification request/s.
+ *Describes a recurring charge.
*/ -export interface ReservedInstancesModificationResult { +export interface RecurringCharge { /** - *The ID for the Reserved Instances that were created as part of the modification request. This field is only available when the modification is fulfilled.
+ *The amount of the recurring charge.
*/ - ReservedInstancesId?: string; + Amount?: number; /** - *The target Reserved Instances configurations supplied as part of the modification request.
+ *The frequency of the recurring charge.
*/ - TargetConfiguration?: ReservedInstancesConfiguration; + Frequency?: RecurringChargeFrequency | string; } -export namespace ReservedInstancesModificationResult { +export namespace RecurringCharge { /** * @internal */ - export const filterSensitiveLog = (obj: ReservedInstancesModificationResult): any => ({ + export const filterSensitiveLog = (obj: RecurringCharge): any => ({ ...obj, }); } +export enum Scope { + AVAILABILITY_ZONE = "Availability Zone", + REGIONAL = "Region", +} + +export type ReservedInstanceState = + | "active" + | "payment-failed" + | "payment-pending" + | "queued" + | "queued-deleted" + | "retired"; + /** - *Describes the ID of a Reserved Instance.
+ *Describes a Reserved Instance.
*/ -export interface ReservedInstancesId { +export interface ReservedInstances { + /** + *The Availability Zone in which the Reserved Instance can be used.
+ */ + AvailabilityZone?: string; + + /** + *The duration of the Reserved Instance, in seconds.
+ */ + Duration?: number; + + /** + *The time when the Reserved Instance expires.
+ */ + End?: Date; + + /** + *The purchase price of the Reserved Instance.
+ */ + FixedPrice?: number; + + /** + *The number of reservations purchased.
+ */ + InstanceCount?: number; + + /** + *The instance type on which the Reserved Instance can be used.
+ */ + InstanceType?: _InstanceType | string; + + /** + *The Reserved Instance product platform description.
+ */ + ProductDescription?: RIProductDescription | string; + /** *The ID of the Reserved Instance.
*/ ReservedInstancesId?: string; -} -export namespace ReservedInstancesId { /** - * @internal + *The date and time the Reserved Instance started.
*/ - export const filterSensitiveLog = (obj: ReservedInstancesId): any => ({ - ...obj, - }); -} + Start?: Date; -/** - *Describes a Reserved Instance modification.
- */ -export interface ReservedInstancesModification { /** - *A unique, case-sensitive key supplied by the client to ensure that the request is idempotent. - * For more information, see Ensuring - * Idempotency.
+ *The state of the Reserved Instance purchase.
*/ - ClientToken?: string; + State?: ReservedInstanceState | string; /** - *The time when the modification request was created.
+ *The usage price of the Reserved Instance, per hour.
*/ - CreateDate?: Date; + UsagePrice?: number; /** - *The time for the modification to become effective.
+ *The currency of the Reserved Instance. It's specified using ISO 4217 standard currency codes.
+ * At this time, the only supported currency is USD.
Contains target configurations along with their corresponding new Reserved Instance IDs.
+ *The tenancy of the instance.
*/ - ModificationResults?: ReservedInstancesModificationResult[]; + InstanceTenancy?: Tenancy | string; /** - *The IDs of one or more Reserved Instances.
+ *The offering class of the Reserved Instance.
*/ - ReservedInstancesIds?: ReservedInstancesId[]; + OfferingClass?: OfferingClassType | string; /** - *A unique ID for the Reserved Instance modification.
+ *The Reserved Instance offering type.
*/ - ReservedInstancesModificationId?: string; + OfferingType?: OfferingTypeValues | string; /** - *The status of the Reserved Instances modification request.
+ *The recurring charge tag assigned to the resource.
*/ - Status?: string; + RecurringCharges?: RecurringCharge[]; /** - *The reason for the status.
+ *The scope of the Reserved Instance.
*/ - StatusMessage?: string; + Scope?: Scope | string; /** - *The time when the modification request was last updated.
+ *Any tags assigned to the resource.
*/ - UpdateDate?: Date; + Tags?: Tag[]; } -export namespace ReservedInstancesModification { +export namespace ReservedInstances { /** * @internal */ - export const filterSensitiveLog = (obj: ReservedInstancesModification): any => ({ + export const filterSensitiveLog = (obj: ReservedInstances): any => ({ ...obj, }); } /** - *Contains the output of DescribeReservedInstancesModifications.
+ *Contains the output for DescribeReservedInstances.
*/ -export interface DescribeReservedInstancesModificationsResult { +export interface DescribeReservedInstancesResult { /** - *The token to use to retrieve the next page of results. This value is null when
- * there are no more results to return.
A list of Reserved Instances.
*/ - NextToken?: string; + ReservedInstances?: ReservedInstances[]; +} +export namespace DescribeReservedInstancesResult { /** - *The Reserved Instance modification information.
+ * @internal */ - ReservedInstancesModifications?: ReservedInstancesModification[]; + export const filterSensitiveLog = (obj: DescribeReservedInstancesResult): any => ({ + ...obj, + }); } -export namespace DescribeReservedInstancesModificationsResult { +/** + *Contains the parameters for DescribeReservedInstancesListings.
+ */ +export interface DescribeReservedInstancesListingsRequest { + /** + *One or more filters.
+ *
+ * reserved-instances-id - The ID of the Reserved Instances.
+ * reserved-instances-listing-id - The ID of the Reserved Instances listing.
+ * status - The status of the Reserved Instance listing (pending | active |
+ * cancelled | closed).
+ * status-message - The reason for the status.
One or more Reserved Instance IDs.
+ */ + ReservedInstancesId?: string; + + /** + *One or more Reserved Instance listing IDs.
+ */ + ReservedInstancesListingId?: string; +} + +export namespace DescribeReservedInstancesListingsRequest { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeReservedInstancesModificationsResult): any => ({ + export const filterSensitiveLog = (obj: DescribeReservedInstancesListingsRequest): any => ({ ...obj, }); } /** - *Contains the parameters for DescribeReservedInstancesOfferings.
+ *Contains the output of DescribeReservedInstancesListings.
*/ -export interface DescribeReservedInstancesOfferingsRequest { +export interface DescribeReservedInstancesListingsResult { /** - *The Availability Zone in which the Reserved Instance can be used.
+ *Information about the Reserved Instance listing.
*/ - AvailabilityZone?: string; + ReservedInstancesListings?: ReservedInstancesListing[]; +} + +export namespace DescribeReservedInstancesListingsResult { + /** + * @internal + */ + export const filterSensitiveLog = (obj: DescribeReservedInstancesListingsResult): any => ({ + ...obj, + }); +} +/** + *Contains the parameters for DescribeReservedInstancesModifications.
+ */ +export interface DescribeReservedInstancesModificationsRequest { /** *One or more filters.
*
- * availability-zone - The Availability Zone where the Reserved Instance can be
- * used.
client-token - The idempotency token for the modification request.
*
- * duration - The duration of the Reserved Instance (for example, one year or
- * three years), in seconds (31536000 | 94608000).
create-date - The time when the modification request was created.
*
- * fixed-price - The purchase price of the Reserved Instance (for example,
- * 9800.0).
effective-date - The time when the modification becomes effective.
*
- * instance-type - The instance type that is covered by the
- * reservation.
modification-result.reserved-instances-id - The ID for the Reserved Instances created as part of the modification request. This ID is only available when the status of the modification is fulfilled.
*
- * marketplace - Set to true to show only Reserved Instance
- * Marketplace offerings. When this filter is not used, which is the default behavior, all
- * offerings from both Amazon Web Services and the Reserved Instance Marketplace are listed.
modification-result.target-configuration.availability-zone - The Availability Zone for the new Reserved Instances.
*
- * product-description - The Reserved Instance product platform description.
- * Instances that include (Amazon VPC) in the product platform description will
- * only be displayed to EC2-Classic account holders and are for use with Amazon VPC.
- * (Linux/UNIX | Linux/UNIX (Amazon VPC) | SUSE
- * Linux | SUSE Linux (Amazon VPC) | Red Hat Enterprise
- * Linux | Red Hat Enterprise Linux (Amazon VPC) | Red Hat
- * Enterprise Linux with HA (Amazon VPC) | Windows | Windows
- * (Amazon VPC) | Windows with SQL Server Standard | Windows with
- * SQL Server Standard (Amazon VPC) | Windows with SQL Server Web |
- * Windows with SQL Server Web (Amazon VPC) | Windows with SQL Server
- * Enterprise | Windows with SQL Server Enterprise (Amazon VPC))
modification-result.target-configuration.instance-count - The number of new Reserved Instances.
*
- * reserved-instances-offering-id - The Reserved Instances offering
- * ID.
modification-result.target-configuration.instance-type - The instance type of the new Reserved Instances.
*
- * scope - The scope of the Reserved Instance (Availability Zone or
- * Region).
modification-result.target-configuration.platform - The network platform of the new Reserved Instances (EC2-Classic | EC2-VPC).
*
- * usage-price - The usage price of the Reserved Instance, per hour (for
- * example, 0.84).
reserved-instances-id - The ID of the Reserved Instances modified.
+ *
+ * reserved-instances-modification-id - The ID of the modification request.
+ * status - The status of the Reserved Instances modification request
+ * (processing | fulfilled | failed).
+ * status-message - The reason for the status.
+ * update-date - The time when the modification request was last updated.
Include Reserved Instance Marketplace offerings in the response.
+ *IDs for the submitted modification request.
*/ - IncludeMarketplace?: boolean; + ReservedInstancesModificationIds?: string[]; /** - *The instance type that the reservation will cover (for example, m1.small). For more information, see
- * Instance types in the
- * Amazon EC2 User Guide.
The token to retrieve the next page of results.
*/ - InstanceType?: _InstanceType | string; + NextToken?: string; +} +export namespace DescribeReservedInstancesModificationsRequest { /** - *The maximum duration (in seconds) to filter when searching for offerings.
- *Default: 94608000 (3 years)
+ * @internal */ - MaxDuration?: number; + export const filterSensitiveLog = (obj: DescribeReservedInstancesModificationsRequest): any => ({ + ...obj, + }); +} +/** + *Describes the configuration settings for the modified Reserved Instances.
+ */ +export interface ReservedInstancesConfiguration { /** - *The maximum number of instances to filter when searching for offerings.
- *Default: 20
+ *The Availability Zone for the modified Reserved Instances.
*/ - MaxInstanceCount?: number; + AvailabilityZone?: string; /** - *The minimum duration (in seconds) to filter when searching for offerings.
- *Default: 2592000 (1 month)
+ *The number of modified Reserved Instances.
+ *This is a required field for a request.
+ *The offering class of the Reserved Instance. Can be standard or convertible.
The instance type for the modified Reserved Instances.
*/ - OfferingClass?: OfferingClassType | string; + InstanceType?: _InstanceType | string; /** - *The Reserved Instance product platform description. Instances that include (Amazon
- * VPC) in the description are for use with Amazon VPC.
The network platform of the modified Reserved Instances, which is either EC2-Classic or EC2-VPC.
*/ - ProductDescription?: RIProductDescription | string; + Platform?: string; /** - *One or more Reserved Instances offering IDs.
+ *Whether the Reserved Instance is applied to instances in a Region or instances in a specific Availability Zone.
*/ - ReservedInstancesOfferingIds?: string[]; + Scope?: Scope | string; +} +export namespace ReservedInstancesConfiguration { /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
Describes the modification request/s.
+ */ +export interface ReservedInstancesModificationResult { /** - *The tenancy of the instances covered by the reservation. A Reserved Instance with a tenancy
- * of dedicated is applied to instances that run in a VPC on single-tenant hardware
- * (i.e., Dedicated Instances).
- * Important: The host value cannot be used with this parameter. Use the default or dedicated values only.
Default: default
- *
The ID for the Reserved Instances that were created as part of the modification request. This field is only available when the modification is fulfilled.
*/ - InstanceTenancy?: Tenancy | string; + ReservedInstancesId?: string; /** - *The maximum number of results to return for the request in a single page. The remaining
- * results of the initial request can be seen by sending another request with the returned
- * NextToken value. The maximum is 100.
Default: 100
+ *The target Reserved Instances configurations supplied as part of the modification request.
*/ - MaxResults?: number; + TargetConfiguration?: ReservedInstancesConfiguration; +} + +export namespace ReservedInstancesModificationResult { + /** + * @internal + */ + export const filterSensitiveLog = (obj: ReservedInstancesModificationResult): any => ({ + ...obj, + }); +} + +/** + *Describes the ID of a Reserved Instance.
+ */ +export interface ReservedInstancesId { + /** + *The ID of the Reserved Instance.
+ */ + ReservedInstancesId?: string; +} + +export namespace ReservedInstancesId { + /** + * @internal + */ + export const filterSensitiveLog = (obj: ReservedInstancesId): any => ({ + ...obj, + }); +} + +/** + *Describes a Reserved Instance modification.
+ */ +export interface ReservedInstancesModification { + /** + *A unique, case-sensitive key supplied by the client to ensure that the request is idempotent. + * For more information, see Ensuring + * Idempotency.
+ */ + ClientToken?: string; + + /** + *The time when the modification request was created.
+ */ + CreateDate?: Date; + + /** + *The time for the modification to become effective.
+ */ + EffectiveDate?: Date; + + /** + *Contains target configurations along with their corresponding new Reserved Instance IDs.
+ */ + ModificationResults?: ReservedInstancesModificationResult[]; + + /** + *The IDs of one or more Reserved Instances.
+ */ + ReservedInstancesIds?: ReservedInstancesId[]; + + /** + *A unique ID for the Reserved Instance modification.
+ */ + ReservedInstancesModificationId?: string; + + /** + *The status of the Reserved Instances modification request.
+ */ + Status?: string; + + /** + *The reason for the status.
+ */ + StatusMessage?: string; + + /** + *The time when the modification request was last updated.
+ */ + UpdateDate?: Date; +} + +export namespace ReservedInstancesModification { + /** + * @internal + */ + export const filterSensitiveLog = (obj: ReservedInstancesModification): any => ({ + ...obj, + }); +} + +/** + *Contains the output of DescribeReservedInstancesModifications.
+ */ +export interface DescribeReservedInstancesModificationsResult { + /** + *The token to use to retrieve the next page of results. This value is null when
+ * there are no more results to return.
The Reserved Instance modification information.
+ */ + ReservedInstancesModifications?: ReservedInstancesModification[]; +} + +export namespace DescribeReservedInstancesModificationsResult { + /** + * @internal + */ + export const filterSensitiveLog = (obj: DescribeReservedInstancesModificationsResult): any => ({ + ...obj, + }); +} + +/** + *Contains the parameters for DescribeReservedInstancesOfferings.
+ */ +export interface DescribeReservedInstancesOfferingsRequest { + /** + *The Availability Zone in which the Reserved Instance can be used.
+ */ + AvailabilityZone?: string; + + /** + *One or more filters.
+ *
+ * availability-zone - The Availability Zone where the Reserved Instance can be
+ * used.
+ * duration - The duration of the Reserved Instance (for example, one year or
+ * three years), in seconds (31536000 | 94608000).
+ * fixed-price - The purchase price of the Reserved Instance (for example,
+ * 9800.0).
+ * instance-type - The instance type that is covered by the
+ * reservation.
+ * marketplace - Set to true to show only Reserved Instance
+ * Marketplace offerings. When this filter is not used, which is the default behavior, all
+ * offerings from both Amazon Web Services and the Reserved Instance Marketplace are listed.
+ * product-description - The Reserved Instance product platform description.
+ * Instances that include (Amazon VPC) in the product platform description will
+ * only be displayed to EC2-Classic account holders and are for use with Amazon VPC.
+ * (Linux/UNIX | Linux/UNIX (Amazon VPC) | SUSE
+ * Linux | SUSE Linux (Amazon VPC) | Red Hat Enterprise
+ * Linux | Red Hat Enterprise Linux (Amazon VPC) | Red Hat
+ * Enterprise Linux with HA (Amazon VPC) | Windows | Windows
+ * (Amazon VPC) | Windows with SQL Server Standard | Windows with
+ * SQL Server Standard (Amazon VPC) | Windows with SQL Server Web |
+ * Windows with SQL Server Web (Amazon VPC) | Windows with SQL Server
+ * Enterprise | Windows with SQL Server Enterprise (Amazon VPC))
+ * reserved-instances-offering-id - The Reserved Instances offering
+ * ID.
+ * scope - The scope of the Reserved Instance (Availability Zone or
+ * Region).
+ * usage-price - The usage price of the Reserved Instance, per hour (for
+ * example, 0.84).
Include Reserved Instance Marketplace offerings in the response.
+ */ + IncludeMarketplace?: boolean; + + /** + *The instance type that the reservation will cover (for example, m1.small). For more information, see
+ * Instance types in the
+ * Amazon EC2 User Guide.
The maximum duration (in seconds) to filter when searching for offerings.
+ *Default: 94608000 (3 years)
+ */ + MaxDuration?: number; + + /** + *The maximum number of instances to filter when searching for offerings.
+ *Default: 20
+ */ + MaxInstanceCount?: number; + + /** + *The minimum duration (in seconds) to filter when searching for offerings.
+ *Default: 2592000 (1 month)
+ */ + MinDuration?: number; + + /** + *The offering class of the Reserved Instance. Can be standard or convertible.
The Reserved Instance product platform description. Instances that include (Amazon
+ * VPC) in the description are for use with Amazon VPC.
One or more Reserved Instances offering IDs.
+ */ + ReservedInstancesOfferingIds?: string[]; + + /** + *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The tenancy of the instances covered by the reservation. A Reserved Instance with a tenancy
+ * of dedicated is applied to instances that run in a VPC on single-tenant hardware
+ * (i.e., Dedicated Instances).
+ * Important: The host value cannot be used with this parameter. Use the default or dedicated values only.
Default: default
+ *
The maximum number of results to return for the request in a single page. The remaining
+ * results of the initial request can be seen by sending another request with the returned
+ * NextToken value. The maximum is 100.
Default: 100
+ */ + MaxResults?: number; /** *The token to retrieve the next page of results.
@@ -4084,8 +4438,8 @@ export interface DescribeStoreImageTasksRequest { /** *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
DryRunOperation. Otherwise, it is UnauthorizedOperation.
*/
DryRun?: boolean;
@@ -7923,6 +8277,93 @@ export namespace DisableEbsEncryptionByDefaultResult {
});
}
+export interface DisableFastLaunchRequest {
+ /**
+ * The ID of the image for which you’re turning off faster launching, and removing pre-provisioned snapshots.
+ */ + ImageId: string | undefined; + + /** + *Forces the image settings to turn off faster launching for your Windows AMI. This parameter overrides + * any errors that are encountered while cleaning up resources in your account.
+ */ + Force?: boolean; + + /** + *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is
+ * DryRunOperation. Otherwise, it is UnauthorizedOperation.
The ID of the image for which faster-launching has been turned off.
+ */ + ImageId?: string; + + /** + *The pre-provisioning resource type that must be cleaned after turning off faster launching
+ * for the Windows AMI. Supported values include: snapshot.
Parameters that were used for faster launching for the Windows AMI before + * faster launching was turned off. This informs the clean-up process.
+ */ + SnapshotConfiguration?: FastLaunchSnapshotConfigurationResponse; + + /** + *The launch template that was used to launch Windows instances from pre-provisioned snapshots.
+ */ + LaunchTemplate?: FastLaunchLaunchTemplateSpecificationResponse; + + /** + *The maximum number of parallel instances to launch for creating resources.
+ */ + MaxParallelLaunches?: number; + + /** + *The owner of the Windows AMI for which faster launching was turned off.
+ */ + OwnerId?: string; + + /** + *The current state of faster launching for the specified Windows AMI.
+ */ + State?: FastLaunchStateCode | string; + + /** + *The reason that the state changed for faster launching for the Windows AMI.
+ */ + StateTransitionReason?: string; + + /** + *The time that the state changed for faster launching for the Windows AMI.
+ */ + StateTransitionTime?: Date; +} + +export namespace DisableFastLaunchResult { + /** + * @internal + */ + export const filterSensitiveLog = (obj: DisableFastLaunchResult): any => ({ + ...obj, + }); +} + export interface DisableFastSnapshotRestoresRequest { /** *One or more Availability Zones. For example, us-east-2a.
Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
DryRunOperation. Otherwise, it is UnauthorizedOperation.
*/
DryRun?: boolean;
}
@@ -8909,362 +9350,196 @@ export namespace EnableEbsEncryptionByDefaultRequest {
/**
* @internal
*/
- export const filterSensitiveLog = (obj: EnableEbsEncryptionByDefaultRequest): any => ({
- ...obj,
- });
-}
-
-export interface EnableEbsEncryptionByDefaultResult {
- /**
- * The updated status of encryption by default.
- */ - EbsEncryptionByDefault?: boolean; -} - -export namespace EnableEbsEncryptionByDefaultResult { - /** - * @internal - */ - export const filterSensitiveLog = (obj: EnableEbsEncryptionByDefaultResult): any => ({ - ...obj, - }); -} - -export interface EnableFastSnapshotRestoresRequest { - /** - *One or more Availability Zones. For example, us-east-2a.
The IDs of one or more snapshots. For example, snap-1234567890abcdef0. You can specify
- * a snapshot that was shared with you from another Amazon Web Services account.
Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
Describes fast snapshot restores that were successfully enabled.
- */ -export interface EnableFastSnapshotRestoreSuccessItem { - /** - *The ID of the snapshot.
- */ - SnapshotId?: string; - - /** - *The Availability Zone.
- */ - AvailabilityZone?: string; - - /** - *The state of fast snapshot restores.
- */ - State?: FastSnapshotRestoreStateCode | string; - - /** - *The reason for the state transition. The possible values are as follows:
- *
- * Client.UserInitiated - The state successfully transitioned to enabling or
- * disabling.
- * Client.UserInitiated - Lifecycle state transition - The state successfully transitioned
- * to optimizing, enabled, or disabled.
The ID of the Amazon Web Services account that enabled fast snapshot restores on the snapshot.
- */ - OwnerId?: string; - - /** - *The Amazon Web Services owner alias that enabled fast snapshot restores on the snapshot. This is intended for future use.
- */ - OwnerAlias?: string; - - /** - *The time at which fast snapshot restores entered the enabling state.
The time at which fast snapshot restores entered the optimizing state.
The time at which fast snapshot restores entered the enabled state.
The time at which fast snapshot restores entered the disabling state.
The time at which fast snapshot restores entered the disabled state.
Describes an error that occurred when enabling fast snapshot restores.
- */ -export interface EnableFastSnapshotRestoreStateError { - /** - *The error code.
- */ - Code?: string; + export const filterSensitiveLog = (obj: EnableEbsEncryptionByDefaultRequest): any => ({ + ...obj, + }); +} +export interface EnableEbsEncryptionByDefaultResult { /** - *The error message.
+ *The updated status of encryption by default.
*/ - Message?: string; + EbsEncryptionByDefault?: boolean; } -export namespace EnableFastSnapshotRestoreStateError { +export namespace EnableEbsEncryptionByDefaultResult { /** * @internal */ - export const filterSensitiveLog = (obj: EnableFastSnapshotRestoreStateError): any => ({ + export const filterSensitiveLog = (obj: EnableEbsEncryptionByDefaultResult): any => ({ ...obj, }); } /** - *Contains information about an error that occurred when enabling fast snapshot restores.
+ *Request to create a launch template for a fast-launch enabled Windows AMI.
+ *Note - You can specify either the LaunchTemplateName or the
+ * LaunchTemplateId, but not both.
The Availability Zone.
+ *The ID of the launch template to use for faster launching for a Windows AMI.
*/ - AvailabilityZone?: string; + LaunchTemplateId?: string; /** - *The error.
+ *The name of the launch template to use for faster launching for a Windows AMI.
*/ - Error?: EnableFastSnapshotRestoreStateError; + LaunchTemplateName?: string; + + /** + *The version of the launch template to use for faster launching for a Windows AMI.
+ */ + Version: string | undefined; } -export namespace EnableFastSnapshotRestoreStateErrorItem { +export namespace FastLaunchLaunchTemplateSpecificationRequest { /** * @internal */ - export const filterSensitiveLog = (obj: EnableFastSnapshotRestoreStateErrorItem): any => ({ + export const filterSensitiveLog = (obj: FastLaunchLaunchTemplateSpecificationRequest): any => ({ ...obj, }); } /** - *Contains information about the errors that occurred when enabling fast snapshot restores.
+ *Configuration settings for creating and managing pre-provisioned snapshots for a fast-launch enabled Windows AMI.
*/ -export interface EnableFastSnapshotRestoreErrorItem { - /** - *The ID of the snapshot.
- */ - SnapshotId?: string; - +export interface FastLaunchSnapshotConfigurationRequest { /** - *The errors.
+ *The number of pre-provisioned snapshots to keep on hand for a fast-launch enabled Windows AMI.
*/ - FastSnapshotRestoreStateErrors?: EnableFastSnapshotRestoreStateErrorItem[]; + TargetResourceCount?: number; } -export namespace EnableFastSnapshotRestoreErrorItem { +export namespace FastLaunchSnapshotConfigurationRequest { /** * @internal */ - export const filterSensitiveLog = (obj: EnableFastSnapshotRestoreErrorItem): any => ({ + export const filterSensitiveLog = (obj: FastLaunchSnapshotConfigurationRequest): any => ({ ...obj, }); } -export interface EnableFastSnapshotRestoresResult { +export interface EnableFastLaunchRequest { /** - *Information about the snapshots for which fast snapshot restores were successfully enabled.
+ *The ID of the image for which you’re enabling faster launching.
*/ - Successful?: EnableFastSnapshotRestoreSuccessItem[]; + ImageId: string | undefined; /** - *Information about the snapshots for which fast snapshot restores could not be enabled.
+ *The type of resource to use for pre-provisioning the Windows AMI for faster launching.
+ * Supported values include: snapshot, which is the default value.
Configuration settings for creating and managing the snapshots that are used for
+ * pre-provisioning the Windows AMI for faster launching. The associated ResourceType
+ * must be snapshot.
The ID of the AMI.
+ *The launch template to use when launching Windows instances from pre-provisioned + * snapshots. Launch template parameters can include either the name or ID of the launch + * template, but not both.
*/ - ImageId: string | undefined; + LaunchTemplate?: FastLaunchLaunchTemplateSpecificationRequest; /** - *The date and time to deprecate the AMI, in UTC, in the following format: - * YYYY-MM-DDTHH:MM:SSZ. - * If you specify a value for seconds, Amazon EC2 rounds the seconds to the - * nearest minute.
- *You can’t specify a date in the past. The upper limit for DeprecateAt is 10
- * years from now.
The maximum number of parallel instances to launch for creating resources.
*/ - DeprecateAt: Date | undefined; + MaxParallelLaunches?: number; /** *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
DryRunOperation. Otherwise, it is UnauthorizedOperation.
*/
DryRun?: boolean;
}
-export namespace EnableImageDeprecationRequest {
+export namespace EnableFastLaunchRequest {
/**
* @internal
*/
- export const filterSensitiveLog = (obj: EnableImageDeprecationRequest): any => ({
+ export const filterSensitiveLog = (obj: EnableFastLaunchRequest): any => ({
...obj,
});
}
-export interface EnableImageDeprecationResult {
- /**
- * Returns true if the request succeeds; otherwise, it returns an error.
The image ID that identifies the Windows AMI for which faster launching was enabled.
*/ - export const filterSensitiveLog = (obj: EnableImageDeprecationResult): any => ({ - ...obj, - }); -} + ImageId?: string; -export interface EnableIpamOrganizationAdminAccountRequest { /** - *A check for whether you have the required permissions for the action without actually making the request
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The type of resource that was defined for pre-provisioning the Windows AMI for faster launching.
*/ - DryRun?: boolean; + ResourceType?: FastLaunchResourceType | string; /** - *The Organizations member account ID that you want to enable as the IPAM account.
+ *The configuration settings that were defined for creating and managing the pre-provisioned snapshots
+ * for faster launching of the Windows AMI. This property is returned when the associated
+ * resourceType is snapshot.
The launch template that is used when launching Windows instances from pre-provisioned snapshots.
*/ - export const filterSensitiveLog = (obj: EnableIpamOrganizationAdminAccountRequest): any => ({ - ...obj, - }); -} + LaunchTemplate?: FastLaunchLaunchTemplateSpecificationResponse; -export interface EnableIpamOrganizationAdminAccountResult { /** - *The result of enabling the IPAM account.
+ *The maximum number of parallel instances to launch for creating resources.
*/ - Success?: boolean; -} + MaxParallelLaunches?: number; -export namespace EnableIpamOrganizationAdminAccountResult { /** - * @internal + *The owner ID for the Windows AMI for which faster launching was enabled.
*/ - export const filterSensitiveLog = (obj: EnableIpamOrganizationAdminAccountResult): any => ({ - ...obj, - }); -} + OwnerId?: string; -export interface EnableSerialConsoleAccessRequest { /** - *Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
The current state of faster launching for the specified Windows AMI.
*/ - DryRun?: boolean; -} + State?: FastLaunchStateCode | string; -export namespace EnableSerialConsoleAccessRequest { /** - * @internal + *The reason that the state changed for faster launching for the Windows AMI.
*/ - export const filterSensitiveLog = (obj: EnableSerialConsoleAccessRequest): any => ({ - ...obj, - }); -} + StateTransitionReason?: string; -export interface EnableSerialConsoleAccessResult { /** - *If true, access to the EC2 serial console of all instances is enabled for
- * your account. If false, access to the EC2 serial console of all instances
- * is disabled for your account.
The time that the state changed for faster launching for the Windows AMI.
*/ - SerialConsoleAccessEnabled?: boolean; + StateTransitionTime?: Date; } -export namespace EnableSerialConsoleAccessResult { +export namespace EnableFastLaunchResult { /** * @internal */ - export const filterSensitiveLog = (obj: EnableSerialConsoleAccessResult): any => ({ + export const filterSensitiveLog = (obj: EnableFastLaunchResult): any => ({ ...obj, }); } -export interface EnableTransitGatewayRouteTablePropagationRequest { +export interface EnableFastSnapshotRestoresRequest { /** - *The ID of the propagation route table.
+ *One or more Availability Zones. For example, us-east-2a.
The ID of the attachment.
+ *The IDs of one or more snapshots. For example, snap-1234567890abcdef0. You can specify
+ * a snapshot that was shared with you from another Amazon Web Services account.
Checks whether you have the required permissions for the action, without actually making the request, @@ -9274,304 +9549,321 @@ export interface EnableTransitGatewayRouteTablePropagationRequest { DryRun?: boolean; } -export namespace EnableTransitGatewayRouteTablePropagationRequest { +export namespace EnableFastSnapshotRestoresRequest { /** * @internal */ - export const filterSensitiveLog = (obj: EnableTransitGatewayRouteTablePropagationRequest): any => ({ + export const filterSensitiveLog = (obj: EnableFastSnapshotRestoresRequest): any => ({ ...obj, }); } -export interface EnableTransitGatewayRouteTablePropagationResult { +/** + *
Describes fast snapshot restores that were successfully enabled.
+ */ +export interface EnableFastSnapshotRestoreSuccessItem { /** - *Information about route propagation.
+ *The ID of the snapshot.
*/ - Propagation?: TransitGatewayPropagation; -} + SnapshotId?: string; -export namespace EnableTransitGatewayRouteTablePropagationResult { /** - * @internal + *The Availability Zone.
*/ - export const filterSensitiveLog = (obj: EnableTransitGatewayRouteTablePropagationResult): any => ({ - ...obj, - }); -} + AvailabilityZone?: string; -/** - *Contains the parameters for EnableVgwRoutePropagation.
- */ -export interface EnableVgwRoutePropagationRequest { /** - *The ID of the virtual private gateway that is attached to a VPC. The virtual private - * gateway must be attached to the same VPC that the routing tables are associated with. - *
+ *The state of fast snapshot restores.
*/ - GatewayId: string | undefined; + State?: FastSnapshotRestoreStateCode | string; /** - *The ID of the route table. The routing table must be associated with the same VPC that - * the virtual private gateway is attached to.
+ *The reason for the state transition. The possible values are as follows:
+ *
+ * Client.UserInitiated - The state successfully transitioned to enabling or
+ * disabling.
+ * Client.UserInitiated - Lifecycle state transition - The state successfully transitioned
+ * to optimizing, enabled, or disabled.
Checks whether you have the required permissions for the action, without actually
- * making the request, and provides an error response. If you have the required
- * permissions, the error response is DryRunOperation. Otherwise, it is
- * UnauthorizedOperation.
The ID of the Amazon Web Services account that enabled fast snapshot restores on the snapshot.
*/ - DryRun?: boolean; -} + OwnerId?: string; -export namespace EnableVgwRoutePropagationRequest { /** - * @internal + *The Amazon Web Services owner alias that enabled fast snapshot restores on the snapshot. This is intended for future use.
*/ - export const filterSensitiveLog = (obj: EnableVgwRoutePropagationRequest): any => ({ - ...obj, - }); -} + OwnerAlias?: string; -export interface EnableVolumeIORequest { /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The time at which fast snapshot restores entered the enabling state.
The ID of the volume.
+ *The time at which fast snapshot restores entered the optimizing state.
The time at which fast snapshot restores entered the enabled state.
The time at which fast snapshot restores entered the disabling state.
The time at which fast snapshot restores entered the disabled state.
Describes an error that occurred when enabling fast snapshot restores.
+ */ +export interface EnableFastSnapshotRestoreStateError { /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The error code.
*/ - DryRun?: boolean; + Code?: string; /** - *The ID of the VPC.
+ *The error message.
*/ - VpcId: string | undefined; + Message?: string; } -export namespace EnableVpcClassicLinkRequest { +export namespace EnableFastSnapshotRestoreStateError { /** * @internal */ - export const filterSensitiveLog = (obj: EnableVpcClassicLinkRequest): any => ({ + export const filterSensitiveLog = (obj: EnableFastSnapshotRestoreStateError): any => ({ ...obj, }); } -export interface EnableVpcClassicLinkResult { +/** + *Contains information about an error that occurred when enabling fast snapshot restores.
+ */ +export interface EnableFastSnapshotRestoreStateErrorItem { /** - *Returns true if the request succeeds; otherwise, it returns an error.
The Availability Zone.
*/ - Return?: boolean; + AvailabilityZone?: string; + + /** + *The error.
+ */ + Error?: EnableFastSnapshotRestoreStateError; } -export namespace EnableVpcClassicLinkResult { +export namespace EnableFastSnapshotRestoreStateErrorItem { /** * @internal */ - export const filterSensitiveLog = (obj: EnableVpcClassicLinkResult): any => ({ + export const filterSensitiveLog = (obj: EnableFastSnapshotRestoreStateErrorItem): any => ({ ...obj, }); } -export interface EnableVpcClassicLinkDnsSupportRequest { +/** + *Contains information about the errors that occurred when enabling fast snapshot restores.
+ */ +export interface EnableFastSnapshotRestoreErrorItem { /** - *The ID of the VPC.
+ *The ID of the snapshot.
*/ - VpcId?: string; + SnapshotId?: string; + + /** + *The errors.
+ */ + FastSnapshotRestoreStateErrors?: EnableFastSnapshotRestoreStateErrorItem[]; } -export namespace EnableVpcClassicLinkDnsSupportRequest { +export namespace EnableFastSnapshotRestoreErrorItem { /** * @internal */ - export const filterSensitiveLog = (obj: EnableVpcClassicLinkDnsSupportRequest): any => ({ + export const filterSensitiveLog = (obj: EnableFastSnapshotRestoreErrorItem): any => ({ ...obj, }); } -export interface EnableVpcClassicLinkDnsSupportResult { +export interface EnableFastSnapshotRestoresResult { /** - *Returns true if the request succeeds; otherwise, it returns an error.
Information about the snapshots for which fast snapshot restores were successfully enabled.
*/ - Return?: boolean; + Successful?: EnableFastSnapshotRestoreSuccessItem[]; + + /** + *Information about the snapshots for which fast snapshot restores could not be enabled.
+ */ + Unsuccessful?: EnableFastSnapshotRestoreErrorItem[]; } -export namespace EnableVpcClassicLinkDnsSupportResult { +export namespace EnableFastSnapshotRestoresResult { /** * @internal */ - export const filterSensitiveLog = (obj: EnableVpcClassicLinkDnsSupportResult): any => ({ + export const filterSensitiveLog = (obj: EnableFastSnapshotRestoresResult): any => ({ ...obj, }); } -export interface ExportClientVpnClientCertificateRevocationListRequest { +export interface EnableImageDeprecationRequest { /** - *The ID of the Client VPN endpoint.
+ *The ID of the AMI.
*/ - ClientVpnEndpointId: string | undefined; + ImageId: string | undefined; /** - *Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
The date and time to deprecate the AMI, in UTC, in the following format: + * YYYY-MM-DDTHH:MM:SSZ. + * If you specify a value for seconds, Amazon EC2 rounds the seconds to the + * nearest minute.
+ *You can’t specify a date in the past. The upper limit for DeprecateAt is 10
+ * years from now.
Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is
+ * DryRunOperation. Otherwise, it is UnauthorizedOperation.
Describes the state of a client certificate revocation list.
- */ -export interface ClientCertificateRevocationListStatus { - /** - *The state of the client certificate revocation list.
- */ - Code?: ClientCertificateRevocationListStatusCode | string; - +export interface EnableImageDeprecationResult { /** - *A message about the status of the client certificate revocation list, if applicable.
+ *Returns true if the request succeeds; otherwise, it returns an error.
Information about the client certificate revocation list.
+ *A check for whether you have the required permissions for the action without actually making the request
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The current state of the client certificate revocation list.
+ *The Organizations member account ID that you want to enable as the IPAM account.
*/ - Status?: ClientCertificateRevocationListStatus; + DelegatedAdminAccountId: string | undefined; } -export namespace ExportClientVpnClientCertificateRevocationListResult { +export namespace EnableIpamOrganizationAdminAccountRequest { /** * @internal */ - export const filterSensitiveLog = (obj: ExportClientVpnClientCertificateRevocationListResult): any => ({ + export const filterSensitiveLog = (obj: EnableIpamOrganizationAdminAccountRequest): any => ({ ...obj, }); } -export interface ExportClientVpnClientConfigurationRequest { - /** - *The ID of the Client VPN endpoint.
- */ - ClientVpnEndpointId: string | undefined; - +export interface EnableIpamOrganizationAdminAccountResult { /** - *Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
The result of enabling the IPAM account.
*/ - DryRun?: boolean; + Success?: boolean; } -export namespace ExportClientVpnClientConfigurationRequest { +export namespace EnableIpamOrganizationAdminAccountResult { /** * @internal */ - export const filterSensitiveLog = (obj: ExportClientVpnClientConfigurationRequest): any => ({ + export const filterSensitiveLog = (obj: EnableIpamOrganizationAdminAccountResult): any => ({ ...obj, }); } -export interface ExportClientVpnClientConfigurationResult { +export interface EnableSerialConsoleAccessRequest { /** - *The contents of the Client VPN endpoint configuration file.
+ *Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Describes the destination for an export image task.
- */ -export interface ExportTaskS3LocationRequest { - /** - *The destination Amazon S3 bucket.
- */ - S3Bucket: string | undefined; - +export interface EnableSerialConsoleAccessResult { /** - *The prefix (logical hierarchy) in the bucket.
+ *If true, access to the EC2 serial console of all instances is enabled for
+ * your account. If false, access to the EC2 serial console of all instances
+ * is disabled for your account.
Token to enable idempotency for export image requests.
- */ - ClientToken?: string; - +export interface EnableTransitGatewayRouteTablePropagationRequest { /** - *A description of the image being exported. The maximum length is 255 characters.
+ *The ID of the propagation route table.
*/ - Description?: string; + TransitGatewayRouteTableId: string | undefined; /** - *The disk image format.
+ *The ID of the attachment.
*/ - DiskImageFormat: DiskImageFormat | string | undefined; + TransitGatewayAttachmentId: string | undefined; /** *Checks whether you have the required permissions for the action, without actually making the request,
@@ -9579,197 +9871,167 @@ export interface ExportImageRequest {
* Otherwise, it is UnauthorizedOperation.
The ID of the image.
- */ - ImageId: string | undefined; - - /** - *Information about the destination Amazon S3 bucket. The bucket must exist and grant WRITE - * and READ_ACP permissions to the Amazon Web Services account vm-import-export@amazon.com.
- */ - S3ExportLocation: ExportTaskS3LocationRequest | undefined; - - /** - *The name of the role that grants VM Import/Export permission to export images to your Amazon - * S3 bucket. If this parameter is not specified, the default role is named 'vmimport'.
+ * @internal */ - RoleName?: string; + export const filterSensitiveLog = (obj: EnableTransitGatewayRouteTablePropagationRequest): any => ({ + ...obj, + }); +} +export interface EnableTransitGatewayRouteTablePropagationResult { /** - *The tags to apply to the export image task during creation.
+ *Information about route propagation.
*/ - TagSpecifications?: TagSpecification[]; + Propagation?: TransitGatewayPropagation; } -export namespace ExportImageRequest { +export namespace EnableTransitGatewayRouteTablePropagationResult { /** * @internal */ - export const filterSensitiveLog = (obj: ExportImageRequest): any => ({ + export const filterSensitiveLog = (obj: EnableTransitGatewayRouteTablePropagationResult): any => ({ ...obj, }); } -export interface ExportImageResult { - /** - *A description of the image being exported.
- */ - Description?: string; - +/** + *Contains the parameters for EnableVgwRoutePropagation.
+ */ +export interface EnableVgwRoutePropagationRequest { /** - *The disk image format for the exported image.
+ *The ID of the virtual private gateway that is attached to a VPC. The virtual private + * gateway must be attached to the same VPC that the routing tables are associated with. + *
*/ - DiskImageFormat?: DiskImageFormat | string; + GatewayId: string | undefined; /** - *The ID of the export image task.
+ *The ID of the route table. The routing table must be associated with the same VPC that + * the virtual private gateway is attached to.
*/ - ExportImageTaskId?: string; + RouteTableId: string | undefined; /** - *The ID of the image.
+ *Checks whether you have the required permissions for the action, without actually
+ * making the request, and provides an error response. If you have the required
+ * permissions, the error response is DryRunOperation. Otherwise, it is
+ * UnauthorizedOperation.
The name of the role that grants VM Import/Export permission to export images to your Amazon - * S3 bucket.
+ * @internal */ - RoleName?: string; + export const filterSensitiveLog = (obj: EnableVgwRoutePropagationRequest): any => ({ + ...obj, + }); +} +export interface EnableVolumeIORequest { /** - *The percent complete of the export image task.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Information about the destination Amazon S3 bucket.
+ *The ID of the volume.
*/ - S3ExportLocation?: ExportTaskS3Location; + VolumeId: string | undefined; +} +export namespace EnableVolumeIORequest { /** - *The status of the export image task. The possible values are active, completed,
- * deleting, and deleted.
The status message for the export image task.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Any tags assigned to the export image task.
+ *The ID of the VPC.
*/ - Tags?: Tag[]; + VpcId: string | undefined; } -export namespace ExportImageResult { +export namespace EnableVpcClassicLinkRequest { /** * @internal */ - export const filterSensitiveLog = (obj: ExportImageResult): any => ({ + export const filterSensitiveLog = (obj: EnableVpcClassicLinkRequest): any => ({ ...obj, }); } -export interface ExportTransitGatewayRoutesRequest { - /** - *The ID of the route table.
- */ - TransitGatewayRouteTableId: string | undefined; - +export interface EnableVpcClassicLinkResult { /** - *One or more filters. The possible values are:
- *
- * attachment.transit-gateway-attachment-id - The id of the transit gateway attachment.
- * attachment.resource-id - The resource id of the transit gateway attachment.
- * route-search.exact-match - The exact match of the specified filter.
- * route-search.longest-prefix-match - The longest prefix that matches the route.
- * route-search.subnet-of-match - The routes with a subnet that match the specified CIDR filter.
- * route-search.supernet-of-match - The routes with a CIDR that encompass the CIDR filter. For example, if you have 10.0.1.0/29 and 10.0.1.0/31 routes in your route table and you specify supernet-of-match as 10.0.1.0/30, then the result returns 10.0.1.0/29.
- * state - The state of the route (active | blackhole).
- * transit-gateway-route-destination-cidr-block - The CIDR range.
- * type - The type of route (propagated |
- * static).
Returns true if the request succeeds; otherwise, it returns an error.
The name of the S3 bucket.
+ * @internal */ - S3Bucket: string | undefined; + export const filterSensitiveLog = (obj: EnableVpcClassicLinkResult): any => ({ + ...obj, + }); +} +export interface EnableVpcClassicLinkDnsSupportRequest { /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The ID of the VPC.
*/ - DryRun?: boolean; + VpcId?: string; } -export namespace ExportTransitGatewayRoutesRequest { +export namespace EnableVpcClassicLinkDnsSupportRequest { /** * @internal */ - export const filterSensitiveLog = (obj: ExportTransitGatewayRoutesRequest): any => ({ + export const filterSensitiveLog = (obj: EnableVpcClassicLinkDnsSupportRequest): any => ({ ...obj, }); } -export interface ExportTransitGatewayRoutesResult { +export interface EnableVpcClassicLinkDnsSupportResult { /** - *The URL of the exported file in Amazon S3. For example, - * s3://bucket_name/VPCTransitGateway/TransitGatewayRouteTables/file_name.
+ *Returns true if the request succeeds; otherwise, it returns an error.
The ARN of the ACM certificate for which to view the associated IAM roles, encryption keys, and Amazon - * S3 object information.
+ *The ID of the Client VPN endpoint.
*/ - CertificateArn?: string; + ClientVpnEndpointId: string | undefined; /** *Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Information about the associated IAM roles.
+ *Describes the state of a client certificate revocation list.
*/ -export interface AssociatedRole { - /** - *The ARN of the associated IAM role.
- */ - AssociatedRoleArn?: string; - - /** - *The name of the Amazon S3 bucket in which the Amazon S3 object is stored.
- */ - CertificateS3BucketName?: string; - +export interface ClientCertificateRevocationListStatus { /** - *The key of the Amazon S3 object ey where the certificate, certificate chain, and encrypted private key bundle
- * is stored. The object key is formated as follows: role_arn/certificate_arn.
- *
The state of the client certificate revocation list.
*/ - CertificateS3ObjectKey?: string; + Code?: ClientCertificateRevocationListStatusCode | string; /** - *The ID of the KMS customer master key (CMK) used to encrypt the private key.
+ *A message about the status of the client certificate revocation list, if applicable.
*/ - EncryptionKmsKeyId?: string; + Message?: string; } -export namespace AssociatedRole { +export namespace ClientCertificateRevocationListStatus { /** * @internal */ - export const filterSensitiveLog = (obj: AssociatedRole): any => ({ + export const filterSensitiveLog = (obj: ClientCertificateRevocationListStatus): any => ({ ...obj, }); } -export interface GetAssociatedEnclaveCertificateIamRolesResult { +export interface ExportClientVpnClientCertificateRevocationListResult { /** - *Information about the associated IAM roles.
+ *Information about the client certificate revocation list.
*/ - AssociatedRoles?: AssociatedRole[]; + CertificateRevocationList?: string; + + /** + *The current state of the client certificate revocation list.
+ */ + Status?: ClientCertificateRevocationListStatus; } -export namespace GetAssociatedEnclaveCertificateIamRolesResult { +export namespace ExportClientVpnClientCertificateRevocationListResult { /** * @internal */ - export const filterSensitiveLog = (obj: GetAssociatedEnclaveCertificateIamRolesResult): any => ({ + export const filterSensitiveLog = (obj: ExportClientVpnClientCertificateRevocationListResult): any => ({ ...obj, }); } -export interface GetAssociatedIpv6PoolCidrsRequest { +export interface ExportClientVpnClientConfigurationRequest { /** - *The ID of the IPv6 address pool.
+ *The ID of the Client VPN endpoint.
*/ - PoolId: string | undefined; + ClientVpnEndpointId: string | undefined; /** - *The token for the next page of results.
+ *Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
The maximum number of results to return with a single call.
- * To retrieve the remaining results, make another call with the returned nextToken value.
Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The contents of the Client VPN endpoint configuration file.
*/ - DryRun?: boolean; + ClientConfiguration?: string; } -export namespace GetAssociatedIpv6PoolCidrsRequest { +export namespace ExportClientVpnClientConfigurationResult { /** * @internal */ - export const filterSensitiveLog = (obj: GetAssociatedIpv6PoolCidrsRequest): any => ({ + export const filterSensitiveLog = (obj: ExportClientVpnClientConfigurationResult): any => ({ ...obj, }); } /** - *Describes an IPv6 CIDR block association.
+ *Describes the destination for an export image task.
*/ -export interface Ipv6CidrAssociation { +export interface ExportTaskS3LocationRequest { /** - *The IPv6 CIDR block.
+ *The destination Amazon S3 bucket.
*/ - Ipv6Cidr?: string; + S3Bucket: string | undefined; /** - *The resource that's associated with the IPv6 CIDR block.
+ *The prefix (logical hierarchy) in the bucket.
*/ - AssociatedResource?: string; + S3Prefix?: string; } -export namespace Ipv6CidrAssociation { +export namespace ExportTaskS3LocationRequest { /** * @internal */ - export const filterSensitiveLog = (obj: Ipv6CidrAssociation): any => ({ + export const filterSensitiveLog = (obj: ExportTaskS3LocationRequest): any => ({ ...obj, }); } -export interface GetAssociatedIpv6PoolCidrsResult { +export interface ExportImageRequest { /** - *Information about the IPv6 CIDR block associations.
+ *Token to enable idempotency for export image requests.
*/ - Ipv6CidrAssociations?: Ipv6CidrAssociation[]; + ClientToken?: string; /** - *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
A description of the image being exported. The maximum length is 255 characters.
*/ - NextToken?: string; + Description?: string; + + /** + *The disk image format.
+ */ + DiskImageFormat: DiskImageFormat | string | undefined; + + /** + *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The ID of the image.
+ */ + ImageId: string | undefined; + + /** + *Information about the destination Amazon S3 bucket. The bucket must exist and grant WRITE + * and READ_ACP permissions to the Amazon Web Services account vm-import-export@amazon.com.
+ */ + S3ExportLocation: ExportTaskS3LocationRequest | undefined; + + /** + *The name of the role that grants VM Import/Export permission to export images to your Amazon + * S3 bucket. If this parameter is not specified, the default role is named 'vmimport'.
+ */ + RoleName?: string; + + /** + *The tags to apply to the export image task during creation.
+ */ + TagSpecifications?: TagSpecification[]; } -export namespace GetAssociatedIpv6PoolCidrsResult { +export namespace ExportImageRequest { /** * @internal */ - export const filterSensitiveLog = (obj: GetAssociatedIpv6PoolCidrsResult): any => ({ + export const filterSensitiveLog = (obj: ExportImageRequest): any => ({ ...obj, }); } -export interface GetCapacityReservationUsageRequest { - /** - *The ID of the Capacity Reservation.
- */ - CapacityReservationId: string | undefined; - +export interface ExportImageResult { /** - *The token to use to retrieve the next page of results.
+ *A description of the image being exported.
*/ - NextToken?: string; + Description?: string; /** - *The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error.
Valid range: Minimum value of 1. Maximum value of 1000.
+ *The disk image format for the exported image.
*/ - MaxResults?: number; + DiskImageFormat?: DiskImageFormat | string; /** - *Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
The ID of the export image task.
*/ - DryRun?: boolean; -} + ExportImageTaskId?: string; -export namespace GetCapacityReservationUsageRequest { /** - * @internal + *The ID of the image.
*/ - export const filterSensitiveLog = (obj: GetCapacityReservationUsageRequest): any => ({ - ...obj, - }); -} + ImageId?: string; -/** - *Information about the Capacity Reservation usage.
- */ -export interface InstanceUsage { /** - *The ID of the Amazon Web Services account that is making use of the Capacity Reservation.
+ *The name of the role that grants VM Import/Export permission to export images to your Amazon + * S3 bucket.
*/ - AccountId?: string; + RoleName?: string; /** - *The number of instances the Amazon Web Services account currently has in the Capacity Reservation.
+ *The percent complete of the export image task.
*/ - UsedInstanceCount?: number; -} + Progress?: string; -export namespace InstanceUsage { /** - * @internal + *Information about the destination Amazon S3 bucket.
*/ - export const filterSensitiveLog = (obj: InstanceUsage): any => ({ - ...obj, - }); -} + S3ExportLocation?: ExportTaskS3Location; -export interface GetCapacityReservationUsageResult { /** - *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The status of the export image task. The possible values are active, completed,
+ * deleting, and deleted.
The ID of the Capacity Reservation.
+ *The status message for the export image task.
*/ - CapacityReservationId?: string; + StatusMessage?: string; /** - *The type of instance for which the Capacity Reservation reserves capacity.
+ *Any tags assigned to the export image task.
*/ - InstanceType?: string; + Tags?: Tag[]; +} +export namespace ExportImageResult { /** - *The number of instances for which the Capacity Reservation reserves capacity.
+ * @internal */ - TotalInstanceCount?: number; + export const filterSensitiveLog = (obj: ExportImageResult): any => ({ + ...obj, + }); +} +export interface ExportTransitGatewayRoutesRequest { /** - *The remaining capacity. Indicates the number of instances that can be launched in the Capacity Reservation.
+ *The ID of the route table.
*/ - AvailableInstanceCount?: number; + TransitGatewayRouteTableId: string | undefined; /** - *The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:
- *One or more filters. The possible values are:
+ *
- * active - The Capacity Reservation is active and the capacity is available for your use.
attachment.transit-gateway-attachment-id - The id of the transit gateway attachment.
*
- * expired - The Capacity Reservation expired automatically at the date and time specified
- * in your request. The reserved capacity is no longer available for your use.
attachment.resource-id - The resource id of the transit gateway attachment.
*
- * cancelled - The Capacity Reservation was cancelled. The reserved capacity is no
- * longer available for your use.
route-search.exact-match - The exact match of the specified filter.
*
- * pending - The Capacity Reservation request was successful but the capacity
- * provisioning is still pending.
route-search.longest-prefix-match - The longest prefix that matches the route.
*
- * failed - The Capacity Reservation request has failed. A request might fail
- * due to invalid request parameters, capacity constraints, or instance limit constraints.
- * Failed requests are retained for 60 minutes.
route-search.subnet-of-match - The routes with a subnet that match the specified CIDR filter.
* Information about the Capacity Reservation usage.
- */ - InstanceUsages?: InstanceUsage[]; -} - -export namespace GetCapacityReservationUsageResult { - /** - * @internal - */ - export const filterSensitiveLog = (obj: GetCapacityReservationUsageResult): any => ({ - ...obj, - }); -} - -export interface GetCoipPoolUsageRequest { - /** - *The ID of the address pool.
- */ - PoolId: string | undefined; - - /** - *The filters. The following are the possible values:
- *
- * coip-address-usage.allocation-id
- *
route-search.supernet-of-match - The routes with a CIDR that encompass the CIDR filter. For example, if you have 10.0.1.0/29 and 10.0.1.0/31 routes in your route table and you specify supernet-of-match as 10.0.1.0/30, then the result returns 10.0.1.0/29.
*
- * coip-address-usage.aws-account-id
- *
state - The state of the route (active | blackhole).
*
- * coip-address-usage.aws-service
- *
transit-gateway-route-destination-cidr-block - The CIDR range.
*
- * coip-address-usage.co-ip
- *
type - The type of route (propagated |
+ * static).
* The maximum number of results to return with a single call.
- * To retrieve the remaining results, make another call with the returned nextToken value.
The token for the next page of results.
+ *The name of the S3 bucket.
*/ - NextToken?: string; + S3Bucket: string | undefined; /** *Checks whether you have the required permissions for the action, without actually making the request, @@ -10104,612 +10337,550 @@ export interface GetCoipPoolUsageRequest { DryRun?: boolean; } -export namespace GetCoipPoolUsageRequest { +export namespace ExportTransitGatewayRoutesRequest { /** * @internal */ - export const filterSensitiveLog = (obj: GetCoipPoolUsageRequest): any => ({ + export const filterSensitiveLog = (obj: ExportTransitGatewayRoutesRequest): any => ({ ...obj, }); } -/** - *
Describes address usage for a customer-owned address pool.
- */ -export interface CoipAddressUsage { - /** - *The allocation ID of the address.
- */ - AllocationId?: string; - - /** - *The Amazon Web Services account ID.
- */ - AwsAccountId?: string; - - /** - *The Amazon Web Services service.
- */ - AwsService?: string; - +export interface ExportTransitGatewayRoutesResult { /** - *The customer-owned IP address.
+ *The URL of the exported file in Amazon S3. For example, + * s3://bucket_name/VPCTransitGateway/TransitGatewayRouteTables/file_name.
*/ - CoIp?: string; + S3Location?: string; } -export namespace CoipAddressUsage { +export namespace ExportTransitGatewayRoutesResult { /** * @internal */ - export const filterSensitiveLog = (obj: CoipAddressUsage): any => ({ + export const filterSensitiveLog = (obj: ExportTransitGatewayRoutesResult): any => ({ ...obj, }); } -export interface GetCoipPoolUsageResult { - /** - *The ID of the customer-owned address pool.
- */ - CoipPoolId?: string; - +export interface GetAssociatedEnclaveCertificateIamRolesRequest { /** - *Information about the address usage.
+ *The ARN of the ACM certificate for which to view the associated IAM roles, encryption keys, and Amazon + * S3 object information.
*/ - CoipAddressUsages?: CoipAddressUsage[]; + CertificateArn?: string; /** - *The ID of the local gateway route table.
+ *Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
The ID of the instance.
- */ - InstanceId: string | undefined; - - /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
When enabled, retrieves the latest console output for the instance.
- *Default: disabled (false)
Information about the associated IAM roles.
+ */ +export interface AssociatedRole { /** - * @internal + *The ARN of the associated IAM role.
*/ - export const filterSensitiveLog = (obj: GetConsoleOutputRequest): any => ({ - ...obj, - }); -} + AssociatedRoleArn?: string; -export interface GetConsoleOutputResult { /** - *The ID of the instance.
+ *The name of the Amazon S3 bucket in which the Amazon S3 object is stored.
*/ - InstanceId?: string; + CertificateS3BucketName?: string; /** - *The console output, base64-encoded. If you are using a command line tool, the tool - * decodes the output for you.
+ *The key of the Amazon S3 object ey where the certificate, certificate chain, and encrypted private key bundle
+ * is stored. The object key is formated as follows: role_arn/certificate_arn.
+ *
The time at which the output was last updated.
+ *The ID of the KMS customer master key (CMK) used to encrypt the private key.
*/ - Timestamp?: Date; + EncryptionKmsKeyId?: string; } -export namespace GetConsoleOutputResult { +export namespace AssociatedRole { /** * @internal */ - export const filterSensitiveLog = (obj: GetConsoleOutputResult): any => ({ + export const filterSensitiveLog = (obj: AssociatedRole): any => ({ ...obj, }); } -export interface GetConsoleScreenshotRequest { - /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The ID of the instance.
- */ - InstanceId: string | undefined; - - /** - *When set to true, acts as keystroke input and wakes up an instance that's
- * in standby or "sleep" mode.
Information about the associated IAM roles.
*/ - WakeUp?: boolean; + AssociatedRoles?: AssociatedRole[]; } -export namespace GetConsoleScreenshotRequest { +export namespace GetAssociatedEnclaveCertificateIamRolesResult { /** * @internal */ - export const filterSensitiveLog = (obj: GetConsoleScreenshotRequest): any => ({ + export const filterSensitiveLog = (obj: GetAssociatedEnclaveCertificateIamRolesResult): any => ({ ...obj, }); } -export interface GetConsoleScreenshotResult { +export interface GetAssociatedIpv6PoolCidrsRequest { /** - *The data that comprises the image.
+ *The ID of the IPv6 address pool.
*/ - ImageData?: string; + PoolId: string | undefined; /** - *The ID of the instance.
+ *The token for the next page of results.
*/ - InstanceId?: string; -} + NextToken?: string; -export namespace GetConsoleScreenshotResult { /** - * @internal + *The maximum number of results to return with a single call.
+ * To retrieve the remaining results, make another call with the returned nextToken value.
Checks whether you have the required permissions for the action, without actually making the request,
* and provides an error response. If you have the required permissions, the error response is DryRunOperation.
* Otherwise, it is UnauthorizedOperation.
The instance family.
- */ - InstanceFamily: UnlimitedSupportedInstanceFamily | string | undefined; } -export namespace GetDefaultCreditSpecificationRequest { +export namespace GetAssociatedIpv6PoolCidrsRequest { /** * @internal */ - export const filterSensitiveLog = (obj: GetDefaultCreditSpecificationRequest): any => ({ + export const filterSensitiveLog = (obj: GetAssociatedIpv6PoolCidrsRequest): any => ({ ...obj, }); } /** - *Describes the default credit option for CPU usage of a burstable performance instance family.
+ *Describes an IPv6 CIDR block association.
*/ -export interface InstanceFamilyCreditSpecification { +export interface Ipv6CidrAssociation { /** - *The instance family.
+ *The IPv6 CIDR block.
*/ - InstanceFamily?: UnlimitedSupportedInstanceFamily | string; + Ipv6Cidr?: string; /** - *The default credit option for CPU usage of the instance family. Valid values are standard and unlimited.
The resource that's associated with the IPv6 CIDR block.
*/ - CpuCredits?: string; + AssociatedResource?: string; } -export namespace InstanceFamilyCreditSpecification { +export namespace Ipv6CidrAssociation { /** * @internal */ - export const filterSensitiveLog = (obj: InstanceFamilyCreditSpecification): any => ({ + export const filterSensitiveLog = (obj: Ipv6CidrAssociation): any => ({ ...obj, }); } -export interface GetDefaultCreditSpecificationResult { - /** - *The default credit option for CPU usage of the instance family.
- */ - InstanceFamilyCreditSpecification?: InstanceFamilyCreditSpecification; -} - -export namespace GetDefaultCreditSpecificationResult { +export interface GetAssociatedIpv6PoolCidrsResult { /** - * @internal + *Information about the IPv6 CIDR block associations.
*/ - export const filterSensitiveLog = (obj: GetDefaultCreditSpecificationResult): any => ({ - ...obj, - }); -} + Ipv6CidrAssociations?: Ipv6CidrAssociation[]; -export interface GetEbsDefaultKmsKeyIdRequest { /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The Amazon Resource Name (ARN) of the default KMS key for encryption by default.
+ *The ID of the Capacity Reservation.
*/ - KmsKeyId?: string; -} + CapacityReservationId: string | undefined; -export namespace GetEbsDefaultKmsKeyIdResult { /** - * @internal + *The token to use to retrieve the next page of results.
*/ - export const filterSensitiveLog = (obj: GetEbsDefaultKmsKeyIdResult): any => ({ - ...obj, - }); -} + NextToken?: string; -export interface GetEbsEncryptionByDefaultRequest { /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error.
Valid range: Minimum value of 1. Maximum value of 1000.
+ */ + MaxResults?: number; + + /** + *Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Information about the Capacity Reservation usage.
+ */ +export interface InstanceUsage { /** - *Indicates whether encryption by default is enabled.
+ *The ID of the Amazon Web Services account that is making use of the Capacity Reservation.
*/ - EbsEncryptionByDefault?: boolean; + AccountId?: string; + + /** + *The number of instances the Amazon Web Services account currently has in the Capacity Reservation.
+ */ + UsedInstanceCount?: number; } -export namespace GetEbsEncryptionByDefaultResult { +export namespace InstanceUsage { /** * @internal */ - export const filterSensitiveLog = (obj: GetEbsEncryptionByDefaultResult): any => ({ + export const filterSensitiveLog = (obj: InstanceUsage): any => ({ ...obj, }); } -export enum PartitionLoadFrequency { - DAILY = "daily", - MONTHLY = "monthly", - NONE = "none", - WEEKLY = "weekly", -} +export interface GetCapacityReservationUsageResult { + /** + *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Describes integration options for Amazon Athena.
- */ -export interface AthenaIntegration { /** - *The location in Amazon S3 to store the generated CloudFormation template.
+ *The ID of the Capacity Reservation.
*/ - IntegrationResultS3DestinationArn: string | undefined; + CapacityReservationId?: string; /** - *The schedule for adding new partitions to the table.
+ *The type of instance for which the Capacity Reservation reserves capacity.
*/ - PartitionLoadFrequency: PartitionLoadFrequency | string | undefined; + InstanceType?: string; /** - *The start date for the partition.
+ *The number of instances for which the Capacity Reservation reserves capacity.
*/ - PartitionStartDate?: Date; + TotalInstanceCount?: number; /** - *The end date for the partition.
+ *The remaining capacity. Indicates the number of instances that can be launched in the Capacity Reservation.
*/ - PartitionEndDate?: Date; -} + AvailableInstanceCount?: number; -export namespace AthenaIntegration { /** - * @internal + *The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:
+ *
+ * active - The Capacity Reservation is active and the capacity is available for your use.
+ * expired - The Capacity Reservation expired automatically at the date and time specified
+ * in your request. The reserved capacity is no longer available for your use.
+ * cancelled - The Capacity Reservation was cancelled. The reserved capacity is no
+ * longer available for your use.
+ * pending - The Capacity Reservation request was successful but the capacity
+ * provisioning is still pending.
+ * failed - The Capacity Reservation request has failed. A request might fail
+ * due to invalid request parameters, capacity constraints, or instance limit constraints.
+ * Failed requests are retained for 60 minutes.
Describes service integrations with VPC Flow logs.
- */ -export interface IntegrateServices { /** - *Information about the integration with Amazon Athena.
+ *Information about the Capacity Reservation usage.
*/ - AthenaIntegrations?: AthenaIntegration[]; + InstanceUsages?: InstanceUsage[]; } -export namespace IntegrateServices { +export namespace GetCapacityReservationUsageResult { /** * @internal */ - export const filterSensitiveLog = (obj: IntegrateServices): any => ({ + export const filterSensitiveLog = (obj: GetCapacityReservationUsageResult): any => ({ ...obj, }); } -export interface GetFlowLogsIntegrationTemplateRequest { - /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The ID of the flow log.
+ *The ID of the address pool.
*/ - FlowLogId: string | undefined; + PoolId: string | undefined; /** - *To store the CloudFormation template in Amazon S3, specify the location in Amazon S3.
+ *The filters. The following are the possible values:
+ *
+ * coip-address-usage.allocation-id
+ *
+ * coip-address-usage.aws-account-id
+ *
+ * coip-address-usage.aws-service
+ *
+ * coip-address-usage.co-ip
+ *
Information about the service integration.
+ *The maximum number of results to return with a single call.
+ * To retrieve the remaining results, make another call with the returned nextToken value.
The token for the next page of results.
*/ - export const filterSensitiveLog = (obj: GetFlowLogsIntegrationTemplateRequest): any => ({ - ...obj, - }); -} + NextToken?: string; -export interface GetFlowLogsIntegrationTemplateResult { /** - *The generated CloudFormation template.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Describes address usage for a customer-owned address pool.
+ */ +export interface CoipAddressUsage { /** - *The ID of the Capacity Reservation.
+ *The allocation ID of the address.
*/ - CapacityReservationId: string | undefined; + AllocationId?: string; /** - *The token to use to retrieve the next page of results.
+ *The Amazon Web Services account ID.
*/ - NextToken?: string; + AwsAccountId?: string; /** - *The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error.
The Amazon Web Services service.
*/ - MaxResults?: number; + AwsService?: string; /** - *Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
The customer-owned IP address.
*/ - DryRun?: boolean; + CoIp?: string; } -export namespace GetGroupsForCapacityReservationRequest { +export namespace CoipAddressUsage { /** * @internal */ - export const filterSensitiveLog = (obj: GetGroupsForCapacityReservationRequest): any => ({ + export const filterSensitiveLog = (obj: CoipAddressUsage): any => ({ ...obj, }); } -/** - *Describes a resource group to which a Capacity Reservation has been added.
- */ -export interface CapacityReservationGroup { - /** - *The ARN of the resource group.
- */ - GroupArn?: string; - - /** - *The ID of the Amazon Web Services account that owns the resource group.
- */ - OwnerId?: string; -} - -export namespace CapacityReservationGroup { +export interface GetCoipPoolUsageResult { /** - * @internal + *The ID of the customer-owned address pool.
*/ - export const filterSensitiveLog = (obj: CapacityReservationGroup): any => ({ - ...obj, - }); -} + CoipPoolId?: string; -export interface GetGroupsForCapacityReservationResult { /** - *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Information about the address usage.
*/ - NextToken?: string; + CoipAddressUsages?: CoipAddressUsage[]; /** - *Information about the resource groups to which the Capacity Reservation has been added.
+ *The ID of the local gateway route table.
*/ - CapacityReservationGroups?: CapacityReservationGroup[]; + LocalGatewayRouteTableId?: string; } -export namespace GetGroupsForCapacityReservationResult { +export namespace GetCoipPoolUsageResult { /** * @internal */ - export const filterSensitiveLog = (obj: GetGroupsForCapacityReservationResult): any => ({ + export const filterSensitiveLog = (obj: GetCoipPoolUsageResult): any => ({ ...obj, }); } -export interface GetHostReservationPurchasePreviewRequest { +export interface GetConsoleOutputRequest { /** - *The IDs of the Dedicated Hosts with which the reservation is associated.
+ *The ID of the instance.
*/ - HostIdSet: string[] | undefined; + InstanceId: string | undefined; /** - *The offering ID of the reservation.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
When enabled, retrieves the latest console output for the instance.
+ *Default: disabled (false)
Describes the result of the purchase.
- */ -export interface Purchase { - /** - *The currency in which the UpfrontPrice and HourlyPrice
- * amounts are specified. At this time, the only supported currency is
- * USD.
The duration of the reservation's term in seconds.
+ *The ID of the instance.
*/ - Duration?: number; + InstanceId?: string; /** - *The IDs of the Dedicated Hosts associated with the reservation.
+ *The console output, base64-encoded. If you are using a command line tool, the tool + * decodes the output for you.
*/ - HostIdSet?: string[]; + Output?: string; /** - *The ID of the reservation.
+ *The time at which the output was last updated.
*/ - HostReservationId?: string; + Timestamp?: Date; +} +export namespace GetConsoleOutputResult { /** - *The hourly price of the reservation per hour.
+ * @internal */ - HourlyPrice?: string; + export const filterSensitiveLog = (obj: GetConsoleOutputResult): any => ({ + ...obj, + }); +} +export interface GetConsoleScreenshotRequest { /** - *The instance family on the Dedicated Host that the reservation can be associated - * with.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The payment option for the reservation.
+ *The ID of the instance.
*/ - PaymentOption?: PaymentOption | string; + InstanceId: string | undefined; /** - *The upfront price of the reservation.
+ *When set to true, acts as keystroke input and wakes up an instance that's
+ * in standby or "sleep" mode.
The currency in which the totalUpfrontPrice and
- * totalHourlyPrice amounts are specified. At this time, the only
- * supported currency is USD.
The purchase information of the Dedicated Host reservation and the Dedicated Hosts - * associated with it.
- */ - Purchase?: Purchase[]; - +export interface GetConsoleScreenshotResult { /** - *The potential total hourly price of the reservation per hour.
+ *The data that comprises the image.
*/ - TotalHourlyPrice?: string; + ImageData?: string; /** - *The potential total upfront price. This is billed immediately.
+ *The ID of the instance.
*/ - TotalUpfrontPrice?: string; + InstanceId?: string; } -export namespace GetHostReservationPurchasePreviewResult { +export namespace GetConsoleScreenshotResult { /** * @internal */ - export const filterSensitiveLog = (obj: GetHostReservationPurchasePreviewResult): any => ({ + export const filterSensitiveLog = (obj: GetConsoleScreenshotResult): any => ({ ...obj, }); } -export interface GetInstanceTypesFromInstanceRequirementsRequest { +export type UnlimitedSupportedInstanceFamily = "t2" | "t3" | "t3a" | "t4g"; + +export interface GetDefaultCreditSpecificationRequest { /** *Checks whether you have the required permissions for the action, without actually making the request,
* and provides an error response. If you have the required permissions, the error response is DryRunOperation.
@@ -10718,444 +10889,466 @@ export interface GetInstanceTypesFromInstanceRequirementsRequest {
DryRun?: boolean;
/**
- *
The processor architecture type.
- */ - ArchitectureTypes: (ArchitectureType | string)[] | undefined; - - /** - *The virtualization type.
+ *The instance family.
*/ - VirtualizationTypes: (VirtualizationType | string)[] | undefined; + InstanceFamily: UnlimitedSupportedInstanceFamily | string | undefined; +} +export namespace GetDefaultCreditSpecificationRequest { /** - *The attributes required for the instance types.
+ * @internal */ - InstanceRequirements: InstanceRequirementsRequest | undefined; + export const filterSensitiveLog = (obj: GetDefaultCreditSpecificationRequest): any => ({ + ...obj, + }); +} +/** + *Describes the default credit option for CPU usage of a burstable performance instance family.
+ */ +export interface InstanceFamilyCreditSpecification { /** - *The maximum number of results to return in a single call. Specify a value between 1 and
- * 1000. The default value is 1000. To retrieve the remaining results, make another call with
- * the returned NextToken value.
The instance family.
*/ - MaxResults?: number; + InstanceFamily?: UnlimitedSupportedInstanceFamily | string; /** - *The token for the next set of results.
+ *The default credit option for CPU usage of the instance family. Valid values are standard and unlimited.
The list of instance types with the specified instance attributes.
- */ -export interface InstanceTypeInfoFromInstanceRequirements { +export interface GetDefaultCreditSpecificationResult { /** - *The matching instance type.
+ *The default credit option for CPU usage of the instance family.
*/ - InstanceType?: string; + InstanceFamilyCreditSpecification?: InstanceFamilyCreditSpecification; } -export namespace InstanceTypeInfoFromInstanceRequirements { +export namespace GetDefaultCreditSpecificationResult { /** * @internal */ - export const filterSensitiveLog = (obj: InstanceTypeInfoFromInstanceRequirements): any => ({ + export const filterSensitiveLog = (obj: GetDefaultCreditSpecificationResult): any => ({ ...obj, }); } -export interface GetInstanceTypesFromInstanceRequirementsResult { +export interface GetEbsDefaultKmsKeyIdRequest { + /** + *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The instance types with the specified instance attributes.
+ * @internal */ - InstanceTypes?: InstanceTypeInfoFromInstanceRequirements[]; + export const filterSensitiveLog = (obj: GetEbsDefaultKmsKeyIdRequest): any => ({ + ...obj, + }); +} +export interface GetEbsDefaultKmsKeyIdResult { /** - *The token for the next set of results.
+ *The Amazon Resource Name (ARN) of the default KMS key for encryption by default.
*/ - NextToken?: string; + KmsKeyId?: string; } -export namespace GetInstanceTypesFromInstanceRequirementsResult { +export namespace GetEbsDefaultKmsKeyIdResult { /** * @internal */ - export const filterSensitiveLog = (obj: GetInstanceTypesFromInstanceRequirementsResult): any => ({ + export const filterSensitiveLog = (obj: GetEbsDefaultKmsKeyIdResult): any => ({ ...obj, }); } -export interface GetIpamAddressHistoryRequest { +export interface GetEbsEncryptionByDefaultRequest { /** - *A check for whether you have the required permissions for the action without actually making the request + *
Checks whether you have the required permissions for the action, without actually making the request,
* and provides an error response. If you have the required permissions, the error response is DryRunOperation.
* Otherwise, it is UnauthorizedOperation.
The CIDR you want the history of. The CIDR can be an IPv4 or IPv6 IP address range. - * If you enter a /16 IPv4 CIDR, you will get records that match it exactly. You will not get records for any subnets within the /16 CIDR.
+ * @internal */ - Cidr: string | undefined; + export const filterSensitiveLog = (obj: GetEbsEncryptionByDefaultRequest): any => ({ + ...obj, + }); +} +export interface GetEbsEncryptionByDefaultResult { /** - *The ID of the IPAM scope that the CIDR is in.
+ *Indicates whether encryption by default is enabled.
*/ - IpamScopeId: string | undefined; + EbsEncryptionByDefault?: boolean; +} +export namespace GetEbsEncryptionByDefaultResult { /** - *The ID of the VPC you want your history records filtered by.
+ * @internal */ - VpcId?: string; + export const filterSensitiveLog = (obj: GetEbsEncryptionByDefaultResult): any => ({ + ...obj, + }); +} + +export enum PartitionLoadFrequency { + DAILY = "daily", + MONTHLY = "monthly", + NONE = "none", + WEEKLY = "weekly", +} +/** + *Describes integration options for Amazon Athena.
+ */ +export interface AthenaIntegration { /** - *The start of the time period for which you are looking for history. If you omit this option, it will default to the value of EndTime.
+ *The location in Amazon S3 to store the generated CloudFormation template.
*/ - StartTime?: Date; + IntegrationResultS3DestinationArn: string | undefined; /** - *The end of the time period for which you are looking for history. If you omit this option, it will default to the current time.
+ *The schedule for adding new partitions to the table.
*/ - EndTime?: Date; + PartitionLoadFrequency: PartitionLoadFrequency | string | undefined; /** - *The maximum number of historical results you would like returned per page. Defaults to 100.
+ *The start date for the partition.
*/ - MaxResults?: number; + PartitionStartDate?: Date; /** - *The token for the next page of results.
+ *The end date for the partition.
*/ - NextToken?: string; + PartitionEndDate?: Date; } -export namespace GetIpamAddressHistoryRequest { +export namespace AthenaIntegration { /** * @internal */ - export const filterSensitiveLog = (obj: GetIpamAddressHistoryRequest): any => ({ + export const filterSensitiveLog = (obj: AthenaIntegration): any => ({ ...obj, }); } -export enum IpamComplianceStatus { - compliant = "compliant", - ignored = "ignored", - noncompliant = "noncompliant", - unmanaged = "unmanaged", -} - -export enum IpamOverlapStatus { - ignored = "ignored", - nonoverlapping = "nonoverlapping", - overlapping = "overlapping", +/** + *Describes service integrations with VPC Flow logs.
+ */ +export interface IntegrateServices { + /** + *Information about the integration with Amazon Athena.
+ */ + AthenaIntegrations?: AthenaIntegration[]; } -export enum IpamAddressHistoryResourceType { - eip = "eip", - instance = "instance", - network_interface = "network-interface", - subnet = "subnet", - vpc = "vpc", +export namespace IntegrateServices { + /** + * @internal + */ + export const filterSensitiveLog = (obj: IntegrateServices): any => ({ + ...obj, + }); } -/** - *The historical record of a CIDR within an IPAM scope. For more information, see View the history of IP addresses in the Amazon VPC IPAM User Guide. - *
- */ -export interface IpamAddressHistoryRecord { +export interface GetFlowLogsIntegrationTemplateRequest { /** - *The ID of the resource owner.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The Amazon Web Services Region of the resource.
+ *The ID of the flow log.
*/ - ResourceRegion?: string; + FlowLogId: string | undefined; /** - *The type of the resource.
+ *To store the CloudFormation template in Amazon S3, specify the location in Amazon S3.
*/ - ResourceType?: IpamAddressHistoryResourceType | string; + ConfigDeliveryS3DestinationArn: string | undefined; /** - *The ID of the resource.
+ *Information about the service integration.
*/ - ResourceId?: string; + IntegrateServices: IntegrateServices | undefined; +} +export namespace GetFlowLogsIntegrationTemplateRequest { /** - *The CIDR of the resource.
+ * @internal */ - ResourceCidr?: string; + export const filterSensitiveLog = (obj: GetFlowLogsIntegrationTemplateRequest): any => ({ + ...obj, + }); +} +export interface GetFlowLogsIntegrationTemplateResult { /** - *The name of the resource.
+ *The generated CloudFormation template.
*/ - ResourceName?: string; + Result?: string; +} +export namespace GetFlowLogsIntegrationTemplateResult { /** - *The compliance status of a resource. For more information on compliance statuses, see Monitor CIDR usage by resource in the Amazon VPC IPAM User Guide.
+ * @internal */ - ResourceComplianceStatus?: IpamComplianceStatus | string; + export const filterSensitiveLog = (obj: GetFlowLogsIntegrationTemplateResult): any => ({ + ...obj, + }); +} +export interface GetGroupsForCapacityReservationRequest { /** - *The overlap status of an IPAM resource. The overlap status tells you if the CIDR for a resource overlaps with another CIDR in the scope. For more information on overlap statuses, see Monitor CIDR usage by resource in the Amazon VPC IPAM User Guide.
+ *The ID of the Capacity Reservation.
*/ - ResourceOverlapStatus?: IpamOverlapStatus | string; + CapacityReservationId: string | undefined; /** - *The VPC ID of the resource.
+ *The token to use to retrieve the next page of results.
*/ - VpcId?: string; + NextToken?: string; /** - *Sampled start time of the resource-to-CIDR association within the IPAM scope. Changes are picked up in periodic snapshots, so the start time may have occurred before this specific time.
+ *The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error.
Sampled end time of the resource-to-CIDR association within the IPAM scope. Changes are picked up in periodic snapshots, so the end time may have occurred before this specific time.
+ *Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Describes a resource group to which a Capacity Reservation has been added.
+ */ +export interface CapacityReservationGroup { /** - *A historical record for a CIDR within an IPAM scope. If the CIDR is associated with an EC2 instance, you will see an object in the response for the instance and one for the network interface.
+ *The ARN of the resource group.
*/ - HistoryRecords?: IpamAddressHistoryRecord[]; + GroupArn?: string; /** - *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The ID of the Amazon Web Services account that owns the resource group.
*/ - NextToken?: string; + OwnerId?: string; } -export namespace GetIpamAddressHistoryResult { +export namespace CapacityReservationGroup { /** * @internal */ - export const filterSensitiveLog = (obj: GetIpamAddressHistoryResult): any => ({ + export const filterSensitiveLog = (obj: CapacityReservationGroup): any => ({ ...obj, }); } -export interface GetIpamPoolAllocationsRequest { - /** - *A check for whether you have the required permissions for the action without actually making the request
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The ID of the IPAM pool you want to see the allocations for.
- */ - IpamPoolId: string | undefined; - - /** - *The ID of the allocation.
- */ - IpamPoolAllocationId?: string; - - /** - *One or more filters for the request. For more information about filtering, see Filtering CLI output.
- */ - Filters?: Filter[]; - +export interface GetGroupsForCapacityReservationResult { /** - *The maximum number of results you would like returned per page.
+ *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The token for the next page of results.
+ *Information about the resource groups to which the Capacity Reservation has been added.
*/ - NextToken?: string; + CapacityReservationGroups?: CapacityReservationGroup[]; } -export namespace GetIpamPoolAllocationsRequest { +export namespace GetGroupsForCapacityReservationResult { /** * @internal */ - export const filterSensitiveLog = (obj: GetIpamPoolAllocationsRequest): any => ({ + export const filterSensitiveLog = (obj: GetGroupsForCapacityReservationResult): any => ({ ...obj, }); } -export interface GetIpamPoolAllocationsResult { +export interface GetHostReservationPurchasePreviewRequest { /** - *The IPAM pool allocations you want information on.
+ *The IDs of the Dedicated Hosts with which the reservation is associated.
*/ - IpamPoolAllocations?: IpamPoolAllocation[]; + HostIdSet: string[] | undefined; /** - *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The offering ID of the reservation.
*/ - NextToken?: string; + OfferingId: string | undefined; } -export namespace GetIpamPoolAllocationsResult { +export namespace GetHostReservationPurchasePreviewRequest { /** * @internal */ - export const filterSensitiveLog = (obj: GetIpamPoolAllocationsResult): any => ({ + export const filterSensitiveLog = (obj: GetHostReservationPurchasePreviewRequest): any => ({ ...obj, }); } -export interface GetIpamPoolCidrsRequest { +/** + *Describes the result of the purchase.
+ */ +export interface Purchase { /** - *A check for whether you have the required permissions for the action without actually making the request
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The currency in which the UpfrontPrice and HourlyPrice
+ * amounts are specified. At this time, the only supported currency is
+ * USD.
The ID of the IPAM pool you want the CIDR for.
+ *The duration of the reservation's term in seconds.
*/ - IpamPoolId: string | undefined; + Duration?: number; /** - *One or more filters for the request. For more information about filtering, see Filtering CLI output.
+ *The IDs of the Dedicated Hosts associated with the reservation.
*/ - Filters?: Filter[]; + HostIdSet?: string[]; /** - *The maximum number of results to return in the request.
+ *The ID of the reservation.
*/ - MaxResults?: number; + HostReservationId?: string; /** - *The token for the next page of results.
+ *The hourly price of the reservation per hour.
*/ - NextToken?: string; -} + HourlyPrice?: string; -export namespace GetIpamPoolCidrsRequest { /** - * @internal + *The instance family on the Dedicated Host that the reservation can be associated + * with.
*/ - export const filterSensitiveLog = (obj: GetIpamPoolCidrsRequest): any => ({ - ...obj, - }); -} + InstanceFamily?: string; -export interface GetIpamPoolCidrsResult { /** - *Information about the CIDRs provisioned to an IPAM pool.
+ *The payment option for the reservation.
*/ - IpamPoolCidrs?: IpamPoolCidr[]; + PaymentOption?: PaymentOption | string; /** - *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The upfront price of the reservation.
*/ - NextToken?: string; + UpfrontPrice?: string; } -export namespace GetIpamPoolCidrsResult { +export namespace Purchase { /** * @internal */ - export const filterSensitiveLog = (obj: GetIpamPoolCidrsResult): any => ({ + export const filterSensitiveLog = (obj: Purchase): any => ({ ...obj, }); } -export enum IpamResourceType { - eip = "eip", - ipv6_pool = "ipv6-pool", - public_ipv4_pool = "public-ipv4-pool", - subnet = "subnet", - vpc = "vpc", -} +export interface GetHostReservationPurchasePreviewResult { + /** + *The currency in which the totalUpfrontPrice and
+ * totalHourlyPrice amounts are specified. At this time, the only
+ * supported currency is USD.
A check for whether you have the required permissions for the action without actually making the request
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The purchase information of the Dedicated Host reservation and the Dedicated Hosts + * associated with it.
*/ - DryRun?: boolean; + Purchase?: Purchase[]; /** - *One or more filters for the request. For more information about filtering, see Filtering CLI output.
+ *The potential total hourly price of the reservation per hour.
*/ - Filters?: Filter[]; + TotalHourlyPrice?: string; /** - *The maximum number of results to return in the request.
+ *The potential total upfront price. This is billed immediately.
*/ - MaxResults?: number; + TotalUpfrontPrice?: string; +} +export namespace GetHostReservationPurchasePreviewResult { /** - *The token for the next page of results.
+ * @internal */ - NextToken?: string; + export const filterSensitiveLog = (obj: GetHostReservationPurchasePreviewResult): any => ({ + ...obj, + }); +} +export interface GetInstanceTypesFromInstanceRequirementsRequest { /** - *The ID of the scope that the resource is in.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The ID of the IPAM pool that the resource is in.
+ *The processor architecture type.
*/ - IpamPoolId?: string; + ArchitectureTypes: (ArchitectureType | string)[] | undefined; /** - *The ID of the resource.
+ *The virtualization type.
*/ - ResourceId?: string; + VirtualizationTypes: (VirtualizationType | string)[] | undefined; /** - *The resource type.
+ *The attributes required for the instance types.
*/ - ResourceType?: IpamResourceType | string; + InstanceRequirements: InstanceRequirementsRequest | undefined; /** - *A tag on an IPAM resource.
+ *The maximum number of results to return in a single call. Specify a value between 1 and
+ * 1000. The default value is 1000. To retrieve the remaining results, make another call with
+ * the returned NextToken value.
The ID of the Amazon Web Services account that owns the resource.
+ *The token for the next set of results.
*/ - ResourceOwner?: string; + NextToken?: string; } -export namespace GetIpamResourceCidrsRequest { +export namespace GetInstanceTypesFromInstanceRequirementsRequest { /** * @internal */ - export const filterSensitiveLog = (obj: GetIpamResourceCidrsRequest): any => ({ + export const filterSensitiveLog = (obj: GetInstanceTypesFromInstanceRequirementsRequest): any => ({ ...obj, }); } - -export enum IpamManagementState { - ignored = "ignored", - managed = "managed", - unmanaged = "unmanaged", -} diff --git a/clients/client-ec2/src/models/models_5.ts b/clients/client-ec2/src/models/models_5.ts index 97255e814c33e..6c8c3d1bd7981 100644 --- a/clients/client-ec2/src/models/models_5.ts +++ b/clients/client-ec2/src/models/models_5.ts @@ -13,7 +13,7 @@ import { AutoPlacement, ByoipCidr, ClientConnectOptions, - ClientVpnAuthorizationRuleStatus, + ClientLoginBannerOptions, ConnectionLogOptions, CurrencyCodeValues, DnsSupportValue, @@ -24,7 +24,7 @@ import { IamInstanceProfileAssociation, IamInstanceProfileSpecification, InstanceEventWindow, - IpPermission, + IpamPoolAllocation, Ipv6SupportValue, PortRange, RouteTableAssociationState, @@ -66,7 +66,6 @@ import { ResponseLaunchTemplateData, RuleAction, ShutdownBehavior, - SnapshotState, SpotInstanceType, SubnetCidrReservation, TargetCapacitySpecificationRequest, @@ -119,7 +118,6 @@ import { Monitoring, PermissionGroup, PublicIpv4PoolRange, - ReservedInstancesConfiguration, SnapshotDetail, SnapshotTaskDetail, VirtualizationType, @@ -129,12 +127,9 @@ import { ExcessCapacityTerminationPolicy, InstanceFamilyCreditSpecification, InstanceNetworkInterfaceSpecification, - IpamComplianceStatus, - IpamManagementState, - IpamOverlapStatus, - IpamResourceType, LaunchTemplateConfig, Purchase, + ReservedInstancesConfiguration, RunInstancesMonitoringEnabled, ScheduledInstance, SnapshotAttributeName, @@ -147,218 +142,259 @@ import { } from "./models_4"; /** - *The CIDR for an IPAM resource.
+ *The list of instance types with the specified instance attributes.
*/ -export interface IpamResourceCidr { +export interface InstanceTypeInfoFromInstanceRequirements { /** - *The IPAM ID for an IPAM resource.
+ *The matching instance type.
*/ - IpamId?: string; + InstanceType?: string; +} +export namespace InstanceTypeInfoFromInstanceRequirements { /** - *The scope ID for an IPAM resource.
+ * @internal */ - IpamScopeId?: string; + export const filterSensitiveLog = (obj: InstanceTypeInfoFromInstanceRequirements): any => ({ + ...obj, + }); +} +export interface GetInstanceTypesFromInstanceRequirementsResult { /** - *The pool ID for an IPAM resource.
+ *The instance types with the specified instance attributes.
*/ - IpamPoolId?: string; + InstanceTypes?: InstanceTypeInfoFromInstanceRequirements[]; /** - *The Amazon Web Services Region for an IPAM resource.
+ *The token for the next set of results.
*/ - ResourceRegion?: string; + NextToken?: string; +} +export namespace GetInstanceTypesFromInstanceRequirementsResult { /** - *The Amazon Web Services account number of the owner of an IPAM resource.
+ * @internal */ - ResourceOwnerId?: string; + export const filterSensitiveLog = (obj: GetInstanceTypesFromInstanceRequirementsResult): any => ({ + ...obj, + }); +} +export interface GetIpamAddressHistoryRequest { /** - *The ID of an IPAM resource.
+ *A check for whether you have the required permissions for the action without actually making the request
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The name of an IPAM resource.
+ *The CIDR you want the history of. The CIDR can be an IPv4 or IPv6 IP address range. + * If you enter a /16 IPv4 CIDR, you will get records that match it exactly. You will not get records for any subnets within the /16 CIDR.
*/ - ResourceName?: string; + Cidr: string | undefined; /** - *The CIDR for an IPAM resource.
+ *The ID of the IPAM scope that the CIDR is in.
*/ - ResourceCidr?: string; + IpamScopeId: string | undefined; /** - *The type of IPAM resource.
+ *The ID of the VPC you want your history records filtered by.
*/ - ResourceType?: IpamResourceType | string; + VpcId?: string; /** - *The tags for an IPAM resource.
+ *The start of the time period for which you are looking for history. If you omit this option, it will default to the value of EndTime.
*/ - ResourceTags?: IpamResourceTag[]; + StartTime?: Date; /** - *The IP address space in the IPAM pool that is allocated to this resource. To convert the decimal to a percentage, multiply the decimal by 100.
+ *The end of the time period for which you are looking for history. If you omit this option, it will default to the current time.
*/ - IpUsage?: number; + EndTime?: Date; /** - *The compliance status of the IPAM resource. For more information on compliance statuses, see Monitor CIDR usage by resource in the Amazon VPC IPAM User Guide.
+ *The maximum number of historical results you would like returned per page. Defaults to 100.
*/ - ComplianceStatus?: IpamComplianceStatus | string; + MaxResults?: number; /** - *The management state of the resource. For more information about management states, see Monitor CIDR usage by resource in the Amazon VPC IPAM User Guide.
+ *The token for the next page of results.
*/ - ManagementState?: IpamManagementState | string; + NextToken?: string; +} +export namespace GetIpamAddressHistoryRequest { /** - *The overlap status of an IPAM resource. The overlap status tells you if the CIDR for a resource overlaps with another CIDR in the scope. For more information on overlap statuses, see Monitor CIDR usage by resource in the Amazon VPC IPAM User Guide.
+ * @internal */ - OverlapStatus?: IpamOverlapStatus | string; + export const filterSensitiveLog = (obj: GetIpamAddressHistoryRequest): any => ({ + ...obj, + }); +} + +export enum IpamComplianceStatus { + compliant = "compliant", + ignored = "ignored", + noncompliant = "noncompliant", + unmanaged = "unmanaged", +} +export enum IpamOverlapStatus { + ignored = "ignored", + nonoverlapping = "nonoverlapping", + overlapping = "overlapping", +} + +export enum IpamAddressHistoryResourceType { + eip = "eip", + instance = "instance", + network_interface = "network-interface", + subnet = "subnet", + vpc = "vpc", +} + +/** + *The historical record of a CIDR within an IPAM scope. For more information, see View the history of IP addresses in the Amazon VPC IPAM User Guide. + *
+ */ +export interface IpamAddressHistoryRecord { /** - *The ID of a VPC.
+ *The ID of the resource owner.
*/ - VpcId?: string; -} + ResourceOwnerId?: string; -export namespace IpamResourceCidr { /** - * @internal + *The Amazon Web Services Region of the resource.
*/ - export const filterSensitiveLog = (obj: IpamResourceCidr): any => ({ - ...obj, - }); -} + ResourceRegion?: string; -export interface GetIpamResourceCidrsResult { /** - *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The type of the resource.
*/ - NextToken?: string; + ResourceType?: IpamAddressHistoryResourceType | string; /** - *The resource CIDRs.
+ *The ID of the resource.
*/ - IpamResourceCidrs?: IpamResourceCidr[]; -} + ResourceId?: string; -export namespace GetIpamResourceCidrsResult { /** - * @internal + *The CIDR of the resource.
*/ - export const filterSensitiveLog = (obj: GetIpamResourceCidrsResult): any => ({ - ...obj, - }); -} + ResourceCidr?: string; -export interface GetLaunchTemplateDataRequest { /** - *Checks whether you have the required permissions for the action, without actually
- * making the request, and provides an error response. If you have the required
- * permissions, the error response is DryRunOperation. Otherwise, it is
- * UnauthorizedOperation.
The name of the resource.
*/ - DryRun?: boolean; + ResourceName?: string; /** - *The ID of the instance.
+ *The compliance status of a resource. For more information on compliance statuses, see Monitor CIDR usage by resource in the Amazon VPC IPAM User Guide.
*/ - InstanceId: string | undefined; + ResourceComplianceStatus?: IpamComplianceStatus | string; + + /** + *The overlap status of an IPAM resource. The overlap status tells you if the CIDR for a resource overlaps with another CIDR in the scope. For more information on overlap statuses, see Monitor CIDR usage by resource in the Amazon VPC IPAM User Guide.
+ */ + ResourceOverlapStatus?: IpamOverlapStatus | string; + + /** + *The VPC ID of the resource.
+ */ + VpcId?: string; + + /** + *Sampled start time of the resource-to-CIDR association within the IPAM scope. Changes are picked up in periodic snapshots, so the start time may have occurred before this specific time.
+ */ + SampledStartTime?: Date; + + /** + *Sampled end time of the resource-to-CIDR association within the IPAM scope. Changes are picked up in periodic snapshots, so the end time may have occurred before this specific time.
+ */ + SampledEndTime?: Date; } -export namespace GetLaunchTemplateDataRequest { +export namespace IpamAddressHistoryRecord { /** * @internal */ - export const filterSensitiveLog = (obj: GetLaunchTemplateDataRequest): any => ({ + export const filterSensitiveLog = (obj: IpamAddressHistoryRecord): any => ({ ...obj, }); } -export interface GetLaunchTemplateDataResult { +export interface GetIpamAddressHistoryResult { /** - *The instance data.
+ *A historical record for a CIDR within an IPAM scope. If the CIDR is associated with an EC2 instance, you will see an object in the response for the instance and one for the network interface.
*/ - LaunchTemplateData?: ResponseLaunchTemplateData; + HistoryRecords?: IpamAddressHistoryRecord[]; + + /** + *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Checks whether you have the required permissions for the action, without actually making the request, + *
A check for whether you have the required permissions for the action without actually making the request
* and provides an error response. If you have the required permissions, the error response is DryRunOperation.
* Otherwise, it is UnauthorizedOperation.
The ID of the prefix list.
- */ - PrefixListId: string | undefined; - - /** - *The maximum number of results to return with a single call.
- * To retrieve the remaining results, make another call with the returned nextToken value.
The ID of the IPAM pool you want to see the allocations for.
*/ - MaxResults?: number; + IpamPoolId: string | undefined; /** - *The token for the next page of results.
+ *The ID of the allocation.
*/ - NextToken?: string; -} + IpamPoolAllocationId?: string; -export namespace GetManagedPrefixListAssociationsRequest { /** - * @internal + *One or more filters for the request. For more information about filtering, see Filtering CLI output.
*/ - export const filterSensitiveLog = (obj: GetManagedPrefixListAssociationsRequest): any => ({ - ...obj, - }); -} + Filters?: Filter[]; -/** - *Describes the resource with which a prefix list is associated.
- */ -export interface PrefixListAssociation { /** - *The ID of the resource.
+ *The maximum number of results you would like returned per page.
*/ - ResourceId?: string; + MaxResults?: number; /** - *The owner of the resource.
+ *The token for the next page of results.
*/ - ResourceOwner?: string; + NextToken?: string; } -export namespace PrefixListAssociation { +export namespace GetIpamPoolAllocationsRequest { /** * @internal */ - export const filterSensitiveLog = (obj: PrefixListAssociation): any => ({ + export const filterSensitiveLog = (obj: GetIpamPoolAllocationsRequest): any => ({ ...obj, }); } -export interface GetManagedPrefixListAssociationsResult { +export interface GetIpamPoolAllocationsResult { /** - *Information about the associations.
+ *The IPAM pool allocations you want information on.
*/ - PrefixListAssociations?: PrefixListAssociation[]; + IpamPoolAllocations?: IpamPoolAllocation[]; /** *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Checks whether you have the required permissions for the action, without actually making the request, + *
A check for whether you have the required permissions for the action without actually making the request
* and provides an error response. If you have the required permissions, the error response is DryRunOperation.
* Otherwise, it is UnauthorizedOperation.
The ID of the prefix list.
+ *The ID of the IPAM pool you want the CIDR for.
*/ - PrefixListId: string | undefined; + IpamPoolId: string | undefined; /** - *The version of the prefix list for which to return the entries. The default is the current version.
+ *One or more filters for the request. For more information about filtering, see Filtering CLI output.
*/ - TargetVersion?: number; + Filters?: Filter[]; /** - *The maximum number of results to return with a single call.
- * To retrieve the remaining results, make another call with the returned nextToken value.
The maximum number of results to return in the request.
*/ MaxResults?: number; @@ -405,69 +440,59 @@ export interface GetManagedPrefixListEntriesRequest { NextToken?: string; } -export namespace GetManagedPrefixListEntriesRequest { +export namespace GetIpamPoolCidrsRequest { /** * @internal */ - export const filterSensitiveLog = (obj: GetManagedPrefixListEntriesRequest): any => ({ + export const filterSensitiveLog = (obj: GetIpamPoolCidrsRequest): any => ({ ...obj, }); } -/** - *Describes a prefix list entry.
- */ -export interface PrefixListEntry { +export interface GetIpamPoolCidrsResult { /** - *The CIDR block.
+ *Information about the CIDRs provisioned to an IPAM pool.
*/ - Cidr?: string; + IpamPoolCidrs?: IpamPoolCidr[]; /** - *The description.
+ *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Information about the prefix list entries.
- */ - Entries?: PrefixListEntry[]; - - /** - *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
A check for whether you have the required permissions for the action without actually making the request
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The ID of the Network Access Scope analysis.
+ *One or more filters for the request. For more information about filtering, see Filtering CLI output.
*/ - NetworkInsightsAccessScopeAnalysisId: string | undefined; + Filters?: Filter[]; /** - *The maximum number of results to return with a single call.
- * To retrieve the remaining results, make another call with the returned nextToken value.
The maximum number of results to return in the request.
*/ MaxResults?: number; @@ -477,577 +502,473 @@ export interface GetNetworkInsightsAccessScopeAnalysisFindingsRequest { NextToken?: string; /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The ID of the scope that the resource is in.
*/ - DryRun?: boolean; -} + IpamScopeId: string | undefined; -export namespace GetNetworkInsightsAccessScopeAnalysisFindingsRequest { /** - * @internal + *The ID of the IPAM pool that the resource is in.
*/ - export const filterSensitiveLog = (obj: GetNetworkInsightsAccessScopeAnalysisFindingsRequest): any => ({ - ...obj, - }); -} + IpamPoolId?: string; -export interface GetNetworkInsightsAccessScopeAnalysisFindingsResult { /** - *The ID of the Network Access Scope analysis.
+ *The ID of the resource.
*/ - NetworkInsightsAccessScopeAnalysisId?: string; + ResourceId?: string; /** - *The status of Network Access Scope Analysis.
+ *The resource type.
*/ - AnalysisStatus?: AnalysisStatus | string; + ResourceType?: IpamResourceType | string; /** - *The findings associated with Network Access Scope Analysis.
+ *A tag on an IPAM resource.
*/ - AnalysisFindings?: AccessScopeAnalysisFinding[]; + ResourceTag?: RequestIpamResourceTag; /** - *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The ID of the Amazon Web Services account that owns the resource.
*/ - NextToken?: string; + ResourceOwner?: string; } -export namespace GetNetworkInsightsAccessScopeAnalysisFindingsResult { +export namespace GetIpamResourceCidrsRequest { /** * @internal */ - export const filterSensitiveLog = (obj: GetNetworkInsightsAccessScopeAnalysisFindingsResult): any => ({ + export const filterSensitiveLog = (obj: GetIpamResourceCidrsRequest): any => ({ ...obj, }); } -export interface GetNetworkInsightsAccessScopeContentRequest { - /** - *The ID of the Network Access Scope.
- */ - NetworkInsightsAccessScopeId: string | undefined; +export enum IpamManagementState { + ignored = "ignored", + managed = "managed", + unmanaged = "unmanaged", +} +/** + *The CIDR for an IPAM resource.
+ */ +export interface IpamResourceCidr { /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The IPAM ID for an IPAM resource.
*/ - DryRun?: boolean; -} + IpamId?: string; -export namespace GetNetworkInsightsAccessScopeContentRequest { /** - * @internal + *The scope ID for an IPAM resource.
*/ - export const filterSensitiveLog = (obj: GetNetworkInsightsAccessScopeContentRequest): any => ({ - ...obj, - }); -} + IpamScopeId?: string; -export interface GetNetworkInsightsAccessScopeContentResult { /** - *The Network Access Scope content.
+ *The pool ID for an IPAM resource.
*/ - NetworkInsightsAccessScopeContent?: NetworkInsightsAccessScopeContent; -} + IpamPoolId?: string; -export namespace GetNetworkInsightsAccessScopeContentResult { /** - * @internal + *The Amazon Web Services Region for an IPAM resource.
*/ - export const filterSensitiveLog = (obj: GetNetworkInsightsAccessScopeContentResult): any => ({ - ...obj, - }); -} + ResourceRegion?: string; -export interface GetPasswordDataRequest { /** - *The ID of the Windows instance.
+ *The Amazon Web Services account number of the owner of an IPAM resource.
*/ - InstanceId: string | undefined; + ResourceOwnerId?: string; /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The ID of an IPAM resource.
*/ - DryRun?: boolean; -} + ResourceId?: string; -export namespace GetPasswordDataRequest { /** - * @internal + *The name of an IPAM resource.
*/ - export const filterSensitiveLog = (obj: GetPasswordDataRequest): any => ({ - ...obj, - }); -} + ResourceName?: string; -export interface GetPasswordDataResult { /** - *The ID of the Windows instance.
+ *The CIDR for an IPAM resource.
*/ - InstanceId?: string; + ResourceCidr?: string; /** - *The password of the instance. Returns an empty string if the password is not - * available.
+ *The type of IPAM resource.
*/ - PasswordData?: string; + ResourceType?: IpamResourceType | string; /** - *The time the data was last updated.
+ *The tags for an IPAM resource.
*/ - Timestamp?: Date; -} + ResourceTags?: IpamResourceTag[]; -export namespace GetPasswordDataResult { /** - * @internal + *The IP address space in the IPAM pool that is allocated to this resource. To convert the decimal to a percentage, multiply the decimal by 100.
*/ - export const filterSensitiveLog = (obj: GetPasswordDataResult): any => ({ - ...obj, - }); -} + IpUsage?: number; -/** - *Contains the parameters for GetReservedInstanceExchangeQuote.
- */ -export interface GetReservedInstancesExchangeQuoteRequest { /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The compliance status of the IPAM resource. For more information on compliance statuses, see Monitor CIDR usage by resource in the Amazon VPC IPAM User Guide.
*/ - DryRun?: boolean; + ComplianceStatus?: IpamComplianceStatus | string; /** - *The IDs of the Convertible Reserved Instances to exchange.
+ *The management state of the resource. For more information about management states, see Monitor CIDR usage by resource in the Amazon VPC IPAM User Guide.
*/ - ReservedInstanceIds: string[] | undefined; + ManagementState?: IpamManagementState | string; /** - *The configuration of the target Convertible Reserved Instance to exchange for your - * current Convertible Reserved Instances.
+ *The overlap status of an IPAM resource. The overlap status tells you if the CIDR for a resource overlaps with another CIDR in the scope. For more information on overlap statuses, see Monitor CIDR usage by resource in the Amazon VPC IPAM User Guide.
*/ - TargetConfigurations?: TargetConfigurationRequest[]; + OverlapStatus?: IpamOverlapStatus | string; + + /** + *The ID of a VPC.
+ */ + VpcId?: string; } -export namespace GetReservedInstancesExchangeQuoteRequest { +export namespace IpamResourceCidr { /** * @internal */ - export const filterSensitiveLog = (obj: GetReservedInstancesExchangeQuoteRequest): any => ({ + export const filterSensitiveLog = (obj: IpamResourceCidr): any => ({ ...obj, }); } -/** - *The cost associated with the Reserved Instance.
- */ -export interface ReservationValue { - /** - *The hourly rate of the reservation.
- */ - HourlyPrice?: string; - +export interface GetIpamResourceCidrsResult { /** - *The balance of the total value (the sum of remainingUpfrontValue + hourlyPrice * number of hours remaining).
+ *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The remaining upfront cost of the reservation.
+ *The resource CIDRs.
*/ - RemainingUpfrontValue?: string; + IpamResourceCidrs?: IpamResourceCidr[]; } -export namespace ReservationValue { +export namespace GetIpamResourceCidrsResult { /** * @internal */ - export const filterSensitiveLog = (obj: ReservationValue): any => ({ + export const filterSensitiveLog = (obj: GetIpamResourceCidrsResult): any => ({ ...obj, }); } -/** - *The total value of the Convertible Reserved Instance.
- */ -export interface ReservedInstanceReservationValue { +export interface GetLaunchTemplateDataRequest { /** - *The total value of the Convertible Reserved Instance that you are exchanging.
+ *Checks whether you have the required permissions for the action, without actually
+ * making the request, and provides an error response. If you have the required
+ * permissions, the error response is DryRunOperation. Otherwise, it is
+ * UnauthorizedOperation.
The ID of the Convertible Reserved Instance that you are exchanging.
+ *The ID of the instance.
*/ - ReservedInstanceId?: string; + InstanceId: string | undefined; } -export namespace ReservedInstanceReservationValue { +export namespace GetLaunchTemplateDataRequest { /** * @internal */ - export const filterSensitiveLog = (obj: ReservedInstanceReservationValue): any => ({ + export const filterSensitiveLog = (obj: GetLaunchTemplateDataRequest): any => ({ ...obj, }); } -/** - *Information about the Convertible Reserved Instance offering.
- */ -export interface TargetConfiguration { - /** - *The number of instances the Convertible Reserved Instance offering can be applied to. This parameter is - * reserved and cannot be specified in a request
- */ - InstanceCount?: number; - +export interface GetLaunchTemplateDataResult { /** - *The ID of the Convertible Reserved Instance offering.
+ *The instance data.
*/ - OfferingId?: string; + LaunchTemplateData?: ResponseLaunchTemplateData; } -export namespace TargetConfiguration { +export namespace GetLaunchTemplateDataResult { /** * @internal */ - export const filterSensitiveLog = (obj: TargetConfiguration): any => ({ + export const filterSensitiveLog = (obj: GetLaunchTemplateDataResult): any => ({ ...obj, }); } -/** - *The total value of the new Convertible Reserved Instances.
- */ -export interface TargetReservationValue { +export interface GetManagedPrefixListAssociationsRequest { /** - *The total value of the Convertible Reserved Instances that make up the exchange. This is the sum of - * the list value, remaining upfront price, and additional upfront cost of the exchange.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The configuration of the Convertible Reserved Instances that make up the exchange.
+ *The ID of the prefix list.
*/ - TargetConfiguration?: TargetConfiguration; + PrefixListId: string | undefined; + + /** + *The maximum number of results to return with a single call.
+ * To retrieve the remaining results, make another call with the returned nextToken value.
The token for the next page of results.
+ */ + NextToken?: string; } -export namespace TargetReservationValue { +export namespace GetManagedPrefixListAssociationsRequest { /** * @internal */ - export const filterSensitiveLog = (obj: TargetReservationValue): any => ({ + export const filterSensitiveLog = (obj: GetManagedPrefixListAssociationsRequest): any => ({ ...obj, }); } /** - *Contains the output of GetReservedInstancesExchangeQuote.
+ *Describes the resource with which a prefix list is associated.
*/ -export interface GetReservedInstancesExchangeQuoteResult { +export interface PrefixListAssociation { /** - *The currency of the transaction.
+ *The ID of the resource.
*/ - CurrencyCode?: string; + ResourceId?: string; /** - *If true, the exchange is valid. If false, the exchange cannot be completed.
The owner of the resource.
*/ - IsValidExchange?: boolean; + ResourceOwner?: string; +} +export namespace PrefixListAssociation { /** - *The new end date of the reservation term.
+ * @internal */ - OutputReservedInstancesWillExpireAt?: Date; + export const filterSensitiveLog = (obj: PrefixListAssociation): any => ({ + ...obj, + }); +} +export interface GetManagedPrefixListAssociationsResult { /** - *The total true upfront charge for the exchange.
+ *Information about the associations.
*/ - PaymentDue?: string; + PrefixListAssociations?: PrefixListAssociation[]; /** - *The cost associated with the Reserved Instance.
+ *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The configuration of your Convertible Reserved Instances.
+ * @internal */ - ReservedInstanceValueSet?: ReservedInstanceReservationValue[]; + export const filterSensitiveLog = (obj: GetManagedPrefixListAssociationsResult): any => ({ + ...obj, + }); +} +export interface GetManagedPrefixListEntriesRequest { /** - *The cost associated with the Reserved Instance.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The values of the target Convertible Reserved Instances.
+ *The ID of the prefix list.
*/ - TargetConfigurationValueSet?: TargetReservationValue[]; + PrefixListId: string | undefined; /** - *Describes the reason why the exchange cannot be completed.
+ *The version of the prefix list for which to return the entries. The default is the current version.
*/ - ValidationFailureReason?: string; -} + TargetVersion?: number; -export namespace GetReservedInstancesExchangeQuoteResult { /** - * @internal - */ - export const filterSensitiveLog = (obj: GetReservedInstancesExchangeQuoteResult): any => ({ - ...obj, - }); -} + *The maximum number of results to return with a single call.
+ * To retrieve the remaining results, make another call with the returned nextToken value.
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
The token for the next page of results.
*/ - DryRun?: boolean; + NextToken?: string; } -export namespace GetSerialConsoleAccessStatusRequest { +export namespace GetManagedPrefixListEntriesRequest { /** * @internal */ - export const filterSensitiveLog = (obj: GetSerialConsoleAccessStatusRequest): any => ({ + export const filterSensitiveLog = (obj: GetManagedPrefixListEntriesRequest): any => ({ ...obj, }); } -export interface GetSerialConsoleAccessStatusResult { +/** + *Describes a prefix list entry.
+ */ +export interface PrefixListEntry { /** - *If true, access to the EC2 serial console of all instances is enabled for
- * your account. If false, access to the EC2 serial console of all instances
- * is disabled for your account.
The CIDR block.
*/ - SerialConsoleAccessEnabled?: boolean; + Cidr?: string; + + /** + *The description.
+ */ + Description?: string; } -export namespace GetSerialConsoleAccessStatusResult { +export namespace PrefixListEntry { /** * @internal */ - export const filterSensitiveLog = (obj: GetSerialConsoleAccessStatusResult): any => ({ + export const filterSensitiveLog = (obj: PrefixListEntry): any => ({ ...obj, }); } -/** - *The architecture type, virtualization type, and other attributes for the instance types. - * When you specify instance attributes, Amazon EC2 will identify instance types with those - * attributes.
- *If you specify InstanceRequirementsWithMetadataRequest, you can't specify
- * InstanceTypes.
The architecture type.
- */ - ArchitectureTypes?: (ArchitectureType | string)[]; - +export interface GetManagedPrefixListEntriesResult { /** - *The virtualization type.
+ *Information about the prefix list entries.
*/ - VirtualizationTypes?: (VirtualizationType | string)[]; + Entries?: PrefixListEntry[]; /** - *The attributes for the instance types. When you specify instance attributes, Amazon EC2 will - * identify instance types with those attributes.
+ *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The instance types. We recommend that you specify at least three instance types. If you
- * specify one or two instance types, or specify variations of a single instance type (for
- * example, an m3.xlarge with and without instance storage), the returned
- * placement score will always be low.
If you specify InstanceTypes, you can't specify
- * InstanceRequirementsWithMetadata.
The ID of the Network Access Scope analysis.
*/ - InstanceTypes?: string[]; + NetworkInsightsAccessScopeAnalysisId: string | undefined; /** - *The target capacity.
+ *The maximum number of results to return with a single call.
+ * To retrieve the remaining results, make another call with the returned nextToken value.
The unit for the target capacity.
- *Default: units (translates to number of instances)
The token for the next page of results.
*/ - TargetCapacityUnitType?: TargetCapacityUnitType | string; + NextToken?: string; /** - *Specify true so that the response returns a list of scored Availability Zones.
- * Otherwise, the response returns a list of scored Regions.
A list of scored Availability Zones is useful if you want to launch all of your Spot - * capacity into a single Availability Zone.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The Regions used to narrow down the list of Regions to be scored. Enter the Region code,
- * for example, us-east-1.
The attributes for the instance types. When you specify instance attributes, Amazon EC2 will - * identify instance types with those attributes.
- *If you specify InstanceRequirementsWithMetadata, you can't specify
- * InstanceTypes.
The ID of the Network Access Scope analysis.
*/ - InstanceRequirementsWithMetadata?: InstanceRequirementsWithMetadataRequest; + NetworkInsightsAccessScopeAnalysisId?: string; /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The status of Network Access Scope Analysis.
*/ - DryRun?: boolean; + AnalysisStatus?: AnalysisStatus | string; /** - *The maximum number of results to return in a single call. Specify a value between 1 and
- * 1000. The default value is 1000. To retrieve the remaining results, make another call with
- * the returned NextToken value.
The findings associated with Network Access Scope Analysis.
*/ - MaxResults?: number; + AnalysisFindings?: AccessScopeAnalysisFinding[]; /** - *The token for the next set of results.
+ *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The Spot placement score for this Region or Availability Zone. The score is calculated
- * based on the assumption that the capacity-optimized allocation strategy is
- * used and that all of the Availability Zones in the Region can be used.
The Region.
- */ - Region?: string; - +export interface GetNetworkInsightsAccessScopeContentRequest { /** - *The Availability Zone.
+ *The ID of the Network Access Scope.
*/ - AvailabilityZoneId?: string; + NetworkInsightsAccessScopeId: string | undefined; /** - *The placement score, on a scale from 1 to 10. A score of
- * 10 indicates that your Spot request is highly likely to succeed in this
- * Region or Availability Zone. A score of 1 indicates that your Spot request is
- * not likely to succeed.
Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The Spot placement score for the top 10 Regions or Availability Zones, scored on a scale
- * from 1 to 10. Each score
reflects how likely it is that each Region or Availability Zone
- * will succeed at fulfilling the specified target capacity
at the time of the Spot
- * placement score request. A score of 10 means that your Spot
- * capacity request is highly likely to succeed in that Region or Availability Zone.
If you request a Spot placement score for Regions, a high score assumes that your fleet
- * request will be configured to use all Availability Zones and the
- * capacity-optimized allocation strategy. If you request a Spot placement
- * score for Availability Zones, a high score assumes that your fleet request will be
- * configured to use a single Availability Zone and the capacity-optimized
- * allocation strategy.
Different Regions or Availability Zones might return the same score.
- *The Spot placement score serves as a recommendation only. No score guarantees that your - * Spot request will be fully or partially fulfilled.
- *The token for the next set of results.
+ *The Network Access Scope content.
*/ - NextToken?: string; + NetworkInsightsAccessScopeContent?: NetworkInsightsAccessScopeContent; } -export namespace GetSpotPlacementScoresResult { +export namespace GetNetworkInsightsAccessScopeContentResult { /** * @internal */ - export const filterSensitiveLog = (obj: GetSpotPlacementScoresResult): any => ({ + export const filterSensitiveLog = (obj: GetNetworkInsightsAccessScopeContentResult): any => ({ ...obj, }); } -export interface GetSubnetCidrReservationsRequest { - /** - *One or more filters.
- *
- * reservationType - The type of reservation (prefix |
- * explicit).
- * subnet-id - The ID of the subnet.
- * tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
- * tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
The ID of the subnet.
+ *The ID of the Windows instance.
*/ - SubnetId: string | undefined; + InstanceId: string | undefined; /** *Checks whether you have the required permissions for the action, without actually making the request,
@@ -1055,398 +976,349 @@ export interface GetSubnetCidrReservationsRequest {
* Otherwise, it is UnauthorizedOperation.
The token for the next page of results.
- */ - NextToken?: string; - - /** - *The maximum number of results to return with a single call.
- * To retrieve the remaining results, make another call with the returned nextToken value.
Information about the IPv4 subnet CIDR reservations.
+ *The ID of the Windows instance.
*/ - SubnetIpv4CidrReservations?: SubnetCidrReservation[]; + InstanceId?: string; /** - *Information about the IPv6 subnet CIDR reservations.
+ *The password of the instance. Returns an empty string if the password is not + * available.
*/ - SubnetIpv6CidrReservations?: SubnetCidrReservation[]; + PasswordData?: string; /** - *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The time the data was last updated.
*/ - NextToken?: string; + Timestamp?: Date; } -export namespace GetSubnetCidrReservationsResult { +export namespace GetPasswordDataResult { /** * @internal */ - export const filterSensitiveLog = (obj: GetSubnetCidrReservationsResult): any => ({ + export const filterSensitiveLog = (obj: GetPasswordDataResult): any => ({ ...obj, }); } -export interface GetTransitGatewayAttachmentPropagationsRequest { - /** - *The ID of the attachment.
- */ - TransitGatewayAttachmentId: string | undefined; - - /** - *One or more filters. The possible values are:
- *
- * transit-gateway-route-table-id - The ID of the transit gateway route table.
Contains the parameters for GetReservedInstanceExchangeQuote.
+ */ +export interface GetReservedInstancesExchangeQuoteRequest { /** - *The maximum number of results to return with a single call.
- * To retrieve the remaining results, make another call with the returned nextToken value.
Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The token for the next page of results.
+ *The IDs of the Convertible Reserved Instances to exchange.
*/ - NextToken?: string; + ReservedInstanceIds: string[] | undefined; /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The configuration of the target Convertible Reserved Instance to exchange for your + * current Convertible Reserved Instances.
*/ - DryRun?: boolean; + TargetConfigurations?: TargetConfigurationRequest[]; } -export namespace GetTransitGatewayAttachmentPropagationsRequest { +export namespace GetReservedInstancesExchangeQuoteRequest { /** * @internal */ - export const filterSensitiveLog = (obj: GetTransitGatewayAttachmentPropagationsRequest): any => ({ + export const filterSensitiveLog = (obj: GetReservedInstancesExchangeQuoteRequest): any => ({ ...obj, }); } /** - *Describes a propagation route table.
+ *The cost associated with the Reserved Instance.
*/ -export interface TransitGatewayAttachmentPropagation { +export interface ReservationValue { /** - *The ID of the propagation route table.
+ *The hourly rate of the reservation.
*/ - TransitGatewayRouteTableId?: string; + HourlyPrice?: string; /** - *The state of the propagation route table.
+ *The balance of the total value (the sum of remainingUpfrontValue + hourlyPrice * number of hours remaining).
*/ - State?: TransitGatewayPropagationState | string; + RemainingTotalValue?: string; + + /** + *The remaining upfront cost of the reservation.
+ */ + RemainingUpfrontValue?: string; } -export namespace TransitGatewayAttachmentPropagation { +export namespace ReservationValue { /** * @internal */ - export const filterSensitiveLog = (obj: TransitGatewayAttachmentPropagation): any => ({ + export const filterSensitiveLog = (obj: ReservationValue): any => ({ ...obj, }); } -export interface GetTransitGatewayAttachmentPropagationsResult { +/** + *The total value of the Convertible Reserved Instance.
+ */ +export interface ReservedInstanceReservationValue { /** - *Information about the propagation route tables.
+ *The total value of the Convertible Reserved Instance that you are exchanging.
*/ - TransitGatewayAttachmentPropagations?: TransitGatewayAttachmentPropagation[]; + ReservationValue?: ReservationValue; /** - *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The ID of the Convertible Reserved Instance that you are exchanging.
*/ - NextToken?: string; + ReservedInstanceId?: string; } -export namespace GetTransitGatewayAttachmentPropagationsResult { +export namespace ReservedInstanceReservationValue { /** * @internal */ - export const filterSensitiveLog = (obj: GetTransitGatewayAttachmentPropagationsResult): any => ({ + export const filterSensitiveLog = (obj: ReservedInstanceReservationValue): any => ({ ...obj, }); } -export interface GetTransitGatewayMulticastDomainAssociationsRequest { +/** + *Information about the Convertible Reserved Instance offering.
+ */ +export interface TargetConfiguration { /** - *The ID of the transit gateway multicast domain.
+ *The number of instances the Convertible Reserved Instance offering can be applied to. This parameter is + * reserved and cannot be specified in a request
*/ - TransitGatewayMulticastDomainId?: string; + InstanceCount?: number; /** - *One or more filters. The possible values are:
- *
- * resource-id - The ID of the resource.
- * resource-type - The type of resource. The valid value is: vpc.
- * state - The state of the subnet association. Valid values are
- * associated |
- * associating
- * | disassociated | disassociating.
- * subnet-id - The ID of the subnet.
- * transit-gateway-attachment-id - The id of the transit gateway attachment.
The ID of the Convertible Reserved Instance offering.
*/ - Filters?: Filter[]; + OfferingId?: string; +} +export namespace TargetConfiguration { /** - *The maximum number of results to return with a single call.
- * To retrieve the remaining results, make another call with the returned nextToken value.
The total value of the new Convertible Reserved Instances.
+ */ +export interface TargetReservationValue { /** - *The token for the next page of results.
+ *The total value of the Convertible Reserved Instances that make up the exchange. This is the sum of + * the list value, remaining upfront price, and additional upfront cost of the exchange.
*/ - NextToken?: string; + ReservationValue?: ReservationValue; /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The configuration of the Convertible Reserved Instances that make up the exchange.
*/ - DryRun?: boolean; + TargetConfiguration?: TargetConfiguration; } -export namespace GetTransitGatewayMulticastDomainAssociationsRequest { +export namespace TargetReservationValue { /** * @internal */ - export const filterSensitiveLog = (obj: GetTransitGatewayMulticastDomainAssociationsRequest): any => ({ + export const filterSensitiveLog = (obj: TargetReservationValue): any => ({ ...obj, }); } /** - *Describes the resources associated with the transit gateway multicast domain.
+ *Contains the output of GetReservedInstancesExchangeQuote.
*/ -export interface TransitGatewayMulticastDomainAssociation { +export interface GetReservedInstancesExchangeQuoteResult { /** - *The ID of the transit gateway attachment.
+ *The currency of the transaction.
*/ - TransitGatewayAttachmentId?: string; + CurrencyCode?: string; /** - *The ID of the resource.
+ *If true, the exchange is valid. If false, the exchange cannot be completed.
The type of resource, for example a VPC attachment.
+ *The new end date of the reservation term.
*/ - ResourceType?: TransitGatewayAttachmentResourceType | string; + OutputReservedInstancesWillExpireAt?: Date; /** - *The ID of the Amazon Web Services account that owns the transit gateway multicast domain association resource.
+ *The total true upfront charge for the exchange.
*/ - ResourceOwnerId?: string; + PaymentDue?: string; /** - *The subnet associated with the transit gateway multicast domain.
+ *The cost associated with the Reserved Instance.
*/ - Subnet?: SubnetAssociation; -} + ReservedInstanceValueRollup?: ReservationValue; -export namespace TransitGatewayMulticastDomainAssociation { /** - * @internal + *The configuration of your Convertible Reserved Instances.
*/ - export const filterSensitiveLog = (obj: TransitGatewayMulticastDomainAssociation): any => ({ - ...obj, - }); -} + ReservedInstanceValueSet?: ReservedInstanceReservationValue[]; -export interface GetTransitGatewayMulticastDomainAssociationsResult { /** - *Information about the multicast domain associations.
+ *The cost associated with the Reserved Instance.
*/ - MulticastDomainAssociations?: TransitGatewayMulticastDomainAssociation[]; + TargetConfigurationValueRollup?: ReservationValue; /** - *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The values of the target Convertible Reserved Instances.
*/ - NextToken?: string; + TargetConfigurationValueSet?: TargetReservationValue[]; + + /** + *Describes the reason why the exchange cannot be completed.
+ */ + ValidationFailureReason?: string; } -export namespace GetTransitGatewayMulticastDomainAssociationsResult { +export namespace GetReservedInstancesExchangeQuoteResult { /** * @internal */ - export const filterSensitiveLog = (obj: GetTransitGatewayMulticastDomainAssociationsResult): any => ({ + export const filterSensitiveLog = (obj: GetReservedInstancesExchangeQuoteResult): any => ({ ...obj, }); } -export interface GetTransitGatewayPrefixListReferencesRequest { +export interface GetSerialConsoleAccessStatusRequest { /** - *The ID of the transit gateway route table.
+ *Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
One or more filters. The possible values are:
- *
- * attachment.resource-id - The ID of the resource for the attachment.
- * attachment.resource-type - The type of resource for the
- * attachment. Valid values are vpc | vpn |
- * direct-connect-gateway | peering.
- * attachment.transit-gateway-attachment-id - The ID of the attachment.
- * is-blackhole - Whether traffic matching the route is blocked (true | false).
- * prefix-list-id - The ID of the prefix list.
- * prefix-list-owner-id - The ID of the owner of the prefix list.
- * state - The state of the prefix list reference (pending | available | modifying | deleting).
The maximum number of results to return with a single call.
- * To retrieve the remaining results, make another call with the returned nextToken value.
If true, access to the EC2 serial console of all instances is enabled for
+ * your account. If false, access to the EC2 serial console of all instances
+ * is disabled for your account.
The token for the next page of results.
- */ - NextToken?: string; - - /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The architecture type, virtualization type, and other attributes for the instance types. + * When you specify instance attributes, Amazon EC2 will identify instance types with those + * attributes.
+ *If you specify InstanceRequirementsWithMetadataRequest, you can't specify
+ * InstanceTypes.
Information about the prefix list references.
+ *The architecture type.
*/ - TransitGatewayPrefixListReferences?: TransitGatewayPrefixListReference[]; + ArchitectureTypes?: (ArchitectureType | string)[]; /** - *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The virtualization type.
*/ - NextToken?: string; + VirtualizationTypes?: (VirtualizationType | string)[]; + + /** + *The attributes for the instance types. When you specify instance attributes, Amazon EC2 will + * identify instance types with those attributes.
+ */ + InstanceRequirements?: InstanceRequirementsRequest; } -export namespace GetTransitGatewayPrefixListReferencesResult { +export namespace InstanceRequirementsWithMetadataRequest { /** * @internal */ - export const filterSensitiveLog = (obj: GetTransitGatewayPrefixListReferencesResult): any => ({ + export const filterSensitiveLog = (obj: InstanceRequirementsWithMetadataRequest): any => ({ ...obj, }); } -export interface GetTransitGatewayRouteTableAssociationsRequest { +export interface GetSpotPlacementScoresRequest { /** - *The ID of the transit gateway route table.
+ *The instance types. We recommend that you specify at least three instance types. If you
+ * specify one or two instance types, or specify variations of a single instance type (for
+ * example, an m3.xlarge with and without instance storage), the returned
+ * placement score will always be low.
If you specify InstanceTypes, you can't specify
+ * InstanceRequirementsWithMetadata.
One or more filters. The possible values are:
- *
- * resource-id - The ID of the resource.
- * resource-type - The resource type. Valid values are vpc
- * | vpn | direct-connect-gateway | peering
- * | connect.
- * transit-gateway-attachment-id - The ID of the attachment.
The target capacity.
*/ - Filters?: Filter[]; + TargetCapacity: number | undefined; /** - *The maximum number of results to return with a single call.
- * To retrieve the remaining results, make another call with the returned nextToken value.
The unit for the target capacity.
+ *Default: units (translates to number of instances)
The token for the next page of results.
+ *Specify true so that the response returns a list of scored Availability Zones.
+ * Otherwise, the response returns a list of scored Regions.
A list of scored Availability Zones is useful if you want to launch all of your Spot + * capacity into a single Availability Zone.
*/ - NextToken?: string; + SingleAvailabilityZone?: boolean; + + /** + *The Regions used to narrow down the list of Regions to be scored. Enter the Region code,
+ * for example, us-east-1.
The attributes for the instance types. When you specify instance attributes, Amazon EC2 will + * identify instance types with those attributes.
+ *If you specify InstanceRequirementsWithMetadata, you can't specify
+ * InstanceTypes.
Checks whether you have the required permissions for the action, without actually making the request,
@@ -1454,104 +1326,136 @@ export interface GetTransitGatewayRouteTableAssociationsRequest {
* Otherwise, it is UnauthorizedOperation.
The maximum number of results to return in a single call. Specify a value between 1 and
+ * 1000. The default value is 1000. To retrieve the remaining results, make another call with
+ * the returned NextToken value.
The token for the next set of results.
+ */ + NextToken?: string; } -export namespace GetTransitGatewayRouteTableAssociationsRequest { +export namespace GetSpotPlacementScoresRequest { /** * @internal */ - export const filterSensitiveLog = (obj: GetTransitGatewayRouteTableAssociationsRequest): any => ({ + export const filterSensitiveLog = (obj: GetSpotPlacementScoresRequest): any => ({ ...obj, }); } /** - *Describes an association between a route table and a resource attachment.
+ *The Spot placement score for this Region or Availability Zone. The score is calculated
+ * based on the assumption that the capacity-optimized allocation strategy is
+ * used and that all of the Availability Zones in the Region can be used.
The ID of the attachment.
- */ - TransitGatewayAttachmentId?: string; - +export interface SpotPlacementScore { /** - *The ID of the resource.
+ *The Region.
*/ - ResourceId?: string; + Region?: string; /** - *The resource type. Note that the tgw-peering resource type has been deprecated.
The Availability Zone.
*/ - ResourceType?: TransitGatewayAttachmentResourceType | string; + AvailabilityZoneId?: string; /** - *The state of the association.
+ *The placement score, on a scale from 1 to 10. A score of
+ * 10 indicates that your Spot request is highly likely to succeed in this
+ * Region or Availability Zone. A score of 1 indicates that your Spot request is
+ * not likely to succeed.
Information about the associations.
+ *The Spot placement score for the top 10 Regions or Availability Zones, scored on a scale
+ * from 1 to 10. Each score
reflects how likely it is that each Region or Availability Zone
+ * will succeed at fulfilling the specified target capacity
at the time of the Spot
+ * placement score request. A score of 10 means that your Spot
+ * capacity request is highly likely to succeed in that Region or Availability Zone.
If you request a Spot placement score for Regions, a high score assumes that your fleet
+ * request will be configured to use all Availability Zones and the
+ * capacity-optimized allocation strategy. If you request a Spot placement
+ * score for Availability Zones, a high score assumes that your fleet request will be
+ * configured to use a single Availability Zone and the capacity-optimized
+ * allocation strategy.
Different Regions or Availability Zones might return the same score.
+ *The Spot placement score serves as a recommendation only. No score guarantees that your + * Spot request will be fully or partially fulfilled.
+ *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The token for the next set of results.
*/ NextToken?: string; } -export namespace GetTransitGatewayRouteTableAssociationsResult { +export namespace GetSpotPlacementScoresResult { /** * @internal */ - export const filterSensitiveLog = (obj: GetTransitGatewayRouteTableAssociationsResult): any => ({ + export const filterSensitiveLog = (obj: GetSpotPlacementScoresResult): any => ({ ...obj, }); } -export interface GetTransitGatewayRouteTablePropagationsRequest { - /** - *The ID of the transit gateway route table.
- */ - TransitGatewayRouteTableId: string | undefined; - +export interface GetSubnetCidrReservationsRequest { /** - *One or more filters. The possible values are:
- *One or more filters.
+ *
- * resource-id - The ID of the resource.
+ * reservationType - The type of reservation (prefix |
+ * explicit).
+ * subnet-id - The ID of the subnet.
- * resource-type - The resource type. Valid values are vpc
- * | vpn | direct-connect-gateway | peering
- * | connect.
tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
*
- * transit-gateway-attachment-id - The ID of the attachment.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
* The maximum number of results to return with a single call.
- * To retrieve the remaining results, make another call with the returned nextToken value.
The ID of the subnet.
*/ - MaxResults?: number; + SubnetId: string | undefined; + + /** + *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The token for the next page of results.
@@ -1559,1075 +1463,1301 @@ export interface GetTransitGatewayRouteTablePropagationsRequest { NextToken?: string; /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The maximum number of results to return with a single call.
+ * To retrieve the remaining results, make another call with the returned nextToken value.
Describes a route table propagation.
- */ -export interface TransitGatewayRouteTablePropagation { - /** - *The ID of the attachment.
- */ - TransitGatewayAttachmentId?: string; - +export interface GetSubnetCidrReservationsResult { /** - *The ID of the resource.
+ *Information about the IPv4 subnet CIDR reservations.
*/ - ResourceId?: string; + SubnetIpv4CidrReservations?: SubnetCidrReservation[]; /** - *The type of resource. Note that the tgw-peering resource type has been deprecated.
Information about the IPv6 subnet CIDR reservations.
*/ - ResourceType?: TransitGatewayAttachmentResourceType | string; + SubnetIpv6CidrReservations?: SubnetCidrReservation[]; /** - *The state of the resource.
+ *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Information about the route table propagations.
+ *The ID of the attachment.
*/ - TransitGatewayRouteTablePropagations?: TransitGatewayRouteTablePropagation[]; + TransitGatewayAttachmentId: string | undefined; /** - *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
One or more filters. The possible values are:
+ *
+ * transit-gateway-route-table-id - The ID of the transit gateway route table.
The maximum number of results to return with a single call.
+ * To retrieve the remaining results, make another call with the returned nextToken value.
The token for the next page of results.
*/ NextToken?: string; + + /** + *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Describes a propagation route table.
+ */ +export interface TransitGatewayAttachmentPropagation { /** - *The VpnConnectionId specifies the Site-to-Site VPN connection used for the sample
- * configuration.
The ID of the propagation route table.
*/ - VpnConnectionId: string | undefined; + TransitGatewayRouteTableId?: string; /** - *Device identifier provided by the GetVpnConnectionDeviceTypes API.
The state of the propagation route table.
*/ - VpnConnectionDeviceTypeId: string | undefined; + State?: TransitGatewayPropagationState | string; +} +export namespace TransitGatewayAttachmentPropagation { /** - *The IKE version to be used in the sample configuration file for your customer gateway
- * device. You can specify one of the following versions: ikev1 or
- * ikev2.
Checks whether you have the required permissions for the action, without actually
- * making the request, and provides an error response. If you have the required
- * permissions, the error response is DryRunOperation. Otherwise, it is
- * UnauthorizedOperation.
Information about the propagation route tables.
*/ - DryRun?: boolean; + TransitGatewayAttachmentPropagations?: TransitGatewayAttachmentPropagation[]; + + /** + *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Sample configuration file for the specified customer gateway device.
+ *The ID of the transit gateway multicast domain.
*/ - VpnConnectionDeviceSampleConfiguration?: string; -} + TransitGatewayMulticastDomainId?: string; -export namespace GetVpnConnectionDeviceSampleConfigurationResult { /** - * @internal + *One or more filters. The possible values are:
+ *
+ * resource-id - The ID of the resource.
+ * resource-type - The type of resource. The valid value is: vpc.
+ * state - The state of the subnet association. Valid values are
+ * associated |
+ * associating
+ * | disassociated | disassociating.
+ * subnet-id - The ID of the subnet.
+ * transit-gateway-attachment-id - The id of the transit gateway attachment.
The maximum number of results returned by GetVpnConnectionDeviceTypes in
- * paginated output. When this parameter is used, GetVpnConnectionDeviceTypes
- * only returns MaxResults results in a single page along with a
- * NextToken response element. The remaining results of the initial
- * request can be seen by sending another GetVpnConnectionDeviceTypes request
- * with the returned NextToken value. This value can be between 200 and 1000.
- * If this parameter is not used, then GetVpnConnectionDeviceTypes returns all
- * results.
The maximum number of results to return with a single call.
+ * To retrieve the remaining results, make another call with the returned nextToken value.
The NextToken value returned from a previous paginated
- * GetVpnConnectionDeviceTypes request where MaxResults was
- * used and the results exceeded the value of that parameter. Pagination continues from the
- * end of the previous results that returned the NextToken value. This value
- * is null when there are no more results to return.
The token for the next page of results.
*/ NextToken?: string; /** - *Checks whether you have the required permissions for the action, without actually
- * making the request, and provides an error response. If you have the required
- * permissions, the error response is DryRunOperation. Otherwise, it is
- * UnauthorizedOperation.
Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
List of customer gateway devices that have a sample configuration file available for - * use. You can also see the list of device types with sample configuration files available - * under Your customer - * gateway device in the Amazon Web Services Site-to-Site VPN User Guide.
+ *Describes the resources associated with the transit gateway multicast domain.
*/ -export interface VpnConnectionDeviceType { +export interface TransitGatewayMulticastDomainAssociation { /** - *Customer gateway device identifier.
+ *The ID of the transit gateway attachment.
*/ - VpnConnectionDeviceTypeId?: string; + TransitGatewayAttachmentId?: string; /** - *Customer gateway device vendor.
+ *The ID of the resource.
*/ - Vendor?: string; + ResourceId?: string; /** - *Customer gateway device platform.
+ *The type of resource, for example a VPC attachment.
*/ - Platform?: string; + ResourceType?: TransitGatewayAttachmentResourceType | string; /** - *Customer gateway device software version.
+ *The ID of the Amazon Web Services account that owns the transit gateway multicast domain association resource.
*/ - Software?: string; + ResourceOwnerId?: string; + + /** + *The subnet associated with the transit gateway multicast domain.
+ */ + Subnet?: SubnetAssociation; } -export namespace VpnConnectionDeviceType { +export namespace TransitGatewayMulticastDomainAssociation { /** * @internal */ - export const filterSensitiveLog = (obj: VpnConnectionDeviceType): any => ({ + export const filterSensitiveLog = (obj: TransitGatewayMulticastDomainAssociation): any => ({ ...obj, }); } -export interface GetVpnConnectionDeviceTypesResult { +export interface GetTransitGatewayMulticastDomainAssociationsResult { /** - *List of customer gateway devices that have a sample configuration file available for - * use.
+ *Information about the multicast domain associations.
*/ - VpnConnectionDeviceTypes?: VpnConnectionDeviceType[]; + MulticastDomainAssociations?: TransitGatewayMulticastDomainAssociation[]; /** - *The NextToken value to include in a future
- * GetVpnConnectionDeviceTypes request. When the results of a
- * GetVpnConnectionDeviceTypes request exceed MaxResults,
- * this value can be used to retrieve the next page of results. This value is null when
- * there are no more results to return.
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The ID of the Client VPN endpoint to which the client certificate revocation list applies.
+ *The ID of the transit gateway route table.
*/ - ClientVpnEndpointId: string | undefined; + TransitGatewayRouteTableId: string | undefined; /** - *The client certificate revocation list file. For more information, see Generate a Client Certificate Revocation List in the - * Client VPN Administrator Guide.
+ *One or more filters. The possible values are:
+ *
+ * attachment.resource-id - The ID of the resource for the attachment.
+ * attachment.resource-type - The type of resource for the
+ * attachment. Valid values are vpc | vpn |
+ * direct-connect-gateway | peering.
+ * attachment.transit-gateway-attachment-id - The ID of the attachment.
+ * is-blackhole - Whether traffic matching the route is blocked (true | false).
+ * prefix-list-id - The ID of the prefix list.
+ * prefix-list-owner-id - The ID of the owner of the prefix list.
+ * state - The state of the prefix list reference (pending | available | modifying | deleting).
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
The maximum number of results to return with a single call.
+ * To retrieve the remaining results, make another call with the returned nextToken value.
The token for the next page of results.
+ */ + NextToken?: string; + + /** + *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Returns true if the request succeeds; otherwise, it returns an error.
Information about the prefix list references.
*/ - Return?: boolean; + TransitGatewayPrefixListReferences?: TransitGatewayPrefixListReference[]; + + /** + *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Describes the client-specific data.
- */ -export interface ClientData { +export interface GetTransitGatewayRouteTableAssociationsRequest { /** - *A user-defined comment about the disk upload.
+ *The ID of the transit gateway route table.
*/ - Comment?: string; + TransitGatewayRouteTableId: string | undefined; /** - *The time that the disk upload ends.
+ *One or more filters. The possible values are:
+ *
+ * resource-id - The ID of the resource.
+ * resource-type - The resource type. Valid values are vpc
+ * | vpn | direct-connect-gateway | peering
+ * | connect.
+ * transit-gateway-attachment-id - The ID of the attachment.
The size of the uploaded disk image, in GiB.
+ *The maximum number of results to return with a single call.
+ * To retrieve the remaining results, make another call with the returned nextToken value.
The time that the disk upload starts.
+ *The token for the next page of results.
*/ - UploadStart?: Date; + NextToken?: string; + + /** + *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Describes the Amazon S3 bucket for the disk image.
+ *Describes an association between a route table and a resource attachment.
*/ -export interface UserBucket { +export interface TransitGatewayRouteTableAssociation { /** - *The name of the Amazon S3 bucket where the disk image is located.
+ *The ID of the attachment.
*/ - S3Bucket?: string; + TransitGatewayAttachmentId?: string; /** - *The file name of the disk image.
+ *The ID of the resource.
*/ - S3Key?: string; + ResourceId?: string; + + /** + *The resource type. Note that the tgw-peering resource type has been deprecated.
The state of the association.
+ */ + State?: TransitGatewayAssociationState | string; } -export namespace UserBucket { +export namespace TransitGatewayRouteTableAssociation { /** * @internal */ - export const filterSensitiveLog = (obj: UserBucket): any => ({ + export const filterSensitiveLog = (obj: TransitGatewayRouteTableAssociation): any => ({ ...obj, }); } -/** - *Describes the disk container object for an import image task.
- */ -export interface ImageDiskContainer { +export interface GetTransitGatewayRouteTableAssociationsResult { /** - *The description of the disk image.
+ *Information about the associations.
*/ - Description?: string; + Associations?: TransitGatewayRouteTableAssociation[]; /** - *The block device mapping for the disk.
+ *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The format of the disk image being imported.
- *Valid values: OVA | VHD | VHDX | VMDK | RAW
- *
The ID of the EBS snapshot to be used for importing the snapshot.
+ *The ID of the transit gateway route table.
*/ - SnapshotId?: string; + TransitGatewayRouteTableId: string | undefined; /** - *The URL to the Amazon S3-based disk image being imported. The URL can either be a https URL (https://..) or an - * Amazon S3 URL (s3://..)
+ *One or more filters. The possible values are:
+ *
+ * resource-id - The ID of the resource.
+ * resource-type - The resource type. Valid values are vpc
+ * | vpn | direct-connect-gateway | peering
+ * | connect.
+ * transit-gateway-attachment-id - The ID of the attachment.
The S3 bucket for the disk image.
+ *The maximum number of results to return with a single call.
+ * To retrieve the remaining results, make another call with the returned nextToken value.
The token for the next page of results.
+ */ + NextToken?: string; + + /** + *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The request information of license configurations.
+ *Describes a route table propagation.
*/ -export interface ImportImageLicenseConfigurationRequest { +export interface TransitGatewayRouteTablePropagation { /** - *The ARN of a license configuration.
+ *The ID of the attachment.
*/ - LicenseConfigurationArn?: string; + TransitGatewayAttachmentId?: string; + + /** + *The ID of the resource.
+ */ + ResourceId?: string; + + /** + *The type of resource. Note that the tgw-peering resource type has been deprecated.
The state of the resource.
+ */ + State?: TransitGatewayPropagationState | string; } -export namespace ImportImageLicenseConfigurationRequest { +export namespace TransitGatewayRouteTablePropagation { /** * @internal */ - export const filterSensitiveLog = (obj: ImportImageLicenseConfigurationRequest): any => ({ + export const filterSensitiveLog = (obj: TransitGatewayRouteTablePropagation): any => ({ ...obj, }); } -export interface ImportImageRequest { +export interface GetTransitGatewayRouteTablePropagationsResult { /** - *The architecture of the virtual machine.
- *Valid values: i386 | x86_64
- *
Information about the route table propagations.
*/ - Architecture?: string; + TransitGatewayRouteTablePropagations?: TransitGatewayRouteTablePropagation[]; /** - *The client-specific data.
+ *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The token to enable idempotency for VM import requests.
+ * @internal */ - ClientToken?: string; + export const filterSensitiveLog = (obj: GetTransitGatewayRouteTablePropagationsResult): any => ({ + ...obj, + }); +} +export interface GetVpnConnectionDeviceSampleConfigurationRequest { /** - *A description string for the import image task.
+ *The VpnConnectionId specifies the Site-to-Site VPN connection used for the sample
+ * configuration.
Information about the disk containers.
+ *Device identifier provided by the GetVpnConnectionDeviceTypes API.
Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The IKE version to be used in the sample configuration file for your customer gateway
+ * device. You can specify one of the following versions: ikev1 or
+ * ikev2.
Checks whether you have the required permissions for the action, without actually
+ * making the request, and provides an error response. If you have the required
+ * permissions, the error response is DryRunOperation. Otherwise, it is
+ * UnauthorizedOperation.
Specifies whether the destination AMI of the imported image should be encrypted. The default KMS key for EBS is used
- * unless you specify a non-default KMS key using KmsKeyId. For more information, see Amazon EBS Encryption in the
- * Amazon Elastic Compute Cloud User Guide.
The target hypervisor platform.
- *Valid values: xen
- *
Sample configuration file for the specified customer gateway device.
*/ - Hypervisor?: string; + VpnConnectionDeviceSampleConfiguration?: string; +} +export namespace GetVpnConnectionDeviceSampleConfigurationResult { /** - *An identifier for the symmetric KMS key to use when creating the
- * encrypted AMI. This parameter is only required if you want to use a non-default KMS key; if this
- * parameter is not specified, the default KMS key for EBS is used. If a KmsKeyId is
- * specified, the Encrypted flag must also be set.
The KMS key identifier may be provided in any of the following formats:
- *Key ID
- *Key alias. The alias ARN contains the arn:aws:kms namespace, followed by the Region of the key, the Amazon Web Services account ID of the key owner, the alias namespace, and then the key alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
ARN using key ID. The ID ARN contains the arn:aws:kms namespace, followed by the Region of the key, the Amazon Web Services account ID of the key owner, the key namespace, and then the key ID. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.
ARN using key alias. The alias ARN contains the arn:aws:kms namespace, followed by the Region of the key, the Amazon Web Services account ID of the key owner, the alias namespace, and then the key alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
Amazon Web Services parses KmsKeyId asynchronously, meaning that the action you call may appear to complete even
- * though you provided an invalid identifier. This action will eventually report failure.
The specified KMS key must exist in the Region that the AMI is being copied to.
- *Amazon EBS does not support asymmetric KMS keys.
+ * @internal */ - KmsKeyId?: string; + export const filterSensitiveLog = (obj: GetVpnConnectionDeviceSampleConfigurationResult): any => ({ + ...obj, + ...(obj.VpnConnectionDeviceSampleConfiguration && { VpnConnectionDeviceSampleConfiguration: SENSITIVE_STRING }), + }); +} +export interface GetVpnConnectionDeviceTypesRequest { /** - *The license type to be used for the Amazon Machine Image (AMI) after importing.
- *By default, we detect the source-system operating system (OS) and apply the appropriate license. Specify
- * AWS to replace the source-system license with an Amazon Web Services license, if appropriate. Specify BYOL
- * to retain the source-system license, if appropriate.
To use BYOL, you must have existing licenses with rights to use these licenses in a third party
- * cloud, such as Amazon Web Services. For more information, see Prerequisites in the
- * VM Import/Export User Guide.
The maximum number of results returned by GetVpnConnectionDeviceTypes in
+ * paginated output. When this parameter is used, GetVpnConnectionDeviceTypes
+ * only returns MaxResults results in a single page along with a
+ * NextToken response element. The remaining results of the initial
+ * request can be seen by sending another GetVpnConnectionDeviceTypes request
+ * with the returned NextToken value. This value can be between 200 and 1000.
+ * If this parameter is not used, then GetVpnConnectionDeviceTypes returns all
+ * results.
The operating system of the virtual machine.
- *Valid values: Windows | Linux
- *
The NextToken value returned from a previous paginated
+ * GetVpnConnectionDeviceTypes request where MaxResults was
+ * used and the results exceeded the value of that parameter. Pagination continues from the
+ * end of the previous results that returned the NextToken value. This value
+ * is null when there are no more results to return.
The name of the role to use when not using the default role, 'vmimport'.
+ *Checks whether you have the required permissions for the action, without actually
+ * making the request, and provides an error response. If you have the required
+ * permissions, the error response is DryRunOperation. Otherwise, it is
+ * UnauthorizedOperation.
The ARNs of the license configurations.
+ * @internal */ - LicenseSpecifications?: ImportImageLicenseConfigurationRequest[]; + export const filterSensitiveLog = (obj: GetVpnConnectionDeviceTypesRequest): any => ({ + ...obj, + }); +} +/** + *List of customer gateway devices that have a sample configuration file available for + * use. You can also see the list of device types with sample configuration files available + * under Your customer + * gateway device in the Amazon Web Services Site-to-Site VPN User Guide.
+ */ +export interface VpnConnectionDeviceType { /** - *The tags to apply to the import image task during creation.
+ *Customer gateway device identifier.
*/ - TagSpecifications?: TagSpecification[]; + VpnConnectionDeviceTypeId?: string; /** - *The usage operation value. For more information, see Licensing options in the VM Import/Export User Guide.
+ *Customer gateway device vendor.
*/ - UsageOperation?: string; + Vendor?: string; /** - *The boot mode of the virtual machine.
+ *Customer gateway device platform.
*/ - BootMode?: BootModeValues | string; + Platform?: string; + + /** + *Customer gateway device software version.
+ */ + Software?: string; } -export namespace ImportImageRequest { +export namespace VpnConnectionDeviceType { /** * @internal */ - export const filterSensitiveLog = (obj: ImportImageRequest): any => ({ + export const filterSensitiveLog = (obj: VpnConnectionDeviceType): any => ({ ...obj, }); } -export interface ImportImageResult { +export interface GetVpnConnectionDeviceTypesResult { /** - *The architecture of the virtual machine.
+ *List of customer gateway devices that have a sample configuration file available for + * use.
*/ - Architecture?: string; + VpnConnectionDeviceTypes?: VpnConnectionDeviceType[]; /** - *A description of the import task.
+ *The NextToken value to include in a future
+ * GetVpnConnectionDeviceTypes request. When the results of a
+ * GetVpnConnectionDeviceTypes request exceed MaxResults,
+ * this value can be used to retrieve the next page of results. This value is null when
+ * there are no more results to return.
Indicates whether the AMI is encrypted.
+ * @internal */ - Encrypted?: boolean; + export const filterSensitiveLog = (obj: GetVpnConnectionDeviceTypesResult): any => ({ + ...obj, + }); +} +export interface ImportClientVpnClientCertificateRevocationListRequest { /** - *The target hypervisor of the import task.
+ *The ID of the Client VPN endpoint to which the client certificate revocation list applies.
*/ - Hypervisor?: string; + ClientVpnEndpointId: string | undefined; /** - *The ID of the Amazon Machine Image (AMI) created by the import task.
+ *The client certificate revocation list file. For more information, see Generate a Client Certificate Revocation List in the + * Client VPN Administrator Guide.
*/ - ImageId?: string; + CertificateRevocationList: string | undefined; /** - *The task ID of the import image task.
+ *Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
The identifier for the symmetric KMS key that was used to create the encrypted AMI.
+ * @internal */ - KmsKeyId?: string; + export const filterSensitiveLog = (obj: ImportClientVpnClientCertificateRevocationListRequest): any => ({ + ...obj, + }); +} +export interface ImportClientVpnClientCertificateRevocationListResult { /** - *The license type of the virtual machine.
+ *Returns true if the request succeeds; otherwise, it returns an error.
The operating system of the virtual machine.
+ * @internal */ - Platform?: string; + export const filterSensitiveLog = (obj: ImportClientVpnClientCertificateRevocationListResult): any => ({ + ...obj, + }); +} +/** + *Describes the client-specific data.
+ */ +export interface ClientData { /** - *The progress of the task.
+ *A user-defined comment about the disk upload.
*/ - Progress?: string; + Comment?: string; /** - *Information about the snapshots.
+ *The time that the disk upload ends.
*/ - SnapshotDetails?: SnapshotDetail[]; + UploadEnd?: Date; /** - *A brief status of the task.
+ *The size of the uploaded disk image, in GiB.
*/ - Status?: string; + UploadSize?: number; /** - *A detailed status message of the import task.
+ *The time that the disk upload starts.
*/ - StatusMessage?: string; + UploadStart?: Date; +} +export namespace ClientData { /** - *The ARNs of the license configurations.
+ * @internal */ - LicenseSpecifications?: ImportImageLicenseConfigurationResponse[]; + export const filterSensitiveLog = (obj: ClientData): any => ({ + ...obj, + }); +} +/** + *Describes the Amazon S3 bucket for the disk image.
+ */ +export interface UserBucket { /** - *Any tags assigned to the import image task.
+ *The name of the Amazon S3 bucket where the disk image is located.
*/ - Tags?: Tag[]; + S3Bucket?: string; /** - *The usage operation value.
+ *The file name of the disk image.
*/ - UsageOperation?: string; + S3Key?: string; } -export namespace ImportImageResult { +export namespace UserBucket { /** * @internal */ - export const filterSensitiveLog = (obj: ImportImageResult): any => ({ + export const filterSensitiveLog = (obj: UserBucket): any => ({ ...obj, }); } /** - *Describes a disk image.
+ *Describes the disk container object for an import image task.
*/ -export interface DiskImageDetail { +export interface ImageDiskContainer { /** - *The size of the disk image, in GiB.
+ *The description of the disk image.
*/ - Bytes: number | undefined; + Description?: string; /** - *The disk image format.
+ *The block device mapping for the disk.
*/ - Format: DiskImageFormat | string | undefined; + DeviceName?: string; /** - *A presigned URL for the import manifest stored in Amazon S3 and presented here as an Amazon S3 presigned URL. - * For information about creating a presigned URL for an Amazon S3 object, read the "Query String Request Authentication - * Alternative" section of the Authenticating REST Requests topic in the Amazon Simple Storage Service Developer - * Guide.
- *For information about the import manifest referenced by this API action, see VM Import Manifest.
+ *The format of the disk image being imported.
+ *Valid values: OVA | VHD | VHDX | VMDK | RAW
+ *
The ID of the EBS snapshot to be used for importing the snapshot.
+ */ + SnapshotId?: string; + + /** + *The URL to the Amazon S3-based disk image being imported. The URL can either be a https URL (https://..) or an + * Amazon S3 URL (s3://..)
+ */ + Url?: string; + + /** + *The S3 bucket for the disk image.
+ */ + UserBucket?: UserBucket; } -export namespace DiskImageDetail { +export namespace ImageDiskContainer { /** * @internal */ - export const filterSensitiveLog = (obj: DiskImageDetail): any => ({ + export const filterSensitiveLog = (obj: ImageDiskContainer): any => ({ ...obj, }); } /** - *Describes an EBS volume.
+ *The request information of license configurations.
*/ -export interface VolumeDetail { +export interface ImportImageLicenseConfigurationRequest { /** - *The size of the volume, in GiB.
+ *The ARN of a license configuration.
*/ - Size: number | undefined; + LicenseConfigurationArn?: string; } -export namespace VolumeDetail { +export namespace ImportImageLicenseConfigurationRequest { /** * @internal */ - export const filterSensitiveLog = (obj: VolumeDetail): any => ({ + export const filterSensitiveLog = (obj: ImportImageLicenseConfigurationRequest): any => ({ ...obj, }); } -/** - *Describes a disk image.
- */ -export interface DiskImage { - /** - *A description of the disk image.
- */ - Description?: string; - +export interface ImportImageRequest { /** - *Information about the disk image.
+ *The architecture of the virtual machine.
+ *Valid values: i386 | x86_64
+ *
Information about the volume.
+ *The client-specific data.
*/ - Volume?: VolumeDetail; -} + ClientData?: ClientData; -export namespace DiskImage { /** - * @internal + *The token to enable idempotency for VM import requests.
*/ - export const filterSensitiveLog = (obj: DiskImage): any => ({ - ...obj, - }); -} + ClientToken?: string; -/** - *Describes the user data for an instance.
- */ -export interface UserData { /** - *The user data. If you are using an Amazon Web Services SDK or command line tool, Base64-encoding is performed for you, and you - * can load the text from a file. Otherwise, you must provide Base64-encoded text.
+ *A description string for the import image task.
*/ - Data?: string; -} + Description?: string; -export namespace UserData { /** - * @internal + *Information about the disk containers.
*/ - export const filterSensitiveLog = (obj: UserData): any => ({ - ...obj, - }); -} + DiskContainers?: ImageDiskContainer[]; -/** - *Describes the launch specification for VM import.
- */ -export interface ImportInstanceLaunchSpecification { /** - *Reserved.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The architecture of the instance.
+ *Specifies whether the destination AMI of the imported image should be encrypted. The default KMS key for EBS is used
+ * unless you specify a non-default KMS key using KmsKeyId. For more information, see Amazon EBS Encryption in the
+ * Amazon Elastic Compute Cloud User Guide.
The security group IDs.
+ *The target hypervisor platform.
+ *Valid values: xen
+ *
The security group names.
+ *An identifier for the symmetric KMS key to use when creating the
+ * encrypted AMI. This parameter is only required if you want to use a non-default KMS key; if this
+ * parameter is not specified, the default KMS key for EBS is used. If a KmsKeyId is
+ * specified, the Encrypted flag must also be set.
The KMS key identifier may be provided in any of the following formats:
+ *Key ID
+ *Key alias. The alias ARN contains the arn:aws:kms namespace, followed by the Region of the key, the Amazon Web Services account ID of the key owner, the alias namespace, and then the key alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
ARN using key ID. The ID ARN contains the arn:aws:kms namespace, followed by the Region of the key, the Amazon Web Services account ID of the key owner, the key namespace, and then the key ID. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.
ARN using key alias. The alias ARN contains the arn:aws:kms namespace, followed by the Region of the key, the Amazon Web Services account ID of the key owner, the alias namespace, and then the key alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
Amazon Web Services parses KmsKeyId asynchronously, meaning that the action you call may appear to complete even
+ * though you provided an invalid identifier. This action will eventually report failure.
The specified KMS key must exist in the Region that the AMI is being copied to.
+ *Amazon EBS does not support asymmetric KMS keys.
*/ - GroupNames?: string[]; + KmsKeyId?: string; /** - *Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the - * operating system command for system shutdown).
+ *The license type to be used for the Amazon Machine Image (AMI) after importing.
+ *By default, we detect the source-system operating system (OS) and apply the appropriate license. Specify
+ * AWS to replace the source-system license with an Amazon Web Services license, if appropriate. Specify BYOL
+ * to retain the source-system license, if appropriate.
To use BYOL, you must have existing licenses with rights to use these licenses in a third party
+ * cloud, such as Amazon Web Services. For more information, see Prerequisites in the
+ * VM Import/Export User Guide.
The instance type. For more information about the instance types that you can import, see Instance Types in the - * VM Import/Export User Guide.
+ *The operating system of the virtual machine.
+ *Valid values: Windows | Linux
+ *
Indicates whether monitoring is enabled.
+ *The name of the role to use when not using the default role, 'vmimport'.
*/ - Monitoring?: boolean; + RoleName?: string; /** - *The placement information for the instance.
+ *The ARNs of the license configurations.
*/ - Placement?: Placement; + LicenseSpecifications?: ImportImageLicenseConfigurationRequest[]; /** - *[EC2-VPC] An available IP address from the IP address range of the subnet.
+ *The tags to apply to the import image task during creation.
*/ - PrivateIpAddress?: string; + TagSpecifications?: TagSpecification[]; /** - *[EC2-VPC] The ID of the subnet in which to launch the instance.
+ *The usage operation value. For more information, see Licensing options in the VM Import/Export User Guide.
*/ - SubnetId?: string; + UsageOperation?: string; /** - *The Base64-encoded user data to make available to the instance.
+ *The boot mode of the virtual machine.
*/ - UserData?: UserData; + BootMode?: BootModeValues | string; } -export namespace ImportInstanceLaunchSpecification { +export namespace ImportImageRequest { /** * @internal */ - export const filterSensitiveLog = (obj: ImportInstanceLaunchSpecification): any => ({ + export const filterSensitiveLog = (obj: ImportImageRequest): any => ({ ...obj, - ...(obj.UserData && { UserData: SENSITIVE_STRING }), }); } -export interface ImportInstanceRequest { - /** - *A description for the instance being imported.
- */ - Description?: string; - +export interface ImportImageResult { /** - *The disk image.
+ *The architecture of the virtual machine.
*/ - DiskImages?: DiskImage[]; + Architecture?: string; /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
A description of the import task.
*/ - DryRun?: boolean; + Description?: string; /** - *The launch specification.
+ *Indicates whether the AMI is encrypted.
*/ - LaunchSpecification?: ImportInstanceLaunchSpecification; + Encrypted?: boolean; /** - *The instance operating system.
+ *The target hypervisor of the import task.
*/ - Platform: PlatformValues | string | undefined; -} + Hypervisor?: string; -export namespace ImportInstanceRequest { /** - * @internal + *The ID of the Amazon Machine Image (AMI) created by the import task.
*/ - export const filterSensitiveLog = (obj: ImportInstanceRequest): any => ({ - ...obj, - ...(obj.LaunchSpecification && { - LaunchSpecification: ImportInstanceLaunchSpecification.filterSensitiveLog(obj.LaunchSpecification), - }), - }); -} + ImageId?: string; -export interface ImportInstanceResult { /** - *Information about the conversion task.
+ *The task ID of the import image task.
*/ - ConversionTask?: ConversionTask; -} + ImportTaskId?: string; -export namespace ImportInstanceResult { /** - * @internal + *The identifier for the symmetric KMS key that was used to create the encrypted AMI.
*/ - export const filterSensitiveLog = (obj: ImportInstanceResult): any => ({ - ...obj, - }); -} + KmsKeyId?: string; -export interface ImportKeyPairRequest { /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The license type of the virtual machine.
*/ - DryRun?: boolean; + LicenseType?: string; /** - *A unique name for the key pair.
+ *The operating system of the virtual machine.
*/ - KeyName: string | undefined; + Platform?: string; /** - *The public key. For API calls, the text must be base64-encoded. For command line tools, base64 encoding is performed for you.
+ *The progress of the task.
*/ - PublicKeyMaterial: Uint8Array | undefined; + Progress?: string; /** - *The tags to apply to the imported key pair.
+ *Information about the snapshots.
*/ - TagSpecifications?: TagSpecification[]; -} + SnapshotDetails?: SnapshotDetail[]; -export namespace ImportKeyPairRequest { /** - * @internal + *A brief status of the task.
*/ - export const filterSensitiveLog = (obj: ImportKeyPairRequest): any => ({ - ...obj, - }); -} + Status?: string; -export interface ImportKeyPairResult { /** - *The MD5 public key fingerprint as specified in section 4 of RFC 4716.
+ *A detailed status message of the import task.
*/ - KeyFingerprint?: string; + StatusMessage?: string; /** - *The key pair name that you provided.
+ *The ARNs of the license configurations.
*/ - KeyName?: string; + LicenseSpecifications?: ImportImageLicenseConfigurationResponse[]; /** - *The ID of the resulting key pair.
+ *Any tags assigned to the import image task.
*/ - KeyPairId?: string; + Tags?: Tag[]; /** - *The tags applied to the imported key pair.
+ *The usage operation value.
*/ - Tags?: Tag[]; + UsageOperation?: string; } -export namespace ImportKeyPairResult { +export namespace ImportImageResult { /** * @internal */ - export const filterSensitiveLog = (obj: ImportKeyPairResult): any => ({ + export const filterSensitiveLog = (obj: ImportImageResult): any => ({ ...obj, }); } /** - *The disk container object for the import snapshot request.
+ *Describes a disk image.
*/ -export interface SnapshotDiskContainer { +export interface DiskImageDetail { /** - *The description of the disk image being imported.
+ *The size of the disk image, in GiB.
*/ - Description?: string; + Bytes: number | undefined; /** - *The format of the disk image being imported.
- *Valid values: VHD | VMDK | RAW
- *
The disk image format.
*/ - Format?: string; + Format: DiskImageFormat | string | undefined; /** - *The URL to the Amazon S3-based disk image being imported. It can either be a https URL (https://..) or an Amazon - * S3 URL (s3://..).
- */ - Url?: string; + *A presigned URL for the import manifest stored in Amazon S3 and presented here as an Amazon S3 presigned URL. + * For information about creating a presigned URL for an Amazon S3 object, read the "Query String Request Authentication + * Alternative" section of the Authenticating REST Requests topic in the Amazon Simple Storage Service Developer + * Guide.
+ *For information about the import manifest referenced by this API action, see VM Import Manifest.
+ */ + ImportManifestUrl: string | undefined; +} +export namespace DiskImageDetail { /** - *The Amazon S3 bucket for the disk image.
+ * @internal */ - UserBucket?: UserBucket; + export const filterSensitiveLog = (obj: DiskImageDetail): any => ({ + ...obj, + }); } -export namespace SnapshotDiskContainer { +/** + *Describes an EBS volume.
+ */ +export interface VolumeDetail { + /** + *The size of the volume, in GiB.
+ */ + Size: number | undefined; +} + +export namespace VolumeDetail { /** * @internal */ - export const filterSensitiveLog = (obj: SnapshotDiskContainer): any => ({ + export const filterSensitiveLog = (obj: VolumeDetail): any => ({ ...obj, }); } -export interface ImportSnapshotRequest { +/** + *Describes a disk image.
+ */ +export interface DiskImage { /** - *The client-specific data.
+ *A description of the disk image.
*/ - ClientData?: ClientData; + Description?: string; /** - *Token to enable idempotency for VM import requests.
+ *Information about the disk image.
*/ - ClientToken?: string; + Image?: DiskImageDetail; /** - *The description string for the import snapshot task.
+ *Information about the volume.
*/ - Description?: string; + Volume?: VolumeDetail; +} +export namespace DiskImage { /** - *Information about the disk container.
+ * @internal */ - DiskContainer?: SnapshotDiskContainer; + export const filterSensitiveLog = (obj: DiskImage): any => ({ + ...obj, + }); +} +/** + *Describes the user data for an instance.
+ */ +export interface UserData { /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The user data. If you are using an Amazon Web Services SDK or command line tool, Base64-encoding is performed for you, and you + * can load the text from a file. Otherwise, you must provide Base64-encoded text.
*/ - DryRun?: boolean; + Data?: string; +} +export namespace UserData { /** - *Specifies whether the destination snapshot of the imported image should be encrypted. The default KMS key for EBS is
- * used unless you specify a non-default KMS key using KmsKeyId. For more information, see Amazon EBS Encryption in the
- * Amazon Elastic Compute Cloud User Guide.
Describes the launch specification for VM import.
+ */ +export interface ImportInstanceLaunchSpecification { /** - *An identifier for the symmetric KMS key to use when creating the
- * encrypted snapshot. This parameter is only required if you want to use a non-default KMS key; if this
- * parameter is not specified, the default KMS key for EBS is used. If a KmsKeyId is
- * specified, the Encrypted flag must also be set.
The KMS key identifier may be provided in any of the following formats:
- *Key ID
- *Key alias. The alias ARN contains the arn:aws:kms namespace, followed by the Region of the key, the Amazon Web Services account ID of the key owner, the alias namespace, and then the key alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
ARN using key ID. The ID ARN contains the arn:aws:kms namespace, followed by the Region of the key, the Amazon Web Services account ID of the key owner, the key namespace, and then the key ID. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.
ARN using key alias. The alias ARN contains the arn:aws:kms namespace, followed by the Region of the key, the Amazon Web Services account ID of the key owner, the alias namespace, and then the key alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
Amazon Web Services parses KmsKeyId asynchronously, meaning that the action you call may appear to complete even
- * though you provided an invalid identifier. This action will eventually report failure.
The specified KMS key must exist in the Region that the snapshot is being copied to.
- *Amazon EBS does not support asymmetric KMS keys.
+ *Reserved.
*/ - KmsKeyId?: string; + AdditionalInfo?: string; /** - *The name of the role to use when not using the default role, 'vmimport'.
+ *The architecture of the instance.
*/ - RoleName?: string; + Architecture?: ArchitectureValues | string; /** - *The tags to apply to the import snapshot task during creation.
+ *The security group IDs.
*/ - TagSpecifications?: TagSpecification[]; -} + GroupIds?: string[]; -export namespace ImportSnapshotRequest { /** - * @internal + *The security group names.
*/ - export const filterSensitiveLog = (obj: ImportSnapshotRequest): any => ({ - ...obj, - }); -} + GroupNames?: string[]; -export interface ImportSnapshotResult { /** - *A description of the import snapshot task.
+ *Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the + * operating system command for system shutdown).
*/ - Description?: string; + InstanceInitiatedShutdownBehavior?: ShutdownBehavior | string; /** - *The ID of the import snapshot task.
+ *The instance type. For more information about the instance types that you can import, see Instance Types in the + * VM Import/Export User Guide.
*/ - ImportTaskId?: string; + InstanceType?: _InstanceType | string; /** - *Information about the import snapshot task.
+ *Indicates whether monitoring is enabled.
*/ - SnapshotTaskDetail?: SnapshotTaskDetail; + Monitoring?: boolean; /** - *Any tags assigned to the import snapshot task.
+ *The placement information for the instance.
*/ - Tags?: Tag[]; + Placement?: Placement; + + /** + *[EC2-VPC] An available IP address from the IP address range of the subnet.
+ */ + PrivateIpAddress?: string; + + /** + *[EC2-VPC] The ID of the subnet in which to launch the instance.
+ */ + SubnetId?: string; + + /** + *The Base64-encoded user data to make available to the instance.
+ */ + UserData?: UserData; } -export namespace ImportSnapshotResult { +export namespace ImportInstanceLaunchSpecification { /** * @internal */ - export const filterSensitiveLog = (obj: ImportSnapshotResult): any => ({ + export const filterSensitiveLog = (obj: ImportInstanceLaunchSpecification): any => ({ ...obj, + ...(obj.UserData && { UserData: SENSITIVE_STRING }), }); } -export interface ImportVolumeRequest { +export interface ImportInstanceRequest { /** - *The Availability Zone for the resulting EBS volume.
+ *A description for the instance being imported.
*/ - AvailabilityZone: string | undefined; + Description?: string; /** - *A description of the volume.
+ *The disk image.
*/ - Description?: string; + DiskImages?: DiskImage[]; /** *Checks whether you have the required permissions for the action, without actually making the request, @@ -2637,194 +2767,165 @@ export interface ImportVolumeRequest { DryRun?: boolean; /** - *
The disk image.
+ *The launch specification.
*/ - Image: DiskImageDetail | undefined; + LaunchSpecification?: ImportInstanceLaunchSpecification; /** - *The volume size.
+ *The instance operating system.
*/ - Volume: VolumeDetail | undefined; + Platform: PlatformValues | string | undefined; } -export namespace ImportVolumeRequest { +export namespace ImportInstanceRequest { /** * @internal */ - export const filterSensitiveLog = (obj: ImportVolumeRequest): any => ({ + export const filterSensitiveLog = (obj: ImportInstanceRequest): any => ({ ...obj, + ...(obj.LaunchSpecification && { + LaunchSpecification: ImportInstanceLaunchSpecification.filterSensitiveLog(obj.LaunchSpecification), + }), }); } -export interface ImportVolumeResult { +export interface ImportInstanceResult { /** *Information about the conversion task.
*/ ConversionTask?: ConversionTask; } -export namespace ImportVolumeResult { +export namespace ImportInstanceResult { /** * @internal */ - export const filterSensitiveLog = (obj: ImportVolumeResult): any => ({ + export const filterSensitiveLog = (obj: ImportInstanceResult): any => ({ ...obj, }); } -export interface ListSnapshotsInRecycleBinRequest { +export interface ImportKeyPairRequest { /** - *The maximum number of results to return with a single call.
- * To retrieve the remaining results, make another call with the returned nextToken value.
Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The token for the next page of results.
+ *A unique name for the key pair.
*/ - NextToken?: string; + KeyName: string | undefined; /** - *The IDs of the snapshots to list. Omit this parameter to list all of the - * snapshots that are in the Recycle Bin.
+ *The public key. For API calls, the text must be base64-encoded. For command line tools, base64 encoding is performed for you.
*/ - SnapshotIds?: string[]; + PublicKeyMaterial: Uint8Array | undefined; /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The tags to apply to the imported key pair.
*/ - DryRun?: boolean; + TagSpecifications?: TagSpecification[]; } -export namespace ListSnapshotsInRecycleBinRequest { +export namespace ImportKeyPairRequest { /** * @internal */ - export const filterSensitiveLog = (obj: ListSnapshotsInRecycleBinRequest): any => ({ + export const filterSensitiveLog = (obj: ImportKeyPairRequest): any => ({ ...obj, }); } -/** - *Information about a snapshot that is currently in the Recycle Bin.
- */ -export interface SnapshotRecycleBinInfo { - /** - *The ID of the snapshot.
- */ - SnapshotId?: string; - +export interface ImportKeyPairResult { /** - *The date and time when the snaphsot entered the Recycle Bin.
+ *The MD5 public key fingerprint as specified in section 4 of RFC 4716.
*/ - RecycleBinEnterTime?: Date; + KeyFingerprint?: string; /** - *The date and time when the snapshot is to be permanently deleted from the Recycle Bin.
+ *The key pair name that you provided.
*/ - RecycleBinExitTime?: Date; + KeyName?: string; /** - *The description for the snapshot.
+ *The ID of the resulting key pair.
*/ - Description?: string; + KeyPairId?: string; /** - *The ID of the volume from which the snapshot was created.
+ *The tags applied to the imported key pair.
*/ - VolumeId?: string; + Tags?: Tag[]; } -export namespace SnapshotRecycleBinInfo { +export namespace ImportKeyPairResult { /** * @internal */ - export const filterSensitiveLog = (obj: SnapshotRecycleBinInfo): any => ({ + export const filterSensitiveLog = (obj: ImportKeyPairResult): any => ({ ...obj, }); } -export interface ListSnapshotsInRecycleBinResult { - /** - *Information about the snapshots.
- */ - Snapshots?: SnapshotRecycleBinInfo[]; - - /** - *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The disk container object for the import snapshot request.
+ */ +export interface SnapshotDiskContainer { /** - * @internal + *The description of the disk image being imported.
*/ - export const filterSensitiveLog = (obj: ListSnapshotsInRecycleBinResult): any => ({ - ...obj, - }); -} + Description?: string; -export interface ModifyAddressAttributeRequest { /** - *[EC2-VPC] The allocation ID.
+ *The format of the disk image being imported.
+ *Valid values: VHD | VMDK | RAW
+ *
The domain name to modify for the IP address.
+ *The URL to the Amazon S3-based disk image being imported. It can either be a https URL (https://..) or an Amazon + * S3 URL (s3://..).
*/ - DomainName?: string; + Url?: string; /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The Amazon S3 bucket for the disk image.
*/ - DryRun?: boolean; + UserBucket?: UserBucket; } -export namespace ModifyAddressAttributeRequest { +export namespace SnapshotDiskContainer { /** * @internal */ - export const filterSensitiveLog = (obj: ModifyAddressAttributeRequest): any => ({ + export const filterSensitiveLog = (obj: SnapshotDiskContainer): any => ({ ...obj, }); } -export interface ModifyAddressAttributeResult { +export interface ImportSnapshotRequest { /** - *Information about the Elastic IP address.
+ *The client-specific data.
*/ - Address?: AddressAttribute; -} + ClientData?: ClientData; -export namespace ModifyAddressAttributeResult { /** - * @internal + *Token to enable idempotency for VM import requests.
*/ - export const filterSensitiveLog = (obj: ModifyAddressAttributeResult): any => ({ - ...obj, - }); -} - -export type ModifyAvailabilityZoneOptInStatus = "not-opted-in" | "opted-in"; + ClientToken?: string; -export interface ModifyAvailabilityZoneGroupRequest { /** - *The name of the Availability Zone group, Local Zone group, or Wavelength Zone - * group.
+ *The description string for the import snapshot task.
*/ - GroupName: string | undefined; + Description?: string; /** - *Indicates whether you are opted in to the Local Zone group or Wavelength Zone group. The
- * only valid value is opted-in. You must contact Amazon Web Services Support to opt out of a Local Zone or Wavelength Zone group.
Information about the disk container.
*/ - OptInStatus: ModifyAvailabilityZoneOptInStatus | string | undefined; + DiskContainer?: SnapshotDiskContainer; /** *Checks whether you have the required permissions for the action, without actually making the request,
@@ -2832,1966 +2933,1616 @@ export interface ModifyAvailabilityZoneGroupRequest {
* Otherwise, it is UnauthorizedOperation.
Specifies whether the destination snapshot of the imported image should be encrypted. The default KMS key for EBS is
+ * used unless you specify a non-default KMS key using KmsKeyId. For more information, see Amazon EBS Encryption in the
+ * Amazon Elastic Compute Cloud User Guide.
Is true if the request succeeds, and an error otherwise.
An identifier for the symmetric KMS key to use when creating the
+ * encrypted snapshot. This parameter is only required if you want to use a non-default KMS key; if this
+ * parameter is not specified, the default KMS key for EBS is used. If a KmsKeyId is
+ * specified, the Encrypted flag must also be set.
The KMS key identifier may be provided in any of the following formats:
+ *Key ID
+ *Key alias. The alias ARN contains the arn:aws:kms namespace, followed by the Region of the key, the Amazon Web Services account ID of the key owner, the alias namespace, and then the key alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
ARN using key ID. The ID ARN contains the arn:aws:kms namespace, followed by the Region of the key, the Amazon Web Services account ID of the key owner, the key namespace, and then the key ID. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.
ARN using key alias. The alias ARN contains the arn:aws:kms namespace, followed by the Region of the key, the Amazon Web Services account ID of the key owner, the alias namespace, and then the key alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
Amazon Web Services parses KmsKeyId asynchronously, meaning that the action you call may appear to complete even
+ * though you provided an invalid identifier. This action will eventually report failure.
The specified KMS key must exist in the Region that the snapshot is being copied to.
+ *Amazon EBS does not support asymmetric KMS keys.
*/ - Return?: boolean; + KmsKeyId?: string; + + /** + *The name of the role to use when not using the default role, 'vmimport'.
+ */ + RoleName?: string; + + /** + *The tags to apply to the import snapshot task during creation.
+ */ + TagSpecifications?: TagSpecification[]; } -export namespace ModifyAvailabilityZoneGroupResult { +export namespace ImportSnapshotRequest { /** * @internal */ - export const filterSensitiveLog = (obj: ModifyAvailabilityZoneGroupResult): any => ({ + export const filterSensitiveLog = (obj: ImportSnapshotRequest): any => ({ ...obj, }); } -export interface ModifyCapacityReservationRequest { +export interface ImportSnapshotResult { /** - *The ID of the Capacity Reservation.
+ *A description of the import snapshot task.
*/ - CapacityReservationId: string | undefined; + Description?: string; /** - *The number of instances for which to reserve capacity. The number of instances can't be increased or
- * decreased by more than 1000 in a single request.
The ID of the import snapshot task.
*/ - InstanceCount?: number; + ImportTaskId?: string; /** - *The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved capacity
- * is released and you can no longer launch instances into it. The Capacity Reservation's state changes to
- * expired when it reaches its end date and time.
The Capacity Reservation is cancelled within an hour from the specified time. For example, if you specify - * 5/31/2019, 13:30:55, the Capacity Reservation is guaranteed to end between 13:30:55 and 14:30:55 on 5/31/2019.
- *You must provide an EndDate value if EndDateType is
- * limited. Omit EndDate if EndDateType is
- * unlimited.
Information about the import snapshot task.
*/ - EndDate?: Date; + SnapshotTaskDetail?: SnapshotTaskDetail; /** - *Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end - * types:
- *
- * unlimited - The Capacity Reservation remains active until you explicitly cancel it. Do not
- * provide an EndDate value if EndDateType is
- * unlimited.
- * limited - The Capacity Reservation expires automatically at a specified date and time. You must
- * provide an EndDate value if EndDateType is
- * limited.
Any tags assigned to the import snapshot task.
*/ - EndDateType?: EndDateType | string; + Tags?: Tag[]; +} +export namespace ImportSnapshotResult { /** - *Reserved. Capacity Reservations you have created are accepted by default.
+ * @internal */ - Accept?: boolean; + export const filterSensitiveLog = (obj: ImportSnapshotResult): any => ({ + ...obj, + }); +} +export interface ImportVolumeRequest { /** - *Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
The Availability Zone for the resulting EBS volume.
+ */ + AvailabilityZone: string | undefined; + + /** + *A description of the volume.
+ */ + Description?: string; + + /** + *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Reserved for future use.
+ *The disk image.
*/ - AdditionalInfo?: string; + Image: DiskImageDetail | undefined; + + /** + *The volume size.
+ */ + Volume: VolumeDetail | undefined; } -export namespace ModifyCapacityReservationRequest { +export namespace ImportVolumeRequest { /** * @internal */ - export const filterSensitiveLog = (obj: ModifyCapacityReservationRequest): any => ({ + export const filterSensitiveLog = (obj: ImportVolumeRequest): any => ({ ...obj, }); } -export interface ModifyCapacityReservationResult { +export interface ImportVolumeResult { /** - *Returns true if the request succeeds; otherwise, it returns an error.
Information about the conversion task.
*/ - Return?: boolean; + ConversionTask?: ConversionTask; } -export namespace ModifyCapacityReservationResult { +export namespace ImportVolumeResult { /** * @internal */ - export const filterSensitiveLog = (obj: ModifyCapacityReservationResult): any => ({ + export const filterSensitiveLog = (obj: ImportVolumeResult): any => ({ ...obj, }); } -export interface ModifyCapacityReservationFleetRequest { +export interface ListSnapshotsInRecycleBinRequest { /** - *The ID of the Capacity Reservation Fleet to modify.
+ *The maximum number of results to return with a single call.
+ * To retrieve the remaining results, make another call with the returned nextToken value.
The total number of capacity units to be reserved by the Capacity Reservation Fleet. This value, - * together with the instance type weights that you assign to each instance type used by the Fleet - * determine the number of instances for which the Fleet reserves capacity. Both values are based on - * units that make sense for your workload. For more information, see Total target capacity - * in the Amazon EC2 User Guide.
+ *The token for the next page of results.
*/ - TotalTargetCapacity?: number; + NextToken?: string; /** - *The date and time at which the Capacity Reservation Fleet expires. When the Capacity Reservation
- * Fleet expires, its state changes to expired and all of the Capacity Reservations in the
- * Fleet expire.
The Capacity Reservation Fleet expires within an hour after the specified time. For example, if you
- * specify 5/31/2019, 13:30:55, the Capacity Reservation Fleet is guaranteed
- * to expire between 13:30:55 and 14:30:55 on 5/31/2019.
You can't specify EndDate and - * RemoveEndDate in the same request.
+ *The IDs of the snapshots to list. Omit this parameter to list all of the + * snapshots that are in the Recycle Bin.
*/ - EndDate?: Date; + SnapshotIds?: string[]; /** - *Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Indicates whether to remove the end date from the Capacity Reservation Fleet. If you remove the - * end date, the Capacity Reservation Fleet does not expire and it remains active until you explicitly - * cancel it using the CancelCapacityReservationFleet action.
- *You can't specify RemoveEndDate and - * EndDate in the same request.
- */ - RemoveEndDate?: boolean; } -export namespace ModifyCapacityReservationFleetRequest { +export namespace ListSnapshotsInRecycleBinRequest { /** * @internal */ - export const filterSensitiveLog = (obj: ModifyCapacityReservationFleetRequest): any => ({ - ...obj, - }); -} - -export interface ModifyCapacityReservationFleetResult { - /** - *Returns true if the request succeeds; otherwise, it returns an error.
Information about the DNS server to be used.
+ *Information about a snapshot that is currently in the Recycle Bin.
*/ -export interface DnsServersOptionsModifyStructure { - /** - *The IPv4 address range, in CIDR notation, of the DNS servers to be used. You can specify up to - * two DNS servers. Ensure that the DNS servers can be reached by the clients. The specified values - * overwrite the existing values.
- */ - CustomDnsServers?: string[]; - - /** - *Indicates whether DNS servers should be used. Specify False to delete the existing DNS
- * servers.
The ID of the Client VPN endpoint to modify.
+ *The ID of the snapshot.
*/ - ClientVpnEndpointId: string | undefined; + SnapshotId?: string; /** - *The ARN of the server certificate to be used. The server certificate must be provisioned in - * Certificate Manager (ACM).
+ *The date and time when the snaphsot entered the Recycle Bin.
*/ - ServerCertificateArn?: string; + RecycleBinEnterTime?: Date; /** - *Information about the client connection logging options.
- *If you enable client connection logging, data about client connections is sent to a - * Cloudwatch Logs log stream. The following information is logged:
- *Client connection requests
- *Client connection results (successful and unsuccessful)
- *Reasons for unsuccessful client connection requests
- *Client connection termination time
- *The date and time when the snapshot is to be permanently deleted from the Recycle Bin.
*/ - ConnectionLogOptions?: ConnectionLogOptions; + RecycleBinExitTime?: Date; /** - *Information about the DNS servers to be used by Client VPN connections. A Client VPN endpoint can have - * up to two DNS servers.
+ *The description for the snapshot.
*/ - DnsServers?: DnsServersOptionsModifyStructure; + Description?: string; /** - *The port number to assign to the Client VPN endpoint for TCP and UDP traffic.
- *Valid Values: 443 | 1194
- *
Default Value: 443
- *
The ID of the volume from which the snapshot was created.
*/ - VpnPort?: number; + VolumeId?: string; +} +export namespace SnapshotRecycleBinInfo { /** - *A brief description of the Client VPN endpoint.
+ * @internal */ - Description?: string; + export const filterSensitiveLog = (obj: SnapshotRecycleBinInfo): any => ({ + ...obj, + }); +} +export interface ListSnapshotsInRecycleBinResult { /** - *Indicates whether the VPN is split-tunnel.
- *For information about split-tunnel VPN endpoints, see Split-tunnel Client VPN endpoint in the - * Client VPN Administrator Guide.
+ *Information about the snapshots.
*/ - SplitTunnel?: boolean; + Snapshots?: SnapshotRecycleBinInfo[]; /** - *Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The IDs of one or more security groups to apply to the target network.
+ * @internal */ - SecurityGroupIds?: string[]; + export const filterSensitiveLog = (obj: ListSnapshotsInRecycleBinResult): any => ({ + ...obj, + }); +} +export interface ModifyAddressAttributeRequest { /** - *The ID of the VPC to associate with the Client VPN endpoint.
+ *[EC2-VPC] The allocation ID.
*/ - VpcId?: string; + AllocationId: string | undefined; /** - *Specify whether to enable the self-service portal for the Client VPN endpoint.
+ *The domain name to modify for the IP address.
*/ - SelfServicePortal?: SelfServicePortal | string; + DomainName?: string; /** - *The options for managing connection authorization for new client connections.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Returns true if the request succeeds; otherwise, it returns an error.
Information about the Elastic IP address.
*/ - Return?: boolean; + Address?: AddressAttribute; } -export namespace ModifyClientVpnEndpointResult { +export namespace ModifyAddressAttributeResult { /** * @internal */ - export const filterSensitiveLog = (obj: ModifyClientVpnEndpointResult): any => ({ + export const filterSensitiveLog = (obj: ModifyAddressAttributeResult): any => ({ ...obj, }); } -export interface ModifyDefaultCreditSpecificationRequest { +export type ModifyAvailabilityZoneOptInStatus = "not-opted-in" | "opted-in"; + +export interface ModifyAvailabilityZoneGroupRequest { /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The name of the Availability Zone group, Local Zone group, or Wavelength Zone + * group.
*/ - DryRun?: boolean; + GroupName: string | undefined; /** - *The instance family.
+ *Indicates whether you are opted in to the Local Zone group or Wavelength Zone group. The
+ * only valid value is opted-in. You must contact Amazon Web Services Support to opt out of a Local Zone or Wavelength Zone group.
The credit option for CPU usage of the instance family.
- *Valid Values: standard | unlimited
- *
Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The default credit option for CPU usage of the instance family.
+ *Is true if the request succeeds, and an error otherwise.
The identifier of the Key Management Service (KMS) KMS key to use for Amazon EBS encryption.
- * If this parameter is not specified, your KMS key for Amazon EBS is used. If KmsKeyId is
- * specified, the encrypted state must be true.
You can specify the KMS key using any of the following:
- *Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.
- *Key alias. For example, alias/ExampleAlias.
- *The ID of the Capacity Reservation.
+ */ + CapacityReservationId: string | undefined; + + /** + *The number of instances for which to reserve capacity. The number of instances can't be increased or
+ * decreased by more than 1000 in a single request.
The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved capacity
+ * is released and you can no longer launch instances into it. The Capacity Reservation's state changes to
+ * expired when it reaches its end date and time.
The Capacity Reservation is cancelled within an hour from the specified time. For example, if you specify + * 5/31/2019, 13:30:55, the Capacity Reservation is guaranteed to end between 13:30:55 and 14:30:55 on 5/31/2019.
+ *You must provide an EndDate value if EndDateType is
+ * limited. Omit EndDate if EndDateType is
+ * unlimited.
Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end + * types:
+ *Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab.
+ *
+ * unlimited - The Capacity Reservation remains active until you explicitly cancel it. Do not
+ * provide an EndDate value if EndDateType is
+ * unlimited.
Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
+ *
+ * limited - The Capacity Reservation expires automatically at a specified date and time. You must
+ * provide an EndDate value if EndDateType is
+ * limited.
Amazon Web Services authenticates the KMS key asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, - * the action can appear to complete, but eventually fails.
- *Amazon EBS does not support asymmetric KMS keys.
*/ - KmsKeyId: string | undefined; + EndDateType?: EndDateType | string; /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
Reserved. Capacity Reservations you have created are accepted by default.
+ */ + Accept?: boolean; + + /** + *Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Reserved for future use.
+ */ + AdditionalInfo?: string; } -export namespace ModifyEbsDefaultKmsKeyIdRequest { +export namespace ModifyCapacityReservationRequest { /** * @internal */ - export const filterSensitiveLog = (obj: ModifyEbsDefaultKmsKeyIdRequest): any => ({ + export const filterSensitiveLog = (obj: ModifyCapacityReservationRequest): any => ({ ...obj, }); } -export interface ModifyEbsDefaultKmsKeyIdResult { +export interface ModifyCapacityReservationResult { /** - *The Amazon Resource Name (ARN) of the default KMS key for encryption by default.
+ *Returns true if the request succeeds; otherwise, it returns an error.
Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
Indicates whether running instances should be terminated if the total target capacity of - * the EC2 Fleet is decreased below the current size of the EC2 Fleet.
+ *The ID of the Capacity Reservation Fleet to modify.
*/ - ExcessCapacityTerminationPolicy?: FleetExcessCapacityTerminationPolicy | string; + CapacityReservationFleetId: string | undefined; /** - *The launch template and overrides.
+ *The total number of capacity units to be reserved by the Capacity Reservation Fleet. This value, + * together with the instance type weights that you assign to each instance type used by the Fleet + * determine the number of instances for which the Fleet reserves capacity. Both values are based on + * units that make sense for your workload. For more information, see Total target capacity + * in the Amazon EC2 User Guide.
*/ - LaunchTemplateConfigs?: FleetLaunchTemplateConfigRequest[]; + TotalTargetCapacity?: number; /** - *The ID of the EC2 Fleet.
+ *The date and time at which the Capacity Reservation Fleet expires. When the Capacity Reservation
+ * Fleet expires, its state changes to expired and all of the Capacity Reservations in the
+ * Fleet expire.
The Capacity Reservation Fleet expires within an hour after the specified time. For example, if you
+ * specify 5/31/2019, 13:30:55, the Capacity Reservation Fleet is guaranteed
+ * to expire between 13:30:55 and 14:30:55 on 5/31/2019.
You can't specify EndDate and + * RemoveEndDate in the same request.
*/ - FleetId: string | undefined; + EndDate?: Date; /** - *The size of the EC2 Fleet.
+ *Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Reserved.
+ *Indicates whether to remove the end date from the Capacity Reservation Fleet. If you remove the + * end date, the Capacity Reservation Fleet does not expire and it remains active until you explicitly + * cancel it using the CancelCapacityReservationFleet action.
+ *You can't specify RemoveEndDate and + * EndDate in the same request.
*/ - Context?: string; + RemoveEndDate?: boolean; } -export namespace ModifyFleetRequest { +export namespace ModifyCapacityReservationFleetRequest { /** * @internal */ - export const filterSensitiveLog = (obj: ModifyFleetRequest): any => ({ + export const filterSensitiveLog = (obj: ModifyCapacityReservationFleetRequest): any => ({ ...obj, }); } -export interface ModifyFleetResult { +export interface ModifyCapacityReservationFleetResult { /** - *Is true if the request succeeds, and an error otherwise.
Returns true if the request succeeds; otherwise, it returns an error.
Describes a load permission.
+ *Information about the DNS server to be used.
*/ -export interface LoadPermissionRequest { +export interface DnsServersOptionsModifyStructure { /** - *The name of the group.
+ *The IPv4 address range, in CIDR notation, of the DNS servers to be used. You can specify up to + * two DNS servers. Ensure that the DNS servers can be reached by the clients. The specified values + * overwrite the existing values.
*/ - Group?: PermissionGroup | string; + CustomDnsServers?: string[]; /** - *The Amazon Web Services account ID.
+ *Indicates whether DNS servers should be used. Specify False to delete the existing DNS
+ * servers.
Describes modifications to the load permissions of an Amazon FPGA image (AFI).
- */ -export interface LoadPermissionModifications { +export interface ModifyClientVpnEndpointRequest { /** - *The load permissions to add.
+ *The ID of the Client VPN endpoint to modify.
*/ - Add?: LoadPermissionRequest[]; + ClientVpnEndpointId: string | undefined; /** - *The load permissions to remove.
+ *The ARN of the server certificate to be used. The server certificate must be provisioned in + * Certificate Manager (ACM).
*/ - Remove?: LoadPermissionRequest[]; -} + ServerCertificateArn?: string; -export namespace LoadPermissionModifications { /** - * @internal + *Information about the client connection logging options.
+ *If you enable client connection logging, data about client connections is sent to a + * Cloudwatch Logs log stream. The following information is logged:
+ *Client connection requests
+ *Client connection results (successful and unsuccessful)
+ *Reasons for unsuccessful client connection requests
+ *Client connection termination time
+ *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
Information about the DNS servers to be used by Client VPN connections. A Client VPN endpoint can have + * up to two DNS servers.
*/ - DryRun?: boolean; + DnsServers?: DnsServersOptionsModifyStructure; /** - *The ID of the AFI.
+ *The port number to assign to the Client VPN endpoint for TCP and UDP traffic.
+ *Valid Values: 443 | 1194
+ *
Default Value: 443
+ *
The name of the attribute.
+ *A brief description of the Client VPN endpoint.
*/ - Attribute?: FpgaImageAttributeName | string; + Description?: string; /** - *The operation type.
+ *Indicates whether the VPN is split-tunnel.
+ *For information about split-tunnel VPN endpoints, see Split-tunnel Client VPN endpoint in the + * Client VPN Administrator Guide.
*/ - OperationType?: OperationType | string; + SplitTunnel?: boolean; /** - *The Amazon Web Services account IDs. This parameter is valid only when modifying the loadPermission attribute.
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
The user groups. This parameter is valid only when modifying the loadPermission attribute.
The IDs of one or more security groups to apply to the target network.
*/ - UserGroups?: string[]; + SecurityGroupIds?: string[]; /** - *The product codes. After you add a product code to an AFI, it can't be removed.
- * This parameter is valid only when modifying the productCodes attribute.
The ID of the VPC to associate with the Client VPN endpoint.
*/ - ProductCodes?: string[]; + VpcId?: string; /** - *The load permission for the AFI.
+ *Specify whether to enable the self-service portal for the Client VPN endpoint.
*/ - LoadPermission?: LoadPermissionModifications; + SelfServicePortal?: SelfServicePortal | string; /** - *A description for the AFI.
+ *The options for managing connection authorization for new client connections.
*/ - Description?: string; + ClientConnectOptions?: ClientConnectOptions; - /** - *A name for the AFI.
- */ - Name?: string; + SessionTimeoutHours?: number; + ClientLoginBannerOptions?: ClientLoginBannerOptions; } -export namespace ModifyFpgaImageAttributeRequest { +export namespace ModifyClientVpnEndpointRequest { /** * @internal */ - export const filterSensitiveLog = (obj: ModifyFpgaImageAttributeRequest): any => ({ + export const filterSensitiveLog = (obj: ModifyClientVpnEndpointRequest): any => ({ ...obj, }); } -export interface ModifyFpgaImageAttributeResult { +export interface ModifyClientVpnEndpointResult { /** - *Information about the attribute.
+ *Returns true if the request succeeds; otherwise, it returns an error.
Specify whether to enable or disable auto-placement.
- */ - AutoPlacement?: AutoPlacement | string; - - /** - *The IDs of the Dedicated Hosts to modify.
- */ - HostIds: string[] | undefined; - +export interface ModifyDefaultCreditSpecificationRequest { /** - *Indicates whether to enable or disable host recovery for the Dedicated Host. For more information, - * see - * Host recovery in the Amazon EC2 User Guide.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Specifies the instance type to be supported by the Dedicated Host. Specify this parameter to - * modify a Dedicated Host to support only a specific instance type.
- * - *If you want to modify a Dedicated Host to support multiple instance types in its current instance - * family, omit this parameter and specify InstanceFamily - * instead. You cannot specify InstanceType and - * InstanceFamily in the same request.
+ *The instance family.
*/ - InstanceType?: string; + InstanceFamily: UnlimitedSupportedInstanceFamily | string | undefined; /** - *Specifies the instance family to be supported by the Dedicated Host. Specify this parameter - * to modify a Dedicated Host to support multiple instance types within its current - * instance family.
- * - *If you want to modify a Dedicated Host to support a specific instance type only, omit this parameter - * and specify InstanceType instead. You cannot specify - * InstanceFamily and InstanceType - * in the same request.
+ *The credit option for CPU usage of the instance family.
+ *Valid Values: standard | unlimited
+ *
The IDs of the Dedicated Hosts that were successfully modified.
- */ - Successful?: string[]; - +export interface ModifyDefaultCreditSpecificationResult { /** - *The IDs of the Dedicated Hosts that could not be modified. Check whether the - * setting you requested can be used.
+ *The default credit option for CPU usage of the instance family.
*/ - Unsuccessful?: UnsuccessfulItem[]; + InstanceFamilyCreditSpecification?: InstanceFamilyCreditSpecification; } -export namespace ModifyHostsResult { +export namespace ModifyDefaultCreditSpecificationResult { /** * @internal */ - export const filterSensitiveLog = (obj: ModifyHostsResult): any => ({ + export const filterSensitiveLog = (obj: ModifyDefaultCreditSpecificationResult): any => ({ ...obj, }); } -export interface ModifyIdentityIdFormatRequest { +export interface ModifyEbsDefaultKmsKeyIdRequest { /** - *The ARN of the principal, which can be an IAM user, IAM role, or the root user. Specify
- * all to modify the ID format for all IAM users, IAM roles, and the root user of
- * the account.
The identifier of the Key Management Service (KMS) KMS key to use for Amazon EBS encryption.
+ * If this parameter is not specified, your KMS key for Amazon EBS is used. If KmsKeyId is
+ * specified, the encrypted state must be true.
You can specify the KMS key using any of the following:
+ *Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.
+ *Key alias. For example, alias/ExampleAlias.
+ *Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab.
+ *Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
+ *Amazon Web Services authenticates the KMS key asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, + * the action can appear to complete, but eventually fails.
+ *Amazon EBS does not support asymmetric KMS keys.
*/ - PrincipalArn: string | undefined; + KmsKeyId: string | undefined; /** - *The type of resource: bundle | conversion-task | customer-gateway | dhcp-options |
- * elastic-ip-allocation | elastic-ip-association |
- * export-task | flow-log | image |
- * import-task | internet-gateway | network-acl
- * | network-acl-association | network-interface |
- * network-interface-attachment | prefix-list |
- * route-table | route-table-association |
- * security-group | subnet |
- * subnet-cidr-block-association | vpc |
- * vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway.
Alternatively, use the all-current option to include all resource types that are
- * currently within their opt-in period for longer IDs.
Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Indicates whether the resource should use longer IDs (17-character IDs)
+ * @internal */ - UseLongIds: boolean | undefined; + export const filterSensitiveLog = (obj: ModifyEbsDefaultKmsKeyIdRequest): any => ({ + ...obj, + }); } -export namespace ModifyIdentityIdFormatRequest { +export interface ModifyEbsDefaultKmsKeyIdResult { + /** + *The Amazon Resource Name (ARN) of the default KMS key for encryption by default.
+ */ + KmsKeyId?: string; +} + +export namespace ModifyEbsDefaultKmsKeyIdResult { /** * @internal */ - export const filterSensitiveLog = (obj: ModifyIdentityIdFormatRequest): any => ({ + export const filterSensitiveLog = (obj: ModifyEbsDefaultKmsKeyIdResult): any => ({ ...obj, }); } -export interface ModifyIdFormatRequest { +export interface ModifyFleetRequest { /** - *The type of resource: bundle | conversion-task | customer-gateway | dhcp-options |
- * elastic-ip-allocation | elastic-ip-association |
- * export-task | flow-log | image |
- * import-task | internet-gateway | network-acl
- * | network-acl-association | network-interface |
- * network-interface-attachment | prefix-list |
- * route-table | route-table-association |
- * security-group | subnet |
- * subnet-cidr-block-association | vpc |
- * vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway.
Alternatively, use the all-current option to include all resource types that are
- * currently within their opt-in period for longer IDs.
Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Indicate whether the resource should use longer IDs (17-character IDs).
+ *Indicates whether running instances should be terminated if the total target capacity of + * the EC2 Fleet is decreased below the current size of the EC2 Fleet.
*/ - UseLongIds: boolean | undefined; + ExcessCapacityTerminationPolicy?: FleetExcessCapacityTerminationPolicy | string; + + /** + *The launch template and overrides.
+ */ + LaunchTemplateConfigs?: FleetLaunchTemplateConfigRequest[]; + + /** + *The ID of the EC2 Fleet.
+ */ + FleetId: string | undefined; + + /** + *The size of the EC2 Fleet.
+ */ + TargetCapacitySpecification?: TargetCapacitySpecificationRequest; + + /** + *Reserved.
+ */ + Context?: string; } -export namespace ModifyIdFormatRequest { +export namespace ModifyFleetRequest { /** * @internal */ - export const filterSensitiveLog = (obj: ModifyIdFormatRequest): any => ({ + export const filterSensitiveLog = (obj: ModifyFleetRequest): any => ({ + ...obj, + }); +} + +export interface ModifyFleetResult { + /** + *Is true if the request succeeds, and an error otherwise.
Describes a launch permission modification.
+ *Describes a load permission.
*/ -export interface LaunchPermissionModifications { +export interface LoadPermissionRequest { /** - *The Amazon Web Services account ID, organization ARN, or OU ARN to add to the list of launch permissions for the AMI.
+ *The name of the group.
*/ - Add?: LaunchPermission[]; + Group?: PermissionGroup | string; /** - *The Amazon Web Services account ID, organization ARN, or OU ARN to remove from the list of launch permissions for the AMI.
+ *The Amazon Web Services account ID.
*/ - Remove?: LaunchPermission[]; + UserId?: string; } -export namespace LaunchPermissionModifications { +export namespace LoadPermissionRequest { /** * @internal */ - export const filterSensitiveLog = (obj: LaunchPermissionModifications): any => ({ + export const filterSensitiveLog = (obj: LoadPermissionRequest): any => ({ ...obj, }); } /** - *Contains the parameters for ModifyImageAttribute.
+ *Describes modifications to the load permissions of an Amazon FPGA image (AFI).
*/ -export interface ModifyImageAttributeRequest { +export interface LoadPermissionModifications { /** - *The name of the attribute to modify.
- *Valid values: description | launchPermission
- *
The load permissions to add.
*/ - Attribute?: string; + Add?: LoadPermissionRequest[]; /** - *A new description for the AMI.
+ *The load permissions to remove.
*/ - Description?: AttributeValue; + Remove?: LoadPermissionRequest[]; +} +export namespace LoadPermissionModifications { /** - *The ID of the AMI.
+ * @internal */ - ImageId: string | undefined; + export const filterSensitiveLog = (obj: LoadPermissionModifications): any => ({ + ...obj, + }); +} + +export type OperationType = "add" | "remove"; +export interface ModifyFpgaImageAttributeRequest { /** - *A new launch permission for the AMI.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The operation type.
- * This parameter can be used only when the Attribute parameter is launchPermission.
The ID of the AFI.
*/ - OperationType?: OperationType | string; + FpgaImageId: string | undefined; /** - *Not supported.
+ *The name of the attribute.
*/ - ProductCodes?: string[]; + Attribute?: FpgaImageAttributeName | string; /** - *The user groups.
- * This parameter can be used only when the Attribute parameter is launchPermission.
The operation type.
*/ - UserGroups?: string[]; + OperationType?: OperationType | string; /** - *The Amazon Web Services account IDs.
- * This parameter can be used only when the Attribute parameter is launchPermission.
The Amazon Web Services account IDs. This parameter is valid only when modifying the loadPermission attribute.
The value of the attribute being modified.
- * This parameter can be used only when the Attribute parameter is description.
The user groups. This parameter is valid only when modifying the loadPermission attribute.
Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The product codes. After you add a product code to an AFI, it can't be removed.
+ * This parameter is valid only when modifying the productCodes attribute.
The Amazon Resource Name (ARN) of an organization. This parameter can be used only when the Attribute parameter is launchPermission.
The load permission for the AFI.
*/ - OrganizationArns?: string[]; + LoadPermission?: LoadPermissionModifications; /** - *The Amazon Resource Name (ARN) of an organizational unit (OU). This parameter can be used only when the Attribute parameter is launchPermission.
A description for the AFI.
*/ - OrganizationalUnitArns?: string[]; + Description?: string; + + /** + *A name for the AFI.
+ */ + Name?: string; } -export namespace ModifyImageAttributeRequest { +export namespace ModifyFpgaImageAttributeRequest { /** * @internal */ - export const filterSensitiveLog = (obj: ModifyImageAttributeRequest): any => ({ + export const filterSensitiveLog = (obj: ModifyFpgaImageAttributeRequest): any => ({ ...obj, }); } -/** - *Describes information used to set up an EBS volume specified in a block device - * mapping.
- */ -export interface EbsInstanceBlockDeviceSpecification { - /** - *Indicates whether the volume is deleted on instance termination.
- */ - DeleteOnTermination?: boolean; - +export interface ModifyFpgaImageAttributeResult { /** - *The ID of the EBS volume.
+ *Information about the attribute.
*/ - VolumeId?: string; + FpgaImageAttribute?: FpgaImageAttribute; } -export namespace EbsInstanceBlockDeviceSpecification { +export namespace ModifyFpgaImageAttributeResult { /** * @internal */ - export const filterSensitiveLog = (obj: EbsInstanceBlockDeviceSpecification): any => ({ + export const filterSensitiveLog = (obj: ModifyFpgaImageAttributeResult): any => ({ ...obj, }); } -/** - *Describes a block device mapping entry.
- */ -export interface InstanceBlockDeviceMappingSpecification { +export interface ModifyHostsRequest { /** - *The device name (for example, /dev/sdh or xvdh).
Specify whether to enable or disable auto-placement.
*/ - DeviceName?: string; + AutoPlacement?: AutoPlacement | string; /** - *Parameters used to automatically set up EBS volumes when the instance is - * launched.
+ *The IDs of the Dedicated Hosts to modify.
*/ - Ebs?: EbsInstanceBlockDeviceSpecification; + HostIds: string[] | undefined; /** - *suppress the specified device included in the block device mapping.
+ *Indicates whether to enable or disable host recovery for the Dedicated Host. For more information, + * see + * Host recovery in the Amazon EC2 User Guide.
*/ - NoDevice?: string; + HostRecovery?: HostRecovery | string; /** - *The virtual device name.
- */ - VirtualName?: string; -} - -export namespace InstanceBlockDeviceMappingSpecification { - /** - * @internal - */ - export const filterSensitiveLog = (obj: InstanceBlockDeviceMappingSpecification): any => ({ - ...obj, - }); -} - -export interface BlobAttributeValue { - Value?: Uint8Array; -} - -export namespace BlobAttributeValue { - /** - * @internal - */ - export const filterSensitiveLog = (obj: BlobAttributeValue): any => ({ - ...obj, - }); -} - -export interface ModifyInstanceAttributeRequest { - /** - *Enable or disable source/destination checks, which ensure that the instance
- * is either the source or the destination of any traffic that it receives.
- * If the value is true, source/destination checks are enabled;
- * otherwise, they are disabled. The default value is true.
- * You must disable source/destination checks if the instance runs services
- * such as network address translation, routing, or firewalls.
The name of the attribute.
- */ - Attribute?: InstanceAttributeName | string; - - /** - *Modifies the DeleteOnTermination attribute for volumes that are currently
- * attached. The volume must be owned by the caller. If no value is specified for
- * DeleteOnTermination, the default is true and the volume is
- * deleted when the instance is terminated.
To add instance store volumes to an Amazon EBS-backed instance, you must add them when - * you launch the instance. For more information, see Update the block device mapping when launching an instance in the - * Amazon EC2 User Guide.
- */ - BlockDeviceMappings?: InstanceBlockDeviceMappingSpecification[]; - - /** - *If the value is true, you can't terminate the instance using the Amazon
- * EC2 console, CLI, or API; otherwise, you can. You cannot use this parameter for Spot
- * Instances.
Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
Specifies whether the instance is optimized for Amazon EBS I/O. This optimization - * provides dedicated throughput to Amazon EBS and an optimized configuration stack to - * provide optimal EBS I/O performance. This optimization isn't available with all instance - * types. Additional usage charges apply when using an EBS Optimized instance.
- */ - EbsOptimized?: AttributeBooleanValue; - - /** - *Set to true to enable enhanced networking with ENA for the
- * instance.
This option is supported only for HVM instances. Specifying this option with a PV - * instance can make it unreachable.
- */ - EnaSupport?: AttributeBooleanValue; - - /** - *[EC2-VPC] Replaces the security groups of the instance with the specified security groups. - * You must specify at least one security group, even if it's just the default security group for the VPC. You must - * specify the security group ID, not the security group name.
- */ - Groups?: string[]; - - /** - *The ID of the instance.
- */ - InstanceId: string | undefined; - - /** - *Specifies whether an instance stops or terminates when you initiate shutdown from the - * instance (using the operating system command for system shutdown).
- */ - InstanceInitiatedShutdownBehavior?: AttributeValue; - - /** - *Changes the instance type to the specified value. For more information, see Instance
- * types in the Amazon EC2 User Guide. If the instance type is not valid,
- * the error returned is InvalidInstanceAttributeValue.
Changes the instance's kernel to the specified value. We recommend that you use - * PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB.
- */ - Kernel?: AttributeValue; - - /** - *Changes the instance's RAM disk to the specified value. We recommend that you use - * PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB.
- */ - Ramdisk?: AttributeValue; - - /** - *Set to simple to enable enhanced networking with the Intel 82599 Virtual
- * Function interface for the instance.
There is no way to disable enhanced networking with the Intel 82599 Virtual Function - * interface at this time.
- *This option is supported only for HVM instances. Specifying this option with a PV - * instance can make it unreachable.
- */ - SriovNetSupport?: AttributeValue; - - /** - *Changes the instance's user data to the specified value. If you are using an Amazon Web Services SDK - * or command line tool, base64-encoding is performed for you, and you can load the text - * from a file. Otherwise, you must provide base64-encoded text.
- */ - UserData?: BlobAttributeValue; - - /** - *A new value for the attribute. Use only with the kernel,
- * ramdisk, userData, disableApiTermination, or
- * instanceInitiatedShutdownBehavior attribute.
Describes an instance's Capacity Reservation targeting option. You can specify only one parameter
- * at a time. If you specify CapacityReservationPreference and
- * CapacityReservationTarget, the request fails.
Use the CapacityReservationPreference parameter to configure the instance
- * to run as an On-Demand Instance or to run in any open Capacity Reservation that has
- * matching attributes (instance type, platform, Availability Zone). Use the
- * CapacityReservationTarget parameter to explicitly target a specific
- * Capacity Reservation or a Capacity Reservation group.
Indicates the instance's Capacity Reservation preferences. Possible preferences include:
- *
- * open - The instance can run in any open Capacity Reservation that has matching attributes
- * (instance type, platform, Availability Zone).
- * none - The instance avoids running in a Capacity Reservation even if one is available. The
- * instance runs as an On-Demand Instance.
Information about the target Capacity Reservation or Capacity Reservation group.
- */ - CapacityReservationTarget?: CapacityReservationTarget; -} - -export namespace CapacityReservationSpecification { - /** - * @internal - */ - export const filterSensitiveLog = (obj: CapacityReservationSpecification): any => ({ - ...obj, - }); -} - -export interface ModifyInstanceCapacityReservationAttributesRequest { - /** - *The ID of the instance to be modified.
- */ - InstanceId: string | undefined; - - /** - *Information about the Capacity Reservation targeting option.
- */ - CapacityReservationSpecification: CapacityReservationSpecification | undefined; - - /** - *Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Returns true if the request succeeds; otherwise, it returns an error.
Describes the credit option for CPU usage of a burstable performance instance.
- */ -export interface InstanceCreditSpecificationRequest { - /** - *The ID of the instance.
- */ - InstanceId?: string; - - /** - *The credit option for CPU usage of the instance. Valid values are
- * standard and unlimited.
T3 instances with host tenancy do not support the unlimited
- * CPU credit option.
Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
A unique, case-sensitive token that you provide to ensure idempotency of your - * modification request. For more information, see Ensuring - * Idempotency.
- */ - ClientToken?: string; - - /** - *Information about the credit option for CPU usage.
- */ - InstanceCreditSpecifications: InstanceCreditSpecificationRequest[] | undefined; -} - -export namespace ModifyInstanceCreditSpecificationRequest { - /** - * @internal - */ - export const filterSensitiveLog = (obj: ModifyInstanceCreditSpecificationRequest): any => ({ - ...obj, - }); -} - -/** - *Describes the burstable performance instance whose credit option for CPU usage was - * successfully modified.
- */ -export interface SuccessfulInstanceCreditSpecificationItem { - /** - *The ID of the instance.
- */ - InstanceId?: string; -} - -export namespace SuccessfulInstanceCreditSpecificationItem { - /** - * @internal - */ - export const filterSensitiveLog = (obj: SuccessfulInstanceCreditSpecificationItem): any => ({ - ...obj, - }); -} - -export enum UnsuccessfulInstanceCreditSpecificationErrorCode { - INCORRECT_INSTANCE_STATE = "IncorrectInstanceState", - INSTANCE_CREDIT_SPECIFICATION_NOT_SUPPORTED = "InstanceCreditSpecification.NotSupported", - INSTANCE_NOT_FOUND = "InvalidInstanceID.NotFound", - INVALID_INSTANCE_ID = "InvalidInstanceID.Malformed", -} - -/** - *Information about the error for the burstable performance instance whose credit option - * for CPU usage was not modified.
- */ -export interface UnsuccessfulInstanceCreditSpecificationItemError { - /** - *The error code.
- */ - Code?: UnsuccessfulInstanceCreditSpecificationErrorCode | string; - - /** - *The applicable error message.
- */ - Message?: string; -} - -export namespace UnsuccessfulInstanceCreditSpecificationItemError { - /** - * @internal - */ - export const filterSensitiveLog = (obj: UnsuccessfulInstanceCreditSpecificationItemError): any => ({ - ...obj, - }); -} - -/** - *Describes the burstable performance instance whose credit option for CPU usage was not - * modified.
- */ -export interface UnsuccessfulInstanceCreditSpecificationItem { - /** - *The ID of the instance.
- */ - InstanceId?: string; - - /** - *The applicable error for the burstable performance instance whose credit option for - * CPU usage was not modified.
- */ - Error?: UnsuccessfulInstanceCreditSpecificationItemError; -} - -export namespace UnsuccessfulInstanceCreditSpecificationItem { - /** - * @internal - */ - export const filterSensitiveLog = (obj: UnsuccessfulInstanceCreditSpecificationItem): any => ({ - ...obj, - }); -} - -export interface ModifyInstanceCreditSpecificationResult { - /** - *Information about the instances whose credit option for CPU usage was successfully - * modified.
- */ - SuccessfulInstanceCreditSpecifications?: SuccessfulInstanceCreditSpecificationItem[]; - - /** - *Information about the instances whose credit option for CPU usage was not - * modified.
- */ - UnsuccessfulInstanceCreditSpecifications?: UnsuccessfulInstanceCreditSpecificationItem[]; -} - -export namespace ModifyInstanceCreditSpecificationResult { - /** - * @internal - */ - export const filterSensitiveLog = (obj: ModifyInstanceCreditSpecificationResult): any => ({ - ...obj, - }); -} - -export interface ModifyInstanceEventStartTimeRequest { - /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The ID of the instance with the scheduled event.
- */ - InstanceId: string | undefined; - - /** - *The ID of the event whose date and time you are modifying.
- */ - InstanceEventId: string | undefined; - - /** - *The new date and time when the event will take place.
- */ - NotBefore: Date | undefined; -} - -export namespace ModifyInstanceEventStartTimeRequest { - /** - * @internal - */ - export const filterSensitiveLog = (obj: ModifyInstanceEventStartTimeRequest): any => ({ - ...obj, - }); -} - -export interface ModifyInstanceEventStartTimeResult { - /** - *Describes a scheduled event for an instance.
- */ - Event?: InstanceStatusEvent; -} - -export namespace ModifyInstanceEventStartTimeResult { - /** - * @internal - */ - export const filterSensitiveLog = (obj: ModifyInstanceEventStartTimeResult): any => ({ - ...obj, - }); -} - -export interface ModifyInstanceEventWindowRequest { - /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The name of the event window.
- */ - Name?: string; - - /** - *The ID of the event window.
- */ - InstanceEventWindowId: string | undefined; - - /** - *The time ranges of the event window.
+ *Specifies the instance type to be supported by the Dedicated Host. Specify this parameter to + * modify a Dedicated Host to support only a specific instance type.
+ * + *If you want to modify a Dedicated Host to support multiple instance types in its current instance + * family, omit this parameter and specify InstanceFamily + * instead. You cannot specify InstanceType and + * InstanceFamily in the same request.
*/ - TimeRanges?: InstanceEventWindowTimeRangeRequest[]; + InstanceType?: string; /** - *The cron expression of the event window, for example, * 0-4,20-23 * * 1,5.
Constraints:
- *Only hour and day of the week values are supported.
- *For day of the week values, you can specify either integers 0 through
- * 6, or alternative single values SUN through
- * SAT.
The minute, month, and year must be specified by *.
The hour value must be one or a multiple range, for example, 0-4 or
- * 0-4,20-23.
Each hour range must be >= 2 hours, for example, 0-2 or
- * 20-23.
The event window must be >= 4 hours. The combined total time ranges in the event - * window must be >= 4 hours.
- *For more information about cron expressions, see cron on the Wikipedia - * website.
+ *Specifies the instance family to be supported by the Dedicated Host. Specify this parameter + * to modify a Dedicated Host to support multiple instance types within its current + * instance family.
+ * + *If you want to modify a Dedicated Host to support a specific instance type only, omit this parameter + * and specify InstanceType instead. You cannot specify + * InstanceFamily and InstanceType + * in the same request.
*/ - CronExpression?: string; + InstanceFamily?: string; } -export namespace ModifyInstanceEventWindowRequest { +export namespace ModifyHostsRequest { /** * @internal */ - export const filterSensitiveLog = (obj: ModifyInstanceEventWindowRequest): any => ({ + export const filterSensitiveLog = (obj: ModifyHostsRequest): any => ({ ...obj, }); } -export interface ModifyInstanceEventWindowResult { +export interface ModifyHostsResult { /** - *Information about the event window.
+ *The IDs of the Dedicated Hosts that were successfully modified.
*/ - InstanceEventWindow?: InstanceEventWindow; + Successful?: string[]; + + /** + *The IDs of the Dedicated Hosts that could not be modified. Check whether the + * setting you requested can be used.
+ */ + Unsuccessful?: UnsuccessfulItem[]; } -export namespace ModifyInstanceEventWindowResult { +export namespace ModifyHostsResult { /** * @internal */ - export const filterSensitiveLog = (obj: ModifyInstanceEventWindowResult): any => ({ + export const filterSensitiveLog = (obj: ModifyHostsResult): any => ({ ...obj, }); } -export interface ModifyInstanceMetadataOptionsRequest { - /** - *The ID of the instance.
- */ - InstanceId: string | undefined; - +export interface ModifyIdentityIdFormatRequest { /** - *The state of token usage for your instance metadata requests. If the parameter is not
- * specified in the request, the default state is optional.
If the state is optional, you can choose to retrieve instance metadata
- * with or without a signed token header on your request. If you retrieve the IAM role
- * credentials without a token, the version 1.0 role credentials are returned. If you
- * retrieve the IAM role credentials using a valid signed token, the version 2.0 role
- * credentials are returned.
If the state is required, you must send a signed token header with any
- * instance metadata retrieval requests. In this state, retrieving the IAM role credential
- * always returns the version 2.0 credentials; the version 1.0 credentials are not
- * available.
The ARN of the principal, which can be an IAM user, IAM role, or the root user. Specify
+ * all to modify the ID format for all IAM users, IAM roles, and the root user of
+ * the account.
The desired HTTP PUT response hop limit for instance metadata requests. The larger the - * number, the further instance metadata requests can travel. If no parameter is specified, the existing state is maintained.
- *Possible values: Integers from 1 to 64
+ *The type of resource: bundle | conversion-task | customer-gateway | dhcp-options |
+ * elastic-ip-allocation | elastic-ip-association |
+ * export-task | flow-log | image |
+ * import-task | internet-gateway | network-acl
+ * | network-acl-association | network-interface |
+ * network-interface-attachment | prefix-list |
+ * route-table | route-table-association |
+ * security-group | subnet |
+ * subnet-cidr-block-association | vpc |
+ * vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway.
Alternatively, use the all-current option to include all resource types that are
+ * currently within their opt-in period for longer IDs.
Enables or disables the HTTP metadata endpoint on your instances. If - * this parameter is not specified, the existing state is maintained.
- *If you specify a value of disabled, you cannot access your
- * instance metadata.
Indicates whether the resource should use longer IDs (17-character IDs)
*/ - HttpEndpoint?: InstanceMetadataEndpointState | string; + UseLongIds: boolean | undefined; +} +export namespace ModifyIdentityIdFormatRequest { /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is
- * DryRunOperation. Otherwise, it is UnauthorizedOperation.
Enables or disables the IPv6 endpoint for the instance metadata service. This setting - * applies only if you have enabled the HTTP metadata endpoint.
+ *The type of resource: bundle | conversion-task | customer-gateway | dhcp-options |
+ * elastic-ip-allocation | elastic-ip-association |
+ * export-task | flow-log | image |
+ * import-task | internet-gateway | network-acl
+ * | network-acl-association | network-interface |
+ * network-interface-attachment | prefix-list |
+ * route-table | route-table-association |
+ * security-group | subnet |
+ * subnet-cidr-block-association | vpc |
+ * vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway.
Alternatively, use the all-current option to include all resource types that are
+ * currently within their opt-in period for longer IDs.
Set to enabled to allow access to instance tags from the instance
- * metadata. Set to disabled to turn off access to instance tags from the
- * instance metadata. For more information, see Work with
- * instance tags using the instance metadata.
Default: disabled
- *
Indicate whether the resource should use longer IDs (17-character IDs).
*/ - InstanceMetadataTags?: InstanceMetadataTagsState | string; + UseLongIds: boolean | undefined; } -export namespace ModifyInstanceMetadataOptionsRequest { +export namespace ModifyIdFormatRequest { /** * @internal */ - export const filterSensitiveLog = (obj: ModifyInstanceMetadataOptionsRequest): any => ({ + export const filterSensitiveLog = (obj: ModifyIdFormatRequest): any => ({ ...obj, }); } -export interface ModifyInstanceMetadataOptionsResult { +/** + *Describes a launch permission modification.
+ */ +export interface LaunchPermissionModifications { /** - *The ID of the instance.
+ *The Amazon Web Services account ID, organization ARN, or OU ARN to add to the list of launch permissions for the AMI.
*/ - InstanceId?: string; + Add?: LaunchPermission[]; /** - *The metadata options for the instance.
+ *The Amazon Web Services account ID, organization ARN, or OU ARN to remove from the list of launch permissions for the AMI.
*/ - InstanceMetadataOptions?: InstanceMetadataOptionsResponse; + Remove?: LaunchPermission[]; } -export namespace ModifyInstanceMetadataOptionsResult { +export namespace LaunchPermissionModifications { /** * @internal */ - export const filterSensitiveLog = (obj: ModifyInstanceMetadataOptionsResult): any => ({ + export const filterSensitiveLog = (obj: LaunchPermissionModifications): any => ({ ...obj, }); } -export type HostTenancy = "dedicated" | "host"; +/** + *Contains the parameters for ModifyImageAttribute.
+ */ +export interface ModifyImageAttributeRequest { + /** + *The name of the attribute to modify.
+ *Valid values: description | launchPermission
+ *
The affinity setting for the instance.
+ *A new description for the AMI.
*/ - Affinity?: Affinity | string; + Description?: AttributeValue; /** - *The name of the placement group in which to place the instance. For spread placement
- * groups, the instance must have a tenancy of default. For cluster and
- * partition placement groups, the instance must have a tenancy of default or
- * dedicated.
To remove an instance from a placement group, specify an empty string - * ("").
+ *The ID of the AMI.
*/ - GroupName?: string; + ImageId: string | undefined; /** - *The ID of the Dedicated Host with which to associate the instance.
+ *A new launch permission for the AMI.
*/ - HostId?: string; + LaunchPermission?: LaunchPermissionModifications; /** - *The ID of the instance that you are modifying.
+ *The operation type.
+ * This parameter can be used only when the Attribute parameter is launchPermission.
The tenancy for the instance.
- * - *For T3 instances, you can't change the tenancy from dedicated
- * to host, or from host to dedicated.
- * Attempting to make one of these unsupported tenancy changes results in the
- * InvalidTenancy error code.
Not supported.
*/ - Tenancy?: HostTenancy | string; + ProductCodes?: string[]; /** - *The number of the partition in which to place the instance. Valid only if the
- * placement group strategy is set to partition.
The user groups.
+ * This parameter can be used only when the Attribute parameter is launchPermission.
The ARN of the host resource group in which to place the instance.
+ *The Amazon Web Services account IDs.
+ * This parameter can be used only when the Attribute parameter is launchPermission.
The value of the attribute being modified.
+ * This parameter can be used only when the Attribute parameter is description.
Is true if the request succeeds, and an error otherwise.
Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is
+ * DryRunOperation. Otherwise, it is UnauthorizedOperation.
The Amazon Resource Name (ARN) of an organization. This parameter can be used only when the Attribute parameter is launchPermission.
The Amazon Resource Name (ARN) of an organizational unit (OU). This parameter can be used only when the Attribute parameter is launchPermission.
Remove an operating Region from an IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only - * discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.
- *For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide - *
+ *Describes information used to set up an EBS volume specified in a block device + * mapping.
*/ -export interface RemoveIpamOperatingRegion { +export interface EbsInstanceBlockDeviceSpecification { /** - *The name of the operating Region you want to remove.
+ *Indicates whether the volume is deleted on instance termination.
*/ - RegionName?: string; + DeleteOnTermination?: boolean; + + /** + *The ID of the EBS volume.
+ */ + VolumeId?: string; } -export namespace RemoveIpamOperatingRegion { +export namespace EbsInstanceBlockDeviceSpecification { /** * @internal */ - export const filterSensitiveLog = (obj: RemoveIpamOperatingRegion): any => ({ + export const filterSensitiveLog = (obj: EbsInstanceBlockDeviceSpecification): any => ({ ...obj, }); } -export interface ModifyIpamRequest { - /** - *A check for whether you have the required permissions for the action without actually making the request
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
Describes a block device mapping entry.
+ */ +export interface InstanceBlockDeviceMappingSpecification { /** - *The ID of the IPAM you want to modify.
+ *The device name (for example, /dev/sdh or xvdh).
The description of the IPAM you want to modify.
+ *Parameters used to automatically set up EBS volumes when the instance is + * launched.
*/ - Description?: string; + Ebs?: EbsInstanceBlockDeviceSpecification; /** - *Choose the operating Regions for the IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only - * discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.
- *For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide.
+ *suppress the specified device included in the block device mapping.
*/ - AddOperatingRegions?: AddIpamOperatingRegion[]; + NoDevice?: string; /** - *The operating Regions to remove.
+ *The virtual device name.
*/ - RemoveOperatingRegions?: RemoveIpamOperatingRegion[]; + VirtualName?: string; } -export namespace ModifyIpamRequest { +export namespace InstanceBlockDeviceMappingSpecification { /** * @internal */ - export const filterSensitiveLog = (obj: ModifyIpamRequest): any => ({ + export const filterSensitiveLog = (obj: InstanceBlockDeviceMappingSpecification): any => ({ ...obj, }); } -export interface ModifyIpamResult { - /** - *The results of the modification.
- */ - Ipam?: Ipam; +export interface BlobAttributeValue { + Value?: Uint8Array; } -export namespace ModifyIpamResult { +export namespace BlobAttributeValue { /** * @internal */ - export const filterSensitiveLog = (obj: ModifyIpamResult): any => ({ + export const filterSensitiveLog = (obj: BlobAttributeValue): any => ({ ...obj, }); } -export interface ModifyIpamPoolRequest { +export interface ModifyInstanceAttributeRequest { /** - *A check for whether you have the required permissions for the action without actually making the request + *
Enable or disable source/destination checks, which ensure that the instance
+ * is either the source or the destination of any traffic that it receives.
+ * If the value is true, source/destination checks are enabled;
+ * otherwise, they are disabled. The default value is true.
+ * You must disable source/destination checks if the instance runs services
+ * such as network address translation, routing, or firewalls.
The name of the attribute.
+ */ + Attribute?: InstanceAttributeName | string; + + /** + *Modifies the DeleteOnTermination attribute for volumes that are currently
+ * attached. The volume must be owned by the caller. If no value is specified for
+ * DeleteOnTermination, the default is true and the volume is
+ * deleted when the instance is terminated.
To add instance store volumes to an Amazon EBS-backed instance, you must add them when + * you launch the instance. For more information, see Update the block device mapping when launching an instance in the + * Amazon EC2 User Guide.
+ */ + BlockDeviceMappings?: InstanceBlockDeviceMappingSpecification[]; + + /** + *If the value is true, you can't terminate the instance using the Amazon
+ * EC2 console, CLI, or API; otherwise, you can. You cannot use this parameter for Spot
+ * Instances.
Checks whether you have the required permissions for the action, without actually making the request,
* and provides an error response. If you have the required permissions, the error response is DryRunOperation.
* Otherwise, it is UnauthorizedOperation.
The ID of the IPAM pool you want to modify.
+ *Specifies whether the instance is optimized for Amazon EBS I/O. This optimization + * provides dedicated throughput to Amazon EBS and an optimized configuration stack to + * provide optimal EBS I/O performance. This optimization isn't available with all instance + * types. Additional usage charges apply when using an EBS Optimized instance.
*/ - IpamPoolId: string | undefined; + EbsOptimized?: AttributeBooleanValue; /** - *The description of the IPAM pool you want to modify.
+ *Set to true to enable enhanced networking with ENA for the
+ * instance.
This option is supported only for HVM instances. Specifying this option with a PV + * instance can make it unreachable.
*/ - Description?: string; + EnaSupport?: AttributeBooleanValue; /** - *If true, IPAM will continuously look for resources within the CIDR range of this pool - * and automatically import them as allocations into your IPAM. The CIDRs that will be allocated for - * these resources must not already be allocated to other resources in order for the import to succeed. IPAM will import - * a CIDR regardless of its compliance with the pool's allocation rules, so a resource might be imported and subsequently - * marked as noncompliant. If IPAM discovers multiple CIDRs that overlap, IPAM will import the largest CIDR only. If IPAM - * discovers multiple CIDRs with matching CIDRs, IPAM will randomly import one of them only. - *
- *A locale must be set on the pool for this feature to work.
+ *[EC2-VPC] Replaces the security groups of the instance with the specified security groups. + * You must specify at least one security group, even if it's just the default security group for the VPC. You must + * specify the security group ID, not the security group name.
*/ - AutoImport?: boolean; + Groups?: string[]; /** - *The minimum netmask length required for CIDR allocations in this IPAM pool to be compliant. Possible - * netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128. The minimum netmask - * length must be less than the maximum netmask length.
+ *The ID of the instance.
*/ - AllocationMinNetmaskLength?: number; + InstanceId: string | undefined; /** - *The maximum netmask length possible for CIDR allocations in this IPAM pool to be compliant. Possible - * netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.The maximum netmask - * length must be greater than the minimum netmask length.
+ *Specifies whether an instance stops or terminates when you initiate shutdown from the + * instance (using the operating system command for system shutdown).
*/ - AllocationMaxNetmaskLength?: number; + InstanceInitiatedShutdownBehavior?: AttributeValue; /** - *The default netmask length for allocations added to this pool. If, for example, the CIDR assigned to this pool is 10.0.0.0/8 and you enter 16 here, new allocations will default to 10.0.0.0/16.
+ *Changes the instance type to the specified value. For more information, see Instance
+ * types in the Amazon EC2 User Guide. If the instance type is not valid,
+ * the error returned is InvalidInstanceAttributeValue.
Clear the default netmask length allocation rule for this pool.
+ *Changes the instance's kernel to the specified value. We recommend that you use + * PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB.
*/ - ClearAllocationDefaultNetmaskLength?: boolean; + Kernel?: AttributeValue; /** - *Add tag allocation rules to a pool. For more information about allocation rules, see Create a top-level pool in the Amazon VPC IPAM User Guide.
+ *Changes the instance's RAM disk to the specified value. We recommend that you use + * PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB.
*/ - AddAllocationResourceTags?: RequestIpamResourceTag[]; + Ramdisk?: AttributeValue; /** - *Remove tag allocation rules from a pool.
+ *Set to simple to enable enhanced networking with the Intel 82599 Virtual
+ * Function interface for the instance.
There is no way to disable enhanced networking with the Intel 82599 Virtual Function + * interface at this time.
+ *This option is supported only for HVM instances. Specifying this option with a PV + * instance can make it unreachable.
*/ - RemoveAllocationResourceTags?: RequestIpamResourceTag[]; -} + SriovNetSupport?: AttributeValue; -export namespace ModifyIpamPoolRequest { /** - * @internal + *Changes the instance's user data to the specified value. If you are using an Amazon Web Services SDK + * or command line tool, base64-encoding is performed for you, and you can load the text + * from a file. Otherwise, you must provide base64-encoded text.
*/ - export const filterSensitiveLog = (obj: ModifyIpamPoolRequest): any => ({ - ...obj, - }); -} + UserData?: BlobAttributeValue; -export interface ModifyIpamPoolResult { /** - *The results of the modification.
+ *A new value for the attribute. Use only with the kernel,
+ * ramdisk, userData, disableApiTermination, or
+ * instanceInitiatedShutdownBehavior attribute.
Describes an instance's Capacity Reservation targeting option. You can specify only one parameter
+ * at a time. If you specify CapacityReservationPreference and
+ * CapacityReservationTarget, the request fails.
Use the CapacityReservationPreference parameter to configure the instance
+ * to run as an On-Demand Instance or to run in any open Capacity Reservation that has
+ * matching attributes (instance type, platform, Availability Zone). Use the
+ * CapacityReservationTarget parameter to explicitly target a specific
+ * Capacity Reservation or a Capacity Reservation group.
A check for whether you have the required permissions for the action without actually making the request
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
Indicates the instance's Capacity Reservation preferences. Possible preferences include:
+ *
+ * open - The instance can run in any open Capacity Reservation that has matching attributes
+ * (instance type, platform, Availability Zone).
+ * none - The instance avoids running in a Capacity Reservation even if one is available. The
+ * instance runs as an On-Demand Instance.
The ID of the resource you want to modify.
+ *Information about the target Capacity Reservation or Capacity Reservation group.
*/ - ResourceId: string | undefined; + CapacityReservationTarget?: CapacityReservationTarget; +} +export namespace CapacityReservationSpecification { /** - *The CIDR of the resource you want to modify.
+ * @internal */ - ResourceCidr: string | undefined; + export const filterSensitiveLog = (obj: CapacityReservationSpecification): any => ({ + ...obj, + }); +} +export interface ModifyInstanceCapacityReservationAttributesRequest { /** - *The Amazon Web Services Region of the resource you want to modify.
+ *The ID of the instance to be modified.
*/ - ResourceRegion: string | undefined; + InstanceId: string | undefined; /** - *The ID of the current scope that the resource CIDR is in.
+ *Information about the Capacity Reservation targeting option.
*/ - CurrentIpamScopeId: string | undefined; + CapacityReservationSpecification: CapacityReservationSpecification | undefined; /** - *The ID of the scope you want to transfer the resource CIDR to.
+ *Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Determines if the resource is monitored by IPAM. If a resource is monitored, the resource is discovered by IPAM and you can view details about the resource’s CIDR.
+ *Returns true if the request succeeds; otherwise, it returns an error.
Describes the credit option for CPU usage of a burstable performance instance.
+ */ +export interface InstanceCreditSpecificationRequest { /** - *The CIDR for an IPAM resource.
+ *The ID of the instance.
*/ - IpamResourceCidr?: IpamResourceCidr; + InstanceId?: string; + + /** + *The credit option for CPU usage of the instance. Valid values are
+ * standard and unlimited.
T3 instances with host tenancy do not support the unlimited
+ * CPU credit option.
A check for whether you have the required permissions for the action without actually making the request + *
Checks whether you have the required permissions for the action, without actually making the request,
* and provides an error response. If you have the required permissions, the error response is DryRunOperation.
* Otherwise, it is UnauthorizedOperation.
The ID of the scope you want to modify.
+ *A unique, case-sensitive token that you provide to ensure idempotency of your + * modification request. For more information, see Ensuring + * Idempotency.
*/ - IpamScopeId: string | undefined; + ClientToken?: string; /** - *The description of the scope you want to modify.
+ *Information about the credit option for CPU usage.
*/ - Description?: string; + InstanceCreditSpecifications: InstanceCreditSpecificationRequest[] | undefined; } -export namespace ModifyIpamScopeRequest { +export namespace ModifyInstanceCreditSpecificationRequest { /** * @internal */ - export const filterSensitiveLog = (obj: ModifyIpamScopeRequest): any => ({ + export const filterSensitiveLog = (obj: ModifyInstanceCreditSpecificationRequest): any => ({ ...obj, }); } -export interface ModifyIpamScopeResult { +/** + *Describes the burstable performance instance whose credit option for CPU usage was + * successfully modified.
+ */ +export interface SuccessfulInstanceCreditSpecificationItem { /** - *The results of the modification.
+ *The ID of the instance.
*/ - IpamScope?: IpamScope; + InstanceId?: string; } -export namespace ModifyIpamScopeResult { +export namespace SuccessfulInstanceCreditSpecificationItem { /** * @internal */ - export const filterSensitiveLog = (obj: ModifyIpamScopeResult): any => ({ + export const filterSensitiveLog = (obj: SuccessfulInstanceCreditSpecificationItem): any => ({ ...obj, }); } -export interface ModifyLaunchTemplateRequest { - /** - *Checks whether you have the required permissions for the action, without actually
- * making the request, and provides an error response. If you have the required
- * permissions, the error response is DryRunOperation. Otherwise, it is
- * UnauthorizedOperation.
Unique, case-sensitive identifier you provide to ensure the idempotency of the - * request. For more information, see Ensuring - * Idempotency.
- *Constraint: Maximum 128 ASCII characters.
- */ - ClientToken?: string; - - /** - *The ID of the launch template. You must specify either the launch template ID or - * launch template name in the request.
- */ - LaunchTemplateId?: string; +export enum UnsuccessfulInstanceCreditSpecificationErrorCode { + INCORRECT_INSTANCE_STATE = "IncorrectInstanceState", + INSTANCE_CREDIT_SPECIFICATION_NOT_SUPPORTED = "InstanceCreditSpecification.NotSupported", + INSTANCE_NOT_FOUND = "InvalidInstanceID.NotFound", + INVALID_INSTANCE_ID = "InvalidInstanceID.Malformed", +} +/** + *Information about the error for the burstable performance instance whose credit option + * for CPU usage was not modified.
+ */ +export interface UnsuccessfulInstanceCreditSpecificationItemError { /** - *The name of the launch template. You must specify either the launch template ID or - * launch template name in the request.
+ *The error code.
*/ - LaunchTemplateName?: string; + Code?: UnsuccessfulInstanceCreditSpecificationErrorCode | string; /** - *The version number of the launch template to set as the default version.
+ *The applicable error message.
*/ - DefaultVersion?: string; + Message?: string; } -export namespace ModifyLaunchTemplateRequest { +export namespace UnsuccessfulInstanceCreditSpecificationItemError { /** * @internal */ - export const filterSensitiveLog = (obj: ModifyLaunchTemplateRequest): any => ({ + export const filterSensitiveLog = (obj: UnsuccessfulInstanceCreditSpecificationItemError): any => ({ ...obj, }); } -export interface ModifyLaunchTemplateResult { +/** + *Describes the burstable performance instance whose credit option for CPU usage was not + * modified.
+ */ +export interface UnsuccessfulInstanceCreditSpecificationItem { /** - *Information about the launch template.
+ *The ID of the instance.
*/ - LaunchTemplate?: LaunchTemplate; + InstanceId?: string; + + /** + *The applicable error for the burstable performance instance whose credit option for + * CPU usage was not modified.
+ */ + Error?: UnsuccessfulInstanceCreditSpecificationItemError; } -export namespace ModifyLaunchTemplateResult { +export namespace UnsuccessfulInstanceCreditSpecificationItem { /** * @internal */ - export const filterSensitiveLog = (obj: ModifyLaunchTemplateResult): any => ({ + export const filterSensitiveLog = (obj: UnsuccessfulInstanceCreditSpecificationItem): any => ({ ...obj, }); } -/** - *An entry for a prefix list.
- */ -export interface RemovePrefixListEntry { +export interface ModifyInstanceCreditSpecificationResult { /** - *The CIDR block.
+ *Information about the instances whose credit option for CPU usage was successfully + * modified.
*/ - Cidr: string | undefined; + SuccessfulInstanceCreditSpecifications?: SuccessfulInstanceCreditSpecificationItem[]; + + /** + *Information about the instances whose credit option for CPU usage was not + * modified.
+ */ + UnsuccessfulInstanceCreditSpecifications?: UnsuccessfulInstanceCreditSpecificationItem[]; } -export namespace RemovePrefixListEntry { +export namespace ModifyInstanceCreditSpecificationResult { /** * @internal */ - export const filterSensitiveLog = (obj: RemovePrefixListEntry): any => ({ + export const filterSensitiveLog = (obj: ModifyInstanceCreditSpecificationResult): any => ({ ...obj, }); } -export interface ModifyManagedPrefixListRequest { +export interface ModifyInstanceEventStartTimeRequest { /** *Checks whether you have the required permissions for the action, without actually making the request,
* and provides an error response. If you have the required permissions, the error response is DryRunOperation.
@@ -4800,962 +4551,1007 @@ export interface ModifyManagedPrefixListRequest {
DryRun?: boolean;
/**
- *
The ID of the prefix list.
- */ - PrefixListId: string | undefined; - - /** - *The current version of the prefix list.
- */ - CurrentVersion?: number; - - /** - *A name for the prefix list.
- */ - PrefixListName?: string; - - /** - *One or more entries to add to the prefix list.
+ *The ID of the instance with the scheduled event.
*/ - AddEntries?: AddPrefixListEntry[]; + InstanceId: string | undefined; /** - *One or more entries to remove from the prefix list.
+ *The ID of the event whose date and time you are modifying.
*/ - RemoveEntries?: RemovePrefixListEntry[]; + InstanceEventId: string | undefined; /** - *The maximum number of entries for the prefix list. You cannot modify the entries - * of a prefix list and modify the size of a prefix list at the same time.
- *If any of the resources that reference the prefix list cannot support the new - * maximum size, the modify operation fails. Check the state message for the IDs of - * the first ten resources that do not support the new maximum size.
+ *The new date and time when the event will take place.
*/ - MaxEntries?: number; + NotBefore: Date | undefined; } -export namespace ModifyManagedPrefixListRequest { +export namespace ModifyInstanceEventStartTimeRequest { /** * @internal */ - export const filterSensitiveLog = (obj: ModifyManagedPrefixListRequest): any => ({ + export const filterSensitiveLog = (obj: ModifyInstanceEventStartTimeRequest): any => ({ ...obj, }); } -export interface ModifyManagedPrefixListResult { +export interface ModifyInstanceEventStartTimeResult { /** - *Information about the prefix list.
+ *Describes a scheduled event for an instance.
*/ - PrefixList?: ManagedPrefixList; + Event?: InstanceStatusEvent; } -export namespace ModifyManagedPrefixListResult { +export namespace ModifyInstanceEventStartTimeResult { /** * @internal */ - export const filterSensitiveLog = (obj: ModifyManagedPrefixListResult): any => ({ + export const filterSensitiveLog = (obj: ModifyInstanceEventStartTimeResult): any => ({ ...obj, }); } -/** - *Describes an attachment change.
- */ -export interface NetworkInterfaceAttachmentChanges { - /** - *The ID of the network interface attachment.
- */ - AttachmentId?: string; - - /** - *Indicates whether the network interface is deleted when the instance is terminated.
- */ - DeleteOnTermination?: boolean; -} - -export namespace NetworkInterfaceAttachmentChanges { +export interface ModifyInstanceEventWindowRequest { /** - * @internal + *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Contains the parameters for ModifyNetworkInterfaceAttribute.
- */ -export interface ModifyNetworkInterfaceAttributeRequest { /** - *Information about the interface attachment. If modifying the 'delete on termination' attribute, you must specify the ID of the interface attachment.
+ *The name of the event window.
*/ - Attachment?: NetworkInterfaceAttachmentChanges; + Name?: string; /** - *A description for the network interface.
+ *The ID of the event window.
*/ - Description?: AttributeValue; + InstanceEventWindowId: string | undefined; /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The time ranges of the event window.
*/ - DryRun?: boolean; + TimeRanges?: InstanceEventWindowTimeRangeRequest[]; /** - *Changes the security groups for the network interface. The new set of groups you specify replaces the current set. You must specify at least one group, even if it's just the default security group in the VPC. You must specify the ID of the security group, not the name.
+ *The cron expression of the event window, for example, * 0-4,20-23 * * 1,5.
Constraints:
+ *Only hour and day of the week values are supported.
+ *For day of the week values, you can specify either integers 0 through
+ * 6, or alternative single values SUN through
+ * SAT.
The minute, month, and year must be specified by *.
The hour value must be one or a multiple range, for example, 0-4 or
+ * 0-4,20-23.
Each hour range must be >= 2 hours, for example, 0-2 or
+ * 20-23.
The event window must be >= 4 hours. The combined total time ranges in the event + * window must be >= 4 hours.
+ *For more information about cron expressions, see cron on the Wikipedia + * website.
*/ - Groups?: string[]; + CronExpression?: string; +} +export namespace ModifyInstanceEventWindowRequest { /** - *The ID of the network interface.
+ * @internal */ - NetworkInterfaceId: string | undefined; + export const filterSensitiveLog = (obj: ModifyInstanceEventWindowRequest): any => ({ + ...obj, + }); +} +export interface ModifyInstanceEventWindowResult { /** - *Enable or disable source/destination checks, which ensure that the instance
- * is either the source or the destination of any traffic that it receives.
- * If the value is true, source/destination checks are enabled;
- * otherwise, they are disabled. The default value is true.
- * You must disable source/destination checks if the instance runs services
- * such as network address translation, routing, or firewalls.
Information about the event window.
*/ - SourceDestCheck?: AttributeBooleanValue; + InstanceEventWindow?: InstanceEventWindow; } -export namespace ModifyNetworkInterfaceAttributeRequest { +export namespace ModifyInstanceEventWindowResult { /** * @internal */ - export const filterSensitiveLog = (obj: ModifyNetworkInterfaceAttributeRequest): any => ({ + export const filterSensitiveLog = (obj: ModifyInstanceEventWindowResult): any => ({ ...obj, }); } -export interface ModifyPrivateDnsNameOptionsRequest { +export interface ModifyInstanceMetadataOptionsRequest { /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The ID of the instance.
*/ - DryRun?: boolean; + InstanceId: string | undefined; /** - *The ID of the instance.
+ *The state of token usage for your instance metadata requests. If the parameter is not
+ * specified in the request, the default state is optional.
If the state is optional, you can choose to retrieve instance metadata
+ * with or without a signed token header on your request. If you retrieve the IAM role
+ * credentials without a token, the version 1.0 role credentials are returned. If you
+ * retrieve the IAM role credentials using a valid signed token, the version 2.0 role
+ * credentials are returned.
If the state is required, you must send a signed token header with any
+ * instance metadata retrieval requests. In this state, retrieving the IAM role credential
+ * always returns the version 2.0 credentials; the version 1.0 credentials are not
+ * available.
The type of hostname for EC2 instances. For IPv4 only subnets, an instance DNS name must be - * based on the instance IPv4 address. For IPv6 only subnets, an instance DNS name must be based - * on the instance ID. For dual-stack subnets, you can specify whether DNS names use the instance - * IPv4 address or the instance ID.
+ *The desired HTTP PUT response hop limit for instance metadata requests. The larger the + * number, the further instance metadata requests can travel. If no parameter is specified, the existing state is maintained.
+ *Possible values: Integers from 1 to 64
*/ - PrivateDnsHostnameType?: HostnameType | string; + HttpPutResponseHopLimit?: number; /** - *Indicates whether to respond to DNS queries for instance hostnames with DNS A records.
+ *Enables or disables the HTTP metadata endpoint on your instances. If + * this parameter is not specified, the existing state is maintained.
+ *If you specify a value of disabled, you cannot access your
+ * instance metadata.
Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is
+ * DryRunOperation. Otherwise, it is UnauthorizedOperation.
Enables or disables the IPv6 endpoint for the instance metadata service. This setting + * applies only if you have enabled the HTTP metadata endpoint.
*/ - export const filterSensitiveLog = (obj: ModifyPrivateDnsNameOptionsRequest): any => ({ - ...obj, - }); -} + HttpProtocolIpv6?: InstanceMetadataProtocolState | string; -export interface ModifyPrivateDnsNameOptionsResult { /** - *Returns true if the request succeeds; otherwise, it returns an error.
Set to enabled to allow access to instance tags from the instance
+ * metadata. Set to disabled to turn off access to instance tags from the
+ * instance metadata. For more information, see Work with
+ * instance tags using the instance metadata.
Default: disabled
+ *
Contains the parameters for ModifyReservedInstances.
- */ -export interface ModifyReservedInstancesRequest { - /** - *The IDs of the Reserved Instances to modify.
- */ - ReservedInstancesIds: string[] | undefined; - +export interface ModifyInstanceMetadataOptionsResult { /** - *A unique, case-sensitive token you provide to ensure idempotency of your modification request. For more information, see - * Ensuring Idempotency.
+ *The ID of the instance.
*/ - ClientToken?: string; + InstanceId?: string; /** - *The configuration settings for the Reserved Instances to modify.
+ *The metadata options for the instance.
*/ - TargetConfigurations: ReservedInstancesConfiguration[] | undefined; + InstanceMetadataOptions?: InstanceMetadataOptionsResponse; } -export namespace ModifyReservedInstancesRequest { +export namespace ModifyInstanceMetadataOptionsResult { /** * @internal */ - export const filterSensitiveLog = (obj: ModifyReservedInstancesRequest): any => ({ + export const filterSensitiveLog = (obj: ModifyInstanceMetadataOptionsResult): any => ({ ...obj, }); } -/** - *Contains the output of ModifyReservedInstances.
- */ -export interface ModifyReservedInstancesResult { - /** - *The ID for the modification.
- */ - ReservedInstancesModificationId?: string; -} +export type HostTenancy = "dedicated" | "host"; -export namespace ModifyReservedInstancesResult { +export interface ModifyInstancePlacementRequest { /** - * @internal + *The affinity setting for the instance.
*/ - export const filterSensitiveLog = (obj: ModifyReservedInstancesResult): any => ({ - ...obj, - }); -} + Affinity?: Affinity | string; -/** - *Describes a security group rule.
- *You must specify exactly one of the following parameters, based on the rule type:
- *CidrIpv4
- *CidrIpv6
- *PrefixListId
- *ReferencedGroupId
- *When you modify a rule, you cannot change the rule type. For example, if the rule
- * uses an IPv4 address range, you must use CidrIpv4 to specify a new IPv4
- * address range.
The IP protocol name (tcp, udp, icmp,
- * icmpv6) or number (see Protocol Numbers).
Use -1 to specify all protocols.
The name of the placement group in which to place the instance. For spread placement
+ * groups, the instance must have a tenancy of default. For cluster and
+ * partition placement groups, the instance must have a tenancy of default or
+ * dedicated.
To remove an instance from a placement group, specify an empty string + * ("").
*/ - IpProtocol?: string; + GroupName?: string; /** - *The start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type. A value of -1 indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all codes.
+ *The ID of the Dedicated Host with which to associate the instance.
*/ - FromPort?: number; + HostId?: string; /** - *The end of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code. A value of -1 indicates all ICMP/ICMPv6 codes. If you specify all ICMP/ICMPv6 types, you must specify all codes.
The ID of the instance that you are modifying.
*/ - ToPort?: number; + InstanceId: string | undefined; /** - *The IPv4 CIDR range. To specify a single IPv4 address, use the /32 prefix length.
+ *The tenancy for the instance.
+ * + *For T3 instances, you can't change the tenancy from dedicated
+ * to host, or from host to dedicated.
+ * Attempting to make one of these unsupported tenancy changes results in the
+ * InvalidTenancy error code.
The IPv6 CIDR range. To specify a single IPv6 address, use the /128 prefix length.
+ *The number of the partition in which to place the instance. Valid only if the
+ * placement group strategy is set to partition.
The ID of the prefix list.
+ *The ARN of the host resource group in which to place the instance.
*/ - PrefixListId?: string; + HostResourceGroupArn?: string; +} +export namespace ModifyInstancePlacementRequest { /** - *The ID of the security group that is referenced in the security group rule.
+ * @internal */ - ReferencedGroupId?: string; + export const filterSensitiveLog = (obj: ModifyInstancePlacementRequest): any => ({ + ...obj, + }); +} +export interface ModifyInstancePlacementResult { /** - *The description of the security group rule.
+ *Is true if the request succeeds, and an error otherwise.
Describes an update to a security group rule.
+ *Remove an operating Region from an IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only + * discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.
+ *For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide + *
*/ -export interface SecurityGroupRuleUpdate { +export interface RemoveIpamOperatingRegion { /** - *The ID of the security group rule.
+ *The name of the operating Region you want to remove.
*/ - SecurityGroupRuleId?: string; + RegionName?: string; +} +export namespace RemoveIpamOperatingRegion { /** - *Information about the security group rule.
+ * @internal + */ + export const filterSensitiveLog = (obj: RemoveIpamOperatingRegion): any => ({ + ...obj, + }); +} + +export interface ModifyIpamRequest { + /** + *A check for whether you have the required permissions for the action without actually making the request
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The ID of the IPAM you want to modify.
*/ - export const filterSensitiveLog = (obj: SecurityGroupRuleUpdate): any => ({ - ...obj, - }); -} + IpamId: string | undefined; -export interface ModifySecurityGroupRulesRequest { /** - *The ID of the security group.
+ *The description of the IPAM you want to modify.
*/ - GroupId: string | undefined; + Description?: string; /** - *Information about the security group properties to update.
+ *Choose the operating Regions for the IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only + * discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.
+ *For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide.
*/ - SecurityGroupRules: SecurityGroupRuleUpdate[] | undefined; + AddOperatingRegions?: AddIpamOperatingRegion[]; /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The operating Regions to remove.
*/ - DryRun?: boolean; + RemoveOperatingRegions?: RemoveIpamOperatingRegion[]; } -export namespace ModifySecurityGroupRulesRequest { +export namespace ModifyIpamRequest { /** * @internal */ - export const filterSensitiveLog = (obj: ModifySecurityGroupRulesRequest): any => ({ + export const filterSensitiveLog = (obj: ModifyIpamRequest): any => ({ ...obj, }); } -export interface ModifySecurityGroupRulesResult { +export interface ModifyIpamResult { /** - *Returns true if the request succeeds; otherwise, returns an error.
The results of the modification.
*/ - Return?: boolean; + Ipam?: Ipam; } -export namespace ModifySecurityGroupRulesResult { +export namespace ModifyIpamResult { /** * @internal */ - export const filterSensitiveLog = (obj: ModifySecurityGroupRulesResult): any => ({ + export const filterSensitiveLog = (obj: ModifyIpamResult): any => ({ ...obj, }); } -/** - *Describes modifications to the list of create volume permissions for a volume.
- */ -export interface CreateVolumePermissionModifications { +export interface ModifyIpamPoolRequest { /** - *Adds the specified Amazon Web Services account ID or group to the list.
+ *A check for whether you have the required permissions for the action without actually making the request
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Removes the specified Amazon Web Services account ID or group from the list.
+ *The ID of the IPAM pool you want to modify.
*/ - Remove?: CreateVolumePermission[]; -} + IpamPoolId: string | undefined; -export namespace CreateVolumePermissionModifications { /** - * @internal + *The description of the IPAM pool you want to modify.
*/ - export const filterSensitiveLog = (obj: CreateVolumePermissionModifications): any => ({ - ...obj, - }); -} + Description?: string; -export interface ModifySnapshotAttributeRequest { /** - *The snapshot attribute to modify. Only volume creation permissions can be modified.
+ *If true, IPAM will continuously look for resources within the CIDR range of this pool + * and automatically import them as allocations into your IPAM. The CIDRs that will be allocated for + * these resources must not already be allocated to other resources in order for the import to succeed. IPAM will import + * a CIDR regardless of its compliance with the pool's allocation rules, so a resource might be imported and subsequently + * marked as noncompliant. If IPAM discovers multiple CIDRs that overlap, IPAM will import the largest CIDR only. If IPAM + * discovers multiple CIDRs with matching CIDRs, IPAM will randomly import one of them only. + *
+ *A locale must be set on the pool for this feature to work.
*/ - Attribute?: SnapshotAttributeName | string; + AutoImport?: boolean; /** - *A JSON representation of the snapshot attribute modification.
+ *The minimum netmask length required for CIDR allocations in this IPAM pool to be compliant. Possible + * netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128. The minimum netmask + * length must be less than the maximum netmask length.
*/ - CreateVolumePermission?: CreateVolumePermissionModifications; + AllocationMinNetmaskLength?: number; /** - *The group to modify for the snapshot.
+ *The maximum netmask length possible for CIDR allocations in this IPAM pool to be compliant. Possible + * netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.The maximum netmask + * length must be greater than the minimum netmask length.
*/ - GroupNames?: string[]; + AllocationMaxNetmaskLength?: number; /** - *The type of operation to perform to the attribute.
+ *The default netmask length for allocations added to this pool. If, for example, the CIDR assigned to this pool is 10.0.0.0/8 and you enter 16 here, new allocations will default to 10.0.0.0/16.
*/ - OperationType?: OperationType | string; + AllocationDefaultNetmaskLength?: number; /** - *The ID of the snapshot.
+ *Clear the default netmask length allocation rule for this pool.
*/ - SnapshotId: string | undefined; + ClearAllocationDefaultNetmaskLength?: boolean; /** - *The account ID to modify for the snapshot.
+ *Add tag allocation rules to a pool. For more information about allocation rules, see Create a top-level pool in the Amazon VPC IPAM User Guide.
*/ - UserIds?: string[]; + AddAllocationResourceTags?: RequestIpamResourceTag[]; /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
Remove tag allocation rules from a pool.
*/ - DryRun?: boolean; + RemoveAllocationResourceTags?: RequestIpamResourceTag[]; } -export namespace ModifySnapshotAttributeRequest { +export namespace ModifyIpamPoolRequest { /** * @internal */ - export const filterSensitiveLog = (obj: ModifySnapshotAttributeRequest): any => ({ + export const filterSensitiveLog = (obj: ModifyIpamPoolRequest): any => ({ ...obj, }); } -export enum TargetStorageTier { - archive = "archive", -} - -export interface ModifySnapshotTierRequest { - /** - *The ID of the snapshot.
- */ - SnapshotId: string | undefined; - - /** - *The name of the storage tier. You must specify archive.
Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The results of the modification.
*/ - DryRun?: boolean; + IpamPool?: IpamPool; } -export namespace ModifySnapshotTierRequest { +export namespace ModifyIpamPoolResult { /** * @internal */ - export const filterSensitiveLog = (obj: ModifySnapshotTierRequest): any => ({ + export const filterSensitiveLog = (obj: ModifyIpamPoolResult): any => ({ ...obj, }); } -export interface ModifySnapshotTierResult { +export interface ModifyIpamResourceCidrRequest { /** - *The ID of the snapshot.
+ *A check for whether you have the required permissions for the action without actually making the request
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The date and time when the archive process was started.
+ *The ID of the resource you want to modify.
*/ - TieringStartTime?: Date; -} + ResourceId: string | undefined; -export namespace ModifySnapshotTierResult { /** - * @internal + *The CIDR of the resource you want to modify.
*/ - export const filterSensitiveLog = (obj: ModifySnapshotTierResult): any => ({ - ...obj, - }); -} + ResourceCidr: string | undefined; -/** - *Contains the parameters for ModifySpotFleetRequest.
- */ -export interface ModifySpotFleetRequestRequest { /** - *Indicates whether running Spot Instances should be terminated if the target capacity - * of the Spot Fleet request is decreased below the current size of the Spot Fleet.
+ *The Amazon Web Services Region of the resource you want to modify.
*/ - ExcessCapacityTerminationPolicy?: ExcessCapacityTerminationPolicy | string; + ResourceRegion: string | undefined; /** - *The launch template and overrides. You can only use this parameter if you specified a
- * launch template (LaunchTemplateConfigs) in your Spot Fleet request. If you
- * specified LaunchSpecifications in your Spot Fleet request, then omit this
- * parameter.
The ID of the current scope that the resource CIDR is in.
*/ - LaunchTemplateConfigs?: LaunchTemplateConfig[]; + CurrentIpamScopeId: string | undefined; /** - *The ID of the Spot Fleet request.
+ *The ID of the scope you want to transfer the resource CIDR to.
*/ - SpotFleetRequestId: string | undefined; + DestinationIpamScopeId?: string; /** - *The size of the fleet.
+ *Determines if the resource is monitored by IPAM. If a resource is monitored, the resource is discovered by IPAM and you can view details about the resource’s CIDR.
*/ - TargetCapacity?: number; + Monitored: boolean | undefined; +} +export namespace ModifyIpamResourceCidrRequest { /** - *The number of On-Demand Instances in the fleet.
+ * @internal */ - OnDemandTargetCapacity?: number; + export const filterSensitiveLog = (obj: ModifyIpamResourceCidrRequest): any => ({ + ...obj, + }); +} +export interface ModifyIpamResourceCidrResult { /** - *Reserved.
+ *The CIDR for an IPAM resource.
*/ - Context?: string; + IpamResourceCidr?: IpamResourceCidr; } -export namespace ModifySpotFleetRequestRequest { +export namespace ModifyIpamResourceCidrResult { /** * @internal */ - export const filterSensitiveLog = (obj: ModifySpotFleetRequestRequest): any => ({ + export const filterSensitiveLog = (obj: ModifyIpamResourceCidrResult): any => ({ ...obj, }); } -/** - *Contains the output of ModifySpotFleetRequest.
- */ -export interface ModifySpotFleetRequestResponse { +export interface ModifyIpamScopeRequest { /** - *Is true if the request succeeds, and an error otherwise.
A check for whether you have the required permissions for the action without actually making the request
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The ID of the scope you want to modify.
+ */ + IpamScopeId: string | undefined; + + /** + *The description of the scope you want to modify.
+ */ + Description?: string; } -export namespace ModifySpotFleetRequestResponse { +export namespace ModifyIpamScopeRequest { /** * @internal */ - export const filterSensitiveLog = (obj: ModifySpotFleetRequestResponse): any => ({ + export const filterSensitiveLog = (obj: ModifyIpamScopeRequest): any => ({ ...obj, }); } -export interface ModifySubnetAttributeRequest { +export interface ModifyIpamScopeResult { /** - *Specify true to indicate that network interfaces created in the
- * specified subnet should be assigned an IPv6 address. This includes a network interface
- * that's created when launching an instance into the subnet (the instance therefore
- * receives an IPv6 address).
If you enable the IPv6 addressing feature for your subnet, your network interface
- * or instance only receives an IPv6 address if it's created using version
- * 2016-11-15 or later of the Amazon EC2 API.
The results of the modification.
*/ - AssignIpv6AddressOnCreation?: AttributeBooleanValue; + IpamScope?: IpamScope; +} +export namespace ModifyIpamScopeResult { /** - *Specify true to indicate that network interfaces attached to instances created in the
- * specified subnet should be assigned a public IPv4 address.
The ID of the subnet.
+ *Checks whether you have the required permissions for the action, without actually
+ * making the request, and provides an error response. If you have the required
+ * permissions, the error response is DryRunOperation. Otherwise, it is
+ * UnauthorizedOperation.
Specify true to indicate that network interfaces attached to instances created in the
- * specified subnet should be assigned a customer-owned IPv4 address.
When this value is true, you must specify the customer-owned IP pool using CustomerOwnedIpv4Pool.
Unique, case-sensitive identifier you provide to ensure the idempotency of the + * request. For more information, see Ensuring + * Idempotency.
+ *Constraint: Maximum 128 ASCII characters.
*/ - MapCustomerOwnedIpOnLaunch?: AttributeBooleanValue; + ClientToken?: string; /** - *The customer-owned IPv4 address pool associated with the subnet.
- *You must set this value when you specify true for MapCustomerOwnedIpOnLaunch.
The ID of the launch template. You must specify either the launch template ID or + * launch template name in the request.
*/ - CustomerOwnedIpv4Pool?: string; + LaunchTemplateId?: string; /** - *Indicates whether DNS queries made to the Amazon-provided DNS Resolver in this subnet - * should return synthetic IPv6 addresses for IPv4-only destinations.
+ *The name of the launch template. You must specify either the launch template ID or + * launch template name in the request.
*/ - EnableDns64?: AttributeBooleanValue; + LaunchTemplateName?: string; /** - *The type of hostnames to assign to instances in the subnet at launch. For IPv4 only subnets, an - * instance DNS name must be based on the instance IPv4 address. For IPv6 only subnets, an instance - * DNS name must be based on the instance ID. For dual-stack subnets, you can specify whether DNS - * names use the instance IPv4 address or the instance ID.
+ *The version number of the launch template to set as the default version.
*/ - PrivateDnsHostnameTypeOnLaunch?: HostnameType | string; + DefaultVersion?: string; +} +export namespace ModifyLaunchTemplateRequest { /** - *Indicates whether to respond to DNS queries for instance hostnames with DNS A records.
+ * @internal */ - EnableResourceNameDnsARecordOnLaunch?: AttributeBooleanValue; + export const filterSensitiveLog = (obj: ModifyLaunchTemplateRequest): any => ({ + ...obj, + }); +} +export interface ModifyLaunchTemplateResult { /** - *Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records.
+ *Information about the launch template.
*/ - EnableResourceNameDnsAAAARecordOnLaunch?: AttributeBooleanValue; + LaunchTemplate?: LaunchTemplate; +} +export namespace ModifyLaunchTemplateResult { /** - *
- * Indicates the device position for local network interfaces in this subnet. For example,
- * 1 indicates local network interfaces in this subnet are the secondary
- * network interface (eth1). A local network interface cannot be the primary network
- * interface (eth0).
- *
An entry for a prefix list.
+ */ +export interface RemovePrefixListEntry { /** - *
- * Specify true to indicate that local network interfaces at the current
- * position should be disabled.
- *
The CIDR block.
*/ - DisableLniAtDeviceIndex?: AttributeBooleanValue; + Cidr: string | undefined; } -export namespace ModifySubnetAttributeRequest { +export namespace RemovePrefixListEntry { /** * @internal */ - export const filterSensitiveLog = (obj: ModifySubnetAttributeRequest): any => ({ + export const filterSensitiveLog = (obj: RemovePrefixListEntry): any => ({ ...obj, }); } -export interface ModifyTrafficMirrorFilterNetworkServicesRequest { +export interface ModifyManagedPrefixListRequest { /** - *The ID of the Traffic Mirror filter.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The network service, for example Amazon DNS, that you want to mirror.
+ *The ID of the prefix list.
*/ - AddNetworkServices?: (TrafficMirrorNetworkService | string)[]; + PrefixListId: string | undefined; /** - *The network service, for example Amazon DNS, that you no longer want to mirror.
+ *The current version of the prefix list.
*/ - RemoveNetworkServices?: (TrafficMirrorNetworkService | string)[]; + CurrentVersion?: number; /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
A name for the prefix list.
*/ - DryRun?: boolean; -} + PrefixListName?: string; -export namespace ModifyTrafficMirrorFilterNetworkServicesRequest { /** - * @internal + *One or more entries to add to the prefix list.
*/ - export const filterSensitiveLog = (obj: ModifyTrafficMirrorFilterNetworkServicesRequest): any => ({ - ...obj, - }); -} + AddEntries?: AddPrefixListEntry[]; -export interface ModifyTrafficMirrorFilterNetworkServicesResult { /** - *The Traffic Mirror filter that the network service is associated with.
+ *One or more entries to remove from the prefix list.
*/ - TrafficMirrorFilter?: TrafficMirrorFilter; + RemoveEntries?: RemovePrefixListEntry[]; + + /** + *The maximum number of entries for the prefix list. You cannot modify the entries + * of a prefix list and modify the size of a prefix list at the same time.
+ *If any of the resources that reference the prefix list cannot support the new + * maximum size, the modify operation fails. Check the state message for the IDs of + * the first ten resources that do not support the new maximum size.
+ */ + MaxEntries?: number; } -export namespace ModifyTrafficMirrorFilterNetworkServicesResult { +export namespace ModifyManagedPrefixListRequest { /** * @internal */ - export const filterSensitiveLog = (obj: ModifyTrafficMirrorFilterNetworkServicesResult): any => ({ + export const filterSensitiveLog = (obj: ModifyManagedPrefixListRequest): any => ({ ...obj, }); } -export type TrafficMirrorFilterRuleField = "description" | "destination-port-range" | "protocol" | "source-port-range"; - -export interface ModifyTrafficMirrorFilterRuleRequest { - /** - *The ID of the Traffic Mirror rule.
- */ - TrafficMirrorFilterRuleId: string | undefined; - +export interface ModifyManagedPrefixListResult { /** - *The type of traffic to assign to the rule.
+ *Information about the prefix list.
*/ - TrafficDirection?: TrafficDirection | string; + PrefixList?: ManagedPrefixList; +} +export namespace ModifyManagedPrefixListResult { /** - *The number of the Traffic Mirror rule. This number must be unique for each Traffic Mirror rule in a given - * direction. The rules are processed in ascending order by rule number.
+ * @internal */ - RuleNumber?: number; + export const filterSensitiveLog = (obj: ModifyManagedPrefixListResult): any => ({ + ...obj, + }); +} +/** + *Describes an attachment change.
+ */ +export interface NetworkInterfaceAttachmentChanges { /** - *The action to assign to the rule.
+ *The ID of the network interface attachment.
*/ - RuleAction?: TrafficMirrorRuleAction | string; + AttachmentId?: string; /** - *The destination ports that are associated with the Traffic Mirror rule.
+ *Indicates whether the network interface is deleted when the instance is terminated.
*/ - DestinationPortRange?: TrafficMirrorPortRangeRequest; + DeleteOnTermination?: boolean; +} +export namespace NetworkInterfaceAttachmentChanges { /** - *The port range to assign to the Traffic Mirror rule.
+ * @internal */ - SourcePortRange?: TrafficMirrorPortRangeRequest; + export const filterSensitiveLog = (obj: NetworkInterfaceAttachmentChanges): any => ({ + ...obj, + }); +} +/** + *Contains the parameters for ModifyNetworkInterfaceAttribute.
+ */ +export interface ModifyNetworkInterfaceAttributeRequest { /** - *The protocol, for example TCP, to assign to the Traffic Mirror rule.
+ *Information about the interface attachment. If modifying the 'delete on termination' attribute, you must specify the ID of the interface attachment.
*/ - Protocol?: number; + Attachment?: NetworkInterfaceAttachmentChanges; /** - *The destination CIDR block to assign to the Traffic Mirror rule.
+ *A description for the network interface.
*/ - DestinationCidrBlock?: string; + Description?: AttributeValue; /** - *The source CIDR block to assign to the Traffic Mirror rule.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The description to assign to the Traffic Mirror rule.
+ *Changes the security groups for the network interface. The new set of groups you specify replaces the current set. You must specify at least one group, even if it's just the default security group in the VPC. You must specify the ID of the security group, not the name.
*/ - Description?: string; + Groups?: string[]; /** - *The properties that you want to remove from the Traffic Mirror filter rule.
- *When you remove a property from a Traffic Mirror filter rule, the property is set to the default.
+ *The ID of the network interface.
*/ - RemoveFields?: (TrafficMirrorFilterRuleField | string)[]; + NetworkInterfaceId: string | undefined; /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
Enable or disable source/destination checks, which ensure that the instance
+ * is either the source or the destination of any traffic that it receives.
+ * If the value is true, source/destination checks are enabled;
+ * otherwise, they are disabled. The default value is true.
+ * You must disable source/destination checks if the instance runs services
+ * such as network address translation, routing, or firewalls.
Modifies a Traffic Mirror rule.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The ID of the instance.
*/ - export const filterSensitiveLog = (obj: ModifyTrafficMirrorFilterRuleResult): any => ({ - ...obj, - }); -} - -export type TrafficMirrorSessionField = "description" | "packet-length" | "virtual-network-id"; + InstanceId?: string; -export interface ModifyTrafficMirrorSessionRequest { /** - *The ID of the Traffic Mirror session.
+ *The type of hostname for EC2 instances. For IPv4 only subnets, an instance DNS name must be + * based on the instance IPv4 address. For IPv6 only subnets, an instance DNS name must be based + * on the instance ID. For dual-stack subnets, you can specify whether DNS names use the instance + * IPv4 address or the instance ID.
*/ - TrafficMirrorSessionId: string | undefined; + PrivateDnsHostnameType?: HostnameType | string; /** - *The Traffic Mirror target. The target must be in the same VPC as the source, or have a VPC peering connection with the source.
+ *Indicates whether to respond to DNS queries for instance hostnames with DNS A records.
*/ - TrafficMirrorTargetId?: string; + EnableResourceNameDnsARecord?: boolean; /** - *The ID of the Traffic Mirror filter.
+ *Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records.
*/ - TrafficMirrorFilterId?: string; + EnableResourceNameDnsAAAARecord?: boolean; +} +export namespace ModifyPrivateDnsNameOptionsRequest { /** - *The number of bytes in each packet to mirror. These are bytes after the VXLAN header. To mirror a subset, set this to the length (in bytes) to mirror. For example, if you set this value to 100, then the first 100 bytes that meet the filter criteria are copied to the target. Do not specify this parameter when you want to mirror the entire packet.
+ * @internal */ - PacketLength?: number; + export const filterSensitiveLog = (obj: ModifyPrivateDnsNameOptionsRequest): any => ({ + ...obj, + }); +} - /** - *The session number determines the order in which sessions are evaluated when an interface is used by multiple sessions. The first session with a matching filter is the one that mirrors the packets.
- *Valid values are 1-32766.
+export interface ModifyPrivateDnsNameOptionsResult { + /** + *Returns true if the request succeeds; otherwise, it returns an error.
The virtual network ID of the Traffic Mirror session.
+ * @internal */ - VirtualNetworkId?: number; + export const filterSensitiveLog = (obj: ModifyPrivateDnsNameOptionsResult): any => ({ + ...obj, + }); +} +/** + *Contains the parameters for ModifyReservedInstances.
+ */ +export interface ModifyReservedInstancesRequest { /** - *The description to assign to the Traffic Mirror session.
+ *The IDs of the Reserved Instances to modify.
*/ - Description?: string; + ReservedInstancesIds: string[] | undefined; /** - *The properties that you want to remove from the Traffic Mirror session.
- *When you remove a property from a Traffic Mirror session, the property is set to the default.
+ *A unique, case-sensitive token you provide to ensure idempotency of your modification request. For more information, see + * Ensuring Idempotency.
*/ - RemoveFields?: (TrafficMirrorSessionField | string)[]; + ClientToken?: string; /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The configuration settings for the Reserved Instances to modify.
*/ - DryRun?: boolean; + TargetConfigurations: ReservedInstancesConfiguration[] | undefined; } -export namespace ModifyTrafficMirrorSessionRequest { +export namespace ModifyReservedInstancesRequest { /** * @internal */ - export const filterSensitiveLog = (obj: ModifyTrafficMirrorSessionRequest): any => ({ + export const filterSensitiveLog = (obj: ModifyReservedInstancesRequest): any => ({ ...obj, }); } -export interface ModifyTrafficMirrorSessionResult { +/** + *Contains the output of ModifyReservedInstances.
+ */ +export interface ModifyReservedInstancesResult { /** - *Information about the Traffic Mirror session.
+ *The ID for the modification.
*/ - TrafficMirrorSession?: TrafficMirrorSession; + ReservedInstancesModificationId?: string; } -export namespace ModifyTrafficMirrorSessionResult { +export namespace ModifyReservedInstancesResult { /** * @internal */ - export const filterSensitiveLog = (obj: ModifyTrafficMirrorSessionResult): any => ({ + export const filterSensitiveLog = (obj: ModifyReservedInstancesResult): any => ({ ...obj, }); } /** - *The transit gateway options.
+ *Describes a security group rule.
+ *You must specify exactly one of the following parameters, based on the rule type:
+ *CidrIpv4
+ *CidrIpv6
+ *PrefixListId
+ *ReferencedGroupId
+ *When you modify a rule, you cannot change the rule type. For example, if the rule
+ * uses an IPv4 address range, you must use CidrIpv4 to specify a new IPv4
+ * address range.
Adds IPv4 or IPv6 CIDR blocks for the transit gateway. Must be a size /24 CIDR block or larger for IPv4, or a size /64 CIDR block or larger for IPv6.
- */ - AddTransitGatewayCidrBlocks?: string[]; - +export interface SecurityGroupRuleRequest { /** - *Removes CIDR blocks for the transit gateway.
+ *The IP protocol name (tcp, udp, icmp,
+ * icmpv6) or number (see Protocol Numbers).
Use -1 to specify all protocols.
Enable or disable Equal Cost Multipath Protocol support.
+ *The start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type. A value of -1 indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all codes.
*/ - VpnEcmpSupport?: VpnEcmpSupportValue | string; + FromPort?: number; /** - *Enable or disable DNS support.
+ *The end of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code. A value of -1 indicates all ICMP/ICMPv6 codes. If you specify all ICMP/ICMPv6 types, you must specify all codes.
Enable or disable automatic acceptance of attachment requests.
+ *The IPv4 CIDR range. To specify a single IPv4 address, use the /32 prefix length.
*/ - AutoAcceptSharedAttachments?: AutoAcceptSharedAttachmentsValue | string; + CidrIpv4?: string; /** - *Enable or disable automatic association with the default association route table.
+ *The IPv6 CIDR range. To specify a single IPv6 address, use the /128 prefix length.
*/ - DefaultRouteTableAssociation?: DefaultRouteTableAssociationValue | string; + CidrIpv6?: string; /** - *The ID of the default association route table.
+ *The ID of the prefix list.
*/ - AssociationDefaultRouteTableId?: string; + PrefixListId?: string; /** - *Enable or disable automatic propagation of routes to the default propagation route table.
+ *The ID of the security group that is referenced in the security group rule.
*/ - DefaultRouteTablePropagation?: DefaultRouteTablePropagationValue | string; + ReferencedGroupId?: string; /** - *The ID of the default propagation route table.
+ *The description of the security group rule.
*/ - PropagationDefaultRouteTableId?: string; + Description?: string; } -export namespace ModifyTransitGatewayOptions { +export namespace SecurityGroupRuleRequest { /** * @internal */ - export const filterSensitiveLog = (obj: ModifyTransitGatewayOptions): any => ({ + export const filterSensitiveLog = (obj: SecurityGroupRuleRequest): any => ({ ...obj, }); } -export interface ModifyTransitGatewayRequest { +/** + *Describes an update to a security group rule.
+ */ +export interface SecurityGroupRuleUpdate { /** - *The ID of the transit gateway.
+ *The ID of the security group rule.
*/ - TransitGatewayId: string | undefined; + SecurityGroupRuleId?: string; /** - *The description for the transit gateway.
+ *Information about the security group rule.
*/ - Description?: string; + SecurityGroupRule?: SecurityGroupRuleRequest; +} +export namespace SecurityGroupRuleUpdate { /** - *The options to modify.
+ * @internal */ - Options?: ModifyTransitGatewayOptions; + export const filterSensitiveLog = (obj: SecurityGroupRuleUpdate): any => ({ + ...obj, + }); +} + +export interface ModifySecurityGroupRulesRequest { + /** + *The ID of the security group.
+ */ + GroupId: string | undefined; + + /** + *Information about the security group properties to update.
+ */ + SecurityGroupRules: SecurityGroupRuleUpdate[] | undefined; /** *Checks whether you have the required permissions for the action, without actually making the request, @@ -5765,51 +5561,85 @@ export interface ModifyTransitGatewayRequest { DryRun?: boolean; } -export namespace ModifyTransitGatewayRequest { +export namespace ModifySecurityGroupRulesRequest { /** * @internal */ - export const filterSensitiveLog = (obj: ModifyTransitGatewayRequest): any => ({ + export const filterSensitiveLog = (obj: ModifySecurityGroupRulesRequest): any => ({ ...obj, }); } -export interface ModifyTransitGatewayResult { +export interface ModifySecurityGroupRulesResult { /** - *
Describes a transit gateway.
+ *Returns true if the request succeeds; otherwise, returns an error.
Describes modifications to the list of create volume permissions for a volume.
+ */ +export interface CreateVolumePermissionModifications { /** - *The ID of the transit gateway route table.
+ *Adds the specified Amazon Web Services account ID or group to the list.
*/ - TransitGatewayRouteTableId: string | undefined; + Add?: CreateVolumePermission[]; /** - *The ID of the prefix list.
+ *Removes the specified Amazon Web Services account ID or group from the list.
*/ - PrefixListId: string | undefined; + Remove?: CreateVolumePermission[]; +} +export namespace CreateVolumePermissionModifications { /** - *The ID of the attachment to which traffic is routed.
+ * @internal */ - TransitGatewayAttachmentId?: string; + export const filterSensitiveLog = (obj: CreateVolumePermissionModifications): any => ({ + ...obj, + }); +} +export interface ModifySnapshotAttributeRequest { /** - *Indicates whether to drop traffic that matches this route.
+ *The snapshot attribute to modify. Only volume creation permissions can be modified.
*/ - Blackhole?: boolean; + Attribute?: SnapshotAttributeName | string; + + /** + *A JSON representation of the snapshot attribute modification.
+ */ + CreateVolumePermission?: CreateVolumePermissionModifications; + + /** + *The group to modify for the snapshot.
+ */ + GroupNames?: string[]; + + /** + *The type of operation to perform to the attribute.
+ */ + OperationType?: OperationType | string; + + /** + *The ID of the snapshot.
+ */ + SnapshotId: string | undefined; + + /** + *The account ID to modify for the snapshot.
+ */ + UserIds?: string[]; /** *Checks whether you have the required permissions for the action, without actually making the request, @@ -5819,236 +5649,238 @@ export interface ModifyTransitGatewayPrefixListReferenceRequest { DryRun?: boolean; } -export namespace ModifyTransitGatewayPrefixListReferenceRequest { +export namespace ModifySnapshotAttributeRequest { /** * @internal */ - export const filterSensitiveLog = (obj: ModifyTransitGatewayPrefixListReferenceRequest): any => ({ + export const filterSensitiveLog = (obj: ModifySnapshotAttributeRequest): any => ({ ...obj, }); } -export interface ModifyTransitGatewayPrefixListReferenceResult { +export enum TargetStorageTier { + archive = "archive", +} + +export interface ModifySnapshotTierRequest { /** - *
Information about the prefix list reference.
+ *The ID of the snapshot.
*/ - TransitGatewayPrefixListReference?: TransitGatewayPrefixListReference; + SnapshotId: string | undefined; + + /** + *The name of the storage tier. You must specify archive.
Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Describes the options for a VPC attachment.
- */ -export interface ModifyTransitGatewayVpcAttachmentRequestOptions { - /** - *Enable or disable DNS support. The default is enable.
Enable or disable IPv6 support. The default is enable.
The ID of the snapshot.
*/ - Ipv6Support?: Ipv6SupportValue | string; + SnapshotId?: string; /** - *Enable or disable support for appliance mode. If enabled, a traffic flow between a source and destination uses the same Availability Zone for the VPC attachment for the lifetime of that flow. The default is disable.
The date and time when the archive process was started.
*/ - ApplianceModeSupport?: ApplianceModeSupportValue | string; + TieringStartTime?: Date; } -export namespace ModifyTransitGatewayVpcAttachmentRequestOptions { +export namespace ModifySnapshotTierResult { /** * @internal */ - export const filterSensitiveLog = (obj: ModifyTransitGatewayVpcAttachmentRequestOptions): any => ({ + export const filterSensitiveLog = (obj: ModifySnapshotTierResult): any => ({ ...obj, }); } -export interface ModifyTransitGatewayVpcAttachmentRequest { +/** + *Contains the parameters for ModifySpotFleetRequest.
+ */ +export interface ModifySpotFleetRequestRequest { /** - *The ID of the attachment.
+ *Indicates whether running Spot Instances should be terminated if the target capacity + * of the Spot Fleet request is decreased below the current size of the Spot Fleet.
*/ - TransitGatewayAttachmentId: string | undefined; + ExcessCapacityTerminationPolicy?: ExcessCapacityTerminationPolicy | string; /** - *The IDs of one or more subnets to add. You can specify at most one subnet per Availability Zone.
+ *The launch template and overrides. You can only use this parameter if you specified a
+ * launch template (LaunchTemplateConfigs) in your Spot Fleet request. If you
+ * specified LaunchSpecifications in your Spot Fleet request, then omit this
+ * parameter.
The IDs of one or more subnets to remove.
+ *The ID of the Spot Fleet request.
*/ - RemoveSubnetIds?: string[]; + SpotFleetRequestId: string | undefined; /** - *The new VPC attachment options.
+ *The size of the fleet.
*/ - Options?: ModifyTransitGatewayVpcAttachmentRequestOptions; + TargetCapacity?: number; /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The number of On-Demand Instances in the fleet.
*/ - DryRun?: boolean; + OnDemandTargetCapacity?: number; + + /** + *Reserved.
+ */ + Context?: string; } -export namespace ModifyTransitGatewayVpcAttachmentRequest { +export namespace ModifySpotFleetRequestRequest { /** * @internal */ - export const filterSensitiveLog = (obj: ModifyTransitGatewayVpcAttachmentRequest): any => ({ + export const filterSensitiveLog = (obj: ModifySpotFleetRequestRequest): any => ({ ...obj, }); } -export interface ModifyTransitGatewayVpcAttachmentResult { +/** + *Contains the output of ModifySpotFleetRequest.
+ */ +export interface ModifySpotFleetRequestResponse { /** - *Information about the modified attachment.
+ *Is true if the request succeeds, and an error otherwise.
Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
Specify true to indicate that network interfaces created in the
+ * specified subnet should be assigned an IPv6 address. This includes a network interface
+ * that's created when launching an instance into the subnet (the instance therefore
+ * receives an IPv6 address).
If you enable the IPv6 addressing feature for your subnet, your network interface
+ * or instance only receives an IPv6 address if it's created using version
+ * 2016-11-15 or later of the Amazon EC2 API.
The ID of the volume.
+ *Specify true to indicate that network interfaces attached to instances created in the
+ * specified subnet should be assigned a public IPv4 address.
The target size of the volume, in GiB. The target volume size must be greater than or - * equal to the existing size of the volume.
- *The following are the supported volumes sizes for each volume type:
- *
- * gp2 and gp3: 1-16,384
- * io1 and io2: 4-16,384
- * st1 and sc1: 125-16,384
- * standard: 1-1,024
Default: The existing size is retained.
+ *The ID of the subnet.
*/ - Size?: number; + SubnetId: string | undefined; /** - *The target EBS volume type of the volume. For more information, see Amazon EBS volume types in the Amazon Elastic Compute Cloud User Guide.
- *Default: The existing type is retained.
+ *Specify true to indicate that network interfaces attached to instances created in the
+ * specified subnet should be assigned a customer-owned IPv4 address.
When this value is true, you must specify the customer-owned IP pool using CustomerOwnedIpv4Pool.
The target IOPS rate of the volume. This parameter is valid only for gp3, io1, and io2 volumes.
The following are the supported values for each volume type:
- *
- * gp3: 3,000-16,000 IOPS
- * io1: 100-64,000 IOPS
- * io2: 100-64,000 IOPS
Default: The existing value is retained if you keep the same volume type. If you change
- * the volume type to io1, io2, or gp3, the default is 3,000.
The customer-owned IPv4 address pool associated with the subnet.
+ *You must set this value when you specify true for MapCustomerOwnedIpOnLaunch.
The target throughput of the volume, in MiB/s. This parameter is valid only for gp3 volumes.
- * The maximum value is 1,000.
Default: The existing value is retained if the source and target volume type is gp3.
- * Otherwise, the default value is 125.
Valid Range: Minimum value of 125. Maximum value of 1000.
+ *Indicates whether DNS queries made to the Amazon-provided DNS Resolver in this subnet + * should return synthetic IPv6 addresses for IPv4-only destinations.
*/ - Throughput?: number; + EnableDns64?: AttributeBooleanValue; /** - *Specifies whether to enable Amazon EBS Multi-Attach. If you enable Multi-Attach, you can attach the
- * volume to up to 16
- * Nitro-based instances in the same Availability Zone. This parameter is
- * supported with io1 and io2 volumes only. For more information, see
- *
- * Amazon EBS Multi-Attach in the Amazon Elastic Compute Cloud User Guide.
The type of hostnames to assign to instances in the subnet at launch. For IPv4 only subnets, an + * instance DNS name must be based on the instance IPv4 address. For IPv6 only subnets, an instance + * DNS name must be based on the instance ID. For dual-stack subnets, you can specify whether DNS + * names use the instance IPv4 address or the instance ID.
*/ - MultiAttachEnabled?: boolean; -} + PrivateDnsHostnameTypeOnLaunch?: HostnameType | string; -export namespace ModifyVolumeRequest { /** - * @internal + *Indicates whether to respond to DNS queries for instance hostnames with DNS A records.
*/ - export const filterSensitiveLog = (obj: ModifyVolumeRequest): any => ({ - ...obj, - }); -} + EnableResourceNameDnsARecordOnLaunch?: AttributeBooleanValue; -export interface ModifyVolumeResult { /** - *Information about the volume modification.
+ *Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records.
*/ - VolumeModification?: VolumeModification; + EnableResourceNameDnsAAAARecordOnLaunch?: AttributeBooleanValue; + + /** + *
+ * Indicates the device position for local network interfaces in this subnet. For example,
+ * 1 indicates local network interfaces in this subnet are the secondary
+ * network interface (eth1). A local network interface cannot be the primary network
+ * interface (eth0).
+ *
+ * Specify true to indicate that local network interfaces at the current
+ * position should be disabled.
+ *
Indicates whether the volume should be auto-enabled for I/O operations.
+ *The ID of the Traffic Mirror filter.
*/ - AutoEnableIO?: AttributeBooleanValue; + TrafficMirrorFilterId: string | undefined; /** - *The ID of the volume.
+ *The network service, for example Amazon DNS, that you want to mirror.
*/ - VolumeId: string | undefined; + AddNetworkServices?: (TrafficMirrorNetworkService | string)[]; + + /** + *The network service, for example Amazon DNS, that you no longer want to mirror.
+ */ + RemoveNetworkServices?: (TrafficMirrorNetworkService | string)[]; /** *Checks whether you have the required permissions for the action, without actually making the request, @@ -6058,399 +5890,413 @@ export interface ModifyVolumeAttributeRequest { DryRun?: boolean; } -export namespace ModifyVolumeAttributeRequest { +export namespace ModifyTrafficMirrorFilterNetworkServicesRequest { /** * @internal */ - export const filterSensitiveLog = (obj: ModifyVolumeAttributeRequest): any => ({ + export const filterSensitiveLog = (obj: ModifyTrafficMirrorFilterNetworkServicesRequest): any => ({ ...obj, }); } -export interface ModifyVpcAttributeRequest { - /** - *
Indicates whether the instances launched in the VPC get DNS hostnames. If enabled, instances in the VPC get DNS hostnames; otherwise, they do not.
- *You cannot modify the DNS resolution and DNS hostnames attributes in the same request. Use separate requests for each attribute. You can only enable DNS hostnames if you've enabled DNS support.
- */ - EnableDnsHostnames?: AttributeBooleanValue; - - /** - *Indicates whether the DNS resolution is supported for the VPC. If enabled, queries to - * the Amazon provided DNS server at the 169.254.169.253 IP address, or the reserved IP - * address at the base of the VPC network range "plus two" succeed. If disabled, the Amazon - * provided DNS service in the VPC that resolves public DNS hostnames to IP addresses is - * not enabled.
- *You cannot modify the DNS resolution and DNS hostnames attributes in the same request. Use separate requests for each attribute.
- */ - EnableDnsSupport?: AttributeBooleanValue; - +export interface ModifyTrafficMirrorFilterNetworkServicesResult { /** - *The ID of the VPC.
+ *The Traffic Mirror filter that the network service is associated with.
*/ - VpcId: string | undefined; + TrafficMirrorFilter?: TrafficMirrorFilter; } -export namespace ModifyVpcAttributeRequest { +export namespace ModifyTrafficMirrorFilterNetworkServicesResult { /** * @internal */ - export const filterSensitiveLog = (obj: ModifyVpcAttributeRequest): any => ({ + export const filterSensitiveLog = (obj: ModifyTrafficMirrorFilterNetworkServicesResult): any => ({ ...obj, }); } -/** - *Contains the parameters for ModifyVpcEndpoint.
- */ -export interface ModifyVpcEndpointRequest { +export type TrafficMirrorFilterRuleField = "description" | "destination-port-range" | "protocol" | "source-port-range"; + +export interface ModifyTrafficMirrorFilterRuleRequest { /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The ID of the Traffic Mirror rule.
*/ - DryRun?: boolean; + TrafficMirrorFilterRuleId: string | undefined; + + /** + *The type of traffic to assign to the rule.
+ */ + TrafficDirection?: TrafficDirection | string; /** - *The ID of the endpoint.
+ *The number of the Traffic Mirror rule. This number must be unique for each Traffic Mirror rule in a given + * direction. The rules are processed in ascending order by rule number.
*/ - VpcEndpointId: string | undefined; + RuleNumber?: number; /** - *(Gateway endpoint) Specify true to reset the policy document to the
- * default policy. The default policy allows full access to the service.
The action to assign to the rule.
*/ - ResetPolicy?: boolean; + RuleAction?: TrafficMirrorRuleAction | string; /** - *(Interface and gateway endpoints) A policy to attach to the endpoint that controls access to the service. The policy must - * be in valid JSON format.
+ *The destination ports that are associated with the Traffic Mirror rule.
*/ - PolicyDocument?: string; + DestinationPortRange?: TrafficMirrorPortRangeRequest; /** - *(Gateway endpoint) One or more route tables IDs to associate with the endpoint.
+ *The port range to assign to the Traffic Mirror rule.
*/ - AddRouteTableIds?: string[]; + SourcePortRange?: TrafficMirrorPortRangeRequest; /** - *(Gateway endpoint) One or more route table IDs to disassociate from the endpoint.
+ *The protocol, for example TCP, to assign to the Traffic Mirror rule.
*/ - RemoveRouteTableIds?: string[]; + Protocol?: number; /** - *(Interface and Gateway Load Balancer endpoints) One or more subnet IDs in which to serve the endpoint. For a Gateway Load Balancer endpoint, you can specify only one subnet.
+ *The destination CIDR block to assign to the Traffic Mirror rule.
*/ - AddSubnetIds?: string[]; + DestinationCidrBlock?: string; /** - *(Interface endpoint) One or more subnets IDs in which to remove the endpoint.
+ *The source CIDR block to assign to the Traffic Mirror rule.
*/ - RemoveSubnetIds?: string[]; + SourceCidrBlock?: string; /** - *(Interface endpoint) One or more security group IDs to associate with the network interface.
+ *The description to assign to the Traffic Mirror rule.
*/ - AddSecurityGroupIds?: string[]; + Description?: string; /** - *(Interface endpoint) One or more security group IDs to disassociate from the network interface.
+ *The properties that you want to remove from the Traffic Mirror filter rule.
+ *When you remove a property from a Traffic Mirror filter rule, the property is set to the default.
*/ - RemoveSecurityGroupIds?: string[]; + RemoveFields?: (TrafficMirrorFilterRuleField | string)[]; /** - *(Interface endpoint) Indicates whether a private hosted zone is associated with the - * VPC.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Returns true if the request succeeds; otherwise, it returns an error.
Modifies a Traffic Mirror rule.
*/ - Return?: boolean; + TrafficMirrorFilterRule?: TrafficMirrorFilterRule; } -export namespace ModifyVpcEndpointResult { +export namespace ModifyTrafficMirrorFilterRuleResult { /** * @internal */ - export const filterSensitiveLog = (obj: ModifyVpcEndpointResult): any => ({ + export const filterSensitiveLog = (obj: ModifyTrafficMirrorFilterRuleResult): any => ({ ...obj, }); } -export interface ModifyVpcEndpointConnectionNotificationRequest { +export type TrafficMirrorSessionField = "description" | "packet-length" | "virtual-network-id"; + +export interface ModifyTrafficMirrorSessionRequest { /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The ID of the Traffic Mirror session.
*/ - DryRun?: boolean; + TrafficMirrorSessionId: string | undefined; /** - *The ID of the notification.
+ *The Traffic Mirror target. The target must be in the same VPC as the source, or have a VPC peering connection with the source.
*/ - ConnectionNotificationId: string | undefined; + TrafficMirrorTargetId?: string; /** - *The ARN for the SNS topic for the notification.
+ *The ID of the Traffic Mirror filter.
*/ - ConnectionNotificationArn?: string; + TrafficMirrorFilterId?: string; /** - *One or more events for the endpoint. Valid values are Accept,
- * Connect, Delete, and Reject.
The number of bytes in each packet to mirror. These are bytes after the VXLAN header. To mirror a subset, set this to the length (in bytes) to mirror. For example, if you set this value to 100, then the first 100 bytes that meet the filter criteria are copied to the target. Do not specify this parameter when you want to mirror the entire packet.
*/ - ConnectionEvents?: string[]; + PacketLength?: number; + + /** + *The session number determines the order in which sessions are evaluated when an interface is used by multiple sessions. The first session with a matching filter is the one that mirrors the packets.
+ *Valid values are 1-32766.
+ */ + SessionNumber?: number; + + /** + *The virtual network ID of the Traffic Mirror session.
+ */ + VirtualNetworkId?: number; + + /** + *The description to assign to the Traffic Mirror session.
+ */ + Description?: string; + + /** + *The properties that you want to remove from the Traffic Mirror session.
+ *When you remove a property from a Traffic Mirror session, the property is set to the default.
+ */ + RemoveFields?: (TrafficMirrorSessionField | string)[]; + + /** + *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Returns true if the request succeeds; otherwise, it returns an error.
Information about the Traffic Mirror session.
*/ - ReturnValue?: boolean; + TrafficMirrorSession?: TrafficMirrorSession; } -export namespace ModifyVpcEndpointConnectionNotificationResult { +export namespace ModifyTrafficMirrorSessionResult { /** * @internal */ - export const filterSensitiveLog = (obj: ModifyVpcEndpointConnectionNotificationResult): any => ({ + export const filterSensitiveLog = (obj: ModifyTrafficMirrorSessionResult): any => ({ ...obj, }); } -export interface ModifyVpcEndpointServiceConfigurationRequest { +/** + *The transit gateway options.
+ */ +export interface ModifyTransitGatewayOptions { /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
Adds IPv4 or IPv6 CIDR blocks for the transit gateway. Must be a size /24 CIDR block or larger for IPv4, or a size /64 CIDR block or larger for IPv6.
*/ - DryRun?: boolean; + AddTransitGatewayCidrBlocks?: string[]; /** - *The ID of the service.
+ *Removes CIDR blocks for the transit gateway.
*/ - ServiceId: string | undefined; + RemoveTransitGatewayCidrBlocks?: string[]; /** - *(Interface endpoint configuration) The private DNS name to assign to the endpoint service.
+ *Enable or disable Equal Cost Multipath Protocol support.
*/ - PrivateDnsName?: string; + VpnEcmpSupport?: VpnEcmpSupportValue | string; /** - *(Interface endpoint configuration) Removes the private DNS name of the endpoint service.
+ *Enable or disable DNS support.
*/ - RemovePrivateDnsName?: boolean; + DnsSupport?: DnsSupportValue | string; /** - *Indicates whether requests to create an endpoint to your service must be accepted.
+ *Enable or disable automatic acceptance of attachment requests.
*/ - AcceptanceRequired?: boolean; + AutoAcceptSharedAttachments?: AutoAcceptSharedAttachmentsValue | string; /** - *The Amazon Resource Names (ARNs) of Network Load Balancers to add to your service - * configuration.
+ *Enable or disable automatic association with the default association route table.
*/ - AddNetworkLoadBalancerArns?: string[]; + DefaultRouteTableAssociation?: DefaultRouteTableAssociationValue | string; /** - *The Amazon Resource Names (ARNs) of Network Load Balancers to remove from your service - * configuration.
+ *The ID of the default association route table.
*/ - RemoveNetworkLoadBalancerArns?: string[]; + AssociationDefaultRouteTableId?: string; /** - *The Amazon Resource Names (ARNs) of Gateway Load Balancers to add to your service - * configuration.
+ *Enable or disable automatic propagation of routes to the default propagation route table.
*/ - AddGatewayLoadBalancerArns?: string[]; + DefaultRouteTablePropagation?: DefaultRouteTablePropagationValue | string; /** - *The Amazon Resource Names (ARNs) of Gateway Load Balancers to remove from your service - * configuration.
+ *The ID of the default propagation route table.
*/ - RemoveGatewayLoadBalancerArns?: string[]; + PropagationDefaultRouteTableId?: string; } -export namespace ModifyVpcEndpointServiceConfigurationRequest { +export namespace ModifyTransitGatewayOptions { /** * @internal */ - export const filterSensitiveLog = (obj: ModifyVpcEndpointServiceConfigurationRequest): any => ({ + export const filterSensitiveLog = (obj: ModifyTransitGatewayOptions): any => ({ ...obj, }); } -export interface ModifyVpcEndpointServiceConfigurationResult { +export interface ModifyTransitGatewayRequest { /** - *Returns true if the request succeeds; otherwise, it returns an error.
The ID of the transit gateway.
*/ - Return?: boolean; -} + TransitGatewayId: string | undefined; -export namespace ModifyVpcEndpointServiceConfigurationResult { /** - * @internal + *The description for the transit gateway.
*/ - export const filterSensitiveLog = (obj: ModifyVpcEndpointServiceConfigurationResult): any => ({ - ...obj, - }); -} + Description?: string; + + /** + *The options to modify.
+ */ + Options?: ModifyTransitGatewayOptions; -export interface ModifyVpcEndpointServicePayerResponsibilityRequest { /** *Checks whether you have the required permissions for the action, without actually making the request,
* and provides an error response. If you have the required permissions, the error response is DryRunOperation.
* Otherwise, it is UnauthorizedOperation.
The ID of the service.
- */ - ServiceId: string | undefined; - - /** - *The entity that is responsible for the endpoint costs. The default is the endpoint owner. - * If you set the payer responsibility to the service owner, you cannot set it back to the - * endpoint owner.
- */ - PayerResponsibility: PayerResponsibility | string | undefined; } -export namespace ModifyVpcEndpointServicePayerResponsibilityRequest { +export namespace ModifyTransitGatewayRequest { /** * @internal */ - export const filterSensitiveLog = (obj: ModifyVpcEndpointServicePayerResponsibilityRequest): any => ({ + export const filterSensitiveLog = (obj: ModifyTransitGatewayRequest): any => ({ ...obj, }); } -export interface ModifyVpcEndpointServicePayerResponsibilityResult { +export interface ModifyTransitGatewayResult { /** - *Returns true if the request succeeds; otherwise, it returns an error.
Describes a transit gateway.
*/ - ReturnValue?: boolean; + TransitGateway?: TransitGateway; } -export namespace ModifyVpcEndpointServicePayerResponsibilityResult { +export namespace ModifyTransitGatewayResult { /** * @internal */ - export const filterSensitiveLog = (obj: ModifyVpcEndpointServicePayerResponsibilityResult): any => ({ + export const filterSensitiveLog = (obj: ModifyTransitGatewayResult): any => ({ ...obj, }); } -export interface ModifyVpcEndpointServicePermissionsRequest { +export interface ModifyTransitGatewayPrefixListReferenceRequest { /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The ID of the transit gateway route table.
*/ - DryRun?: boolean; + TransitGatewayRouteTableId: string | undefined; /** - *The ID of the service.
+ *The ID of the prefix list.
*/ - ServiceId: string | undefined; + PrefixListId: string | undefined; /** - *The Amazon Resource Names (ARN) of one or more principals. - * Permissions are granted to the principals in this list. - * To grant permissions to all principals, specify an asterisk (*).
+ *The ID of the attachment to which traffic is routed.
*/ - AddAllowedPrincipals?: string[]; + TransitGatewayAttachmentId?: string; /** - *The Amazon Resource Names (ARN) of one or more principals. - * Permissions are revoked for principals in this list.
+ *Indicates whether to drop traffic that matches this route.
*/ - RemoveAllowedPrincipals?: string[]; + Blackhole?: boolean; + + /** + *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Returns true if the request succeeds; otherwise, it returns an error.
Information about the prefix list reference.
*/ - ReturnValue?: boolean; + TransitGatewayPrefixListReference?: TransitGatewayPrefixListReference; } -export namespace ModifyVpcEndpointServicePermissionsResult { +export namespace ModifyTransitGatewayPrefixListReferenceResult { /** * @internal */ - export const filterSensitiveLog = (obj: ModifyVpcEndpointServicePermissionsResult): any => ({ + export const filterSensitiveLog = (obj: ModifyTransitGatewayPrefixListReferenceResult): any => ({ ...obj, }); } /** - *The VPC peering connection options.
+ *Describes the options for a VPC attachment.
*/ -export interface PeeringConnectionOptionsRequest { +export interface ModifyTransitGatewayVpcAttachmentRequestOptions { /** - *If true, enables a local VPC to resolve public DNS hostnames to private IP addresses when queried from instances in the peer VPC.
+ *Enable or disable DNS support. The default is enable.
If true, enables outbound communication from an EC2-Classic instance that's linked to - * a local VPC using ClassicLink to instances in a peer VPC.
+ *Enable or disable IPv6 support. The default is enable.
If true, enables outbound communication from instances in a local VPC to an - * EC2-Classic instance that's linked to a peer VPC using ClassicLink.
+ *Enable or disable support for appliance mode. If enabled, a traffic flow between a source and destination uses the same Availability Zone for the VPC attachment for the lifetime of that flow. The default is disable.
The VPC peering connection options for the accepter VPC.
+ *The ID of the attachment.
*/ - AccepterPeeringConnectionOptions?: PeeringConnectionOptionsRequest; + TransitGatewayAttachmentId: string | undefined; + + /** + *The IDs of one or more subnets to add. You can specify at most one subnet per Availability Zone.
+ */ + AddSubnetIds?: string[]; + + /** + *The IDs of one or more subnets to remove.
+ */ + RemoveSubnetIds?: string[]; + + /** + *The new VPC attachment options.
+ */ + Options?: ModifyTransitGatewayVpcAttachmentRequestOptions; /** *Checks whether you have the required permissions for the action, without actually making the request,
@@ -6458,562 +6304,557 @@ export interface ModifyVpcPeeringConnectionOptionsRequest {
* Otherwise, it is UnauthorizedOperation.
The VPC peering connection options for the requester VPC.
+ * @internal */ - RequesterPeeringConnectionOptions?: PeeringConnectionOptionsRequest; + export const filterSensitiveLog = (obj: ModifyTransitGatewayVpcAttachmentRequest): any => ({ + ...obj, + }); +} +export interface ModifyTransitGatewayVpcAttachmentResult { /** - *The ID of the VPC peering connection.
+ *Information about the modified attachment.
*/ - VpcPeeringConnectionId: string | undefined; + TransitGatewayVpcAttachment?: TransitGatewayVpcAttachment; } -export namespace ModifyVpcPeeringConnectionOptionsRequest { +export namespace ModifyTransitGatewayVpcAttachmentResult { /** * @internal */ - export const filterSensitiveLog = (obj: ModifyVpcPeeringConnectionOptionsRequest): any => ({ + export const filterSensitiveLog = (obj: ModifyTransitGatewayVpcAttachmentResult): any => ({ ...obj, }); } -/** - *Describes the VPC peering connection options.
- */ -export interface PeeringConnectionOptions { +export interface ModifyVolumeRequest { /** - *If true, the public DNS hostnames of instances in the specified VPC resolve to private - * IP addresses when queried from instances in the peer VPC.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
If true, enables outbound communication from an EC2-Classic instance that's linked to - * a local VPC using ClassicLink to instances in a peer VPC.
+ *The ID of the volume.
*/ - AllowEgressFromLocalClassicLinkToRemoteVpc?: boolean; + VolumeId: string | undefined; /** - *If true, enables outbound communication from instances in a local VPC to an - * EC2-Classic instance that's linked to a peer VPC using ClassicLink.
+ *The target size of the volume, in GiB. The target volume size must be greater than or + * equal to the existing size of the volume.
+ *The following are the supported volumes sizes for each volume type:
+ *
+ * gp2 and gp3: 1-16,384
+ * io1 and io2: 4-16,384
+ * st1 and sc1: 125-16,384
+ * standard: 1-1,024
Default: The existing size is retained.
*/ - AllowEgressFromLocalVpcToRemoteClassicLink?: boolean; -} + Size?: number; -export namespace PeeringConnectionOptions { /** - * @internal + *The target EBS volume type of the volume. For more information, see Amazon EBS volume types in the Amazon Elastic Compute Cloud User Guide.
+ *Default: The existing type is retained.
*/ - export const filterSensitiveLog = (obj: PeeringConnectionOptions): any => ({ - ...obj, - }); -} + VolumeType?: VolumeType | string; -export interface ModifyVpcPeeringConnectionOptionsResult { /** - *Information about the VPC peering connection options for the accepter VPC.
+ *The target IOPS rate of the volume. This parameter is valid only for gp3, io1, and io2 volumes.
The following are the supported values for each volume type:
+ *
+ * gp3: 3,000-16,000 IOPS
+ * io1: 100-64,000 IOPS
+ * io2: 100-64,000 IOPS
Default: The existing value is retained if you keep the same volume type. If you change
+ * the volume type to io1, io2, or gp3, the default is 3,000.
Information about the VPC peering connection options for the requester VPC.
+ *The target throughput of the volume, in MiB/s. This parameter is valid only for gp3 volumes.
+ * The maximum value is 1,000.
Default: The existing value is retained if the source and target volume type is gp3.
+ * Otherwise, the default value is 125.
Valid Range: Minimum value of 125. Maximum value of 1000.
*/ - RequesterPeeringConnectionOptions?: PeeringConnectionOptions; + Throughput?: number; + + /** + *Specifies whether to enable Amazon EBS Multi-Attach. If you enable Multi-Attach, you can attach the
+ * volume to up to 16
+ * Nitro-based instances in the same Availability Zone. This parameter is
+ * supported with io1 and io2 volumes only. For more information, see
+ *
+ * Amazon EBS Multi-Attach in the Amazon Elastic Compute Cloud User Guide.
The ID of the VPC.
+ *Information about the volume modification.
*/ - VpcId: string | undefined; + VolumeModification?: VolumeModification; +} +export namespace ModifyVolumeResult { /** - *The instance tenancy attribute for the VPC.
+ * @internal */ - InstanceTenancy: VpcTenancy | string | undefined; + export const filterSensitiveLog = (obj: ModifyVolumeResult): any => ({ + ...obj, + }); +} +export interface ModifyVolumeAttributeRequest { /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
Indicates whether the volume should be auto-enabled for I/O operations.
*/ - DryRun?: boolean; -} + AutoEnableIO?: AttributeBooleanValue; -export namespace ModifyVpcTenancyRequest { /** - * @internal + *The ID of the volume.
*/ - export const filterSensitiveLog = (obj: ModifyVpcTenancyRequest): any => ({ - ...obj, - }); -} + VolumeId: string | undefined; -export interface ModifyVpcTenancyResult { /** - *Returns true if the request succeeds; otherwise, returns an
- * error.
Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The ID of the VPN connection.
+ *Indicates whether the instances launched in the VPC get DNS hostnames. If enabled, instances in the VPC get DNS hostnames; otherwise, they do not.
+ *You cannot modify the DNS resolution and DNS hostnames attributes in the same request. Use separate requests for each attribute. You can only enable DNS hostnames if you've enabled DNS support.
*/ - VpnConnectionId: string | undefined; + EnableDnsHostnames?: AttributeBooleanValue; /** - *The ID of the transit gateway.
+ *Indicates whether the DNS resolution is supported for the VPC. If enabled, queries to + * the Amazon provided DNS server at the 169.254.169.253 IP address, or the reserved IP + * address at the base of the VPC network range "plus two" succeed. If disabled, the Amazon + * provided DNS service in the VPC that resolves public DNS hostnames to IP addresses is + * not enabled.
+ *You cannot modify the DNS resolution and DNS hostnames attributes in the same request. Use separate requests for each attribute.
*/ - TransitGatewayId?: string; + EnableDnsSupport?: AttributeBooleanValue; /** - *The ID of the customer gateway at your end of the VPN connection.
+ *The ID of the VPC.
*/ - CustomerGatewayId?: string; + VpcId: string | undefined; +} +export namespace ModifyVpcAttributeRequest { /** - *The ID of the virtual private gateway at the Amazon Web Services side of the VPN - * connection.
+ * @internal */ - VpnGatewayId?: string; + export const filterSensitiveLog = (obj: ModifyVpcAttributeRequest): any => ({ + ...obj, + }); +} +/** + *Contains the parameters for ModifyVpcEndpoint.
+ */ +export interface ModifyVpcEndpointRequest { /** - *Checks whether you have the required permissions for the action, without actually
- * making the request, and provides an error response. If you have the required
- * permissions, the error response is DryRunOperation. Otherwise, it is
- * UnauthorizedOperation.
Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The ID of the endpoint.
*/ - export const filterSensitiveLog = (obj: ModifyVpnConnectionRequest): any => ({ - ...obj, - }); -} + VpcEndpointId: string | undefined; -export interface ModifyVpnConnectionResult { /** - *Describes a VPN connection.
+ *(Gateway endpoint) Specify true to reset the policy document to the
+ * default policy. The default policy allows full access to the service.
(Interface and gateway endpoints) A policy to attach to the endpoint that controls access to the service. The policy must + * be in valid JSON format.
*/ - export const filterSensitiveLog = (obj: ModifyVpnConnectionResult): any => ({ - ...obj, - }); -} + PolicyDocument?: string; -export interface ModifyVpnConnectionOptionsRequest { /** - *The ID of the Site-to-Site VPN connection.
+ *(Gateway endpoint) One or more route tables IDs to associate with the endpoint.
*/ - VpnConnectionId: string | undefined; + AddRouteTableIds?: string[]; /** - *The IPv4 CIDR on the customer gateway (on-premises) side of the VPN connection.
- *Default: 0.0.0.0/0
- *
(Gateway endpoint) One or more route table IDs to disassociate from the endpoint.
*/ - LocalIpv4NetworkCidr?: string; + RemoveRouteTableIds?: string[]; /** - *The IPv4 CIDR on the Amazon Web Services side of the VPN connection.
- *Default: 0.0.0.0/0
- *
(Interface and Gateway Load Balancer endpoints) One or more subnet IDs in which to serve the endpoint. For a Gateway Load Balancer endpoint, you can specify only one subnet.
*/ - RemoteIpv4NetworkCidr?: string; + AddSubnetIds?: string[]; /** - *The IPv6 CIDR on the customer gateway (on-premises) side of the VPN connection.
- *Default: ::/0
- *
(Interface endpoint) One or more subnets IDs in which to remove the endpoint.
*/ - LocalIpv6NetworkCidr?: string; + RemoveSubnetIds?: string[]; /** - *The IPv6 CIDR on the Amazon Web Services side of the VPN connection.
- *Default: ::/0
- *
(Interface endpoint) One or more security group IDs to associate with the network interface.
*/ - RemoteIpv6NetworkCidr?: string; + AddSecurityGroupIds?: string[]; /** - *Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
(Interface endpoint) One or more security group IDs to disassociate from the network interface.
*/ - DryRun?: boolean; + RemoveSecurityGroupIds?: string[]; + + /** + *(Interface endpoint) Indicates whether a private hosted zone is associated with the + * VPC.
+ */ + PrivateDnsEnabled?: boolean; } -export namespace ModifyVpnConnectionOptionsRequest { +export namespace ModifyVpcEndpointRequest { /** * @internal */ - export const filterSensitiveLog = (obj: ModifyVpnConnectionOptionsRequest): any => ({ + export const filterSensitiveLog = (obj: ModifyVpcEndpointRequest): any => ({ ...obj, }); } -export interface ModifyVpnConnectionOptionsResult { +export interface ModifyVpcEndpointResult { /** - *Describes a VPN connection.
+ *Returns true if the request succeeds; otherwise, it returns an error.
The ID of the Amazon Web Services Site-to-Site VPN connection.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The external IP address of the VPN tunnel.
+ *The ID of the notification.
*/ - VpnTunnelOutsideIpAddress: string | undefined; + ConnectionNotificationId: string | undefined; /** - *Checks whether you have the required permissions for the action, without actually
- * making the request, and provides an error response. If you have the required
- * permissions, the error response is DryRunOperation. Otherwise, it is
- * UnauthorizedOperation.
The ARN for the SNS topic for the notification.
*/ - DryRun?: boolean; + ConnectionNotificationArn?: string; + + /** + *One or more events for the endpoint. Valid values are Accept,
+ * Connect, Delete, and Reject.
Describes a VPN connection.
+ *Returns true if the request succeeds; otherwise, it returns an error.
The Amazon Web Services Site-to-Site VPN tunnel options to modify.
- */ -export interface ModifyVpnTunnelOptionsSpecification { - /** - *The range of inside IPv4 addresses for the tunnel. Any specified CIDR blocks must be - * unique across all VPN connections that use the same virtual private gateway.
- *Constraints: A size /30 CIDR block from the 169.254.0.0/16 range. The
- * following CIDR blocks are reserved and cannot be used:
- * 169.254.0.0/30
- *
- * 169.254.1.0/30
- *
- * 169.254.2.0/30
- *
- * 169.254.3.0/30
- *
- * 169.254.4.0/30
- *
- * 169.254.5.0/30
- *
- * 169.254.169.252/30
- *
The range of inside IPv6 addresses for the tunnel. Any specified CIDR blocks must be - * unique across all VPN connections that use the same transit gateway.
- *Constraints: A size /126 CIDR block from the local fd00::/8 range.
Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The pre-shared key (PSK) to establish initial authentication between the virtual - * private gateway and the customer gateway.
- *Constraints: Allowed characters are alphanumeric characters, periods (.), and - * underscores (_). Must be between 8 and 64 characters in length and cannot start with - * zero (0).
+ *The ID of the service.
*/ - PreSharedKey?: string; + ServiceId: string | undefined; /** - *The lifetime for phase 1 of the IKE negotiation, in seconds.
- *Constraints: A value between 900 and 28,800.
- *Default: 28800
- *
(Interface endpoint configuration) The private DNS name to assign to the endpoint service.
*/ - Phase1LifetimeSeconds?: number; + PrivateDnsName?: string; /** - *The lifetime for phase 2 of the IKE negotiation, in seconds.
- *Constraints: A value between 900 and 3,600. The value must be less than the value for
- * Phase1LifetimeSeconds.
Default: 3600
- *
(Interface endpoint configuration) Removes the private DNS name of the endpoint service.
*/ - Phase2LifetimeSeconds?: number; + RemovePrivateDnsName?: boolean; /** - *The margin time, in seconds, before the phase 2 lifetime expires, during which the
- * Amazon Web Services side of the VPN connection performs an IKE rekey. The exact time
- * of the rekey is randomly selected based on the value for
- * RekeyFuzzPercentage.
Constraints: A value between 60 and half of Phase2LifetimeSeconds.
Default: 540
- *
Indicates whether requests to create an endpoint to your service must be accepted.
*/ - RekeyMarginTimeSeconds?: number; + AcceptanceRequired?: boolean; /** - *The percentage of the rekey window (determined by RekeyMarginTimeSeconds)
- * during which the rekey time is randomly selected.
Constraints: A value between 0 and 100.
- *Default: 100
- *
The Amazon Resource Names (ARNs) of Network Load Balancers to add to your service + * configuration.
*/ - RekeyFuzzPercentage?: number; + AddNetworkLoadBalancerArns?: string[]; /** - *The number of packets in an IKE replay window.
- *Constraints: A value between 64 and 2048.
- *Default: 1024
- *
The Amazon Resource Names (ARNs) of Network Load Balancers to remove from your service + * configuration.
*/ - ReplayWindowSize?: number; + RemoveNetworkLoadBalancerArns?: string[]; /** - *The number of seconds after which a DPD timeout occurs.
- *Constraints: A value greater than or equal to 30.
- *Default: 30
- *
The Amazon Resource Names (ARNs) of Gateway Load Balancers to add to your service + * configuration.
*/ - DPDTimeoutSeconds?: number; + AddGatewayLoadBalancerArns?: string[]; /** - *The action to take after DPD timeout occurs. Specify restart to restart
- * the IKE initiation. Specify clear to end the IKE session.
Valid Values: clear | none | restart
- *
Default: clear
- *
The Amazon Resource Names (ARNs) of Gateway Load Balancers to remove from your service + * configuration.
*/ - DPDTimeoutAction?: string; + RemoveGatewayLoadBalancerArns?: string[]; +} +export namespace ModifyVpcEndpointServiceConfigurationRequest { /** - *One or more encryption algorithms that are permitted for the VPN tunnel for phase 1 - * IKE negotiations.
- *Valid values: AES128 | AES256 | AES128-GCM-16 |
- * AES256-GCM-16
- *
One or more encryption algorithms that are permitted for the VPN tunnel for phase 2 - * IKE negotiations.
- *Valid values: AES128 | AES256 | AES128-GCM-16 |
- * AES256-GCM-16
- *
Returns true if the request succeeds; otherwise, it returns an error.
One or more integrity algorithms that are permitted for the VPN tunnel for phase 1 IKE - * negotiations.
- *Valid values: SHA1 | SHA2-256 | SHA2-384 |
- * SHA2-512
- *
One or more integrity algorithms that are permitted for the VPN tunnel for phase 2 IKE - * negotiations.
- *Valid values: SHA1 | SHA2-256 | SHA2-384 |
- * SHA2-512
- *
Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel for - * phase 1 IKE negotiations.
- *Valid values: 2 | 14 | 15 | 16 |
- * 17 | 18 | 19 | 20 |
- * 21 | 22 | 23 | 24
- *
The ID of the service.
*/ - Phase1DHGroupNumbers?: Phase1DHGroupNumbersRequestListValue[]; + ServiceId: string | undefined; /** - *One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel for - * phase 2 IKE negotiations.
- *Valid values: 2 | 5 | 14 | 15 |
- * 16 | 17 | 18 | 19 |
- * 20 | 21 | 22 | 23 |
- * 24
- *
The entity that is responsible for the endpoint costs. The default is the endpoint owner. + * If you set the payer responsibility to the service owner, you cannot set it back to the + * endpoint owner.
*/ - Phase2DHGroupNumbers?: Phase2DHGroupNumbersRequestListValue[]; + PayerResponsibility: PayerResponsibility | string | undefined; +} +export namespace ModifyVpcEndpointServicePayerResponsibilityRequest { /** - *The IKE versions that are permitted for the VPN tunnel.
- *Valid values: ikev1 | ikev2
- *
The action to take when the establishing the tunnel for the VPN connection. By
- * default, your customer gateway device must initiate the IKE negotiation and bring up the
- * tunnel. Specify start for Amazon Web Services to initiate the IKE
- * negotiation.
Valid Values: add | start
- *
Default: add
- *
Returns true if the request succeeds; otherwise, it returns an error.
The ID of the Amazon Web Services Site-to-Site VPN connection.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The external IP address of the VPN tunnel.
+ *The ID of the service.
*/ - VpnTunnelOutsideIpAddress: string | undefined; + ServiceId: string | undefined; /** - *The tunnel options to modify.
+ *The Amazon Resource Names (ARN) of one or more principals. + * Permissions are granted to the principals in this list. + * To grant permissions to all principals, specify an asterisk (*).
*/ - TunnelOptions: ModifyVpnTunnelOptionsSpecification | undefined; + AddAllowedPrincipals?: string[]; /** - *Checks whether you have the required permissions for the action, without actually
- * making the request, and provides an error response. If you have the required
- * permissions, the error response is DryRunOperation. Otherwise, it is
- * UnauthorizedOperation.
The Amazon Resource Names (ARN) of one or more principals. + * Permissions are revoked for principals in this list.
*/ - DryRun?: boolean; + RemoveAllowedPrincipals?: string[]; } -export namespace ModifyVpnTunnelOptionsRequest { +export namespace ModifyVpcEndpointServicePermissionsRequest { /** * @internal */ - export const filterSensitiveLog = (obj: ModifyVpnTunnelOptionsRequest): any => ({ + export const filterSensitiveLog = (obj: ModifyVpcEndpointServicePermissionsRequest): any => ({ ...obj, }); } -export interface ModifyVpnTunnelOptionsResult { +export interface ModifyVpcEndpointServicePermissionsResult { /** - *Describes a VPN connection.
+ *Returns true if the request succeeds; otherwise, it returns an error.
The VPC peering connection options.
+ */ +export interface PeeringConnectionOptionsRequest { /** - *The IDs of the instances.
+ *If true, enables a local VPC to resolve public DNS hostnames to private IP addresses when queried from instances in the peer VPC.
*/ - InstanceIds: string[] | undefined; + AllowDnsResolutionFromRemoteVpc?: boolean; + + /** + *If true, enables outbound communication from an EC2-Classic instance that's linked to + * a local VPC using ClassicLink to instances in a peer VPC.
+ */ + AllowEgressFromLocalClassicLinkToRemoteVpc?: boolean; + + /** + *If true, enables outbound communication from instances in a local VPC to an + * EC2-Classic instance that's linked to a peer VPC using ClassicLink.
+ */ + AllowEgressFromLocalVpcToRemoteClassicLink?: boolean; +} + +export namespace PeeringConnectionOptionsRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: PeeringConnectionOptionsRequest): any => ({ + ...obj, + }); +} + +export interface ModifyVpcPeeringConnectionOptionsRequest { + /** + *The VPC peering connection options for the accepter VPC.
+ */ + AccepterPeeringConnectionOptions?: PeeringConnectionOptionsRequest; /** *Checks whether you have the required permissions for the action, without actually making the request,
@@ -7021,585 +6862,621 @@ export interface MonitorInstancesRequest {
* Otherwise, it is UnauthorizedOperation.
The VPC peering connection options for the requester VPC.
+ */ + RequesterPeeringConnectionOptions?: PeeringConnectionOptionsRequest; + + /** + *The ID of the VPC peering connection.
+ */ + VpcPeeringConnectionId: string | undefined; } -export namespace MonitorInstancesRequest { +export namespace ModifyVpcPeeringConnectionOptionsRequest { /** * @internal */ - export const filterSensitiveLog = (obj: MonitorInstancesRequest): any => ({ + export const filterSensitiveLog = (obj: ModifyVpcPeeringConnectionOptionsRequest): any => ({ ...obj, }); } /** - *Describes the monitoring of an instance.
+ *Describes the VPC peering connection options.
*/ -export interface InstanceMonitoring { +export interface PeeringConnectionOptions { /** - *The ID of the instance.
+ *If true, the public DNS hostnames of instances in the specified VPC resolve to private + * IP addresses when queried from instances in the peer VPC.
*/ - InstanceId?: string; + AllowDnsResolutionFromRemoteVpc?: boolean; /** - *The monitoring for the instance.
+ *If true, enables outbound communication from an EC2-Classic instance that's linked to + * a local VPC using ClassicLink to instances in a peer VPC.
*/ - Monitoring?: Monitoring; + AllowEgressFromLocalClassicLinkToRemoteVpc?: boolean; + + /** + *If true, enables outbound communication from instances in a local VPC to an + * EC2-Classic instance that's linked to a peer VPC using ClassicLink.
+ */ + AllowEgressFromLocalVpcToRemoteClassicLink?: boolean; } -export namespace InstanceMonitoring { +export namespace PeeringConnectionOptions { /** * @internal */ - export const filterSensitiveLog = (obj: InstanceMonitoring): any => ({ + export const filterSensitiveLog = (obj: PeeringConnectionOptions): any => ({ ...obj, }); } -export interface MonitorInstancesResult { +export interface ModifyVpcPeeringConnectionOptionsResult { /** - *The monitoring information.
+ *Information about the VPC peering connection options for the accepter VPC.
*/ - InstanceMonitorings?: InstanceMonitoring[]; + AccepterPeeringConnectionOptions?: PeeringConnectionOptions; + + /** + *Information about the VPC peering connection options for the requester VPC.
+ */ + RequesterPeeringConnectionOptions?: PeeringConnectionOptions; } -export namespace MonitorInstancesResult { +export namespace ModifyVpcPeeringConnectionOptionsResult { /** * @internal */ - export const filterSensitiveLog = (obj: MonitorInstancesResult): any => ({ + export const filterSensitiveLog = (obj: ModifyVpcPeeringConnectionOptionsResult): any => ({ ...obj, }); } -export interface MoveAddressToVpcRequest { +export type VpcTenancy = "default"; + +export interface ModifyVpcTenancyRequest { + /** + *The ID of the VPC.
+ */ + VpcId: string | undefined; + + /** + *The instance tenancy attribute for the VPC.
+ */ + InstanceTenancy: VpcTenancy | string | undefined; + /** *Checks whether you have the required permissions for the action, without actually making the request,
* and provides an error response. If you have the required permissions, the error response is DryRunOperation.
* Otherwise, it is UnauthorizedOperation.
The Elastic IP address.
- */ - PublicIp: string | undefined; } -export namespace MoveAddressToVpcRequest { +export namespace ModifyVpcTenancyRequest { /** * @internal */ - export const filterSensitiveLog = (obj: MoveAddressToVpcRequest): any => ({ + export const filterSensitiveLog = (obj: ModifyVpcTenancyRequest): any => ({ ...obj, }); } -export enum Status { - inClassic = "InClassic", - inVpc = "InVpc", - moveInProgress = "MoveInProgress", -} - -export interface MoveAddressToVpcResult { - /** - *The allocation ID for the Elastic IP address.
- */ - AllocationId?: string; - +export interface ModifyVpcTenancyResult { /** - *The status of the move of the IP address.
+ *Returns true if the request succeeds; otherwise, returns an
+ * error.
A check for whether you have the required permissions for the action without actually making the request
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The BYOIP CIDR.
+ *The ID of the VPN connection.
*/ - Cidr: string | undefined; + VpnConnectionId: string | undefined; /** - *The IPAM pool ID.
+ *The ID of the transit gateway.
*/ - IpamPoolId: string | undefined; + TransitGatewayId?: string; /** - *The Amazon Web Services account ID of the owner of the IPAM pool.
+ *The ID of the customer gateway at your end of the VPN connection.
*/ - IpamPoolOwner: string | undefined; -} + CustomerGatewayId?: string; -export namespace MoveByoipCidrToIpamRequest { /** - * @internal + *The ID of the virtual private gateway at the Amazon Web Services side of the VPN + * connection.
*/ - export const filterSensitiveLog = (obj: MoveByoipCidrToIpamRequest): any => ({ - ...obj, - }); -} + VpnGatewayId?: string; -export interface MoveByoipCidrToIpamResult { /** - *Information about an address range that is provisioned for use with your Amazon Web Services resources - * through bring your own IP addresses (BYOIP).
+ *Checks whether you have the required permissions for the action, without actually
+ * making the request, and provides an error response. If you have the required
+ * permissions, the error response is DryRunOperation. Otherwise, it is
+ * UnauthorizedOperation.
Provides authorization for Amazon to bring a specific IP address range to a specific - * Amazon Web Services account using bring your own IP addresses (BYOIP). For more information, see Configuring your BYOIP address range in the Amazon Elastic Compute Cloud User Guide.
- */ -export interface CidrAuthorizationContext { - /** - *The plain-text authorization message for the prefix and account.
- */ - Message: string | undefined; - +export interface ModifyVpnConnectionResult { /** - *The signed authorization message for the prefix and account.
+ *Describes a VPN connection.
*/ - Signature: string | undefined; + VpnConnection?: VpnConnection; } -export namespace CidrAuthorizationContext { +export namespace ModifyVpnConnectionResult { /** * @internal */ - export const filterSensitiveLog = (obj: CidrAuthorizationContext): any => ({ + export const filterSensitiveLog = (obj: ModifyVpnConnectionResult): any => ({ ...obj, }); } -export interface ProvisionByoipCidrRequest { - /** - *The public IPv4 or IPv6 address range, in CIDR notation. The most specific IPv4 prefix that you can - * specify is /24. The most specific IPv6 prefix you can specify is /56. The address range cannot overlap with another address range that you've - * brought to this or another Region.
- */ - Cidr: string | undefined; - +export interface ModifyVpnConnectionOptionsRequest { /** - *A signed document that proves that you are authorized to bring the specified IP address - * range to Amazon using BYOIP.
+ *The ID of the Site-to-Site VPN connection.
*/ - CidrAuthorizationContext?: CidrAuthorizationContext; + VpnConnectionId: string | undefined; /** - *(IPv6 only) Indicate whether the address range will be publicly advertised to the - * internet.
- *Default: true
+ *The IPv4 CIDR on the customer gateway (on-premises) side of the VPN connection.
+ *Default: 0.0.0.0/0
+ *
A description for the address range and the address pool.
+ *The IPv4 CIDR on the Amazon Web Services side of the VPN connection.
+ *Default: 0.0.0.0/0
+ *
Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The IPv6 CIDR on the customer gateway (on-premises) side of the VPN connection.
+ *Default: ::/0
+ *
The tags to apply to the address pool.
+ *The IPv6 CIDR on the Amazon Web Services side of the VPN connection.
+ *Default: ::/0
+ *
Reserved.
+ *Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Information about the address range.
+ *Describes a VPN connection.
*/ - ByoipCidr?: ByoipCidr; + VpnConnection?: VpnConnection; } -export namespace ProvisionByoipCidrResult { +export namespace ModifyVpnConnectionOptionsResult { /** * @internal */ - export const filterSensitiveLog = (obj: ProvisionByoipCidrResult): any => ({ + export const filterSensitiveLog = (obj: ModifyVpnConnectionOptionsResult): any => ({ ...obj, }); } -/** - *A signed document that proves that you are authorized to bring the specified IP address range to Amazon using BYOIP.
- */ -export interface IpamCidrAuthorizationContext { +export interface ModifyVpnTunnelCertificateRequest { /** - *The plain-text authorization message for the prefix and account.
+ *The ID of the Amazon Web Services Site-to-Site VPN connection.
*/ - Message?: string; + VpnConnectionId: string | undefined; /** - *The signed authorization message for the prefix and account.
+ *The external IP address of the VPN tunnel.
*/ - Signature?: string; + VpnTunnelOutsideIpAddress: string | undefined; + + /** + *Checks whether you have the required permissions for the action, without actually
+ * making the request, and provides an error response. If you have the required
+ * permissions, the error response is DryRunOperation. Otherwise, it is
+ * UnauthorizedOperation.
A check for whether you have the required permissions for the action without actually making the request
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The ID of the IPAM pool to which you want to assign a CIDR.
- */ - IpamPoolId: string | undefined; - - /** - *The CIDR you want to assign to the IPAM pool.
- */ - Cidr?: string; - +export interface ModifyVpnTunnelCertificateResult { /** - *A signed document that proves that you are authorized to bring a specified IP address range to Amazon using BYOIP. This option applies to public pools only.
+ *Describes a VPN connection.
*/ - CidrAuthorizationContext?: IpamCidrAuthorizationContext; + VpnConnection?: VpnConnection; } -export namespace ProvisionIpamPoolCidrRequest { +export namespace ModifyVpnTunnelCertificateResult { /** * @internal */ - export const filterSensitiveLog = (obj: ProvisionIpamPoolCidrRequest): any => ({ + export const filterSensitiveLog = (obj: ModifyVpnTunnelCertificateResult): any => ({ ...obj, }); } -export interface ProvisionIpamPoolCidrResult { +/** + *The Amazon Web Services Site-to-Site VPN tunnel options to modify.
+ */ +export interface ModifyVpnTunnelOptionsSpecification { /** - *Information about the provisioned CIDR.
+ *The range of inside IPv4 addresses for the tunnel. Any specified CIDR blocks must be + * unique across all VPN connections that use the same virtual private gateway.
+ *Constraints: A size /30 CIDR block from the 169.254.0.0/16 range. The
+ * following CIDR blocks are reserved and cannot be used:
+ * 169.254.0.0/30
+ *
+ * 169.254.1.0/30
+ *
+ * 169.254.2.0/30
+ *
+ * 169.254.3.0/30
+ *
+ * 169.254.4.0/30
+ *
+ * 169.254.5.0/30
+ *
+ * 169.254.169.252/30
+ *
The range of inside IPv6 addresses for the tunnel. Any specified CIDR blocks must be + * unique across all VPN connections that use the same transit gateway.
+ *Constraints: A size /126 CIDR block from the local fd00::/8 range.
A check for whether you have the required permissions for the action without actually making the request
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The pre-shared key (PSK) to establish initial authentication between the virtual + * private gateway and the customer gateway.
+ *Constraints: Allowed characters are alphanumeric characters, periods (.), and + * underscores (_). Must be between 8 and 64 characters in length and cannot start with + * zero (0).
+ */ + PreSharedKey?: string; + + /** + *The lifetime for phase 1 of the IKE negotiation, in seconds.
+ *Constraints: A value between 900 and 28,800.
+ *Default: 28800
+ *
The lifetime for phase 2 of the IKE negotiation, in seconds.
+ *Constraints: A value between 900 and 3,600. The value must be less than the value for
+ * Phase1LifetimeSeconds.
Default: 3600
+ *
The ID of the IPAM pool you would like to use to allocate this CIDR.
+ *The margin time, in seconds, before the phase 2 lifetime expires, during which the
+ * Amazon Web Services side of the VPN connection performs an IKE rekey. The exact time
+ * of the rekey is randomly selected based on the value for
+ * RekeyFuzzPercentage.
Constraints: A value between 60 and half of Phase2LifetimeSeconds.
Default: 540
+ *
The ID of the public IPv4 pool you would like to use for this CIDR.
+ *The percentage of the rekey window (determined by RekeyMarginTimeSeconds)
+ * during which the rekey time is randomly selected.
Constraints: A value between 0 and 100.
+ *Default: 100
+ *
The netmask length of the CIDR you would like to allocate to the public IPv4 pool.
+ *The number of packets in an IKE replay window.
+ *Constraints: A value between 64 and 2048.
+ *Default: 1024
+ *
The number of seconds after which a DPD timeout occurs.
+ *Constraints: A value greater than or equal to 30.
+ *Default: 30
+ *
The ID of the pool that you want to provision the CIDR to.
+ *The action to take after DPD timeout occurs. Specify restart to restart
+ * the IKE initiation. Specify clear to end the IKE session.
Valid Values: clear | none | restart
+ *
Default: clear
+ *
Describes an address range of an IPv4 address pool.
+ *One or more encryption algorithms that are permitted for the VPN tunnel for phase 1 + * IKE negotiations.
+ *Valid values: AES128 | AES256 | AES128-GCM-16 |
+ * AES256-GCM-16
+ *
One or more encryption algorithms that are permitted for the VPN tunnel for phase 2 + * IKE negotiations.
+ *Valid values: AES128 | AES256 | AES128-GCM-16 |
+ * AES256-GCM-16
+ *
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.
+ *One or more integrity algorithms that are permitted for the VPN tunnel for phase 1 IKE + * negotiations.
+ *Valid values: SHA1 | SHA2-256 | SHA2-384 |
+ * SHA2-512
+ *
The currency in which the totalUpfrontPrice, LimitPrice,
- * and totalHourlyPrice amounts are specified. At this time, the only
- * supported currency is USD.
One or more integrity algorithms that are permitted for the VPN tunnel for phase 2 IKE + * negotiations.
+ *Valid values: SHA1 | SHA2-256 | SHA2-384 |
+ * SHA2-512
+ *
The IDs of the Dedicated Hosts with which the reservation will be associated.
+ *One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel for + * phase 1 IKE negotiations.
+ *Valid values: 2 | 14 | 15 | 16 |
+ * 17 | 18 | 19 | 20 |
+ * 21 | 22 | 23 | 24
+ *
The specified limit is checked against the total upfront cost of the reservation
- * (calculated as the offering's upfront cost multiplied by the host count). If the total
- * upfront cost is greater than the specified price limit, the request fails. This is used
- * to ensure that the purchase does not exceed the expected upfront cost of the purchase.
- * At this time, the only supported currency is USD. For example, to indicate
- * a limit price of USD 100, specify 100.00.
One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel for + * phase 2 IKE negotiations.
+ *Valid values: 2 | 5 | 14 | 15 |
+ * 16 | 17 | 18 | 19 |
+ * 20 | 21 | 22 | 23 |
+ * 24
+ *
The ID of the offering.
+ *The IKE versions that are permitted for the VPN tunnel.
+ *Valid values: ikev1 | ikev2
+ *
The tags to apply to the Dedicated Host Reservation during purchase.
+ *The action to take when the establishing the tunnel for the VPN connection. By
+ * default, your customer gateway device must initiate the IKE negotiation and bring up the
+ * tunnel. Specify start for Amazon Web Services to initiate the IKE
+ * negotiation.
Valid Values: add | start
+ *
Default: add
+ *
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.
- */ - ClientToken?: string; - +export interface ModifyVpnTunnelOptionsRequest { /** - *The currency in which the totalUpfrontPrice and
- * totalHourlyPrice amounts are specified. At this time, the only
- * supported currency is USD.
The ID of the Amazon Web Services Site-to-Site VPN connection.
*/ - CurrencyCode?: CurrencyCodeValues | string; + VpnConnectionId: string | undefined; /** - *Describes the details of the purchase.
+ *The external IP address of the VPN tunnel.
*/ - Purchase?: Purchase[]; + VpnTunnelOutsideIpAddress: string | undefined; /** - *The total hourly price of the reservation calculated per hour.
+ *The tunnel options to modify.
*/ - TotalHourlyPrice?: string; + TunnelOptions: ModifyVpnTunnelOptionsSpecification | undefined; /** - *The total amount charged to your account when you purchase the reservation.
+ *Checks whether you have the required permissions for the action, without actually
+ * making the request, and provides an error response. If you have the required
+ * permissions, the error response is DryRunOperation. Otherwise, it is
+ * UnauthorizedOperation.
Describes the limit price of a Reserved Instance offering.
- */ -export interface ReservedInstanceLimitPrice { - /** - *Used for Reserved Instance Marketplace offerings. Specifies the limit price on the total order (instanceCount * price).
- */ - Amount?: number; - +export interface ModifyVpnTunnelOptionsResult { /** - *The currency in which the limitPrice amount is specified.
- * At this time, the only supported currency is USD.
Describes a VPN connection.
*/ - CurrencyCode?: CurrencyCodeValues | string; + VpnConnection?: VpnConnection; } -export namespace ReservedInstanceLimitPrice { +export namespace ModifyVpnTunnelOptionsResult { /** * @internal */ - export const filterSensitiveLog = (obj: ReservedInstanceLimitPrice): any => ({ + export const filterSensitiveLog = (obj: ModifyVpnTunnelOptionsResult): any => ({ ...obj, }); } -/** - *Contains the parameters for PurchaseReservedInstancesOffering.
- */ -export interface PurchaseReservedInstancesOfferingRequest { - /** - *The number of Reserved Instances to purchase.
- */ - InstanceCount: number | undefined; - +export interface MonitorInstancesRequest { /** - *The ID of the Reserved Instance offering to purchase.
+ *The IDs of the instances.
*/ - ReservedInstancesOfferingId: string | undefined; + InstanceIds: string[] | undefined; /** *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
*/
DryRun?: boolean;
-
- /**
- * Specified for Reserved Instance Marketplace offerings to limit the total order and ensure that the Reserved Instances are not purchased at unexpected prices.
- */ - LimitPrice?: ReservedInstanceLimitPrice; - - /** - *The time at which to purchase the Reserved Instance, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).
- */ - PurchaseTime?: Date; } -export namespace PurchaseReservedInstancesOfferingRequest { +export namespace MonitorInstancesRequest { /** * @internal */ - export const filterSensitiveLog = (obj: PurchaseReservedInstancesOfferingRequest): any => ({ + export const filterSensitiveLog = (obj: MonitorInstancesRequest): any => ({ ...obj, }); } /** - *Contains the output of PurchaseReservedInstancesOffering.
+ *Describes the monitoring of an instance.
*/ -export interface PurchaseReservedInstancesOfferingResult { +export interface InstanceMonitoring { /** - *The IDs of the purchased Reserved Instances. If your purchase crosses into a discounted - * pricing tier, the final Reserved Instances IDs might change. For more information, see Crossing - * pricing tiers in the Amazon Elastic Compute Cloud User Guide.
+ *The ID of the instance.
*/ - ReservedInstancesId?: string; + InstanceId?: string; + + /** + *The monitoring for the instance.
+ */ + Monitoring?: Monitoring; } -export namespace PurchaseReservedInstancesOfferingResult { +export namespace InstanceMonitoring { /** * @internal */ - export const filterSensitiveLog = (obj: PurchaseReservedInstancesOfferingResult): any => ({ + export const filterSensitiveLog = (obj: InstanceMonitoring): any => ({ ...obj, }); } -/** - *Describes a request to purchase Scheduled Instances.
- */ -export interface PurchaseRequest { - /** - *The number of instances.
- */ - InstanceCount: number | undefined; - +export interface MonitorInstancesResult { /** - *The purchase token.
+ *The monitoring information.
*/ - PurchaseToken: string | undefined; + InstanceMonitorings?: InstanceMonitoring[]; } -export namespace PurchaseRequest { +export namespace MonitorInstancesResult { /** * @internal */ - export const filterSensitiveLog = (obj: PurchaseRequest): any => ({ + export const filterSensitiveLog = (obj: MonitorInstancesResult): any => ({ ...obj, }); } -/** - *Contains the parameters for PurchaseScheduledInstances.
- */ -export interface PurchaseScheduledInstancesRequest { - /** - *Unique, case-sensitive identifier that ensures the idempotency of the request. - * For more information, see Ensuring Idempotency.
- */ - ClientToken?: string; - +export interface MoveAddressToVpcRequest { /** *Checks whether you have the required permissions for the action, without actually making the request,
* and provides an error response. If you have the required permissions, the error response is DryRunOperation.
@@ -7608,500 +7485,524 @@ export interface PurchaseScheduledInstancesRequest {
DryRun?: boolean;
/**
- *
The purchase requests.
+ *The Elastic IP address.
*/ - PurchaseRequests: PurchaseRequest[] | undefined; + PublicIp: string | undefined; } -export namespace PurchaseScheduledInstancesRequest { +export namespace MoveAddressToVpcRequest { /** * @internal */ - export const filterSensitiveLog = (obj: PurchaseScheduledInstancesRequest): any => ({ + export const filterSensitiveLog = (obj: MoveAddressToVpcRequest): any => ({ ...obj, }); } -/** - *Contains the output of PurchaseScheduledInstances.
- */ -export interface PurchaseScheduledInstancesResult { +export enum Status { + inClassic = "InClassic", + inVpc = "InVpc", + moveInProgress = "MoveInProgress", +} + +export interface MoveAddressToVpcResult { /** - *Information about the Scheduled Instances.
+ *The allocation ID for the Elastic IP address.
*/ - ScheduledInstanceSet?: ScheduledInstance[]; + AllocationId?: string; + + /** + *The status of the move of the IP address.
+ */ + Status?: Status | string; } -export namespace PurchaseScheduledInstancesResult { +export namespace MoveAddressToVpcResult { /** * @internal */ - export const filterSensitiveLog = (obj: PurchaseScheduledInstancesResult): any => ({ + export const filterSensitiveLog = (obj: MoveAddressToVpcResult): any => ({ ...obj, }); } -export interface RebootInstancesRequest { - /** - *The instance IDs.
- */ - InstanceIds: string[] | undefined; - +export interface MoveByoipCidrToIpamRequest { /** - *Checks whether you have the required permissions for the action, without actually making the request, + *
A check for whether you have the required permissions for the action without actually making the request
* and provides an error response. If you have the required permissions, the error response is DryRunOperation.
* Otherwise, it is UnauthorizedOperation.
The BYOIP CIDR.
*/ - export const filterSensitiveLog = (obj: RebootInstancesRequest): any => ({ - ...obj, - }); -} + Cidr: string | undefined; -/** - *Contains the parameters for RegisterImage.
- */ -export interface RegisterImageRequest { /** - *The full path to your AMI manifest in Amazon S3 storage. The specified bucket must have the
- * aws-exec-read canned access control list (ACL) to ensure that it can be accessed
- * by Amazon EC2. For more information, see Canned ACLs in the
- * Amazon S3 Service Developer Guide.
The IPAM pool ID.
*/ - ImageLocation?: string; + IpamPoolId: string | undefined; /** - *The architecture of the AMI.
- *Default: For Amazon EBS-backed AMIs, i386.
- * For instance store-backed AMIs, the architecture specified in the manifest file.
The Amazon Web Services account ID of the owner of the IPAM pool.
*/ - Architecture?: ArchitectureValues | string; + IpamPoolOwner: string | undefined; +} +export namespace MoveByoipCidrToIpamRequest { /** - *The block device mapping entries.
- *If you specify an Amazon EBS volume using the ID of an Amazon EBS snapshot, you can't specify the encryption state of the volume.
- *If you create an AMI on an Outpost, then all backing snapshots must be on the same Outpost or in the Region - * of that Outpost. AMIs on an Outpost that include local snapshots can be used to launch instances on the same Outpost - * only. For more information, - * Amazon EBS local snapshots on Outposts in the Amazon Elastic Compute Cloud User Guide.
+ * @internal */ - BlockDeviceMappings?: BlockDeviceMapping[]; + export const filterSensitiveLog = (obj: MoveByoipCidrToIpamRequest): any => ({ + ...obj, + }); +} +export interface MoveByoipCidrToIpamResult { /** - *A description for your AMI.
+ *Information about an address range that is provisioned for use with your Amazon Web Services resources + * through bring your own IP addresses (BYOIP).
*/ - Description?: string; + ByoipCidr?: ByoipCidr; +} +export namespace MoveByoipCidrToIpamResult { /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
Provides authorization for Amazon to bring a specific IP address range to a specific + * Amazon Web Services account using bring your own IP addresses (BYOIP). For more information, see Configuring your BYOIP address range in the Amazon Elastic Compute Cloud User Guide.
+ */ +export interface CidrAuthorizationContext { /** - *Set to true to enable enhanced networking with ENA for the AMI and any instances that you launch from the AMI.
This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make instances launched from the AMI unreachable.
+ *The plain-text authorization message for the prefix and account.
*/ - EnaSupport?: boolean; + Message: string | undefined; /** - *The ID of the kernel.
+ *The signed authorization message for the prefix and account.
*/ - KernelId?: string; + Signature: string | undefined; +} +export namespace CidrAuthorizationContext { /** - *A name for your AMI.
- *Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes ('), at-signs (@), or underscores(_)
+ * @internal */ - Name: string | undefined; + export const filterSensitiveLog = (obj: CidrAuthorizationContext): any => ({ + ...obj, + }); +} +export interface ProvisionByoipCidrRequest { /** - *The billing product codes. Your account must be authorized to specify billing product codes. Otherwise, - * you can use the Amazon Web Services Marketplace to bill for the use of an AMI.
+ *The public IPv4 or IPv6 address range, in CIDR notation. The most specific IPv4 prefix that you can + * specify is /24. The most specific IPv6 prefix you can specify is /56. The address range cannot overlap with another address range that you've + * brought to this or another Region.
*/ - BillingProducts?: string[]; + Cidr: string | undefined; /** - *The ID of the RAM disk.
+ *A signed document that proves that you are authorized to bring the specified IP address + * range to Amazon using BYOIP.
*/ - RamdiskId?: string; + CidrAuthorizationContext?: CidrAuthorizationContext; /** - *The device name of the root device volume (for example, /dev/sda1).
(IPv6 only) Indicate whether the address range will be publicly advertised to the + * internet.
+ *Default: true
*/ - RootDeviceName?: string; + PubliclyAdvertisable?: boolean; /** - *Set to simple to enable enhanced networking with the Intel 82599 Virtual Function interface for the AMI and any instances that you launch from the AMI.
There is no way to disable sriovNetSupport at this time.
This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make instances launched from the AMI unreachable.
+ *A description for the address range and the address pool.
*/ - SriovNetSupport?: string; + Description?: string; /** - *The type of virtualization (hvm | paravirtual).
Default: paravirtual
- *
Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The boot mode of the AMI. For more information, see Boot modes in the - * Amazon Elastic Compute Cloud User Guide.
+ *The tags to apply to the address pool.
*/ - BootMode?: BootModeValues | string; + PoolTagSpecifications?: TagSpecification[]; + + /** + *Reserved.
+ */ + MultiRegion?: boolean; } -export namespace RegisterImageRequest { +export namespace ProvisionByoipCidrRequest { /** * @internal */ - export const filterSensitiveLog = (obj: RegisterImageRequest): any => ({ + export const filterSensitiveLog = (obj: ProvisionByoipCidrRequest): any => ({ ...obj, }); } -/** - *Contains the output of RegisterImage.
- */ -export interface RegisterImageResult { +export interface ProvisionByoipCidrResult { /** - *The ID of the newly registered AMI.
+ *Information about the address range.
*/ - ImageId?: string; + ByoipCidr?: ByoipCidr; } -export namespace RegisterImageResult { +export namespace ProvisionByoipCidrResult { /** * @internal */ - export const filterSensitiveLog = (obj: RegisterImageResult): any => ({ + export const filterSensitiveLog = (obj: ProvisionByoipCidrResult): any => ({ ...obj, }); } /** - *Information about the tag keys to register for the current Region. You can either specify
- * individual tag keys or register all tag keys in the current Region. You must specify either
- * IncludeAllTagsOfInstance or InstanceTagKeys in the request
A signed document that proves that you are authorized to bring the specified IP address range to Amazon using BYOIP.
*/ -export interface RegisterInstanceTagAttributeRequest { +export interface IpamCidrAuthorizationContext { /** - *Indicates whether to register all tag keys in the current Region. Specify true
- * to register all tag keys.
The plain-text authorization message for the prefix and account.
*/ - IncludeAllTagsOfInstance?: boolean; + Message?: string; /** - *The tag keys to register.
+ *The signed authorization message for the prefix and account.
*/ - InstanceTagKeys?: string[]; + Signature?: string; } -export namespace RegisterInstanceTagAttributeRequest { +export namespace IpamCidrAuthorizationContext { /** * @internal */ - export const filterSensitiveLog = (obj: RegisterInstanceTagAttributeRequest): any => ({ + export const filterSensitiveLog = (obj: IpamCidrAuthorizationContext): any => ({ ...obj, }); } -export interface RegisterInstanceEventNotificationAttributesRequest { +export interface ProvisionIpamPoolCidrRequest { /** - *Checks whether you have the required permissions for the action, without actually making the request, + *
A check for whether you have the required permissions for the action without actually making the request
* and provides an error response. If you have the required permissions, the error response is DryRunOperation.
* Otherwise, it is UnauthorizedOperation.
Information about the tag keys to register.
+ *The ID of the IPAM pool to which you want to assign a CIDR.
*/ - InstanceTagAttribute?: RegisterInstanceTagAttributeRequest; + IpamPoolId: string | undefined; + + /** + *The CIDR you want to assign to the IPAM pool.
+ */ + Cidr?: string; + + /** + *A signed document that proves that you are authorized to bring a specified IP address range to Amazon using BYOIP. This option applies to public pools only.
+ */ + CidrAuthorizationContext?: IpamCidrAuthorizationContext; } -export namespace RegisterInstanceEventNotificationAttributesRequest { +export namespace ProvisionIpamPoolCidrRequest { /** * @internal */ - export const filterSensitiveLog = (obj: RegisterInstanceEventNotificationAttributesRequest): any => ({ + export const filterSensitiveLog = (obj: ProvisionIpamPoolCidrRequest): any => ({ ...obj, }); } -export interface RegisterInstanceEventNotificationAttributesResult { +export interface ProvisionIpamPoolCidrResult { /** - *The resulting set of tag keys.
+ *Information about the provisioned CIDR.
*/ - InstanceTagAttribute?: InstanceTagNotificationAttribute; + IpamPoolCidr?: IpamPoolCidr; } -export namespace RegisterInstanceEventNotificationAttributesResult { +export namespace ProvisionIpamPoolCidrResult { /** * @internal */ - export const filterSensitiveLog = (obj: RegisterInstanceEventNotificationAttributesResult): any => ({ + export const filterSensitiveLog = (obj: ProvisionIpamPoolCidrResult): any => ({ ...obj, }); } -export interface RegisterTransitGatewayMulticastGroupMembersRequest { +export interface ProvisionPublicIpv4PoolCidrRequest { /** - *The ID of the transit gateway multicast domain.
+ *A check for whether you have the required permissions for the action without actually making the request
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The IP address assigned to the transit gateway multicast group.
+ *The ID of the IPAM pool you would like to use to allocate this CIDR.
*/ - GroupIpAddress?: string; + IpamPoolId: string | undefined; /** - *The group members' network interface IDs to register with the transit gateway multicast group.
+ *The ID of the public IPv4 pool you would like to use for this CIDR.
*/ - NetworkInterfaceIds?: string[]; + PoolId: string | undefined; /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The netmask length of the CIDR you would like to allocate to the public IPv4 pool.
*/ - DryRun?: boolean; + NetmaskLength: number | undefined; } -export namespace RegisterTransitGatewayMulticastGroupMembersRequest { +export namespace ProvisionPublicIpv4PoolCidrRequest { /** * @internal */ - export const filterSensitiveLog = (obj: RegisterTransitGatewayMulticastGroupMembersRequest): any => ({ + export const filterSensitiveLog = (obj: ProvisionPublicIpv4PoolCidrRequest): any => ({ ...obj, }); } -/** - *Describes the registered transit gateway multicast group members.
- */ -export interface TransitGatewayMulticastRegisteredGroupMembers { - /** - *The ID of the transit gateway multicast domain.
- */ - TransitGatewayMulticastDomainId?: string; - +export interface ProvisionPublicIpv4PoolCidrResult { /** - *The ID of the registered network interfaces.
+ *The ID of the pool that you want to provision the CIDR to.
*/ - RegisteredNetworkInterfaceIds?: string[]; + PoolId?: string; /** - *The IP address assigned to the transit gateway multicast group.
+ *Describes an address range of an IPv4 address pool.
*/ - GroupIpAddress?: string; + PoolAddressRange?: PublicIpv4PoolRange; } -export namespace TransitGatewayMulticastRegisteredGroupMembers { +export namespace ProvisionPublicIpv4PoolCidrResult { /** * @internal */ - export const filterSensitiveLog = (obj: TransitGatewayMulticastRegisteredGroupMembers): any => ({ + export const filterSensitiveLog = (obj: ProvisionPublicIpv4PoolCidrResult): any => ({ ...obj, }); } -export interface RegisterTransitGatewayMulticastGroupMembersResult { +export interface PurchaseHostReservationRequest { /** - *Information about the registered transit gateway multicast group members.
+ *Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.
*/ - RegisteredMulticastGroupMembers?: TransitGatewayMulticastRegisteredGroupMembers; -} + ClientToken?: string; -export namespace RegisterTransitGatewayMulticastGroupMembersResult { /** - * @internal + *The currency in which the totalUpfrontPrice, LimitPrice,
+ * and totalHourlyPrice amounts are specified. At this time, the only
+ * supported currency is USD.
The ID of the transit gateway multicast domain.
+ *The IDs of the Dedicated Hosts with which the reservation will be associated.
*/ - TransitGatewayMulticastDomainId?: string; + HostIdSet: string[] | undefined; /** - *The IP address assigned to the transit gateway multicast group.
+ *The specified limit is checked against the total upfront cost of the reservation
+ * (calculated as the offering's upfront cost multiplied by the host count). If the total
+ * upfront cost is greater than the specified price limit, the request fails. This is used
+ * to ensure that the purchase does not exceed the expected upfront cost of the purchase.
+ * At this time, the only supported currency is USD. For example, to indicate
+ * a limit price of USD 100, specify 100.00.
The group sources' network interface IDs to register with the transit gateway multicast group.
+ *The ID of the offering.
*/ - NetworkInterfaceIds?: string[]; + OfferingId: string | undefined; /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The tags to apply to the Dedicated Host Reservation during purchase.
*/ - DryRun?: boolean; + TagSpecifications?: TagSpecification[]; } -export namespace RegisterTransitGatewayMulticastGroupSourcesRequest { +export namespace PurchaseHostReservationRequest { /** * @internal */ - export const filterSensitiveLog = (obj: RegisterTransitGatewayMulticastGroupSourcesRequest): any => ({ + export const filterSensitiveLog = (obj: PurchaseHostReservationRequest): any => ({ ...obj, }); } -/** - *Describes the members registered with the transit gateway multicast group.
- */ -export interface TransitGatewayMulticastRegisteredGroupSources { +export interface PurchaseHostReservationResult { /** - *The ID of the transit gateway multicast domain.
+ *Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.
*/ - TransitGatewayMulticastDomainId?: string; + ClientToken?: string; /** - *The IDs of the network interfaces members registered with the transit gateway multicast group.
+ *The currency in which the totalUpfrontPrice and
+ * totalHourlyPrice amounts are specified. At this time, the only
+ * supported currency is USD.
The IP address assigned to the transit gateway multicast group.
+ *Describes the details of the purchase.
*/ - GroupIpAddress?: string; + Purchase?: Purchase[]; + + /** + *The total hourly price of the reservation calculated per hour.
+ */ + TotalHourlyPrice?: string; + + /** + *The total amount charged to your account when you purchase the reservation.
+ */ + TotalUpfrontPrice?: string; } -export namespace TransitGatewayMulticastRegisteredGroupSources { +export namespace PurchaseHostReservationResult { /** * @internal */ - export const filterSensitiveLog = (obj: TransitGatewayMulticastRegisteredGroupSources): any => ({ + export const filterSensitiveLog = (obj: PurchaseHostReservationResult): any => ({ ...obj, }); } -export interface RegisterTransitGatewayMulticastGroupSourcesResult { +/** + *Describes the limit price of a Reserved Instance offering.
+ */ +export interface ReservedInstanceLimitPrice { /** - *Information about the transit gateway multicast group sources.
+ *Used for Reserved Instance Marketplace offerings. Specifies the limit price on the total order (instanceCount * price).
*/ - RegisteredMulticastGroupSources?: TransitGatewayMulticastRegisteredGroupSources; + Amount?: number; + + /** + *The currency in which the limitPrice amount is specified.
+ * At this time, the only supported currency is USD.
The ID of the transit gateway multicast domain.
- */ - TransitGatewayMulticastDomainId?: string; - +/** + *Contains the parameters for PurchaseReservedInstancesOffering.
+ */ +export interface PurchaseReservedInstancesOfferingRequest { /** - *The ID of the transit gateway attachment.
+ *The number of Reserved Instances to purchase.
*/ - TransitGatewayAttachmentId?: string; + InstanceCount: number | undefined; /** - *The IDs of the subnets to associate with the transit gateway multicast domain.
+ *The ID of the Reserved Instance offering to purchase.
*/ - SubnetIds?: string[]; + ReservedInstancesOfferingId: string | undefined; /** *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
*/
DryRun?: boolean;
-}
-export namespace RejectTransitGatewayMulticastDomainAssociationsRequest {
/**
- * @internal
+ * Specified for Reserved Instance Marketplace offerings to limit the total order and ensure that the Reserved Instances are not purchased at unexpected prices.
*/ - export const filterSensitiveLog = (obj: RejectTransitGatewayMulticastDomainAssociationsRequest): any => ({ - ...obj, - }); -} + LimitPrice?: ReservedInstanceLimitPrice; -export interface RejectTransitGatewayMulticastDomainAssociationsResult { /** - *Describes the multicast domain associations.
+ *The time at which to purchase the Reserved Instance, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).
*/ - Associations?: TransitGatewayMulticastDomainAssociations; + PurchaseTime?: Date; } -export namespace RejectTransitGatewayMulticastDomainAssociationsResult { +export namespace PurchaseReservedInstancesOfferingRequest { /** * @internal */ - export const filterSensitiveLog = (obj: RejectTransitGatewayMulticastDomainAssociationsResult): any => ({ + export const filterSensitiveLog = (obj: PurchaseReservedInstancesOfferingRequest): any => ({ ...obj, }); } -export interface RejectTransitGatewayPeeringAttachmentRequest { - /** - *The ID of the transit gateway peering attachment.
- */ - TransitGatewayAttachmentId: string | undefined; - +/** + *Contains the output of PurchaseReservedInstancesOffering.
+ */ +export interface PurchaseReservedInstancesOfferingResult { /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The IDs of the purchased Reserved Instances. If your purchase crosses into a discounted + * pricing tier, the final Reserved Instances IDs might change. For more information, see Crossing + * pricing tiers in the Amazon Elastic Compute Cloud User Guide.
*/ - DryRun?: boolean; + ReservedInstancesId?: string; } -export namespace RejectTransitGatewayPeeringAttachmentRequest { +export namespace PurchaseReservedInstancesOfferingResult { /** * @internal */ - export const filterSensitiveLog = (obj: RejectTransitGatewayPeeringAttachmentRequest): any => ({ + export const filterSensitiveLog = (obj: PurchaseReservedInstancesOfferingResult): any => ({ ...obj, }); } -export interface RejectTransitGatewayPeeringAttachmentResult { +/** + *Describes a request to purchase Scheduled Instances.
+ */ +export interface PurchaseRequest { /** - *The transit gateway peering attachment.
+ *The number of instances.
*/ - TransitGatewayPeeringAttachment?: TransitGatewayPeeringAttachment; + InstanceCount: number | undefined; + + /** + *The purchase token.
+ */ + PurchaseToken: string | undefined; } -export namespace RejectTransitGatewayPeeringAttachmentResult { +export namespace PurchaseRequest { /** * @internal */ - export const filterSensitiveLog = (obj: RejectTransitGatewayPeeringAttachmentResult): any => ({ + export const filterSensitiveLog = (obj: PurchaseRequest): any => ({ ...obj, }); } -export interface RejectTransitGatewayVpcAttachmentRequest { +/** + *Contains the parameters for PurchaseScheduledInstances.
+ */ +export interface PurchaseScheduledInstancesRequest { /** - *The ID of the attachment.
+ *Unique, case-sensitive identifier that ensures the idempotency of the request. + * For more information, see Ensuring Idempotency.
*/ - TransitGatewayAttachmentId: string | undefined; + ClientToken?: string; /** *Checks whether you have the required permissions for the action, without actually making the request,
@@ -8109,411 +8010,463 @@ export interface RejectTransitGatewayVpcAttachmentRequest {
* Otherwise, it is UnauthorizedOperation.
The purchase requests.
+ */ + PurchaseRequests: PurchaseRequest[] | undefined; } -export namespace RejectTransitGatewayVpcAttachmentRequest { +export namespace PurchaseScheduledInstancesRequest { /** * @internal */ - export const filterSensitiveLog = (obj: RejectTransitGatewayVpcAttachmentRequest): any => ({ + export const filterSensitiveLog = (obj: PurchaseScheduledInstancesRequest): any => ({ ...obj, }); } -export interface RejectTransitGatewayVpcAttachmentResult { +/** + *Contains the output of PurchaseScheduledInstances.
+ */ +export interface PurchaseScheduledInstancesResult { /** - *Information about the attachment.
+ *Information about the Scheduled Instances.
*/ - TransitGatewayVpcAttachment?: TransitGatewayVpcAttachment; + ScheduledInstanceSet?: ScheduledInstance[]; } -export namespace RejectTransitGatewayVpcAttachmentResult { +export namespace PurchaseScheduledInstancesResult { /** * @internal */ - export const filterSensitiveLog = (obj: RejectTransitGatewayVpcAttachmentResult): any => ({ + export const filterSensitiveLog = (obj: PurchaseScheduledInstancesResult): any => ({ ...obj, }); } -export interface RejectVpcEndpointConnectionsRequest { +export interface RebootInstancesRequest { + /** + *The instance IDs.
+ */ + InstanceIds: string[] | undefined; + /** *Checks whether you have the required permissions for the action, without actually making the request,
* and provides an error response. If you have the required permissions, the error response is DryRunOperation.
* Otherwise, it is UnauthorizedOperation.
The ID of the service.
+ * @internal */ - ServiceId: string | undefined; + export const filterSensitiveLog = (obj: RebootInstancesRequest): any => ({ + ...obj, + }); +} +/** + *Contains the parameters for RegisterImage.
+ */ +export interface RegisterImageRequest { /** - *The IDs of one or more VPC endpoints.
+ *The full path to your AMI manifest in Amazon S3 storage. The specified bucket must have the
+ * aws-exec-read canned access control list (ACL) to ensure that it can be accessed
+ * by Amazon EC2. For more information, see Canned ACLs in the
+ * Amazon S3 Service Developer Guide.
The architecture of the AMI.
+ *Default: For Amazon EBS-backed AMIs, i386.
+ * For instance store-backed AMIs, the architecture specified in the manifest file.
Information about the endpoints that were not rejected, if applicable.
+ *The block device mapping entries.
+ *If you specify an Amazon EBS volume using the ID of an Amazon EBS snapshot, you can't specify the encryption state of the volume.
+ *If you create an AMI on an Outpost, then all backing snapshots must be on the same Outpost or in the Region + * of that Outpost. AMIs on an Outpost that include local snapshots can be used to launch instances on the same Outpost + * only. For more information, + * Amazon EBS local snapshots on Outposts in the Amazon Elastic Compute Cloud User Guide.
*/ - Unsuccessful?: UnsuccessfulItem[]; -} + BlockDeviceMappings?: BlockDeviceMapping[]; -export namespace RejectVpcEndpointConnectionsResult { /** - * @internal + *A description for your AMI.
*/ - export const filterSensitiveLog = (obj: RejectVpcEndpointConnectionsResult): any => ({ - ...obj, - }); -} + Description?: string; -export interface RejectVpcPeeringConnectionRequest { /** *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
DryRunOperation. Otherwise, it is UnauthorizedOperation.
*/
DryRun?: boolean;
/**
- * The ID of the VPC peering connection.
+ *Set to true to enable enhanced networking with ENA for the AMI and any instances that you launch from the AMI.
This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make instances launched from the AMI unreachable.
*/ - VpcPeeringConnectionId: string | undefined; -} + EnaSupport?: boolean; -export namespace RejectVpcPeeringConnectionRequest { /** - * @internal + *The ID of the kernel.
*/ - export const filterSensitiveLog = (obj: RejectVpcPeeringConnectionRequest): any => ({ - ...obj, - }); -} + KernelId?: string; -export interface RejectVpcPeeringConnectionResult { /** - *Returns true if the request succeeds; otherwise, it returns an error.
A name for your AMI.
+ *Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes ('), at-signs (@), or underscores(_)
*/ - Return?: boolean; -} + Name: string | undefined; -export namespace RejectVpcPeeringConnectionResult { /** - * @internal + *The billing product codes. Your account must be authorized to specify billing product codes. Otherwise, + * you can use the Amazon Web Services Marketplace to bill for the use of an AMI.
*/ - export const filterSensitiveLog = (obj: RejectVpcPeeringConnectionResult): any => ({ - ...obj, - }); -} + BillingProducts?: string[]; -export interface ReleaseAddressRequest { /** - *[EC2-VPC] The allocation ID. Required for EC2-VPC.
+ *The ID of the RAM disk.
*/ - AllocationId?: string; + RamdiskId?: string; /** - *[EC2-Classic] The Elastic IP address. Required for EC2-Classic.
+ *The device name of the root device volume (for example, /dev/sda1).
The set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web Services advertises - * IP addresses.
- *If you provide an incorrect network border group, you receive an InvalidAddress.NotFound error.
You cannot use a network border group with EC2 Classic. If you attempt this operation on EC2 classic, you
- * receive an InvalidParameterCombination error.
Set to simple to enable enhanced networking with the Intel 82599 Virtual Function interface for the AMI and any instances that you launch from the AMI.
There is no way to disable sriovNetSupport at this time.
This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make instances launched from the AMI unreachable.
*/ - NetworkBorderGroup?: string; + SriovNetSupport?: string; /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The type of virtualization (hvm | paravirtual).
Default: paravirtual
+ *
The boot mode of the AMI. For more information, see Boot modes in the + * Amazon Elastic Compute Cloud User Guide.
+ */ + BootMode?: BootModeValues | string; } -export namespace ReleaseAddressRequest { +export namespace RegisterImageRequest { /** * @internal */ - export const filterSensitiveLog = (obj: ReleaseAddressRequest): any => ({ + export const filterSensitiveLog = (obj: RegisterImageRequest): any => ({ ...obj, }); } -export interface ReleaseHostsRequest { +/** + *Contains the output of RegisterImage.
+ */ +export interface RegisterImageResult { /** - *The IDs of the Dedicated Hosts to release.
+ *The ID of the newly registered AMI.
*/ - HostIds: string[] | undefined; + ImageId?: string; } -export namespace ReleaseHostsRequest { +export namespace RegisterImageResult { /** * @internal */ - export const filterSensitiveLog = (obj: ReleaseHostsRequest): any => ({ + export const filterSensitiveLog = (obj: RegisterImageResult): any => ({ ...obj, }); } -export interface ReleaseHostsResult { +/** + *Information about the tag keys to register for the current Region. You can either specify
+ * individual tag keys or register all tag keys in the current Region. You must specify either
+ * IncludeAllTagsOfInstance or InstanceTagKeys in the request
The IDs of the Dedicated Hosts that were successfully released.
+ *Indicates whether to register all tag keys in the current Region. Specify true
+ * to register all tag keys.
The IDs of the Dedicated Hosts that could not be released, including an error - * message.
+ *The tag keys to register.
*/ - Unsuccessful?: UnsuccessfulItem[]; + InstanceTagKeys?: string[]; } -export namespace ReleaseHostsResult { +export namespace RegisterInstanceTagAttributeRequest { /** * @internal */ - export const filterSensitiveLog = (obj: ReleaseHostsResult): any => ({ + export const filterSensitiveLog = (obj: RegisterInstanceTagAttributeRequest): any => ({ ...obj, }); } -export interface ReleaseIpamPoolAllocationRequest { +export interface RegisterInstanceEventNotificationAttributesRequest { /** - *A check for whether you have the required permissions for the action without actually making the request + *
Checks whether you have the required permissions for the action, without actually making the request,
* and provides an error response. If you have the required permissions, the error response is DryRunOperation.
* Otherwise, it is UnauthorizedOperation.
The ID of the IPAM pool which contains the allocation you want to release.
+ *Information about the tag keys to register.
*/ - IpamPoolId: string | undefined; + InstanceTagAttribute?: RegisterInstanceTagAttributeRequest; +} +export namespace RegisterInstanceEventNotificationAttributesRequest { /** - *The CIDR of the allocation you want to release.
+ * @internal */ - Cidr: string | undefined; + export const filterSensitiveLog = (obj: RegisterInstanceEventNotificationAttributesRequest): any => ({ + ...obj, + }); +} +export interface RegisterInstanceEventNotificationAttributesResult { /** - *The ID of the allocation.
+ *The resulting set of tag keys.
*/ - IpamPoolAllocationId?: string; + InstanceTagAttribute?: InstanceTagNotificationAttribute; } -export namespace ReleaseIpamPoolAllocationRequest { +export namespace RegisterInstanceEventNotificationAttributesResult { /** * @internal */ - export const filterSensitiveLog = (obj: ReleaseIpamPoolAllocationRequest): any => ({ + export const filterSensitiveLog = (obj: RegisterInstanceEventNotificationAttributesResult): any => ({ ...obj, }); } -export interface ReleaseIpamPoolAllocationResult { +export interface RegisterTransitGatewayMulticastGroupMembersRequest { /** - *Indicates if the release was successful.
+ *The ID of the transit gateway multicast domain.
*/ - Success?: boolean; + TransitGatewayMulticastDomainId?: string; + + /** + *The IP address assigned to the transit gateway multicast group.
+ */ + GroupIpAddress?: string; + + /** + *The group members' network interface IDs to register with the transit gateway multicast group.
+ */ + NetworkInterfaceIds?: string[]; + + /** + *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Describes the registered transit gateway multicast group members.
+ */ +export interface TransitGatewayMulticastRegisteredGroupMembers { /** - *The IAM instance profile.
+ *The ID of the transit gateway multicast domain.
*/ - IamInstanceProfile: IamInstanceProfileSpecification | undefined; + TransitGatewayMulticastDomainId?: string; /** - *The ID of the existing IAM instance profile association.
+ *The ID of the registered network interfaces.
*/ - AssociationId: string | undefined; + RegisteredNetworkInterfaceIds?: string[]; + + /** + *The IP address assigned to the transit gateway multicast group.
+ */ + GroupIpAddress?: string; } -export namespace ReplaceIamInstanceProfileAssociationRequest { +export namespace TransitGatewayMulticastRegisteredGroupMembers { /** * @internal */ - export const filterSensitiveLog = (obj: ReplaceIamInstanceProfileAssociationRequest): any => ({ + export const filterSensitiveLog = (obj: TransitGatewayMulticastRegisteredGroupMembers): any => ({ ...obj, }); } -export interface ReplaceIamInstanceProfileAssociationResult { +export interface RegisterTransitGatewayMulticastGroupMembersResult { /** - *Information about the IAM instance profile association.
+ *Information about the registered transit gateway multicast group members.
*/ - IamInstanceProfileAssociation?: IamInstanceProfileAssociation; + RegisteredMulticastGroupMembers?: TransitGatewayMulticastRegisteredGroupMembers; } -export namespace ReplaceIamInstanceProfileAssociationResult { +export namespace RegisterTransitGatewayMulticastGroupMembersResult { /** * @internal */ - export const filterSensitiveLog = (obj: ReplaceIamInstanceProfileAssociationResult): any => ({ + export const filterSensitiveLog = (obj: RegisterTransitGatewayMulticastGroupMembersResult): any => ({ ...obj, }); } -export interface ReplaceNetworkAclAssociationRequest { - /** - *The ID of the current association between the original network ACL and the subnet.
- */ - AssociationId: string | undefined; - +export interface RegisterTransitGatewayMulticastGroupSourcesRequest { /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The ID of the transit gateway multicast domain.
*/ - DryRun?: boolean; + TransitGatewayMulticastDomainId?: string; /** - *The ID of the new network ACL to associate with the subnet.
+ *The IP address assigned to the transit gateway multicast group.
*/ - NetworkAclId: string | undefined; -} + GroupIpAddress?: string; -export namespace ReplaceNetworkAclAssociationRequest { /** - * @internal + *The group sources' network interface IDs to register with the transit gateway multicast group.
*/ - export const filterSensitiveLog = (obj: ReplaceNetworkAclAssociationRequest): any => ({ - ...obj, - }); -} + NetworkInterfaceIds?: string[]; -export interface ReplaceNetworkAclAssociationResult { /** - *The ID of the new association.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Describes the members registered with the transit gateway multicast group.
+ */ +export interface TransitGatewayMulticastRegisteredGroupSources { /** - *The IPv4 network range to allow or deny, in CIDR notation (for example
- * 172.16.0.0/24).
The ID of the transit gateway multicast domain.
*/ - CidrBlock?: string; + TransitGatewayMulticastDomainId?: string; /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The IDs of the network interfaces members registered with the transit gateway multicast group.
*/ - DryRun?: boolean; + RegisteredNetworkInterfaceIds?: string[]; /** - *Indicates whether to replace the egress rule.
- *Default: If no value is specified, we replace the ingress rule.
+ *The IP address assigned to the transit gateway multicast group.
*/ - Egress: boolean | undefined; + GroupIpAddress?: string; +} +export namespace TransitGatewayMulticastRegisteredGroupSources { /** - *ICMP protocol: The ICMP or ICMPv6 type and code. Required if specifying protocol - * 1 (ICMP) or protocol 58 (ICMPv6) with an IPv6 CIDR block.
+ * @internal */ - IcmpTypeCode?: IcmpTypeCode; + export const filterSensitiveLog = (obj: TransitGatewayMulticastRegisteredGroupSources): any => ({ + ...obj, + }); +} +export interface RegisterTransitGatewayMulticastGroupSourcesResult { /** - *The IPv6 network range to allow or deny, in CIDR notation (for example
- * 2001:bd8:1234:1a00::/64).
Information about the transit gateway multicast group sources.
*/ - Ipv6CidrBlock?: string; + RegisteredMulticastGroupSources?: TransitGatewayMulticastRegisteredGroupSources; +} +export namespace RegisterTransitGatewayMulticastGroupSourcesResult { /** - *The ID of the ACL.
+ * @internal */ - NetworkAclId: string | undefined; + export const filterSensitiveLog = (obj: RegisterTransitGatewayMulticastGroupSourcesResult): any => ({ + ...obj, + }); +} +export interface RejectTransitGatewayMulticastDomainAssociationsRequest { /** - *TCP or UDP protocols: The range of ports the rule applies to. - * Required if specifying protocol 6 (TCP) or 17 (UDP).
+ *The ID of the transit gateway multicast domain.
*/ - PortRange?: PortRange; + TransitGatewayMulticastDomainId?: string; /** - *The protocol number. A value of "-1" means all protocols. If you specify "-1" or a - * protocol number other than "6" (TCP), "17" (UDP), or "1" (ICMP), traffic on all ports is - * allowed, regardless of any ports or ICMP types or codes that you specify. If you specify - * protocol "58" (ICMPv6) and specify an IPv4 CIDR block, traffic for all ICMP types and - * codes allowed, regardless of any that you specify. If you specify protocol "58" (ICMPv6) - * and specify an IPv6 CIDR block, you must specify an ICMP type and code.
+ *The ID of the transit gateway attachment.
*/ - Protocol: string | undefined; + TransitGatewayAttachmentId?: string; /** - *Indicates whether to allow or deny the traffic that matches the rule.
+ *The IDs of the subnets to associate with the transit gateway multicast domain.
*/ - RuleAction: RuleAction | string | undefined; + SubnetIds?: string[]; /** - *The rule number of the entry to replace.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The IPv4 CIDR address block used for the destination match. The value that you - * provide must match the CIDR of an existing route in the table.
+ *Describes the multicast domain associations.
*/ - DestinationCidrBlock?: string; + Associations?: TransitGatewayMulticastDomainAssociations; +} +export namespace RejectTransitGatewayMulticastDomainAssociationsResult { /** - *The IPv6 CIDR address block used for the destination match. The value that you - * provide must match the CIDR of an existing route in the table.
+ * @internal */ - DestinationIpv6CidrBlock?: string; + export const filterSensitiveLog = (obj: RejectTransitGatewayMulticastDomainAssociationsResult): any => ({ + ...obj, + }); +} +export interface RejectTransitGatewayPeeringAttachmentRequest { /** - *The ID of the prefix list for the route.
+ *The ID of the transit gateway peering attachment.
*/ - DestinationPrefixListId?: string; + TransitGatewayAttachmentId: string | undefined; /** *Checks whether you have the required permissions for the action, without actually making the request,
@@ -8521,88 +8474,117 @@ export interface ReplaceRouteRequest {
* Otherwise, it is UnauthorizedOperation.
The ID of a VPC endpoint. Supported for Gateway Load Balancer endpoints only.
+ * @internal */ - VpcEndpointId?: string; + export const filterSensitiveLog = (obj: RejectTransitGatewayPeeringAttachmentRequest): any => ({ + ...obj, + }); +} +export interface RejectTransitGatewayPeeringAttachmentResult { /** - *[IPv6 traffic only] The ID of an egress-only internet gateway.
+ *The transit gateway peering attachment.
*/ - EgressOnlyInternetGatewayId?: string; + TransitGatewayPeeringAttachment?: TransitGatewayPeeringAttachment; +} +export namespace RejectTransitGatewayPeeringAttachmentResult { /** - *The ID of an internet gateway or virtual private gateway.
+ * @internal */ - GatewayId?: string; + export const filterSensitiveLog = (obj: RejectTransitGatewayPeeringAttachmentResult): any => ({ + ...obj, + }); +} +export interface RejectTransitGatewayVpcAttachmentRequest { /** - *The ID of a NAT instance in your VPC.
+ *The ID of the attachment.
*/ - InstanceId?: string; + TransitGatewayAttachmentId: string | undefined; /** - *Specifies whether to reset the local route to its default target (local).
Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
[IPv4 traffic only] The ID of a NAT gateway.
+ * @internal */ - NatGatewayId?: string; + export const filterSensitiveLog = (obj: RejectTransitGatewayVpcAttachmentRequest): any => ({ + ...obj, + }); +} +export interface RejectTransitGatewayVpcAttachmentResult { /** - *The ID of a transit gateway.
+ *Information about the attachment.
*/ - TransitGatewayId?: string; + TransitGatewayVpcAttachment?: TransitGatewayVpcAttachment; +} +export namespace RejectTransitGatewayVpcAttachmentResult { /** - *The ID of the local gateway.
+ * @internal */ - LocalGatewayId?: string; + export const filterSensitiveLog = (obj: RejectTransitGatewayVpcAttachmentResult): any => ({ + ...obj, + }); +} +export interface RejectVpcEndpointConnectionsRequest { /** - *[IPv4 traffic only] The ID of a carrier gateway.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The ID of a network interface.
+ *The ID of the service.
*/ - NetworkInterfaceId?: string; + ServiceId: string | undefined; /** - *The ID of the route table.
+ *The IDs of one or more VPC endpoints.
*/ - RouteTableId: string | undefined; + VpcEndpointIds: string[] | undefined; +} +export namespace RejectVpcEndpointConnectionsRequest { /** - *The ID of a VPC peering connection.
+ * @internal */ - VpcPeeringConnectionId?: string; + export const filterSensitiveLog = (obj: RejectVpcEndpointConnectionsRequest): any => ({ + ...obj, + }); +} +export interface RejectVpcEndpointConnectionsResult { /** - *The Amazon Resource Name (ARN) of the core network.
+ *Information about the endpoints that were not rejected, if applicable.
*/ - CoreNetworkArn?: string; + Unsuccessful?: UnsuccessfulItem[]; } -export namespace ReplaceRouteRequest { +export namespace RejectVpcEndpointConnectionsResult { /** * @internal */ - export const filterSensitiveLog = (obj: ReplaceRouteRequest): any => ({ + export const filterSensitiveLog = (obj: RejectVpcEndpointConnectionsResult): any => ({ ...obj, }); } -export interface ReplaceRouteTableAssociationRequest { - /** - *The association ID.
- */ - AssociationId: string | undefined; - +export interface RejectVpcPeeringConnectionRequest { /** *Checks whether you have the required permissions for the action, without actually making the request,
* and provides an error response. If you have the required permissions, the error response is DryRunOperation.
@@ -8611,61 +8593,55 @@ export interface ReplaceRouteTableAssociationRequest {
DryRun?: boolean;
/**
- *
The ID of the new route table to associate with the subnet.
+ *The ID of the VPC peering connection.
*/ - RouteTableId: string | undefined; + VpcPeeringConnectionId: string | undefined; } -export namespace ReplaceRouteTableAssociationRequest { +export namespace RejectVpcPeeringConnectionRequest { /** * @internal */ - export const filterSensitiveLog = (obj: ReplaceRouteTableAssociationRequest): any => ({ + export const filterSensitiveLog = (obj: RejectVpcPeeringConnectionRequest): any => ({ ...obj, }); } -export interface ReplaceRouteTableAssociationResult { - /** - *The ID of the new association.
- */ - NewAssociationId?: string; - +export interface RejectVpcPeeringConnectionResult { /** - *The state of the association.
+ *Returns true if the request succeeds; otherwise, it returns an error.
The CIDR range used for the destination match. Routing decisions are based on the most specific match.
- */ - DestinationCidrBlock: string | undefined; - +export interface ReleaseAddressRequest { /** - *The ID of the route table.
+ *[EC2-VPC] The allocation ID. Required for EC2-VPC.
*/ - TransitGatewayRouteTableId: string | undefined; + AllocationId?: string; /** - *The ID of the attachment.
+ *[EC2-Classic] The Elastic IP address. Required for EC2-Classic.
*/ - TransitGatewayAttachmentId?: string; + PublicIp?: string; /** - *Indicates whether traffic matching this route is to be dropped.
+ *The set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web Services advertises + * IP addresses.
+ *If you provide an incorrect network border group, you receive an InvalidAddress.NotFound error.
You cannot use a network border group with EC2 Classic. If you attempt this operation on EC2 classic, you
+ * receive an InvalidParameterCombination error.
Checks whether you have the required permissions for the action, without actually making the request, @@ -8675,437 +8651,361 @@ export interface ReplaceTransitGatewayRouteRequest { DryRun?: boolean; } -export namespace ReplaceTransitGatewayRouteRequest { +export namespace ReleaseAddressRequest { /** * @internal */ - export const filterSensitiveLog = (obj: ReplaceTransitGatewayRouteRequest): any => ({ + export const filterSensitiveLog = (obj: ReleaseAddressRequest): any => ({ ...obj, }); } -export interface ReplaceTransitGatewayRouteResult { +export interface ReleaseHostsRequest { /** - *
Information about the modified route.
+ *The IDs of the Dedicated Hosts to release.
*/ - Route?: TransitGatewayRoute; + HostIds: string[] | undefined; } -export namespace ReplaceTransitGatewayRouteResult { +export namespace ReleaseHostsRequest { /** * @internal */ - export const filterSensitiveLog = (obj: ReplaceTransitGatewayRouteResult): any => ({ + export const filterSensitiveLog = (obj: ReleaseHostsRequest): any => ({ ...obj, }); } -export type ReportInstanceReasonCodes = - | "instance-stuck-in-state" - | "not-accepting-credentials" - | "other" - | "password-not-available" - | "performance-ebs-volume" - | "performance-instance-store" - | "performance-network" - | "performance-other" - | "unresponsive"; +export interface ReleaseHostsResult { + /** + *The IDs of the Dedicated Hosts that were successfully released.
+ */ + Successful?: string[]; -export type ReportStatusType = "impaired" | "ok"; + /** + *The IDs of the Dedicated Hosts that could not be released, including an error + * message.
+ */ + Unsuccessful?: UnsuccessfulItem[]; +} -export interface ReportInstanceStatusRequest { +export namespace ReleaseHostsResult { /** - *Descriptive text about the health state of your instance.
+ * @internal */ - Description?: string; + export const filterSensitiveLog = (obj: ReleaseHostsResult): any => ({ + ...obj, + }); +} +export interface ReleaseIpamPoolAllocationRequest { /** - *Checks whether you have the required permissions for the action, without actually making the request, + *
A check for whether you have the required permissions for the action without actually making the request
* and provides an error response. If you have the required permissions, the error response is DryRunOperation.
* Otherwise, it is UnauthorizedOperation.
The time at which the reported instance health state ended.
+ *The ID of the IPAM pool which contains the allocation you want to release.
*/ - EndTime?: Date; + IpamPoolId: string | undefined; /** - *The instances.
+ *The CIDR of the allocation you want to release.
*/ - Instances: string[] | undefined; + Cidr: string | undefined; /** - *The reason codes that describe the health state of your instance.
- *
- * instance-stuck-in-state: My instance is stuck in a state.
- * unresponsive: My instance is unresponsive.
- * not-accepting-credentials: My instance is not accepting my
- * credentials.
- * password-not-available: A password is not available for my
- * instance.
- * performance-network: My instance is experiencing performance
- * problems that I believe are network related.
- * performance-instance-store: My instance is experiencing performance
- * problems that I believe are related to the instance stores.
- * performance-ebs-volume: My instance is experiencing performance
- * problems that I believe are related to an EBS volume.
- * performance-other: My instance is experiencing performance
- * problems.
- * other: [explain using the description parameter]
The ID of the allocation.
*/ - ReasonCodes: (ReportInstanceReasonCodes | string)[] | undefined; + IpamPoolAllocationId?: string; +} +export namespace ReleaseIpamPoolAllocationRequest { /** - *The time at which the reported instance health state began.
+ * @internal */ - StartTime?: Date; + export const filterSensitiveLog = (obj: ReleaseIpamPoolAllocationRequest): any => ({ + ...obj, + }); +} +export interface ReleaseIpamPoolAllocationResult { /** - *The status of all instances listed.
+ *Indicates if the release was successful.
*/ - Status: ReportStatusType | string | undefined; + Success?: boolean; } -export namespace ReportInstanceStatusRequest { +export namespace ReleaseIpamPoolAllocationResult { /** * @internal */ - export const filterSensitiveLog = (obj: ReportInstanceStatusRequest): any => ({ + export const filterSensitiveLog = (obj: ReleaseIpamPoolAllocationResult): any => ({ ...obj, }); } -/** - *Contains the parameters for RequestSpotFleet.
- */ -export interface RequestSpotFleetRequest { +export interface ReplaceIamInstanceProfileAssociationRequest { /** - *Checks whether you have the required permissions for the action, without actually
- * making the request, and provides an error response. If you have the required
- * permissions, the error response is DryRunOperation. Otherwise, it is
- * UnauthorizedOperation.
The IAM instance profile.
*/ - DryRun?: boolean; + IamInstanceProfile: IamInstanceProfileSpecification | undefined; /** - *The configuration for the Spot Fleet request.
+ *The ID of the existing IAM instance profile association.
*/ - SpotFleetRequestConfig: SpotFleetRequestConfigData | undefined; + AssociationId: string | undefined; } -export namespace RequestSpotFleetRequest { +export namespace ReplaceIamInstanceProfileAssociationRequest { /** * @internal */ - export const filterSensitiveLog = (obj: RequestSpotFleetRequest): any => ({ + export const filterSensitiveLog = (obj: ReplaceIamInstanceProfileAssociationRequest): any => ({ ...obj, }); } -/** - *Contains the output of RequestSpotFleet.
- */ -export interface RequestSpotFleetResponse { +export interface ReplaceIamInstanceProfileAssociationResult { /** - *The ID of the Spot Fleet request.
+ *Information about the IAM instance profile association.
*/ - SpotFleetRequestId?: string; + IamInstanceProfileAssociation?: IamInstanceProfileAssociation; } -export namespace RequestSpotFleetResponse { +export namespace ReplaceIamInstanceProfileAssociationResult { /** * @internal */ - export const filterSensitiveLog = (obj: RequestSpotFleetResponse): any => ({ + export const filterSensitiveLog = (obj: ReplaceIamInstanceProfileAssociationResult): any => ({ ...obj, }); } -/** - *Describes the launch specification for an instance.
- */ -export interface RequestSpotLaunchSpecification { +export interface ReplaceNetworkAclAssociationRequest { /** - *One or more security group IDs.
+ *The ID of the current association between the original network ACL and the subnet.
*/ - SecurityGroupIds?: string[]; + AssociationId: string | undefined; /** - *One or more security groups. When requesting instances in a VPC, you must specify the IDs of the security groups. When requesting instances in EC2-Classic, you can specify the names or the IDs of the security groups.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Deprecated.
+ *The ID of the new network ACL to associate with the subnet.
*/ - AddressingType?: string; + NetworkAclId: string | undefined; +} +export namespace ReplaceNetworkAclAssociationRequest { /** - *One or more block device mapping entries. You can't specify both a snapshot ID and an encryption value. - * This is because only blank volumes can be encrypted on creation. If a snapshot is the basis for a volume, - * it is not blank and its encryption status is used for the volume encryption status.
+ * @internal */ - BlockDeviceMappings?: BlockDeviceMapping[]; + export const filterSensitiveLog = (obj: ReplaceNetworkAclAssociationRequest): any => ({ + ...obj, + }); +} +export interface ReplaceNetworkAclAssociationResult { /** - *Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.
- *Default: false
- *
The ID of the new association.
*/ - EbsOptimized?: boolean; + NewAssociationId?: string; +} +export namespace ReplaceNetworkAclAssociationResult { /** - *The IAM instance profile.
+ * @internal */ - IamInstanceProfile?: IamInstanceProfileSpecification; + export const filterSensitiveLog = (obj: ReplaceNetworkAclAssociationResult): any => ({ + ...obj, + }); +} +export interface ReplaceNetworkAclEntryRequest { /** - *The ID of the AMI.
+ *The IPv4 network range to allow or deny, in CIDR notation (for example
+ * 172.16.0.0/24).
The instance type.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The ID of the kernel.
+ *Indicates whether to replace the egress rule.
+ *Default: If no value is specified, we replace the ingress rule.
*/ - KernelId?: string; + Egress: boolean | undefined; /** - *The name of the key pair.
+ *ICMP protocol: The ICMP or ICMPv6 type and code. Required if specifying protocol + * 1 (ICMP) or protocol 58 (ICMPv6) with an IPv6 CIDR block.
*/ - KeyName?: string; + IcmpTypeCode?: IcmpTypeCode; /** - *Indicates whether basic or detailed monitoring is enabled for the instance.
- *Default: Disabled
+ *The IPv6 network range to allow or deny, in CIDR notation (for example
+ * 2001:bd8:1234:1a00::/64).
One or more network interfaces. If you specify a network interface, you must specify - * subnet IDs and security group IDs using the network interface.
+ *The ID of the ACL.
*/ - NetworkInterfaces?: InstanceNetworkInterfaceSpecification[]; + NetworkAclId: string | undefined; /** - *The placement information for the instance.
+ *TCP or UDP protocols: The range of ports the rule applies to. + * Required if specifying protocol 6 (TCP) or 17 (UDP).
*/ - Placement?: SpotPlacement; + PortRange?: PortRange; /** - *The ID of the RAM disk.
+ *The protocol number. A value of "-1" means all protocols. If you specify "-1" or a + * protocol number other than "6" (TCP), "17" (UDP), or "1" (ICMP), traffic on all ports is + * allowed, regardless of any ports or ICMP types or codes that you specify. If you specify + * protocol "58" (ICMPv6) and specify an IPv4 CIDR block, traffic for all ICMP types and + * codes allowed, regardless of any that you specify. If you specify protocol "58" (ICMPv6) + * and specify an IPv6 CIDR block, you must specify an ICMP type and code.
*/ - RamdiskId?: string; + Protocol: string | undefined; /** - *The ID of the subnet in which to launch the instance.
+ *Indicates whether to allow or deny the traffic that matches the rule.
*/ - SubnetId?: string; + RuleAction: RuleAction | string | undefined; /** - *The Base64-encoded user data for the instance. User data is limited to 16 KB.
+ *The rule number of the entry to replace.
*/ - UserData?: string; + RuleNumber: number | undefined; } -export namespace RequestSpotLaunchSpecification { +export namespace ReplaceNetworkAclEntryRequest { /** * @internal */ - export const filterSensitiveLog = (obj: RequestSpotLaunchSpecification): any => ({ + export const filterSensitiveLog = (obj: ReplaceNetworkAclEntryRequest): any => ({ ...obj, }); } -/** - *Contains the parameters for RequestSpotInstances.
- */ -export interface RequestSpotInstancesRequest { +export interface ReplaceRouteRequest { /** - *The user-specified name for a logical grouping of requests.
- *When you specify an Availability Zone group in a Spot Instance request, all Spot - * Instances in the request are launched in the same Availability Zone. Instance proximity - * is maintained with this parameter, but the choice of Availability Zone is not. The group - * applies only to requests for Spot Instances of the same instance type. Any additional - * Spot Instance requests that are specified with the same Availability Zone group name are - * launched in that same Availability Zone, as long as at least one instance from the group - * is still active.
- *If there is no active instance running in the Availability Zone group that you specify - * for a new Spot Instance request (all instances are terminated, the request is expired, - * or the maximum price you specified falls below current Spot price), then Amazon EC2 launches - * the instance in any Availability Zone where the constraint can be met. Consequently, the - * subsequent set of Spot Instances could be placed in a different zone from the original - * request, even if you specified the same Availability Zone group.
- *Default: Instances are launched in any available Availability Zone.
+ *The IPv4 CIDR address block used for the destination match. The value that you + * provide must match the CIDR of an existing route in the table.
*/ - AvailabilityZoneGroup?: string; + DestinationCidrBlock?: string; /** - *Deprecated.
+ *The IPv6 CIDR address block used for the destination match. The value that you + * provide must match the CIDR of an existing route in the table.
*/ - BlockDurationMinutes?: number; + DestinationIpv6CidrBlock?: string; /** - *Unique, case-sensitive identifier that you provide to ensure the idempotency of the - * request. For more information, see How to Ensure - * Idempotency in the Amazon EC2 User Guide for Linux Instances.
+ *The ID of the prefix list for the route.
*/ - ClientToken?: string; + DestinationPrefixListId?: string; /** - *Checks whether you have the required permissions for the action, without actually
- * making the request, and provides an error response. If you have the required
- * permissions, the error response is DryRunOperation. Otherwise, it is
- * UnauthorizedOperation.
Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The maximum number of Spot Instances to launch.
- *Default: 1
+ *The ID of a VPC endpoint. Supported for Gateway Load Balancer endpoints only.
*/ - InstanceCount?: number; + VpcEndpointId?: string; /** - *The instance launch group. Launch groups are Spot Instances that launch together and - * terminate together.
- *Default: Instances are launched and terminated individually
+ *[IPv6 traffic only] The ID of an egress-only internet gateway.
*/ - LaunchGroup?: string; + EgressOnlyInternetGatewayId?: string; /** - *The launch specification.
+ *The ID of an internet gateway or virtual private gateway.
*/ - LaunchSpecification?: RequestSpotLaunchSpecification; + GatewayId?: string; /** - *The maximum price per hour that you are willing to pay for a Spot Instance. The - * default is the On-Demand price.
+ *The ID of a NAT instance in your VPC.
*/ - SpotPrice?: string; + InstanceId?: string; /** - *The Spot Instance request type.
- *Default: one-time
- *
Specifies whether to reset the local route to its default target (local).
The start date of the request. If this is a one-time request, the request becomes - * active at this date and time and remains active until all instances launch, the request - * expires, or the request is canceled. If the request is persistent, the request becomes - * active at this date and time and remains active until it expires or is canceled.
- *The specified start date and time cannot be equal to the current date and time. You - * must specify a start date and time that occurs after the current date and time.
+ *[IPv4 traffic only] The ID of a NAT gateway.
*/ - ValidFrom?: Date; + NatGatewayId?: string; /** - *The end date of the request, in UTC format - * (YYYY-MM-DDTHH:MM:SSZ).
- *For a persistent request, the request remains active until the
- * ValidUntil date and time is reached. Otherwise, the request
- * remains active until you cancel it.
For a one-time request, the request remains active until all instances launch,
- * the request is canceled, or the ValidUntil date and time is
- * reached. By default, the request is valid for 7 days from the date the request
- * was created.
The ID of a transit gateway.
*/ - ValidUntil?: Date; + TransitGatewayId?: string; /** - *The key-value pair for tagging the Spot Instance request on creation. The value for
- * ResourceType must be spot-instances-request, otherwise the
- * Spot Instance request fails. To tag the Spot Instance request after it has been created,
- * see CreateTags.
The ID of the local gateway.
*/ - TagSpecifications?: TagSpecification[]; + LocalGatewayId?: string; /** - *The behavior when a Spot Instance is interrupted. The default is terminate.
[IPv4 traffic only] The ID of a carrier gateway.
*/ - InstanceInterruptionBehavior?: InstanceInterruptionBehavior | string; -} + CarrierGatewayId?: string; -export namespace RequestSpotInstancesRequest { /** - * @internal + *The ID of a network interface.
*/ - export const filterSensitiveLog = (obj: RequestSpotInstancesRequest): any => ({ - ...obj, - }); -} + NetworkInterfaceId?: string; -/** - *Contains the output of RequestSpotInstances.
- */ -export interface RequestSpotInstancesResult { /** - *One or more Spot Instance requests.
+ *The ID of the route table.
*/ - SpotInstanceRequests?: SpotInstanceRequest[]; + RouteTableId: string | undefined; + + /** + *The ID of a VPC peering connection.
+ */ + VpcPeeringConnectionId?: string; + + /** + *The Amazon Resource Name (ARN) of the core network.
+ */ + CoreNetworkArn?: string; } -export namespace RequestSpotInstancesResult { +export namespace ReplaceRouteRequest { /** * @internal */ - export const filterSensitiveLog = (obj: RequestSpotInstancesResult): any => ({ + export const filterSensitiveLog = (obj: ReplaceRouteRequest): any => ({ ...obj, }); } -export interface ResetAddressAttributeRequest { - /** - *[EC2-VPC] The allocation ID.
- */ - AllocationId: string | undefined; - +export interface ReplaceRouteTableAssociationRequest { /** - *The attribute of the IP address.
+ *The association ID.
*/ - Attribute: AddressAttributeName | string | undefined; + AssociationId: string | undefined; /** *Checks whether you have the required permissions for the action, without actually making the request,
@@ -9113,683 +9013,660 @@ export interface ResetAddressAttributeRequest {
* Otherwise, it is UnauthorizedOperation.
The ID of the new route table to associate with the subnet.
+ */ + RouteTableId: string | undefined; } -export namespace ResetAddressAttributeRequest { +export namespace ReplaceRouteTableAssociationRequest { /** * @internal */ - export const filterSensitiveLog = (obj: ResetAddressAttributeRequest): any => ({ + export const filterSensitiveLog = (obj: ReplaceRouteTableAssociationRequest): any => ({ ...obj, }); } -export interface ResetAddressAttributeResult { +export interface ReplaceRouteTableAssociationResult { /** - *Information about the IP address.
+ *The ID of the new association.
*/ - Address?: AddressAttribute; + NewAssociationId?: string; + + /** + *The state of the association.
+ */ + AssociationState?: RouteTableAssociationState; } -export namespace ResetAddressAttributeResult { +export namespace ReplaceRouteTableAssociationResult { /** * @internal */ - export const filterSensitiveLog = (obj: ResetAddressAttributeResult): any => ({ + export const filterSensitiveLog = (obj: ReplaceRouteTableAssociationResult): any => ({ ...obj, }); } -export interface ResetEbsDefaultKmsKeyIdRequest { +export interface ReplaceTransitGatewayRouteRequest { /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The CIDR range used for the destination match. Routing decisions are based on the most specific match.
*/ - DryRun?: boolean; -} + DestinationCidrBlock: string | undefined; -export namespace ResetEbsDefaultKmsKeyIdRequest { /** - * @internal + *The ID of the route table.
*/ - export const filterSensitiveLog = (obj: ResetEbsDefaultKmsKeyIdRequest): any => ({ - ...obj, - }); -} + TransitGatewayRouteTableId: string | undefined; -export interface ResetEbsDefaultKmsKeyIdResult { /** - *The Amazon Resource Name (ARN) of the default KMS key for EBS encryption by default.
+ *The ID of the attachment.
*/ - KmsKeyId?: string; -} + TransitGatewayAttachmentId?: string; -export namespace ResetEbsDefaultKmsKeyIdResult { /** - * @internal + *Indicates whether traffic matching this route is to be dropped.
*/ - export const filterSensitiveLog = (obj: ResetEbsDefaultKmsKeyIdResult): any => ({ - ...obj, - }); -} - -export type ResetFpgaImageAttributeName = "loadPermission"; + Blackhole?: boolean; -export interface ResetFpgaImageAttributeRequest { /** *Checks whether you have the required permissions for the action, without actually making the request,
* and provides an error response. If you have the required permissions, the error response is DryRunOperation.
* Otherwise, it is UnauthorizedOperation.
The ID of the AFI.
- */ - FpgaImageId: string | undefined; - - /** - *The attribute.
- */ - Attribute?: ResetFpgaImageAttributeName | string; } -export namespace ResetFpgaImageAttributeRequest { +export namespace ReplaceTransitGatewayRouteRequest { /** * @internal */ - export const filterSensitiveLog = (obj: ResetFpgaImageAttributeRequest): any => ({ + export const filterSensitiveLog = (obj: ReplaceTransitGatewayRouteRequest): any => ({ ...obj, }); } -export interface ResetFpgaImageAttributeResult { +export interface ReplaceTransitGatewayRouteResult { /** - *Is true if the request succeeds, and an error otherwise.
Information about the modified route.
*/ - Return?: boolean; + Route?: TransitGatewayRoute; } -export namespace ResetFpgaImageAttributeResult { +export namespace ReplaceTransitGatewayRouteResult { /** * @internal */ - export const filterSensitiveLog = (obj: ResetFpgaImageAttributeResult): any => ({ + export const filterSensitiveLog = (obj: ReplaceTransitGatewayRouteResult): any => ({ ...obj, }); } -export type ResetImageAttributeName = "launchPermission"; - -/** - *Contains the parameters for ResetImageAttribute.
- */ -export interface ResetImageAttributeRequest { - /** - *The attribute to reset (currently you can only reset the launch permission attribute).
- */ - Attribute: ResetImageAttributeName | string | undefined; +export type ReportInstanceReasonCodes = + | "instance-stuck-in-state" + | "not-accepting-credentials" + | "other" + | "password-not-available" + | "performance-ebs-volume" + | "performance-instance-store" + | "performance-network" + | "performance-other" + | "unresponsive"; + +export type ReportStatusType = "impaired" | "ok"; +export interface ReportInstanceStatusRequest { /** - *The ID of the AMI.
+ *Descriptive text about the health state of your instance.
*/ - ImageId: string | undefined; + Description?: string; /** *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
*/
DryRun?: boolean;
-}
-export namespace ResetImageAttributeRequest {
/**
- * @internal
+ * The time at which the reported instance health state ended.
*/ - export const filterSensitiveLog = (obj: ResetImageAttributeRequest): any => ({ - ...obj, - }); -} + EndTime?: Date; -export interface ResetInstanceAttributeRequest { /** - *The attribute to reset.
- *You can only reset the following attributes: kernel |
- * ramdisk | sourceDestCheck. To change an instance
- * attribute, use ModifyInstanceAttribute.
The instances.
*/ - Attribute: InstanceAttributeName | string | undefined; + Instances: string[] | undefined; /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The reason codes that describe the health state of your instance.
+ *
+ * instance-stuck-in-state: My instance is stuck in a state.
+ * unresponsive: My instance is unresponsive.
+ * not-accepting-credentials: My instance is not accepting my
+ * credentials.
+ * password-not-available: A password is not available for my
+ * instance.
+ * performance-network: My instance is experiencing performance
+ * problems that I believe are network related.
+ * performance-instance-store: My instance is experiencing performance
+ * problems that I believe are related to the instance stores.
+ * performance-ebs-volume: My instance is experiencing performance
+ * problems that I believe are related to an EBS volume.
+ * performance-other: My instance is experiencing performance
+ * problems.
+ * other: [explain using the description parameter]
The ID of the instance.
+ *The time at which the reported instance health state began.
*/ - InstanceId: string | undefined; + StartTime?: Date; + + /** + *The status of all instances listed.
+ */ + Status: ReportStatusType | string | undefined; } -export namespace ResetInstanceAttributeRequest { +export namespace ReportInstanceStatusRequest { /** * @internal */ - export const filterSensitiveLog = (obj: ResetInstanceAttributeRequest): any => ({ + export const filterSensitiveLog = (obj: ReportInstanceStatusRequest): any => ({ ...obj, }); } /** - *Contains the parameters for ResetNetworkInterfaceAttribute.
+ *Contains the parameters for RequestSpotFleet.
*/ -export interface ResetNetworkInterfaceAttributeRequest { +export interface RequestSpotFleetRequest { /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
Checks whether you have the required permissions for the action, without actually
+ * making the request, and provides an error response. If you have the required
+ * permissions, the error response is DryRunOperation. Otherwise, it is
+ * UnauthorizedOperation.
The ID of the network interface.
- */ - NetworkInterfaceId: string | undefined; - - /** - *The source/destination checking attribute. Resets the value to true.
The configuration for the Spot Fleet request.
*/ - SourceDestCheck?: string; + SpotFleetRequestConfig: SpotFleetRequestConfigData | undefined; } -export namespace ResetNetworkInterfaceAttributeRequest { +export namespace RequestSpotFleetRequest { /** * @internal */ - export const filterSensitiveLog = (obj: ResetNetworkInterfaceAttributeRequest): any => ({ + export const filterSensitiveLog = (obj: RequestSpotFleetRequest): any => ({ ...obj, }); } -export interface ResetSnapshotAttributeRequest { - /** - *The attribute to reset. Currently, only the attribute for permission to create volumes can - * be reset.
- */ - Attribute: SnapshotAttributeName | string | undefined; - - /** - *The ID of the snapshot.
- */ - SnapshotId: string | undefined; - +/** + *Contains the output of RequestSpotFleet.
+ */ +export interface RequestSpotFleetResponse { /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The ID of the Spot Fleet request.
*/ - DryRun?: boolean; + SpotFleetRequestId?: string; } -export namespace ResetSnapshotAttributeRequest { +export namespace RequestSpotFleetResponse { /** * @internal */ - export const filterSensitiveLog = (obj: ResetSnapshotAttributeRequest): any => ({ + export const filterSensitiveLog = (obj: RequestSpotFleetResponse): any => ({ ...obj, }); } -export interface RestoreAddressToClassicRequest { +/** + *Describes the launch specification for an instance.
+ */ +export interface RequestSpotLaunchSpecification { /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
One or more security group IDs.
*/ - DryRun?: boolean; + SecurityGroupIds?: string[]; /** - *The Elastic IP address.
+ *One or more security groups. When requesting instances in a VPC, you must specify the IDs of the security groups. When requesting instances in EC2-Classic, you can specify the names or the IDs of the security groups.
*/ - PublicIp: string | undefined; -} + SecurityGroups?: string[]; -export namespace RestoreAddressToClassicRequest { /** - * @internal + *Deprecated.
*/ - export const filterSensitiveLog = (obj: RestoreAddressToClassicRequest): any => ({ - ...obj, - }); -} + AddressingType?: string; -export interface RestoreAddressToClassicResult { /** - *The Elastic IP address.
+ *One or more block device mapping entries. You can't specify both a snapshot ID and an encryption value. + * This is because only blank volumes can be encrypted on creation. If a snapshot is the basis for a volume, + * it is not blank and its encryption status is used for the volume encryption status.
*/ - PublicIp?: string; + BlockDeviceMappings?: BlockDeviceMapping[]; /** - *The move status for the IP address.
+ *Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.
+ *Default: false
+ *
The IAM instance profile.
*/ - export const filterSensitiveLog = (obj: RestoreAddressToClassicResult): any => ({ - ...obj, - }); -} + IamInstanceProfile?: IamInstanceProfileSpecification; -export interface RestoreManagedPrefixListVersionRequest { /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The ID of the AMI.
*/ - DryRun?: boolean; + ImageId?: string; /** - *The ID of the prefix list.
+ *The instance type.
*/ - PrefixListId: string | undefined; + InstanceType?: _InstanceType | string; /** - *The version to restore.
+ *The ID of the kernel.
*/ - PreviousVersion: number | undefined; + KernelId?: string; /** - *The current version number for the prefix list.
+ *The name of the key pair.
*/ - CurrentVersion: number | undefined; -} + KeyName?: string; -export namespace RestoreManagedPrefixListVersionRequest { /** - * @internal + *Indicates whether basic or detailed monitoring is enabled for the instance.
+ *Default: Disabled
*/ - export const filterSensitiveLog = (obj: RestoreManagedPrefixListVersionRequest): any => ({ - ...obj, - }); -} + Monitoring?: RunInstancesMonitoringEnabled; -export interface RestoreManagedPrefixListVersionResult { /** - *Information about the prefix list.
+ *One or more network interfaces. If you specify a network interface, you must specify + * subnet IDs and security group IDs using the network interface.
*/ - PrefixList?: ManagedPrefixList; -} + NetworkInterfaces?: InstanceNetworkInterfaceSpecification[]; -export namespace RestoreManagedPrefixListVersionResult { /** - * @internal + *The placement information for the instance.
*/ - export const filterSensitiveLog = (obj: RestoreManagedPrefixListVersionResult): any => ({ - ...obj, - }); -} + Placement?: SpotPlacement; -export interface RestoreSnapshotFromRecycleBinRequest { /** - *The ID of the snapshot to restore.
+ *The ID of the RAM disk.
*/ - SnapshotId: string | undefined; + RamdiskId?: string; /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The ID of the subnet in which to launch the instance.
*/ - DryRun?: boolean; + SubnetId?: string; + + /** + *The Base64-encoded user data for the instance. User data is limited to 16 KB.
+ */ + UserData?: string; } -export namespace RestoreSnapshotFromRecycleBinRequest { +export namespace RequestSpotLaunchSpecification { /** * @internal */ - export const filterSensitiveLog = (obj: RestoreSnapshotFromRecycleBinRequest): any => ({ + export const filterSensitiveLog = (obj: RequestSpotLaunchSpecification): any => ({ ...obj, }); } -export interface RestoreSnapshotFromRecycleBinResult { - /** - *The ID of the snapshot.
- */ - SnapshotId?: string; - - /** - *The ARN of the Outpost on which the snapshot is stored. For more information, see Amazon EBS local snapshots on Outposts in the - * Amazon Elastic Compute Cloud User Guide.
- */ - OutpostArn?: string; - +/** + *Contains the parameters for RequestSpotInstances.
+ */ +export interface RequestSpotInstancesRequest { /** - *The description for the snapshot.
+ *The user-specified name for a logical grouping of requests.
+ *When you specify an Availability Zone group in a Spot Instance request, all Spot + * Instances in the request are launched in the same Availability Zone. Instance proximity + * is maintained with this parameter, but the choice of Availability Zone is not. The group + * applies only to requests for Spot Instances of the same instance type. Any additional + * Spot Instance requests that are specified with the same Availability Zone group name are + * launched in that same Availability Zone, as long as at least one instance from the group + * is still active.
+ *If there is no active instance running in the Availability Zone group that you specify + * for a new Spot Instance request (all instances are terminated, the request is expired, + * or the maximum price you specified falls below current Spot price), then Amazon EC2 launches + * the instance in any Availability Zone where the constraint can be met. Consequently, the + * subsequent set of Spot Instances could be placed in a different zone from the original + * request, even if you specified the same Availability Zone group.
+ *Default: Instances are launched in any available Availability Zone.
*/ - Description?: string; + AvailabilityZoneGroup?: string; /** - *Indicates whether the snapshot is encrypted.
+ *Deprecated.
*/ - Encrypted?: boolean; + BlockDurationMinutes?: number; /** - *The ID of the Amazon Web Services account that owns the EBS snapshot.
+ *Unique, case-sensitive identifier that you provide to ensure the idempotency of the + * request. For more information, see How to Ensure + * Idempotency in the Amazon EC2 User Guide for Linux Instances.
*/ - OwnerId?: string; + ClientToken?: string; /** - *The progress of the snapshot, as a percentage.
+ *Checks whether you have the required permissions for the action, without actually
+ * making the request, and provides an error response. If you have the required
+ * permissions, the error response is DryRunOperation. Otherwise, it is
+ * UnauthorizedOperation.
The time stamp when the snapshot was initiated.
+ *The maximum number of Spot Instances to launch.
+ *Default: 1
*/ - StartTime?: Date; + InstanceCount?: number; /** - *The state of the snapshot.
+ *The instance launch group. Launch groups are Spot Instances that launch together and + * terminate together.
+ *Default: Instances are launched and terminated individually
*/ - State?: SnapshotState | string; + LaunchGroup?: string; /** - *The ID of the volume that was used to create the snapshot.
+ *The launch specification.
*/ - VolumeId?: string; + LaunchSpecification?: RequestSpotLaunchSpecification; /** - *The size of the volume, in GiB.
+ *The maximum price per hour that you are willing to pay for a Spot Instance. The + * default is the On-Demand price.
*/ - VolumeSize?: number; -} + SpotPrice?: string; -export namespace RestoreSnapshotFromRecycleBinResult { /** - * @internal + *The Spot Instance request type.
+ *Default: one-time
+ *
The ID of the snapshot to restore.
+ *The start date of the request. If this is a one-time request, the request becomes + * active at this date and time and remains active until all instances launch, the request + * expires, or the request is canceled. If the request is persistent, the request becomes + * active at this date and time and remains active until it expires or is canceled.
+ *The specified start date and time cannot be equal to the current date and time. You + * must specify a start date and time that occurs after the current date and time.
*/ - SnapshotId: string | undefined; + ValidFrom?: Date; /** - *Specifies the number of days for which to temporarily restore an archived snapshot. - * Required for temporary restores only. The snapshot will be automatically re-archived - * after this period.
- *To temporarily restore an archived snapshot, specify the number of days and omit
- * the PermanentRestore parameter or set it to
- * false.
The end date of the request, in UTC format + * (YYYY-MM-DDTHH:MM:SSZ).
+ *For a persistent request, the request remains active until the
+ * ValidUntil date and time is reached. Otherwise, the request
+ * remains active until you cancel it.
For a one-time request, the request remains active until all instances launch,
+ * the request is canceled, or the ValidUntil date and time is
+ * reached. By default, the request is valid for 7 days from the date the request
+ * was created.
Indicates whether to permanently restore an archived snapshot. To permanently restore
- * an archived snapshot, specify true and omit the
- * RestoreSnapshotTierRequest$TemporaryRestoreDays parameter.
The key-value pair for tagging the Spot Instance request on creation. The value for
+ * ResourceType must be spot-instances-request, otherwise the
+ * Spot Instance request fails. To tag the Spot Instance request after it has been created,
+ * see CreateTags.
Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The behavior when a Spot Instance is interrupted. The default is terminate.
The ID of the snapshot.
- */ - SnapshotId?: string; - - /** - *The date and time when the snapshot restore process started.
- */ - RestoreStartTime?: Date; - - /** - *For temporary restores only. The number of days for which the archived snapshot - * is temporarily restored.
- */ - RestoreDuration?: number; - +/** + *Contains the output of RequestSpotInstances.
+ */ +export interface RequestSpotInstancesResult { /** - *Indicates whether the snapshot is permanently restored. true indicates a permanent
- * restore. false indicates a temporary restore.
One or more Spot Instance requests.
*/ - IsPermanentRestore?: boolean; + SpotInstanceRequests?: SpotInstanceRequest[]; } -export namespace RestoreSnapshotTierResult { +export namespace RequestSpotInstancesResult { /** * @internal */ - export const filterSensitiveLog = (obj: RestoreSnapshotTierResult): any => ({ + export const filterSensitiveLog = (obj: RequestSpotInstancesResult): any => ({ ...obj, }); } -export interface RevokeClientVpnIngressRequest { - /** - *The ID of the Client VPN endpoint with which the authorization rule is associated.
- */ - ClientVpnEndpointId: string | undefined; - - /** - *The IPv4 address range, in CIDR notation, of the network for which access is being removed.
- */ - TargetNetworkCidr: string | undefined; - +export interface ResetAddressAttributeRequest { /** - *The ID of the Active Directory group for which to revoke access.
+ *[EC2-VPC] The allocation ID.
*/ - AccessGroupId?: string; + AllocationId: string | undefined; /** - *Indicates whether access should be revoked for all clients.
+ *The attribute of the IP address.
*/ - RevokeAllGroups?: boolean; + Attribute: AddressAttributeName | string | undefined; /** - *Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The current state of the authorization rule.
+ *Information about the IP address.
*/ - Status?: ClientVpnAuthorizationRuleStatus; + Address?: AddressAttribute; } -export namespace RevokeClientVpnIngressResult { +export namespace ResetAddressAttributeResult { /** * @internal */ - export const filterSensitiveLog = (obj: RevokeClientVpnIngressResult): any => ({ + export const filterSensitiveLog = (obj: ResetAddressAttributeResult): any => ({ ...obj, }); } -export interface RevokeSecurityGroupEgressRequest { +export interface ResetEbsDefaultKmsKeyIdRequest { /** *Checks whether you have the required permissions for the action, without actually making the request,
* and provides an error response. If you have the required permissions, the error response is DryRunOperation.
* Otherwise, it is UnauthorizedOperation.
The ID of the security group.
- */ - GroupId: string | undefined; - - /** - *The sets of IP permissions. You can't specify a destination security group and a CIDR IP address range in the same set of permissions.
- */ - IpPermissions?: IpPermission[]; - - /** - *The IDs of the security group rules.
+ * @internal */ - SecurityGroupRuleIds?: string[]; + export const filterSensitiveLog = (obj: ResetEbsDefaultKmsKeyIdRequest): any => ({ + ...obj, + }); +} +export interface ResetEbsDefaultKmsKeyIdResult { /** - *Not supported. Use a set of IP permissions to specify the CIDR.
+ *The Amazon Resource Name (ARN) of the default KMS key for EBS encryption by default.
*/ - CidrIp?: string; + KmsKeyId?: string; +} +export namespace ResetEbsDefaultKmsKeyIdResult { /** - *Not supported. Use a set of IP permissions to specify the port.
+ * @internal */ - FromPort?: number; + export const filterSensitiveLog = (obj: ResetEbsDefaultKmsKeyIdResult): any => ({ + ...obj, + }); +} - /** - *Not supported. Use a set of IP permissions to specify the protocol name or - * number.
- */ - IpProtocol?: string; +export type ResetFpgaImageAttributeName = "loadPermission"; +export interface ResetFpgaImageAttributeRequest { /** - *Not supported. Use a set of IP permissions to specify the port.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Not supported. Use a set of IP permissions to specify a - * destination security group.
+ *The ID of the AFI.
*/ - SourceSecurityGroupName?: string; + FpgaImageId: string | undefined; /** - *Not supported. Use a set of IP permissions to specify a destination security - * group.
+ *The attribute.
*/ - SourceSecurityGroupOwnerId?: string; + Attribute?: ResetFpgaImageAttributeName | string; } -export namespace RevokeSecurityGroupEgressRequest { +export namespace ResetFpgaImageAttributeRequest { /** * @internal */ - export const filterSensitiveLog = (obj: RevokeSecurityGroupEgressRequest): any => ({ + export const filterSensitiveLog = (obj: ResetFpgaImageAttributeRequest): any => ({ ...obj, }); } -export interface RevokeSecurityGroupEgressResult { +export interface ResetFpgaImageAttributeResult { /** - *Returns true if the request succeeds; otherwise, returns an error.
Is true if the request succeeds, and an error otherwise.
The outbound rules that were unknown to the service. In some cases,
- * unknownIpPermissionSet might be in a different format from the request
- * parameter.
The CIDR IP address range. You can't specify this parameter when specifying a source security group.
- */ - CidrIp?: string; - - /** - *The start of port range for the TCP and UDP protocols, or an ICMP type number. For the ICMP type number,
- * use -1 to specify all ICMP types.
The ID of the security group. You must specify either the security group ID or the - * security group name in the request. For security groups in a nondefault VPC, you must - * specify the security group ID.
- */ - GroupId?: string; - - /** - *[EC2-Classic, default VPC] The name of the security group. You must specify either the - * security group ID or the security group name in the request.
- */ - GroupName?: string; +export type ResetImageAttributeName = "launchPermission"; +/** + *Contains the parameters for ResetImageAttribute.
+ */ +export interface ResetImageAttributeRequest { /** - *The sets of IP permissions. You can't specify a source security group and a CIDR IP address range in the same set of permissions.
+ *The attribute to reset (currently you can only reset the launch permission attribute).
*/ - IpPermissions?: IpPermission[]; + Attribute: ResetImageAttributeName | string | undefined; /** - *The IP protocol name (tcp, udp, icmp) or number
- * (see Protocol Numbers).
- * Use -1 to specify all.
The ID of the AMI.
*/ - IpProtocol?: string; + ImageId: string | undefined; /** - *[EC2-Classic, default VPC] The name of the source security group. You can't specify this parameter in combination with the following parameters: the CIDR IP address range, the start of the port range, the IP protocol, and the end of the port range. For EC2-VPC, the source security group must be in the same VPC. To revoke a specific rule for an IP protocol and port range, use a set of IP permissions instead.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is
+ * DryRunOperation. Otherwise, it is UnauthorizedOperation.
[EC2-Classic] The Amazon Web Services account ID of the source security group, if the source security group is in a different account. You can't specify this parameter in combination with the following parameters: the CIDR IP address range, the IP protocol, the start of the port range, and the end of the port range. To revoke a specific rule for an IP protocol and port range, use a set of IP permissions instead.
+ * @internal */ - SourceSecurityGroupOwnerId?: string; + export const filterSensitiveLog = (obj: ResetImageAttributeRequest): any => ({ + ...obj, + }); +} +export interface ResetInstanceAttributeRequest { /** - *The end of port range for the TCP and UDP protocols, or an ICMP code number. For the ICMP code number,
- * use -1 to specify all ICMP codes for the ICMP type.
The attribute to reset.
+ *You can only reset the following attributes: kernel |
+ * ramdisk | sourceDestCheck. To change an instance
+ * attribute, use ModifyInstanceAttribute.
Checks whether you have the required permissions for the action, without actually making the request, @@ -9799,66 +9676,76 @@ export interface RevokeSecurityGroupIngressRequest { DryRun?: boolean; /** - *
The IDs of the security group rules.
+ *The ID of the instance.
*/ - SecurityGroupRuleIds?: string[]; + InstanceId: string | undefined; } -export namespace RevokeSecurityGroupIngressRequest { +export namespace ResetInstanceAttributeRequest { /** * @internal */ - export const filterSensitiveLog = (obj: RevokeSecurityGroupIngressRequest): any => ({ + export const filterSensitiveLog = (obj: ResetInstanceAttributeRequest): any => ({ ...obj, }); } -export interface RevokeSecurityGroupIngressResult { +/** + *Contains the parameters for ResetNetworkInterfaceAttribute.
+ */ +export interface ResetNetworkInterfaceAttributeRequest { + /** + *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Returns true if the request succeeds; otherwise, returns an error.
The ID of the network interface.
*/ - Return?: boolean; + NetworkInterfaceId: string | undefined; /** - *The inbound rules that were unknown to the service. In some cases,
- * unknownIpPermissionSet might be in a different format from the request
- * parameter.
The source/destination checking attribute. Resets the value to true.
The CPU options for the instance. Both the core count and threads per core must be - * specified in the request.
- */ -export interface CpuOptionsRequest { +export interface ResetSnapshotAttributeRequest { + /** + *The attribute to reset. Currently, only the attribute for permission to create volumes can + * be reset.
+ */ + Attribute: SnapshotAttributeName | string | undefined; + /** - *The number of CPU cores for the instance.
+ *The ID of the snapshot.
*/ - CoreCount?: number; + SnapshotId: string | undefined; /** - *The number of threads per CPU core. To disable multithreading for
- * the instance, specify a value of 1. Otherwise, specify the default value of
- * 2.
Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The Elastic IP address.
+ */ + PublicIp: string | undefined; +} + +export namespace RestoreAddressToClassicRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: RestoreAddressToClassicRequest): any => ({ + ...obj, + }); +} + +export interface RestoreAddressToClassicResult { + /** + *The Elastic IP address.
+ */ + PublicIp?: string; + + /** + *The move status for the IP address.
+ */ + Status?: Status | string; +} + +export namespace RestoreAddressToClassicResult { + /** + * @internal + */ + export const filterSensitiveLog = (obj: RestoreAddressToClassicResult): any => ({ + ...obj, + }); +} + +export interface RestoreManagedPrefixListVersionRequest { + /** + *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The ID of the prefix list.
+ */ + PrefixListId: string | undefined; + + /** + *The version to restore.
+ */ + PreviousVersion: number | undefined; + + /** + *The current version number for the prefix list.
+ */ + CurrentVersion: number | undefined; +} + +export namespace RestoreManagedPrefixListVersionRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: RestoreManagedPrefixListVersionRequest): any => ({ + ...obj, + }); +} + +export interface RestoreManagedPrefixListVersionResult { + /** + *Information about the prefix list.
+ */ + PrefixList?: ManagedPrefixList; +} + +export namespace RestoreManagedPrefixListVersionResult { + /** + * @internal + */ + export const filterSensitiveLog = (obj: RestoreManagedPrefixListVersionResult): any => ({ + ...obj, + }); +} + +export interface RestoreSnapshotFromRecycleBinRequest { + /** + *The ID of the snapshot to restore.
+ */ + SnapshotId: string | undefined; + + /** + *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The ID of the snapshot.
+ */ + SnapshotId?: string; + + /** + *The ARN of the Outpost on which the snapshot is stored. For more information, see Amazon EBS local snapshots on Outposts in the + * Amazon Elastic Compute Cloud User Guide.
+ */ + OutpostArn?: string; + + /** + *The description for the snapshot.
+ */ + Description?: string; + + /** + *Indicates whether the snapshot is encrypted.
+ */ + Encrypted?: boolean; + + /** + *The ID of the Amazon Web Services account that owns the EBS snapshot.
+ */ + OwnerId?: string; + + /** + *The progress of the snapshot, as a percentage.
+ */ + Progress?: string; + + /** + *The time stamp when the snapshot was initiated.
+ */ + StartTime?: Date; + + /** + *The state of the snapshot.
+ */ + State?: SnapshotState | string; + + /** + *The ID of the volume that was used to create the snapshot.
+ */ + VolumeId?: string; + + /** + *The size of the volume, in GiB.
+ */ + VolumeSize?: number; +} + +export namespace RestoreSnapshotFromRecycleBinResult { + /** + * @internal + */ + export const filterSensitiveLog = (obj: RestoreSnapshotFromRecycleBinResult): any => ({ + ...obj, + }); +} + +export interface RestoreSnapshotTierRequest { + /** + *The ID of the snapshot to restore.
+ */ + SnapshotId: string | undefined; + + /** + *Specifies the number of days for which to temporarily restore an archived snapshot. + * Required for temporary restores only. The snapshot will be automatically re-archived + * after this period.
+ *To temporarily restore an archived snapshot, specify the number of days and omit
+ * the PermanentRestore parameter or set it to
+ * false.
Indicates whether to permanently restore an archived snapshot. To permanently restore
+ * an archived snapshot, specify true and omit the
+ * RestoreSnapshotTierRequest$TemporaryRestoreDays parameter.
Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The ID of the snapshot.
+ */ + SnapshotId?: string; + + /** + *The date and time when the snapshot restore process started.
+ */ + RestoreStartTime?: Date; + + /** + *For temporary restores only. The number of days for which the archived snapshot + * is temporarily restored.
+ */ + RestoreDuration?: number; + + /** + *Indicates whether the snapshot is permanently restored. true indicates a permanent
+ * restore. false indicates a temporary restore.
The ID of the Client VPN endpoint with which the authorization rule is associated.
+ */ + ClientVpnEndpointId: string | undefined; + + /** + *The IPv4 address range, in CIDR notation, of the network for which access is being removed.
+ */ + TargetNetworkCidr: string | undefined; + + /** + *The ID of the Active Directory group for which to revoke access.
+ */ + AccessGroupId?: string; + + /** + *Indicates whether access should be revoked for all clients.
+ */ + RevokeAllGroups?: boolean; + + /** + *Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
The current state of the authorization rule.
+ */ + Status?: ClientVpnAuthorizationRuleStatus; +} + +export namespace RevokeClientVpnIngressResult { + /** + * @internal + */ + export const filterSensitiveLog = (obj: RevokeClientVpnIngressResult): any => ({ + ...obj, + }); +} + +export interface RevokeSecurityGroupEgressRequest { + /** + *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The ID of the security group.
+ */ + GroupId: string | undefined; + + /** + *The sets of IP permissions. You can't specify a destination security group and a CIDR IP address range in the same set of permissions.
+ */ + IpPermissions?: IpPermission[]; + + /** + *The IDs of the security group rules.
+ */ + SecurityGroupRuleIds?: string[]; + + /** + *Not supported. Use a set of IP permissions to specify the CIDR.
+ */ + CidrIp?: string; + + /** + *Not supported. Use a set of IP permissions to specify the port.
+ */ + FromPort?: number; + + /** + *Not supported. Use a set of IP permissions to specify the protocol name or + * number.
+ */ + IpProtocol?: string; + + /** + *Not supported. Use a set of IP permissions to specify the port.
+ */ + ToPort?: number; + + /** + *Not supported. Use a set of IP permissions to specify a + * destination security group.
+ */ + SourceSecurityGroupName?: string; + + /** + *Not supported. Use a set of IP permissions to specify a destination security + * group.
+ */ + SourceSecurityGroupOwnerId?: string; +} + +export namespace RevokeSecurityGroupEgressRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: RevokeSecurityGroupEgressRequest): any => ({ + ...obj, + }); +} + +export interface RevokeSecurityGroupEgressResult { + /** + *Returns true if the request succeeds; otherwise, returns an error.
The outbound rules that were unknown to the service. In some cases,
+ * unknownIpPermissionSet might be in a different format from the request
+ * parameter.
The CIDR IP address range. You can't specify this parameter when specifying a source security group.
+ */ + CidrIp?: string; + + /** + *The start of port range for the TCP and UDP protocols, or an ICMP type number. For the ICMP type number,
+ * use -1 to specify all ICMP types.
The ID of the security group. You must specify either the security group ID or the + * security group name in the request. For security groups in a nondefault VPC, you must + * specify the security group ID.
+ */ + GroupId?: string; + + /** + *[EC2-Classic, default VPC] The name of the security group. You must specify either the + * security group ID or the security group name in the request.
+ */ + GroupName?: string; + + /** + *The sets of IP permissions. You can't specify a source security group and a CIDR IP address range in the same set of permissions.
+ */ + IpPermissions?: IpPermission[]; + + /** + *The IP protocol name (tcp, udp, icmp) or number
+ * (see Protocol Numbers).
+ * Use -1 to specify all.
[EC2-Classic, default VPC] The name of the source security group. You can't specify this parameter in combination with the following parameters: the CIDR IP address range, the start of the port range, the IP protocol, and the end of the port range. For EC2-VPC, the source security group must be in the same VPC. To revoke a specific rule for an IP protocol and port range, use a set of IP permissions instead.
+ */ + SourceSecurityGroupName?: string; + + /** + *[EC2-Classic] The Amazon Web Services account ID of the source security group, if the source security group is in a different account. You can't specify this parameter in combination with the following parameters: the CIDR IP address range, the IP protocol, the start of the port range, and the end of the port range. To revoke a specific rule for an IP protocol and port range, use a set of IP permissions instead.
+ */ + SourceSecurityGroupOwnerId?: string; + + /** + *The end of port range for the TCP and UDP protocols, or an ICMP code number. For the ICMP code number,
+ * use -1 to specify all ICMP codes for the ICMP type.
Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The IDs of the security group rules.
+ */ + SecurityGroupRuleIds?: string[]; +} + +export namespace RevokeSecurityGroupIngressRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: RevokeSecurityGroupIngressRequest): any => ({ + ...obj, + }); +} + +export interface RevokeSecurityGroupIngressResult { + /** + *Returns true if the request succeeds; otherwise, returns an error.
The inbound rules that were unknown to the service. In some cases,
+ * unknownIpPermissionSet might be in a different format from the request
+ * parameter.
The CPU options for the instance. Both the core count and threads per core must be + * specified in the request.
+ */ +export interface CpuOptionsRequest { + /** + *The number of CPU cores for the instance.
+ */ + CoreCount?: number; + + /** + *The number of threads per CPU core. To disable multithreading for
+ * the instance, specify a value of 1. Otherwise, specify the default value of
+ * 2.
diff --git a/clients/client-ec2/src/pagination/DescribeFastLaunchImagesPaginator.ts b/clients/client-ec2/src/pagination/DescribeFastLaunchImagesPaginator.ts
new file mode 100644
index 0000000000000..8039a61e06174
--- /dev/null
+++ b/clients/client-ec2/src/pagination/DescribeFastLaunchImagesPaginator.ts
@@ -0,0 +1,59 @@
+import { Paginator } from "@aws-sdk/types";
+
+import {
+ DescribeFastLaunchImagesCommand,
+ DescribeFastLaunchImagesCommandInput,
+ DescribeFastLaunchImagesCommandOutput,
+} from "../commands/DescribeFastLaunchImagesCommand";
+import { EC2 } from "../EC2";
+import { EC2Client } from "../EC2Client";
+import { EC2PaginationConfiguration } from "./Interfaces";
+
+/**
+ * @private
+ */
+const makePagedClientRequest = async (
+ client: EC2Client,
+ input: DescribeFastLaunchImagesCommandInput,
+ ...args: any
+): Promise
If you make changes to parameters that require a Redis (cluster mode enabled) cluster reboot for the changes to be applied, - * see Rebooting a Cluster for an alternate process.
+ * see Rebooting a Cluster for an alternate process. */ public rebootCacheCluster( args: RebootCacheClusterCommandInput, diff --git a/clients/client-elasticache/src/commands/RebootCacheClusterCommand.ts b/clients/client-elasticache/src/commands/RebootCacheClusterCommand.ts index f871578444ac0..a35153c28d713 100644 --- a/clients/client-elasticache/src/commands/RebootCacheClusterCommand.ts +++ b/clients/client-elasticache/src/commands/RebootCacheClusterCommand.ts @@ -34,7 +34,7 @@ export interface RebootCacheClusterCommandOutput extends RebootCacheClusterResul * Rebooting is not supported on Redis (cluster mode enabled) clusters. * *If you make changes to parameters that require a Redis (cluster mode enabled) cluster reboot for the changes to be applied, - * see Rebooting a Cluster for an alternate process.
+ * see Rebooting a Cluster for an alternate process. * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-elasticache/src/models/models_0.ts b/clients/client-elasticache/src/models/models_0.ts index 6cac4fdb3f03a..6adeeb124e81b 100644 --- a/clients/client-elasticache/src/models/models_0.ts +++ b/clients/client-elasticache/src/models/models_0.ts @@ -724,6 +724,7 @@ export enum LogFormat { } export enum LogType { + ENGINE_LOG = "engine-log", SLOW_LOG = "slow-log", } @@ -740,7 +741,7 @@ export enum LogDeliveryConfigurationStatus { */ export interface LogDeliveryConfiguration { /** - *Refers to slow-log.
+ *Refers to slow-log or engine-log.
*/ LogType?: LogType | string; @@ -893,7 +894,7 @@ export enum PendingAutomaticFailoverStatus { */ export interface PendingLogDeliveryConfiguration { /** - *Refers to slow-log.
+ *Refers to slow-log or engine-log..
*/ LogType?: LogType | string; @@ -1499,7 +1500,7 @@ export interface Snapshot { * * *- * T4g node types (available only for Redis engine version 5.0.6 onward and Memcached engine version 1.5.16 onward):
+ * T4g node types (available only for Redis engine version 6.0 onward and Memcached engine version 1.5.16 onward): * * *@@ -1961,7 +1962,7 @@ export enum AZMode { */ export interface LogDeliveryConfigurationRequest { /** - *
Refers to slow-log.
+ *Refers to slow-log or engine-log..
*/ LogType?: LogType | string; @@ -2130,7 +2131,7 @@ export interface CreateCacheClusterMessage { * * *
- * T4g node types (available only for Redis engine version 5.0.6 onward and Memcached engine version 1.5.16 onward):
+ * T4g node types (available only for Redis engine version 6.0 onward and Memcached engine version 1.5.16 onward):
* cache.t4g.micro,
* cache.t4g.small,
* cache.t4g.medium
@@ -2572,7 +2573,7 @@ export namespace CreateCacheClusterMessage {
*
- * T4g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):
+ * T4g node types (available only for Redis engine version 6.0 onward and for Memcached engine version 1.5.16 onward):
* cache.t4g.micro,
* cache.t4g.small,
* cache.t4g.medium
@@ -3062,7 +3063,7 @@ export interface CacheCluster {
*
*
*
- * T4g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):
+ * T4g node types (available only for Redis engine version 6.0 onward and for Memcached engine version 1.5.16 onward):
* cache.t4g.micro,
* cache.t4g.small,
* cache.t4g.medium
@@ -4407,7 +4408,7 @@ export interface CreateReplicationGroupMessage {
*
*
*
- * T4g node types (available only for Redis engine version 5.0.6 onward and Memcached engine version 1.5.16 onward):
+ * T4g node types (available only for Redis engine version 6.0 onward and Memcached engine version 1.5.16 onward):
* cache.t4g.micro,
* cache.t4g.small,
* cache.t4g.medium
@@ -6896,7 +6897,7 @@ export interface DescribeReservedCacheNodesMessage {
*
- * T4g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):
+ * T4g node types (available only for Redis engine version 6.0 onward and for Memcached engine version 1.5.16 onward):
* cache.t4g.micro,
* cache.t4g.small,
* cache.t4g.medium
@@ -7247,7 +7248,7 @@ export interface ReservedCacheNode {
*
- * T4g node types (available only for Redis engine version 5.0.6 onward and Memcached engine version 1.5.16 onward):
+ * T4g node types (available only for Redis engine version 6.0 onward and Memcached engine version 1.5.16 onward):
* cache.t4g.micro,
* cache.t4g.small,
* cache.t4g.medium
@@ -7608,7 +7609,7 @@ export interface DescribeReservedCacheNodesOfferingsMessage {
*
- * T4g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):
+ * T4g node types (available only for Redis engine version 6.0 onward and for Memcached engine version 1.5.16 onward):
* cache.t4g.micro,
* cache.t4g.small,
* cache.t4g.medium
@@ -7932,7 +7933,7 @@ export interface ReservedCacheNodesOffering {
*
- * T4g node types (available only for Redis engine version 5.0.6 onward and Memcached engine version 1.5.16 onward):
+ * T4g node types (available only for Redis engine version 6.0 onward and Memcached engine version 1.5.16 onward):
* cache.t4g.micro,
* cache.t4g.small,
* cache.t4g.medium
diff --git a/clients/client-finspace-data/src/models/models_0.ts b/clients/client-finspace-data/src/models/models_0.ts
index bed3cd465e4cf..c8802446a82dc 100644
--- a/clients/client-finspace-data/src/models/models_0.ts
+++ b/clients/client-finspace-data/src/models/models_0.ts
@@ -29,7 +29,7 @@ export enum ChangeType {
*/
export interface CreateChangesetRequest {
/**
- *
A token used to ensure idempotency.
+ *A token that ensures idempotency. This token expires in 10 minutes.
*/ clientToken?: string; @@ -61,7 +61,19 @@ export interface CreateChangesetRequest { changeType: ChangeType | string | undefined; /** - *Options that define the location of the data being ingested.
+ *Options that define the location of the data being ingested (s3SourcePath) and the source of the changeset (sourceType).
Both s3SourcePath and sourceType are required attributes.
Here is an example of how you could specify the sourceParams:
+ *
+ * "sourceParams":
+ * {
+ * "s3SourcePath": "s3://finspace-landing-us-east-2-bk7gcfvitndqa6ebnvys4d/scratch/wr5hh8pwkpqqkxa4sxrmcw/ingestion/equity.csv",
+ * "sourceType": "S3"
+ * }
+ *
+ *
The S3 path that you specify must allow the FinSpace role access. To do that, you first need to configure the IAM policy on S3 bucket. For more information, see Loading data from an Amazon S3 Bucket using the FinSpace APIsection.
*/ sourceParams: { [key: string]: string } | undefined; @@ -90,11 +102,9 @@ export interface CreateChangesetRequest { * *Here is an example of how you could specify the formatParams:
- *
- * For example, you could specify the following for formatParams:
- *
- *
+ *
+ *
* "formatParams":
* {
* "formatType": "CSV",
@@ -102,8 +112,18 @@ export interface CreateChangesetRequest {
* "separator": ",",
* "compression":"None"
* }
- *
+ *
Note that if you only provide formatType as CSV, the rest of the attributes will automatically default to CSV values as following:
+ *
+ * {
+ * "withHeader": "true",
+ * "separator": ","
+ * }
+ *
*
For more information about supported file formats, see Supported Data Types and File Formats in the FinSpace User Guide.
*/ formatParams: { [key: string]: string } | undefined; } @@ -221,7 +241,43 @@ export namespace DatasetOwnerInfo { } /** - *Resource permission for a Dataset.
+ *Resource permission for a dataset. When you create a dataset, all the other members of the same user group inherit access to the dataset. You can only create a dataset if your user group has application permission for Create Datasets.
+ *The following is a list of valid dataset permissions that you can apply: + * + *
+ *
+ * ViewDatasetDetails
+ *
+ * ReadDatasetDetails
+ *
+ * AddDatasetData
+ *
+ * CreateSnapshot
+ *
+ * EditDatasetMetadata
+ *
+ * DeleteDataset
+ *
For more information on the ataset permissions, see Supported Dataset Permissions in the FinSpace User Guide.
*/ export interface ResourcePermission { /** @@ -241,6 +297,20 @@ export namespace ResourcePermission { /** *Permission group parameters for Dataset permissions.
+ *Here is an example of how you could specify the PermissionGroupParams:
+ *
+ * {
+ * "permissionGroupId": "0r6fCRtSTUk4XPfXQe3M0g",
+ * "datasetPermissions": [
+ * {"permission": "ViewDatasetDetails"},
+ * {"permission": "AddDatasetData"},
+ * {"permission": "EditDatasetMetadata"},
+ * {"permission": "DeleteDataset"}
+ * ]
+ * }
+ *
+ *
A token used to ensure idempotency.
+ *A token that ensures idempotency. This token expires in 10 minutes.
*/ clientToken?: string; @@ -477,15 +547,42 @@ export interface DataViewDestinationTypeParams { *
* GLUE_TABLE - Glue table destination type.
+ * S3 - S3 destination type.
Data view export file format.
+ *
+ * PARQUET - Parquet export file format.
+ * DELIMITED_TEXT - Delimited text export file format.
Format Options for S3 Destination type.
+ *Here is an example of how you could specify the s3DestinationExportFileFormatOptions
+ *
+ *
+ * {
+ * "header": "true",
+ * "delimiter": ",",
+ * "compression": "gzip"
+ * }
+ *
A token used to ensure idempotency.
+ *A token that ensures idempotency. This token expires in 10 minutes.
*/ clientToken?: string; @@ -576,7 +673,7 @@ export namespace CreateDataViewResponse { */ export interface DeleteDatasetRequest { /** - *A token used to ensure idempotency.
+ *A token that ensures idempotency. This token expires in 10 minutes.
*/ clientToken?: string; @@ -789,7 +886,7 @@ export interface GetChangesetResponse { activeUntilTimestamp?: number; /** - * Milliseconds since UTC epoch + *Beginning time from which the Changeset is active. The value is determined as Epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
*/ activeFromTimestamp?: number; @@ -1396,7 +1493,7 @@ export interface ChangesetSummary { activeUntilTimestamp?: number; /** - * Milliseconds since UTC epoch + *Beginning time from which the Changeset is active. The value is determined as Epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
*/ activeFromTimestamp?: number; @@ -1729,7 +1826,7 @@ export namespace ListDataViewsResponse { */ export interface UpdateChangesetRequest { /** - *A token used to ensure idempotency.
+ *A token that ensures idempotency. This token expires in 10 minutes.
*/ clientToken?: string; @@ -1744,12 +1841,69 @@ export interface UpdateChangesetRequest { changesetId: string | undefined; /** - *Options that define the location of the data being ingested.
+ *Options that define the location of the data being ingested (s3SourcePath) and the source of the changeset (sourceType).
Both s3SourcePath and sourceType are required attributes.
Here is an example of how you could specify the sourceParams:
+ *
+ * "sourceParams":
+ * {
+ * "s3SourcePath": "s3://finspace-landing-us-east-2-bk7gcfvitndqa6ebnvys4d/scratch/wr5hh8pwkpqqkxa4sxrmcw/ingestion/equity.csv",
+ * "sourceType": "S3"
+ * }
+ *
+ *
The S3 path that you specify must allow the FinSpace role access. To do that, you first need to configure the IAM policy on S3 bucket. For more information, see Loading data from an Amazon S3 Bucket using the FinSpace APIsection.
*/ sourceParams: { [key: string]: string } | undefined; /** - *Options that define the structure of the source file(s).
+ *Options that define the structure of the source file(s) including the format type (formatType), header row (withHeader), data separation character (separator) and the type of compression (compression).
+ *
+ * formatType is a required attribute and can have the following values:
+ *
+ * PARQUET - Parquet source file format.
+ * CSV - CSV source file format.
+ * JSON - JSON source file format.
+ * XML - XML source file format.
Here is an example of how you could specify the formatParams:
+ *
+ * "formatParams":
+ * {
+ * "formatType": "CSV",
+ * "withHeader": "true",
+ * "separator": ",",
+ * "compression":"None"
+ * }
+ *
+ *
Note that if you only provide formatType as CSV, the rest of the attributes will automatically default to CSV values as following:
+ *
+ * {
+ * "withHeader": "true",
+ * "separator": ","
+ * }
+ *
+ *
For more information about supported file formats, see Supported Data Types and File Formats in the FinSpace User Guide.
*/ formatParams: { [key: string]: string } | undefined; } @@ -1792,7 +1946,7 @@ export namespace UpdateChangesetResponse { */ export interface UpdateDatasetRequest { /** - *A token used to ensure idempotency.
+ *A token that ensures idempotency. This token expires in 10 minutes.
*/ clientToken?: string; diff --git a/clients/client-fis/README.md b/clients/client-fis/README.md index 91c587837e734..6ffcb6e6ca7de 100644 --- a/clients/client-fis/README.md +++ b/clients/client-fis/README.md @@ -7,8 +7,8 @@ AWS SDK for JavaScript Fis Client for Node.js, Browser and React Native. -AWS Fault Injection Simulator is a managed service that enables you to perform fault injection -experiments on your AWS workloads. For more information, see the AWS Fault Injection Simulator User Guide.
+Fault Injection Simulator is a managed service that enables you to perform fault injection +experiments on your Amazon Web Services workloads. For more information, see the Fault Injection Simulator User Guide.
## Installing diff --git a/clients/client-fis/src/Fis.ts b/clients/client-fis/src/Fis.ts index 4c611020f7c86..2f8fbfa3b4d86 100644 --- a/clients/client-fis/src/Fis.ts +++ b/clients/client-fis/src/Fis.ts @@ -61,18 +61,18 @@ import { import { FisClient } from "./FisClient"; /** - *AWS Fault Injection Simulator is a managed service that enables you to perform fault injection - * experiments on your AWS workloads. For more information, see the AWS Fault Injection Simulator User Guide.
+ *Fault Injection Simulator is a managed service that enables you to perform fault injection + * experiments on your Amazon Web Services workloads. For more information, see the Fault Injection Simulator User Guide.
*/ export class Fis extends FisClient { /** *Creates an experiment template.
- *To create a template, specify the following information:
+ *An experiment template includes the following components:
*- * Targets: A target can be a specific resource - * in your AWS environment, or one or more resources that match criteria that you + * Targets: A target can be a specific resource in + * your Amazon Web Services environment, or one or more resources that match criteria that you * specify, for example, resources that have specific tags.
*For more information, see the AWS Fault Injection Simulator User Guide.
+ *For more information, see Experiment templates + * in the Fault Injection Simulator User Guide.
*/ public createExperimentTemplate( args: CreateExperimentTemplateCommandInput, @@ -151,7 +152,7 @@ export class Fis extends FisClient { } /** - *Gets information about the specified AWS FIS action.
+ *Gets information about the specified FIS action.
*/ public getAction(args: GetActionCommandInput, options?: __HttpHandlerOptions): PromiseLists the available AWS FIS actions.
+ *Lists the available FIS actions.
*/ public listActions(args: ListActionsCommandInput, options?: __HttpHandlerOptions): PromiseAWS Fault Injection Simulator is a managed service that enables you to perform fault injection - * experiments on your AWS workloads. For more information, see the AWS Fault Injection Simulator User Guide.
+ *Fault Injection Simulator is a managed service that enables you to perform fault injection + * experiments on your Amazon Web Services workloads. For more information, see the Fault Injection Simulator User Guide.
*/ export class FisClient extends __Client< __HttpHandlerOptions, diff --git a/clients/client-fis/src/commands/CreateExperimentTemplateCommand.ts b/clients/client-fis/src/commands/CreateExperimentTemplateCommand.ts index b51ff7fec69f6..180938b761b70 100644 --- a/clients/client-fis/src/commands/CreateExperimentTemplateCommand.ts +++ b/clients/client-fis/src/commands/CreateExperimentTemplateCommand.ts @@ -23,12 +23,12 @@ export interface CreateExperimentTemplateCommandOutput extends CreateExperimentT /** *Creates an experiment template.
- *To create a template, specify the following information:
+ *An experiment template includes the following components:
*- * Targets: A target can be a specific resource - * in your AWS environment, or one or more resources that match criteria that you + * Targets: A target can be a specific resource in + * your Amazon Web Services environment, or one or more resources that match criteria that you * specify, for example, resources that have specific tags.
*For more information, see the AWS Fault Injection Simulator User Guide.
+ *For more information, see Experiment templates + * in the Fault Injection Simulator User Guide.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-fis/src/commands/GetActionCommand.ts b/clients/client-fis/src/commands/GetActionCommand.ts index 11a8ee7c38e58..3c48f86467cc2 100644 --- a/clients/client-fis/src/commands/GetActionCommand.ts +++ b/clients/client-fis/src/commands/GetActionCommand.ts @@ -22,7 +22,7 @@ export interface GetActionCommandInput extends GetActionRequest {} export interface GetActionCommandOutput extends GetActionResponse, __MetadataBearer {} /** - *Gets information about the specified AWS FIS action.
+ *Gets information about the specified FIS action.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-fis/src/commands/ListActionsCommand.ts b/clients/client-fis/src/commands/ListActionsCommand.ts index b15854f1b4979..117355431b0db 100644 --- a/clients/client-fis/src/commands/ListActionsCommand.ts +++ b/clients/client-fis/src/commands/ListActionsCommand.ts @@ -22,7 +22,7 @@ export interface ListActionsCommandInput extends ListActionsRequest {} export interface ListActionsCommandOutput extends ListActionsResponse, __MetadataBearer {} /** - *Lists the available AWS FIS actions.
+ *Lists the available FIS actions.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-fis/src/models/models_0.ts b/clients/client-fis/src/models/models_0.ts index cd543a73a2ee4..055da1aa0b32c 100644 --- a/clients/client-fis/src/models/models_0.ts +++ b/clients/client-fis/src/models/models_0.ts @@ -44,8 +44,8 @@ export namespace ActionTarget { } /** - *Describes an action. For more information, see AWS FIS actions - * in the AWS Fault Injection Simulator User Guide.
+ *Describes an action. For more information, see FIS actions + * in the Fault Injection Simulator User Guide.
*/ export interface Action { /** @@ -128,10 +128,12 @@ export interface ConflictException extends __SmithyException, $MetadataBearer { /** *Specifies an action for an experiment template.
+ *For more information, see Actions + * in the Fault Injection Simulator User Guide.
*/ export interface CreateExperimentTemplateActionInput { /** - *The ID of the action.
+ *The ID of the action. The format of the action ID is: aws:service-name:action-type.
*/ actionId: string | undefined; @@ -193,7 +195,9 @@ export namespace CreateExperimentTemplateStopConditionInput { } /** - *Describes a filter used for the target resource input in an experiment template.
+ *Specifies a filter used for the target resource input in an experiment template.
+ *For more information, see Resource filters + * in the Fault Injection Simulator User Guide.
*/ export interface ExperimentTemplateTargetInputFilter { /** @@ -219,10 +223,12 @@ export namespace ExperimentTemplateTargetInputFilter { /** *Specifies a target for an experiment. You must specify at least one Amazon Resource Name (ARN) or * at least one resource tag. You cannot specify both ARNs and tags.
+ *For more information, see Targets + * in the Fault Injection Simulator User Guide.
*/ export interface CreateExperimentTemplateTargetInput { /** - *The AWS resource type. The resource type must be supported for the specified action.
+ *The Amazon Web Services resource type. The resource type must be supported for the specified action.
*/ resourceType: string | undefined; @@ -276,7 +282,7 @@ export interface CreateExperimentTemplateRequest { clientToken?: string; /** - *A description for the experiment template. Can contain up to 64 letters (A-Z and a-z).
+ *A description for the experiment template.
*/ description: string | undefined; @@ -296,7 +302,7 @@ export interface CreateExperimentTemplateRequest { actions: { [key: string]: CreateExperimentTemplateActionInput } | undefined; /** - *The Amazon Resource Name (ARN) of an IAM role that grants the AWS FIS service permission to perform service actions on your behalf.
+ *The Amazon Resource Name (ARN) of an IAM role that grants the FIS service permission to perform service actions on your behalf.
*/ roleArn: string | undefined; @@ -643,6 +649,16 @@ export interface ExperimentAction { *The state of the action.
*/ state?: ExperimentActionState; + + /** + *The time that the action started.
+ */ + startTime?: Date; + + /** + *The time that the action ended.
+ */ + endTime?: Date; } export namespace ExperimentAction { @@ -790,7 +806,7 @@ export interface Experiment { experimentTemplateId?: string; /** - *The Amazon Resource Name (ARN) of an IAM role that grants the AWS FIS service permission to perform service actions on your behalf.
+ *The Amazon Resource Name (ARN) of an IAM role that grants the FIS service permission to perform service actions on your behalf.
*/ roleArn?: string; @@ -815,12 +831,12 @@ export interface Experiment { stopConditions?: ExperimentStopCondition[]; /** - *The time the experiment was created.
+ *The time that the experiment was created.
*/ creationTime?: Date; /** - *The time that the experiment was started.
+ *The time that the experiment started.
*/ startTime?: Date; @@ -1384,7 +1400,7 @@ export namespace UpdateExperimentTemplateStopConditionInput { */ export interface UpdateExperimentTemplateTargetInput { /** - *The AWS resource type. The resource type must be supported for the specified action.
+ *The Amazon Web Services resource type. The resource type must be supported for the specified action.
*/ resourceType: string | undefined; @@ -1445,7 +1461,7 @@ export interface UpdateExperimentTemplateRequest { actions?: { [key: string]: UpdateExperimentTemplateActionInputItem }; /** - *The Amazon Resource Name (ARN) of an IAM role that grants the AWS FIS service permission to perform service actions on your behalf.
+ *The Amazon Resource Name (ARN) of an IAM role that grants the FIS service permission to perform service actions on your behalf.
*/ roleArn?: string; } diff --git a/clients/client-fis/src/protocols/Aws_restJson1.ts b/clients/client-fis/src/protocols/Aws_restJson1.ts index f1d4a251c03b9..c5fb76b88900c 100644 --- a/clients/client-fis/src/protocols/Aws_restJson1.ts +++ b/clients/client-fis/src/protocols/Aws_restJson1.ts @@ -1861,6 +1861,10 @@ const deserializeAws_restJson1ExperimentAction = (output: any, context: __SerdeC return { actionId: __expectString(output.actionId), description: __expectString(output.description), + endTime: + output.endTime !== undefined && output.endTime !== null + ? __expectNonNull(__parseEpochTimestamp(__expectNumber(output.endTime))) + : undefined, parameters: output.parameters !== undefined && output.parameters !== null ? deserializeAws_restJson1ExperimentActionParameterMap(output.parameters, context) @@ -1869,6 +1873,10 @@ const deserializeAws_restJson1ExperimentAction = (output: any, context: __SerdeC output.startAfter !== undefined && output.startAfter !== null ? deserializeAws_restJson1ExperimentActionStartAfterList(output.startAfter, context) : undefined, + startTime: + output.startTime !== undefined && output.startTime !== null + ? __expectNonNull(__parseEpochTimestamp(__expectNumber(output.startTime))) + : undefined, state: output.state !== undefined && output.state !== null ? deserializeAws_restJson1ExperimentActionState(output.state, context) diff --git a/clients/client-fms/src/FMS.ts b/clients/client-fms/src/FMS.ts index 081aec3e5c166..bd657c93e060f 100644 --- a/clients/client-fms/src/FMS.ts +++ b/clients/client-fms/src/FMS.ts @@ -868,7 +868,7 @@ export class FMS extends FMSClient { * Amazon VPCs. * *A DNS Firewall policy, which provides Route 53 Resolver DNS Firewall rules to filter DNS queries for + *
A DNS Firewall policy, which provides Route 53 Resolver DNS Firewall rules to filter DNS queries for * specified VPCs.
*A DNS Firewall policy, which provides Route 53 Resolver DNS Firewall rules to filter DNS queries for + *
A DNS Firewall policy, which provides Route 53 Resolver DNS Firewall rules to filter DNS queries for * specified VPCs.
*Details about the service that are specific to the service type, in JSON format. For
- * service type SHIELD_ADVANCED, this is an empty string.
Details about the service that are specific to the service type, in JSON format.
*Example: DNS_FIREWALL
@@ -738,6 +737,16 @@ export interface SecurityServicePolicyData {
*
Specification for SHIELD_ADVANCED for Amazon CloudFront distributions
+ * "{\"type\":\"SHIELD_ADVANCED\",\"automaticResponseConfiguration\": {\"automaticResponseStatus\":\"ENABLED|IGNORED|DISABLED\", \"automaticResponseAction\":\"BLOCK|COUNT\"}, \"overrideCustomerWebaclClassic\":true|false}"
+ *
For example: "{\"type\":\"SHIELD_ADVANCED\",\"automaticResponseConfiguration\": {\"automaticResponseStatus\":\"ENABLED\", \"automaticResponseAction\":\"COUNT\"}}"
+ *
The default value for automaticResponseStatus is IGNORED. The value for automaticResponseAction is only required when automaticResponseStatus is set to ENABLED. The default value for overrideCustomerWebaclClassic is false.
For other resource types that you can protect with a Shield Advanced policy, this ManagedServiceData configuration is an empty string.
Example: WAFV2
*
@@ -831,8 +840,8 @@ export interface Policy { *
The type of resource protected by or in scope of the policy. This is in the format shown
* in the Amazon Web Services Resource Types Reference.
* To apply this policy to multiple resource types, specify a resource type of ResourceTypeList and then specify the resource types in a ResourceTypeList.
For WAF and Shield Advanced, example resource types include
- * AWS::ElasticLoadBalancingV2::LoadBalancer and
+ *
For WAF and Shield Advanced, resource types include
+ * AWS::ElasticLoadBalancingV2::LoadBalancer, AWS::ElasticLoadBalancing::LoadBalancer, AWS::EC2::EIP, and
* AWS::CloudFront::Distribution. For a security group common policy, valid values
* are AWS::EC2::NetworkInterface and AWS::EC2::Instance. For a
* security group content audit policy, valid values are AWS::EC2::SecurityGroup,
@@ -866,7 +875,11 @@ export interface Policy {
RemediationEnabled: boolean | undefined;
/**
- *
Indicates whether Firewall Manager should delete Firewall Manager managed resources, such as web ACLs and security groups, when they are not in use by the Firewall Manager policy. By default, Firewall Manager doesn't delete unused Firewall Manager managed resources. This option is not available for Shield Advanced or WAF Classic policies.
+ *Indicates whether Firewall Manager should automatically remove protections from resources that leave the policy scope and clean up resources + * that Firewall Manager is managing for accounts when those accounts leave policy scope. For example, Firewall Manager will disassociate a Firewall Manager managed web ACL + * from a protected customer resource when the customer resource leaves policy scope.
+ *By default, Firewall Manager doesn't remove protections or delete Firewall Manager managed resources.
+ *This option is not available for Shield Advanced or WAF Classic policies.
*/ DeleteUnusedFMManagedResources?: boolean; @@ -2998,7 +3011,11 @@ export interface PolicySummary { RemediationEnabled?: boolean; /** - *Indicates whether Firewall Manager should delete Firewall Manager managed resources, such as web ACLs and security groups, when they are not in use by the Firewall Manager policy. By default, Firewall Manager doesn't delete unused Firewall Manager managed resources. This option is not available for Shield Advanced or WAF Classic policies.
+ *Indicates whether Firewall Manager should automatically remove protections from resources that leave the policy scope and clean up resources + * that Firewall Manager is managing for accounts when those accounts leave policy scope. For example, Firewall Manager will disassociate a Firewall Manager managed web ACL + * from a protected customer resource when the customer resource leaves policy scope.
+ *By default, Firewall Manager doesn't remove protections or delete Firewall Manager managed resources.
+ *This option is not available for Shield Advanced or WAF Classic policies.
*/ DeleteUnusedFMManagedResources?: boolean; } diff --git a/clients/client-glue/src/models/models_1.ts b/clients/client-glue/src/models/models_1.ts index 5efd75688cf54..1358b5007dba1 100644 --- a/clients/client-glue/src/models/models_1.ts +++ b/clients/client-glue/src/models/models_1.ts @@ -5966,6 +5966,11 @@ export interface StartWorkflowRunRequest { *The name of the workflow to start.
*/ Name: string | undefined; + + /** + *The workflow run properties for the new workflow run.
+ */ + RunProperties?: { [key: string]: string }; } export namespace StartWorkflowRunRequest { diff --git a/clients/client-glue/src/protocols/Aws_json1_1.ts b/clients/client-glue/src/protocols/Aws_json1_1.ts index 4e8522961d25c..1804a987df54b 100644 --- a/clients/client-glue/src/protocols/Aws_json1_1.ts +++ b/clients/client-glue/src/protocols/Aws_json1_1.ts @@ -20458,6 +20458,10 @@ const serializeAws_json1_1StartTriggerRequest = (input: StartTriggerRequest, con const serializeAws_json1_1StartWorkflowRunRequest = (input: StartWorkflowRunRequest, context: __SerdeContext): any => { return { ...(input.Name !== undefined && input.Name !== null && { Name: input.Name }), + ...(input.RunProperties !== undefined && + input.RunProperties !== null && { + RunProperties: serializeAws_json1_1WorkflowRunProperties(input.RunProperties, context), + }), }; }; diff --git a/clients/client-guardduty/README.md b/clients/client-guardduty/README.md index 8f88d8c8957e2..05584c5f6bef4 100644 --- a/clients/client-guardduty/README.md +++ b/clients/client-guardduty/README.md @@ -8,17 +8,17 @@ AWS SDK for JavaScript GuardDuty Client for Node.js, Browser and React Native.Amazon GuardDuty is a continuous security monitoring service that analyzes and processes -the following data sources: VPC Flow Logs, AWS CloudTrail event logs, and DNS logs. It uses +the following data sources: VPC Flow Logs, Amazon Web Services CloudTrail event logs, and DNS logs. It uses threat intelligence feeds (such as lists of malicious IPs and domains) and machine learning to -identify unexpected, potentially unauthorized, and malicious activity within your AWS +identify unexpected, potentially unauthorized, and malicious activity within your Amazon Web Services environment. This can include issues like escalations of privileges, uses of exposed credentials, or communication with malicious IPs, URLs, or domains. For example, GuardDuty can detect compromised EC2 instances that serve malware or mine bitcoin.
-GuardDuty also monitors AWS account access behavior for signs of compromise. Some examples +
GuardDuty also monitors Amazon Web Services account access behavior for signs of compromise. Some examples of this are unauthorized infrastructure deployments such as EC2 instances deployed in a Region that has never been used, or unusual API calls like a password policy change to reduce password strength.
-GuardDuty informs you of the status of your AWS environment by producing security findings +
resource.s3BucketDetails.publicAccess.effectivePermissions
+ *resource.s3BucketDetails.name
+ *resource.s3BucketDetails.tags.key
+ *resource.s3BucketDetails.tags.value
+ *resource.s3BucketDetails.type
+ *service.archived
*When this attribute is set to TRUE, only archived findings are listed. When it's set * to FALSE, only unarchived findings are listed. When this attribute is not set, all @@ -1263,8 +1307,7 @@ export interface CreateIPSetRequest { Format: IpSetFormat | string | undefined; /** - *
The URI of the file that contains the IPSet. For example: - * https://s3.us-west-2.amazonaws.com/my-bucket/my-object-key.
+ *The URI of the file that contains the IPSet.
*/ Location: string | undefined; @@ -1338,7 +1381,7 @@ export namespace CreateMembersRequest { */ export interface UnprocessedAccount { /** - *The AWS account ID.
+ *The Amazon Web Services account ID.
*/ AccountId: string | undefined; @@ -1381,6 +1424,9 @@ export namespace CreateMembersResponse { export interface DestinationProperties { /** *The ARN of the resource to publish to.
+ *To specify an S3 bucket folder use the following format:
+ * arn:aws:s3:::DOC-EXAMPLE-BUCKET/myFolder/
+ *
The URI of the file that contains the ThreatIntelSet. For example: - * https://s3.us-west-2.amazonaws.com/my-bucket/my-object-key.
+ *The URI of the file that contains the ThreatIntelSet.
*/ Location: string | undefined; @@ -1662,7 +1707,7 @@ export namespace DataSourceConfigurationsResult { export interface DeclineInvitationsRequest { /** - *A list of account IDs of the AWS accounts that sent invitations to the current member + *
A list of account IDs of the Amazon Web Services accounts that sent invitations to the current member * account that you want to decline invitations from.
*/ AccountIds: string[] | undefined; @@ -1782,7 +1827,7 @@ export namespace DeleteFilterResponse { export interface DeleteInvitationsRequest { /** - *A list of account IDs of the AWS accounts that sent invitations to the current member + *
A list of account IDs of the Amazon Web Services accounts that sent invitations to the current member * account that you want to delete invitations from.
*/ AccountIds: string[] | undefined; @@ -2141,7 +2186,7 @@ export enum DetectorStatus { export interface DisableOrganizationAdminAccountRequest { /** - *The AWS Account ID for the organizations account to be disabled as a GuardDuty delegated + *
The Amazon Web Services Account ID for the organizations account to be disabled as a GuardDuty delegated * administrator.
*/ AdminAccountId: string | undefined; @@ -2236,7 +2281,7 @@ export namespace DisassociateMembersResponse { export interface EnableOrganizationAdminAccountRequest { /** - *The AWS Account ID for the organization account to be enabled as a GuardDuty delegated + *
The Amazon Web Services Account ID for the organization account to be enabled as a GuardDuty delegated * administrator.
*/ AdminAccountId: string | undefined; @@ -2536,7 +2581,7 @@ export interface InstanceDetails { InstanceType?: string; /** - *The Amazon Resource Name (ARN) of the AWS Outpost. Only applicable to AWS Outposts + *
The Amazon Resource Name (ARN) of the Amazon Web Services Outpost. Only applicable to Amazon Web Services Outposts * instances.
*/ OutpostArn?: string; @@ -2702,7 +2747,7 @@ export namespace S3BucketDetail { } /** - *Contains information about the AWS resource associated with the activity that prompted + *
Contains information about the Amazon Web Services resource associated with the activity that prompted * GuardDuty to generate a finding.
*/ export interface Resource { @@ -2724,7 +2769,7 @@ export interface Resource { InstanceDetails?: InstanceDetails; /** - *The type of AWS resource.
+ *The type of Amazon Web Services resource.
*/ ResourceType?: string; } @@ -2785,7 +2830,7 @@ export interface Service { ResourceRole?: string; /** - *The name of the AWS service (GuardDuty) that generated a finding.
+ *The name of the Amazon Web Services service (GuardDuty) that generated a finding.
*/ ServiceName?: string; @@ -2850,7 +2895,7 @@ export interface Finding { Region: string | undefined; /** - *Contains information about the AWS resource associated with the activity that prompted + *
Contains information about the Amazon Web Services resource associated with the activity that prompted * GuardDuty to generate a finding.
*/ Resource: Resource | undefined; @@ -3228,8 +3273,7 @@ export interface GetIPSetResponse { Format: IpSetFormat | string | undefined; /** - *The URI of the file that contains the IPSet. For example: - * https://s3.us-west-2.amazonaws.com/my-bucket/my-object-key.
+ *The URI of the file that contains the IPSet.
*/ Location: string | undefined; @@ -3523,8 +3567,7 @@ export interface GetThreatIntelSetResponse { Format: ThreatIntelSetFormat | string | undefined; /** - *The URI of the file that contains the ThreatIntelSet. For example: - * https://s3.us-west-2.amazonaws.com/my-bucket/my-object-key.
+ *The URI of the file that contains the ThreatIntelSet.
*/ Location: string | undefined; @@ -3704,11 +3747,11 @@ export namespace UsageDataSourceResult { } /** - *Contains information on the sum of usage based on an AWS resource.
+ *Contains information on the sum of usage based on an Amazon Web Services resource.
*/ export interface UsageResourceResult { /** - *The AWS resource that generated usage.
+ *The Amazon Web Services resource that generated usage.
*/ Resource?: string; @@ -4058,9 +4101,6 @@ export interface ListFindingsRequest { *service.action.networkConnectionAction.protocol
*service.action.networkConnectionAction.remoteIpDetails.city.cityName
- *service.action.networkConnectionAction.remoteIpDetails.country.countryName
*The updated URI of the file that contains the IPSet. For example: - * https://s3.us-west-2.amazonaws.com/my-bucket/my-object-key.
+ *The updated URI of the file that contains the IPSet.
*/ Location?: string; diff --git a/clients/client-guardduty/src/protocols/Aws_restJson1.ts b/clients/client-guardduty/src/protocols/Aws_restJson1.ts index c2e2abf637bdd..5a6a4f1c2bcd2 100644 --- a/clients/client-guardduty/src/protocols/Aws_restJson1.ts +++ b/clients/client-guardduty/src/protocols/Aws_restJson1.ts @@ -205,6 +205,7 @@ import { PrivateIpAddressDetails, ProductCode, PublicAccess, + RemoteAccountDetails, RemoteIpDetails, RemotePortDetails, Resource, @@ -6356,6 +6357,10 @@ const deserializeAws_restJson1AwsApiCallAction = (output: any, context: __SerdeC ? deserializeAws_restJson1DomainDetails(output.domainDetails, context) : undefined, ErrorCode: __expectString(output.errorCode), + RemoteAccountDetails: + output.remoteAccountDetails !== undefined && output.remoteAccountDetails !== null + ? deserializeAws_restJson1RemoteAccountDetails(output.remoteAccountDetails, context) + : undefined, RemoteIpDetails: output.remoteIpDetails !== undefined && output.remoteIpDetails !== null ? deserializeAws_restJson1RemoteIpDetails(output.remoteIpDetails, context) @@ -7062,6 +7067,13 @@ const deserializeAws_restJson1PublicAccess = (output: any, context: __SerdeConte } as any; }; +const deserializeAws_restJson1RemoteAccountDetails = (output: any, context: __SerdeContext): RemoteAccountDetails => { + return { + AccountId: __expectString(output.accountId), + Affiliated: __expectBoolean(output.affiliated), + } as any; +}; + const deserializeAws_restJson1RemoteIpDetails = (output: any, context: __SerdeContext): RemoteIpDetails => { return { City: diff --git a/clients/client-honeycode/src/Honeycode.ts b/clients/client-honeycode/src/Honeycode.ts index a39f9ae13e6bc..c444d90f4309b 100644 --- a/clients/client-honeycode/src/Honeycode.ts +++ b/clients/client-honeycode/src/Honeycode.ts @@ -46,6 +46,11 @@ import { ListTableRowsCommandOutput, } from "./commands/ListTableRowsCommand"; import { ListTablesCommand, ListTablesCommandInput, ListTablesCommandOutput } from "./commands/ListTablesCommand"; +import { + ListTagsForResourceCommand, + ListTagsForResourceCommandInput, + ListTagsForResourceCommandOutput, +} from "./commands/ListTagsForResourceCommand"; import { QueryTableRowsCommand, QueryTableRowsCommandInput, @@ -56,6 +61,12 @@ import { StartTableDataImportJobCommandInput, StartTableDataImportJobCommandOutput, } from "./commands/StartTableDataImportJobCommand"; +import { TagResourceCommand, TagResourceCommandInput, TagResourceCommandOutput } from "./commands/TagResourceCommand"; +import { + UntagResourceCommand, + UntagResourceCommandInput, + UntagResourceCommandOutput, +} from "./commands/UntagResourceCommand"; import { HoneycodeClient } from "./HoneycodeClient"; /** @@ -429,6 +440,40 @@ export class Honeycode extends HoneycodeClient { } } + /** + *+ * The ListTagsForResource API allows you to return a resource's tags. + *
+ */ + public listTagsForResource( + args: ListTagsForResourceCommandInput, + options?: __HttpHandlerOptions + ): Promise* The QueryTableRows API allows you to use a filter formula to query for specific rows in a table. @@ -498,4 +543,68 @@ export class Honeycode extends HoneycodeClient { return this.send(command, optionsOrCb); } } + + /** + *
+ * The TagResource API allows you to add tags to an ARN-able resource. Resource includes workbook, table, + * screen and screen-automation. + *
+ */ + public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise+ * The UntagResource API allows you to removes tags from an ARN-able resource. Resource includes workbook, table, + * screen and screen-automation. + *
+ */ + public untagResource( + args: UntagResourceCommandInput, + options?: __HttpHandlerOptions + ): Promise+ * The ListTagsForResource API allows you to return a resource's tags. + *
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { HoneycodeClient, ListTagsForResourceCommand } from "@aws-sdk/client-honeycode"; // ES Modules import + * // const { HoneycodeClient, ListTagsForResourceCommand } = require("@aws-sdk/client-honeycode"); // CommonJS import + * const client = new HoneycodeClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link HoneycodeClientResolvedConfig | config} for HoneycodeClient's `config` shape. + * + */ +export class ListTagsForResourceCommand extends $Command< + ListTagsForResourceCommandInput, + ListTagsForResourceCommandOutput, + HoneycodeClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + constructor(readonly input: ListTagsForResourceCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStack+ * The TagResource API allows you to add tags to an ARN-able resource. Resource includes workbook, table, + * screen and screen-automation. + *
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { HoneycodeClient, TagResourceCommand } from "@aws-sdk/client-honeycode"; // ES Modules import + * // const { HoneycodeClient, TagResourceCommand } = require("@aws-sdk/client-honeycode"); // CommonJS import + * const client = new HoneycodeClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link HoneycodeClientResolvedConfig | config} for HoneycodeClient's `config` shape. + * + */ +export class TagResourceCommand extends $Command< + TagResourceCommandInput, + TagResourceCommandOutput, + HoneycodeClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + constructor(readonly input: TagResourceCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStack+ * The UntagResource API allows you to removes tags from an ARN-able resource. Resource includes workbook, table, + * screen and screen-automation. + *
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { HoneycodeClient, UntagResourceCommand } from "@aws-sdk/client-honeycode"; // ES Modules import + * // const { HoneycodeClient, UntagResourceCommand } = require("@aws-sdk/client-honeycode"); // CommonJS import + * const client = new HoneycodeClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link HoneycodeClientResolvedConfig | config} for HoneycodeClient's `config` shape. + * + */ +export class UntagResourceCommand extends $Command< + UntagResourceCommandInput, + UntagResourceCommandOutput, + HoneycodeClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + constructor(readonly input: UntagResourceCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStack* CellInput object contains the data needed to create or update cells in a table. *
+ *+ * CellInput object has only a facts field or a fact field, but not both. A 400 bad request will be + * thrown if both fact and facts field are present. + *
+ *+ * A list representing the values that are entered into a ROWSET cell. Facts list can have either only values + * or rowIDs, and rowIDs should from the same table. + *
+ */ + facts?: string[]; } export namespace CellInput { @@ -53,6 +67,7 @@ export namespace CellInput { export const filterSensitiveLog = (obj: CellInput): any => ({ ...obj, ...(obj.fact && { fact: SENSITIVE_STRING }), + ...(obj.facts && { facts: SENSITIVE_STRING }), }); } @@ -721,6 +736,7 @@ export enum Format { Number = "NUMBER", Percentage = "PERCENTAGE", Rowlink = "ROWLINK", + Rowset = "ROWSET", Text = "TEXT", Time = "TIME", } @@ -779,6 +795,18 @@ export interface Cell { * "row:dfcefaee-5b37-4355-8f28-40c3e4ff5dd4/ca432b2f-b8eb-431d-9fb5-cbe0342f9f03" as the raw value. * *+ * Cells with format ROWSET (aka multi-select or multi-record picklist) will by default have the first column + * of each of the linked rows as the formatted value in the list, and the rowset id of the linked rows as the + * raw value. For example, a cell containing a multi-select picklist to a table that contains items might have + * "Item A", "Item B" in the formatted value list and "rows:b742c1f4-6cb0-4650-a845-35eb86fcc2bb/ + * [fdea123b-8f68-474a-aa8a-5ff87aa333af,6daf41f0-a138-4eee-89da-123086d36ecf]" as the raw value. + *
+ *+ * Cells with format ATTACHMENT will have the name of the attachment as the formatted value and the attachment + * id as the raw value. For example, a cell containing an attachment named "image.jpeg" will have + * "image.jpeg" as the formatted value and "attachment:ca432b2f-b8eb-431d-9fb5-cbe0342f9f03" as the raw value. + *
+ ** Cells with format AUTO or cells without any format that are auto-detected as one of the formats above will * contain the raw and formatted values as mentioned above, based on the auto-detected formats. If there is no * auto-detected format, the raw and formatted values will be the same as the data in the cell. @@ -798,6 +826,15 @@ export interface Cell { *
*/ formattedValue?: string; + + /** + *+ * A list of formatted values of the cell. This field is only returned when the cell is ROWSET format + * (aka multi-select or multi-record picklist). Values in the list are always represented as strings. + * The formattedValue field will be empty if this field is returned. + *
+ */ + formattedValues?: string[]; } export namespace Cell { @@ -947,6 +984,23 @@ export namespace DescribeTableDataImportJobRequest { }); } +export enum ErrorCode { + AccessDenied = "ACCESS_DENIED", + FileEmptyError = "FILE_EMPTY_ERROR", + FileNotFoundError = "FILE_NOT_FOUND_ERROR", + FileParsingError = "FILE_PARSING_ERROR", + FileSizeLimitError = "FILE_SIZE_LIMIT_ERROR", + InvalidFileTypeError = "INVALID_FILE_TYPE_ERROR", + InvalidImportOptionsError = "INVALID_IMPORT_OPTIONS_ERROR", + InvalidTableColumnIdError = "INVALID_TABLE_COLUMN_ID_ERROR", + InvalidTableIdError = "INVALID_TABLE_ID_ERROR", + InvalidUrlError = "INVALID_URL_ERROR", + ResourceNotFoundError = "RESOURCE_NOT_FOUND_ERROR", + SystemLimitError = "SYSTEM_LIMIT_ERROR", + TableNotFoundError = "TABLE_NOT_FOUND_ERROR", + UnknownError = "UNKNOWN_ERROR", +} + /** ** An object that contains the configuration parameters for the data source of an import request. @@ -967,6 +1021,7 @@ export namespace ImportDataSourceConfig { */ export const filterSensitiveLog = (obj: ImportDataSourceConfig): any => ({ ...obj, + ...(obj.dataSourceUrl && { dataSourceUrl: SENSITIVE_STRING }), }); } @@ -986,6 +1041,7 @@ export namespace ImportDataSource { */ export const filterSensitiveLog = (obj: ImportDataSource): any => ({ ...obj, + ...(obj.dataSourceConfig && { dataSourceConfig: ImportDataSourceConfig.filterSensitiveLog(obj.dataSourceConfig) }), }); } @@ -1108,6 +1164,7 @@ export namespace TableDataImportJobMetadata { export const filterSensitiveLog = (obj: TableDataImportJobMetadata): any => ({ ...obj, ...(obj.submitter && { submitter: ImportJobSubmitter.filterSensitiveLog(obj.submitter) }), + ...(obj.dataSource && { dataSource: ImportDataSource.filterSensitiveLog(obj.dataSource) }), }); } @@ -1139,6 +1196,13 @@ export interface DescribeTableDataImportJobResult { *
*/ jobMetadata: TableDataImportJobMetadata | undefined; + + /** + *+ * If job status is failed, error code to understand reason for the failure. + *
+ */ + errorCode?: ErrorCode | string; } export namespace DescribeTableDataImportJobResult { @@ -1177,7 +1241,7 @@ export interface GetScreenDataRequest { workbookId: string | undefined; /** - *The ID of the app that contains the screem.
+ *The ID of the app that contains the screen.
*/ appId: string | undefined; @@ -1749,6 +1813,38 @@ export namespace ListTablesResult { }); } +export interface ListTagsForResourceRequest { + /** + *The resource's Amazon Resource Name (ARN).
+ */ + resourceArn: string | undefined; +} + +export namespace ListTagsForResourceRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: ListTagsForResourceRequest): any => ({ + ...obj, + }); +} + +export interface ListTagsForResourceResult { + /** + *The resource's tags.
+ */ + tags?: { [key: string]: string }; +} + +export namespace ListTagsForResourceResult { + /** + * @internal + */ + export const filterSensitiveLog = (obj: ListTagsForResourceResult): any => ({ + ...obj, + }); +} + export interface QueryTableRowsRequest { /** *The ID of the workbook whose table rows are being queried.
@@ -1903,6 +1999,7 @@ export namespace StartTableDataImportJobRequest { */ export const filterSensitiveLog = (obj: StartTableDataImportJobRequest): any => ({ ...obj, + ...(obj.dataSource && { dataSource: ImportDataSource.filterSensitiveLog(obj.dataSource) }), }); } @@ -1931,3 +2028,67 @@ export namespace StartTableDataImportJobResult { ...obj, }); } + +export interface TagResourceRequest { + /** + *The resource's Amazon Resource Name (ARN).
+ */ + resourceArn: string | undefined; + + /** + *A list of tags to apply to the resource.
+ */ + tags: { [key: string]: string } | undefined; +} + +export namespace TagResourceRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: TagResourceRequest): any => ({ + ...obj, + }); +} + +export interface TagResourceResult {} + +export namespace TagResourceResult { + /** + * @internal + */ + export const filterSensitiveLog = (obj: TagResourceResult): any => ({ + ...obj, + }); +} + +export interface UntagResourceRequest { + /** + *The resource's Amazon Resource Name (ARN).
+ */ + resourceArn: string | undefined; + + /** + *A list of tag keys to remove from the resource.
+ */ + tagKeys: string[] | undefined; +} + +export namespace UntagResourceRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({ + ...obj, + }); +} + +export interface UntagResourceResult {} + +export namespace UntagResourceResult { + /** + * @internal + */ + export const filterSensitiveLog = (obj: UntagResourceResult): any => ({ + ...obj, + }); +} diff --git a/clients/client-honeycode/src/protocols/Aws_restJson1.ts b/clients/client-honeycode/src/protocols/Aws_restJson1.ts index 550ec76f2c8cd..c1e6b271aa584 100644 --- a/clients/client-honeycode/src/protocols/Aws_restJson1.ts +++ b/clients/client-honeycode/src/protocols/Aws_restJson1.ts @@ -46,11 +46,17 @@ import { import { ListTableColumnsCommandInput, ListTableColumnsCommandOutput } from "../commands/ListTableColumnsCommand"; import { ListTableRowsCommandInput, ListTableRowsCommandOutput } from "../commands/ListTableRowsCommand"; import { ListTablesCommandInput, ListTablesCommandOutput } from "../commands/ListTablesCommand"; +import { + ListTagsForResourceCommandInput, + ListTagsForResourceCommandOutput, +} from "../commands/ListTagsForResourceCommand"; import { QueryTableRowsCommandInput, QueryTableRowsCommandOutput } from "../commands/QueryTableRowsCommand"; import { StartTableDataImportJobCommandInput, StartTableDataImportJobCommandOutput, } from "../commands/StartTableDataImportJobCommand"; +import { TagResourceCommandInput, TagResourceCommandOutput } from "../commands/TagResourceCommand"; +import { UntagResourceCommandInput, UntagResourceCommandOutput } from "../commands/UntagResourceCommand"; import { AccessDeniedException, AutomationExecutionException, @@ -550,6 +556,34 @@ export const serializeAws_restJson1ListTablesCommand = async ( }); }; +export const serializeAws_restJson1ListTagsForResourceCommand = async ( + input: ListTagsForResourceCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const { hostname, protocol = "https", port, path: basePath } = await context.endpoint(); + const headers: any = {}; + let resolvedPath = `${basePath?.endsWith("/") ? basePath.slice(0, -1) : basePath || ""}` + "/tags/{resourceArn}"; + if (input.resourceArn !== undefined) { + const labelValue: string = input.resourceArn; + if (labelValue.length <= 0) { + throw new Error("Empty value provided for input HTTP label: resourceArn."); + } + resolvedPath = resolvedPath.replace("{resourceArn}", __extendedEncodeURIComponent(labelValue)); + } else { + throw new Error("No value provided for input HTTP label: resourceArn."); + } + let body: any; + return new __HttpRequest({ + protocol, + hostname, + port, + method: "GET", + headers, + path: resolvedPath, + body, + }); +}; + export const serializeAws_restJson1QueryTableRowsCommand = async ( input: QueryTableRowsCommandInput, context: __SerdeContext @@ -649,6 +683,72 @@ export const serializeAws_restJson1StartTableDataImportJobCommand = async ( }); }; +export const serializeAws_restJson1TagResourceCommand = async ( + input: TagResourceCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const { hostname, protocol = "https", port, path: basePath } = await context.endpoint(); + const headers: any = { + "content-type": "application/json", + }; + let resolvedPath = `${basePath?.endsWith("/") ? basePath.slice(0, -1) : basePath || ""}` + "/tags/{resourceArn}"; + if (input.resourceArn !== undefined) { + const labelValue: string = input.resourceArn; + if (labelValue.length <= 0) { + throw new Error("Empty value provided for input HTTP label: resourceArn."); + } + resolvedPath = resolvedPath.replace("{resourceArn}", __extendedEncodeURIComponent(labelValue)); + } else { + throw new Error("No value provided for input HTTP label: resourceArn."); + } + let body: any; + body = JSON.stringify({ + ...(input.tags !== undefined && + input.tags !== null && { tags: serializeAws_restJson1TagsMap(input.tags, context) }), + }); + return new __HttpRequest({ + protocol, + hostname, + port, + method: "POST", + headers, + path: resolvedPath, + body, + }); +}; + +export const serializeAws_restJson1UntagResourceCommand = async ( + input: UntagResourceCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const { hostname, protocol = "https", port, path: basePath } = await context.endpoint(); + const headers: any = {}; + let resolvedPath = `${basePath?.endsWith("/") ? basePath.slice(0, -1) : basePath || ""}` + "/tags/{resourceArn}"; + if (input.resourceArn !== undefined) { + const labelValue: string = input.resourceArn; + if (labelValue.length <= 0) { + throw new Error("Empty value provided for input HTTP label: resourceArn."); + } + resolvedPath = resolvedPath.replace("{resourceArn}", __extendedEncodeURIComponent(labelValue)); + } else { + throw new Error("No value provided for input HTTP label: resourceArn."); + } + const query: any = { + ...(input.tagKeys !== undefined && { tagKeys: (input.tagKeys || []).map((_entry) => _entry as any) }), + }; + let body: any; + return new __HttpRequest({ + protocol, + hostname, + port, + method: "DELETE", + headers, + path: resolvedPath, + query, + body, + }); +}; + export const deserializeAws_restJson1BatchCreateTableRowsCommand = async ( output: __HttpResponse, context: __SerdeContext @@ -1110,11 +1210,15 @@ export const deserializeAws_restJson1DescribeTableDataImportJobCommand = async ( } const contents: DescribeTableDataImportJobCommandOutput = { $metadata: deserializeMetadata(output), + errorCode: undefined, jobMetadata: undefined, jobStatus: undefined, message: undefined, }; const data: { [key: string]: any } = __expectNonNull(__expectObject(await parseBody(output.body, context)), "body"); + if (data.errorCode !== undefined && data.errorCode !== null) { + contents.errorCode = __expectString(data.errorCode); + } if (data.jobMetadata !== undefined && data.jobMetadata !== null) { contents.jobMetadata = deserializeAws_restJson1TableDataImportJobMetadata(data.jobMetadata, context); } @@ -1155,6 +1259,14 @@ const deserializeAws_restJson1DescribeTableDataImportJobCommandError = async ( $metadata: deserializeMetadata(output), }; break; + case "RequestTimeoutException": + case "com.amazonaws.honeycode#RequestTimeoutException": + response = { + ...(await deserializeAws_restJson1RequestTimeoutExceptionResponse(parsedOutput, context)), + name: errorCode, + $metadata: deserializeMetadata(output), + }; + break; case "ResourceNotFoundException": case "com.amazonaws.honeycode#ResourceNotFoundException": response = { @@ -1393,6 +1505,14 @@ const deserializeAws_restJson1InvokeScreenAutomationCommandError = async ( $metadata: deserializeMetadata(output), }; break; + case "ServiceQuotaExceededException": + case "com.amazonaws.honeycode#ServiceQuotaExceededException": + response = { + ...(await deserializeAws_restJson1ServiceQuotaExceededExceptionResponse(parsedOutput, context)), + name: errorCode, + $metadata: deserializeMetadata(output), + }; + break; case "ServiceUnavailableException": case "com.amazonaws.honeycode#ServiceUnavailableException": response = { @@ -1775,6 +1895,109 @@ const deserializeAws_restJson1ListTablesCommandError = async ( return Promise.reject(Object.assign(new Error(message), response)); }; +export const deserializeAws_restJson1ListTagsForResourceCommand = async ( + output: __HttpResponse, + context: __SerdeContext +): PromiseAWS IoT Events monitors your equipment or device fleets for failures or changes in operation, and -triggers actions when such events occur. You can use AWS IoT Events Data API commands to send inputs to +
IoT Events monitors your equipment or device fleets for failures or changes in operation, and +triggers actions when such events occur. You can use IoT Events Data API commands to send inputs to detectors, list detectors, and view or update a detector's status.
-For more information, see What is AWS IoT Events? in the -AWS IoT Events Developer Guide.
+For more information, see What is IoT Events? in the +IoT Events Developer Guide.
## Installing diff --git a/clients/client-iot-events-data/src/IoTEventsData.ts b/clients/client-iot-events-data/src/IoTEventsData.ts index 1aec11ae1c9ec..b16a3d704aeb0 100644 --- a/clients/client-iot-events-data/src/IoTEventsData.ts +++ b/clients/client-iot-events-data/src/IoTEventsData.ts @@ -54,11 +54,11 @@ import { import { IoTEventsDataClient } from "./IoTEventsDataClient"; /** - *AWS IoT Events monitors your equipment or device fleets for failures or changes in operation, and - * triggers actions when such events occur. You can use AWS IoT Events Data API commands to send inputs to + *
IoT Events monitors your equipment or device fleets for failures or changes in operation, and + * triggers actions when such events occur. You can use IoT Events Data API commands to send inputs to * detectors, list detectors, and view or update a detector's status.
- *For more information, see What is AWS IoT Events? in the - * AWS IoT Events Developer Guide.
+ *For more information, see What is IoT Events? in the + * IoT Events Developer Guide.
*/ export class IoTEventsData extends IoTEventsDataClient { /** @@ -161,7 +161,7 @@ export class IoTEventsData extends IoTEventsDataClient { } /** - *Sends a set of messages to the AWS IoT Events system. Each message payload is transformed into + *
Sends a set of messages to the IoT Events system. Each message payload is transformed into
* the input you specify ("inputName") and ingested into any detectors that monitor
* that input. If multiple messages are sent, the order in which the messages are processed isn't
* guaranteed. To guarantee ordering, you must send messages one at a time and wait for a
diff --git a/clients/client-iot-events-data/src/IoTEventsDataClient.ts b/clients/client-iot-events-data/src/IoTEventsDataClient.ts
index 424a83f54cd71..bff39be91f13a 100644
--- a/clients/client-iot-events-data/src/IoTEventsDataClient.ts
+++ b/clients/client-iot-events-data/src/IoTEventsDataClient.ts
@@ -249,11 +249,11 @@ type IoTEventsDataClientResolvedConfigType = __SmithyResolvedConfiguration<__Htt
export interface IoTEventsDataClientResolvedConfig extends IoTEventsDataClientResolvedConfigType {}
/**
- *
AWS IoT Events monitors your equipment or device fleets for failures or changes in operation, and - * triggers actions when such events occur. You can use AWS IoT Events Data API commands to send inputs to + *
IoT Events monitors your equipment or device fleets for failures or changes in operation, and + * triggers actions when such events occur. You can use IoT Events Data API commands to send inputs to * detectors, list detectors, and view or update a detector's status.
- *For more information, see What is AWS IoT Events? in the - * AWS IoT Events Developer Guide.
+ *For more information, see What is IoT Events? in the + * IoT Events Developer Guide.
*/ export class IoTEventsDataClient extends __Client< __HttpHandlerOptions, diff --git a/clients/client-iot-events-data/src/commands/BatchPutMessageCommand.ts b/clients/client-iot-events-data/src/commands/BatchPutMessageCommand.ts index b90fdf7b3af37..61e55b2747a77 100644 --- a/clients/client-iot-events-data/src/commands/BatchPutMessageCommand.ts +++ b/clients/client-iot-events-data/src/commands/BatchPutMessageCommand.ts @@ -22,7 +22,7 @@ export interface BatchPutMessageCommandInput extends BatchPutMessageRequest {} export interface BatchPutMessageCommandOutput extends BatchPutMessageResponse, __MetadataBearer {} /** - *Sends a set of messages to the AWS IoT Events system. Each message payload is transformed into + *
Sends a set of messages to the IoT Events system. Each message payload is transformed into
* the input you specify ("inputName") and ingested into any detectors that monitor
* that input. If multiple messages are sent, the order in which the messages are processed isn't
* guaranteed. To guarantee ordering, you must send messages one at a time and wait for a
diff --git a/clients/client-iot-events-data/src/models/models_0.ts b/clients/client-iot-events-data/src/models/models_0.ts
index a522977739b4f..8f351140bff20 100644
--- a/clients/client-iot-events-data/src/models/models_0.ts
+++ b/clients/client-iot-events-data/src/models/models_0.ts
@@ -1330,7 +1330,7 @@ export interface Timer {
name: string | undefined;
/**
- *
The number of seconds which have elapsed on the timer.
+ *The expiration time for the timer.
*/ timestamp: Date | undefined; } diff --git a/clients/client-ivs/src/models/models_0.ts b/clients/client-ivs/src/models/models_0.ts index 9a7e2cc84673c..abffeedaec573 100644 --- a/clients/client-ivs/src/models/models_0.ts +++ b/clients/client-ivs/src/models/models_0.ts @@ -428,6 +428,42 @@ export namespace DestinationConfiguration { }); } +export enum RecordingMode { + Disabled = "DISABLED", + Interval = "INTERVAL", +} + +/** + *An object representing a configuration of thumbnails for recorded video.
+ */ +export interface ThumbnailConfiguration { + /** + *Thumbnail recording mode. Default: INTERVAL.
The targeted thumbnail-generation interval in seconds. This is configurable (and required)
+ * only if recordingMode is INTERVAL. Default: 60.
+ * Important: Setting a value for targetIntervalSeconds does not guarantee that thumbnails
+ * are generated at the specified interval. For thumbnails to be generated at the
+ * targetIntervalSeconds interval, the IDR/Keyframe value for the input video must be less than
+ * the targetIntervalSeconds value. See Amazon IVS Streaming Configuration for information on
+ * setting IDR/Keyframe to the recommended value in video-encoder settings.
Recording-configuration name. The value does not need to be unique.
@@ -444,6 +480,12 @@ export interface CreateRecordingConfigurationRequest { *Array of 1-50 maps, each of the form string:string (key:value).
A complex type that allows you to enable/disable the recording of thumbnails for a live + * session and modify the interval at which thumbnails are generated for the live session.
+ */ + thumbnailConfiguration?: ThumbnailConfiguration; } export namespace CreateRecordingConfigurationRequest { @@ -490,6 +532,12 @@ export interface RecordingConfiguration { *Array of 1-50 maps, each of the form string:string (key:value).
A complex type that allows you to enable/disable the recording of thumbnails for a live + * session and modify the interval at which thumbnails are generated for the live session.
+ */ + thumbnailConfiguration?: ThumbnailConfiguration; } export namespace RecordingConfiguration { @@ -1709,7 +1757,7 @@ export namespace StreamSessionSummary { export interface ListStreamSessionsResponse { /** - * + *List of stream sessions.
*/ streamSessions: StreamSessionSummary[] | undefined; diff --git a/clients/client-ivs/src/protocols/Aws_restJson1.ts b/clients/client-ivs/src/protocols/Aws_restJson1.ts index 33b966dfde7d4..316e86dd965e1 100644 --- a/clients/client-ivs/src/protocols/Aws_restJson1.ts +++ b/clients/client-ivs/src/protocols/Aws_restJson1.ts @@ -97,6 +97,7 @@ import { StreamSummary, StreamUnavailable, ThrottlingException, + ThumbnailConfiguration, ValidationException, VideoConfiguration, } from "../models/models_0"; @@ -202,6 +203,10 @@ export const serializeAws_restJson1CreateRecordingConfigurationCommand = async ( }), ...(input.name !== undefined && input.name !== null && { name: input.name }), ...(input.tags !== undefined && input.tags !== null && { tags: serializeAws_restJson1Tags(input.tags, context) }), + ...(input.thumbnailConfiguration !== undefined && + input.thumbnailConfiguration !== null && { + thumbnailConfiguration: serializeAws_restJson1ThumbnailConfiguration(input.thumbnailConfiguration, context), + }), }); return new __HttpRequest({ protocol, @@ -2404,6 +2409,14 @@ const deserializeAws_restJson1ListStreamsCommandError = async ( $metadata: deserializeMetadata(output), }; break; + case "ValidationException": + case "com.amazonaws.ivs#ValidationException": + response = { + ...(await deserializeAws_restJson1ValidationExceptionResponse(parsedOutput, context)), + name: errorCode, + $metadata: deserializeMetadata(output), + }; + break; default: const parsedBody = parsedOutput.body; errorCode = parsedBody.code || parsedBody.Code || errorCode; @@ -3183,6 +3196,14 @@ const serializeAws_restJson1Tags = (input: { [key: string]: string }, context: _ }, {}); }; +const serializeAws_restJson1ThumbnailConfiguration = (input: ThumbnailConfiguration, context: __SerdeContext): any => { + return { + ...(input.recordingMode !== undefined && input.recordingMode !== null && { recordingMode: input.recordingMode }), + ...(input.targetIntervalSeconds !== undefined && + input.targetIntervalSeconds !== null && { targetIntervalSeconds: input.targetIntervalSeconds }), + }; +}; + const deserializeAws_restJson1AudioConfiguration = (output: any, context: __SerdeContext): AudioConfiguration => { return { channels: __expectLong(output.channels), @@ -3345,6 +3366,10 @@ const deserializeAws_restJson1RecordingConfiguration = ( output.tags !== undefined && output.tags !== null ? deserializeAws_restJson1Tags(output.tags, context) : undefined, + thumbnailConfiguration: + output.thumbnailConfiguration !== undefined && output.thumbnailConfiguration !== null + ? deserializeAws_restJson1ThumbnailConfiguration(output.thumbnailConfiguration, context) + : undefined, } as any; }; @@ -3565,6 +3590,16 @@ const deserializeAws_restJson1Tags = (output: any, context: __SerdeContext): { [ }, {}); }; +const deserializeAws_restJson1ThumbnailConfiguration = ( + output: any, + context: __SerdeContext +): ThumbnailConfiguration => { + return { + recordingMode: __expectString(output.recordingMode), + targetIntervalSeconds: __expectLong(output.targetIntervalSeconds), + } as any; +}; + const deserializeAws_restJson1VideoConfiguration = (output: any, context: __SerdeContext): VideoConfiguration => { return { avcLevel: __expectString(output.avcLevel), diff --git a/clients/client-kendra/src/Kendra.ts b/clients/client-kendra/src/Kendra.ts index 1be69d8990e8c..5574a514949a6 100644 --- a/clients/client-kendra/src/Kendra.ts +++ b/clients/client-kendra/src/Kendra.ts @@ -551,6 +551,7 @@ export class Kendra extends KendraClient { /** *Creates an new set of frequently asked question (FAQ) questions and answers.
+ *Adding FAQs to an index is an asynchronous operation.
*/ public createFaq(args: CreateFaqCommandInput, options?: __HttpHandlerOptions): PromiseCreates an new set of frequently asked question (FAQ) questions and answers.
+ *Adding FAQs to an index is an asynchronous operation.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-kendra/src/models/models_0.ts b/clients/client-kendra/src/models/models_0.ts index 78368c580d839..b1aea373bdeb3 100644 --- a/clients/client-kendra/src/models/models_0.ts +++ b/clients/client-kendra/src/models/models_0.ts @@ -434,7 +434,7 @@ export interface DocumentAttributeValue { *A date expressed as an ISO 8601 string.
*It is important for the time zone to be included * in the ISO 8601 date-time format. For example, - * 20120325T123010+01:00 is the ISO 8601 date-time format + * 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format * for March 25th 2012 at 12:30PM (plus 10 seconds) in * Central European Time.
*/ @@ -451,7 +451,10 @@ export namespace DocumentAttributeValue { } /** - *A custom attribute value assigned to a document.
+ *A custom attribute value assigned to a document.
+ *For more information on how to create custom document attributes, see + * Custom + * Attributes.
*/ export interface DocumentAttribute { /** @@ -996,10 +999,10 @@ export namespace InlineCustomDocumentEnrichmentConfiguration { *Provides the configuration information for invoking a Lambda function in * Lambda to alter document metadata and content when ingesting * documents into Amazon Kendra. You can configure your Lambda function using - * PreExtractionHookConfiguration + * PreExtractionHookConfiguration * if you want to apply advanced alterations on the original or raw documents. * If you want to apply advanced alterations on the Amazon Kendra structured documents, - * you must configure your Lambda function using PostExtractionHookConfiguration. + * you must configure your Lambda function using PostExtractionHookConfiguration. * You can only invoke one Lambda function. However, this function can invoke other * functions it requires.
*For more information, see Customizing document metadata @@ -3936,6 +3939,10 @@ export enum UserGroupResolutionMode { * permissions to use Amazon Web Services SSO with Amazon Kendra. For more information, see * IAM roles for * Amazon Web Services SSO.
+ *Amazon Kendra currently does not support using UserGroupResolutionConfiguration
+ * with an Amazon Web Services organization member account for your Amazon Web Services SSO
+ * identify source. You must create your index in the parent account for the organization
+ * in order to use UserGroupResolutionConfiguration.
The warning code and message that explains a problem with a query.
+ */ +export interface Warning { + /** + *The message that explains the problem with the query.
+ */ + Message?: string; + + /** + *The code used to show the type of warning for the query.
+ */ + Code?: WarningCode | string; +} + +export namespace Warning { + /** + * @internal + */ + export const filterSensitiveLog = (obj: Warning): any => ({ + ...obj, + }); +} + export interface QueryResult { /** *The unique identifier for the search. You use QueryId
@@ -7929,6 +7964,15 @@ export interface QueryResult {
* you can only retrieve the first 100 of the items.
A list of warning codes and their messages on problems with your query.
+ *Amazon Kendra currently only supports one type of warning, which is a warning + * on invalid syntax used in the query. For examples of invalid query syntax, + * see Searching + * with advanced query syntax.
+ */ + Warnings?: Warning[]; } export namespace QueryResult { @@ -8628,7 +8672,7 @@ export interface QueryRequest { /** *The text to search for.
*/ - QueryText: string | undefined; + QueryText?: string; /** *Enables filtered searches based on document attributes. You can only
diff --git a/clients/client-kendra/src/pagination/GetSnapshotsPaginator.ts b/clients/client-kendra/src/pagination/GetSnapshotsPaginator.ts
new file mode 100644
index 0000000000000..dae03f2d12195
--- /dev/null
+++ b/clients/client-kendra/src/pagination/GetSnapshotsPaginator.ts
@@ -0,0 +1,59 @@
+import { Paginator } from "@aws-sdk/types";
+
+import {
+ GetSnapshotsCommand,
+ GetSnapshotsCommandInput,
+ GetSnapshotsCommandOutput,
+} from "../commands/GetSnapshotsCommand";
+import { Kendra } from "../Kendra";
+import { KendraClient } from "../KendraClient";
+import { KendraPaginationConfiguration } from "./Interfaces";
+
+/**
+ * @private
+ */
+const makePagedClientRequest = async (
+ client: KendraClient,
+ input: GetSnapshotsCommandInput,
+ ...args: any
+): Promise Removes a custom vocabulary from the specified locale
+ * in the specified bot. Removes a previous export and the associated files stored in an S3
* bucket. Provides metadata information about a custom vocabulary. Gets information about a specific export. Lists the exports for a bot or bot locale. Exports are kept in the
- * list for 7 days. Lists the exports for a bot, bot locale, or custom vocabulary.
+ * Exports are kept in the list for 7 days. Lists the imports for a bot or bot locale. Imports are kept in the
- * list for 7 days. Lists the imports for a bot, bot locale, or custom vocabulary.
+ * Imports are kept in the list for 7 days. Starts importing a bot or bot locale from a zip archive that you
- * uploaded to an S3 bucket. Starts importing a bot, bot locale, or custom vocabulary from a zip
+ * archive that you uploaded to an S3 bucket. Removes a custom vocabulary from the specified locale
+ * in the specified bot. Provides metadata information about a custom vocabulary. Lists the exports for a bot or bot locale. Exports are kept in the
- * list for 7 days. Lists the exports for a bot, bot locale, or custom vocabulary.
+ * Exports are kept in the list for 7 days. Lists the imports for a bot or bot locale. Imports are kept in the
- * list for 7 days. Lists the imports for a bot, bot locale, or custom vocabulary.
+ * Imports are kept in the list for 7 days. Starts importing a bot or bot locale from a zip archive that you
- * uploaded to an S3 bucket. Starts importing a bot, bot locale, or custom vocabulary from a zip
+ * archive that you uploaded to an S3 bucket. Provides settings that enable advanced recognition settings for slot values. Enables using the slot values as a custom vocabulary for recognizing user utterances. Provides the parameters required for exporting a custom vocabulary. The identifier of the bot that contains the custom vocabulary to export. The version of the bot that contains the custom vocabulary to export. The locale of the bot that contains the custom vocabulary to export. Parameters for exporting a bot locale. The parameters required to export a custom vocabulary. A regular expression used to validate the value of a slot. Provides settings that enable advanced recognition settings for slot
+ * values. Provides the parameters required for importing a custom vocabulary. The identifier of the bot to import the custom vocabulary to. The version of the bot to import the custom vocabulary to. The identifier of the local to import the custom vocabulary to. The value must
+ * be The object used for specifying the data range that the customer
* wants Amazon Lex to read through in the input transcripts. The unique identifier of the bot to remove the custom
+ * vocabulary from. The version of the bot to remove the custom vocabulary
+ * from. The locale identifier for the locale that contains the
+ * custom vocabulary to remove. The identifier of the bot that the custom vocabulary
+ * was removed from. The version of the bot that the custom vocabulary
+ * was removed from. The locale identifier for the locale that the
+ * custom vocabulary was removed from. The status of removing the custom vocabulary. The unique identifier of the export to delete. The unique identifier of the bot that contains the custom vocabulary. The bot version of the bot to return metadata for. The locale to return the custom vocabulary information for.
+ * The locale must be The identifier of the bot that contains the custom vocabulary. The version of the bot that contains the custom vocabulary to describe. The locale that contains the custom vocabulary to describe. The status of the custom vocabulary. If the status is
+ * The date and time that the custom vocabulary was created. The date and time that the custom vocabulary was last updated. The unique identifier of the export to describe. The file format used in the files that describe the bot or bot
- * locale. The file format used in the files that describe the resource.
+ * Parameters for importing a bot locale. Provides the parameters required for importing a custom vocabulary. The specifications of the imported bot or bot locale. The specifications of the imported bot, bot locale, or custom
+ * vocabulary. The values to use to filter the response. The values to use to filter the response. The values must be
+ * The values to use to filter the response. The values to use to filter the response. The values must be
+ * The date and time that the import was last updated. The type of resource that was imported. If the response from the en_GB.en_GB.Ready the custom vocabulary is ready to use.Bot, BotLocale, or
+ * CustomVocabulary.Bot, BotLocale, or
+ * CustomVocabulary.ListBots operation contains
* more results than specified in the maxResults parameter, a
- * token is returned in the response. Use that token in the
- * nextToken parameter to return the next page of
- * results.
Use the returned token in the nextToken parameter of a
+ * ListBots request to return the next page of results.
+ * For a complete set of results, call the ListBots operation
+ * until the nextToken returned in the response is
+ * null.
If the response from the ListExports operation contains
* more results that specified in the maxResults parameter, a
- * token is returned in the response. Use that token in the
- * nextToken parameter to return the next page of
- * results.
Use the returned token in the nextToken parameter of a
+ * ListExports request to return the next page of results.
+ * For a complete set of results, call the ListExports
+ * operation until the nextToken returned in the response is
+ * null.
Specifies the resources that should be exported. If you
+ * don't specify a resource type in the filters parameter,
+ * both bot locales and custom vocabularies are exported.
The locale specified in the request.
+ */ + localeId?: string; } export namespace ListExportsResponse { @@ -7224,11 +7497,21 @@ export interface ListImportsRequest { /** *If the response from the ListImports operation contains
* more results than specified in the maxResults parameter, a
- * token is returned in the response. Use that token in the
- * nextToken parameter to return the next page of
- * results.
Use the returned token in the nextToken parameter of a
+ * ListImports request to return the next page of results.
+ * For a complete set of results, call the ListImports
+ * operation until the nextToken returned in the response is
+ * null.
Specifies the locale that should be present in the list. If you
+ * don't specify a resource type in the filters parameter,
+ * the list contains both bot locales and custom vocabularies.
The locale specified in the request.
+ */ + localeId?: string; } export namespace ListImportsResponse { @@ -7323,9 +7611,12 @@ export interface ListIntentsRequest { /** *If the response from the ListIntents operation contains
* more results than specified in the maxResults parameter, a
- * token is returned in the response. Use that token in the
- * nextToken parameter to return the next page of
- * results.
Use the returned token in the nextToken parameter of a
+ * ListIntents request to return the next page of results.
+ * For a complete set of results, call the ListIntents
+ * operation until the nextToken returned in the response is
+ * null.
Parameters for creating the bot or bot locale.
+ *Parameters for creating the bot, bot locale or custom + * vocabulary.
*/ resourceSpecification: ImportResourceSpecification | undefined; @@ -8292,8 +8584,8 @@ export interface StartImportRequest { mergeStrategy: MergeStrategy | string | undefined; /** - *The password used to encrypt the zip archive that contains the bot - * or bot locale definition. You should always encrypt the zip archive to + *
The password used to encrypt the zip archive that contains the + * resource definition. You should always encrypt the zip archive to * protect it during transit between your site and Amazon Lex.
*/ filePassword?: string; @@ -8316,7 +8608,7 @@ export interface StartImportResponse { importId?: string; /** - *The parameters used when importing the bot or bot locale.
+ *The parameters used when importing the resource.
*/ resourceSpecification?: ImportResourceSpecification; @@ -8330,7 +8622,8 @@ export interface StartImportResponse { /** *The current status of the import. When the status is
- * Complete the bot or bot alias is ready to use.
Complete the bot, bot alias, or custom vocabulary is
+ * ready to use.
*/
importStatus?: ImportStatus | string;
@@ -8932,7 +9225,9 @@ export interface UpdateExportResponse {
resourceSpecification?: ExportResourceSpecification;
/**
- * The file format used for the files that define the resource.
+ *The file format used for the files that define the resource. The
+ * TSV format is required to export a custom vocabulary
+ * only; otherwise use LexJson format.
Provides the phrase that Amazon Lex V2 should look for in the user's input + * to the bot.
+ */ +export interface RuntimeHintValue { + /** + *The phrase that Amazon Lex V2 should look for in the user's input to the + * bot.
+ */ + phrase: string | undefined; +} + +export namespace RuntimeHintValue { + /** + * @internal + */ + export const filterSensitiveLog = (obj: RuntimeHintValue): any => ({ + ...obj, + }); +} + +/** + *Provides an array of phrases that should be given preference when + * resolving values for a slot.
+ */ +export interface RuntimeHintDetails { + /** + *One or more strings that Amazon Lex V2 should look for in the input to the + * bot. Each phrase is given preference when deciding on slot + * values.
+ */ + runtimeHintValues: RuntimeHintValue[] | undefined; +} + +export namespace RuntimeHintDetails { + /** + * @internal + */ + export const filterSensitiveLog = (obj: RuntimeHintDetails): any => ({ + ...obj, + }); +} + +/** + *You can provide Amazon Lex V2 with hints to the phrases that a customer is + * likely to use for a slot. When a slot with hints is resolved, the + * phrases in the runtime hints are preferred in the resolution. You can + * provide hints for a maximum of 100 intents. You can provide a maximum + * of 100 slots.
+ *Before you can use runtime hints with an existing bot, you must + * first rebuild the bot.
+ *For more information, see Using hints to improve + * accuracy.
+ */ +export interface RuntimeHints { + /** + *A list of the slots in the intent that should have runtime hints + * added, and the phrases that should be added for each slot.
+ *The first level of the slotHints map is the name of the
+ * intent. The second level is the name of the slot within the intent. For
+ * more information, see Using hints to improve
+ * accuracy.
The intent name and slot name must exist.
+ */ + slotHints?: { [key: string]: { [key: string]: RuntimeHintDetails } }; +} + +export namespace RuntimeHints { + /** + * @internal + */ + export const filterSensitiveLog = (obj: RuntimeHints): any => ({ + ...obj, + }); +} + /** * */ @@ -1365,9 +1441,16 @@ export interface SessionState { sessionAttributes?: { [key: string]: string }; /** - * + *A unique identifier for a specific request.
*/ originatingRequestId?: string; + + /** + *Hints for phrases that a customer is likely to use + * for a slot. Amazon Lex V2 uses the hints to help determine the correct + * value of a slot.
+ */ + runtimeHints?: RuntimeHints; } export namespace SessionState { diff --git a/clients/client-lex-runtime-v2/src/protocols/Aws_restJson1.ts b/clients/client-lex-runtime-v2/src/protocols/Aws_restJson1.ts index 3212c4c9af339..cb9e5644bb733 100644 --- a/clients/client-lex-runtime-v2/src/protocols/Aws_restJson1.ts +++ b/clients/client-lex-runtime-v2/src/protocols/Aws_restJson1.ts @@ -48,6 +48,9 @@ import { PlaybackCompletionEvent, PlaybackInterruptionEvent, ResourceNotFoundException, + RuntimeHintDetails, + RuntimeHints, + RuntimeHintValue, SentimentResponse, SentimentScore, SessionState, @@ -1805,6 +1808,39 @@ const serializeAws_restJson1PlaybackCompletionEvent = ( }; }; +const serializeAws_restJson1RuntimeHintDetails = (input: RuntimeHintDetails, context: __SerdeContext): any => { + return { + ...(input.runtimeHintValues !== undefined && + input.runtimeHintValues !== null && { + runtimeHintValues: serializeAws_restJson1RuntimeHintValuesList(input.runtimeHintValues, context), + }), + }; +}; + +const serializeAws_restJson1RuntimeHints = (input: RuntimeHints, context: __SerdeContext): any => { + return { + ...(input.slotHints !== undefined && + input.slotHints !== null && { slotHints: serializeAws_restJson1SlotHintsIntentMap(input.slotHints, context) }), + }; +}; + +const serializeAws_restJson1RuntimeHintValue = (input: RuntimeHintValue, context: __SerdeContext): any => { + return { + ...(input.phrase !== undefined && input.phrase !== null && { phrase: input.phrase }), + }; +}; + +const serializeAws_restJson1RuntimeHintValuesList = (input: RuntimeHintValue[], context: __SerdeContext): any => { + return input + .filter((e: any) => e != null) + .map((entry) => { + if (entry === null) { + return null as any; + } + return serializeAws_restJson1RuntimeHintValue(entry, context); + }); +}; + const serializeAws_restJson1SessionState = (input: SessionState, context: __SerdeContext): any => { return { ...(input.activeContexts !== undefined && @@ -1817,6 +1853,8 @@ const serializeAws_restJson1SessionState = (input: SessionState, context: __Serd input.intent !== null && { intent: serializeAws_restJson1Intent(input.intent, context) }), ...(input.originatingRequestId !== undefined && input.originatingRequestId !== null && { originatingRequestId: input.originatingRequestId }), + ...(input.runtimeHints !== undefined && + input.runtimeHints !== null && { runtimeHints: serializeAws_restJson1RuntimeHints(input.runtimeHints, context) }), ...(input.sessionAttributes !== undefined && input.sessionAttributes !== null && { sessionAttributes: serializeAws_restJson1StringMap(input.sessionAttributes, context), @@ -1834,6 +1872,36 @@ const serializeAws_restJson1Slot = (input: Slot, context: __SerdeContext): any = }; }; +const serializeAws_restJson1SlotHintsIntentMap = ( + input: { [key: string]: { [key: string]: RuntimeHintDetails } }, + context: __SerdeContext +): any => { + return Object.entries(input).reduce((acc: { [key: string]: any }, [key, value]: [string, any]) => { + if (value === null) { + return acc; + } + return { + ...acc, + [key]: serializeAws_restJson1SlotHintsSlotMap(value, context), + }; + }, {}); +}; + +const serializeAws_restJson1SlotHintsSlotMap = ( + input: { [key: string]: RuntimeHintDetails }, + context: __SerdeContext +): any => { + return Object.entries(input).reduce((acc: { [key: string]: any }, [key, value]: [string, any]) => { + if (value === null) { + return acc; + } + return { + ...acc, + [key]: serializeAws_restJson1RuntimeHintDetails(value, context), + }; + }, {}); +}; + const serializeAws_restJson1Slots = (input: { [key: string]: Slot }, context: __SerdeContext): any => { return Object.entries(input).reduce((acc: { [key: string]: any }, [key, value]: [string, any]) => { if (value === null) { @@ -2167,6 +2235,41 @@ const deserializeAws_restJson1ResourceNotFoundException = ( } as any; }; +const deserializeAws_restJson1RuntimeHintDetails = (output: any, context: __SerdeContext): RuntimeHintDetails => { + return { + runtimeHintValues: + output.runtimeHintValues !== undefined && output.runtimeHintValues !== null + ? deserializeAws_restJson1RuntimeHintValuesList(output.runtimeHintValues, context) + : undefined, + } as any; +}; + +const deserializeAws_restJson1RuntimeHints = (output: any, context: __SerdeContext): RuntimeHints => { + return { + slotHints: + output.slotHints !== undefined && output.slotHints !== null + ? deserializeAws_restJson1SlotHintsIntentMap(output.slotHints, context) + : undefined, + } as any; +}; + +const deserializeAws_restJson1RuntimeHintValue = (output: any, context: __SerdeContext): RuntimeHintValue => { + return { + phrase: __expectString(output.phrase), + } as any; +}; + +const deserializeAws_restJson1RuntimeHintValuesList = (output: any, context: __SerdeContext): RuntimeHintValue[] => { + return (output || []) + .filter((e: any) => e != null) + .map((entry: any) => { + if (entry === null) { + return null as any; + } + return deserializeAws_restJson1RuntimeHintValue(entry, context); + }); +}; + const deserializeAws_restJson1SentimentResponse = (output: any, context: __SerdeContext): SentimentResponse => { return { sentiment: __expectString(output.sentiment), @@ -2201,6 +2304,10 @@ const deserializeAws_restJson1SessionState = (output: any, context: __SerdeConte ? deserializeAws_restJson1Intent(output.intent, context) : undefined, originatingRequestId: __expectString(output.originatingRequestId), + runtimeHints: + output.runtimeHints !== undefined && output.runtimeHints !== null + ? deserializeAws_restJson1RuntimeHints(output.runtimeHints, context) + : undefined, sessionAttributes: output.sessionAttributes !== undefined && output.sessionAttributes !== null ? deserializeAws_restJson1StringMap(output.sessionAttributes, context) @@ -2222,6 +2329,39 @@ const deserializeAws_restJson1Slot = (output: any, context: __SerdeContext): Slo } as any; }; +const deserializeAws_restJson1SlotHintsIntentMap = ( + output: any, + context: __SerdeContext +): { [key: string]: { [key: string]: RuntimeHintDetails } } => { + return Object.entries(output).reduce( + (acc: { [key: string]: { [key: string]: RuntimeHintDetails } }, [key, value]: [string, any]) => { + if (value === null) { + return acc; + } + return { + ...acc, + [key]: deserializeAws_restJson1SlotHintsSlotMap(value, context), + }; + }, + {} + ); +}; + +const deserializeAws_restJson1SlotHintsSlotMap = ( + output: any, + context: __SerdeContext +): { [key: string]: RuntimeHintDetails } => { + return Object.entries(output).reduce((acc: { [key: string]: RuntimeHintDetails }, [key, value]: [string, any]) => { + if (value === null) { + return acc; + } + return { + ...acc, + [key]: deserializeAws_restJson1RuntimeHintDetails(value, context), + }; + }, {}); +}; + const deserializeAws_restJson1Slots = (output: any, context: __SerdeContext): { [key: string]: Slot } => { return Object.entries(output).reduce((acc: { [key: string]: Slot }, [key, value]: [string, any]) => { if (value === null) { diff --git a/clients/client-location/src/Location.ts b/clients/client-location/src/Location.ts index 0bac9ab98db2d..81b50a30041d6 100644 --- a/clients/client-location/src/Location.ts +++ b/clients/client-location/src/Location.ts @@ -40,6 +40,11 @@ import { CalculateRouteCommandInput, CalculateRouteCommandOutput, } from "./commands/CalculateRouteCommand"; +import { + CalculateRouteMatrixCommand, + CalculateRouteMatrixCommandInput, + CalculateRouteMatrixCommandOutput, +} from "./commands/CalculateRouteMatrixCommand"; import { CreateGeofenceCollectionCommand, CreateGeofenceCollectionCommandInput, @@ -504,7 +509,7 @@ export class Location extends LocationClient { /** *
* Calculates a route given the following required parameters:
- * DeparturePostiton and DestinationPosition. Requires that
+ * DeparturePosition and DestinationPosition. Requires that
* you first create a
* route calculator resource.
By default, a request that doesn't specify a departure time uses the best time of day @@ -513,25 +518,23 @@ export class Location extends LocationClient { *
- * Specifying a departure time using either DepartureTime or
- * DepartureNow. This calculates a route based on predictive
- * traffic data at the given time.
DepartureTime
+ * or DepartNow. This calculates a route based on predictive traffic
+ * data at the given time.
* You can't specify both DepartureTime and
- * DepartureNow in a single request. Specifying both
- * parameters returns a validation error.
DepartNow in a single request. Specifying both parameters
+ * returns a validation error.
*
- * Specifying a travel mode using TravelMode. This lets you specify an
- * additional route preference such as CarModeOptions if traveling by
- * Car, or TruckModeOptions if traveling by
- * Truck.
CarModeOptions if traveling by Car, or
+ * TruckModeOptions if traveling by Truck.
* - *
*/ public calculateRoute( args: CalculateRouteCommandInput, @@ -562,6 +565,77 @@ export class Location extends LocationClient { } } + /** + *
+ * Calculates a
+ * route matrix given the following required parameters:
+ * DeparturePositions and DestinationPositions.
+ * CalculateRouteMatrix calculates routes and returns the travel time and
+ * travel distance from each departure position to each destination position in the
+ * request. For example, given departure positions A and B, and destination positions
+ * X and Y, CalculateRouteMatrix will return time and distance for routes
+ * from A to X, A to Y, B to X, and B to Y (in that order). The number of results returned
+ * (and routes calculated) will be the number of DeparturePositions
+ * times the number of DestinationPositions.
Your account is charged for each route calculated, not the number of requests.
+ *Requires that you first create a + * route calculator resource.
+ *By default, a request that doesn't specify a departure time uses the best time of day + * to travel with the best traffic conditions when calculating routes.
+ *Additional options include:
+ *
+ *
+ * Specifying a departure time using either DepartureTime
+ * or DepartNow. This calculates routes based on predictive traffic
+ * data at the given time.
You can't specify both DepartureTime and
+ * DepartNow in a single request. Specifying both parameters
+ * returns a validation error.
+ * Specifying a travel mode using TravelMode sets the transportation
+ * mode used to calculate the routes. This also lets you specify additional route
+ * preferences in CarModeOptions if traveling by Car, or
+ * TruckModeOptions if traveling by Truck.
Creates a geofence collection, which manages and stores geofences.
*/ @@ -597,6 +671,12 @@ export class Location extends LocationClient { /** *Creates a map resource in your AWS account, which provides map tiles of different * styles sourced from global location data providers.
+ *If your application is tracking or routing assets you use in your business, such + * as delivery vehicles or employees, you may only use HERE as your geolocation + * provider. See section 82 of the AWS + * service terms for more details.
+ *SearchPlaceIndexForText operation,
* and reverse geocode coordinates by using the SearchPlaceIndexForPosition operation, and
* enable autosuggestions by using the SearchPlaceIndexForSuggestions operation.
+ * If your application is tracking or routing assets you use in your business, such + * as delivery vehicles or employees, you may only use HERE as your geolocation + * provider. See section 82 of the AWS + * service terms for more details.
+ *You can send requests to a route calculator resource to estimate travel time, * distance, and get directions. A route calculator sources traffic and road network data * from your chosen data provider.
+ *If your application is tracking or routing assets you use in your business, such + * as delivery vehicles or employees, you may only use HERE as your geolocation + * provider. See section 82 of the AWS + * service terms for more details.
+ *
* Calculates a route given the following required parameters:
- * DeparturePostiton and DestinationPosition. Requires that
+ * DeparturePosition and DestinationPosition. Requires that
* you first create a
* route calculator resource.
By default, a request that doesn't specify a departure time uses the best time of day @@ -33,25 +33,23 @@ export interface CalculateRouteCommandOutput extends CalculateRouteResponse, __M *
- * Specifying a departure time using either DepartureTime or
- * DepartureNow. This calculates a route based on predictive
- * traffic data at the given time.
DepartureTime
+ * or DepartNow. This calculates a route based on predictive traffic
+ * data at the given time.
* You can't specify both DepartureTime and
- * DepartureNow in a single request. Specifying both
- * parameters returns a validation error.
DepartNow in a single request. Specifying both parameters
+ * returns a validation error.
*
- * Specifying a travel mode using TravelMode. This lets you specify an
- * additional route preference such as CarModeOptions if traveling by
- * Car, or TruckModeOptions if traveling by
- * Truck.
CarModeOptions if traveling by Car, or
+ * TruckModeOptions if traveling by Truck.
* - *
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-location/src/commands/CalculateRouteMatrixCommand.ts b/clients/client-location/src/commands/CalculateRouteMatrixCommand.ts new file mode 100644 index 0000000000000..8350ee6ed8573 --- /dev/null +++ b/clients/client-location/src/commands/CalculateRouteMatrixCommand.ts @@ -0,0 +1,134 @@ +import { getSerdePlugin } from "@aws-sdk/middleware-serde"; +import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@aws-sdk/protocol-http"; +import { Command as $Command } from "@aws-sdk/smithy-client"; +import { + FinalizeHandlerArguments, + Handler, + HandlerExecutionContext, + HttpHandlerOptions as __HttpHandlerOptions, + MetadataBearer as __MetadataBearer, + MiddlewareStack, + SerdeContext as __SerdeContext, +} from "@aws-sdk/types"; + +import { LocationClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../LocationClient"; +import { CalculateRouteMatrixRequest, CalculateRouteMatrixResponse } from "../models/models_0"; +import { + deserializeAws_restJson1CalculateRouteMatrixCommand, + serializeAws_restJson1CalculateRouteMatrixCommand, +} from "../protocols/Aws_restJson1"; + +export interface CalculateRouteMatrixCommandInput extends CalculateRouteMatrixRequest {} +export interface CalculateRouteMatrixCommandOutput extends CalculateRouteMatrixResponse, __MetadataBearer {} + +/** + *
+ * Calculates a
+ * route matrix given the following required parameters:
+ * DeparturePositions and DestinationPositions.
+ * CalculateRouteMatrix calculates routes and returns the travel time and
+ * travel distance from each departure position to each destination position in the
+ * request. For example, given departure positions A and B, and destination positions
+ * X and Y, CalculateRouteMatrix will return time and distance for routes
+ * from A to X, A to Y, B to X, and B to Y (in that order). The number of results returned
+ * (and routes calculated) will be the number of DeparturePositions
+ * times the number of DestinationPositions.
Your account is charged for each route calculated, not the number of requests.
+ *Requires that you first create a + * route calculator resource.
+ *By default, a request that doesn't specify a departure time uses the best time of day + * to travel with the best traffic conditions when calculating routes.
+ *Additional options include:
+ *
+ *
+ * Specifying a departure time using either DepartureTime
+ * or DepartNow. This calculates routes based on predictive traffic
+ * data at the given time.
You can't specify both DepartureTime and
+ * DepartNow in a single request. Specifying both parameters
+ * returns a validation error.
+ * Specifying a travel mode using TravelMode sets the transportation
+ * mode used to calculate the routes. This also lets you specify additional route
+ * preferences in CarModeOptions if traveling by Car, or
+ * TruckModeOptions if traveling by Truck.
Creates a map resource in your AWS account, which provides map tiles of different * styles sourced from global location data providers.
+ *If your application is tracking or routing assets you use in your business, such + * as delivery vehicles or employees, you may only use HERE as your geolocation + * provider. See section 82 of the AWS + * service terms for more details.
+ *SearchPlaceIndexForText operation,
* and reverse geocode coordinates by using the SearchPlaceIndexForPosition operation, and
* enable autosuggestions by using the SearchPlaceIndexForSuggestions operation.
+ * If your application is tracking or routing assets you use in your business, such + * as delivery vehicles or employees, you may only use HERE as your geolocation + * provider. See section 82 of the AWS + * service terms for more details.
+ *You can send requests to a route calculator resource to estimate travel time, * distance, and get directions. A route calculator sources traffic and road network data * from your chosen data provider.
+ *If your application is tracking or routing assets you use in your business, such + * as delivery vehicles or employees, you may only use HERE as your geolocation + * provider. See section 82 of the AWS + * service terms for more details.
+ *If you specify a departure that's not located on a road, Amazon Location moves the
+ * If you specify a departure that's not located on a road, Amazon Location moves the
* position to the nearest road. If Esri is the provider for your route calculator,
* specifying a route that is longer than 400 km returns a 400 RoutesValidationException error.
If you specify a destination that's not located on a road, Amazon Location moves the position to the nearest road.
+ *If you specify a destination that's not located on a road, Amazon Location moves the position to the nearest road.
*Valid Values: [-180 to 180,-90 to 90]
*
If you specify a waypoint position that's not located on a road, Amazon Location moves the position to the nearest road.
+ *If you specify a waypoint position that's not located on a road, Amazon Location moves the position to the nearest road.
*Specifying more than 23 waypoints returns a 400 ValidationException
* error.
If Esri is the provider for your route calculator, specifying a @@ -1055,7 +1055,8 @@ export interface CalculateRouteRequest { /** *
Specifies the mode of transport when calculating a route. Used in estimating the speed * of travel and road compatibility.
- *The TravelMode you specify determines how you specify route preferences:
The TravelMode you specify also determines how you specify route
+ * preferences:
If traveling by Car use the CarModeOptions
@@ -1232,7 +1233,7 @@ export namespace Step {
* number of legs returned corresponds to one fewer than the total number of positions in
* the request.
For example, a route with a departure position and destination position returns one - * leg with the positions snapped to a nearby road:
+ * leg with the positions snapped to a nearby road: *The StartPosition is the departure position.
The starting position of the leg. Follows the format
* [longitude,latitude].
If the StartPosition isn't located on a road, it's snapped to a nearby road.
If the StartPosition isn't located on a road, it's snapped to a nearby road.
The terminating position of the leg. Follows the format
* [longitude,latitude].
If the EndPosition isn't located on a road, it's snapped to a nearby road.
If the EndPosition isn't located on a road, it's snapped to a nearby road.
For example, a route with a departure position and destination position returns one - * leg with the positions snapped to a nearby road:
+ * leg with the positions snapped to a nearby road: *The StartPosition is the departure position.
The name of the route calculator resource that you want to use to calculate the route matrix.
+ */ + CalculatorName: string | undefined; + + /** + *The list of departure (origin) positions for the route matrix. An array of points,
+ * each of which is itself a 2-value array defined in WGS 84 format:
+ * [longitude, latitude]. For example, [-123.115,
+ * 49.285].
Depending on the data provider selected in the route calculator resource there may be additional + * restrictions on the inputs you can choose. See + * Position restrictions in the Amazon Location Service Developer Guide.
+ *For route calculators that use Esri as the data provider, if you specify a
+ * departure that's not located on a road, Amazon Location moves the position
+ * to the nearest road. The snapped value is available in the result in
+ * SnappedDeparturePositions.
Valid Values: [-180 to 180,-90 to 90]
+ *
The list of destination positions for the route matrix. An array of points, each of
+ * which is itself a 2-value array defined in WGS 84 format:
+ * [longitude, latitude]. For example, [-122.339,
+ * 47.615]
+ *
Depending on the data provider selected in the route calculator resource there may be additional + * restrictions on the inputs you can choose. See + * Position restrictions in the Amazon Location Service Developer Guide.
+ *For route calculators that use Esri as the data provider, if you specify a
+ * destination that's not located on a road, Amazon Location moves the position
+ * to the nearest road. The snapped value is available in the result in
+ * SnappedDestinationPositions.
Valid Values: [-180 to 180,-90 to 90]
+ *
Specifies the mode of transport when calculating a route. Used in estimating the speed + * of travel and road compatibility.
+ *The TravelMode you specify also determines how you specify route
+ * preferences:
If traveling by Car use the CarModeOptions
+ * parameter.
If traveling by Truck use the TruckModeOptions
+ * parameter.
Default Value: Car
+ *
Specifies the desired time of departure. Uses the given time to calculate the route
+ * matrix. You can't set both DepartureTime and DepartNow. If
+ * neither is set, the best time of day to travel with the best traffic conditions is used
+ * to calculate the route matrix.
Setting a departure time in the past returns a 400
+ * ValidationException error.
In ISO
+ * 8601 format: YYYY-MM-DDThh:mm:ss.sssZ. For example,
+ * 2020–07-2T12:15:20.000Z+01:00
+ *
Sets the time of departure as the current time. Uses the current time to calculate the
+ * route matrix. You can't set both DepartureTime and DepartNow.
+ * If neither is set, the best time of day to travel with the best traffic conditions is
+ * used to calculate the route matrix.
Default Value: false
+ *
Valid Values: false | true
+ *
Set the unit system to specify the distance.
+ *Default Value: Kilometers
+ *
Specifies route preferences when traveling by Car, such as avoiding
+ * routes that use ferries or tolls.
Requirements: TravelMode must be specified as Car.
Specifies route preferences when traveling by Truck, such as avoiding
+ * routes that use ferries or tolls, and truck specifications to consider when choosing an
+ * optimal road.
Requirements: TravelMode must be specified as Truck.
An error corresponding to the calculation of a route between the
+ * DeparturePosition and DestinationPosition.
The error code can be one of the following:
+ *
+ * RouteNotFound - Unable to find a
+ * valid route with the given parameters.
+ * RouteTooLong - Route calculation went
+ * beyond the maximum size of a route and was terminated before completion.
+ * PositionsNotFound - One or more of the
+ * input positions were not found on the route network.
+ * DestinationPositionNotFound - The
+ * destination position was not found on the route network.
+ * DeparturePositionNotFound - The
+ * departure position was not found on the route network.
+ * OtherValidationError - The given inputs were not valid or a
+ * route was not found. More information is given in the error
+ * Message
+ *
The type of error which occurred for the route calculation.
+ */ + Code: RouteMatrixErrorCode | string | undefined; + + /** + *A message about the error that occurred for the route calculation.
+ */ + Message?: string; +} + +export namespace RouteMatrixEntryError { + /** + * @internal + */ + export const filterSensitiveLog = (obj: RouteMatrixEntryError): any => ({ + ...obj, + }); +} + +/** + *The result for one SnappedDeparturePosition
+ * SnappedDestinationPosition pair.
The total distance of travel for the route.
+ */ + Distance?: number; + + /** + *The expected duration of travel for the route.
+ */ + DurationSeconds?: number; + + /** + *An error corresponding to the calculation of a route between the
+ * DeparturePosition and DestinationPosition.
A summary of the calculated route matrix.
+ */ +export interface CalculateRouteMatrixSummary { + /** + *The data provider of traffic and road network data used to calculate the routes. + * Indicates one of the available providers:
+ *
+ * Esri
+ *
+ * Here
+ *
For more information about data providers, see Amazon Location Service data providers.
+ */ + DataSource: string | undefined; + + /** + *The count of cells in the route matrix. Equal to the number of DeparturePositions
+ * multiplied by the number of DestinationPositions.
The count of error results in the route matrix. If this number is 0, all routes were calculated successfully.
+ */ + ErrorCount: number | undefined; + + /** + *The unit of measurement for route distances.
+ */ + DistanceUnit: DistanceUnit | string | undefined; +} + +export namespace CalculateRouteMatrixSummary { + /** + * @internal + */ + export const filterSensitiveLog = (obj: CalculateRouteMatrixSummary): any => ({ + ...obj, + }); +} + +/** + *Returns the result of the route matrix calculation.
+ */ +export interface CalculateRouteMatrixResponse { + /** + *The calculated route matrix containing the results for all pairs of
+ * DeparturePositions to DestinationPositions.
+ * Each row corresponds to one entry in DeparturePositions. Each
+ * entry in the row corresponds to the route from that entry in
+ * DeparturePositions to an entry in DestinationPositions.
+ *
For routes calculated using an Esri route calculator resource, departure positions
+ * are snapped to the closest road. For Esri route calculator resources, this returns
+ * the list of departure/origin positions used for calculation of the
+ * RouteMatrix.
The list of destination positions for the route matrix used for calculation of the RouteMatrix.
Contains information about the route matrix, DataSource,
+ * DistanceUnit, RouteCount and ErrorCount.
Optionally specifies the pricing plan for the geofence collection. Defaults to + * @deprecated + * + *
No longer used. If included, the only allowed value is
* RequestBasedUsage.
For additional details and restrictions on each pricing plan option, see the Amazon Location Service pricing - * page.
*/ PricingPlan?: PricingPlan | string; /** - *Specifies the data provider for the geofence collection.
- *Required value for the following pricing plans: MobileAssetTracking
- * | MobileAssetManagement
- *
For more information about Data Providers, and Pricing plans, see the Amazon Location - * Service product page.
- *Amazon Location Service only uses PricingPlanDataSource to calculate billing for
- * your geofence collection. Your data won't be shared with the data provider, and will
- * remain in your AWS account or Region unless you move it.
Valid Values: Esri | Here
- *
This parameter is no longer used.
*/ PricingPlanDataSource?: string; @@ -1693,9 +2018,10 @@ export interface CreateMapRequest { Configuration: MapConfiguration | undefined; /** - *Optionally specifies the pricing plan for the map resource. Defaults to + * @deprecated + * + *
No longer used. If included, the only allowed value is
* RequestBasedUsage.
For additional details and restrictions on each pricing plan option, see Amazon Location Service pricing.
*/ PricingPlan?: PricingPlan | string; @@ -1880,9 +2206,10 @@ export interface CreatePlaceIndexRequest { DataSource: string | undefined; /** - *Optionally specifies the pricing plan for the place index resource. Defaults to + * @deprecated + * + *
No longer used. If included, the only allowed value is
* RequestBasedUsage.
For additional details and restrictions on each pricing plan option, see Amazon Location Service pricing.
*/ PricingPlan?: PricingPlan | string; @@ -2015,9 +2342,10 @@ export interface CreateRouteCalculatorRequest { DataSource: string | undefined; /** - *Optionally specifies the pricing plan for the route calculator resource. Defaults to + * @deprecated + * + *
No longer used. If included, the only allowed value is
* RequestBasedUsage.
For additional details and restrictions on each pricing plan option, see Amazon Location Service pricing.
*/ PricingPlan?: PricingPlan | string; @@ -2139,9 +2467,10 @@ export interface CreateTrackerRequest { TrackerName: string | undefined; /** - *Optionally specifies the pricing plan for the tracker resource. Defaults to
- * RequestBasedUsage.
For additional details and restrictions on each pricing plan option, see Amazon Location Service pricing.
+ * @deprecated + * + *No longer used. If included, the only allowed value is
+ * RequestBasedUsage.
Specifies the data provider for the tracker resource.
- *Required value for the following pricing plans: MobileAssetTracking
- * | MobileAssetManagement
- *
For more information about Data Providers, and Pricing plans, see the Amazon Location - * Service product page.
- *Amazon Location Service only uses PricingPlanDataSource to calculate billing for your tracker resource. Your data will not be shared with the data provider, and will remain in your AWS account or Region unless you move it.
Valid values: Esri | Here
- *
This parameter is no longer used.
*/ PricingPlanDataSource?: string; @@ -2460,14 +2777,16 @@ export interface DescribeGeofenceCollectionResponse { Description: string | undefined; /** - *The pricing plan selected for the specified geofence collection.
- *For additional details and restrictions on each pricing plan option, see the Amazon Location Service pricing - * page.
+ * @deprecated + * + *No longer used. Always returns RequestBasedUsage.
The specified data provider for the geofence collection.
+ * @deprecated + * + *No longer used. Always returns an empty string.
*/ PricingPlanDataSource?: string; @@ -2541,11 +2860,11 @@ export interface DescribeMapResponse { MapArn: string | undefined; /** - *The pricing plan selected for the specified map resource.
+ * @deprecated * - *For additional details and restrictions on each pricing plan option, see Amazon Location Service pricing.
+ *No longer used. Always returns RequestBasedUsage.
Specifies the data provider for the associated map tiles.
@@ -2625,10 +2944,11 @@ export interface DescribePlaceIndexResponse { IndexArn: string | undefined; /** - *The pricing plan selected for the specified place index resource.
- *For additional details and restrictions on each pricing plan option, see Amazon Location Service pricing.
+ * @deprecated + * + *No longer used. Always returns RequestBasedUsage.
The optional description for the place index resource.
@@ -2721,10 +3041,11 @@ export interface DescribeRouteCalculatorResponse { CalculatorArn: string | undefined; /** - *The pricing plan selected for the specified route calculator resource.
- *For additional details and restrictions on each pricing plan option, see Amazon Location Service pricing.
+ * @deprecated + * + *Always returns RequestBasedUsage.
The optional description of the route calculator resource.
@@ -2830,13 +3151,16 @@ export interface DescribeTrackerResponse { Description: string | undefined; /** - *The pricing plan selected for the specified tracker resource.
- *For additional details and restrictions on each pricing plan option, see Amazon Location Service pricing.
+ * @deprecated + * + *Always returns RequestBasedUsage.
The specified data provider for the tracker resource.
+ * @deprecated + * + *No longer used. Always returns an empty string.
*/ PricingPlanDataSource?: string; @@ -3190,14 +3514,16 @@ export interface ListGeofenceCollectionsResponseEntry { Description: string | undefined; /** - *The pricing plan for the specified geofence collection.
- *For additional details and restrictions on each pricing plan option, see the Amazon Location Service pricing - * page.
+ * @deprecated + * + *No longer used. Always returns RequestBasedUsage.
The specified data provider for the geofence collection.
+ * @deprecated + * + *No longer used. Always returns an empty string.
*/ PricingPlanDataSource?: string; @@ -3430,27 +3756,17 @@ export interface UpdateGeofenceCollectionRequest { CollectionName: string | undefined; /** - *Updates the pricing plan for the geofence collection.
- *For more information about each pricing plan option restrictions, see Amazon Location Service - * pricing.
+ * @deprecated + * + *No longer used. If included, the only allowed value is
+ * RequestBasedUsage.
Updates the data provider for the geofence collection.
- *A required value for the following pricing plans: MobileAssetTracking|
- * MobileAssetManagement
- *
For more information about data providers and - * pricing plans, see the - * Amazon Location Service product page.
- *This can only be updated when updating the PricingPlan in the same
- * request.
Amazon Location Service uses PricingPlanDataSource to calculate
- * billing for your geofence collection. Your data won't be shared with the data
- * provider, and will remain in your AWS account and Region unless you move it.
This parameter is no longer used.
*/ PricingPlanDataSource?: string; @@ -4044,10 +4360,11 @@ export interface ListMapsResponseEntry { DataSource: string | undefined; /** - *The pricing plan for the specified map resource.
- *For additional details and restrictions on each pricing plan option, see Amazon Location Service pricing.
+ * @deprecated + * + *No longer used. Always returns RequestBasedUsage.
The timestamp for when the map resource was created in ISO 8601 @@ -4151,10 +4468,11 @@ export interface ListPlaceIndexesResponseEntry { DataSource: string | undefined; /** - *
The pricing plan for the specified place index resource.
- *For additional details and restrictions on each pricing plan option, see Amazon Location Service pricing.
+ * @deprecated + * + *No longer used. Always returns RequestBasedUsage.
The timestamp for when the place index resource was created in ISO 8601 format: @@ -4260,10 +4578,11 @@ export interface ListRouteCalculatorsResponseEntry { DataSource: string | undefined; /** - *
The pricing plan for the specified route calculator resource.
- *For additional details and restrictions on each pricing plan option, see Amazon Location Service pricing.
+ * @deprecated + * + *Always returns RequestBasedUsage.
The timestamp when the route calculator resource was created in ISO 8601 @@ -4415,13 +4734,16 @@ export interface ListTrackersResponseEntry { Description: string | undefined; /** - *
The pricing plan for the specified tracker resource.
- *For additional details and restrictions on each pricing plan option, see Amazon Location Service pricing.
+ * @deprecated + * + *Always returns RequestBasedUsage.
The specified data provider for the tracker resource.
+ * @deprecated + * + *No longer used. Always returns an empty string.
*/ PricingPlanDataSource?: string; @@ -4477,8 +4799,10 @@ export interface UpdateMapRequest { MapName: string | undefined; /** - *Updates the pricing plan for the map resource.
- *For more information about each pricing plan option restrictions, see Amazon Location Service pricing.
+ * @deprecated + * + *No longer used. If included, the only allowed value is
+ * RequestBasedUsage.
Updates the pricing plan for the place index resource.
- *For more information about each pricing plan option restrictions, see Amazon Location Service pricing.
+ * @deprecated + * + *No longer used. If included, the only allowed value is
+ * RequestBasedUsage.
Updates the pricing plan for the route calculator resource.
- *For more information about each pricing plan option restrictions, see Amazon Location - * Service pricing.
+ * @deprecated + * + *No longer used. If included, the only allowed value is
+ * RequestBasedUsage.
Updates the pricing plan for the tracker resource.
- *For more information about each pricing plan option restrictions, see Amazon Location Service - * pricing.
+ * @deprecated + * + *No longer used. If included, the only allowed value is
+ * RequestBasedUsage.
Updates the data provider for the tracker resource.
- *A required value for the following pricing plans: MobileAssetTracking| MobileAssetManagement
- *
For more information about data providers and pricing plans, see the Amazon Location Service product - * page
- *This can only be updated when updating the PricingPlan in the same
- * request.
Amazon Location Service uses PricingPlanDataSource to calculate
- * billing for your tracker resource. Your data won't be shared with the data provider,
- * and will remain in your AWS account and Region unless you move it.
This parameter is no longer used.
*/ PricingPlanDataSource?: string; diff --git a/clients/client-location/src/protocols/Aws_restJson1.ts b/clients/client-location/src/protocols/Aws_restJson1.ts index e315eff286882..60b981ead5967 100644 --- a/clients/client-location/src/protocols/Aws_restJson1.ts +++ b/clients/client-location/src/protocols/Aws_restJson1.ts @@ -48,6 +48,10 @@ import { BatchUpdateDevicePositionCommandOutput, } from "../commands/BatchUpdateDevicePositionCommand"; import { CalculateRouteCommandInput, CalculateRouteCommandOutput } from "../commands/CalculateRouteCommand"; +import { + CalculateRouteMatrixCommandInput, + CalculateRouteMatrixCommandOutput, +} from "../commands/CalculateRouteMatrixCommand"; import { CreateGeofenceCollectionCommandInput, CreateGeofenceCollectionCommandOutput, @@ -160,6 +164,7 @@ import { BatchPutGeofenceSuccess, BatchUpdateDevicePositionError, CalculateRouteCarModeOptions, + CalculateRouteMatrixSummary, CalculateRouteSummary, CalculateRouteTruckModeOptions, ConflictException, @@ -182,6 +187,8 @@ import { PlaceGeometry, PositionalAccuracy, ResourceNotFoundException, + RouteMatrixEntry, + RouteMatrixEntryError, SearchForPositionResult, SearchForSuggestionsResult, SearchForTextResult, @@ -570,6 +577,68 @@ export const serializeAws_restJson1CalculateRouteCommand = async ( }); }; +export const serializeAws_restJson1CalculateRouteMatrixCommand = async ( + input: CalculateRouteMatrixCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const { hostname, protocol = "https", port, path: basePath } = await context.endpoint(); + const headers: any = { + "content-type": "application/json", + }; + let resolvedPath = + `${basePath?.endsWith("/") ? basePath.slice(0, -1) : basePath || ""}` + + "/routes/v0/calculators/{CalculatorName}/calculate/route-matrix"; + if (input.CalculatorName !== undefined) { + const labelValue: string = input.CalculatorName; + if (labelValue.length <= 0) { + throw new Error("Empty value provided for input HTTP label: CalculatorName."); + } + resolvedPath = resolvedPath.replace("{CalculatorName}", __extendedEncodeURIComponent(labelValue)); + } else { + throw new Error("No value provided for input HTTP label: CalculatorName."); + } + let body: any; + body = JSON.stringify({ + ...(input.CarModeOptions !== undefined && + input.CarModeOptions !== null && { + CarModeOptions: serializeAws_restJson1CalculateRouteCarModeOptions(input.CarModeOptions, context), + }), + ...(input.DepartNow !== undefined && input.DepartNow !== null && { DepartNow: input.DepartNow }), + ...(input.DeparturePositions !== undefined && + input.DeparturePositions !== null && { + DeparturePositions: serializeAws_restJson1PositionList(input.DeparturePositions, context), + }), + ...(input.DepartureTime !== undefined && + input.DepartureTime !== null && { DepartureTime: input.DepartureTime.toISOString().split(".")[0] + "Z" }), + ...(input.DestinationPositions !== undefined && + input.DestinationPositions !== null && { + DestinationPositions: serializeAws_restJson1PositionList(input.DestinationPositions, context), + }), + ...(input.DistanceUnit !== undefined && input.DistanceUnit !== null && { DistanceUnit: input.DistanceUnit }), + ...(input.TravelMode !== undefined && input.TravelMode !== null && { TravelMode: input.TravelMode }), + ...(input.TruckModeOptions !== undefined && + input.TruckModeOptions !== null && { + TruckModeOptions: serializeAws_restJson1CalculateRouteTruckModeOptions(input.TruckModeOptions, context), + }), + }); + let { hostname: resolvedHostname } = await context.endpoint(); + if (context.disableHostPrefix !== true) { + resolvedHostname = "routes." + resolvedHostname; + if (!__isValidHostname(resolvedHostname)) { + throw new Error("ValidationError: prefixed hostname must be hostname compatible."); + } + } + return new __HttpRequest({ + protocol, + hostname: resolvedHostname, + port, + method: "POST", + headers, + path: resolvedPath, + body, + }); +}; + export const serializeAws_restJson1CreateGeofenceCollectionCommand = async ( input: CreateGeofenceCollectionCommandInput, context: __SerdeContext @@ -3065,6 +3134,108 @@ const deserializeAws_restJson1CalculateRouteCommandError = async ( return Promise.reject(Object.assign(new Error(message), response)); }; +export const deserializeAws_restJson1CalculateRouteMatrixCommand = async ( + output: __HttpResponse, + context: __SerdeContext +): PromiseDeactivates an anomaly detector.
+ */ + public deactivateAnomalyDetector( + args: DeactivateAnomalyDetectorCommandInput, + options?: __HttpHandlerOptions + ): PromiseDeletes an alert.
*/ diff --git a/clients/client-lookoutmetrics/src/LookoutMetricsClient.ts b/clients/client-lookoutmetrics/src/LookoutMetricsClient.ts index 1ae50206f48bd..da7374ea51040 100644 --- a/clients/client-lookoutmetrics/src/LookoutMetricsClient.ts +++ b/clients/client-lookoutmetrics/src/LookoutMetricsClient.ts @@ -64,6 +64,10 @@ import { CreateAnomalyDetectorCommandOutput, } from "./commands/CreateAnomalyDetectorCommand"; import { CreateMetricSetCommandInput, CreateMetricSetCommandOutput } from "./commands/CreateMetricSetCommand"; +import { + DeactivateAnomalyDetectorCommandInput, + DeactivateAnomalyDetectorCommandOutput, +} from "./commands/DeactivateAnomalyDetectorCommand"; import { DeleteAlertCommandInput, DeleteAlertCommandOutput } from "./commands/DeleteAlertCommand"; import { DeleteAnomalyDetectorCommandInput, @@ -120,6 +124,7 @@ export type ServiceInputTypes = | CreateAlertCommandInput | CreateAnomalyDetectorCommandInput | CreateMetricSetCommandInput + | DeactivateAnomalyDetectorCommandInput | DeleteAlertCommandInput | DeleteAnomalyDetectorCommandInput | DescribeAlertCommandInput @@ -148,6 +153,7 @@ export type ServiceOutputTypes = | CreateAlertCommandOutput | CreateAnomalyDetectorCommandOutput | CreateMetricSetCommandOutput + | DeactivateAnomalyDetectorCommandOutput | DeleteAlertCommandOutput | DeleteAnomalyDetectorCommandOutput | DescribeAlertCommandOutput diff --git a/clients/client-lookoutmetrics/src/commands/DeactivateAnomalyDetectorCommand.ts b/clients/client-lookoutmetrics/src/commands/DeactivateAnomalyDetectorCommand.ts new file mode 100644 index 0000000000000..0f3878ebc3f45 --- /dev/null +++ b/clients/client-lookoutmetrics/src/commands/DeactivateAnomalyDetectorCommand.ts @@ -0,0 +1,98 @@ +import { getSerdePlugin } from "@aws-sdk/middleware-serde"; +import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@aws-sdk/protocol-http"; +import { Command as $Command } from "@aws-sdk/smithy-client"; +import { + FinalizeHandlerArguments, + Handler, + HandlerExecutionContext, + HttpHandlerOptions as __HttpHandlerOptions, + MetadataBearer as __MetadataBearer, + MiddlewareStack, + SerdeContext as __SerdeContext, +} from "@aws-sdk/types"; + +import { LookoutMetricsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../LookoutMetricsClient"; +import { DeactivateAnomalyDetectorRequest, DeactivateAnomalyDetectorResponse } from "../models/models_0"; +import { + deserializeAws_restJson1DeactivateAnomalyDetectorCommand, + serializeAws_restJson1DeactivateAnomalyDetectorCommand, +} from "../protocols/Aws_restJson1"; + +export interface DeactivateAnomalyDetectorCommandInput extends DeactivateAnomalyDetectorRequest {} +export interface DeactivateAnomalyDetectorCommandOutput extends DeactivateAnomalyDetectorResponse, __MetadataBearer {} + +/** + *Deactivates an anomaly detector.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LookoutMetricsClient, DeactivateAnomalyDetectorCommand } from "@aws-sdk/client-lookoutmetrics"; // ES Modules import + * // const { LookoutMetricsClient, DeactivateAnomalyDetectorCommand } = require("@aws-sdk/client-lookoutmetrics"); // CommonJS import + * const client = new LookoutMetricsClient(config); + * const command = new DeactivateAnomalyDetectorCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeactivateAnomalyDetectorCommandInput} for command's `input` shape. + * @see {@link DeactivateAnomalyDetectorCommandOutput} for command's `response` shape. + * @see {@link LookoutMetricsClientResolvedConfig | config} for LookoutMetricsClient's `config` shape. + * + */ +export class DeactivateAnomalyDetectorCommand extends $Command< + DeactivateAnomalyDetectorCommandInput, + DeactivateAnomalyDetectorCommandOutput, + LookoutMetricsClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + constructor(readonly input: DeactivateAnomalyDetectorCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackAn IAM role that gives Amazon Lookout for Metrics permission to access the flow.
*/ - RoleArn: string | undefined; + RoleArn?: string; /** *name of the flow.
*/ - FlowName: string | undefined; + FlowName?: string; } export namespace AppFlowConfig { @@ -808,7 +817,7 @@ export interface CloudWatchConfig { /** *An IAM role that gives Amazon Lookout for Metrics permission to access data in Amazon CloudWatch.
*/ - RoleArn: string | undefined; + RoleArn?: string; } export namespace CloudWatchConfig { @@ -1017,42 +1026,42 @@ export interface RDSSourceConfig { /** *A string identifying the database instance.
*/ - DBInstanceIdentifier: string | undefined; + DBInstanceIdentifier?: string; /** *The host name of the database.
*/ - DatabaseHost: string | undefined; + DatabaseHost?: string; /** *The port number where the database can be accessed.
*/ - DatabasePort: number | undefined; + DatabasePort?: number; /** *The Amazon Resource Name (ARN) of the AWS Secrets Manager role.
*/ - SecretManagerArn: string | undefined; + SecretManagerArn?: string; /** *The name of the RDS database.
*/ - DatabaseName: string | undefined; + DatabaseName?: string; /** *The name of the table in the database.
*/ - TableName: string | undefined; + TableName?: string; /** *The Amazon Resource Name (ARN) of the role.
*/ - RoleArn: string | undefined; + RoleArn?: string; /** *An object containing information about the Amazon Virtual Private Cloud (VPC) configuration.
*/ - VpcConfiguration: VpcConfiguration | undefined; + VpcConfiguration?: VpcConfiguration; } export namespace RDSSourceConfig { @@ -1071,42 +1080,42 @@ export interface RedshiftSourceConfig { /** *A string identifying the Redshift cluster.
*/ - ClusterIdentifier: string | undefined; + ClusterIdentifier?: string; /** *The name of the database host.
*/ - DatabaseHost: string | undefined; + DatabaseHost?: string; /** *The port number where the database can be accessed.
*/ - DatabasePort: number | undefined; + DatabasePort?: number; /** *The Amazon Resource Name (ARN) of the AWS Secrets Manager role.
*/ - SecretManagerArn: string | undefined; + SecretManagerArn?: string; /** *The Redshift database name.
*/ - DatabaseName: string | undefined; + DatabaseName?: string; /** *The table name of the Redshift database.
*/ - TableName: string | undefined; + TableName?: string; /** *The Amazon Resource Name (ARN) of the role providing access to the database.
*/ - RoleArn: string | undefined; + RoleArn?: string; /** *Contains information about the Amazon Virtual Private Cloud (VPC) configuration.
*/ - VpcConfiguration: VpcConfiguration | undefined; + VpcConfiguration?: VpcConfiguration; } export namespace RedshiftSourceConfig { @@ -1227,7 +1236,7 @@ export interface S3SourceConfig { /** *The ARN of an IAM role that has read and write access permissions to the source S3 bucket.
*/ - RoleArn: string | undefined; + RoleArn?: string; /** *A list of templated paths to the source files.
@@ -1399,6 +1408,33 @@ export namespace CreateMetricSetResponse { }); } +export interface DeactivateAnomalyDetectorRequest { + /** + *The Amazon Resource Name (ARN) of the anomaly detector.
+ */ + AnomalyDetectorArn: string | undefined; +} + +export namespace DeactivateAnomalyDetectorRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: DeactivateAnomalyDetectorRequest): any => ({ + ...obj, + }); +} + +export interface DeactivateAnomalyDetectorResponse {} + +export namespace DeactivateAnomalyDetectorResponse { + /** + * @internal + */ + export const filterSensitiveLog = (obj: DeactivateAnomalyDetectorResponse): any => ({ + ...obj, + }); +} + export interface DeleteAlertRequest { /** *The ARN of the alert to delete.
@@ -1619,7 +1655,7 @@ export interface DescribeAnomalyDetectorResponse { Status?: AnomalyDetectorStatus | string; /** - *The reason that the detector failed, if any.
+ *The reason that the detector failed.
*/ FailureReason?: string; @@ -1627,6 +1663,11 @@ export interface DescribeAnomalyDetectorResponse { *The ARN of the KMS key to use to encrypt your data.
*/ KmsKeyArn?: string; + + /** + *The process that caused the detector to fail.
+ */ + FailureType?: AnomalyDetectorFailureType | string; } export namespace DescribeAnomalyDetectorResponse { diff --git a/clients/client-lookoutmetrics/src/protocols/Aws_restJson1.ts b/clients/client-lookoutmetrics/src/protocols/Aws_restJson1.ts index 5defe950ec43f..eea8e72ccd827 100644 --- a/clients/client-lookoutmetrics/src/protocols/Aws_restJson1.ts +++ b/clients/client-lookoutmetrics/src/protocols/Aws_restJson1.ts @@ -32,6 +32,10 @@ import { CreateAnomalyDetectorCommandOutput, } from "../commands/CreateAnomalyDetectorCommand"; import { CreateMetricSetCommandInput, CreateMetricSetCommandOutput } from "../commands/CreateMetricSetCommand"; +import { + DeactivateAnomalyDetectorCommandInput, + DeactivateAnomalyDetectorCommandOutput, +} from "../commands/DeactivateAnomalyDetectorCommand"; import { DeleteAlertCommandInput, DeleteAlertCommandOutput } from "../commands/DeleteAlertCommand"; import { DeleteAnomalyDetectorCommandInput, @@ -291,6 +295,32 @@ export const serializeAws_restJson1CreateMetricSetCommand = async ( }); }; +export const serializeAws_restJson1DeactivateAnomalyDetectorCommand = async ( + input: DeactivateAnomalyDetectorCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const { hostname, protocol = "https", port, path: basePath } = await context.endpoint(); + const headers: any = { + "content-type": "application/json", + }; + const resolvedPath = + `${basePath?.endsWith("/") ? basePath.slice(0, -1) : basePath || ""}` + "/DeactivateAnomalyDetector"; + let body: any; + body = JSON.stringify({ + ...(input.AnomalyDetectorArn !== undefined && + input.AnomalyDetectorArn !== null && { AnomalyDetectorArn: input.AnomalyDetectorArn }), + }); + return new __HttpRequest({ + protocol, + hostname, + port, + method: "POST", + headers, + path: resolvedPath, + body, + }); +}; + export const serializeAws_restJson1DeleteAlertCommand = async ( input: DeleteAlertCommandInput, context: __SerdeContext @@ -1376,6 +1406,97 @@ const deserializeAws_restJson1CreateMetricSetCommandError = async ( return Promise.reject(Object.assign(new Error(message), response)); }; +export const deserializeAws_restJson1DeactivateAnomalyDetectorCommand = async ( + output: __HttpResponse, + context: __SerdeContext +): PromiseA custom name for the custom data identifier. The name can contain as many as 128 characters.
We strongly recommend that you avoid including any sensitive data in the name of a custom data identifier. Other users of your account might be able to see this name, depending on the actions that they're allowed to perform in Amazon Macie.
*/ - name?: string; + name: string | undefined; /** *The regular expression (regex) that defines the pattern to match. The expression can contain as many as 512 characters.
*/ - regex?: string; + regex: string | undefined; /** *The severity to assign to findings that the custom data identifier produces, based on the number of occurrences of text that matches the custom data identifier's detection criteria. You can specify as many as three SeverityLevel objects in this array, one for each severity: LOW, MEDIUM, or HIGH. If you specify more than one, the occurrences thresholds must be in ascending order by severity, moving from LOW to HIGH. For example, 1 for LOW, 50 for MEDIUM, and 100 for HIGH. If an S3 object contains fewer occurrences than the lowest specified threshold, Amazon Macie doesn't create a finding.
If you don't specify any values for this array, Macie creates findings for S3 objects that contain at least one occurrence of text that matches the detection criteria, and Macie assigns the MEDIUM severity to those findings.
diff --git a/clients/client-mediaconvert/src/commands/UntagResourceCommand.ts b/clients/client-mediaconvert/src/commands/UntagResourceCommand.ts index 4ba65d1b7989c..262581f5fe854 100644 --- a/clients/client-mediaconvert/src/commands/UntagResourceCommand.ts +++ b/clients/client-mediaconvert/src/commands/UntagResourceCommand.ts @@ -12,7 +12,7 @@ import { } from "@aws-sdk/types"; import { MediaConvertClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../MediaConvertClient"; -import { UntagResourceRequest, UntagResourceResponse } from "../models/models_1"; +import { UntagResourceRequest, UntagResourceResponse } from "../models/models_2"; import { deserializeAws_restJson1UntagResourceCommand, serializeAws_restJson1UntagResourceCommand, diff --git a/clients/client-mediaconvert/src/commands/UpdateJobTemplateCommand.ts b/clients/client-mediaconvert/src/commands/UpdateJobTemplateCommand.ts index 0f65683f47bf6..af7489509b119 100644 --- a/clients/client-mediaconvert/src/commands/UpdateJobTemplateCommand.ts +++ b/clients/client-mediaconvert/src/commands/UpdateJobTemplateCommand.ts @@ -12,7 +12,7 @@ import { } from "@aws-sdk/types"; import { MediaConvertClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../MediaConvertClient"; -import { UpdateJobTemplateRequest, UpdateJobTemplateResponse } from "../models/models_1"; +import { UpdateJobTemplateRequest, UpdateJobTemplateResponse } from "../models/models_2"; import { deserializeAws_restJson1UpdateJobTemplateCommand, serializeAws_restJson1UpdateJobTemplateCommand, diff --git a/clients/client-mediaconvert/src/commands/UpdatePresetCommand.ts b/clients/client-mediaconvert/src/commands/UpdatePresetCommand.ts index deddf64464208..f5d5d69508cd4 100644 --- a/clients/client-mediaconvert/src/commands/UpdatePresetCommand.ts +++ b/clients/client-mediaconvert/src/commands/UpdatePresetCommand.ts @@ -12,8 +12,7 @@ import { } from "@aws-sdk/types"; import { MediaConvertClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../MediaConvertClient"; -import { UpdatePresetRequest } from "../models/models_1"; -import { UpdatePresetResponse } from "../models/models_2"; +import { UpdatePresetRequest, UpdatePresetResponse } from "../models/models_2"; import { deserializeAws_restJson1UpdatePresetCommand, serializeAws_restJson1UpdatePresetCommand, diff --git a/clients/client-mediaconvert/src/models/models_0.ts b/clients/client-mediaconvert/src/models/models_0.ts index ccfc1bc029726..6f6e282c13a5f 100644 --- a/clients/client-mediaconvert/src/models/models_0.ts +++ b/clients/client-mediaconvert/src/models/models_0.ts @@ -1130,6 +1130,7 @@ export enum LanguageCode { SQI = "SQI", SRB = "SRB", SRD = "SRD", + SRP = "SRP", SSW = "SSW", SUN = "SUN", SWA = "SWA", @@ -1768,6 +1769,11 @@ export namespace EmbeddedDestinationSettings { }); } +export enum ImscAccessibilitySubs { + DISABLED = "DISABLED", + ENABLED = "ENABLED", +} + export enum ImscStylePassthrough { DISABLED = "DISABLED", ENABLED = "ENABLED", @@ -1777,6 +1783,11 @@ export enum ImscStylePassthrough { * Settings related to IMSC captions. IMSC is a sidecar format that holds captions in a file that is separate from the video container. Set up sidecar captions in the same output group, but different output from your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/ttml-and-webvtt-output-captions.html. When you work directly in your JSON job specification, include this object and any required children when you set destinationType to IMSC. */ export interface ImscDestinationSettings { + /** + * Specify whether to flag this caption track as accessibility in your HLS/CMAF parent manifest. When you choose ENABLED, MediaConvert includes the parameters CHARACTERISTICS="public.accessibility.describes-spoken-dialog,public.accessibility.describes-music-and-sound" and AUTOSELECT="YES" in the EXT-X-MEDIA entry for this track. When you keep the default choice, DISABLED, MediaConvert leaves this parameter out. + */ + Accessibility?: ImscAccessibilitySubs | string; + /** * Keep this setting enabled to have MediaConvert use the font style and position information from the captions source in the output. This option is available only when your input captions are IMSC, SMPTE-TT, or TTML. Disable this setting for simplified output captions. */ @@ -1899,6 +1910,11 @@ export namespace TtmlDestinationSettings { }); } +export enum WebvttAccessibilitySubs { + DISABLED = "DISABLED", + ENABLED = "ENABLED", +} + export enum WebvttStylePassthrough { DISABLED = "DISABLED", ENABLED = "ENABLED", @@ -1908,6 +1924,11 @@ export enum WebvttStylePassthrough { * Settings related to WebVTT captions. WebVTT is a sidecar format that holds captions in a file that is separate from the video container. Set up sidecar captions in the same output group, but different output from your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/ttml-and-webvtt-output-captions.html. When you work directly in your JSON job specification, include this object and any required children when you set destinationType to WebVTT. */ export interface WebvttDestinationSettings { + /** + * Specify whether to flag this caption track as accessibility in your HLS/CMAF parent manifest. When you choose ENABLED, MediaConvert includes the parameters CHARACTERISTICS="public.accessibility.describes-spoken-dialog,public.accessibility.describes-music-and-sound" and AUTOSELECT="YES" in the EXT-X-MEDIA entry for this track. When you keep the default choice, DISABLED, MediaConvert leaves this parameter out. + */ + Accessibility?: WebvttAccessibilitySubs | string; + /** * Set Style passthrough (StylePassthrough) to ENABLED to use the available style, color, and position information from your input captions. MediaConvert uses default settings for any missing style and position information in your input captions. Set Style passthrough to DISABLED, or leave blank, to ignore the style and position information from your input captions and use simplified output captions. */ @@ -3131,6 +3152,11 @@ export interface Input { */ DenoiseFilter?: InputDenoiseFilter | string; + /** + * Use this setting only when your video source has Dolby Vision studio mastering metadata that is carried in a separate XML file. Specify the Amazon S3 location for the metadata XML file. MediaConvert uses this file to provide global and frame-level metadata for Dolby Vision preprocessing. When you specify a file here and your input also has interleaved global and frame level metadata, MediaConvert ignores the interleaved metadata and uses only the the metadata from this external XML file. Note that your IAM service role must grant MediaConvert read permissions to this file. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/iam-role.html. + */ + DolbyVisionMetadataXml?: string; + /** * Specify the source file for your transcoding job. You can use multiple inputs in a single job. The service concatenates these inputs, in the order that you specify them in the job, to create the outputs. If your input format is IMF, specify your input by providing the path to your CPL. For example, "s3://bucket/vf/cpl.xml". If the CPL is in an incomplete IMP, make sure to use *Supplemental IMPs* (SupplementalImps) to specify any supplemental IMPs that contain assets referenced by the CPL. */ @@ -3240,6 +3266,11 @@ export interface InputTemplate { */ DenoiseFilter?: InputDenoiseFilter | string; + /** + * Use this setting only when your video source has Dolby Vision studio mastering metadata that is carried in a separate XML file. Specify the Amazon S3 location for the metadata XML file. MediaConvert uses this file to provide global and frame-level metadata for Dolby Vision preprocessing. When you specify a file here and your input also has interleaved global and frame level metadata, MediaConvert ignores the interleaved metadata and uses only the the metadata from this external XML file. Note that your IAM service role must grant MediaConvert read permissions to this file. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/iam-role.html. + */ + DolbyVisionMetadataXml?: string; + /** * Specify how the transcoding service applies the denoise and deblock filters. You must also enable the filters separately, with Denoise (InputDenoiseFilter) and Deblock (InputDeblockFilter). * Auto - The transcoding service determines whether to apply filtering, depending on input type and quality. * Disable - The input is not filtered. This is true even if you use the API to enable them in (InputDeblockFilter) and (InputDeblockFilter). * Force - The input is filtered regardless of input type. */ @@ -5257,6 +5288,11 @@ export enum CmfcScte35Source { PASSTHROUGH = "PASSTHROUGH", } +export enum CmfcTimedMetadata { + NONE = "NONE", + PASSTHROUGH = "PASSTHROUGH", +} + /** * These settings relate to the fragmented MP4 container for the segments in your CMAF outputs. */ @@ -5300,6 +5336,11 @@ export interface CmfcSettings { * Ignore this setting unless you have SCTE-35 markers in your input video file. Choose Passthrough (PASSTHROUGH) if you want SCTE-35 markers that appear in your input to also appear in this output. Choose None (NONE) if you don't want those SCTE-35 markers in this output. */ Scte35Source?: CmfcScte35Source | string; + + /** + * Applies to CMAF outputs. Use this setting to specify whether the service inserts the ID3 timed metadata from the input in this output. + */ + TimedMetadata?: CmfcTimedMetadata | string; } export namespace CmfcSettings { @@ -5759,122 +5800,3 @@ export enum M3u8Scte35Source { NONE = "NONE", PASSTHROUGH = "PASSTHROUGH", } - -export enum TimedMetadata { - NONE = "NONE", - PASSTHROUGH = "PASSTHROUGH", -} - -/** - * These settings relate to the MPEG-2 transport stream (MPEG2-TS) container for the MPEG2-TS segments in your HLS outputs. - */ -export interface M3u8Settings { - /** - * Specify this setting only when your output will be consumed by a downstream repackaging workflow that is sensitive to very small duration differences between video and audio. For this situation, choose Match video duration (MATCH_VIDEO_DURATION). In all other cases, keep the default value, Default codec duration (DEFAULT_CODEC_DURATION). When you choose Match video duration, MediaConvert pads the output audio streams with silence or trims them to ensure that the total duration of each audio stream is at least as long as the total duration of the video stream. After padding or trimming, the audio stream duration is no more than one frame longer than the video stream. MediaConvert applies audio padding or trimming only to the end of the last segment of the output. For unsegmented outputs, MediaConvert adds padding only to the end of the file. When you keep the default value, any minor discrepancies between audio and video duration will depend on your output audio codec. - */ - AudioDuration?: M3u8AudioDuration | string; - - /** - * The number of audio frames to insert for each PES packet. - */ - AudioFramesPerPes?: number; - - /** - * Packet Identifier (PID) of the elementary audio stream(s) in the transport stream. Multiple values are accepted, and can be entered in ranges and/or by comma separation. - */ - AudioPids?: number[]; - - /** - * If you select ALIGN_TO_VIDEO, MediaConvert writes captions and data packets with Presentation Timestamp (PTS) values greater than or equal to the first video packet PTS (MediaConvert drops captions and data packets with lesser PTS values). Keep the default value (AUTO) to allow all PTS values. - */ - DataPTSControl?: M3u8DataPtsControl | string; - - /** - * Specify the maximum time, in milliseconds, between Program Clock References (PCRs) inserted into the transport stream. - */ - MaxPcrInterval?: number; - - /** - * If INSERT, Nielsen inaudible tones for media tracking will be detected in the input audio and an equivalent ID3 tag will be inserted in the output. - */ - NielsenId3?: M3u8NielsenId3 | string; - - /** - * The number of milliseconds between instances of this table in the output transport stream. - */ - PatInterval?: number; - - /** - * When set to PCR_EVERY_PES_PACKET a Program Clock Reference value is inserted for every Packetized Elementary Stream (PES) header. This parameter is effective only when the PCR PID is the same as the video or audio elementary stream. - */ - PcrControl?: M3u8PcrControl | string; - - /** - * Packet Identifier (PID) of the Program Clock Reference (PCR) in the transport stream. When no value is given, the encoder will assign the same value as the Video PID. - */ - PcrPid?: number; - - /** - * The number of milliseconds between instances of this table in the output transport stream. - */ - PmtInterval?: number; - - /** - * Packet Identifier (PID) for the Program Map Table (PMT) in the transport stream. - */ - PmtPid?: number; - - /** - * Packet Identifier (PID) of the private metadata stream in the transport stream. - */ - PrivateMetadataPid?: number; - - /** - * The value of the program number field in the Program Map Table. - */ - ProgramNumber?: number; - - /** - * Packet Identifier (PID) of the SCTE-35 stream in the transport stream. - */ - Scte35Pid?: number; - - /** - * For SCTE-35 markers from your input-- Choose Passthrough (PASSTHROUGH) if you want SCTE-35 markers that appear in your input to also appear in this output. Choose None (NONE) if you don't want SCTE-35 markers in this output. For SCTE-35 markers from an ESAM XML document-- Choose None (NONE) if you don't want manifest conditioning. Choose Passthrough (PASSTHROUGH) and choose Ad markers (adMarkers) if you do want manifest conditioning. In both cases, also provide the ESAM XML as a string in the setting Signal processing notification XML (sccXml). - */ - Scte35Source?: M3u8Scte35Source | string; - - /** - * Applies only to HLS outputs. Use this setting to specify whether the service inserts the ID3 timed metadata from the input in this output. - */ - TimedMetadata?: TimedMetadata | string; - - /** - * Packet Identifier (PID) of the timed metadata stream in the transport stream. - */ - TimedMetadataPid?: number; - - /** - * The value of the transport stream ID field in the Program Map Table. - */ - TransportStreamId?: number; - - /** - * Packet Identifier (PID) of the elementary video stream in the transport stream. - */ - VideoPid?: number; -} - -export namespace M3u8Settings { - /** - * @internal - */ - export const filterSensitiveLog = (obj: M3u8Settings): any => ({ - ...obj, - }); -} - -export enum MovClapAtom { - EXCLUDE = "EXCLUDE", - INCLUDE = "INCLUDE", -} diff --git a/clients/client-mediaconvert/src/models/models_1.ts b/clients/client-mediaconvert/src/models/models_1.ts index d786f24ec3c5b..a169c9fbf7e13 100644 --- a/clients/client-mediaconvert/src/models/models_1.ts +++ b/clients/client-mediaconvert/src/models/models_1.ts @@ -26,9 +26,12 @@ import { JobPhase, KantarWatermarkSettings, M2tsSettings, - M3u8Settings, + M3u8AudioDuration, + M3u8DataPtsControl, + M3u8NielsenId3, + M3u8PcrControl, + M3u8Scte35Source, MotionImageInserter, - MovClapAtom, NielsenConfiguration, NielsenNonLinearWatermarkSettings, OutputGroupDetail, @@ -37,6 +40,125 @@ import { Rectangle, } from "./models_0"; +export enum TimedMetadata { + NONE = "NONE", + PASSTHROUGH = "PASSTHROUGH", +} + +/** + * These settings relate to the MPEG-2 transport stream (MPEG2-TS) container for the MPEG2-TS segments in your HLS outputs. + */ +export interface M3u8Settings { + /** + * Specify this setting only when your output will be consumed by a downstream repackaging workflow that is sensitive to very small duration differences between video and audio. For this situation, choose Match video duration (MATCH_VIDEO_DURATION). In all other cases, keep the default value, Default codec duration (DEFAULT_CODEC_DURATION). When you choose Match video duration, MediaConvert pads the output audio streams with silence or trims them to ensure that the total duration of each audio stream is at least as long as the total duration of the video stream. After padding or trimming, the audio stream duration is no more than one frame longer than the video stream. MediaConvert applies audio padding or trimming only to the end of the last segment of the output. For unsegmented outputs, MediaConvert adds padding only to the end of the file. When you keep the default value, any minor discrepancies between audio and video duration will depend on your output audio codec. + */ + AudioDuration?: M3u8AudioDuration | string; + + /** + * The number of audio frames to insert for each PES packet. + */ + AudioFramesPerPes?: number; + + /** + * Packet Identifier (PID) of the elementary audio stream(s) in the transport stream. Multiple values are accepted, and can be entered in ranges and/or by comma separation. + */ + AudioPids?: number[]; + + /** + * If you select ALIGN_TO_VIDEO, MediaConvert writes captions and data packets with Presentation Timestamp (PTS) values greater than or equal to the first video packet PTS (MediaConvert drops captions and data packets with lesser PTS values). Keep the default value (AUTO) to allow all PTS values. + */ + DataPTSControl?: M3u8DataPtsControl | string; + + /** + * Specify the maximum time, in milliseconds, between Program Clock References (PCRs) inserted into the transport stream. + */ + MaxPcrInterval?: number; + + /** + * If INSERT, Nielsen inaudible tones for media tracking will be detected in the input audio and an equivalent ID3 tag will be inserted in the output. + */ + NielsenId3?: M3u8NielsenId3 | string; + + /** + * The number of milliseconds between instances of this table in the output transport stream. + */ + PatInterval?: number; + + /** + * When set to PCR_EVERY_PES_PACKET a Program Clock Reference value is inserted for every Packetized Elementary Stream (PES) header. This parameter is effective only when the PCR PID is the same as the video or audio elementary stream. + */ + PcrControl?: M3u8PcrControl | string; + + /** + * Packet Identifier (PID) of the Program Clock Reference (PCR) in the transport stream. When no value is given, the encoder will assign the same value as the Video PID. + */ + PcrPid?: number; + + /** + * The number of milliseconds between instances of this table in the output transport stream. + */ + PmtInterval?: number; + + /** + * Packet Identifier (PID) for the Program Map Table (PMT) in the transport stream. + */ + PmtPid?: number; + + /** + * Packet Identifier (PID) of the private metadata stream in the transport stream. + */ + PrivateMetadataPid?: number; + + /** + * The value of the program number field in the Program Map Table. + */ + ProgramNumber?: number; + + /** + * Packet Identifier (PID) of the SCTE-35 stream in the transport stream. + */ + Scte35Pid?: number; + + /** + * For SCTE-35 markers from your input-- Choose Passthrough (PASSTHROUGH) if you want SCTE-35 markers that appear in your input to also appear in this output. Choose None (NONE) if you don't want SCTE-35 markers in this output. For SCTE-35 markers from an ESAM XML document-- Choose None (NONE) if you don't want manifest conditioning. Choose Passthrough (PASSTHROUGH) and choose Ad markers (adMarkers) if you do want manifest conditioning. In both cases, also provide the ESAM XML as a string in the setting Signal processing notification XML (sccXml). + */ + Scte35Source?: M3u8Scte35Source | string; + + /** + * Applies to HLS outputs. Use this setting to specify whether the service inserts the ID3 timed metadata from the input in this output. + */ + TimedMetadata?: TimedMetadata | string; + + /** + * Packet Identifier (PID) of the timed metadata stream in the transport stream. + */ + TimedMetadataPid?: number; + + /** + * The value of the transport stream ID field in the Program Map Table. + */ + TransportStreamId?: number; + + /** + * Packet Identifier (PID) of the elementary video stream in the transport stream. + */ + VideoPid?: number; +} + +export namespace M3u8Settings { + /** + * @internal + */ + export const filterSensitiveLog = (obj: M3u8Settings): any => ({ + ...obj, + }); +} + +export enum MovClapAtom { + EXCLUDE = "EXCLUDE", + INCLUDE = "INCLUDE", +} + export enum MovCslgAtom { EXCLUDE = "EXCLUDE", INCLUDE = "INCLUDE", @@ -180,6 +302,11 @@ export enum MpdScte35Source { PASSTHROUGH = "PASSTHROUGH", } +export enum MpdTimedMetadata { + NONE = "NONE", + PASSTHROUGH = "PASSTHROUGH", +} + /** * These settings relate to the fragmented MP4 container for the segments in your DASH outputs. */ @@ -208,6 +335,11 @@ export interface MpdSettings { * Ignore this setting unless you have SCTE-35 markers in your input video file. Choose Passthrough (PASSTHROUGH) if you want SCTE-35 markers that appear in your input to also appear in this output. Choose None (NONE) if you don't want those SCTE-35 markers in this output. */ Scte35Source?: MpdScte35Source | string; + + /** + * Applies to DASH outputs. Use this setting to specify whether the service inserts the ID3 timed metadata from the input in this output. + */ + TimedMetadata?: MpdTimedMetadata | string; } export namespace MpdSettings { @@ -458,6 +590,11 @@ export enum Av1AdaptiveQuantization { OFF = "OFF", } +export enum Av1BitDepth { + BIT_10 = "BIT_10", + BIT_8 = "BIT_8", +} + export enum Av1FramerateControl { INITIALIZE_FROM_SOURCE = "INITIALIZE_FROM_SOURCE", SPECIFIED = "SPECIFIED", @@ -511,6 +648,11 @@ export interface Av1Settings { */ AdaptiveQuantization?: Av1AdaptiveQuantization | string; + /** + * Specify the Bit depth (Av1BitDepth). You can choose 8-bit (BIT_8) or 10-bit (BIT_10). + */ + BitDepth?: Av1BitDepth | string; + /** * If you are using the console, use the Framerate setting to specify the frame rate for this output. If you want to keep the same frame rate as the input video, choose Follow source. If you want to do frame rate conversion, choose a frame rate from the dropdown list or choose Custom. The framerates shown in the dropdown list are decimal approximations of fractions. If you choose Custom, specify your frame rate as a fraction. If you are creating your transcoding job specification as a JSON file without the console, use FramerateControl to specify which value the service uses for the frame rate for this output. Choose INITIALIZE_FROM_SOURCE if you want the service to use the frame rate from the input. Choose SPECIFIED if you want the service to use the frame rate you specify in the settings FramerateNumerator and FramerateDenominator. */ @@ -1151,6 +1293,7 @@ export namespace H264Settings { } export enum H265AdaptiveQuantization { + AUTO = "AUTO", HIGH = "HIGH", HIGHER = "HIGHER", LOW = "LOW", @@ -1341,7 +1484,7 @@ export enum H265WriteMp4PackagingType { */ export interface H265Settings { /** - * Specify the strength of any adaptive quantization filters that you enable. The value that you choose here applies to the following settings: Flicker adaptive quantization (flickerAdaptiveQuantization), Spatial adaptive quantization (spatialAdaptiveQuantization), and Temporal adaptive quantization (temporalAdaptiveQuantization). + * When you set Adaptive Quantization (H265AdaptiveQuantization) to Auto (AUTO), or leave blank, MediaConvert automatically applies quantization to improve the video quality of your output. Set Adaptive Quantization to Low (LOW), Medium (MEDIUM), High (HIGH), Higher (HIGHER), or Max (MAX) to manually control the strength of the quantization filter. When you do, you can specify a value for Spatial Adaptive Quantization (H265SpatialAdaptiveQuantization), Temporal Adaptive Quantization (H265TemporalAdaptiveQuantization), and Flicker Adaptive Quantization (H265FlickerAdaptiveQuantization), to further control the quantization filter. Set Adaptive Quantization to Off (OFF) to apply no quantization to your output. */ AdaptiveQuantization?: H265AdaptiveQuantization | string; @@ -5298,138 +5441,3 @@ export namespace TagResourceResponse { ...obj, }); } - -export interface UntagResourceRequest { - /** - * The Amazon Resource Name (ARN) of the resource that you want to remove tags from. To get the ARN, send a GET request with the resource name. - */ - Arn: string | undefined; - - /** - * The keys of the tags that you want to remove from the resource. - */ - TagKeys?: string[]; -} - -export namespace UntagResourceRequest { - /** - * @internal - */ - export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({ - ...obj, - }); -} - -export interface UntagResourceResponse {} - -export namespace UntagResourceResponse { - /** - * @internal - */ - export const filterSensitiveLog = (obj: UntagResourceResponse): any => ({ - ...obj, - }); -} - -export interface UpdateJobTemplateRequest { - /** - * Accelerated transcoding can significantly speed up jobs with long, visually complex content. Outputs that use this feature incur pro-tier pricing. For information about feature limitations, see the AWS Elemental MediaConvert User Guide. - */ - AccelerationSettings?: AccelerationSettings; - - /** - * The new category for the job template, if you are changing it. - */ - Category?: string; - - /** - * The new description for the job template, if you are changing it. - */ - Description?: string; - - /** - * Optional list of hop destinations. - */ - HopDestinations?: HopDestination[]; - - /** - * The name of the job template you are modifying - */ - Name: string | undefined; - - /** - * Specify the relative priority for this job. In any given queue, the service begins processing the job with the highest value first. When more than one job has the same priority, the service begins processing the job that you submitted first. If you don't specify a priority, the service uses the default value 0. - */ - Priority?: number; - - /** - * The new queue for the job template, if you are changing it. - */ - Queue?: string; - - /** - * JobTemplateSettings contains all the transcode settings saved in the template that will be applied to jobs created from it. - */ - Settings?: JobTemplateSettings; - - /** - * Specify how often MediaConvert sends STATUS_UPDATE events to Amazon CloudWatch Events. Set the interval, in seconds, between status updates. MediaConvert sends an update at this interval from the time the service begins processing your job to the time it completes the transcode or encounters an error. - */ - StatusUpdateInterval?: StatusUpdateInterval | string; -} - -export namespace UpdateJobTemplateRequest { - /** - * @internal - */ - export const filterSensitiveLog = (obj: UpdateJobTemplateRequest): any => ({ - ...obj, - }); -} - -export interface UpdateJobTemplateResponse { - /** - * A job template is a pre-made set of encoding instructions that you can use to quickly create a job. - */ - JobTemplate?: JobTemplate; -} - -export namespace UpdateJobTemplateResponse { - /** - * @internal - */ - export const filterSensitiveLog = (obj: UpdateJobTemplateResponse): any => ({ - ...obj, - }); -} - -export interface UpdatePresetRequest { - /** - * The new category for the preset, if you are changing it. - */ - Category?: string; - - /** - * The new description for the preset, if you are changing it. - */ - Description?: string; - - /** - * The name of the preset you are modifying. - */ - Name: string | undefined; - - /** - * Settings for preset - */ - Settings?: PresetSettings; -} - -export namespace UpdatePresetRequest { - /** - * @internal - */ - export const filterSensitiveLog = (obj: UpdatePresetRequest): any => ({ - ...obj, - }); -} diff --git a/clients/client-mediaconvert/src/models/models_2.ts b/clients/client-mediaconvert/src/models/models_2.ts index 3ba77801188f3..fd16b38cf8c89 100644 --- a/clients/client-mediaconvert/src/models/models_2.ts +++ b/clients/client-mediaconvert/src/models/models_2.ts @@ -1,4 +1,149 @@ -import { Preset, Queue, QueueStatus, ReservationPlanSettings } from "./models_1"; +import { AccelerationSettings, HopDestination } from "./models_0"; +import { + JobTemplate, + JobTemplateSettings, + Preset, + PresetSettings, + Queue, + QueueStatus, + ReservationPlanSettings, + StatusUpdateInterval, +} from "./models_1"; + +export interface UntagResourceRequest { + /** + * The Amazon Resource Name (ARN) of the resource that you want to remove tags from. To get the ARN, send a GET request with the resource name. + */ + Arn: string | undefined; + + /** + * The keys of the tags that you want to remove from the resource. + */ + TagKeys?: string[]; +} + +export namespace UntagResourceRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({ + ...obj, + }); +} + +export interface UntagResourceResponse {} + +export namespace UntagResourceResponse { + /** + * @internal + */ + export const filterSensitiveLog = (obj: UntagResourceResponse): any => ({ + ...obj, + }); +} + +export interface UpdateJobTemplateRequest { + /** + * Accelerated transcoding can significantly speed up jobs with long, visually complex content. Outputs that use this feature incur pro-tier pricing. For information about feature limitations, see the AWS Elemental MediaConvert User Guide. + */ + AccelerationSettings?: AccelerationSettings; + + /** + * The new category for the job template, if you are changing it. + */ + Category?: string; + + /** + * The new description for the job template, if you are changing it. + */ + Description?: string; + + /** + * Optional list of hop destinations. + */ + HopDestinations?: HopDestination[]; + + /** + * The name of the job template you are modifying + */ + Name: string | undefined; + + /** + * Specify the relative priority for this job. In any given queue, the service begins processing the job with the highest value first. When more than one job has the same priority, the service begins processing the job that you submitted first. If you don't specify a priority, the service uses the default value 0. + */ + Priority?: number; + + /** + * The new queue for the job template, if you are changing it. + */ + Queue?: string; + + /** + * JobTemplateSettings contains all the transcode settings saved in the template that will be applied to jobs created from it. + */ + Settings?: JobTemplateSettings; + + /** + * Specify how often MediaConvert sends STATUS_UPDATE events to Amazon CloudWatch Events. Set the interval, in seconds, between status updates. MediaConvert sends an update at this interval from the time the service begins processing your job to the time it completes the transcode or encounters an error. + */ + StatusUpdateInterval?: StatusUpdateInterval | string; +} + +export namespace UpdateJobTemplateRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: UpdateJobTemplateRequest): any => ({ + ...obj, + }); +} + +export interface UpdateJobTemplateResponse { + /** + * A job template is a pre-made set of encoding instructions that you can use to quickly create a job. + */ + JobTemplate?: JobTemplate; +} + +export namespace UpdateJobTemplateResponse { + /** + * @internal + */ + export const filterSensitiveLog = (obj: UpdateJobTemplateResponse): any => ({ + ...obj, + }); +} + +export interface UpdatePresetRequest { + /** + * The new category for the preset, if you are changing it. + */ + Category?: string; + + /** + * The new description for the preset, if you are changing it. + */ + Description?: string; + + /** + * The name of the preset you are modifying. + */ + Name: string | undefined; + + /** + * Settings for preset + */ + Settings?: PresetSettings; +} + +export namespace UpdatePresetRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: UpdatePresetRequest): any => ({ + ...obj, + }); +} export interface UpdatePresetResponse { /** diff --git a/clients/client-mediaconvert/src/protocols/Aws_restJson1.ts b/clients/client-mediaconvert/src/protocols/Aws_restJson1.ts index 34eb62ad7520c..cd6435817ec89 100644 --- a/clients/client-mediaconvert/src/protocols/Aws_restJson1.ts +++ b/clients/client-mediaconvert/src/protocols/Aws_restJson1.ts @@ -127,7 +127,6 @@ import { KantarWatermarkSettings, M2tsScte35Esam, M2tsSettings, - M3u8Settings, MotionImageInserter, MotionImageInsertionFramerate, MotionImageInsertionOffset, @@ -191,6 +190,7 @@ import { JobSettings, JobTemplate, JobTemplateSettings, + M3u8Settings, MovSettings, Mp4Settings, MpdSettings, @@ -4476,6 +4476,7 @@ const serializeAws_restJson1Av1Settings = (input: Av1Settings, context: __SerdeC return { ...(input.AdaptiveQuantization !== undefined && input.AdaptiveQuantization !== null && { adaptiveQuantization: input.AdaptiveQuantization }), + ...(input.BitDepth !== undefined && input.BitDepth !== null && { bitDepth: input.BitDepth }), ...(input.FramerateControl !== undefined && input.FramerateControl !== null && { framerateControl: input.FramerateControl }), ...(input.FramerateConversionAlgorithm !== undefined && @@ -4865,6 +4866,7 @@ const serializeAws_restJson1CmfcSettings = (input: CmfcSettings, context: __Serd input.IFrameOnlyManifest !== null && { iFrameOnlyManifest: input.IFrameOnlyManifest }), ...(input.Scte35Esam !== undefined && input.Scte35Esam !== null && { scte35Esam: input.Scte35Esam }), ...(input.Scte35Source !== undefined && input.Scte35Source !== null && { scte35Source: input.Scte35Source }), + ...(input.TimedMetadata !== undefined && input.TimedMetadata !== null && { timedMetadata: input.TimedMetadata }), }; }; @@ -5715,6 +5717,7 @@ const serializeAws_restJson1ImscDestinationSettings = ( context: __SerdeContext ): any => { return { + ...(input.Accessibility !== undefined && input.Accessibility !== null && { accessibility: input.Accessibility }), ...(input.StylePassthrough !== undefined && input.StylePassthrough !== null && { stylePassthrough: input.StylePassthrough }), }; @@ -5742,6 +5745,8 @@ const serializeAws_restJson1Input = (input: Input, context: __SerdeContext): any decryptionSettings: serializeAws_restJson1InputDecryptionSettings(input.DecryptionSettings, context), }), ...(input.DenoiseFilter !== undefined && input.DenoiseFilter !== null && { denoiseFilter: input.DenoiseFilter }), + ...(input.DolbyVisionMetadataXml !== undefined && + input.DolbyVisionMetadataXml !== null && { dolbyVisionMetadataXml: input.DolbyVisionMetadataXml }), ...(input.FileInput !== undefined && input.FileInput !== null && { fileInput: input.FileInput }), ...(input.FilterEnable !== undefined && input.FilterEnable !== null && { filterEnable: input.FilterEnable }), ...(input.FilterStrength !== undefined && @@ -5813,6 +5818,8 @@ const serializeAws_restJson1InputTemplate = (input: InputTemplate, context: __Se input.Crop !== null && { crop: serializeAws_restJson1Rectangle(input.Crop, context) }), ...(input.DeblockFilter !== undefined && input.DeblockFilter !== null && { deblockFilter: input.DeblockFilter }), ...(input.DenoiseFilter !== undefined && input.DenoiseFilter !== null && { denoiseFilter: input.DenoiseFilter }), + ...(input.DolbyVisionMetadataXml !== undefined && + input.DolbyVisionMetadataXml !== null && { dolbyVisionMetadataXml: input.DolbyVisionMetadataXml }), ...(input.FilterEnable !== undefined && input.FilterEnable !== null && { filterEnable: input.FilterEnable }), ...(input.FilterStrength !== undefined && input.FilterStrength !== null && { filterStrength: input.FilterStrength }), @@ -6183,6 +6190,7 @@ const serializeAws_restJson1MpdSettings = (input: MpdSettings, context: __SerdeC input.CaptionContainerType !== null && { captionContainerType: input.CaptionContainerType }), ...(input.Scte35Esam !== undefined && input.Scte35Esam !== null && { scte35Esam: input.Scte35Esam }), ...(input.Scte35Source !== undefined && input.Scte35Source !== null && { scte35Source: input.Scte35Source }), + ...(input.TimedMetadata !== undefined && input.TimedMetadata !== null && { timedMetadata: input.TimedMetadata }), }; }; @@ -6999,6 +7007,7 @@ const serializeAws_restJson1WebvttDestinationSettings = ( context: __SerdeContext ): any => { return { + ...(input.Accessibility !== undefined && input.Accessibility !== null && { accessibility: input.Accessibility }), ...(input.StylePassthrough !== undefined && input.StylePassthrough !== null && { stylePassthrough: input.StylePassthrough }), }; @@ -7847,6 +7856,7 @@ const deserializeAws_restJson1Av1QvbrSettings = (output: any, context: __SerdeCo const deserializeAws_restJson1Av1Settings = (output: any, context: __SerdeContext): Av1Settings => { return { AdaptiveQuantization: __expectString(output.adaptiveQuantization), + BitDepth: __expectString(output.bitDepth), FramerateControl: __expectString(output.framerateControl), FramerateConversionAlgorithm: __expectString(output.framerateConversionAlgorithm), FramerateDenominator: __expectInt32(output.framerateDenominator), @@ -8158,6 +8168,7 @@ const deserializeAws_restJson1CmfcSettings = (output: any, context: __SerdeConte IFrameOnlyManifest: __expectString(output.iFrameOnlyManifest), Scte35Esam: __expectString(output.scte35Esam), Scte35Source: __expectString(output.scte35Source), + TimedMetadata: __expectString(output.timedMetadata), } as any; }; @@ -8842,6 +8853,7 @@ const deserializeAws_restJson1ImscDestinationSettings = ( context: __SerdeContext ): ImscDestinationSettings => { return { + Accessibility: __expectString(output.accessibility), StylePassthrough: __expectString(output.stylePassthrough), } as any; }; @@ -8870,6 +8882,7 @@ const deserializeAws_restJson1Input = (output: any, context: __SerdeContext): In ? deserializeAws_restJson1InputDecryptionSettings(output.decryptionSettings, context) : undefined, DenoiseFilter: __expectString(output.denoiseFilter), + DolbyVisionMetadataXml: __expectString(output.dolbyVisionMetadataXml), FileInput: __expectString(output.fileInput), FilterEnable: __expectString(output.filterEnable), FilterStrength: __expectInt32(output.filterStrength), @@ -8940,6 +8953,7 @@ const deserializeAws_restJson1InputTemplate = (output: any, context: __SerdeCont : undefined, DeblockFilter: __expectString(output.deblockFilter), DenoiseFilter: __expectString(output.denoiseFilter), + DolbyVisionMetadataXml: __expectString(output.dolbyVisionMetadataXml), FilterEnable: __expectString(output.filterEnable), FilterStrength: __expectInt32(output.filterStrength), ImageInserter: @@ -9383,6 +9397,7 @@ const deserializeAws_restJson1MpdSettings = (output: any, context: __SerdeContex CaptionContainerType: __expectString(output.captionContainerType), Scte35Esam: __expectString(output.scte35Esam), Scte35Source: __expectString(output.scte35Source), + TimedMetadata: __expectString(output.timedMetadata), } as any; }; @@ -10251,6 +10266,7 @@ const deserializeAws_restJson1WebvttDestinationSettings = ( context: __SerdeContext ): WebvttDestinationSettings => { return { + Accessibility: __expectString(output.accessibility), StylePassthrough: __expectString(output.stylePassthrough), } as any; }; diff --git a/clients/client-mediatailor/src/models/models_0.ts b/clients/client-mediatailor/src/models/models_0.ts index 9ba3d89b3950c..85f2b967df9b9 100644 --- a/clients/client-mediatailor/src/models/models_0.ts +++ b/clients/client-mediatailor/src/models/models_0.ts @@ -834,6 +834,20 @@ export namespace ScheduleEntry { }); } +export interface SegmentDeliveryConfiguration { + BaseUrl?: string; + Name?: string; +} + +export namespace SegmentDeliveryConfiguration { + /** + * @internal + */ + export const filterSensitiveLog = (obj: SegmentDeliveryConfiguration): any => ({ + ...obj, + }); +} + export enum AccessType { S3_SIGV4 = "S3_SIGV4", SECRETS_MANAGER_ACCESS_TOKEN = "SECRETS_MANAGER_ACCESS_TOKEN", @@ -964,6 +978,7 @@ export interface SourceLocation { */ LastModifiedTime?: Date; + SegmentDeliveryConfigurations?: SegmentDeliveryConfiguration[]; /** *The name of the source location.
*/ @@ -1500,6 +1515,7 @@ export interface CreateSourceLocationRequest { */ HttpConfiguration: HttpConfiguration | undefined; + SegmentDeliveryConfigurations?: SegmentDeliveryConfiguration[]; /** *The identifier for the source location you are working on.
*/ @@ -1551,6 +1567,7 @@ export interface CreateSourceLocationResponse { */ LastModifiedTime?: Date; + SegmentDeliveryConfigurations?: SegmentDeliveryConfiguration[]; /** *The name of the source location.
*/ @@ -2067,6 +2084,7 @@ export interface DescribeSourceLocationResponse { */ LastModifiedTime?: Date; + SegmentDeliveryConfigurations?: SegmentDeliveryConfiguration[]; /** *The name of the source location.
*/ @@ -3139,6 +3157,7 @@ export interface UpdateSourceLocationRequest { */ HttpConfiguration: HttpConfiguration | undefined; + SegmentDeliveryConfigurations?: SegmentDeliveryConfiguration[]; /** *The identifier for the source location you are working on.
*/ @@ -3185,6 +3204,7 @@ export interface UpdateSourceLocationResponse { */ LastModifiedTime?: Date; + SegmentDeliveryConfigurations?: SegmentDeliveryConfiguration[]; /** *The name of the source location.
*/ diff --git a/clients/client-mediatailor/src/protocols/Aws_restJson1.ts b/clients/client-mediatailor/src/protocols/Aws_restJson1.ts index 2fb29bd53cc5f..ac5ef16c0dd19 100644 --- a/clients/client-mediatailor/src/protocols/Aws_restJson1.ts +++ b/clients/client-mediatailor/src/protocols/Aws_restJson1.ts @@ -135,6 +135,7 @@ import { ScheduleConfiguration, ScheduleEntry, SecretsManagerAccessTokenConfiguration, + SegmentDeliveryConfiguration, SlateSource, SourceLocation, SpliceInsertMessage, @@ -347,6 +348,13 @@ export const serializeAws_restJson1CreateSourceLocationCommand = async ( input.HttpConfiguration !== null && { HttpConfiguration: serializeAws_restJson1HttpConfiguration(input.HttpConfiguration, context), }), + ...(input.SegmentDeliveryConfigurations !== undefined && + input.SegmentDeliveryConfigurations !== null && { + SegmentDeliveryConfigurations: serializeAws_restJson1__listOfSegmentDeliveryConfiguration( + input.SegmentDeliveryConfigurations, + context + ), + }), ...(input.Tags !== undefined && input.Tags !== null && { tags: serializeAws_restJson1__mapOf__string(input.Tags, context) }), }); @@ -1406,6 +1414,13 @@ export const serializeAws_restJson1UpdateSourceLocationCommand = async ( input.HttpConfiguration !== null && { HttpConfiguration: serializeAws_restJson1HttpConfiguration(input.HttpConfiguration, context), }), + ...(input.SegmentDeliveryConfigurations !== undefined && + input.SegmentDeliveryConfigurations !== null && { + SegmentDeliveryConfigurations: serializeAws_restJson1__listOfSegmentDeliveryConfiguration( + input.SegmentDeliveryConfigurations, + context + ), + }), }); return new __HttpRequest({ protocol, @@ -1755,6 +1770,7 @@ export const deserializeAws_restJson1CreateSourceLocationCommand = async ( DefaultSegmentDeliveryConfiguration: undefined, HttpConfiguration: undefined, LastModifiedTime: undefined, + SegmentDeliveryConfigurations: undefined, SourceLocationName: undefined, Tags: undefined, }; @@ -1780,6 +1796,12 @@ export const deserializeAws_restJson1CreateSourceLocationCommand = async ( if (data.LastModifiedTime !== undefined && data.LastModifiedTime !== null) { contents.LastModifiedTime = __expectNonNull(__parseEpochTimestamp(__expectNumber(data.LastModifiedTime))); } + if (data.SegmentDeliveryConfigurations !== undefined && data.SegmentDeliveryConfigurations !== null) { + contents.SegmentDeliveryConfigurations = deserializeAws_restJson1__listOfSegmentDeliveryConfiguration( + data.SegmentDeliveryConfigurations, + context + ); + } if (data.SourceLocationName !== undefined && data.SourceLocationName !== null) { contents.SourceLocationName = __expectString(data.SourceLocationName); } @@ -2362,6 +2384,7 @@ export const deserializeAws_restJson1DescribeSourceLocationCommand = async ( DefaultSegmentDeliveryConfiguration: undefined, HttpConfiguration: undefined, LastModifiedTime: undefined, + SegmentDeliveryConfigurations: undefined, SourceLocationName: undefined, Tags: undefined, }; @@ -2387,6 +2410,12 @@ export const deserializeAws_restJson1DescribeSourceLocationCommand = async ( if (data.LastModifiedTime !== undefined && data.LastModifiedTime !== null) { contents.LastModifiedTime = __expectNonNull(__parseEpochTimestamp(__expectNumber(data.LastModifiedTime))); } + if (data.SegmentDeliveryConfigurations !== undefined && data.SegmentDeliveryConfigurations !== null) { + contents.SegmentDeliveryConfigurations = deserializeAws_restJson1__listOfSegmentDeliveryConfiguration( + data.SegmentDeliveryConfigurations, + context + ); + } if (data.SourceLocationName !== undefined && data.SourceLocationName !== null) { contents.SourceLocationName = __expectString(data.SourceLocationName); } @@ -3606,6 +3635,7 @@ export const deserializeAws_restJson1UpdateSourceLocationCommand = async ( DefaultSegmentDeliveryConfiguration: undefined, HttpConfiguration: undefined, LastModifiedTime: undefined, + SegmentDeliveryConfigurations: undefined, SourceLocationName: undefined, Tags: undefined, }; @@ -3631,6 +3661,12 @@ export const deserializeAws_restJson1UpdateSourceLocationCommand = async ( if (data.LastModifiedTime !== undefined && data.LastModifiedTime !== null) { contents.LastModifiedTime = __expectNonNull(__parseEpochTimestamp(__expectNumber(data.LastModifiedTime))); } + if (data.SegmentDeliveryConfigurations !== undefined && data.SegmentDeliveryConfigurations !== null) { + contents.SegmentDeliveryConfigurations = deserializeAws_restJson1__listOfSegmentDeliveryConfiguration( + data.SegmentDeliveryConfigurations, + context + ); + } if (data.SourceLocationName !== undefined && data.SourceLocationName !== null) { contents.SourceLocationName = __expectString(data.SourceLocationName); } @@ -3785,6 +3821,20 @@ const serializeAws_restJson1__listOfAvailMatchingCriteria = ( }); }; +const serializeAws_restJson1__listOfSegmentDeliveryConfiguration = ( + input: SegmentDeliveryConfiguration[], + context: __SerdeContext +): any => { + return input + .filter((e: any) => e != null) + .map((entry) => { + if (entry === null) { + return null as any; + } + return serializeAws_restJson1SegmentDeliveryConfiguration(entry, context); + }); +}; + const serializeAws_restJson1__mapOf__string = (input: { [key: string]: string }, context: __SerdeContext): any => { return Object.entries(input).reduce((acc: { [key: string]: any }, [key, value]: [string, any]) => { if (value === null) { @@ -4046,6 +4096,16 @@ const serializeAws_restJson1SecretsManagerAccessTokenConfiguration = ( }; }; +const serializeAws_restJson1SegmentDeliveryConfiguration = ( + input: SegmentDeliveryConfiguration, + context: __SerdeContext +): any => { + return { + ...(input.BaseUrl !== undefined && input.BaseUrl !== null && { BaseUrl: input.BaseUrl }), + ...(input.Name !== undefined && input.Name !== null && { Name: input.Name }), + }; +}; + const serializeAws_restJson1SlateSource = (input: SlateSource, context: __SerdeContext): any => { return { ...(input.SourceLocationName !== undefined && @@ -4182,6 +4242,20 @@ const deserializeAws_restJson1__listOfScheduleEntry = (output: any, context: __S }); }; +const deserializeAws_restJson1__listOfSegmentDeliveryConfiguration = ( + output: any, + context: __SerdeContext +): SegmentDeliveryConfiguration[] => { + return (output || []) + .filter((e: any) => e != null) + .map((entry: any) => { + if (entry === null) { + return null as any; + } + return deserializeAws_restJson1SegmentDeliveryConfiguration(entry, context); + }); +}; + const deserializeAws_restJson1__listOfSourceLocation = (output: any, context: __SerdeContext): SourceLocation[] => { return (output || []) .filter((e: any) => e != null) @@ -4614,6 +4688,16 @@ const deserializeAws_restJson1SecretsManagerAccessTokenConfiguration = ( } as any; }; +const deserializeAws_restJson1SegmentDeliveryConfiguration = ( + output: any, + context: __SerdeContext +): SegmentDeliveryConfiguration => { + return { + BaseUrl: __expectString(output.BaseUrl), + Name: __expectString(output.Name), + } as any; +}; + const deserializeAws_restJson1SlateSource = (output: any, context: __SerdeContext): SlateSource => { return { SourceLocationName: __expectString(output.SourceLocationName), @@ -4647,6 +4731,10 @@ const deserializeAws_restJson1SourceLocation = (output: any, context: __SerdeCon output.LastModifiedTime !== undefined && output.LastModifiedTime !== null ? __expectNonNull(__parseEpochTimestamp(__expectNumber(output.LastModifiedTime))) : undefined, + SegmentDeliveryConfigurations: + output.SegmentDeliveryConfigurations !== undefined && output.SegmentDeliveryConfigurations !== null + ? deserializeAws_restJson1__listOfSegmentDeliveryConfiguration(output.SegmentDeliveryConfigurations, context) + : undefined, SourceLocationName: __expectString(output.SourceLocationName), Tags: output.tags !== undefined && output.tags !== null diff --git a/clients/client-nimble/src/Nimble.ts b/clients/client-nimble/src/Nimble.ts index 963cbef313a83..91afeaac6652a 100644 --- a/clients/client-nimble/src/Nimble.ts +++ b/clients/client-nimble/src/Nimble.ts @@ -876,7 +876,7 @@ export class Nimble extends NimbleClient { /** *Gets StreamingSession resource.
- *anvoke this operation to poll for a streaming session state while creating or deleting + *
Invoke this operation to poll for a streaming session state while creating or deleting * a session.
*/ public getStreamingSession( diff --git a/clients/client-nimble/src/commands/GetStreamingSessionCommand.ts b/clients/client-nimble/src/commands/GetStreamingSessionCommand.ts index fae345b09db09..c25457c460117 100644 --- a/clients/client-nimble/src/commands/GetStreamingSessionCommand.ts +++ b/clients/client-nimble/src/commands/GetStreamingSessionCommand.ts @@ -23,7 +23,7 @@ export interface GetStreamingSessionCommandOutput extends GetStreamingSessionRes /** *Gets StreamingSession resource.
- *anvoke this operation to poll for a streaming session state while creating or deleting + *
Invoke this operation to poll for a streaming session state while creating or deleting * a session.
* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-nimble/src/models/models_0.ts b/clients/client-nimble/src/models/models_0.ts index 3312f02d5bf17..5fd25750fd2b0 100644 --- a/clients/client-nimble/src/models/models_0.ts +++ b/clients/client-nimble/src/models/models_0.ts @@ -352,14 +352,12 @@ export enum StreamingSessionStorageMode { */ export interface StreamingSessionStorageRoot { /** - *The folder path in Linux workstations where files are uploaded. The default path is
- * $HOME/Downloads.
The folder path in Linux workstations where files are uploaded.
*/ linux?: string; /** - *The folder path in Windows workstations where files are uploaded. The default path is
- * %HOMEPATH%\Downloads.
The folder path in Windows workstations where files are uploaded.
*/ windows?: string; } @@ -435,13 +433,14 @@ export interface StreamConfigurationCreate { *Integer that determines if you can start and stop your sessions and how long a session * can stay in the STOPPED state. The default value is 0. The maximum value is 5760.
*If the value is missing or set to 0, your sessions can’t be stopped. If you then call - * StopStreamingSession, the session fails. If the time that a session stays in the READY - * state exceeds the maxSessionLengthInMinutes value, the session will automatically be - * terminated by AWS (instead of stopped).
+ *StopStreamingSession, the session fails. If the time that a session
+ * stays in the READY state exceeds the maxSessionLengthInMinutes value, the
+ * session will automatically be terminated by AWS (instead of stopped).
* If the value is set to a positive number, the session can be stopped. You can call - * StopStreamingSession to stop sessions in the READY state. If the time that a session - * stays in the READY state exceeds the maxSessionLengthInMinutes value, the session will - * automatically be stopped by AWS (instead of terminated).
+ *StopStreamingSession to stop sessions in the READY state. If the time
+ * that a session stays in the READY state exceeds the
+ * maxSessionLengthInMinutes value, the session will automatically be
+ * stopped by AWS (instead of terminated).
*/
maxStoppedSessionLengthInMinutes?: number;
@@ -592,13 +591,14 @@ export interface StreamConfiguration {
* Integer that determines if you can start and stop your sessions and how long a session * can stay in the STOPPED state. The default value is 0. The maximum value is 5760.
*If the value is missing or set to 0, your sessions can’t be stopped. If you then call - * StopStreamingSession, the session fails. If the time that a session stays in the READY - * state exceeds the maxSessionLengthInMinutes value, the session will automatically be - * terminated by AWS (instead of stopped).
+ *StopStreamingSession, the session fails. If the time that a session
+ * stays in the READY state exceeds the maxSessionLengthInMinutes value, the
+ * session will automatically be terminated by AWS (instead of stopped).
* If the value is set to a positive number, the session can be stopped. You can call - * StopStreamingSession to stop sessions in the READY state. If the time that a session - * stays in the READY state exceeds the maxSessionLengthInMinutes value, the session will - * automatically be stopped by AWS (instead of terminated).
+ *StopStreamingSession to stop sessions in the READY state. If the time
+ * that a session stays in the READY state exceeds the
+ * maxSessionLengthInMinutes value, the session will automatically be
+ * stopped by AWS (instead of terminated).
*/
maxStoppedSessionLengthInMinutes?: number;
@@ -620,6 +620,68 @@ export namespace StreamConfiguration {
});
}
+export enum LaunchProfileValidationState {
+ VALIDATION_FAILED = "VALIDATION_FAILED",
+ VALIDATION_FAILED_INTERNAL_SERVER_ERROR = "VALIDATION_FAILED_INTERNAL_SERVER_ERROR",
+ VALIDATION_IN_PROGRESS = "VALIDATION_IN_PROGRESS",
+ VALIDATION_NOT_STARTED = "VALIDATION_NOT_STARTED",
+ VALIDATION_SUCCESS = "VALIDATION_SUCCESS",
+}
+
+export enum LaunchProfileValidationStatusCode {
+ VALIDATION_FAILED_INTERNAL_SERVER_ERROR = "VALIDATION_FAILED_INTERNAL_SERVER_ERROR",
+ VALIDATION_FAILED_INVALID_ACTIVE_DIRECTORY = "VALIDATION_FAILED_INVALID_ACTIVE_DIRECTORY",
+ VALIDATION_FAILED_INVALID_SECURITY_GROUP_ASSOCIATION = "VALIDATION_FAILED_INVALID_SECURITY_GROUP_ASSOCIATION",
+ VALIDATION_FAILED_INVALID_SUBNET_ROUTE_TABLE_ASSOCIATION = "VALIDATION_FAILED_INVALID_SUBNET_ROUTE_TABLE_ASSOCIATION",
+ VALIDATION_FAILED_SUBNET_NOT_FOUND = "VALIDATION_FAILED_SUBNET_NOT_FOUND",
+ VALIDATION_FAILED_UNAUTHORIZED = "VALIDATION_FAILED_UNAUTHORIZED",
+ VALIDATION_IN_PROGRESS = "VALIDATION_IN_PROGRESS",
+ VALIDATION_NOT_STARTED = "VALIDATION_NOT_STARTED",
+ VALIDATION_SUCCESS = "VALIDATION_SUCCESS",
+}
+
+export enum LaunchProfileValidationType {
+ VALIDATE_ACTIVE_DIRECTORY_STUDIO_COMPONENT = "VALIDATE_ACTIVE_DIRECTORY_STUDIO_COMPONENT",
+ VALIDATE_NETWORK_ACL_ASSOCIATION = "VALIDATE_NETWORK_ACL_ASSOCIATION",
+ VALIDATE_SECURITY_GROUP_ASSOCIATION = "VALIDATE_SECURITY_GROUP_ASSOCIATION",
+ VALIDATE_SUBNET_ASSOCIATION = "VALIDATE_SUBNET_ASSOCIATION",
+}
+
+/**
+ * The launch profile validation result.
+ */ +export interface ValidationResult { + /** + *The type of the validation result.
+ */ + type: LaunchProfileValidationType | string | undefined; + + /** + *The current state.
+ */ + state: LaunchProfileValidationState | string | undefined; + + /** + *The status code. This will contain the failure reason if the state is
+ * VALIDATION_FAILED.
The status message for the validation result.
+ */ + statusMessage: string | undefined; +} + +export namespace ValidationResult { + /** + * @internal + */ + export const filterSensitiveLog = (obj: ValidationResult): any => ({ + ...obj, + }); +} + /** *A launch profile controls your artist workforce’s access to studio components, like * compute farms, shared file systems, managed file systems, and license server @@ -713,6 +775,11 @@ export interface LaunchProfile { *
The user ID of the user that most recently updated the resource.
*/ updatedBy?: string; + + /** + *The list of the latest validation results.
+ */ + validationResults?: ValidationResult[]; } export namespace LaunchProfile { @@ -968,7 +1035,9 @@ export interface CreateStreamingSessionRequest { launchProfileId?: string; /** - *The user ID of the user that owns the streaming session.
+ *The user ID of the user that owns the streaming session. The user that owns the + * session will be logging into the session and interacting with the virtual + * workstation.
*/ ownedBy?: string; @@ -1014,6 +1083,7 @@ export enum StreamingSessionState { export enum StreamingSessionStatusCode { ACTIVE_DIRECTORY_DOMAIN_JOIN_ERROR = "ACTIVE_DIRECTORY_DOMAIN_JOIN_ERROR", + AMI_VALIDATION_ERROR = "AMI_VALIDATION_ERROR", DECRYPT_STREAMING_IMAGE_ERROR = "DECRYPT_STREAMING_IMAGE_ERROR", INITIALIZATION_SCRIPT_ERROR = "INITIALIZATION_SCRIPT_ERROR", INSUFFICIENT_CAPACITY = "INSUFFICIENT_CAPACITY", @@ -1061,7 +1131,9 @@ export interface StreamingSession { launchProfileId?: string; /** - *The user ID of the user that owns the streaming session.
+ *The user ID of the user that owns the streaming session. The user that owns the + * session will be logging into the session and interacting with the virtual + * workstation.
*/ ownedBy?: string; @@ -1238,7 +1310,9 @@ export interface StreamingSessionStream { expiresAt?: Date; /** - *The user ID of the user that owns the streaming session.
+ *The user ID of the user that owns the streaming session. The user that owns the + * session will be logging into the session and interacting with the virtual + * workstation.
*/ ownedBy?: string; @@ -3259,7 +3333,7 @@ export interface ListLaunchProfilesRequest { /** *Filter this request to launch profiles in any of the given states.
*/ - states?: string[]; + states?: (LaunchProfileState | string)[]; /** *The studio ID.
@@ -3625,7 +3699,7 @@ export interface ListStudioComponentsRequest { /** *Filters the request to studio components that are in one of the given states.
*/ - states?: string[]; + states?: (StudioComponentState | string)[]; /** *The studio ID.
@@ -3635,7 +3709,7 @@ export interface ListStudioComponentsRequest { /** *Filters the request to studio components that are of one of the given types.
*/ - types?: string[]; + types?: (StudioComponentType | string)[]; } export namespace ListStudioComponentsRequest { diff --git a/clients/client-nimble/src/protocols/Aws_restJson1.ts b/clients/client-nimble/src/protocols/Aws_restJson1.ts index 7d849f145e181..a3726f78916db 100644 --- a/clients/client-nimble/src/protocols/Aws_restJson1.ts +++ b/clients/client-nimble/src/protocols/Aws_restJson1.ts @@ -190,6 +190,7 @@ import { StudioMembership, ThrottlingException, ValidationException, + ValidationResult, } from "../models/models_0"; export const serializeAws_restJson1AcceptEulasCommand = async ( @@ -7708,6 +7709,10 @@ const deserializeAws_restJson1LaunchProfile = (output: any, context: __SerdeCont ? __expectNonNull(__parseRfc3339DateTime(output.updatedAt)) : undefined, updatedBy: __expectString(output.updatedBy), + validationResults: + output.validationResults !== undefined && output.validationResults !== null + ? deserializeAws_restJson1ValidationResults(output.validationResults, context) + : undefined, } as any; }; @@ -8353,6 +8358,26 @@ const deserializeAws_restJson1Tags = (output: any, context: __SerdeContext): { [ }, {}); }; +const deserializeAws_restJson1ValidationResult = (output: any, context: __SerdeContext): ValidationResult => { + return { + state: __expectString(output.state), + statusCode: __expectString(output.statusCode), + statusMessage: __expectString(output.statusMessage), + type: __expectString(output.type), + } as any; +}; + +const deserializeAws_restJson1ValidationResults = (output: any, context: __SerdeContext): ValidationResult[] => { + return (output || []) + .filter((e: any) => e != null) + .map((entry: any) => { + if (entry === null) { + return null as any; + } + return deserializeAws_restJson1ValidationResult(entry, context); + }); +}; + const deserializeMetadata = (output: __HttpResponse): __ResponseMetadata => ({ httpStatusCode: output.statusCode, requestId: output.headers["x-amzn-requestid"] ?? output.headers["x-amzn-request-id"], diff --git a/clients/client-pi/README.md b/clients/client-pi/README.md index 684a10699013e..cfae539bb5ece 100644 --- a/clients/client-pi/README.md +++ b/clients/client-pi/README.md @@ -9,24 +9,29 @@ AWS SDK for JavaScript PI Client for Node.js, Browser and React Native.Amazon RDS Performance Insights enables you to monitor and explore different dimensions of -database load based on data captured from a running DB instance. The guide provides detailed -information about Performance Insights data types, parameters and errors.
- -When Performance Insights is enabled, the Amazon RDS Performance Insights API provides visibility into the performance of your DB instance. Amazon -CloudWatch provides the authoritative source for AWS service-vended monitoring metrics. Performance Insights offers a domain-specific -view of DB load.
-DB load is measured as Average Active Sessions. Performance Insights provides the data to API consumers as a two-dimensional -time-series dataset. The time dimension provides DB load data for each time point in the queried time range. Each time -point decomposes overall load in relation to the requested dimensions, measured at that time point. Examples include -SQL, Wait event, User, and Host.
+Amazon RDS Performance Insights enables you to monitor and explore different dimensions of database load based on +data captured from a running DB instance. The guide provides detailed information about Performance Insights +data types, parameters and errors. +
+ +When Performance Insights is enabled, the Amazon RDS Performance Insights API provides visibility into the performance of your DB instance. +Amazon CloudWatch provides the authoritative source for Amazon Web Services service-vended monitoring metrics. +Performance Insights offers a domain-specific view of DB load. +
+DB load is measured as average active sessions. Performance Insights provides the data to API consumers as a two-dimensional +time-series dataset. The time dimension provides DB load data for each time point in the +queried time range. Each time point decomposes overall load in relation to the requested dimensions, +measured at that time point. Examples include SQL, Wait event, User, and Host. +
To learn more about Performance Insights and Amazon Aurora DB instances, go to the Amazon Aurora User Guide.
+To learn more about Performance Insights and Amazon Aurora DB instances, go to the Amazon Aurora User Guide. +
To learn more about Performance Insights and Amazon RDS DB instances, go to the Amazon RDS User Guide.
+To learn more about Performance Insights and Amazon RDS DB instances, go to the Amazon RDS User Guide. +
Amazon RDS Performance Insights enables you to monitor and explore different dimensions of - * database load based on data captured from a running DB instance. The guide provides detailed - * information about Performance Insights data types, parameters and errors.
+ *Amazon RDS Performance Insights enables you to monitor and explore different dimensions of database load based on + * data captured from a running DB instance. The guide provides detailed information about Performance Insights + * data types, parameters and errors. + *
* - *When Performance Insights is enabled, the Amazon RDS Performance Insights API provides visibility into the performance of your DB instance. Amazon - * CloudWatch provides the authoritative source for AWS service-vended monitoring metrics. Performance Insights offers a domain-specific - * view of DB load.
- *DB load is measured as Average Active Sessions. Performance Insights provides the data to API consumers as a two-dimensional - * time-series dataset. The time dimension provides DB load data for each time point in the queried time range. Each time - * point decomposes overall load in relation to the requested dimensions, measured at that time point. Examples include - * SQL, Wait event, User, and Host.
+ *When Performance Insights is enabled, the Amazon RDS Performance Insights API provides visibility into the performance of your DB instance. + * Amazon CloudWatch provides the authoritative source for Amazon Web Services service-vended monitoring metrics. + * Performance Insights offers a domain-specific view of DB load. + *
+ *DB load is measured as average active sessions. Performance Insights provides the data to API consumers as a two-dimensional + * time-series dataset. The time dimension provides DB load data for each time point in the + * queried time range. Each time point decomposes overall load in relation to the requested dimensions, + * measured at that time point. Examples include SQL, Wait event, User, and Host. + *
* *To learn more about Performance Insights and Amazon Aurora DB instances, go to the Amazon Aurora User Guide.
+ *To learn more about Performance Insights and Amazon Aurora DB instances, go to the Amazon Aurora User Guide. + *
*To learn more about Performance Insights and Amazon RDS DB instances, go to the Amazon RDS User Guide.
+ *To learn more about Performance Insights and Amazon RDS DB instances, go to the Amazon RDS User Guide. + *
*For a specific time period, retrieve the top N dimension keys for a
- * metric.
For a specific time period, retrieve the top N dimension keys for a metric.
+ *
Each response element returns a maximum of 500 bytes. For larger elements, such as SQL statements, * only the first 500 bytes are returned.
@@ -80,10 +100,11 @@ export class PI extends PIClient { } /** - *Get the attributes of the specified dimension group for a DB instance or data source. For example, if you specify a
- * SQL ID, GetDimensionKeyDetails retrieves the full text of the dimension db.sql.statement
- * associated with this ID. This operation is useful because GetResourceMetrics and
- * DescribeDimensionKeys don't support retrieval of large SQL statement text.
Get the attributes of the specified dimension group for a DB instance or data source.
+ * For example, if you specify a SQL ID, GetDimensionKeyDetails retrieves
+ * the full text of the dimension db.sql.statementcassociated with this ID.
+ * This operation is useful because GetResourceMetrics and DescribeDimensionKeys
+ * don't support retrieval of large SQL statement text.
Retrieve the metadata for different features. For example, the metadata might indicate + * that a feature is turned on or off on a specific DB instance. + *
+ */ + public getResourceMetadata( + args: GetResourceMetadataCommandInput, + options?: __HttpHandlerOptions + ): PromiseRetrieve Performance Insights metrics for a set of data sources, over a time period. You can provide * specific dimension groups and dimensions, and provide aggregation and filtering criteria for @@ -151,4 +206,69 @@ export class PI extends PIClient { return this.send(command, optionsOrCb); } } + + /** + *
Retrieve the dimensions that can be queried for each specified metric type on a specified DB instance.
+ */ + public listAvailableResourceDimensions( + args: ListAvailableResourceDimensionsCommandInput, + options?: __HttpHandlerOptions + ): PromiseRetrieve metrics of the specified types that can be queried for a specified DB instance. + *
+ */ + public listAvailableResourceMetrics( + args: ListAvailableResourceMetricsCommandInput, + options?: __HttpHandlerOptions + ): PromiseAmazon RDS Performance Insights enables you to monitor and explore different dimensions of - * database load based on data captured from a running DB instance. The guide provides detailed - * information about Performance Insights data types, parameters and errors.
+ *Amazon RDS Performance Insights enables you to monitor and explore different dimensions of database load based on + * data captured from a running DB instance. The guide provides detailed information about Performance Insights + * data types, parameters and errors. + *
* - *When Performance Insights is enabled, the Amazon RDS Performance Insights API provides visibility into the performance of your DB instance. Amazon - * CloudWatch provides the authoritative source for AWS service-vended monitoring metrics. Performance Insights offers a domain-specific - * view of DB load.
- *DB load is measured as Average Active Sessions. Performance Insights provides the data to API consumers as a two-dimensional - * time-series dataset. The time dimension provides DB load data for each time point in the queried time range. Each time - * point decomposes overall load in relation to the requested dimensions, measured at that time point. Examples include - * SQL, Wait event, User, and Host.
+ *When Performance Insights is enabled, the Amazon RDS Performance Insights API provides visibility into the performance of your DB instance. + * Amazon CloudWatch provides the authoritative source for Amazon Web Services service-vended monitoring metrics. + * Performance Insights offers a domain-specific view of DB load. + *
+ *DB load is measured as average active sessions. Performance Insights provides the data to API consumers as a two-dimensional + * time-series dataset. The time dimension provides DB load data for each time point in the + * queried time range. Each time point decomposes overall load in relation to the requested dimensions, + * measured at that time point. Examples include SQL, Wait event, User, and Host. + *
* *To learn more about Performance Insights and Amazon Aurora DB instances, go to the Amazon Aurora User Guide.
+ *To learn more about Performance Insights and Amazon Aurora DB instances, go to the Amazon Aurora User Guide. + *
*To learn more about Performance Insights and Amazon RDS DB instances, go to the Amazon RDS User Guide.
+ *To learn more about Performance Insights and Amazon RDS DB instances, go to the Amazon RDS User Guide. + *
*For a specific time period, retrieve the top N dimension keys for a
- * metric.
For a specific time period, retrieve the top N dimension keys for a metric.
+ *
Each response element returns a maximum of 500 bytes. For larger elements, such as SQL statements, * only the first 500 bytes are returned.
diff --git a/clients/client-pi/src/commands/GetDimensionKeyDetailsCommand.ts b/clients/client-pi/src/commands/GetDimensionKeyDetailsCommand.ts index c45e1843c7757..a429ba5762573 100644 --- a/clients/client-pi/src/commands/GetDimensionKeyDetailsCommand.ts +++ b/clients/client-pi/src/commands/GetDimensionKeyDetailsCommand.ts @@ -22,10 +22,11 @@ export interface GetDimensionKeyDetailsCommandInput extends GetDimensionKeyDetai export interface GetDimensionKeyDetailsCommandOutput extends GetDimensionKeyDetailsResponse, __MetadataBearer {} /** - *Get the attributes of the specified dimension group for a DB instance or data source. For example, if you specify a
- * SQL ID, GetDimensionKeyDetails retrieves the full text of the dimension db.sql.statement
- * associated with this ID. This operation is useful because GetResourceMetrics and
- * DescribeDimensionKeys don't support retrieval of large SQL statement text.
Get the attributes of the specified dimension group for a DB instance or data source.
+ * For example, if you specify a SQL ID, GetDimensionKeyDetails retrieves
+ * the full text of the dimension db.sql.statementcassociated with this ID.
+ * This operation is useful because GetResourceMetrics and DescribeDimensionKeys
+ * don't support retrieval of large SQL statement text.
Retrieve the metadata for different features. For example, the metadata might indicate + * that a feature is turned on or off on a specific DB instance. + *
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PIClient, GetResourceMetadataCommand } from "@aws-sdk/client-pi"; // ES Modules import + * // const { PIClient, GetResourceMetadataCommand } = require("@aws-sdk/client-pi"); // CommonJS import + * const client = new PIClient(config); + * const command = new GetResourceMetadataCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetResourceMetadataCommandInput} for command's `input` shape. + * @see {@link GetResourceMetadataCommandOutput} for command's `response` shape. + * @see {@link PIClientResolvedConfig | config} for PIClient's `config` shape. + * + */ +export class GetResourceMetadataCommand extends $Command< + GetResourceMetadataCommandInput, + GetResourceMetadataCommandOutput, + PIClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + constructor(readonly input: GetResourceMetadataCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackRetrieve the dimensions that can be queried for each specified metric type on a specified DB instance.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PIClient, ListAvailableResourceDimensionsCommand } from "@aws-sdk/client-pi"; // ES Modules import + * // const { PIClient, ListAvailableResourceDimensionsCommand } = require("@aws-sdk/client-pi"); // CommonJS import + * const client = new PIClient(config); + * const command = new ListAvailableResourceDimensionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListAvailableResourceDimensionsCommandInput} for command's `input` shape. + * @see {@link ListAvailableResourceDimensionsCommandOutput} for command's `response` shape. + * @see {@link PIClientResolvedConfig | config} for PIClient's `config` shape. + * + */ +export class ListAvailableResourceDimensionsCommand extends $Command< + ListAvailableResourceDimensionsCommandInput, + ListAvailableResourceDimensionsCommandOutput, + PIClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + constructor(readonly input: ListAvailableResourceDimensionsCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackRetrieve metrics of the specified types that can be queried for a specified DB instance. + *
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PIClient, ListAvailableResourceMetricsCommand } from "@aws-sdk/client-pi"; // ES Modules import + * // const { PIClient, ListAvailableResourceMetricsCommand } = require("@aws-sdk/client-pi"); // CommonJS import + * const client = new PIClient(config); + * const command = new ListAvailableResourceMetricsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListAvailableResourceMetricsCommandInput} for command's `input` shape. + * @see {@link ListAvailableResourceMetricsCommandOutput} for command's `response` shape. + * @see {@link PIClientResolvedConfig | config} for PIClient's `config` shape. + * + */ +export class ListAvailableResourceMetricsCommand extends $Command< + ListAvailableResourceMetricsCommandInput, + ListAvailableResourceMetricsCommandOutput, + PIClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + constructor(readonly input: ListAvailableResourceMetricsCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStack
- * db - The name of the database to which the client is connected (only Aurora PostgreSQL, RDS
- * PostgreSQL, Aurora MySQL, RDS MySQL, and MariaDB)
db - The name of the database to which the client is connected (only Aurora PostgreSQL, Amazon RDS PostgreSQL,
+ * Aurora MySQL, Amazon RDS MySQL, and MariaDB)
*
- * db.application - The name of the application that is connected to the database (only Aurora
- * PostgreSQL and RDS PostgreSQL)
db.application - The name of the application that is connected to the database (only Aurora
+ * PostgreSQL and RDS PostgreSQL)
* @@ -55,7 +55,7 @@ export interface DimensionGroup { *
- * db.session_type - The type of the current session (only Aurora PostgreSQL and RDS PostgreSQL)
db.session_type - The type of the current session (only Aurora PostgreSQL and RDS PostgreSQL)
* @@ -90,8 +90,8 @@ export interface DimensionGroup { *
- * db.application.name - The name of the application that is connected to the database (only
- * Aurora PostgreSQL and RDS PostgreSQL)
db.application.name - The name of the application that is connected to the database (only
+ * Aurora PostgreSQL and RDS PostgreSQL)
* @@ -103,12 +103,12 @@ export interface DimensionGroup { *
- * db.name - The name of the database to which the client is connected (only Aurora
- * PostgreSQL, RDS PostgreSQL, Aurora MySQL, RDS MySQL, and MariaDB)
db.name - The name of the database to which the client is connected (only Aurora PostgreSQL, Amazon RDS
+ * PostgreSQL, Aurora MySQL, Amazon RDS MySQL, and MariaDB)
*
- * db.session_type.name - The type of the current session (only Aurora PostgreSQL and RDS PostgreSQL)
db.session_type.name - The type of the current session (only Aurora PostgreSQL and RDS PostgreSQL)
* @@ -180,31 +180,34 @@ export namespace DimensionGroup { } export enum ServiceType { + DOCDB = "DOCDB", RDS = "RDS", } export interface DescribeDimensionKeysRequest { /** - *
The AWS service for which Performance Insights will return metrics. The only valid value for ServiceType is
- * RDS.
The Amazon Web Services service for which Performance Insights will return metrics. The only valid value for
+ * ServiceType is RDS.
+ *
An immutable, AWS Region-unique identifier for a data source. Performance Insights gathers metrics from + *
An immutable, Amazon Web Services Region-unique identifier for a data source. Performance Insights gathers metrics from * this data source.
- *To use an Amazon RDS instance as a data source, you specify its DbiResourceId value. For example,
- * specify db-FAIHNTYBKTGAUSUZQYPDS2GW4A
- *
To use an Amazon RDS instance as a data source, you specify its DbiResourceId value.
+ * For example, specify db-FAIHNTYBKTGAUSUZQYPDS2GW4A.
+ *
The date and time specifying the beginning of the requested time series data. You must specify a
- * StartTime within the past 7 days. The value specified is inclusive, which means
- * that data points equal to or greater than StartTime are returned.
The value for StartTime must be earlier than the value for
- * EndTime.
StartTime within the past 7 days. The value specified is inclusive,
+ * which means that data points equal to or greater than StartTime are returned.
+ *
+ * The value for StartTime must be earlier than the value for EndTime.
+ *
- * db.load.avg - a scaled representation of the number of active sessions
- * for the database engine.
db.load.avg - a scaled representation of the number of active sessions for the database engine.
+ *
*
- * db.sampledload.avg - the raw number of active sessions for the
- * database engine.
db.sampledload.avg - the raw number of active sessions for the database engine.
+ *
* If the number of active sessions is less than an internal Performance Insights threshold, db.load.avg and db.sampledload.avg
- * are the same value. If the number of active sessions is greater than the internal threshold, Performance Insights samples the active sessions, with db.load.avg
- * showing the scaled values, db.sampledload.avg showing the raw values, and db.sampledload.avg less than db.load.avg.
- * For most use cases, you can query db.load.avg only.
If the number of active sessions is less than an internal Performance Insights threshold, db.load.avg
+ * and db.sampledload.avg are the same value. If the number of active sessions is greater than
+ * the internal threshold, Performance Insights samples the active sessions, with db.load.avg
+ * showing the scaled values, db.sampledload.avg showing the raw values, and
+ * db.sampledload.avg less than db.load.avg. For most use cases, you can
+ * query db.load.avg only.
+ *
The granularity, in seconds, of the data points returned from Performance Insights. A period can be as short as - * one second, or as long as one day (86400 seconds). Valid values are:
- * + * one second, or as long as one day (86400 seconds). Valid values are: + * *@@ -267,26 +273,40 @@ export interface DescribeDimensionKeysRequest { *
If you don't specify PeriodInSeconds, then Performance Insights chooses a value for you, with a goal of returning
- * roughly 100-200 data points in the response.
If you don't specify PeriodInSeconds, then Performance Insights chooses a value for you, with a
+ * goal of returning roughly 100-200 data points in the response.
+ *
A specification for how to aggregate the data points from a query result. You must specify a valid dimension group. - * Performance Insights returns all dimensions within this group, unless you provide the names of specific dimensions within this group. - * You can also request that Performance Insights return a limited number of values for a dimension.
+ *A specification for how to aggregate the data points from a query result. You must specify + * a valid dimension group. Performance Insights returns all dimensions within this group, unless you provide + * the names of specific dimensions within this group. You can also request that Performance Insights return + * a limited number of values for a dimension. + *
*/ GroupBy: DimensionGroup | undefined; /** - *For each dimension specified in
- * GroupBy, specify a secondary dimension to further subdivide the partition keys in the response.
Additional metrics for the top N dimension keys.
+ * If the specified dimension group in the GroupBy parameter is db.sql_tokenized, you can
+ * specify per-SQL metrics to get the values for the top N SQL digests. The response syntax is
+ * "AdditionalMetrics" : { "string" : "string" }.
+ *
For each dimension specified in GroupBy, specify a secondary dimension
+ * to further subdivide the partition keys in the response.
+ *
One or more filters to apply in the request. Restrictions:
+ *One or more filters to apply in the request. Restrictions:
*Any number of filters by the same dimension, as specified in the GroupBy or
@@ -300,18 +320,17 @@ export interface DescribeDimensionKeysRequest {
Filter?: { [key: string]: string };
/**
- *
The maximum number of items to return in the response.
- * If more items exist than the specified MaxRecords value, a pagination
- * token is included in the response so that the remaining
- * results can be retrieved.
+ *
The maximum number of items to return in the response. If more items exist than the
+ * specified MaxRecords value, a pagination token is included in the response
+ * so that the remaining results can be retrieved.
*
An optional pagination token provided by a previous request. If
- * this parameter is specified, the response includes only records beyond the token, up to the
- * value specified by MaxRecords.
An optional pagination token provided by a previous request. If this parameter is specified,
+ * the response includes only records beyond the token, up to the value specified by MaxRecords.
+ *
An array of descriptions and aggregated values for - * each dimension within a dimension group.
+ *An object that includes the requested dimension key values and aggregated metric values + * within a dimension group.
*/ export interface DimensionKeyDescription { /** @@ -336,10 +355,15 @@ export interface DimensionKeyDescription { Dimensions?: { [key: string]: string }; /** - *The aggregated metric value for the dimension(s), over the requested time range.
+ *The aggregated metric value for the dimensions, over the requested time range.
*/ Total?: number; + /** + *A map that contains the value for each additional metric.
+ */ + AdditionalMetrics?: { [key: string]: number }; + /** *If PartitionBy was specified, PartitionKeys contains the dimensions that were.
A dimension map that contains the dimension(s) for this partition.
+ *A dimension map that contains the dimensions for this partition.
*/ Dimensions: { [key: string]: string } | undefined; } @@ -379,20 +403,24 @@ export namespace ResponsePartitionKey { export interface DescribeDimensionKeysResponse { /** *The start time for the returned dimension keys, after alignment to a granular boundary (as
- * specified by PeriodInSeconds). AlignedStartTime will be less than or
- * equal to the value of the user-specified StartTime.
PeriodInSeconds). AlignedStartTime will be less than or
+ * equal to the value of the user-specified StartTime.
+ *
*/
AlignedStartTime?: Date;
/**
* The end time for the returned dimension keys, after alignment to a granular boundary (as
- * specified by PeriodInSeconds). AlignedEndTime will be greater than
- * or equal to the value of the user-specified Endtime.
PeriodInSeconds). AlignedEndTime will be greater than
+ * or equal to the value of the user-specified Endtime.
+ *
*/
AlignedEndTime?: Date;
/**
- * If PartitionBy was present in the request, PartitionKeys contains the breakdown of dimension keys by the specified partitions.
If PartitionBy was present in the request, PartitionKeys contains
+ * the breakdown of dimension keys by the specified partitions.
+ *
An optional pagination token provided by a previous request. If
- * this parameter is specified, the response includes only records beyond the token, up to the
- * value specified by MaxRecords.
A pagination token that indicates the response didn’t return all available records
+ * because MaxRecords was specified in the previous request. To get the
+ * remaining records, specify NextToken in a separate request with this value.
+ *
The information about a dimension.
+ */ +export interface DimensionDetail { + /** + *The identifier of a dimension.
+ */ + Identifier?: string; +} + +export namespace DimensionDetail { + /** + * @internal + */ + export const filterSensitiveLog = (obj: DimensionDetail): any => ({ + ...obj, + }); +} + +/** + *Information about dimensions within a dimension group.
+ */ +export interface DimensionGroupDetail { + /** + *The name of the dimension group.
+ */ + Group?: string; + + /** + *The dimensions within a dimension group.
+ */ + Dimensions?: DimensionDetail[]; +} + +export namespace DimensionGroupDetail { + /** + * @internal + */ + export const filterSensitiveLog = (obj: DimensionGroupDetail): any => ({ + ...obj, + }); +} + /** *An object that describes the details for a specified dimension.
*/ @@ -498,16 +570,75 @@ export namespace DimensionKeyDetail { }); } +export enum FeatureStatus { + DISABLED = "DISABLED", + DISABLED_PENDING_REBOOT = "DISABLED_PENDING_REBOOT", + ENABLED = "ENABLED", + ENABLED_PENDING_REBOOT = "ENABLED_PENDING_REBOOT", + UNKNOWN = "UNKNOWN", + UNSUPPORTED = "UNSUPPORTED", +} + +/** + *The metadata for a feature. For example, the metadata might indicate that a feature is + * turned on or off on a specific DB instance.
+ */ +export interface FeatureMetadata { + /** + *The status of the feature on the DB instance. Possible values include the following: + *
+ *
+ * ENABLED: the feature is enabled on the instance.
+ * DISABLED: the feature is disabled on the instance.
+ * UNSUPPORTED: the feature isn't supported on the instance.
+ * ENABLED_PENDING_REBOOT: the feature is enabled on the instance but requires
+ * a reboot to take effect.
+ * DISABLED_PENDING_REBOOT: the feature is disabled on the instance but requires
+ * a reboot to take effect.
+ * UNKNOWN: the feature status couldn't be determined.
The AWS service for which Performance Insights returns data. The only valid value is RDS.
The Amazon Web Services service for which Performance Insights returns data. The only valid value is RDS.
The ID for a data source from which to gather dimension data. This ID must be immutable and unique within an AWS
- * Region. When a DB instance is the data source, specify its DbiResourceId value. For example, specify
- * db-ABCDEFGHIJKLMNOPQRSTU1VW2X.
The ID for a data source from which to gather dimension data. This ID must be immutable and
+ * unique within an Amazon Web Services Region. When a DB instance is the data source, specify its
+ * DbiResourceId value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VW2X.
+ *
A list of dimensions to retrieve the detail data for within the given dimension group. For the dimension group
- * db.sql, specify either the full dimension name db.sql.statement or the short
- * dimension name statement. If you don't specify this parameter, Performance Insights returns all
- * dimension data within the specified dimension group.
A list of dimensions to retrieve the detail data for within the given dimension group.
+ * For the dimension group db.sql, specify either the full dimension name
+ * db.sql.statement or the short dimension name statement.
+ * If you don't specify this parameter, Performance Insights returns all
+ * dimension data within the specified dimension group.
+ *
The Amazon Web Services service for which Performance Insights returns metrics.
+ */ + ServiceType: ServiceType | string | undefined; + + /** + *An immutable identifier for a data source that is unique for an Amazon Web Services Region.
+ * Performance Insights gathers metrics from this data source. To use a DB instance as a data source,
+ * specify its DbiResourceId value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VW2X.
+ *
An immutable identifier for a data source that is unique for an Amazon Web Services Region.
+ *
+ * Performance Insights gathers metrics from this data source. To use a DB instance as a data source,
+ * specify its DbiResourceId value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VW2X.
+ *
The metadata for different features. For example, the metadata might indicate that a feature is + * turned on or off on a specific DB instance.
+ */ + Features?: { [key: string]: FeatureMetadata }; +} + +export namespace GetResourceMetadataResponse { + /** + * @internal + */ + export const filterSensitiveLog = (obj: GetResourceMetadataResponse): any => ({ + ...obj, + }); +} + /** *A single query to be processed. You must provide the metric to query. If no other
- * parameters are specified, Performance Insights returns all of the data points for that metric. You can
- * optionally request that the data points be aggregated by dimension group (
- * GroupBy), and return only those data points that match your criteria (Filter).
GroupBy), and return only
+ * those data points that match your criteria (Filter).
*/
export interface MetricQuery {
/**
@@ -620,13 +803,13 @@ export namespace MetricQuery {
export interface GetResourceMetricsRequest {
/**
- * The AWS service for which Performance Insights returns metrics. The only valid value for ServiceType is + *
The Amazon Web Services service for which Performance Insights returns metrics. The only valid value for ServiceType is
* RDS.
An immutable, AWS Region-unique identifier for a data source. Performance Insights gathers metrics from + *
An immutable, Amazon Web Services Region-unique identifier for a data source. Performance Insights gathers metrics from * this data source.
*To use a DB instance as a data source, specify its DbiResourceId value. For example, specify
* db-FAIHNTYBKTGAUSUZQYPDS2GW4A.
If the number of active sessions is less than an internal Performance Insights threshold, db.load.avg and db.sampledload.avg
- * are the same value. If the number of active sessions is greater than the internal threshold, Performance Insights samples the active sessions, with db.load.avg
- * showing the scaled values, db.sampledload.avg showing the raw values, and db.sampledload.avg less than db.load.avg.
- * For most use cases, you can query db.load.avg only.
If the number of active sessions is less than an internal Performance Insights threshold, db.load.avg and
+ * db.sampledload.avg are the same value. If the number of active sessions is greater than the
+ * internal threshold, Performance Insights samples the active sessions, with db.load.avg showing the scaled values,
+ * db.sampledload.avg showing the raw values, and db.sampledload.avg less
+ * than db.load.avg. For most use cases, you can query db.load.avg only.
+ *
The dimension(s) to which the data points apply.
+ *The dimensions to which the data points apply.
*/ Key?: ResponseResourceMetricKey; @@ -796,11 +981,11 @@ export interface GetResourceMetricsResponse { AlignedEndTime?: Date; /** - *An immutable, AWS Region-unique identifier for a data source. Performance Insights gathers metrics from - * this data source.
- *To use a DB instance as a data source, you specify its
- * DbiResourceId value - for example:
- * db-FAIHNTYBKTGAUSUZQYPDS2GW4A
+ *
An immutable, Amazon Web Services Region-unique identifier for a data source. Performance Insights gathers metrics from + * this data source. + *
+ *To use a DB instance as a data source, you specify its DbiResourceId value -
+ * for example: db-FAIHNTYBKTGAUSUZQYPDS2GW4A
*
An optional pagination token provided by a previous request. If
- * this parameter is specified, the response includes only records beyond the token, up to the
- * value specified by MaxRecords.
An optional pagination token provided by a previous request. If this parameter is specified,
+ * the response includes only records beyond the token, up to the value specified by MaxRecords.
+ *
The Amazon Web Services service for which Performance Insights returns metrics.
+ */ + ServiceType: ServiceType | string | undefined; + + /** + *An immutable identifier for a data source that is unique within an Amazon Web Services Region. Performance Insights gathers
+ * metrics from this data source. To use an Amazon RDS DB instance as a data source, specify its
+ * DbiResourceId value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VWZ.
The types of metrics for which to retrieve dimensions. Valid values include db.load.
The maximum number of items to return in the response. If more items exist than the specified
+ * MaxRecords value, a pagination token is included in the response so that the remaining
+ * results can be retrieved.
An optional pagination token provided by a previous request. If this parameter is specified,
+ * the response includes only records beyond the token, up to the value specified by MaxRecords.
+ *
The available dimension information for a metric type.
+ */ +export interface MetricDimensionGroups { + /** + *The metric type to which the dimension information belongs.
+ */ + Metric?: string; + + /** + *The available dimension groups for a metric type.
+ */ + Groups?: DimensionGroupDetail[]; +} + +export namespace MetricDimensionGroups { + /** + * @internal + */ + export const filterSensitiveLog = (obj: MetricDimensionGroups): any => ({ + ...obj, + }); +} + +export interface ListAvailableResourceDimensionsResponse { + /** + *The dimension information returned for requested metric types.
+ */ + MetricDimensions?: MetricDimensionGroups[]; + + /** + *An optional pagination token provided by a previous request. If this parameter is specified,
+ * the response includes only records beyond the token, up to the value specified by MaxRecords.
The Amazon Web Services service for which Performance Insights returns metrics.
+ */ + ServiceType: ServiceType | string | undefined; + + /** + *An immutable identifier for a data source that is unique within an Amazon Web Services Region. Performance Insights gathers
+ * metrics from this data source. To use an Amazon RDS DB instance as a data source, specify its
+ * DbiResourceId value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VWZ.
The types of metrics to return in the response. Valid values in the array include the following:
+ *
+ * os (OS counter metrics)
+ * db (DB load metrics)
+ * db.sql.stats (per-SQL metrics)
+ * db.sql_tokenized.stats (per-SQL digest metrics)
An optional pagination token provided by a previous request. If this parameter is specified,
+ * the response includes only records beyond the token, up to the value specified by MaxRecords.
+ *
The maximum number of items to return. If the MaxRecords value is less than the number of
+ * existing items, the response includes a pagination token.
+ *
An object that contains the full name, description, and unit of a metric. + *
+ */ +export interface ResponseResourceMetric { + /** + *The full name of the metric.
+ */ + Metric?: string; + + /** + *The description of the metric.
+ */ + Description?: string; + + /** + *The unit of the metric.
+ */ + Unit?: string; +} + +export namespace ResponseResourceMetric { + /** + * @internal + */ + export const filterSensitiveLog = (obj: ResponseResourceMetric): any => ({ + ...obj, + }); +} + +export interface ListAvailableResourceMetricsResponse { + /** + *An array of metrics available to query. Each array element contains the full name, + * description, and unit of the metric. + *
+ */ + Metrics?: ResponseResourceMetric[]; + + /** + *A pagination token that indicates the response didn’t return all available records
+ * because MaxRecords was specified in the previous request. To get the remaining
+ * records, specify NextToken in a separate request with this value.
+ *
The channel-specific configurations for the journey.
+ */ +export interface JourneyChannelSettings { + /** + *Amazon Resource Name (ARN) of the Connect Campaign.
+ */ + ConnectCampaignArn?: string; + + /** + *IAM role ARN to be assumed when invoking Connect campaign execution APIs for dialing.
+ */ + ConnectCampaignExecutionRoleArn?: string; +} + +export namespace JourneyChannelSettings { + /** + * @internal + */ + export const filterSensitiveLog = (obj: JourneyChannelSettings): any => ({ + ...obj, + }); +} + /** *Specifies limits on the messages that a journey can send and the number of times participants can enter a journey.
*/ @@ -4869,6 +4893,11 @@ export interface WriteJourneyRequest { *Specifies whether a journey should be refreshed on segment update.
*/ RefreshOnSegmentUpdate?: boolean; + + /** + *The channel-specific configurations for the journey.
+ */ + JourneyChannelSettings?: JourneyChannelSettings; } export namespace WriteJourneyRequest { @@ -4901,30 +4930,6 @@ export namespace CreateJourneyRequest { }); } -/** - *The channel-specific configurations for the journey.
- */ -export interface JourneyChannelSettings { - /** - *Amazon Resource Name (ARN) of the Connect Campaign.
- */ - ConnectCampaignArn?: string; - - /** - *IAM role ARN to be assumed when invoking Connect campaign execution APIs for dialing.
- */ - ConnectCampaignExecutionRoleArn?: string; -} - -export namespace JourneyChannelSettings { - /** - * @internal - */ - export const filterSensitiveLog = (obj: JourneyChannelSettings): any => ({ - ...obj, - }); -} - /** *Provides information about the status, configuration, and other settings for a journey.
*/ diff --git a/clients/client-pinpoint/src/protocols/Aws_restJson1.ts b/clients/client-pinpoint/src/protocols/Aws_restJson1.ts index 89be0634db9df..b3a2ed6796b57 100644 --- a/clients/client-pinpoint/src/protocols/Aws_restJson1.ts +++ b/clients/client-pinpoint/src/protocols/Aws_restJson1.ts @@ -17664,6 +17664,17 @@ const serializeAws_restJson1InAppTemplateRequest = (input: InAppTemplateRequest, }; }; +const serializeAws_restJson1JourneyChannelSettings = (input: JourneyChannelSettings, context: __SerdeContext): any => { + return { + ...(input.ConnectCampaignArn !== undefined && + input.ConnectCampaignArn !== null && { ConnectCampaignArn: input.ConnectCampaignArn }), + ...(input.ConnectCampaignExecutionRoleArn !== undefined && + input.ConnectCampaignExecutionRoleArn !== null && { + ConnectCampaignExecutionRoleArn: input.ConnectCampaignExecutionRoleArn, + }), + }; +}; + const serializeAws_restJson1JourneyCustomMessage = (input: JourneyCustomMessage, context: __SerdeContext): any => { return { ...(input.Data !== undefined && input.Data !== null && { Data: input.Data }), @@ -18700,6 +18711,10 @@ const serializeAws_restJson1WriteJourneyRequest = (input: WriteJourneyRequest, c ...(input.Activities !== undefined && input.Activities !== null && { Activities: serializeAws_restJson1MapOfActivity(input.Activities, context) }), ...(input.CreationDate !== undefined && input.CreationDate !== null && { CreationDate: input.CreationDate }), + ...(input.JourneyChannelSettings !== undefined && + input.JourneyChannelSettings !== null && { + JourneyChannelSettings: serializeAws_restJson1JourneyChannelSettings(input.JourneyChannelSettings, context), + }), ...(input.LastModifiedDate !== undefined && input.LastModifiedDate !== null && { LastModifiedDate: input.LastModifiedDate }), ...(input.Limits !== undefined && diff --git a/clients/client-ram/src/RAM.ts b/clients/client-ram/src/RAM.ts index b679dae9ebb3a..f206d8c443392 100644 --- a/clients/client-ram/src/RAM.ts +++ b/clients/client-ram/src/RAM.ts @@ -75,6 +75,11 @@ import { ListPermissionsCommandInput, ListPermissionsCommandOutput, } from "./commands/ListPermissionsCommand"; +import { + ListPermissionVersionsCommand, + ListPermissionVersionsCommandInput, + ListPermissionVersionsCommandOutput, +} from "./commands/ListPermissionVersionsCommand"; import { ListPrincipalsCommand, ListPrincipalsCommandInput, @@ -653,6 +658,38 @@ export class RAM extends RAMClient { } } + /** + *Lists the available versions of the specified RAM permission.
+ */ + public listPermissionVersions( + args: ListPermissionVersionsCommandInput, + options?: __HttpHandlerOptions + ): PromiseLists the principals that you are sharing resources with or that are sharing resources * with you.
diff --git a/clients/client-ram/src/RAMClient.ts b/clients/client-ram/src/RAMClient.ts index 13613306ffc40..714252c1855b7 100644 --- a/clients/client-ram/src/RAMClient.ts +++ b/clients/client-ram/src/RAMClient.ts @@ -101,6 +101,10 @@ import { ListPendingInvitationResourcesCommandOutput, } from "./commands/ListPendingInvitationResourcesCommand"; import { ListPermissionsCommandInput, ListPermissionsCommandOutput } from "./commands/ListPermissionsCommand"; +import { + ListPermissionVersionsCommandInput, + ListPermissionVersionsCommandOutput, +} from "./commands/ListPermissionVersionsCommand"; import { ListPrincipalsCommandInput, ListPrincipalsCommandOutput } from "./commands/ListPrincipalsCommand"; import { ListResourcesCommandInput, ListResourcesCommandOutput } from "./commands/ListResourcesCommand"; import { @@ -139,6 +143,7 @@ export type ServiceInputTypes = | GetResourceShareInvitationsCommandInput | GetResourceSharesCommandInput | ListPendingInvitationResourcesCommandInput + | ListPermissionVersionsCommandInput | ListPermissionsCommandInput | ListPrincipalsCommandInput | ListResourceSharePermissionsCommandInput @@ -165,6 +170,7 @@ export type ServiceOutputTypes = | GetResourceShareInvitationsCommandOutput | GetResourceSharesCommandOutput | ListPendingInvitationResourcesCommandOutput + | ListPermissionVersionsCommandOutput | ListPermissionsCommandOutput | ListPrincipalsCommandOutput | ListResourceSharePermissionsCommandOutput diff --git a/clients/client-ram/src/commands/ListPermissionVersionsCommand.ts b/clients/client-ram/src/commands/ListPermissionVersionsCommand.ts new file mode 100644 index 0000000000000..ba9c50cf8f268 --- /dev/null +++ b/clients/client-ram/src/commands/ListPermissionVersionsCommand.ts @@ -0,0 +1,95 @@ +import { getSerdePlugin } from "@aws-sdk/middleware-serde"; +import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@aws-sdk/protocol-http"; +import { Command as $Command } from "@aws-sdk/smithy-client"; +import { + FinalizeHandlerArguments, + Handler, + HandlerExecutionContext, + HttpHandlerOptions as __HttpHandlerOptions, + MetadataBearer as __MetadataBearer, + MiddlewareStack, + SerdeContext as __SerdeContext, +} from "@aws-sdk/types"; + +import { ListPermissionVersionsRequest, ListPermissionVersionsResponse } from "../models/models_0"; +import { + deserializeAws_restJson1ListPermissionVersionsCommand, + serializeAws_restJson1ListPermissionVersionsCommand, +} from "../protocols/Aws_restJson1"; +import { RAMClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RAMClient"; + +export interface ListPermissionVersionsCommandInput extends ListPermissionVersionsRequest {} +export interface ListPermissionVersionsCommandOutput extends ListPermissionVersionsResponse, __MetadataBearer {} + +/** + *Lists the available versions of the specified RAM permission.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RAMClient, ListPermissionVersionsCommand } from "@aws-sdk/client-ram"; // ES Modules import + * // const { RAMClient, ListPermissionVersionsCommand } = require("@aws-sdk/client-ram"); // CommonJS import + * const client = new RAMClient(config); + * const command = new ListPermissionVersionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListPermissionVersionsCommandInput} for command's `input` shape. + * @see {@link ListPermissionVersionsCommandOutput} for command's `response` shape. + * @see {@link RAMClientResolvedConfig | config} for RAMClient's `config` shape. + * + */ +export class ListPermissionVersionsCommand extends $Command< + ListPermissionVersionsCommandInput, + ListPermissionVersionsCommandOutput, + RAMClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + constructor(readonly input: ListPermissionVersionsCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackSpecifies the version of the RAM permission to associate with the resource share. If you don't - * specify this parameter, the operation uses the version designated as the default.
+ * specify this parameter, the operation uses the version designated as the default. You + * can use the ListPermissionVersions operation to discover the available + * versions of a permission. */ permissionVersion?: number; } @@ -1836,6 +1838,71 @@ export namespace ListPermissionsResponse { }); } +export interface ListPermissionVersionsRequest { + /** + *Specifies the Amazon Resoure Name (ARN) of the RAM permission whose versions you want to list. You
+ * can use the permissionVersion parameter on the AssociateResourceSharePermission operation to specify a non-default
+ * version to attach.
Specifies that you want to receive the next page of results. Valid
+ * only if you received a NextToken response in the previous request. If you
+ * did, it indicates that more output is available. Set this parameter to the value
+ * provided by the previous call's NextToken response to request the
+ * next page of results.
Specifies the total number of results that you want included on each page
+ * of the response. If you do not include this parameter, it defaults to a value that is
+ * specific to the operation. If additional items exist beyond the number you specify, the
+ * NextToken response element is returned with a value (not null).
+ * Include the specified value as the NextToken request parameter in the next
+ * call to the operation to get the next part of the results. Note that the service might
+ * return fewer results than the maximum even when there are more results available. You
+ * should check NextToken after every operation to ensure that you receive all
+ * of the results.
An array of objects that contain details for each of the available versions.
+ */ + permissions?: ResourceSharePermissionSummary[]; + + /** + *If present, this value indicates that more output is available than
+ * is included in the current response. Use this value in the NextToken
+ * request parameter in a subsequent call to the operation to get the next part of the
+ * output. You should repeat this until the NextToken response element comes
+ * back as null. This indicates that this is the last page of results.
Specifies that you want to list information for only resource shares that match the
diff --git a/clients/client-ram/src/pagination/ListPermissionVersionsPaginator.ts b/clients/client-ram/src/pagination/ListPermissionVersionsPaginator.ts
new file mode 100644
index 0000000000000..d3a22a6d2dd57
--- /dev/null
+++ b/clients/client-ram/src/pagination/ListPermissionVersionsPaginator.ts
@@ -0,0 +1,59 @@
+import { Paginator } from "@aws-sdk/types";
+
+import {
+ ListPermissionVersionsCommand,
+ ListPermissionVersionsCommandInput,
+ ListPermissionVersionsCommandOutput,
+} from "../commands/ListPermissionVersionsCommand";
+import { RAM } from "../RAM";
+import { RAMClient } from "../RAMClient";
+import { RAMPaginationConfiguration } from "./Interfaces";
+
+/**
+ * @private
+ */
+const makePagedClientRequest = async (
+ client: RAMClient,
+ input: ListPermissionVersionsCommandInput,
+ ...args: any
+): PromiseBackup.
If you specify both the SourceType and SourceIds, such as SourceType = db-instance
- * and SourceIdentifier = myDBInstance1, you are notified of all the db-instance events for
- * the specified source. If you specify a SourceType but do not specify a SourceIdentifier,
+ * and SourceIds = myDBInstance1, you are notified of all the db-instance events for
+ * the specified source. If you specify a SourceType but do not specify SourceIds,
* you receive notice of the events for that source type for all your RDS sources. If you
- * don't specify either the SourceType or the SourceIdentifier, you are notified of events
+ * don't specify either the SourceType or the SourceIds, you are notified of events
* generated from all RDS sources belonging to your customer account.
RDS event notification is only available for unencrypted SNS topics. If you specify an @@ -3675,10 +3675,13 @@ export class RDS extends RDSClient { /** *
Displays a list of categories for all event source types, or, if specified, for a specified source type. - * You can see a list of the event categories and source types - * in - * Events in the Amazon RDS User Guide. - *
+ * You can also see this list in the "Amazon RDS event categories and event messages" section of the + * Amazon RDS User Guide + * or the + * + * Amazon Aurora User Guide + * . + * */ public describeEventCategories( args: DescribeEventCategoriesCommandInput, @@ -3710,11 +3713,11 @@ export class RDS extends RDSClient { } /** - *Returns events related to DB instances, DB clusters, DB parameter groups, DB security groups, DB snapshots, and DB cluster snapshots for the past 14 days. - * Events specific to a particular DB instances, DB clusters, DB parameter groups, DB security groups, DB snapshots, and DB cluster snapshots group can be + *
Returns events related to DB instances, DB clusters, DB parameter groups, DB security groups, DB snapshots, DB cluster snapshots, and RDS Proxies for the past 14 days. + * Events specific to a particular DB instance, DB cluster, DB parameter group, DB security group, DB snapshot, DB cluster snapshot group, or RDS Proxy can be * obtained by providing the name as a parameter.
*By default, the past hour of events are returned.
+ *By default, RDS returns events that were generated in the past hour.
*Backup.
*
* If you specify both the SourceType and SourceIds, such as SourceType = db-instance
- * and SourceIdentifier = myDBInstance1, you are notified of all the db-instance events for
- * the specified source. If you specify a SourceType but do not specify a SourceIdentifier,
+ * and SourceIds = myDBInstance1, you are notified of all the db-instance events for
+ * the specified source. If you specify a SourceType but do not specify SourceIds,
* you receive notice of the events for that source type for all your RDS sources. If you
- * don't specify either the SourceType or the SourceIdentifier, you are notified of events
+ * don't specify either the SourceType or the SourceIds, you are notified of events
* generated from all RDS sources belonging to your customer account.
RDS event notification is only available for unencrypted SNS topics. If you specify an diff --git a/clients/client-rds/src/commands/DescribeEventCategoriesCommand.ts b/clients/client-rds/src/commands/DescribeEventCategoriesCommand.ts index 5dca992a2992f..560bf71bde7cc 100644 --- a/clients/client-rds/src/commands/DescribeEventCategoriesCommand.ts +++ b/clients/client-rds/src/commands/DescribeEventCategoriesCommand.ts @@ -23,10 +23,13 @@ export interface DescribeEventCategoriesCommandOutput extends EventCategoriesMes /** *
Displays a list of categories for all event source types, or, if specified, for a specified source type. - * You can see a list of the event categories and source types - * in - * Events in the Amazon RDS User Guide. - *
+ * You can also see this list in the "Amazon RDS event categories and event messages" section of the + * Amazon RDS User Guide + * or the + * + * Amazon Aurora User Guide + * . + * * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-rds/src/commands/DescribeEventsCommand.ts b/clients/client-rds/src/commands/DescribeEventsCommand.ts index a9bc7a6ee8739..1f6b956f76139 100644 --- a/clients/client-rds/src/commands/DescribeEventsCommand.ts +++ b/clients/client-rds/src/commands/DescribeEventsCommand.ts @@ -22,11 +22,11 @@ export interface DescribeEventsCommandInput extends DescribeEventsMessage {} export interface DescribeEventsCommandOutput extends EventsMessage, __MetadataBearer {} /** - *Returns events related to DB instances, DB clusters, DB parameter groups, DB security groups, DB snapshots, and DB cluster snapshots for the past 14 days. - * Events specific to a particular DB instances, DB clusters, DB parameter groups, DB security groups, DB snapshots, and DB cluster snapshots group can be + *
Returns events related to DB instances, DB clusters, DB parameter groups, DB security groups, DB snapshots, DB cluster snapshots, and RDS Proxies for the past 14 days. + * Events specific to a particular DB instance, DB cluster, DB parameter group, DB security group, DB snapshot, DB cluster snapshot group, or RDS Proxy can be * obtained by providing the name as a parameter.
*By default, the past hour of events are returned.
+ *By default, RDS returns events that were generated in the past hour.
*If the source type is a DB cluster snapshot, a DBClusterSnapshotIdentifier value must be supplied.
If the source type is an RDS Proxy, a DBProxyName value must be supplied.
The type of source that is generating the events. For example, if you want to be
* notified of events generated by a DB instance, you set this parameter to
- * db-instance. If this value isn't specified, all events are
+ * db-instance. For RDS Proxy events, specify db-proxy. If this value isn't specified, all events are
* returned.
Valid values: db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot
+ *
Valid values: db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot | db-proxy
*
A list of event categories for a particular source type (SourceType)
- * that you want to subscribe to. You can see a list of the categories for a given source
- * type in Events in the
- * Amazon RDS User Guide or by using the DescribeEventCategories operation.
DescribeEventCategories operation.
+ *
*/
EventCategories?: string[];
@@ -8950,6 +8958,9 @@ export interface CreateEventSubscriptionMessage {
* If the source type is a DB cluster snapshot, a DBClusterSnapshotIdentifier value must be supplied.
If the source type is an RDS Proxy, a DBProxyName value must be supplied.
The maximum size of the connection pool for each target in a target group. For Aurora MySQL, it is expressed as a percentage of the + *
The maximum size of the connection pool for each target in a target group. The value is expressed as a percentage of the
* max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group.
* Controls how actively the proxy closes idle database connections in the connection pool.
- * A high value enables the proxy to leave a high percentage of idle connections open.
- * A low value causes the proxy to close idle client connections and return the underlying database connections to the connection pool.
- * For Aurora MySQL, it is expressed as a percentage of the max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group.
+ * The value is expressed as a percentage of the max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group.
+ * With a high value, the proxy leaves a high percentage of idle database connections open. A low value causes the proxy to close more idle connections and return them to the database.
*
The type of source that is generating the events.
- *Valid values: db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot
+ *
The type of source that is generating the events. For RDS Proxy events, specify db-proxy.
Valid values: db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot | db-proxy
*
If the source type is a DB cluster snapshot, a DBClusterSnapshotIdentifier value must be supplied.
If the source type is an RDS Proxy, a DBProxyName value must be supplied.
Can't end with a hyphen or contain two consecutive hyphens.
*The maximum size of the connection pool for each target in a target group. For Aurora MySQL, it is expressed as a percentage of the + *
The maximum size of the connection pool for each target in a target group. The value is expressed as a percentage of the
* max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group.
Default: 100
*Constraints: between 1 and 100
@@ -5306,10 +5310,8 @@ export interface ConnectionPoolConfiguration { /** *
* Controls how actively the proxy closes idle database connections in the connection pool.
- * A high value enables the proxy to leave a high percentage of idle connections open.
- * A low value causes the proxy to close idle client connections and return the underlying
- * database connections to the connection pool. For Aurora MySQL, it is expressed as a percentage of the
- * max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group.
+ * The value is expressed as a percentage of the max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group.
+ * With a high value, the proxy leaves a high percentage of idle database connections open. A low value causes the proxy to close more idle connections and return them to the database.
*
Default: 50
*Constraints: between 0 and MaxConnectionsPercent
@@ -5647,8 +5649,8 @@ export interface ModifyEventSubscriptionMessage {
SnsTopicArn?: string;
/**
- *
The type of source that is generating the events. For example, if you want to be notified of events generated by a DB instance, you would set this parameter to db-instance. If this value isn't specified, all events are returned.
- *Valid values: db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot
+ *
The type of source that is generating the events. For example, if you want to be notified of events generated by a DB instance, you would set this parameter to db-instance. For RDS Proxy events, specify db-proxy. If this value isn't specified, all events are returned.
Valid values: db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot | db-proxy
*
With support for IoT Greengrass Version 2 devices, the phrase managed +
With support for IoT Greengrass core devices, the phrase managed instance has been changed to managed node in most of the Systems Manager -documentation. The Systems Manager console, API -calls, error messages, and SSM documents still use the term instance.
+documentation. The Systems Manager console, API calls, error messages, and SSM documents still use the +term instance.This reference is intended to be used with the Amazon Web Services Systems Manager User Guide.
To get started, verify prerequisites and configure managed nodes. For more information, see diff --git a/clients/client-ssm/src/SSM.ts b/clients/client-ssm/src/SSM.ts index 78d18bd822b6c..b4730f59a93fb 100644 --- a/clients/client-ssm/src/SSM.ts +++ b/clients/client-ssm/src/SSM.ts @@ -670,14 +670,13 @@ import { SSMClient } from "./SSMClient"; * collecting system inventory, applying operating system (OS) patches, automating the creation of * Amazon Machine Images (AMIs), and configuring operating systems (OSs) and applications at scale. * Systems Manager lets you remotely and securely manage the configuration of your managed nodes. A - * managed node is any Amazon Elastic Compute Cloud (Amazon EC2) instance, edge - * device, or on-premises server or virtual machine (VM) that has been configured for - * Systems Manager.
+ * managed node is any Amazon Elastic Compute Cloud (Amazon EC2) instance, edge device, or on-premises + * server or virtual machine (VM) that has been configured for Systems Manager. *With support for IoT Greengrass Version 2 devices, the phrase managed + *
With support for IoT Greengrass core devices, the phrase managed * instance has been changed to managed node in most of the Systems Manager - * documentation. The Systems Manager console, API - * calls, error messages, and SSM documents still use the term instance.
+ * documentation. The Systems Manager console, API calls, error messages, and SSM documents still use the + * term instance. *This reference is intended to be used with the Amazon Web Services Systems Manager User Guide.
*To get started, verify prerequisites and configure managed nodes. For more information, see @@ -891,8 +890,8 @@ export class SSM extends SSMClient { * requirements for managing on-premises machines using Systems Manager, see Setting up * Amazon Web Services Systems Manager for hybrid environments in the Amazon Web Services Systems Manager User Guide.
*Amazon Elastic Compute Cloud (Amazon EC2) instances, edge devices, and on-premises servers and VMs that are configured for Systems Manager are all called managed - * nodes.
+ *Amazon Elastic Compute Cloud (Amazon EC2) instances, edge devices, and on-premises servers and VMs that are + * configured for Systems Manager are all called managed nodes.
*Associates the specified Amazon Web Services Systems Manager document (SSM document) with the specified managed nodes * or targets.
- *When you associate a document with one or more managed nodes using IDs or tags, - * Amazon Web Services Systems Manager Agent (SSM Agent) running on the managed node processes the document and configures the - * node as specified.
+ *When you associate a document with one or more managed nodes using IDs or tags, Amazon Web Services Systems Manager + * Agent (SSM Agent) running on the managed node processes the document and configures the node as + * specified.
*If you associate a document with a managed node that already has an associated document, the * system returns the AssociationAlreadyExists exception.
*/ @@ -1271,9 +1270,9 @@ export class SSM extends SSMClient { } /** - *Disassociates the specified Amazon Web Services Systems Manager document (SSM document) from the specified managed node.
- * If you created the association by using the Targets parameter, then you must delete
- * the association by using the association ID.
Disassociates the specified Amazon Web Services Systems Manager document (SSM document) from the specified managed
+ * node. If you created the association by using the Targets parameter, then you must
+ * delete the association by using the association ID.
When you disassociate a document from a managed node, it doesn't change the configuration of * the node. To change the configuration state of a managed node after you disassociate a document, * you must create a new document with the desired configuration and associate it with the @@ -2104,8 +2103,8 @@ export class SSM extends SSMClient { *
Describes one or more of your managed nodes, including information about the operating * system platform, the version of SSM Agent installed on the managed node, node status, and so * on.
- *If you specify one or more managed node IDs, it returns information for those managed nodes. If - * you don't specify node IDs, it returns information for all your managed nodes. If you specify + *
If you specify one or more managed node IDs, it returns information for those managed nodes. + * If you don't specify node IDs, it returns information for all your managed nodes. If you specify * a node ID that isn't valid or a node that you don't own, you receive an error.
*The IamRole field for this API operation is the Identity and Access Management
@@ -2143,8 +2142,8 @@ export class SSM extends SSMClient {
}
/**
- *
Retrieves information about the patches on the specified managed node and their state relative - * to the patch baseline being used for the node.
+ *Retrieves information about the patches on the specified managed node and their state + * relative to the patch baseline being used for the node.
*/ public describeInstancePatches( args: DescribeInstancePatchesCommandInput, @@ -2208,7 +2207,8 @@ export class SSM extends SSMClient { } /** - *Retrieves the high-level patch state for the managed nodes in the specified patch group.
+ *Retrieves the high-level patch state for the managed nodes in the specified patch + * group.
*/ public describeInstancePatchStatesForPatchGroup( args: DescribeInstancePatchStatesForPatchGroupCommandInput, @@ -2991,8 +2991,8 @@ export class SSM extends SSMClient { } /** - *Retrieves the Session Manager connection status for a managed node to determine whether it is running and - * ready to receive Session Manager connections.
+ *Retrieves the Session Manager connection status for a managed node to determine whether it is running + * and ready to receive Session Manager connections.
*/ public getConnectionStatus( args: GetConnectionStatusCommandInput, @@ -3064,8 +3064,8 @@ export class SSM extends SSMClient { *If you run the command locally, such as with the Command Line Interface (CLI), the system attempts to use your local Amazon Web Services credentials and the operation fails. To avoid
* this, you can run the command in the Amazon Web Services Systems Manager console. Use Run Command, a capability of
- * Amazon Web Services Systems Manager, with an SSM document that enables you to target a managed node with a script or command.
- * For example, run the command using the AWS-RunShellScript document or the
+ * Amazon Web Services Systems Manager, with an SSM document that enables you to target a managed node with a script or
+ * command. For example, run the command using the AWS-RunShellScript document or the
* AWS-RunPowerShellScript document.
Query inventory information. This includes managed node status, such as Stopped or
- * Terminated.
Query inventory information. This includes managed node status, such as Stopped
+ * or Terminated.
Returns all State Manager associations in the current Amazon Web Services account and Amazon Web Services Region. You - * can limit the results to a specific State Manager association document or managed node by specifying - * a filter. State Manager is a capability of Amazon Web Services Systems Manager.
+ * can limit the results to a specific State Manager association document or managed node by + * specifying a filter. State Manager is a capability of Amazon Web Services Systems Manager. */ public listAssociations( args: ListAssociationsCommandInput, @@ -3845,11 +3845,11 @@ export class SSM extends SSMClient { } /** - *An invocation is copy of a command sent to a specific managed node. A command can apply to one
- * or more managed nodes. A command invocation applies to one managed node. For example, if a user runs
- * SendCommand against three managed nodes, then a command invocation is created for
- * each requested managed node ID. ListCommandInvocations provide status about command
- * execution.
An invocation is copy of a command sent to a specific managed node. A command can apply to
+ * one or more managed nodes. A command invocation applies to one managed node. For example, if a
+ * user runs SendCommand against three managed nodes, then a command invocation is
+ * created for each requested managed node ID. ListCommandInvocations provide status
+ * about command execution.
Bulk update custom inventory items on one or more managed nodes. The request adds an inventory item, - * if it doesn't already exist, or updates an inventory item, if it does exist.
+ *Bulk update custom inventory items on one or more managed nodes. The request adds an + * inventory item, if it doesn't already exist, or updates an inventory item, if it does + * exist.
*/ public putInventory( args: PutInventoryCommandInput, @@ -4899,9 +4900,9 @@ export class SSM extends SSMClient { } /** - *Initiates a connection to a target (for example, a managed node) for a Session Manager session. Returns a - * URL and token that can be used to open a WebSocket connection for sending input and receiving - * outputs.
+ *Initiates a connection to a target (for example, a managed node) for a Session Manager session. + * Returns a URL and token that can be used to open a WebSocket connection for sending input and + * receiving outputs.
*Amazon Web Services CLI usage: Updates an association. You can update the association name and version, the document
- * version, schedule, parameters, and Amazon Simple Storage Service (Amazon S3) output. start-session is an interactive command that requires the Session Manager
* plugin to be installed on the client machine making the call. For information, see Install
@@ -5035,7 +5036,14 @@ export class SSM extends SSMClient {
/**
* UpdateAssociation, the system drops all optional parameters from the request
+ * and overwrites the association with null values for those parameters. This is by design. You must
+ * specify all optional parameters in the call, even if you are not changing the parameters. This
+ * includes the Name parameter. Before calling this API action, we recommend that you
+ * call the DescribeAssociation API operation and make a note of all optional
+ * parameters required for your UpdateAssociation call.
In order to call this API operation, your Identity and Access Management (IAM) user
* account, group, or role must be configured with permission to call the DescribeAssociation API operation. If you don't have permission to call
* DescribeAssociation, then you receive the following error: An error occurred
@@ -5045,7 +5053,8 @@ export class SSM extends SSMClient {
*
When you update an association, the association immediately runs against the specified - * targets.
+ * targets. You can add theApplyOnlyAtCronInterval parameter to run the association
+ * during the next schedule run.
* With support for IoT Greengrass Version 2 devices, the phrase managed + *
With support for IoT Greengrass core devices, the phrase managed * instance has been changed to managed node in most of the Systems Manager - * documentation. The Systems Manager console, API - * calls, error messages, and SSM documents still use the term instance.
+ * documentation. The Systems Manager console, API calls, error messages, and SSM documents still use the + * term instance. *This reference is intended to be used with the Amazon Web Services Systems Manager User Guide.
*To get started, verify prerequisites and configure managed nodes. For more information, see diff --git a/clients/client-ssm/src/commands/CreateActivationCommand.ts b/clients/client-ssm/src/commands/CreateActivationCommand.ts index 0c4bf4cd91a14..e042bcbce30d7 100644 --- a/clients/client-ssm/src/commands/CreateActivationCommand.ts +++ b/clients/client-ssm/src/commands/CreateActivationCommand.ts @@ -29,8 +29,8 @@ export interface CreateActivationCommandOutput extends CreateActivationResult, _ * requirements for managing on-premises machines using Systems Manager, see Setting up * Amazon Web Services Systems Manager for hybrid environments in the Amazon Web Services Systems Manager User Guide.
*Amazon Elastic Compute Cloud (Amazon EC2) instances, edge devices, and on-premises servers and VMs that are configured for Systems Manager are all called managed - * nodes.
+ *Amazon Elastic Compute Cloud (Amazon EC2) instances, edge devices, and on-premises servers and VMs that are + * configured for Systems Manager are all called managed nodes.
*Associates the specified Amazon Web Services Systems Manager document (SSM document) with the specified managed nodes * or targets.
- *When you associate a document with one or more managed nodes using IDs or tags, - * Amazon Web Services Systems Manager Agent (SSM Agent) running on the managed node processes the document and configures the - * node as specified.
+ *When you associate a document with one or more managed nodes using IDs or tags, Amazon Web Services Systems Manager + * Agent (SSM Agent) running on the managed node processes the document and configures the node as + * specified.
*If you associate a document with a managed node that already has an associated document, the * system returns the AssociationAlreadyExists exception.
* @example diff --git a/clients/client-ssm/src/commands/DeleteAssociationCommand.ts b/clients/client-ssm/src/commands/DeleteAssociationCommand.ts index 7f685a47f6aae..afee2b064e042 100644 --- a/clients/client-ssm/src/commands/DeleteAssociationCommand.ts +++ b/clients/client-ssm/src/commands/DeleteAssociationCommand.ts @@ -22,9 +22,9 @@ export interface DeleteAssociationCommandInput extends DeleteAssociationRequest export interface DeleteAssociationCommandOutput extends DeleteAssociationResult, __MetadataBearer {} /** - *Disassociates the specified Amazon Web Services Systems Manager document (SSM document) from the specified managed node.
- * If you created the association by using the Targets parameter, then you must delete
- * the association by using the association ID.
Disassociates the specified Amazon Web Services Systems Manager document (SSM document) from the specified managed
+ * node. If you created the association by using the Targets parameter, then you must
+ * delete the association by using the association ID.
When you disassociate a document from a managed node, it doesn't change the configuration of * the node. To change the configuration state of a managed node after you disassociate a document, * you must create a new document with the desired configuration and associate it with the diff --git a/clients/client-ssm/src/commands/DescribeInstanceInformationCommand.ts b/clients/client-ssm/src/commands/DescribeInstanceInformationCommand.ts index 22a2d3cefd0cd..8c5b3f6ad6f93 100644 --- a/clients/client-ssm/src/commands/DescribeInstanceInformationCommand.ts +++ b/clients/client-ssm/src/commands/DescribeInstanceInformationCommand.ts @@ -25,8 +25,8 @@ export interface DescribeInstanceInformationCommandOutput extends DescribeInstan *
Describes one or more of your managed nodes, including information about the operating * system platform, the version of SSM Agent installed on the managed node, node status, and so * on.
- *If you specify one or more managed node IDs, it returns information for those managed nodes. If - * you don't specify node IDs, it returns information for all your managed nodes. If you specify + *
If you specify one or more managed node IDs, it returns information for those managed nodes. + * If you don't specify node IDs, it returns information for all your managed nodes. If you specify * a node ID that isn't valid or a node that you don't own, you receive an error.
*The IamRole field for this API operation is the Identity and Access Management
diff --git a/clients/client-ssm/src/commands/DescribeInstancePatchStatesForPatchGroupCommand.ts b/clients/client-ssm/src/commands/DescribeInstancePatchStatesForPatchGroupCommand.ts
index b46d486e534da..c9c5149d89ba5 100644
--- a/clients/client-ssm/src/commands/DescribeInstancePatchStatesForPatchGroupCommand.ts
+++ b/clients/client-ssm/src/commands/DescribeInstancePatchStatesForPatchGroupCommand.ts
@@ -28,7 +28,8 @@ export interface DescribeInstancePatchStatesForPatchGroupCommandOutput
__MetadataBearer {}
/**
- *
Retrieves the high-level patch state for the managed nodes in the specified patch group.
+ *Retrieves the high-level patch state for the managed nodes in the specified patch + * group.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-ssm/src/commands/DescribeInstancePatchesCommand.ts b/clients/client-ssm/src/commands/DescribeInstancePatchesCommand.ts index d7cf6dfc49f53..b968e33f560b9 100644 --- a/clients/client-ssm/src/commands/DescribeInstancePatchesCommand.ts +++ b/clients/client-ssm/src/commands/DescribeInstancePatchesCommand.ts @@ -22,8 +22,8 @@ export interface DescribeInstancePatchesCommandInput extends DescribeInstancePat export interface DescribeInstancePatchesCommandOutput extends DescribeInstancePatchesResult, __MetadataBearer {} /** - *Retrieves information about the patches on the specified managed node and their state relative - * to the patch baseline being used for the node.
+ *Retrieves information about the patches on the specified managed node and their state + * relative to the patch baseline being used for the node.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-ssm/src/commands/GetConnectionStatusCommand.ts b/clients/client-ssm/src/commands/GetConnectionStatusCommand.ts index 98899f80d0a16..3479c71ed960a 100644 --- a/clients/client-ssm/src/commands/GetConnectionStatusCommand.ts +++ b/clients/client-ssm/src/commands/GetConnectionStatusCommand.ts @@ -22,8 +22,8 @@ export interface GetConnectionStatusCommandInput extends GetConnectionStatusRequ export interface GetConnectionStatusCommandOutput extends GetConnectionStatusResponse, __MetadataBearer {} /** - *Retrieves the Session Manager connection status for a managed node to determine whether it is running and - * ready to receive Session Manager connections.
+ *Retrieves the Session Manager connection status for a managed node to determine whether it is running + * and ready to receive Session Manager connections.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-ssm/src/commands/GetDeployablePatchSnapshotForInstanceCommand.ts b/clients/client-ssm/src/commands/GetDeployablePatchSnapshotForInstanceCommand.ts index 9ec567b0bb6ec..c3c2e6389f3b2 100644 --- a/clients/client-ssm/src/commands/GetDeployablePatchSnapshotForInstanceCommand.ts +++ b/clients/client-ssm/src/commands/GetDeployablePatchSnapshotForInstanceCommand.ts @@ -33,8 +33,8 @@ export interface GetDeployablePatchSnapshotForInstanceCommandOutput *If you run the command locally, such as with the Command Line Interface (CLI), the system attempts to use your local Amazon Web Services credentials and the operation fails. To avoid
* this, you can run the command in the Amazon Web Services Systems Manager console. Use Run Command, a capability of
- * Amazon Web Services Systems Manager, with an SSM document that enables you to target a managed node with a script or command.
- * For example, run the command using the AWS-RunShellScript document or the
+ * Amazon Web Services Systems Manager, with an SSM document that enables you to target a managed node with a script or
+ * command. For example, run the command using the AWS-RunShellScript document or the
* AWS-RunPowerShellScript document.
Query inventory information. This includes managed node status, such as Stopped or
- * Terminated.
Query inventory information. This includes managed node status, such as Stopped
+ * or Terminated.
Returns all State Manager associations in the current Amazon Web Services account and Amazon Web Services Region. You - * can limit the results to a specific State Manager association document or managed node by specifying - * a filter. State Manager is a capability of Amazon Web Services Systems Manager.
+ * can limit the results to a specific State Manager association document or managed node by + * specifying a filter. State Manager is a capability of Amazon Web Services Systems Manager. * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-ssm/src/commands/ListCommandInvocationsCommand.ts b/clients/client-ssm/src/commands/ListCommandInvocationsCommand.ts index 0a5294b57a4b2..ea16685ddcb2a 100644 --- a/clients/client-ssm/src/commands/ListCommandInvocationsCommand.ts +++ b/clients/client-ssm/src/commands/ListCommandInvocationsCommand.ts @@ -22,11 +22,11 @@ export interface ListCommandInvocationsCommandInput extends ListCommandInvocatio export interface ListCommandInvocationsCommandOutput extends ListCommandInvocationsResult, __MetadataBearer {} /** - *An invocation is copy of a command sent to a specific managed node. A command can apply to one
- * or more managed nodes. A command invocation applies to one managed node. For example, if a user runs
- * SendCommand against three managed nodes, then a command invocation is created for
- * each requested managed node ID. ListCommandInvocations provide status about command
- * execution.
An invocation is copy of a command sent to a specific managed node. A command can apply to
+ * one or more managed nodes. A command invocation applies to one managed node. For example, if a
+ * user runs SendCommand against three managed nodes, then a command invocation is
+ * created for each requested managed node ID. ListCommandInvocations provide status
+ * about command execution.
Bulk update custom inventory items on one or more managed nodes. The request adds an inventory item, - * if it doesn't already exist, or updates an inventory item, if it does exist.
+ *Bulk update custom inventory items on one or more managed nodes. The request adds an + * inventory item, if it doesn't already exist, or updates an inventory item, if it does + * exist.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-ssm/src/commands/StartSessionCommand.ts b/clients/client-ssm/src/commands/StartSessionCommand.ts index a0e0dc2ad10b1..b2ffcae2b4bfb 100644 --- a/clients/client-ssm/src/commands/StartSessionCommand.ts +++ b/clients/client-ssm/src/commands/StartSessionCommand.ts @@ -22,9 +22,9 @@ export interface StartSessionCommandInput extends StartSessionRequest {} export interface StartSessionCommandOutput extends StartSessionResponse, __MetadataBearer {} /** - *Initiates a connection to a target (for example, a managed node) for a Session Manager session. Returns a - * URL and token that can be used to open a WebSocket connection for sending input and receiving - * outputs.
+ *Initiates a connection to a target (for example, a managed node) for a Session Manager session. + * Returns a URL and token that can be used to open a WebSocket connection for sending input and + * receiving outputs.
*Amazon Web Services CLI usage: Updates an association. You can update the association name and version, the document
- * version, schedule, parameters, and Amazon Simple Storage Service (Amazon S3) output. start-session is an interactive command that requires the Session Manager
* plugin to be installed on the client machine making the call. For information, see Install
diff --git a/clients/client-ssm/src/commands/UpdateAssociationCommand.ts b/clients/client-ssm/src/commands/UpdateAssociationCommand.ts
index b6a50007d8514..27153d409db78 100644
--- a/clients/client-ssm/src/commands/UpdateAssociationCommand.ts
+++ b/clients/client-ssm/src/commands/UpdateAssociationCommand.ts
@@ -23,7 +23,14 @@ export interface UpdateAssociationCommandOutput extends UpdateAssociationResult,
/**
* UpdateAssociation, the system drops all optional parameters from the request
+ * and overwrites the association with null values for those parameters. This is by design. You must
+ * specify all optional parameters in the call, even if you are not changing the parameters. This
+ * includes the Name parameter. Before calling this API action, we recommend that you
+ * call the DescribeAssociation API operation and make a note of all optional
+ * parameters required for your UpdateAssociation call.
In order to call this API operation, your Identity and Access Management (IAM) user
* account, group, or role must be configured with permission to call the DescribeAssociation API operation. If you don't have permission to call
* DescribeAssociation, then you receive the following error: An error occurred
@@ -33,7 +40,8 @@ export interface UpdateAssociationCommandOutput extends UpdateAssociationResult,
*
When you update an association, the association immediately runs against the specified - * targets.
+ * targets. You can add theApplyOnlyAtCronInterval parameter to run the association
+ * during the next schedule run.
* The Identity and Access Management (IAM) role to assign to the managed - * node.
+ *The Identity and Access Management (IAM) role to assign to the managed node.
*/ IamRole?: string; @@ -222,8 +221,8 @@ export interface InvalidResourceId extends __SmithyException, $MetadataBearer { } /** - *The resource type isn't valid. For example, if you are attempting to tag an EC2 instance, the - * instance must be a registered managed node.
+ *The resource type isn't valid. For example, if you are attempting to tag an EC2 instance, + * the instance must be a registered managed node.
*/ export interface InvalidResourceType extends __SmithyException, $MetadataBearer { name: "InvalidResourceType"; @@ -366,8 +365,8 @@ export interface CancelCommandRequest { CommandId: string | undefined; /** - *(Optional) A list of managed node IDs on which you want to cancel the command. If not provided, - * the command is canceled on every node on which it was requested.
+ *(Optional) A list of managed node IDs on which you want to cancel the command. If not + * provided, the command is canceled on every node on which it was requested.
*/ InstanceIds?: string[]; } @@ -569,9 +568,9 @@ export interface CreateActivationRequest { * automatically applied to the on-premises servers or VMs. * *You can't add tags to or delete tags from an existing activation. You can tag your - * on-premises servers, edge devices, and VMs after they connect to Systems Manager for the first time and are assigned a - * managed node ID. This means they are listed in the Amazon Web Services Systems Manager console with an ID that is - * prefixed with "mi-". For information about how to add tags to your managed nodes, see AddTagsToResource. For information about how to remove tags from your managed nodes, + * on-premises servers, edge devices, and VMs after they connect to Systems Manager for the first time and are + * assigned a managed node ID. This means they are listed in the Amazon Web Services Systems Manager console with an ID that + * is prefixed with "mi-". For information about how to add tags to your managed nodes, see AddTagsToResource. For information about how to remove tags from your managed nodes, * see RemoveTagsFromResource.
*/ Tags?: Tag[]; @@ -894,6 +893,9 @@ export interface CreateAssociationRequest { /** *The document version you want to associate with the target(s). Can be a specific version or * the default version.
+ *State Manager doesn't support running associations that use a new version of a document if that document is shared from another account. State Manager always runs the default version of a document if shared from another account, even though the Systems Manager console shows that a new version was processed. If you want to run an association using a new version of a document shared form another account, you must set the document version to default.
The managed node ID.
*
- * InstanceId has been deprecated. To specify a managed node ID for an association,
- * use the Targets parameter. Requests that include the
- * parameter InstanceID with Systems Manager documents (SSM documents) that use schema version
- * 2.0 or later will fail. In addition, if you use the parameter
- * InstanceId, you can't use the parameters AssociationName,
+ * InstanceId has been deprecated. To specify a managed node ID for an
+ * association, use the Targets parameter. Requests that
+ * include the parameter InstanceID with Systems Manager documents (SSM documents) that use
+ * schema version 2.0 or later will fail. In addition, if you use the
+ * parameter InstanceId, you can't use the parameters AssociationName,
* DocumentVersion, MaxErrors, MaxConcurrency,
* OutputLocation, or ScheduleExpression. To use these parameters, you
* must use the Targets parameter.
If a new managed node starts and attempts to run an association while Systems Manager is running
* MaxConcurrency associations, the association is allowed to run. During the next
- * association interval, the new managed node will process its association within the limit specified
- * for MaxConcurrency.
MaxConcurrency.
*/
MaxConcurrency?: string;
@@ -1211,8 +1213,8 @@ export interface AssociationDescription {
* value is 100%, which means all targets run the association at the same time.
* If a new managed node starts and attempts to run an association while Systems Manager is running
* MaxConcurrency associations, the association is allowed to run. During the next
- * association interval, the new managed node will process its association within the limit specified
- * for MaxConcurrency.
MaxConcurrency.
*/
MaxConcurrency?: string;
@@ -1337,8 +1339,8 @@ export interface InvalidTarget extends __SmithyException, $MetadataBearer {
}
/**
- * The document doesn't support the platform type of the given managed node ID(s). For example, you - * sent an document for a Windows managed node to a Linux node.
+ *The document doesn't support the platform type of the given managed node ID(s). For example, + * you sent an document for a Windows managed node to a Linux node.
*/ export interface UnsupportedPlatformType extends __SmithyException, $MetadataBearer { name: "UnsupportedPlatformType"; @@ -1351,8 +1353,8 @@ export interface UnsupportedPlatformType extends __SmithyException, $MetadataBea */ export interface CreateAssociationBatchRequestEntry { /** - *The name of the SSM document that contains the configuration information for the managed node. - * You can specify Command or Automation runbooks.
+ *The name of the SSM document that contains the configuration information for the managed + * node. You can specify Command or Automation runbooks.
*You can specify Amazon Web Services-predefined documents, documents you created, or a document that is * shared with you from another account.
*For SSM documents that are shared with you from other Amazon Web Services accounts, you must specify the @@ -1375,11 +1377,11 @@ export interface CreateAssociationBatchRequestEntry { *
The managed node ID.
*
- * InstanceId has been deprecated. To specify a managed node ID for an association,
- * use the Targets parameter. Requests that include the
- * parameter InstanceID with Systems Manager documents (SSM documents) that use schema version
- * 2.0 or later will fail. In addition, if you use the parameter
- * InstanceId, you can't use the parameters AssociationName,
+ * InstanceId has been deprecated. To specify a managed node ID for an
+ * association, use the Targets parameter. Requests that
+ * include the parameter InstanceID with Systems Manager documents (SSM documents) that use
+ * schema version 2.0 or later will fail. In addition, if you use the
+ * parameter InstanceId, you can't use the parameters AssociationName,
* DocumentVersion, MaxErrors, MaxConcurrency,
* OutputLocation, or ScheduleExpression. To use these parameters, you
* must use the Targets parameter.
If a new managed node starts and attempts to run an association while Systems Manager is running
* MaxConcurrency associations, the association is allowed to run. During the next
- * association interval, the new managed node will process its association within the limit specified
- * for MaxConcurrency.
MaxConcurrency.
*/
MaxConcurrency?: string;
@@ -1943,7 +1945,7 @@ export enum DocumentStatus {
}
/**
- * Describes a Amazon Web Services Systems Manager document (SSM document).
+ *Describes an Amazon Web Services Systems Manager document (SSM document).
*/ export interface DocumentDescription { /** @@ -2022,7 +2024,7 @@ export interface DocumentDescription { Parameters?: DocumentParameter[]; /** - *The list of OS platforms compatible with this SSM document.
+ *The list of operating system (OS) platforms compatible with this SSM document.
*/ PlatformTypes?: (PlatformType | string)[]; @@ -2099,6 +2101,16 @@ export interface DocumentDescription { *The current status of the review.
*/ ReviewStatus?: ReviewStatus | string; + + /** + *The classification of a document to help you identify and categorize its use.
+ */ + Category?: string[]; + + /** + *The value that identifies a document's category.
+ */ + CategoryEnum?: string[]; } export namespace DocumentDescription { @@ -2239,8 +2251,8 @@ export interface CreateMaintenanceWindowRequest { /** *Enables a maintenance window task to run on managed nodes, even if you haven't registered - * those nodes as targets. If enabled, then you must specify the unregistered managed nodes (by - * node ID) when you register a task with the maintenance window.
+ * those nodes as targets. If enabled, then you must specify the unregistered managed nodes (by node + * ID) when you register a task with the maintenance window. *If you don't enable this option, then you must specify previously-registered targets when * you register a task with the maintenance window.
*/ @@ -3343,14 +3355,14 @@ export interface DeleteAssociationRequest { *The managed node ID.
*
- * InstanceId has been deprecated. To specify a managed node ID for an association,
- * use the Targets parameter. Requests that include the
- * parameter InstanceID with Systems Manager documents (SSM documents) that use schema version
- * 2.0 or later will fail. In addition, if you use the parameter
- * InstanceId, you can't use the parameters AssociationName,
- * DocumentVersion, MaxErrors, MaxConcurrency,
- * OutputLocation, or ScheduleExpression. To use these parameters, you
- * must use the Targets parameter.
InstanceId has been deprecated. To specify a managed node ID for an
+ * association, use the Targets parameter. Requests that include the parameter
+ * InstanceID with Systems Manager documents (SSM documents) that use schema version 2.0 or
+ * later will fail. In addition, if you use the parameter InstanceId, you can't use
+ * the parameters AssociationName, DocumentVersion,
+ * MaxErrors, MaxConcurrency, OutputLocation, or
+ * ScheduleExpression. To use these parameters, you must use the Targets
+ * parameter.
* Specify the association version to retrieve. To view the latest version, either specify
* $LATEST for this parameter, or omit this parameter. To view a list of all
- * associations for a managed node, use ListAssociations. To get a list of versions
- * for a specific association, use ListAssociationVersions.
This is a legacy method. We recommend that you don't use this method. Instead, use the
- * Filters data type. Filters enables you to return node information
- * by filtering based on tags applied to managed nodes.
Filters data type. Filters enables you to return node information by
+ * filtering based on tags applied to managed nodes.
* Attempting to use InstanceInformationFilterList and Filters leads
* to an exception error.
Information about the state of a patch on a particular managed node as it relates to the patch - * baseline used to patch the node.
+ *Information about the state of a patch on a particular managed node as it relates to the + * patch baseline used to patch the node.
*/ export interface PatchComplianceData { /** @@ -6703,8 +6715,8 @@ export interface InstancePatchState { InstalledCount?: number; /** - *The number of patches not specified in the patch baseline that are installed on the - * managed node.
+ *The number of patches not specified in the patch baseline that are installed on the managed + * node.
*/ InstalledOtherCount?: number; @@ -6745,8 +6757,8 @@ export interface InstancePatchState { UnreportedNotApplicableCount?: number; /** - *The number of patches from the patch baseline that aren't applicable for the managed node and - * therefore aren't installed on the node. This number may be truncated if the list of patch + *
The number of patches from the patch baseline that aren't applicable for the managed node
+ * and therefore aren't installed on the node. This number may be truncated if the list of patch
* names is very large. The number of patches beyond this limit are reported in
* UnreportedNotApplicableCount.
The time of the last attempt to patch the managed node with NoReboot specified as
- * the reboot option.
The time of the last attempt to patch the managed node with NoReboot specified
+ * as the reboot option.
- * RebootIfNeeded: Patch Manager tries to reboot the managed node if it installed
- * any patches, or if any patches are detected with a status of
+ * RebootIfNeeded: Patch Manager tries to reboot the managed node if it
+ * installed any patches, or if any patches are detected with a status of
* InstalledPendingReboot.
The number of managed nodes where patches that are specified as Critical for
* compliance reporting in the patch baseline aren't installed. These patches might be missing, have
- * failed installation, were rejected, or were installed but awaiting a required managed node reboot.
- * The status of these managed nodes is NON_COMPLIANT.
NON_COMPLIANT.
*/
CriticalNonCompliantCount?: number;
/**
* The number of managed nodes where patches that are specified as Security in a
* patch advisory aren't installed. These patches might be missing, have failed installation, were
- * rejected, or were installed but awaiting a required managed node reboot. The status of these managed
- * nodes is NON_COMPLIANT.
NON_COMPLIANT.
*/
SecurityNonCompliantCount?: number;
@@ -8073,8 +8085,8 @@ export enum MaintenanceWindowTaskCutoffBehavior {
}
/**
- * Information about an Amazon Simple Storage Service (Amazon S3) bucket to write - * managed node-level logs to.
+ *Information about an Amazon Simple Storage Service (Amazon S3) bucket to write managed + * node-level logs to.
*
* LoggingInfo has been deprecated. To specify an Amazon Simple Storage Service (Amazon S3) bucket to contain logs, instead use the
diff --git a/clients/client-ssm/src/models/models_1.ts b/clients/client-ssm/src/models/models_1.ts
index 10972b11ecba3..6e25f945e03dc 100644
--- a/clients/client-ssm/src/models/models_1.ts
+++ b/clients/client-ssm/src/models/models_1.ts
@@ -470,16 +470,16 @@ export interface DescribePatchGroupStateResult {
/**
*
The number of managed nodes where patches that are specified as Critical for
* compliance reporting in the patch baseline aren't installed. These patches might be missing, have
- * failed installation, were rejected, or were installed but awaiting a required managed node reboot.
- * The status of these managed nodes is NON_COMPLIANT.
NON_COMPLIANT.
*/
InstancesWithCriticalNonCompliantPatches?: number;
/**
* The number of managed nodes where patches that are specified as Security in a
* patch advisory aren't installed. These patches might be missing, have failed installation, were
- * rejected, or were installed but awaiting a required managed node reboot. The status of these managed
- * nodes is NON_COMPLIANT.
NON_COMPLIANT.
*/
InstancesWithSecurityNonCompliantPatches?: number;
@@ -1204,8 +1204,9 @@ export interface GetCommandInvocationRequest {
CommandId: string | undefined;
/**
- * (Required) The ID of the managed node targeted by the command. A managed node can be an - * Amazon Elastic Compute Cloud (Amazon EC2) instance, edge device, and on-premises server or VM in your hybrid environment that is configured for Amazon Web Services Systems Manager.
+ *(Required) The ID of the managed node targeted by the command. A managed + * node can be an Amazon Elastic Compute Cloud (Amazon EC2) instance, edge device, and on-premises server or VM + * in your hybrid environment that is configured for Amazon Web Services Systems Manager.
*/ InstanceId: string | undefined; @@ -1281,8 +1282,9 @@ export interface GetCommandInvocationResult { CommandId?: string; /** - *The ID of the managed node targeted by the command. A managed node can be an - * Amazon Elastic Compute Cloud (Amazon EC2) instance, edge device, or on-premises server or VM in your hybrid environment that is configured for Amazon Web Services Systems Manager.
+ *The ID of the managed node targeted by the command. A managed node can + * be an Amazon Elastic Compute Cloud (Amazon EC2) instance, edge device, or on-premises server or VM in your hybrid + * environment that is configured for Amazon Web Services Systems Manager.
*/ InstanceId?: string; @@ -1309,8 +1311,8 @@ export interface GetCommandInvocationResult { /** *The error level response code for the plugin script. If the response code is
- * -1, then the command hasn't started running on the managed node, or it wasn't received
- * by the node.
-1, then the command hasn't started running on the managed node, or it wasn't
+ * received by the node.
*/
ResponseCode?: number;
@@ -1377,18 +1379,18 @@ export interface GetCommandInvocationResult {
* Success or Incomplete. This is a terminal state.
* Execution Timed Out: The command started to run on the managed node, but the execution wasn't - * complete before the timeout expired. Execution timeouts count against the + *
Execution Timed Out: The command started to run on the managed node, but the execution
+ * wasn't complete before the timeout expired. Execution timeouts count against the
* MaxErrors limit of the parent command. This is a terminal state.
Failed: The command wasn't run successfully on the managed node. For a plugin, this indicates - * that the result code wasn't zero. For a command invocation, this indicates that the result code - * for one or more plugins wasn't zero. Invocation failures count against the + *
Failed: The command wasn't run successfully on the managed node. For a plugin, this
+ * indicates that the result code wasn't zero. For a command invocation, this indicates that the
+ * result code for one or more plugins wasn't zero. Invocation failures count against the
* MaxErrors limit of the parent command. This is a terminal state.
Canceled: The command was terminated before it was completed. This is a terminal + *
Cancelled: The command was terminated before it was completed. This is a terminal * state.
*The ID of the managed node for which the appropriate patch snapshot should be retrieved.
+ *The ID of the managed node for which the appropriate patch snapshot should be + * retrieved.
*/ InstanceId: string | undefined; @@ -1989,9 +1992,8 @@ export namespace InventoryResultItem { */ export interface InventoryResultEntity { /** - *ID of the inventory result entity. For example, for managed node inventory the result - * will be the managed node ID. For EC2 instance inventory, the result will be the instance ID. - *
+ *ID of the inventory result entity. For example, for managed node inventory the result will + * be the managed node ID. For EC2 instance inventory, the result will be the instance ID.
*/ Id?: string; @@ -2621,14 +2623,13 @@ export interface MaintenanceWindowAutomationParameters { *OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure.
* For information about how Amazon Web Services Systems Manager handles these options for the supported maintenance
* window task types, see MaintenanceWindowTaskInvocationParameters.
- *
*
* TaskParameters has been deprecated. To specify parameters to pass to a task when it runs,
* instead use the Parameters option in the TaskInvocationParameters structure. For information
* about how Systems Manager handles these options for the supported maintenance window task
* types, see MaintenanceWindowTaskInvocationParameters.
For AUTOMATION task types, Amazon Web Services Systems Manager ignores any values specified for these
- * parameters.
For AUTOMATION
+ * task types, Amazon Web Services Systems Manager ignores any values specified for these parameters.
OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure.
* For information about how Amazon Web Services Systems Manager handles these options for the supported maintenance
* window task types, see MaintenanceWindowTaskInvocationParameters.
- *
*
* TaskParameters has been deprecated. To specify parameters to pass to a task when it runs,
* instead use the Parameters option in the TaskInvocationParameters structure. For information
* about how Systems Manager handles these options for the supported maintenance window task
* types, see MaintenanceWindowTaskInvocationParameters.
For Lambda tasks, Systems Manager ignores any values specified for TaskParameters and - * LoggingInfo.
+ *For Lambda tasks, Systems Manager ignores + * any values specified for TaskParameters and LoggingInfo.
*OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure.
* For information about how Amazon Web Services Systems Manager handles these options for the supported maintenance
* window task types, see MaintenanceWindowTaskInvocationParameters.
- *
*
* TaskParameters has been deprecated. To specify parameters to pass to a task when it runs,
* instead use the Parameters option in the TaskInvocationParameters structure. For information
* about how Systems Manager handles these options for the supported maintenance window task
* types, see MaintenanceWindowTaskInvocationParameters.
For RUN_COMMAND tasks, Systems Manager uses specified values for
- * TaskParameters and LoggingInfo only if no values are specified for
- * TaskInvocationParameters.
For RUN_COMMAND
+ * tasks, Systems Manager uses specified values for TaskParameters and LoggingInfo
+ * only if no values are specified for TaskInvocationParameters.
OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure.
* For information about how Amazon Web Services Systems Manager handles these options for the supported maintenance
* window task types, see MaintenanceWindowTaskInvocationParameters.
- *
*
* TaskParameters has been deprecated. To specify parameters to pass to a task when it runs,
* instead use the Parameters option in the TaskInvocationParameters structure. For information
* about how Systems Manager handles these options for the supported maintenance window task
* types, see MaintenanceWindowTaskInvocationParameters.
For Step Functions tasks, Systems Manager ignores any values specified for
- * TaskParameters and LoggingInfo.
For Step Functions tasks, Systems Manager
+ * ignores any values specified for TaskParameters and
+ * LoggingInfo.
Filtering associations using the InstanceID attribute only returns legacy
* associations created using the InstanceID attribute. Associations targeting the
- * managed node that are part of the Target Attributes ResourceGroup or Tags
- * aren't returned.
ResourceGroup or
+ * Tags aren't returned.
* The version of the document used in the association.
+ *State Manager doesn't support running associations that use a new version of a document if that document is shared from another account. State Manager always runs the default version of a document if shared from another account, even though the Systems Manager console shows that a new version was processed. If you want to run an association using a new version of a document shared form another account, you must set the document version to default.
If a new managed node starts and attempts to run an association while Systems Manager is running
* MaxConcurrency associations, the association is allowed to run. During the next
- * association interval, the new managed node will process its association within the limit specified
- * for MaxConcurrency.
MaxConcurrency.
*/
MaxConcurrency?: string;
@@ -4574,8 +4576,8 @@ export enum CommandFilterKey {
/**
* Describes a command filter.
*A managed node ID can't be specified when a command status is Pending because the
- * command hasn't run on the node yet.
A managed node ID can't be specified when a command status is Pending because
+ * the command hasn't run on the node yet.
Execution Timed Out: Command execution started on the managed node, but the execution wasn't - * complete before the execution timeout expired. Execution timeouts count against the + *
Execution Timed Out: Command execution started on the managed node, but the execution
+ * wasn't complete before the execution timeout expired. Execution timeouts count against the
* MaxErrors limit of the parent command. This is a terminal state.
Failed: The command wasn't successful on the managed node. For a plugin, this indicates that - * the result code wasn't zero. For a command invocation, this indicates that the result code for - * one or more plugins wasn't zero. Invocation failures count against the MaxErrors limit of the - * parent command. This is a terminal state.
+ *Failed: The command wasn't successful on the managed node. For a plugin, this indicates + * that the result code wasn't zero. For a command invocation, this indicates that the result code + * for one or more plugins wasn't zero. Invocation failures count against the MaxErrors limit of + * the parent command. This is a terminal state.
*Canceled: The command was terminated before it was completed. This is a terminal + *
Cancelled: The command was terminated before it was completed. This is a terminal * state.
*Undeliverable: The command can't be delivered to the managed node. The managed node might not - * exist, or it might not be responding. Undeliverable invocations don't count against the parent - * command's MaxErrors limit, and they don't contribute to whether the parent command status is - * Success or Incomplete. This is a terminal state.
+ *Undeliverable: The command can't be delivered to the managed node. The managed node might + * not exist, or it might not be responding. Undeliverable invocations don't count against the + * parent command's MaxErrors limit, and they don't contribute to whether the parent command + * status is Success or Incomplete. This is a terminal state.
*Terminated: The parent command exceeded its MaxErrors limit and subsequent command @@ -4985,11 +4987,11 @@ export namespace CommandPlugin { } /** - *
An invocation is a copy of a command sent to a specific managed node. A command can apply to one
- * or more managed nodes. A command invocation applies to one managed node. For example, if a user runs
- * SendCommand against three managed nodes, then a command invocation is created for
- * each requested managed node ID. A command invocation returns status and detail information about a
- * command you ran.
An invocation is a copy of a command sent to a specific managed node. A command can apply to
+ * one or more managed nodes. A command invocation applies to one managed node. For example, if a
+ * user runs SendCommand against three managed nodes, then a command invocation is
+ * created for each requested managed node ID. A command invocation returns status and detail
+ * information about a command you ran.
A detailed status of the command execution for each invocation (each managed node targeted by - * the command). StatusDetails includes more information than Status because it includes states + *
A detailed status of the command execution for each invocation (each managed node targeted + * by the command). StatusDetails includes more information than Status because it includes states * resulting from error and concurrency control parameters. StatusDetails can show different results * than Status. For more information about these statuses, see Understanding command * statuses in the Amazon Web Services Systems Manager User Guide. StatusDetails can be one of the @@ -5059,23 +5061,23 @@ export interface CommandInvocation { * Success or Incomplete. This is a terminal state.
*Execution Timed Out: Command execution started on the managed node, but the execution wasn't - * complete before the execution timeout expired. Execution timeouts count against the + *
Execution Timed Out: Command execution started on the managed node, but the execution
+ * wasn't complete before the execution timeout expired. Execution timeouts count against the
* MaxErrors limit of the parent command. This is a terminal state.
Failed: The command wasn't successful on the managed node. For a plugin, this indicates that
- * the result code wasn't zero. For a command invocation, this indicates that the result code for
- * one or more plugins wasn't zero. Invocation failures count against the MaxErrors
- * limit of the parent command. This is a terminal state.
Failed: The command wasn't successful on the managed node. For a plugin, this indicates
+ * that the result code wasn't zero. For a command invocation, this indicates that the result code
+ * for one or more plugins wasn't zero. Invocation failures count against the
+ * MaxErrors limit of the parent command. This is a terminal state.
Canceled: The command was terminated before it was completed. This is a terminal + *
Cancelled: The command was terminated before it was completed. This is a terminal * state.
*Undeliverable: The command can't be delivered to the managed node. The managed node might not - * exist or might not be responding. Undeliverable invocations don't count against the parent + *
Undeliverable: The command can't be delivered to the managed node. The managed node might + * not exist or might not be responding. Undeliverable invocations don't count against the parent * command's MaxErrors limit and don't contribute to whether the parent command status is Success * or Incomplete. This is a terminal state.
*(Optional) Lists commands issued against this managed node ID.
*You can't specify a managed node ID in the same command that you specify Status =
- * Pending. This is because the command hasn't reached the managed node yet.
You can't specify a managed node ID in the same command that you specify
+ * Status = Pending. This is because the command hasn't reached the
+ * managed node yet.
Pending: The command hasn't been sent to any managed nodes.
*In Progress: The command has been sent to at least one managed node but hasn't reached a final - * state on all managed nodes.
+ *In Progress: The command has been sent to at least one managed node but hasn't reached a + * final state on all managed nodes.
*Success: The command successfully ran on all invocations. This is a terminal state.
@@ -5312,7 +5315,7 @@ export interface Command { * This is a terminal state. *Canceled: The command was terminated before it was completed. This is a terminal + *
Cancelled: The command was terminated before it was completed. This is a terminal * state.
*The number of targets for which the command invocation reached a terminal state. Terminal - * states include the following: Success, Failed, Execution Timed Out, Delivery Timed Out, Canceled, + * states include the following: Success, Failed, Execution Timed Out, Delivery Timed Out, Cancelled, * Terminated, or Undeliverable.
*/ CompletedCount?: number; @@ -8816,9 +8819,9 @@ export interface InvalidRole extends __SmithyException, $MetadataBearer { export interface SendCommandRequest { /** - *The IDs of the managed nodes where the command should run. Specifying managed node IDs is most - * useful when you are targeting a limited number of managed nodes, though you can specify up to 50 - * IDs.
+ *The IDs of the managed nodes where the command should run. Specifying managed node IDs is + * most useful when you are targeting a limited number of managed nodes, though you can specify up + * to 50 IDs.
*To target a larger number of managed nodes, or if you prefer not to list individual node
* IDs, we recommend using the Targets option instead. Using Targets,
* which accepts tag key-value pairs to identify the managed nodes to send commands to, you can a
@@ -9384,10 +9387,11 @@ export namespace StartSessionResponse {
}
/**
- *
The specified target managed node for the session isn't fully configured for use with Session Manager. For
- * more information, see Getting started with
+ * The specified target managed node for the session isn't fully configured for use with Session Manager.
+ * For more information, see Getting started with
* Session Manager in the Amazon Web Services Systems Manager User Guide. This error is also returned if you
- * attempt to start a session on a managed node that is located in a different account or Region
The document version you want update for the association.
+ *State Manager doesn't support running associations that use a new version of a document if that document is shared from another account. State Manager always runs the default version of a document if shared from another account, even though the Systems Manager console shows that a new version was processed. If you want to run an association using a new version of a document shared form another account, you must set the document version to default.
If a new managed node starts and attempts to run an association while Systems Manager is running
* MaxConcurrency associations, the association is allowed to run. During the next
- * association interval, the new managed node will process its association within the limit specified
- * for MaxConcurrency.
MaxConcurrency.
*/
MaxConcurrency?: string;
diff --git a/clients/client-ssm/src/protocols/Aws_json1_1.ts b/clients/client-ssm/src/protocols/Aws_json1_1.ts
index fba1c58a63dee..818c3e0ed9aed 100644
--- a/clients/client-ssm/src/protocols/Aws_json1_1.ts
+++ b/clients/client-ssm/src/protocols/Aws_json1_1.ts
@@ -19390,6 +19390,28 @@ const deserializeAws_json1_1CancelMaintenanceWindowExecutionResult = (
} as any;
};
+const deserializeAws_json1_1CategoryEnumList = (output: any, context: __SerdeContext): string[] => {
+ return (output || [])
+ .filter((e: any) => e != null)
+ .map((entry: any) => {
+ if (entry === null) {
+ return null as any;
+ }
+ return __expectString(entry) as any;
+ });
+};
+
+const deserializeAws_json1_1CategoryList = (output: any, context: __SerdeContext): string[] => {
+ return (output || [])
+ .filter((e: any) => e != null)
+ .map((entry: any) => {
+ if (entry === null) {
+ return null as any;
+ }
+ return __expectString(entry) as any;
+ });
+};
+
const deserializeAws_json1_1CloudWatchOutputConfig = (output: any, context: __SerdeContext): CloudWatchOutputConfig => {
return {
CloudWatchLogGroupName: __expectString(output.CloudWatchLogGroupName),
@@ -20348,6 +20370,14 @@ const deserializeAws_json1_1DocumentDescription = (output: any, context: __Serde
? deserializeAws_json1_1AttachmentInformationList(output.AttachmentsInformation, context)
: undefined,
Author: __expectString(output.Author),
+ Category:
+ output.Category !== undefined && output.Category !== null
+ ? deserializeAws_json1_1CategoryList(output.Category, context)
+ : undefined,
+ CategoryEnum:
+ output.CategoryEnum !== undefined && output.CategoryEnum !== null
+ ? deserializeAws_json1_1CategoryEnumList(output.CategoryEnum, context)
+ : undefined,
CreatedDate:
output.CreatedDate !== undefined && output.CreatedDate !== null
? __expectNonNull(__parseEpochTimestamp(__expectNumber(output.CreatedDate)))
diff --git a/clients/client-sso-oidc/src/endpoints.ts b/clients/client-sso-oidc/src/endpoints.ts
index f06e1e1df1b6a..3ecf19160f559 100644
--- a/clients/client-sso-oidc/src/endpoints.ts
+++ b/clients/client-sso-oidc/src/endpoints.ts
@@ -128,6 +128,15 @@ const regionHash: RegionHash = {
],
signingRegion: "us-east-2",
},
+ "us-gov-east-1": {
+ variants: [
+ {
+ hostname: "oidc.us-gov-east-1.amazonaws.com",
+ tags: [],
+ },
+ ],
+ signingRegion: "us-gov-east-1",
+ },
"us-gov-west-1": {
variants: [
{
diff --git a/clients/client-sso/src/endpoints.ts b/clients/client-sso/src/endpoints.ts
index 51bcdc7d4e649..0e0b082829833 100644
--- a/clients/client-sso/src/endpoints.ts
+++ b/clients/client-sso/src/endpoints.ts
@@ -128,6 +128,15 @@ const regionHash: RegionHash = {
],
signingRegion: "us-east-2",
},
+ "us-gov-east-1": {
+ variants: [
+ {
+ hostname: "portal.sso.us-gov-east-1.amazonaws.com",
+ tags: [],
+ },
+ ],
+ signingRegion: "us-gov-east-1",
+ },
"us-gov-west-1": {
variants: [
{
diff --git a/clients/client-storage-gateway/src/StorageGateway.ts b/clients/client-storage-gateway/src/StorageGateway.ts
index b92ea90c58ea7..a667fb577bacb 100644
--- a/clients/client-storage-gateway/src/StorageGateway.ts
+++ b/clients/client-storage-gateway/src/StorageGateway.ts
@@ -1318,8 +1318,8 @@ export class StorageGateway extends StorageGatewayClient {
* Deletes the bandwidth rate limits of a gateway. You can delete either the upload and * download bandwidth rate limit, or you can delete both. If you delete only one of the * limits, the other limit remains unchanged. To specify which gateway to work with, use the - * Amazon Resource Name (ARN) of the gateway in your request. This operation is supported for - * the stored volume, cached volume and tape gateway types.
+ * Amazon Resource Name (ARN) of the gateway in your request. This operation is supported only + * for the stored volume, cached volume, and tape gateway types. */ public deleteBandwidthRateLimit( args: DeleteBandwidthRateLimitCommandInput, @@ -1683,13 +1683,14 @@ export class StorageGateway extends StorageGatewayClient { /** *Returns the bandwidth rate limits of a gateway. By default, these limits are not set, - * which means no bandwidth rate limiting is in effect. This operation is supported for the - * stored volume, cached volume, and tape gateway types.
+ * which means no bandwidth rate limiting is in effect. This operation is supported only for + * the stored volume, cached volume, and tape gateway types. To describe bandwidth rate limits + * for S3 file gateways, use DescribeBandwidthRateLimitSchedule. * - *This operation only returns a value for a bandwidth rate limit only if the limit is set. - * If no limits are set for the gateway, then this operation returns only the gateway ARN in - * the response body. To specify which gateway to describe, use the Amazon Resource Name (ARN) - * of the gateway in your request.
+ *This operation returns a value for a bandwidth rate limit only if the limit is set. If + * no limits are set for the gateway, then this operation returns only the gateway ARN in the + * response body. To specify which gateway to describe, use the Amazon Resource Name (ARN) of + * the gateway in your request.
*/ public describeBandwidthRateLimit( args: DescribeBandwidthRateLimitCommandInput, @@ -1723,7 +1724,8 @@ export class StorageGateway extends StorageGatewayClient { /** *Returns information about the bandwidth rate limit schedule of a gateway. By default, * gateways do not have bandwidth rate limit schedules, which means no bandwidth rate limiting - * is in effect. This operation is supported only in the volume and tape gateway types.
+ * is in effect. This operation is supported only for volume, tape and S3 file gateways. FSx + * file gateways do not support bandwidth rate limits. * *This operation returns information about a gateway's bandwidth rate limit schedule. A * bandwidth rate limit schedule consists of one or more bandwidth rate limit intervals. A @@ -3398,8 +3400,9 @@ export class StorageGateway extends StorageGatewayClient { /** *
Updates the bandwidth rate limits of a gateway. You can update both the upload and * download bandwidth rate limit or specify only one of the two. If you don't set a - * bandwidth rate limit, the existing rate limit remains. This operation is supported for the - * stored volume, cached volume, and tape gateway types.
+ * bandwidth rate limit, the existing rate limit remains. This operation is supported only for + * the stored volume, cached volume, and tape gateway types. To update bandwidth rate limits + * for S3 file gateways, use UpdateBandwidthRateLimitSchedule. * *By default, a gateway's bandwidth rate limits are not set. If you don't set * any limit, the gateway does not have any limitations on its bandwidth usage and could @@ -3441,7 +3444,8 @@ export class StorageGateway extends StorageGatewayClient { *
Updates the bandwidth rate limit schedule for a specified gateway. By default, gateways * do not have bandwidth rate limit schedules, which means no bandwidth rate limiting is in * effect. Use this to initiate or update a gateway's bandwidth rate limit schedule. This - * operation is supported in the volume and tape gateway types.
+ * operation is supported only for volume, tape and S3 file gateways. FSx file gateways do not + * support bandwidth rate limits. */ public updateBandwidthRateLimitSchedule( args: UpdateBandwidthRateLimitScheduleCommandInput, diff --git a/clients/client-storage-gateway/src/commands/DeleteBandwidthRateLimitCommand.ts b/clients/client-storage-gateway/src/commands/DeleteBandwidthRateLimitCommand.ts index 2098a363be306..aed2cdd47ad64 100644 --- a/clients/client-storage-gateway/src/commands/DeleteBandwidthRateLimitCommand.ts +++ b/clients/client-storage-gateway/src/commands/DeleteBandwidthRateLimitCommand.ts @@ -25,8 +25,8 @@ export interface DeleteBandwidthRateLimitCommandOutput extends DeleteBandwidthRa *Deletes the bandwidth rate limits of a gateway. You can delete either the upload and * download bandwidth rate limit, or you can delete both. If you delete only one of the * limits, the other limit remains unchanged. To specify which gateway to work with, use the - * Amazon Resource Name (ARN) of the gateway in your request. This operation is supported for - * the stored volume, cached volume and tape gateway types.
+ * Amazon Resource Name (ARN) of the gateway in your request. This operation is supported only + * for the stored volume, cached volume, and tape gateway types. * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-storage-gateway/src/commands/DescribeBandwidthRateLimitCommand.ts b/clients/client-storage-gateway/src/commands/DescribeBandwidthRateLimitCommand.ts index 1bba866298db8..154285800afa2 100644 --- a/clients/client-storage-gateway/src/commands/DescribeBandwidthRateLimitCommand.ts +++ b/clients/client-storage-gateway/src/commands/DescribeBandwidthRateLimitCommand.ts @@ -23,13 +23,14 @@ export interface DescribeBandwidthRateLimitCommandOutput extends DescribeBandwid /** *Returns the bandwidth rate limits of a gateway. By default, these limits are not set, - * which means no bandwidth rate limiting is in effect. This operation is supported for the - * stored volume, cached volume, and tape gateway types.
+ * which means no bandwidth rate limiting is in effect. This operation is supported only for + * the stored volume, cached volume, and tape gateway types. To describe bandwidth rate limits + * for S3 file gateways, use DescribeBandwidthRateLimitSchedule. * - *This operation only returns a value for a bandwidth rate limit only if the limit is set. - * If no limits are set for the gateway, then this operation returns only the gateway ARN in - * the response body. To specify which gateway to describe, use the Amazon Resource Name (ARN) - * of the gateway in your request.
+ *This operation returns a value for a bandwidth rate limit only if the limit is set. If + * no limits are set for the gateway, then this operation returns only the gateway ARN in the + * response body. To specify which gateway to describe, use the Amazon Resource Name (ARN) of + * the gateway in your request.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-storage-gateway/src/commands/DescribeBandwidthRateLimitScheduleCommand.ts b/clients/client-storage-gateway/src/commands/DescribeBandwidthRateLimitScheduleCommand.ts index 19ea5c4bd4cd8..9e8519ba4eb93 100644 --- a/clients/client-storage-gateway/src/commands/DescribeBandwidthRateLimitScheduleCommand.ts +++ b/clients/client-storage-gateway/src/commands/DescribeBandwidthRateLimitScheduleCommand.ts @@ -26,7 +26,8 @@ export interface DescribeBandwidthRateLimitScheduleCommandOutput /** *Returns information about the bandwidth rate limit schedule of a gateway. By default, * gateways do not have bandwidth rate limit schedules, which means no bandwidth rate limiting - * is in effect. This operation is supported only in the volume and tape gateway types.
+ * is in effect. This operation is supported only for volume, tape and S3 file gateways. FSx + * file gateways do not support bandwidth rate limits. * *This operation returns information about a gateway's bandwidth rate limit schedule. A * bandwidth rate limit schedule consists of one or more bandwidth rate limit intervals. A diff --git a/clients/client-storage-gateway/src/commands/UpdateBandwidthRateLimitCommand.ts b/clients/client-storage-gateway/src/commands/UpdateBandwidthRateLimitCommand.ts index 4248796f2572f..0c8f47af575cf 100644 --- a/clients/client-storage-gateway/src/commands/UpdateBandwidthRateLimitCommand.ts +++ b/clients/client-storage-gateway/src/commands/UpdateBandwidthRateLimitCommand.ts @@ -24,8 +24,9 @@ export interface UpdateBandwidthRateLimitCommandOutput extends UpdateBandwidthRa /** *
Updates the bandwidth rate limits of a gateway. You can update both the upload and * download bandwidth rate limit or specify only one of the two. If you don't set a - * bandwidth rate limit, the existing rate limit remains. This operation is supported for the - * stored volume, cached volume, and tape gateway types.
+ * bandwidth rate limit, the existing rate limit remains. This operation is supported only for + * the stored volume, cached volume, and tape gateway types. To update bandwidth rate limits + * for S3 file gateways, use UpdateBandwidthRateLimitSchedule. * *By default, a gateway's bandwidth rate limits are not set. If you don't set * any limit, the gateway does not have any limitations on its bandwidth usage and could diff --git a/clients/client-storage-gateway/src/commands/UpdateBandwidthRateLimitScheduleCommand.ts b/clients/client-storage-gateway/src/commands/UpdateBandwidthRateLimitScheduleCommand.ts index 98b22b89a2863..8527176d42e3a 100644 --- a/clients/client-storage-gateway/src/commands/UpdateBandwidthRateLimitScheduleCommand.ts +++ b/clients/client-storage-gateway/src/commands/UpdateBandwidthRateLimitScheduleCommand.ts @@ -27,7 +27,8 @@ export interface UpdateBandwidthRateLimitScheduleCommandOutput *
Updates the bandwidth rate limit schedule for a specified gateway. By default, gateways * do not have bandwidth rate limit schedules, which means no bandwidth rate limiting is in * effect. Use this to initiate or update a gateway's bandwidth rate limit schedule. This - * operation is supported in the volume and tape gateway types.
+ * operation is supported only for volume, tape and S3 file gateways. FSx file gateways do not + * support bandwidth rate limits. * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-transcribe/src/Transcribe.ts b/clients/client-transcribe/src/Transcribe.ts index 3c3378e3beb6b..37ed1b27689e1 100644 --- a/clients/client-transcribe/src/Transcribe.ts +++ b/clients/client-transcribe/src/Transcribe.ts @@ -199,9 +199,9 @@ import { TranscribeClient } from "./TranscribeClient"; export class Transcribe extends TranscribeClient { /** *Creates an analytics category. Amazon Transcribe applies the conditions specified by your - * analytics categories to your call analytics jobs. For each analytics category, you specify one or - * more rules. For example, you can specify a rule that the customer sentiment was neutral or - * negative within that category. If you start a call analytics job, Amazon Transcribe applies the + * analytics categories to your call analytics jobs. For each analytics category, you specify one + * or more rules. For example, you can specify a rule that the customer sentiment was neutral + * or negative within that category. If you start a call analytics job, Amazon Transcribe applies the * category to the analytics job that you've specified.
*/ public createCallAnalyticsCategory( @@ -234,8 +234,9 @@ export class Transcribe extends TranscribeClient { } /** - *Creates a new custom language model. Use Amazon S3 prefixes to provide the location of your input files. The time it - * takes to create your model depends on the size of your training data.
+ *Creates a new custom language model. Use Amazon S3 prefixes to provide the location of + * your input files. The time it takes to create your model depends on the size of your training + * data.
*/ public createLanguageModel( args: CreateLanguageModelCommandInput, @@ -267,7 +268,8 @@ export class Transcribe extends TranscribeClient { } /** - *Creates a new custom vocabulary that you can use to modify how Amazon Transcribe Medical transcribes your audio file.
+ *Creates a new custom vocabulary that you can use to modify how Amazon Transcribe Medical transcribes + * your audio file.
*/ public createMedicalVocabulary( args: CreateMedicalVocabularyCommandInput, @@ -332,8 +334,8 @@ export class Transcribe extends TranscribeClient { } /** - *Creates a new vocabulary filter that you can use to filter words, such as profane words, from the output of - * a transcription job.
+ *Creates a new vocabulary filter that you can use to filter words, such as profane words, + * from the output of a transcription job.
*/ public createVocabularyFilter( args: CreateVocabularyFilterCommandInput, @@ -893,7 +895,8 @@ export class Transcribe extends TranscribeClient { /** *Provides more information about the call analytics categories that you've created. You * can use the information in this list to find a specific category. You can then use the - * operation to get more information about it.
+ * operation to get more information about + * it. */ public listCallAnalyticsCategories( args: ListCallAnalyticsCategoriesCommandInput, @@ -957,9 +960,10 @@ export class Transcribe extends TranscribeClient { } /** - *Provides more information about the custom language models you've created. You can use the information in - * this list to find a specific custom language model. You can then use the - * operation to get more information about it.
+ *Provides more information about the custom language models you've created. You can + * use the information in this list to find a specific custom language model. You can then use + * the operation to get more information about + * it.
*/ public listLanguageModels( args: ListLanguageModelsCommandInput, @@ -991,7 +995,8 @@ export class Transcribe extends TranscribeClient { } /** - *Lists medical transcription jobs with a specified status or substring that matches their names.
+ *Lists medical transcription jobs with a specified status or substring that matches their + * names.
*/ public listMedicalTranscriptionJobs( args: ListMedicalTranscriptionJobsCommandInput, @@ -1023,8 +1028,8 @@ export class Transcribe extends TranscribeClient { } /** - *Returns a list of vocabularies that match the specified criteria. If you don't enter a value in any of the request - * parameters, returns the entire list of vocabularies.
+ *Returns a list of vocabularies that match the specified criteria. If you don't enter a value in + * any of the request parameters, returns the entire list of vocabularies.
*/ public listMedicalVocabularies( args: ListMedicalVocabulariesCommandInput, @@ -1120,8 +1125,8 @@ export class Transcribe extends TranscribeClient { } /** - *Returns a list of vocabularies that match the specified criteria. If no criteria are specified, returns the entire list - * of vocabularies.
+ *Returns a list of vocabularies that match the specified criteria. If no criteria are specified, + * returns the entire list of vocabularies.
*/ public listVocabularies( args: ListVocabulariesCommandInput, @@ -1185,10 +1190,11 @@ export class Transcribe extends TranscribeClient { } /** - *Starts an asynchronous analytics job that not only transcribes the audio recording of a caller and agent, but - * also returns additional insights. These insights include how quickly or loudly the caller or agent was speaking. To - * retrieve additional insights with your analytics jobs, create categories. A category is a way to classify analytics jobs - * based on attributes, such as a customer's sentiment or a particular phrase being used during the call. For more + *
Starts an asynchronous analytics job that not only transcribes the audio recording of a + * caller and agent, but also returns additional insights. These insights include how quickly or + * loudly the caller or agent was speaking. To retrieve additional insights with your analytics + * jobs, create categories. A category is a way to classify analytics jobs based on attributes, + * such as a customer's sentiment or a particular phrase being used during the call. For more * information, see the operation.
*/ public startCallAnalyticsJob( @@ -1343,8 +1349,9 @@ export class Transcribe extends TranscribeClient { } /** - *Updates the call analytics category with new values. The UpdateCallAnalyticsCategory
- * operation overwrites all of the existing information with the values that you provide in the request.
Updates the call analytics category with new values. The
+ * UpdateCallAnalyticsCategory operation overwrites all of the existing
+ * information with the values that you provide in the request.
Updates a vocabulary with new values that you provide in a different text file from the one you used to create
- * the vocabulary. The UpdateMedicalVocabulary operation overwrites all of the existing information
- * with the values that you provide in the request.
Updates a vocabulary with new values that you provide in a different text file from
+ * the one you used to create the vocabulary. The UpdateMedicalVocabulary
+ * operation overwrites all of the existing information with the values that you provide in the
+ * request.
Updates an existing vocabulary with new values. The UpdateVocabulary operation overwrites
- * all of the existing information with the values that you provide in the request.
Updates an existing vocabulary with new values. The
+ * UpdateVocabulary operation overwrites all of the existing information with
+ * the values that you provide in the request.
Creates an analytics category. Amazon Transcribe applies the conditions specified by your - * analytics categories to your call analytics jobs. For each analytics category, you specify one or - * more rules. For example, you can specify a rule that the customer sentiment was neutral or - * negative within that category. If you start a call analytics job, Amazon Transcribe applies the + * analytics categories to your call analytics jobs. For each analytics category, you specify one + * or more rules. For example, you can specify a rule that the customer sentiment was neutral + * or negative within that category. If you start a call analytics job, Amazon Transcribe applies the * category to the analytics job that you've specified.
* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-transcribe/src/commands/CreateLanguageModelCommand.ts b/clients/client-transcribe/src/commands/CreateLanguageModelCommand.ts index 96d4ee2d0ae83..96347e91a495a 100644 --- a/clients/client-transcribe/src/commands/CreateLanguageModelCommand.ts +++ b/clients/client-transcribe/src/commands/CreateLanguageModelCommand.ts @@ -22,8 +22,9 @@ export interface CreateLanguageModelCommandInput extends CreateLanguageModelRequ export interface CreateLanguageModelCommandOutput extends CreateLanguageModelResponse, __MetadataBearer {} /** - *Creates a new custom language model. Use Amazon S3 prefixes to provide the location of your input files. The time it - * takes to create your model depends on the size of your training data.
+ *Creates a new custom language model. Use Amazon S3 prefixes to provide the location of + * your input files. The time it takes to create your model depends on the size of your training + * data.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-transcribe/src/commands/CreateMedicalVocabularyCommand.ts b/clients/client-transcribe/src/commands/CreateMedicalVocabularyCommand.ts index f0b9cf5bba466..00970bf48eca0 100644 --- a/clients/client-transcribe/src/commands/CreateMedicalVocabularyCommand.ts +++ b/clients/client-transcribe/src/commands/CreateMedicalVocabularyCommand.ts @@ -22,7 +22,8 @@ export interface CreateMedicalVocabularyCommandInput extends CreateMedicalVocabu export interface CreateMedicalVocabularyCommandOutput extends CreateMedicalVocabularyResponse, __MetadataBearer {} /** - *Creates a new custom vocabulary that you can use to modify how Amazon Transcribe Medical transcribes your audio file.
+ *Creates a new custom vocabulary that you can use to modify how Amazon Transcribe Medical transcribes + * your audio file.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-transcribe/src/commands/CreateVocabularyFilterCommand.ts b/clients/client-transcribe/src/commands/CreateVocabularyFilterCommand.ts index cb29b5f128b5c..978161bf28cc4 100644 --- a/clients/client-transcribe/src/commands/CreateVocabularyFilterCommand.ts +++ b/clients/client-transcribe/src/commands/CreateVocabularyFilterCommand.ts @@ -22,8 +22,8 @@ export interface CreateVocabularyFilterCommandInput extends CreateVocabularyFilt export interface CreateVocabularyFilterCommandOutput extends CreateVocabularyFilterResponse, __MetadataBearer {} /** - *Creates a new vocabulary filter that you can use to filter words, such as profane words, from the output of - * a transcription job.
+ *Creates a new vocabulary filter that you can use to filter words, such as profane words, + * from the output of a transcription job.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-transcribe/src/commands/ListCallAnalyticsCategoriesCommand.ts b/clients/client-transcribe/src/commands/ListCallAnalyticsCategoriesCommand.ts index 648808dc4a92e..d06b5b9af276a 100644 --- a/clients/client-transcribe/src/commands/ListCallAnalyticsCategoriesCommand.ts +++ b/clients/client-transcribe/src/commands/ListCallAnalyticsCategoriesCommand.ts @@ -26,7 +26,8 @@ export interface ListCallAnalyticsCategoriesCommandOutput /** *Provides more information about the call analytics categories that you've created. You * can use the information in this list to find a specific category. You can then use the - * operation to get more information about it.
+ * operation to get more information about + * it. * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-transcribe/src/commands/ListLanguageModelsCommand.ts b/clients/client-transcribe/src/commands/ListLanguageModelsCommand.ts index 02d01961b0d5a..a0c3e81db1b0e 100644 --- a/clients/client-transcribe/src/commands/ListLanguageModelsCommand.ts +++ b/clients/client-transcribe/src/commands/ListLanguageModelsCommand.ts @@ -22,9 +22,10 @@ export interface ListLanguageModelsCommandInput extends ListLanguageModelsReques export interface ListLanguageModelsCommandOutput extends ListLanguageModelsResponse, __MetadataBearer {} /** - *Provides more information about the custom language models you've created. You can use the information in - * this list to find a specific custom language model. You can then use the - * operation to get more information about it.
+ *Provides more information about the custom language models you've created. You can + * use the information in this list to find a specific custom language model. You can then use + * the operation to get more information about + * it.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-transcribe/src/commands/ListMedicalTranscriptionJobsCommand.ts b/clients/client-transcribe/src/commands/ListMedicalTranscriptionJobsCommand.ts index cfbe4620b79cf..2c2b463bfd465 100644 --- a/clients/client-transcribe/src/commands/ListMedicalTranscriptionJobsCommand.ts +++ b/clients/client-transcribe/src/commands/ListMedicalTranscriptionJobsCommand.ts @@ -24,7 +24,8 @@ export interface ListMedicalTranscriptionJobsCommandOutput __MetadataBearer {} /** - *Lists medical transcription jobs with a specified status or substring that matches their names.
+ *Lists medical transcription jobs with a specified status or substring that matches their + * names.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-transcribe/src/commands/ListMedicalVocabulariesCommand.ts b/clients/client-transcribe/src/commands/ListMedicalVocabulariesCommand.ts index 1c32552112995..ab0f76a1fa880 100644 --- a/clients/client-transcribe/src/commands/ListMedicalVocabulariesCommand.ts +++ b/clients/client-transcribe/src/commands/ListMedicalVocabulariesCommand.ts @@ -22,8 +22,8 @@ export interface ListMedicalVocabulariesCommandInput extends ListMedicalVocabula export interface ListMedicalVocabulariesCommandOutput extends ListMedicalVocabulariesResponse, __MetadataBearer {} /** - *Returns a list of vocabularies that match the specified criteria. If you don't enter a value in any of the request - * parameters, returns the entire list of vocabularies.
+ *Returns a list of vocabularies that match the specified criteria. If you don't enter a value in + * any of the request parameters, returns the entire list of vocabularies.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-transcribe/src/commands/ListVocabulariesCommand.ts b/clients/client-transcribe/src/commands/ListVocabulariesCommand.ts index 9c531d640501f..5a23b26e355dd 100644 --- a/clients/client-transcribe/src/commands/ListVocabulariesCommand.ts +++ b/clients/client-transcribe/src/commands/ListVocabulariesCommand.ts @@ -22,8 +22,8 @@ export interface ListVocabulariesCommandInput extends ListVocabulariesRequest {} export interface ListVocabulariesCommandOutput extends ListVocabulariesResponse, __MetadataBearer {} /** - *Returns a list of vocabularies that match the specified criteria. If no criteria are specified, returns the entire list - * of vocabularies.
+ *Returns a list of vocabularies that match the specified criteria. If no criteria are specified, + * returns the entire list of vocabularies.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-transcribe/src/commands/StartCallAnalyticsJobCommand.ts b/clients/client-transcribe/src/commands/StartCallAnalyticsJobCommand.ts index b69e1e98a58ce..450ee11723e86 100644 --- a/clients/client-transcribe/src/commands/StartCallAnalyticsJobCommand.ts +++ b/clients/client-transcribe/src/commands/StartCallAnalyticsJobCommand.ts @@ -22,10 +22,11 @@ export interface StartCallAnalyticsJobCommandInput extends StartCallAnalyticsJob export interface StartCallAnalyticsJobCommandOutput extends StartCallAnalyticsJobResponse, __MetadataBearer {} /** - *Starts an asynchronous analytics job that not only transcribes the audio recording of a caller and agent, but - * also returns additional insights. These insights include how quickly or loudly the caller or agent was speaking. To - * retrieve additional insights with your analytics jobs, create categories. A category is a way to classify analytics jobs - * based on attributes, such as a customer's sentiment or a particular phrase being used during the call. For more + *
Starts an asynchronous analytics job that not only transcribes the audio recording of a + * caller and agent, but also returns additional insights. These insights include how quickly or + * loudly the caller or agent was speaking. To retrieve additional insights with your analytics + * jobs, create categories. A category is a way to classify analytics jobs based on attributes, + * such as a customer's sentiment or a particular phrase being used during the call. For more * information, see the operation.
* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-transcribe/src/commands/UpdateCallAnalyticsCategoryCommand.ts b/clients/client-transcribe/src/commands/UpdateCallAnalyticsCategoryCommand.ts index 9a53b61929320..ec3f2ac8a80ce 100644 --- a/clients/client-transcribe/src/commands/UpdateCallAnalyticsCategoryCommand.ts +++ b/clients/client-transcribe/src/commands/UpdateCallAnalyticsCategoryCommand.ts @@ -24,8 +24,9 @@ export interface UpdateCallAnalyticsCategoryCommandOutput __MetadataBearer {} /** - *Updates the call analytics category with new values. The UpdateCallAnalyticsCategory
- * operation overwrites all of the existing information with the values that you provide in the request.
Updates the call analytics category with new values. The
+ * UpdateCallAnalyticsCategory operation overwrites all of the existing
+ * information with the values that you provide in the request.
Updates a vocabulary with new values that you provide in a different text file from the one you used to create
- * the vocabulary. The UpdateMedicalVocabulary operation overwrites all of the existing information
- * with the values that you provide in the request.
Updates a vocabulary with new values that you provide in a different text file from
+ * the one you used to create the vocabulary. The UpdateMedicalVocabulary
+ * operation overwrites all of the existing information with the values that you provide in the
+ * request.
Updates an existing vocabulary with new values. The UpdateVocabulary operation overwrites
- * all of the existing information with the values that you provide in the request.
Updates an existing vocabulary with new values. The
+ * UpdateVocabulary operation overwrites all of the existing information with
+ * the values that you provide in the request.
A value that indicates the beginning of the time range in seconds. To set absolute time range, you must specify a - * start time and an end time. For example, if you specify the following values:
+ *A value that indicates the beginning of the time range in seconds. To set absolute time + * range, you must specify a start time and an end time. For example, if you specify the following + * values:
*StartTime - 10000
@@ -15,13 +16,15 @@ export interface AbsoluteTimeRange { *Endtime - 50000
*The time range is set between 10,000 milliseconds and 50,000 milliseconds into the call.
+ *The time range is set between 10,000 milliseconds and 50,000 milliseconds into the + * call.
*/ StartTime?: number; /** - *A value that indicates the end of the time range in milliseconds. To set absolute time range, you must specify a start - * time and an end time. For example, if you specify the following values:
+ *A value that indicates the end of the time range in milliseconds. To set absolute time + * range, you must specify a start time and an end time. For example, if you specify the following + * values:
*StartTime - 10000
@@ -30,19 +33,22 @@ export interface AbsoluteTimeRange { *Endtime - 50000
*The time range is set between 10,000 milliseconds and 50,000 milliseconds into the call.
+ *The time range is set between 10,000 milliseconds and 50,000 milliseconds into the + * call.
*/ EndTime?: number; /** - *A time range from the beginning of the call to the value that you've specified. For example, if you specify 100000, the - * time range is set to the first 100,000 milliseconds of the call.
+ *A time range from the beginning of the call to the value that you've specified. For example,
+ * if you specify 100000, the time range is set to the first 100,000 milliseconds
+ * of the call.
A time range from the value that you've specified to the end of the call. For example, if you specify 100000, the time - * range is set to the last 100,000 milliseconds of the call.
+ *A time range from the value that you've specified to the end of the call. For example, if you
+ * specify 100000, the time range is set to the last 100,000 milliseconds of the
+ * call.
Your request didn't pass one or more validation tests. For example, if the entity that you're trying to delete
- * doesn't exist or if it is in a non-terminal state (for example, it's "in progress"). See the exception Message
- * field for more information.
Your request didn't pass one or more validation tests. For example, if the entity that
+ * you're trying to delete doesn't exist or if it is in a non-terminal state (for example, it's
+ * "in progress"). See the exception Message field for more information.
For a call analytics job, an object that indicates the audio channel that belongs to the agent and the audio - * channel that belongs to the customer.
+ *For a call analytics job, an object that indicates the audio channel that belongs to the + * agent and the audio channel that belongs to the customer.
*/ export interface ChannelDefinition { /** @@ -95,7 +101,8 @@ export interface ChannelDefinition { ChannelId?: number; /** - *Indicates whether the person speaking on the audio channel is the agent or customer.
+ *Indicates whether the person speaking on the audio channel is the agent or + * customer.
*/ ParticipantRole?: ParticipantRole | string; } @@ -157,19 +164,26 @@ export enum LanguageCode { */ export interface Media { /** - *The S3 object location of the input media file. The URI must be in the same region as the API endpoint that you - * are calling. The general form is:
- * + *The S3 object location of the input media file. The URI must be in the same region as + * the API endpoint that you are calling. The general form is:
+ *
+ * s3://
+ *
For example:
- * - * - *For more information about S3 object names, see Object Keys in the Amazon S3 - * Developer Guide.
+ *
+ * s3://AWSDOC-EXAMPLE-BUCKET/example.mp4
+ *
+ * s3://AWSDOC-EXAMPLE-BUCKET/mediadocs/example.mp4
+ *
For more information about S3 object names, see Object Keys in the + * Amazon S3 Developer Guide.
*/ MediaFileUri?: string; /** - *The S3 object location for your redacted output media file. This is only supported for call analytics jobs.
+ *The S3 object location for your redacted output media file. This is only supported for + * call analytics jobs.
*/ RedactedMediaFileUri?: string; } @@ -193,6 +207,21 @@ export enum MediaFormat { WEBM = "webm", } +export enum PiiEntityType { + ADDRESS = "ADDRESS", + ALL = "ALL", + BANK_ACCOUNT_NUMBER = "BANK_ACCOUNT_NUMBER", + BANK_ROUTING = "BANK_ROUTING", + CREDIT_DEBIT_CVV = "CREDIT_DEBIT_CVV", + CREDIT_DEBIT_EXPIRY = "CREDIT_DEBIT_EXPIRY", + CREDIT_DEBIT_NUMBER = "CREDIT_DEBIT_NUMBER", + EMAIL = "EMAIL", + NAME = "NAME", + PHONE = "PHONE", + PIN = "PIN", + SSN = "SSN", +} + export enum RedactionOutput { REDACTED = "redacted", REDACTED_AND_UNREDACTED = "redacted_and_unredacted", @@ -207,17 +236,26 @@ export enum RedactionType { */ export interface ContentRedaction { /** - *Request parameter that defines the entities to be redacted. The only accepted value is PII.
Request parameter that defines the entities to be redacted. The only accepted value is
+ * PII.
The output transcript file stored in either the default S3 bucket or in a bucket you specify.
- *When you choose redacted Amazon Transcribe outputs only the redacted transcript.
When you choose redacted_and_unredacted Amazon Transcribe outputs both the redacted and
- * unredacted transcripts.
The output transcript file stored in either the default S3 bucket or in a bucket you + * specify.
+ *When you choose redacted Amazon Transcribe outputs only the redacted
+ * transcript.
When you choose redacted_and_unredacted Amazon Transcribe outputs both the
+ * redacted and unredacted transcripts.
The types of personally identifiable information (PII) you want to redact in your + * transcript.
+ */ + PiiEntityTypes?: (PiiEntityType | string)[]; } export namespace ContentRedaction { @@ -230,27 +268,28 @@ export namespace ContentRedaction { } /** - *Language-specific settings that can be specified when language identification is enabled.
+ *Language-specific settings that can be specified when language identification is + * enabled.
*/ export interface LanguageIdSettings { /** *The name of the vocabulary you want to use when processing your transcription job. The - * vocabulary you specify must have the same language code as the transcription job; if the languages don't - * match, the vocabulary won't be applied.
+ * vocabulary you specify must have the same language codes as the transcription job; if the + * languages don't match, the vocabulary isn't applied. */ VocabularyName?: string; /** - *The name of the vocabulary filter you want to use when transcribing your audio. The filter you specify - * must have the same language code as the transcription job; if the languages don't match, the vocabulary - * filter won't be applied.
+ *The name of the vocabulary filter you want to use when transcribing your audio. The filter + * you specify must have the same language codes as the transcription job; if the languages + * don't match, the vocabulary filter isn't be applied.
*/ VocabularyFilterName?: string; /** - *The name of the language model you want to use when transcribing your audio. The model you specify - * must have the same language code as the transcription job; if the languages don't match, the language model - * won't be applied.
+ *The name of the language model you want to use when transcribing your audio. The + * model you specify must have the same language codes as the transcription job; if the + * languages don't match, the language model isn't be applied.
*/ LanguageModelName?: string; } @@ -280,16 +319,18 @@ export interface CallAnalyticsJobSettings { VocabularyName?: string; /** - *The name of the vocabulary filter to use when running a call analytics job. The filter that you specify must have the - * same language code as the analytics job.
+ *The name of the vocabulary filter to use when running a call analytics job. The filter that + * you specify must have the same language code as the analytics job.
*/ VocabularyFilterName?: string; /** - *Set to mask to remove filtered text from the transcript and replace it with three asterisks ("***") as placeholder text.
- * Set to remove to remove filtered text from the transcript without using placeholder text. Set to
- * tag to mark the word in the transcription output that matches the vocabulary filter. When you set the
- * filter method to tag, the words matching your vocabulary filter are not masked or removed.
Set to mask to remove filtered text from the transcript and replace it with three
+ * asterisks ("***") as placeholder text. Set to remove to remove filtered text
+ * from the transcript without using placeholder text. Set to tag to mark the word
+ * in the transcription output that matches the vocabulary filter. When you set the filter method
+ * to tag, the words matching your vocabulary filter are not masked or
+ * removed.
When you run a call analytics job, you can specify the language spoken in the audio, or you can have Amazon Transcribe identify - * the language for you.
- *To specify a language, specify an array with one language code. If you don't know the language, you can leave this - * field blank and Amazon Transcribe will use machine learning to identify the language for you. To improve the ability of Amazon Transcribe to - * correctly identify the language, you can provide an array of the languages that can be present in the audio. Refer to - * Supported languages and language-specific - * features for additional information.
+ *When you run a call analytics job, you can specify the language spoken in the audio, or + * you can have Amazon Transcribe identify the language for you.
+ *To specify a language, specify an array with one language code. If you don't know the + * language, you can leave this field blank and Amazon Transcribe will use machine learning to identify the + * language for you. To improve the ability of Amazon Transcribe to correctly identify the language, you can + * provide an array of the languages that can be present in the audio. Refer to + * Supported languages for + * additional information.
*/ LanguageOptions?: (LanguageCode | string)[]; /** - *The language identification settings associated with your call analytics job. These settings include
- * VocabularyName, VocabularyFilterName, and
+ *
The language identification settings associated with your call analytics job. These settings
+ * include VocabularyName, VocabularyFilterName, and
* LanguageModelName.
The S3 object location of the transcript.
- *Use this URI to access the transcript. If you specified an S3 bucket in the OutputBucketName
- * field when you created the job, this is the URI of that bucket. If you chose to store the transcript in Amazon Transcribe, this is a
- * shareable URL that provides secure access to that location.
Use this URI to access the transcript. If you specified an S3 bucket in the
+ * OutputBucketName field when you created the job, this is the URI of that
+ * bucket. If you chose to store the transcript in Amazon Transcribe, this is a shareable URL that provides
+ * secure access to that location.
The S3 object location of the redacted transcript.
*Use this URI to access the redacted transcript. If you specified an S3 bucket in the
- * OutputBucketName field when you created the job, this is the URI of that bucket. If you chose to store
- * the transcript in Amazon Transcribe, this is a shareable URL that provides secure access to that location.
OutputBucketName field when you created the job, this is the URI of that
+ * bucket. If you chose to store the transcript in Amazon Transcribe, this is a shareable URL that provides
+ * secure access to that location.
*/
RedactedTranscriptFileUri?: string;
}
@@ -362,8 +406,8 @@ export namespace Transcript {
}
/**
- * Describes an asynchronous analytics job that was created with the StartAnalyticsJob
- * operation.
Describes an asynchronous analytics job that was created with the
+ * StartAnalyticsJob operation.
If you know the language spoken between the customer and the agent, specify a language code for this field.
- *If you don't know the language, you can leave this field blank, and Amazon Transcribe will use machine learning to automatically - * identify the language. To improve the accuracy of language identification, you can provide an array containing the - * possible language codes for the language spoken in your audio. Refer to Supported languages and language-specific features for + *
If you know the language spoken between the customer and the agent, specify a + * language code for this field.
+ *If you don't know the language, you can leave this field blank, and Amazon Transcribe will use machine + * learning to automatically identify the language. To improve the accuracy of language + * identification, you can provide an array containing the possible language codes for the + * language spoken in your audio. Refer to Supported languages for * additional information.
*/ LanguageCode?: LanguageCode | string; @@ -391,8 +437,8 @@ export interface CallAnalyticsJob { MediaSampleRateHertz?: number; /** - *The format of the input audio file. Note: for call analytics jobs, only the following media formats are supported: MP3, - * MP4, WAV, FLAC, OGG, and WebM.
+ *The format of the input audio file. Note: for call analytics jobs, only the following media + * formats are supported: MP3, MP4, WAV, FLAC, OGG, and WebM.
*/ MediaFormat?: MediaFormat | string; @@ -422,61 +468,66 @@ export interface CallAnalyticsJob { CompletionTime?: Date; /** - *If the AnalyticsJobStatus is FAILED, this field contains information about why
- * the job failed.
If the AnalyticsJobStatus is FAILED, this field contains
+ * information about why the job failed.
The FailureReason field can contain one of the following values:
+ *
* Unsupported media format: The media format specified in the
- * MediaFormat field of the request isn't valid. See the description of the MediaFormat
- * field for a list of valid values.
MediaFormat field of the request isn't valid. See the description of the
+ * MediaFormat field for a list of valid values.
*
- * The media format provided does not match the detected media format: The media
- * format of the audio file doesn't match the format specified in the MediaFormat field in the request.
- * Check the media format of your media file and make sure the two values match.
+ * The media format provided does not match the detected media
+ * format: The media format of the audio file doesn't match the format specified
+ * in the MediaFormat field in the request. Check the media format of your
+ * media file and make sure the two values match.
+ *
* Invalid sample rate for audio file: The sample rate specified in the
- * MediaSampleRateHertz of the request isn't valid. The sample rate must be between 8,000 and 48,000
- * Hertz.
MediaSampleRateHertz of the request isn't valid. The sample rate must be
+ * between 8,000 and 48,000 Hertz.
*
- * The sample rate provided does not match the detected sample rate: The sample rate
- * in the audio file doesn't match the sample rate specified in the MediaSampleRateHertz field in the
- * request. Check the sample rate of your media file and make sure that the two values match.
The sample rate provided does not match the detected sample
+ * rate: The sample rate in the audio file doesn't match the sample rate specified in
+ * the MediaSampleRateHertz field in the request. Check the sample rate of
+ * your media file and make sure that the two values match.
*
- * Invalid file size: file size too large: The size of your audio file is larger than what Amazon Transcribe Medical
- * can process. For more information, see Guidelines and Quotas in the Amazon Transcribe Medical
- * Guide.
+ * Invalid file size: file size too large: The size of your audio file is larger
+ * than what Amazon Transcribe Medical can process. For more information, see Guidelines and
+ * Quotas in the Amazon Transcribe Medical Guide.
- * Invalid number of channels: number of channels too large: Your audio contains more
- * channels than Amazon Transcribe Medical is configured to process. To request additional channels, see Amazon Transcribe Medical Endpoints and Quotas in the
- * Amazon Web Services General
- * Reference.
+ * Invalid number of channels: number of channels too large: Your
+ * audio contains more channels than Amazon Transcribe Medical is configured to process. To request additional
+ * channels, see Amazon Transcribe Medical Endpoints and Quotas in the
+ * Amazon Web
+ * Services General Reference.
The Amazon Resource Number (ARN) that you use to access the analytics job. ARNs have the format + *
The Amazon Resource Number (ARN) that you use to access the analytics job. ARNs
+ * have the format
* arn:partition:service:region:account-id:resource-type/resource-id.
A value between zero and one that Amazon Transcribe assigned to the language that it identified in the source audio. This value - * appears only when you don't provide a single language code. Larger values indicate that Amazon Transcribe has higher confidence in - * the language that it identified
+ *A value between zero and one that Amazon Transcribe assigned to the language that it identified in + * the source audio. This value appears only when you don't provide a single language code. + * Larger values indicate that Amazon Transcribe has higher confidence in the language that it + * identified.
*/ IdentifiedLanguageScore?: number; @@ -486,8 +537,8 @@ export interface CallAnalyticsJob { Settings?: CallAnalyticsJobSettings; /** - *Shows numeric values to indicate the channel assigned to the agent's audio and the channel assigned to the - * customer's audio.
+ *Shows numeric values to indicate the channel assigned to the agent's audio and the + * channel assigned to the customer's audio.
*/ ChannelDefinitions?: ChannelDefinition[]; } @@ -536,7 +587,8 @@ export interface CallAnalyticsJobSummary { CallAnalyticsJobStatus?: CallAnalyticsJobStatus | string; /** - *If the CallAnalyticsJobStatus is FAILED, a description of the error.
If the CallAnalyticsJobStatus is FAILED, a description of
+ * the error.
An object that allows percentages to specify the proportion of the call where you would like to apply a filter. For - * example, you can specify the first half of the call. You can also specify the period of time between halfway through to - * three-quarters of the way through the call. Because the length of conversation can vary between calls, you can apply + *
An object that allows percentages to specify the proportion of the call where you + * would like to apply a filter. For example, you can specify the first half of the call. You can + * also specify the period of time between halfway through to three-quarters of the way + * through the call. Because the length of conversation can vary between calls, you can apply * relative time ranges across all calls.
*/ export interface RelativeTimeRange { /** - *A value that indicates the percentage of the beginning of the time range. To set a relative time range, you must - * specify a start percentage and an end percentage. For example, if you specify the following values:
+ *A value that indicates the percentage of the beginning of the time range. To set a + * relative time range, you must specify a start percentage and an end percentage. For + * example, if you specify the following values:
*StartPercentage - 10
@@ -568,15 +622,16 @@ export interface RelativeTimeRange { *EndPercentage - 50
*This looks at the time range starting from 10% of the way into the call to 50% of the way through the call. For - * a call that lasts 100,000 milliseconds, this example range would apply from the 10,000 millisecond mark to the - * 50,000 millisecond mark.
+ *This looks at the time range starting from 10% of the way into the call to 50% of + * the way through the call. For a call that lasts 100,000 milliseconds, this example range + * would apply from the 10,000 millisecond mark to the 50,000 millisecond mark.
*/ StartPercentage?: number; /** - *A value that indicates the percentage of the end of the time range. To set a relative time range, you must specify - * a start percentage and an end percentage. For example, if you specify the following values:
+ *A value that indicates the percentage of the end of the time range. To set a relative + * time range, you must specify a start percentage and an end percentage. For example, if + * you specify the following values:
*StartPercentage - 10
@@ -585,22 +640,24 @@ export interface RelativeTimeRange { *EndPercentage - 50
*This looks at the time range starting from 10% of the way into the call to 50% of the way through the call. For a - * call that lasts 100,000 milliseconds, this example range would apply from the 10,000 millisecond mark to the 50,000 - * millisecond mark.
+ *This looks at the time range starting from 10% of the way into the call to 50% of the + * way through the call. For a call that lasts 100,000 milliseconds, this example range would + * apply from the 10,000 millisecond mark to the 50,000 millisecond mark.
*/ EndPercentage?: number; /** - *A range that takes the portion of the call up to the time in milliseconds set by the value that you've specified. For
- * example, if you specify 120000, the time range is set for the first 120,000 milliseconds of the call.
A range that takes the portion of the call up to the time in milliseconds set by the
+ * value that you've specified. For example, if you specify 120000, the time
+ * range is set for the first 120,000 milliseconds of the call.
A range that takes the portion of the call from the time in milliseconds set by the value that you've specified to
- * the end of the call. For example, if you specify 120000, the time range is set for the last 120,000
- * milliseconds of the call.
A range that takes the portion of the call from the time in milliseconds set by the
+ * value that you've specified to the end of the call. For example, if you specify
+ * 120000, the time range is set for the last 120,000 milliseconds of the
+ * call.
An object that enables you to configure your category to be applied to call analytics jobs where either the - * customer or agent was interrupted.
+ *An object that enables you to configure your category to be applied to call analytics + * jobs where either the customer or agent was interrupted.
*/ export interface InterruptionFilter { /** @@ -630,17 +687,19 @@ export interface InterruptionFilter { ParticipantRole?: ParticipantRole | string; /** - *An object you can use to specify a time range (in milliseconds) for when you'd want to find the interruption. For - * example, you could search for an interruption between the 30,000 millisecond mark and the 45,000 millisecond mark. - * You could also specify the time period as the first 15,000 milliseconds or the last 15,000 milliseconds.
+ *An object you can use to specify a time range (in milliseconds) for when you'd want to + * find the interruption. For example, you could search for an interruption between the 30,000 + * millisecond mark and the 45,000 millisecond mark. You could also specify the time period as + * the first 15,000 milliseconds or the last 15,000 milliseconds.
*/ AbsoluteTimeRange?: AbsoluteTimeRange; /** - *An object that allows percentages to specify the proportion of the call where there was a interruption. For - * example, you can specify the first half of the call. You can also specify the period of time between halfway through to - * three-quarters of the way through the call. Because the length of conversation can vary between calls, you can apply - * relative time ranges across all calls.
+ *An object that allows percentages to specify the proportion of the call where there was + * a interruption. For example, you can specify the first half of the call. You can also specify the + * period of time between halfway through to three-quarters of the way through the call. + * Because the length of conversation can vary between calls, you can apply relative time + * ranges across all calls.
*/ RelativeTimeRange?: RelativeTimeRange; @@ -660,8 +719,8 @@ export namespace InterruptionFilter { } /** - *An object that enables you to configure your category to be applied to call analytics jobs where either the - * customer or agent was interrupted.
+ *An object that enables you to configure your category to be applied to call analytics + * jobs where either the customer or agent was interrupted.
*/ export interface NonTalkTimeFilter { /** @@ -670,16 +729,18 @@ export interface NonTalkTimeFilter { Threshold?: number; /** - *An object you can use to specify a time range (in milliseconds) for when no one is talking. For example, you - * could specify a time period between the 30,000 millisecond mark and the 45,000 millisecond mark. You could also - * specify the time period as the first 15,000 milliseconds or the last 15,000 milliseconds.
+ *An object you can use to specify a time range (in milliseconds) for when no one is + * talking. For example, you could specify a time period between the 30,000 millisecond mark + * and the 45,000 millisecond mark. You could also specify the time period as the first 15,000 + * milliseconds or the last 15,000 milliseconds.
*/ AbsoluteTimeRange?: AbsoluteTimeRange; /** - *An object that allows percentages to specify the proportion of the call where there was silence. For example, you - * can specify the first half of the call. You can also specify the period of time between halfway through to three-quarters - * of the way through the call. Because the length of conversation can vary between calls, you can apply relative time + *
An object that allows percentages to specify the proportion of the call where there + * was silence. For example, you can specify the first half of the call. You can also specify + * the period of time between halfway through to three-quarters of the way through the call. + * Because the length of conversation can vary between calls, you can apply relative time * ranges across all calls.
*/ RelativeTimeRange?: RelativeTimeRange; @@ -707,13 +768,15 @@ export enum SentimentValue { } /** - *An object that enables you to specify a particular customer or agent sentiment. If at least 50 percent of the - * conversation turns (the back-and-forth between two speakers) in a specified time period match the specified - * sentiment, Amazon Transcribe will consider the sentiment a match.
+ *An object that enables you to specify a particular customer or agent sentiment. If at + * least 50 percent of the conversation turns (the back-and-forth between two speakers) in a + * specified time period match the specified sentiment, Amazon Transcribe will consider the sentiment a + * match.
*/ export interface SentimentFilter { /** - *An array that enables you to specify sentiments for the customer or agent. You can specify one or more values.
+ *An array that enables you to specify sentiments for the customer or agent. You can + * specify one or more values.
*/ Sentiments: (SentimentValue | string)[] | undefined; @@ -733,7 +796,7 @@ export interface SentimentFilter { ParticipantRole?: ParticipantRole | string; /** - *Set to TRUE to look for sentiments that weren't specified in the request.
Set to TRUE to look for sentiments that weren't specified in the request.
Matches the output of the transcription to either the specific phrases that you specify, or the intent of the phrases - * that you specify.
+ *Matches the output of the transcription to either the specific phrases that you specify, + * or the intent of the phrases that you specify.
*/ export interface TranscriptFilter { /** - *Matches the phrase to the transcription output in a word for word fashion. - * For example, if you specify the phrase "I want to speak to the manager." Amazon Transcribe attempts to match that specific - * phrase to the transcription.
+ *Matches the phrase to the transcription output in a word + * for word fashion. For example, if you specify the phrase "I want to speak to the manager." + * Amazon Transcribe attempts to match that specific phrase to the transcription.
*/ TranscriptFilterType: TranscriptFilterType | string | undefined; @@ -769,21 +832,23 @@ export interface TranscriptFilter { AbsoluteTimeRange?: AbsoluteTimeRange; /** - *An object that allows percentages to specify the proportion of the call where you would like to apply a filter. For - * example, you can specify the first half of the call. You can also specify the period of time between halfway through to - * three-quarters of the way through the call. Because the length of conversation can vary between calls, you can - * apply relative time ranges across all calls.
+ *An object that allows percentages to specify the proportion of the call where you would + * like to apply a filter. For example, you can specify the first half of the call. You can also + * specify the period of time between halfway through to three-quarters of the way through + * the call. Because the length of conversation can vary between calls, you can apply relative + * time ranges across all calls.
*/ RelativeTimeRange?: RelativeTimeRange; /** - *Determines whether the customer or the agent is speaking the phrases that you've specified.
+ *Determines whether the customer or the agent is speaking the phrases that you've + * specified.
*/ ParticipantRole?: ParticipantRole | string; /** - *If TRUE, the rule that you specify is applied to everything except for the phrases that you
- * specify.
If TRUE, the rule that you specify is applied to everything except for the
+ * phrases that you specify.
A condition in the call between the customer and the agent that you want to filter for.
+ *A condition in the call between the customer and the agent that you want to filter + * for.
*/ export type Rule = | Rule.InterruptionFilterMember @@ -837,8 +903,9 @@ export namespace Rule { } /** - *A condition that catches particular words or phrases based on a exact match. For example, if you set the - * phrase "I want to speak to the manager", only that exact phrase will be returned.
+ *A condition that catches particular words or phrases based on a exact match. For + * example, if you set the phrase "I want to speak to the manager", only that exact phrase will + * be returned.
*/ export interface TranscriptFilterMember { NonTalkTimeFilter?: never; @@ -900,7 +967,8 @@ export namespace Rule { } /** - *An object that contains the rules and additional information about a call analytics category.
+ *An object that contains the rules and additional information about a call analytics + * category.
*/ export interface CategoryProperties { /** @@ -919,7 +987,8 @@ export interface CategoryProperties { CreateTime?: Date; /** - *A timestamp that shows when the call analytics category was most recently updated.
+ *A timestamp that shows when the call analytics category was most recently + * updated.
*/ LastUpdateTime?: Date; } @@ -958,9 +1027,9 @@ export interface CreateCallAnalyticsCategoryRequest { CategoryName: string | undefined; /** - *To create a category, you must specify between 1 and 20 rules. For each rule, you specify a - * filter to be applied to the attributes of the call. For example, you can specify a sentiment - * filter to detect if the customer's sentiment was negative or neutral.
+ *To create a category, you must specify between 1 and 20 rules. For each rule, you + * specify a filter to be applied to the attributes of the call. For example, you can specify a + * sentiment filter to detect if the customer's sentiment was negative or neutral.
*/ Rules: Rule[] | undefined; } @@ -1004,8 +1073,8 @@ export interface InternalFailureException extends __SmithyException, $MetadataBe } /** - *Either you have sent too many requests or your input file is too long. Wait before you resend your request, or - * use a smaller file and resend the request.
+ *Either you have sent too many requests or your input file is too long. Wait before you + * resend your request, or use a smaller file and resend the request.
*/ export interface LimitExceededException extends __SmithyException, $MetadataBearer { name: "LimitExceededException"; @@ -1014,23 +1083,26 @@ export interface LimitExceededException extends __SmithyException, $MetadataBear } /** - *The object that contains the Amazon S3 object location and access role required to train and tune your custom - * language model.
+ *The object that contains the Amazon S3 object location and access role required to train and + * tune your custom language model.
*/ export interface InputDataConfig { /** - *The Amazon S3 prefix you specify to access the plain text files that you use to train your custom language model.
+ *The Amazon S3 prefix you specify to access the plain text files that you use to train your + * custom language model.
*/ S3Uri: string | undefined; /** - *The Amazon S3 prefix you specify to access the plain text files that you use to tune your custom language model.
+ *The Amazon S3 prefix you specify to access the plain text files that you use to tune your + * custom language model.
*/ TuningDataS3Uri?: string; /** - *The Amazon Resource Name (ARN) that uniquely identifies the permissions you've given Amazon Transcribe to access your - * Amazon S3 buckets containing your media files or text data. ARNs have the format + *
The Amazon Resource Name (ARN) that uniquely identifies the permissions you've given
+ * Amazon Transcribe to access your Amazon S3 buckets containing your media files or text data. ARNs have the
+ * format
* arn:partition:service:region:account-id:resource-type/resource-id.
A key:value pair that adds metadata to a resource used by Amazon Transcribe. For example, a tag with the key:value pair - * ‘Department’:’Sales’ might be added to a resource to indicate its use by your organization's sales department.
+ *A key:value pair that adds metadata to a resource used by Amazon Transcribe. For example, a tag + * with the key:value pair ‘Department’:’Sales’ might be added to a resource to indicate its use + * by your organization's sales department.
*/ export interface Tag { /** - *The first part of a key:value pair that forms a tag associated with a given resource. For example, in the tag - * ‘Department’:’Sales’, the key is 'Department'.
+ *The first part of a key:value pair that forms a tag associated with a given resource. For + * example, in the tag ‘Department’:’Sales’, the key is 'Department'.
*/ Key: string | undefined; /** - *The second part of a key:value pair that forms a tag associated with a given resource. For example, in the tag - * ‘Department’:’Sales’, the value is 'Sales'.
+ *The second part of a key:value pair that forms a tag associated with a given resource. + * For example, in the tag ‘Department’:’Sales’, the value is 'Sales'.
*/ Value: string | undefined; } @@ -1080,11 +1153,12 @@ export interface CreateLanguageModelRequest { LanguageCode: CLMLanguageCode | string | undefined; /** - *The Amazon Transcribe standard language model, or base model used to create your custom language model.
- *If you want to use your custom language model to transcribe audio with a sample rate of 16,000 Hz or greater,
- * choose Wideband.
If you want to use your custom language model to transcribe audio with a sample rate that is less than
- * 16,000 Hz, choose Narrowband.
The Amazon Transcribe standard language model, or base model used to create your custom + * language model.
+ *If you want to use your custom language model to transcribe audio with a sample rate
+ * of 16,000 Hz or greater, choose Wideband.
If you want to use your custom language model to transcribe audio with a sample rate
+ * that is less than 16,000 Hz, choose Narrowband.
Contains the data access role and the Amazon S3 prefixes to read the required input files to create a custom - * language model.
+ *Contains the data access role and the Amazon S3 prefixes to read the required input files to + * create a custom language model.
*/ InputDataConfig: InputDataConfig | undefined; /** - *Adds one or more tags, each in the form of a key:value pair, to a new language model at the time you create - * this new model.
+ *Adds one or more tags, each in the form of a key:value pair, to a new language model + * at the time you create this new model.
*/ Tags?: Tag[]; } @@ -1128,7 +1202,8 @@ export interface CreateLanguageModelResponse { LanguageCode?: CLMLanguageCode | string; /** - *The Amazon Transcribe standard language model, or base model you've used to create a custom language model.
+ *The Amazon Transcribe standard language model, or base model you've used to create a custom + * language model.
*/ BaseModelName?: BaseModelName | string; @@ -1143,8 +1218,8 @@ export interface CreateLanguageModelResponse { InputDataConfig?: InputDataConfig; /** - *The status of the custom language model. When the status is COMPLETED the model is ready
- * to use.
The status of the custom language model. When the status is
+ * COMPLETED the model is ready to use.
The name of the custom vocabulary. This case-sensitive name must be unique within an Amazon Web Services
- * account. If you try to create a vocabulary with the same name as a previous vocabulary, you get a
- * ConflictException error.
The name of the custom vocabulary. This case-sensitive name must be unique within
+ * an Amazon Web Services account. If you try to create a vocabulary with the same name
+ * as a previous vocabulary, you get a ConflictException error.
The language code for the language used for the entries in your custom vocabulary. The language code of your - * custom vocabulary must match the language code of your transcription job. US English (en-US) is the only language - * code available for Amazon Transcribe Medical.
+ *The language code for the language used for the entries in your custom vocabulary. + * The language code of your custom vocabulary must match the language code of your + * transcription job. US English (en-US) is the only language code available for Amazon Transcribe Medical.
*/ LanguageCode: LanguageCode | string | undefined; /** - *The location in Amazon S3 of the text file you use to define your custom vocabulary. The URI must be in the same
- * Amazon Web Services Region as the resource that you're calling. Enter information about your
- * VocabularyFileUri in the following format:
- *
- * https://s3.
+ *
The location in Amazon S3 of the text file you use to define your custom vocabulary. The URI
+ * must be in the same Amazon Web Services Region as the resource that you're calling. Enter
+ * information about your VocabularyFileUri in the following format:
+ * https://s3.
*
The following is an example URI for a vocabulary file that is stored in Amazon S3:
*
* https://s3.us-east-1.amazonaws.com/AWSDOC-EXAMPLE-BUCKET/vocab.txt
*
For more information about Amazon S3 object names, see Object Keys in the Amazon S3 - * Developer Guide.
- *For more information about custom vocabularies, see Medical Custom Vocabularies.
+ *For more information about Amazon S3 object names, see Object Keys in + * the Amazon S3 Developer Guide.
+ *For more information about custom vocabularies, see Medical Custom + * Vocabularies.
*/ VocabularyFileUri: string | undefined; /** - *Adds one or more tags, each in the form of a key:value pair, to a new medical vocabulary at the time you - * create this new vocabulary.
+ *Adds one or more tags, each in the form of a key:value pair, to a new medical + * vocabulary at the time you create this new vocabulary.
*/ Tags?: Tag[]; } @@ -1216,20 +1290,21 @@ export enum VocabularyState { export interface CreateMedicalVocabularyResponse { /** - *The name of the vocabulary. The name must be unique within an Amazon Web Services account and is case - * sensitive.
+ *The name of the vocabulary. The name must be unique within an Amazon Web Services + * account and is case sensitive.
*/ VocabularyName?: string; /** - *The language code for the entries in your custom vocabulary. US English (en-US) is the only valid language - * code for Amazon Transcribe Medical.
+ *The language code for the entries in your custom vocabulary. US English (en-US) is the + * only valid language code for Amazon Transcribe Medical.
*/ LanguageCode?: LanguageCode | string; /** - *The processing state of your custom vocabulary in Amazon Transcribe Medical. If the state is READY, you can
- * use the vocabulary in a StartMedicalTranscriptionJob request.
The processing state of your custom vocabulary in Amazon Transcribe Medical. If the state is
+ * READY, you can use the vocabulary in a
+ * StartMedicalTranscriptionJob request.
If the VocabularyState field is FAILED, this field contains information about
- * why the job failed.
If the VocabularyState field is FAILED, this field contains
+ * information about why the job failed.
The name of the vocabulary. The name must be unique within an Amazon Web Services account. The name - * is case sensitive. If you try to create a vocabulary with the same name as a previous vocabulary you will receive a + *
The name of the vocabulary. The name must be unique within an
+ * Amazon Web Services account. The name is case sensitive. If you try to create a vocabulary
+ * with the same name as a previous vocabulary you will receive a
* ConflictException error.
The language code of the vocabulary entries. For a list of languages and their corresponding language - * codes, see transcribe-whatis.
+ *The language code of the vocabulary entries. For a list of languages and their + * corresponding language codes, see table-language-matrix.
*/ LanguageCode: LanguageCode | string | undefined; @@ -1274,20 +1350,25 @@ export interface CreateVocabularyRequest { Phrases?: string[]; /** - *The S3 location of the text file that contains the definition of the custom vocabulary. The URI must be in the - * same region as the API endpoint that you are calling. The general form is:
- * - * - * + *The S3 location of the text file that contains the definition of the custom vocabulary. The + * URI must be in the same region as the API endpoint that you are calling. The general form + * is:
+ *
+ * https://s3.
+ *
For example:
+ *
+ * https://s3.us-east-1.amazonaws.com/AWSDOC-EXAMPLE-BUCKET/vocab.txt
+ *
For more information about S3 object names, see Object Keys in the * Amazon S3 Developer Guide.
- *For more information about custom vocabularies, see Custom vocabularies.
+ *For more information about custom vocabularies, see Custom vocabularies.
*/ VocabularyFileUri?: string; /** - *Adds one or more tags, each in the form of a key:value pair, to a new Amazon Transcribe vocabulary at the time you create - * this new vocabulary.
+ *Adds one or more tags, each in the form of a key:value pair, to a new Amazon Transcribe vocabulary at + * the time you create this new vocabulary.
*/ Tags?: Tag[]; } @@ -1313,8 +1394,8 @@ export interface CreateVocabularyResponse { LanguageCode?: LanguageCode | string; /** - *The processing state of the vocabulary. When the VocabularyState field contains
- * READY the vocabulary is ready to be used in a StartTranscriptionJob
+ *
The processing state of the vocabulary. When the VocabularyState field
+ * contains READY the vocabulary is ready to be used in a StartTranscriptionJob
* request.
If the VocabularyState field is FAILED, this field contains information about
- * why the job failed.
If the VocabularyState field is FAILED, this field contains
+ * information about why the job failed.
The vocabulary filter name. The name must be unique within the account that contains it. If you try to create a
- * vocabulary filter with the same name as another vocabulary filter, you get a ConflictException
- * error.
The vocabulary filter name. The name must be unique within the account that contains
+ * it. If you try to create a vocabulary filter with the same name as another vocabulary filter, you
+ * get a ConflictException error.
The language code of the words in the vocabulary filter. All words in the filter must be in the same language. - * The vocabulary filter can only be used with transcription jobs in the specified language.
+ *The language code of the words in the vocabulary filter. All words in the filter must be + * in the same language. The vocabulary filter can only be used with transcription jobs in the + * specified language.
*/ LanguageCode: LanguageCode | string | undefined; /** - *The words to use in the vocabulary filter. Only use characters from the character set defined for custom - * vocabularies. For a list of character sets, see Character Sets for Custom Vocabularies.
+ *The words to use in the vocabulary filter. Only use characters from the character set + * defined for custom vocabularies. For a list of character sets, see Character Sets for Custom + * Vocabularies.
*If you provide a list of words in the Words parameter, you can't use the
* VocabularyFilterFileUri parameter.
The Amazon S3 location of a text file used as input to create the vocabulary filter. Only use characters from - * the character set defined for custom vocabularies. For a list of character sets, see Character Sets for Custom Vocabularies.
+ *The Amazon S3 location of a text file used as input to create the vocabulary filter. Only + * use characters from the character set defined for custom vocabularies. For a list of character + * sets, see Character Sets for Custom + * Vocabularies.
*The specified file must be less than 50 KB of UTF-8 characters.
- *If you provide the location of a list of words in the VocabularyFilterFileUri parameter, you can't
- * use the Words parameter.
If you provide the location of a list of words in the VocabularyFilterFileUri
+ * parameter, you can't use the Words parameter.
Adds one or more tags, each in the form of a key:value pair, to a new Amazon Transcribe vocabulary filter at the time you - * create this new vocabulary filter.
+ *Adds one or more tags, each in the form of a key:value pair, to a new Amazon Transcribe vocabulary + * filter at the time you create this new vocabulary filter.
*/ Tags?: Tag[]; } @@ -1615,19 +1700,21 @@ export interface LanguageModel { LanguageCode?: CLMLanguageCode | string; /** - *The Amazon Transcribe standard language model, or base model used to create the custom language model.
+ *The Amazon Transcribe standard language model, or base model used to create the custom language + * model.
*/ BaseModelName?: BaseModelName | string; /** - *The creation status of a custom language model. When the status is COMPLETED the model is
- * ready for use.
The creation status of a custom language model. When the status is
+ * COMPLETED the model is ready for use.
Whether the base model used for the custom language model is up to date. If this field is true
- * then you are running the most up-to-date version of the base model in your custom language model.
Whether the base model used for the custom language model is up to date. If this field
+ * is true then you are running the most up-to-date version of the base model
+ * in your custom language model.
The data access role and Amazon S3 prefixes for the input files used to train the custom language model.
+ *The data access role and Amazon S3 prefixes for the input files used to train the custom + * language model.
*/ InputDataConfig?: InputDataConfig; } @@ -1756,49 +1844,52 @@ export enum MedicalContentIdentificationType { } /** - *Optional settings for the StartMedicalTranscriptionJob - * operation.
+ *Optional settings for the StartMedicalTranscriptionJob operation.
*/ export interface MedicalTranscriptionSetting { /** - *Determines whether the transcription job uses speaker recognition to identify different speakers in the input
- * audio. Speaker recognition labels individual speakers in the audio file. If you set the ShowSpeakerLabels
- * field to true, you must also set the maximum number of speaker labels in the MaxSpeakerLabels
- * field.
You can't set both ShowSpeakerLabels and ChannelIdentification in the same
- * request. If you set both, your request returns a BadRequestException.
Determines whether the transcription job uses speaker recognition to identify different
+ * speakers in the input audio. Speaker recognition labels individual speakers in the audio file.
+ * If you set the ShowSpeakerLabels field to true, you must also set the
+ * maximum number of speaker labels in the MaxSpeakerLabels field.
You can't set both ShowSpeakerLabels and
+ * ChannelIdentification in the same request. If you set both, your request
+ * returns a BadRequestException.
The maximum number of speakers to identify in the input audio. If there are more speakers in the audio than this
- * number, multiple speakers are identified as a single speaker. If you specify the MaxSpeakerLabels field,
- * you must set the ShowSpeakerLabels field to true.
The maximum number of speakers to identify in the input audio. If there are more
+ * speakers in the audio than this number, multiple speakers are identified as a single speaker.
+ * If you specify the MaxSpeakerLabels field, you must set the
+ * ShowSpeakerLabels field to true.
Instructs Amazon Transcribe Medical to process each audio channel separately and then merge the transcription output of each - * channel into a single transcription.
- *Amazon Transcribe Medical also produces a transcription of each item detected on an audio channel, including the start time and end - * time of the item and alternative transcriptions of item. The alternative transcriptions also come with confidence scores - * provided by Amazon Transcribe Medical.
- *You can't set both ShowSpeakerLabels and ChannelIdentification in the same
- * request. If you set both, your request returns a BadRequestException
- *
Instructs Amazon Transcribe Medical to process each audio channel separately and then merge the + * transcription output of each channel into a single transcription.
+ *Amazon Transcribe Medical also produces a transcription of each item detected on an audio channel, + * including the start time and end time of the item and alternative transcriptions of item. + * The alternative transcriptions also come with confidence scores provided by Amazon Transcribe Medical.
+ *You can't set both ShowSpeakerLabels and
+ * ChannelIdentification in the same request. If you set both, your request
+ * returns a BadRequestException.
Determines whether alternative transcripts are generated along with the transcript that has the highest confidence.
- * If you set ShowAlternatives field to true, you must also set the maximum number of alternatives to
- * return in the MaxAlternatives field.
Determines whether alternative transcripts are generated along with the transcript that
+ * has the highest confidence. If you set ShowAlternatives field to true, you must
+ * also set the maximum number of alternatives to return in the MaxAlternatives
+ * field.
The maximum number of alternatives that you tell the service to return. If you specify the
- * MaxAlternatives field, you must set the ShowAlternatives field to true.
The maximum number of alternatives that you tell the service to return. If you specify
+ * the MaxAlternatives field, you must set the ShowAlternatives
+ * field to true.
The S3 object location of the medical transcript.
- *Use this URI to access the medical transcript. This URI points to the S3 bucket you created to store the medical - * transcript.
+ *Use this URI to access the medical transcript. This URI points to the S3 bucket you created + * to store the medical transcript.
*/ TranscriptFileUri?: string; } @@ -1869,17 +1960,16 @@ export interface MedicalTranscriptionJob { TranscriptionJobStatus?: TranscriptionJobStatus | string; /** - *The language code for the language spoken in the source audio file. US English (en-US) is the only supported
- * language for medical transcriptions. Any other value you enter for language code results in a
- * BadRequestException error.
The language code for the language spoken in the source audio file. US English (en-US)
+ * is the only supported language for medical transcriptions. Any other value you enter for
+ * language code results in a BadRequestException error.
The sample rate, in Hertz, of the source audio containing medical information.
- *If you don't specify the sample rate, Amazon Transcribe Medical determines it for you. If you choose to specify the sample rate, it
- * must match the rate detected by Amazon Transcribe Medical. In most cases, you should leave the
- * MedicalMediaSampleHertz blank and let Amazon Transcribe Medical determine the sample rate.
If you don't specify the sample rate, Amazon Transcribe Medical determines it for you. If you choose to + * specify the sample rate, it must match the rate detected by Amazon Transcribe Medical.
*/ MediaSampleRateHertz?: number; @@ -1894,8 +1984,8 @@ export interface MedicalTranscriptionJob { Media?: Media; /** - *An object that contains the MedicalTranscript. The MedicalTranscript contains the
- * TranscriptFileUri.
An object that contains the MedicalTranscript. The
+ * MedicalTranscript contains the TranscriptFileUri.
If the TranscriptionJobStatus field is FAILED, this field contains information
- * about why the job failed.
If the TranscriptionJobStatus field is FAILED, this field
+ * contains information about why the job failed.
The FailureReason field contains one of the following values:
- * The media format provided does not match the detected media format- The media format
- * of the audio file doesn't match the format specified in the MediaFormat field in the request.
- * Check the media format of your media file and make sure the two values match.
The media format provided does not match the detected media
+ * format- The media format of the audio file doesn't match the format specified
+ * in the MediaFormat field in the request. Check the media format of
+ * your media file and make sure the two values match.
*
* Invalid sample rate for audio file- The sample rate specified in the
- * MediaSampleRateHertz of the request isn't valid. The sample rate must be between 8,000 and
- * 48,000 Hertz.
MediaSampleRateHertz of the request isn't valid. The sample rate must
+ * be between 8,000 and 48,000 Hertz.
*
- * The sample rate provided does not match the detected sample rate- The sample rate in the
- * audio file doesn't match the sample rate specified in the MediaSampleRateHertz field in the request.
- * Check the sample rate of your media file and make sure that the two values match.
The sample rate provided does not match the detected sample
+ * rate- The sample rate in the audio file doesn't match the sample rate specified
+ * in the MediaSampleRateHertz field in the request. Check the sample rate
+ * of your media file and make sure that the two values match.
*
- * Invalid file size: file size too large- The size of your audio file is larger than what Amazon Transcribe Medical can
- * process. For more information, see Guidelines and Quotas in the Amazon Transcribe Medical
- * Guide
- *
Invalid file size: file size too large- The size of your audio file is
+ * larger than what Amazon Transcribe Medical can process. For more information, see
+ * Guidelines
+ * and Quotas in the Amazon Transcribe Medical Guide.
*
- * Invalid number of channels: number of channels too large- Your audio contains more channels
- * than Amazon Transcribe Medical is configured to process. To request additional channels, see Amazon Transcribe Medical Endpoints and Quotas in the Amazon
- * Web Services General Reference
- *
Invalid number of channels: number of channels too large- Your
+ * audio contains more channels than Amazon Transcribe Medical is configured to process. To request
+ * additional channels, see Amazon Transcribe Medical Endpoints and
+ * Quotas in the Amazon Web Services General
+ * Reference.
* Shows the type of content that you've configured Amazon Transcribe Medical to identify in a transcription job. If the value is
- * PHI, you've configured the job to identify personal health information (PHI) in the transcription output.
Shows the type of content that you've configured Amazon Transcribe Medical to identify in a transcription
+ * job. If the value is PHI, you've configured the job to identify personal health
+ * information (PHI) in the transcription output.
The medical specialty of any clinicians providing a dictation or having a conversation. Refer to Transcribing a medical conversationfor a - * list of supported specialties.
+ *The medical specialty of any clinicians providing a dictation or having a conversation. + * Refer to Transcribing a medical + * conversationfor a list of supported specialties.
*/ Specialty?: Specialty | string; /** - *The type of speech in the transcription job. CONVERSATION is generally used for patient-physician
- * dialogues. DICTATION is the setting for physicians speaking their notes after seeing a patient. For more
- * information, see What is
- * Amazon Transcribe Medical?.
The type of speech in the transcription job. CONVERSATION is generally
+ * used for patient-physician dialogues. DICTATION is the setting for physicians
+ * speaking their notes after seeing a patient. For more information, see
+ * What
+ * is Amazon Transcribe Medical?.
Indicates whether a job should be queued by Amazon Transcribe when the concurrent execution limit is exceeded. When the
- * AllowDeferredExecution field is true, jobs are queued and executed when the number of executing
- * jobs falls below the concurrent execution limit. If the field is false, Amazon Transcribe returns a
- * LimitExceededException exception.
Indicates whether a job should be queued by Amazon Transcribe when the concurrent execution limit
+ * is exceeded. When the AllowDeferredExecution field is true, jobs are queued
+ * and executed when the number of executing jobs falls below the concurrent execution limit. If
+ * the field is false, Amazon Transcribe returns a LimitExceededException exception.
Note that job queuing is enabled by default for call analytics jobs.
*If you specify the AllowDeferredExecution field, you must specify the
* DataAccessRoleArn field.
The Amazon Resource Name (ARN), in the form
* arn:partition:service:region:account-id:resource-type/resource-id, of a role
- * that has access to the S3 bucket that contains the input files. Amazon Transcribe assumes this role to read queued
- * media files. If you have specified an output S3 bucket for the transcription results, this role should
- * have access to the output bucket as well.
If you specify the AllowDeferredExecution field, you must specify the
* DataAccessRoleArn field.
Determines whether the transcription job uses speaker recognition to identify different speakers in the input
- * audio. Speaker recognition labels individual speakers in the audio file. If you set the ShowSpeakerLabels
- * field to true, you must also set the maximum number of speaker labels MaxSpeakerLabels field.
You can't set both ShowSpeakerLabels and ChannelIdentification in the same
- * request. If you set both, your request returns a BadRequestException.
Determines whether the transcription job uses speaker recognition to identify different
+ * speakers in the input audio. Speaker recognition labels individual speakers in the audio file.
+ * If you set the ShowSpeakerLabels field to true, you must also set the
+ * maximum number of speaker labels MaxSpeakerLabels field.
You can't set both ShowSpeakerLabels and
+ * ChannelIdentification in the same request. If you set both, your request returns
+ * a BadRequestException.
The maximum number of speakers to identify in the input audio. If there are more speakers in the audio than
- * this number, multiple speakers are identified as a single speaker. If you specify the MaxSpeakerLabels
- * field, you must set the ShowSpeakerLabels field to true.
The maximum number of speakers to identify in the input audio. If there are more
+ * speakers in the audio than this number, multiple speakers are identified as a single speaker.
+ * If you specify the MaxSpeakerLabels field, you must set the
+ * ShowSpeakerLabels field to true.
Instructs Amazon Transcribe to process each audio channel separately and then merge the transcription output of each - * channel into a single transcription.
- *Amazon Transcribe also produces a transcription of each item detected on an audio channel, including the start time and - * end time of the item and alternative transcriptions of the item including the confidence that Amazon Transcribe has in the - * transcription.
- *You can't set both ShowSpeakerLabels and ChannelIdentification in the same
- * request. If you set both, your request returns a BadRequestException.
Instructs Amazon Transcribe to process each audio channel separately and then merge the + * transcription output of each channel into a single transcription.
+ *Amazon Transcribe also produces a transcription of each item detected on an audio channel, + * including the start time and end time of the item and alternative transcriptions of the item + * including the confidence that Amazon Transcribe has in the transcription.
+ *You can't set both ShowSpeakerLabels and
+ * ChannelIdentification in the same request. If you set both, your request
+ * returns a BadRequestException.
Determines whether the transcription contains alternative transcriptions. If you set the
- * ShowAlternatives field to true, you must also set the maximum number of alternatives to return in the
- * MaxAlternatives field.
ShowAlternatives field to true, you must also set the maximum number of
+ * alternatives to return in the MaxAlternatives field.
*/
ShowAlternatives?: boolean;
/**
- * The number of alternative transcriptions that the service should return. If you specify the
- * MaxAlternatives field, you must set the ShowAlternatives field to true.
The number of alternative transcriptions that the service should return. If you specify
+ * the MaxAlternatives field, you must set the ShowAlternatives
+ * field to true.
The name of the vocabulary filter to use when transcribing the audio. The filter that you specify must have the - * same language code as the transcription job.
+ *The name of the vocabulary filter to use when transcribing the audio. The filter that you + * specify must have the same language code as the transcription job.
*/ VocabularyFilterName?: string; /** - *Set to mask to remove filtered text from the transcript and replace it with three asterisks ("***")
- * as placeholder text. Set to remove to remove filtered text from the transcript without using
- * placeholder text. Set to tag to mark the word in the transcription output that matches the
- * vocabulary filter. When you set the filter method to tag, the words matching your vocabulary filter
- * are not masked or removed.
Set to mask to remove filtered text from the transcript and replace it
+ * with three asterisks ("***") as placeholder text. Set to remove to remove
+ * filtered text from the transcript without using placeholder text. Set to tag to
+ * mark the word in the transcription output that matches the vocabulary filter. When you set
+ * the filter method to tag, the words matching your vocabulary filter are not
+ * masked or removed.
Specify the output format for your subtitle file; if you select both SRT and VTT formats, two output files are genereated.
+ *Specify the output format for your subtitle file; if you select both SRT and VTT formats, + * two output files are generated.
*/ Formats?: (SubtitleFormat | string)[]; /** - *Choose the output location for your subtitle file. This location must be an S3 bucket.
+ *Choose the output location for your subtitle file. This location must be an S3 + * bucket.
*/ SubtitleFileUris?: string[]; } @@ -2253,8 +2357,8 @@ export namespace SubtitlesOutput { } /** - *Describes an asynchronous transcription job that was created with the StartTranscriptionJob
- * operation.
Describes an asynchronous transcription job that was created with the
+ * StartTranscriptionJob operation.
The sample rate, in Hertz, of the audio track in the input media file.
+ *The sample rate, in Hertz (Hz), of the audio track in the input media file.
*/ MediaSampleRateHertz?: number; @@ -2308,53 +2412,58 @@ export interface TranscriptionJob { CompletionTime?: Date; /** - *If the TranscriptionJobStatus field is FAILED, this field contains information
- * about why the job failed.
If the TranscriptionJobStatus field is FAILED, this field
+ * contains information about why the job failed.
The FailureReason field can contain one of the following values:
- * Unsupported media format - The media format specified in the MediaFormat
- * field of the request isn't valid. See the description of the MediaFormat field for a list of valid
- * values.
Unsupported media format - The media format specified in the
+ * MediaFormat field of the request isn't valid. See the description of the
+ * MediaFormat field for a list of valid values.
*
- * The media format provided does not match the detected media format - The media format
- * of the audio file doesn't match the format specified in the MediaFormat field in the request. Check
- * the media format of your media file and make sure that the two values match.
The media format provided does not match the detected media
+ * format - The media format of the audio file doesn't match the format specified
+ * in the MediaFormat field in the request. Check the media format of
+ * your media file and make sure that the two values match.
*
* Invalid sample rate for audio file - The sample rate specified in the
- * MediaSampleRateHertz of the request isn't valid. The sample rate must be between 8,000 and
- * 48,000 Hertz.
MediaSampleRateHertz of the request isn't valid. The sample rate must
+ * be between 8,000 and 48,000 Hertz.
*
- * The sample rate provided does not match the detected sample rate - The sample rate in the
- * audio file doesn't match the sample rate specified in the MediaSampleRateHertz field in the request.
- * Check the sample rate of your media file and make sure that the two values match.
The sample rate provided does not match the detected sample
+ * rate - The sample rate in the audio file doesn't match the sample rate
+ * specified in the MediaSampleRateHertz field in the request. Check
+ * the sample rate of your media file and make sure that the two values match.
*
- * Invalid file size: file size too large - The size of your audio file is larger than Amazon Transcribe can process.
- * For more information, see Limits in the Amazon Transcribe Developer Guide.
Invalid file size: file size too large - The size of your audio file is
+ * larger than Amazon Transcribe can process. For more information, see Limits in the
+ * Amazon Transcribe Developer Guide.
*
- * Invalid number of channels: number of channels too large - Your audio contains more
- * channels than Amazon Transcribe is configured to process. To request additional channels, see Amazon Transcribe Limits in
- * the Amazon Web Services General Reference.
Invalid number of channels: number of channels too large - Your
+ * audio contains more channels than Amazon Transcribe is configured to process. To request additional
+ * channels, see Amazon
+ * Transcribe Limits in the Amazon Web Services General
+ * Reference.
* Optional settings for the transcription job. Use these settings to turn on speaker recognition, to set the - * maximum number of speakers that should be identified and to specify a custom vocabulary to use when processing - * the transcription job.
+ *Optional settings for the transcription job. Use these settings to turn on speaker + * recognition, to set the maximum number of speakers that should be identified and to specify + * a custom vocabulary to use when processing the transcription job.
*/ Settings?: Settings; @@ -2374,19 +2483,21 @@ export interface TranscriptionJob { ContentRedaction?: ContentRedaction; /** - *A value that shows if automatic language identification was enabled for a transcription job.
+ *A value that shows if automatic language identification was enabled for a transcription + * job.
*/ IdentifyLanguage?: boolean; /** - *An object that shows the optional array of languages inputted for transcription jobs with automatic language - * identification enabled.
+ *An object that shows the optional array of languages inputted for transcription jobs with + * automatic language identification enabled.
*/ LanguageOptions?: (LanguageCode | string)[]; /** - *A value between zero and one that Amazon Transcribe assigned to the language that it identified in the source audio. Larger - * values indicate that Amazon Transcribe has higher confidence in the language it identified.
+ *A value between zero and one that Amazon Transcribe assigned to the language that it identified in + * the source audio. Larger values indicate that Amazon Transcribe has higher confidence in the language it + * identified.
*/ IdentifiedLanguageScore?: number; @@ -2401,9 +2512,9 @@ export interface TranscriptionJob { Subtitles?: SubtitlesOutput; /** - *Language-specific settings that can be specified when language identification is enabled for your transcription
- * job. These settings include VocabularyName, VocabularyFilterName, and
- * LanguageModelNameLanguageModelName.
Language-specific settings that can be specified when language identification is enabled
+ * for your transcription job. These settings include VocabularyName,
+ * VocabularyFilterName, and LanguageModelName.
The operation returns a page of jobs at a time. The
- * maximum size of the list is set by the MaxResults parameter. If there are
- * more categories in the list than the page size, Amazon Transcribe returns the NextPage
- * token. Include the token in the next request to the
- * operation to return the next page of analytics categories.
The operation returns a page of jobs at
+ * a time. The maximum size of the list is set by the MaxResults parameter. If
+ * there are more categories in the list than the page size, Amazon Transcribe returns the
+ * NextPage token. Include the token in the next request to the
+ * operation to return the next page of analytics
+ * categories.
If you receive a truncated result in the previous request of
- * ,
- * include NextToken to fetch the next set of jobs.
NextToken to fetch the
+ * next set of jobs.
*/
NextToken?: string;
/**
- * The maximum number of call analytics jobs to return in each page of results. If there are - * fewer results than the value you specify, only the actual results are returned. If you do not - * specify a value, the default of 5 is used.
+ *The maximum number of call analytics jobs to return in each page of results. If there + * are fewer results than the value you specify, only the actual results are returned. If you do + * not specify a value, the default of 5 is used.
*/ MaxResults?: number; } @@ -2637,10 +2749,11 @@ export interface ListCallAnalyticsJobsResponse { Status?: CallAnalyticsJobStatus | string; /** - *The operation returns a page of jobs at a time. The
- * maximum size of the page is set by the MaxResults parameter. If there are more
- * jobs in the list than the page size, Amazon Transcribe returns the NextPage token. Include the
- * token in your next request to the operation to return next page of jobs.
The operation returns a page of jobs at a time.
+ * The maximum size of the page is set by the MaxResults parameter. If there are
+ * more jobs in the list than the page size, Amazon Transcribe returns the NextPage token.
+ * Include the token in your next request to the
+ * operation to return next page of jobs.
When specified, returns only custom language models with the specified status. Language models are ordered - * by creation date, with the newest models first. If you don't specify a status, Amazon Transcribe returns all custom language - * models ordered by date.
+ *When specified, returns only custom language models with the specified status. Language + * models are ordered by creation date, with the newest models first. If you don't specify a + * status, Amazon Transcribe returns all custom language models ordered by date.
*/ StatusEquals?: ModelStatus | string; /** - *When specified, the custom language model names returned contain the substring you've specified.
+ *When specified, the custom language model names returned contain the substring you've + * specified.
*/ NameContains?: string; /** - *When included, fetches the next set of jobs if the result of the previous request was truncated.
+ *When included, fetches the next set of jobs if the result of the previous request was + * truncated.
*/ NextToken?: string; /** - *The maximum number of language models to return in each page of results. If there are fewer results than the - * value you specify, only the actual results are returned. If you do not specify a value, the default of 5 is used.
+ *The maximum number of language models to return in each page of results. If there are + * fewer results than the value you specify, only the actual results are returned. If you do not + * specify a value, the default of 5 is used.
*/ MaxResults?: number; } @@ -2695,9 +2811,12 @@ export namespace ListLanguageModelsRequest { export interface ListLanguageModelsResponse { /** - *The operation returns a page of jobs at a time. The maximum size
- * of the list is set by the MaxResults parameter. If there are more language models in the list than the page size, Amazon Transcribe
- * returns the NextPage token. Include the token in the next request to the operation to return the next page of language models.
The operation returns a page of jobs at a
+ * time. The maximum size of the list is set by the MaxResults parameter. If there are more
+ * language models in the list than the page size, Amazon Transcribe returns the NextPage
+ * token. Include the token in the next request to the
+ * operation to return the next page of language
+ * models.
When specified, returns only medical transcription jobs with the specified status. Jobs are ordered by creation - * date, with the newest jobs returned first. If you don't specify a status, Amazon Transcribe Medical returns all transcription jobs ordered - * by creation date.
+ *When specified, returns only medical transcription jobs with the specified status. Jobs + * are ordered by creation date, with the newest jobs returned first. If you don't specify a status, + * Amazon Transcribe Medical returns all transcription jobs ordered by creation date.
*/ Status?: TranscriptionJobStatus | string; /** - *When specified, the jobs returned in the list are limited to jobs whose name contains the specified string.
+ *When specified, the jobs returned in the list are limited to jobs whose name contains the + * specified string.
*/ JobNameContains?: string; /** - *If you a receive a truncated result in the previous request of ListMedicalTranscriptionJobs,
- * include NextToken to fetch the next set of jobs.
If you a receive a truncated result in the previous request of
+ * ListMedicalTranscriptionJobs, include NextToken to fetch the
+ * next set of jobs.
The maximum number of medical transcription jobs to return in each page of results. If there are fewer - * results than the value you specify, only the actual results are returned. If you do not specify a value, the default of - * 5 is used.
+ *The maximum number of medical transcription jobs to return in each page of results. If + * there are fewer results than the value you specify, only the actual results are returned. If you + * do not specify a value, the default of 5 is used.
*/ MaxResults?: number; } @@ -2792,25 +2913,28 @@ export interface MedicalTranscriptionJobSummary { TranscriptionJobStatus?: TranscriptionJobStatus | string; /** - *If the TranscriptionJobStatus field is FAILED, a description of the error.
If the TranscriptionJobStatus field is FAILED, a description
+ * of the error.
Indicates the location of the transcription job's output. This field must be the path of an S3 bucket; if you don't - * already have an S3 bucket, one is created based on the path you add.
+ *Indicates the location of the transcription job's output. This field must be the path of an + * S3 bucket; if you don't already have an S3 bucket, one is created based on the path you + * add.
*/ OutputLocationType?: OutputLocationType | string; /** - *The medical specialty of the transcription job. Refer to Transcribing a medical conversationfor a - * list of supported specialties.
+ *The medical specialty of the transcription job. Refer to Transcribing a medical + * conversationfor a list of supported specialties.
*/ Specialty?: Specialty | string; /** - *Shows the type of information you've configured Amazon Transcribe Medical to identify in a transcription job. If the value is
- * PHI, you've configured the transcription job to identify personal health information (PHI).
Shows the type of information you've configured Amazon Transcribe Medical to identify in a transcription job.
+ * If the value is PHI, you've configured the transcription job to identify personal
+ * health information (PHI).
The ListMedicalTranscriptionJobs operation returns a page of jobs at a time. The maximum
- * size of the page is set by the MaxResults parameter. If the number of jobs exceeds what can fit on
- * a page, Amazon Transcribe Medical returns the NextPage token. Include the token in the next request to the
- * ListMedicalTranscriptionJobs operation to return in the next page of jobs.
The ListMedicalTranscriptionJobs operation returns a page of jobs at a
+ * time. The maximum size of the page is set by the MaxResults parameter. If
+ * the number of jobs exceeds what can fit on a page, Amazon Transcribe Medical returns the
+ * NextPage token. Include the token in the next request to the
+ * ListMedicalTranscriptionJobs operation to return in the next page of
+ * jobs.
If the result of your previous request to ListMedicalVocabularies was truncated, include the
- * NextToken to fetch the next set of vocabularies.
If the result of your previous request to ListMedicalVocabularies was
+ * truncated, include the NextToken to fetch the next set of vocabularies.
The maximum number of vocabularies to return in each page of results. If there are fewer results than the - * value you specify, only the actual results are returned. If you do not specify a value, the default of 5 is used.
+ *The maximum number of vocabularies to return in each page of results. If there are fewer + * results than the value you specify, only the actual results are returned. If you do not specify + * a value, the default of 5 is used.
*/ MaxResults?: number; /** - *When specified, returns only vocabularies with the VocabularyState equal to the specified
- * vocabulary state. Use this field to see which vocabularies are ready for your medical transcription jobs.
When specified, returns only vocabularies with the VocabularyState equal
+ * to the specified vocabulary state. Use this field to see which vocabularies are ready for your
+ * medical transcription jobs.
Returns vocabularies whose names contain the specified string. The search is not case sensitive.
- * ListMedicalVocabularies returns both "vocabularyname" and
- * "VocabularyName".
Returns vocabularies whose names contain the specified string. The search is not case
+ * sensitive. ListMedicalVocabularies returns both
+ * "vocabularyname" and "VocabularyName".
Provides information about a custom vocabulary.
+ *Provides information about a custom vocabulary.
*/ export interface VocabularyInfo { /** @@ -2914,8 +3042,8 @@ export interface VocabularyInfo { LastModifiedTime?: Date; /** - *The processing state of the vocabulary. If the state is READY you can use
- * the vocabulary in a StartTranscriptionJob request.
The processing state of the vocabulary. If the state is READY you
+ * can use the vocabulary in a StartTranscriptionJob request.
The ListMedicalVocabularies operation returns a page of vocabularies at a time. You set the
- * maximum number of vocabularies to return on a page with the MaxResults parameter. If there
- * are more jobs in the list will fit on a page, Amazon Transcribe Medical returns the NextPage token. To return the next
- * page of vocabularies, include the token in the next request to the ListMedicalVocabularies
+ *
The ListMedicalVocabularies operation returns a page of vocabularies at a
+ * time. You set the maximum number of vocabularies to return on a page with the
+ * MaxResults parameter. If there are more jobs in the list will fit on a page,
+ * Amazon Transcribe Medical returns the NextPage token. To return the next page of vocabularies,
+ * include the token in the next request to the ListMedicalVocabularies
* operation .
When specified, returns only transcription jobs with the specified status. Jobs are ordered by creation date, with - * the newest jobs returned first. If you don’t specify a status, Amazon Transcribe returns all transcription jobs ordered by creation - * date.
+ *When specified, returns only transcription jobs with the specified status. Jobs are ordered + * by creation date, with the newest jobs returned first. If you don’t specify a status, Amazon Transcribe + * returns all transcription jobs ordered by creation date.
*/ Status?: TranscriptionJobStatus | string; /** - *When specified, the jobs returned in the list are limited to jobs whose name contains the specified string.
+ *When specified, the jobs returned in the list are limited to jobs whose name contains the + * specified string.
*/ JobNameContains?: string; /** - *If the result of the previous request to ListTranscriptionJobs is truncated, include the
- * NextToken to fetch the next set of jobs.
If the result of the previous request to ListTranscriptionJobs is truncated,
+ * include the NextToken to fetch the next set of jobs.
The maximum number of jobs to return in each page of results. If there are fewer results than the value you - * specify, only the actual results are returned. If you do not specify a value, the default of 5 is used.
+ *The maximum number of jobs to return in each page of results. If there are fewer results + * than the value you specify, only the actual results are returned. If you do not specify a value, + * the default of 5 is used.
*/ MaxResults?: number; } @@ -3067,23 +3198,26 @@ export interface TranscriptionJobSummary { LanguageCode?: LanguageCode | string; /** - *The status of the transcription job. When the status is COMPLETED, use the
- * GetTranscriptionJob operation to get the results of the transcription.
The status of the transcription job. When the status is COMPLETED,
+ * use the GetTranscriptionJob operation to get the results of the
+ * transcription.
If the TranscriptionJobStatus field is FAILED, a description of the error.
If the TranscriptionJobStatus field is FAILED, a
+ * description of the error.
Indicates the location of the output of the transcription job.
- *If the value is CUSTOMER_BUCKET then the location is the S3 bucket specified in the
- * outputBucketName field when the transcription job was started with the
- * StartTranscriptionJob operation.
If the value is SERVICE_BUCKET then the output is stored by Amazon Transcribe and can be retrieved using
- * the URI in the GetTranscriptionJob response's TranscriptFileUri field.
If the value is CUSTOMER_BUCKET then the location is the S3 bucket
+ * specified in the outputBucketName field when the transcription job was
+ * started with the StartTranscriptionJob operation.
If the value is SERVICE_BUCKET then the output is stored by Amazon Transcribe and
+ * can be retrieved using the URI in the GetTranscriptionJob response's
+ * TranscriptFileUri field.
A value between zero and one that Amazon Transcribe assigned to the language it identified in the source audio. A higher - * score indicates that Amazon Transcribe is more confident in the language it identified.
+ *A value between zero and one that Amazon Transcribe assigned to the language it identified in + * the source audio. A higher score indicates that Amazon Transcribe is more confident in the language it + * identified.
*/ IdentifiedLanguageScore?: number; } @@ -3125,10 +3260,11 @@ export interface ListTranscriptionJobsResponse { Status?: TranscriptionJobStatus | string; /** - *The ListTranscriptionJobs operation returns a page of jobs at a time. The maximum size of the
- * page is set by the MaxResults parameter. If there are more jobs in the list than the page size, Amazon Transcribe
- * returns the NextPage token. Include the token in the next request to the
- * ListTranscriptionJobs operation to return in the next page of jobs.
The ListTranscriptionJobs operation returns a page of jobs at a time. The
+ * maximum size of the page is set by the MaxResults parameter. If there are
+ * more jobs in the list than the page size, Amazon Transcribe returns the NextPage token.
+ * Include the token in the next request to the ListTranscriptionJobs operation to
+ * return in the next page of jobs.
If the result of the previous request to ListVocabularies was truncated, include the
- * NextToken to fetch the next set of jobs.
If the result of the previous request to ListVocabularies was truncated,
+ * include the NextToken to fetch the next set of jobs.
The maximum number of vocabularies to return in each page of results. If there are fewer results than the - * value you specify, only the actual results are returned. If you do not specify a value, the default of 5 is used.
+ *The maximum number of vocabularies to return in each page of results. If there are fewer + * results than the value you specify, only the actual results are returned. If you do not specify a + * value, the default of 5 is used.
*/ MaxResults?: number; /** - *When specified, only returns vocabularies with the VocabularyState field equal to the
- * specified state.
When specified, only returns vocabularies with the VocabularyState field
+ * equal to the specified state.
When specified, the vocabularies returned in the list are limited to vocabularies whose name contains the
- * specified string. The search is not case sensitive, ListVocabularies returns both "vocabularyname"
- * and "VocabularyName" in the response list.
When specified, the vocabularies returned in the list are limited to vocabularies whose
+ * name contains the specified string. The search is not case sensitive,
+ * ListVocabularies returns both "vocabularyname" and "VocabularyName" in the
+ * response list.
The ListVocabularies operation returns a page of vocabularies at a time. The maximum size of
- * the page is set in the MaxResults parameter. If there are more jobs in the list than will fit on the
- * page, Amazon Transcribe returns the NextPage token. To return in the next page of jobs, include the token in the
- * next request to the ListVocabularies operation.
The ListVocabularies operation returns a page of vocabularies at a time.
+ * The maximum size of the page is set in the MaxResults parameter. If there are
+ * more jobs in the list than will fit on the page, Amazon Transcribe returns the NextPage token.
+ * To return in the next page of jobs, include the token in the next request to the
+ * ListVocabularies operation.
A list of objects that describe the vocabularies that match the search criteria in the request.
+ *A list of objects that describe the vocabularies that match the search criteria in the + * request.
*/ Vocabularies?: VocabularyInfo[]; } @@ -3214,19 +3354,21 @@ export namespace ListVocabulariesResponse { export interface ListVocabularyFiltersRequest { /** - *If the result of the previous request to ListVocabularyFilters was truncated, include the
- * NextToken to fetch the next set of collections.
If the result of the previous request to ListVocabularyFilters was truncated,
+ * include the NextToken to fetch the next set of collections.
The maximum number of filters to return in each page of results. If there are fewer results than the value you - * specify, only the actual results are returned. If you do not specify a value, the default of 5 is used.
+ *The maximum number of filters to return in each page of results. If there are fewer + * results than the value you specify, only the actual results are returned. If you do not specify + * a value, the default of 5 is used.
*/ MaxResults?: number; /** - *Filters the response so that it only contains vocabulary filters whose name contains the specified string.
+ *Filters the response so that it only contains vocabulary filters whose name contains the + * specified string.
*/ NameContains?: string; } @@ -3245,7 +3387,8 @@ export namespace ListVocabularyFiltersRequest { */ export interface VocabularyFilterInfo { /** - *The name of the vocabulary filter. The name must be unique in the account that holds the filter.
+ *The name of the vocabulary filter. The name must be unique in the account that + * holds the filter.
*/ VocabularyFilterName?: string; @@ -3271,17 +3414,19 @@ export namespace VocabularyFilterInfo { export interface ListVocabularyFiltersResponse { /** - *The ListVocabularyFilters operation returns a page of collections at a time. The maximum size
- * of the page is set by the MaxResults parameter. If there are more jobs in the list than the page size,
- * Amazon Transcribe returns the NextPage token. Include the token in the next request to the
- * ListVocabularyFilters operation to return in the next page of jobs.
The ListVocabularyFilters operation returns a page of collections at a time.
+ * The maximum size of the page is set by the MaxResults parameter. If there
+ * are more jobs in the list than the page size, Amazon Transcribe returns the NextPage token.
+ * Include the token in the next request to the ListVocabularyFilters operation to
+ * return in the next page of jobs.
The list of vocabulary filters. It contains at most MaxResults number of filters. If there are more
- * filters, call the ListVocabularyFilters operation again with the NextToken parameter
- * in the request set to the value of the NextToken field in the response.
The list of vocabulary filters. It contains at most MaxResults number of
+ * filters. If there are more filters, call the ListVocabularyFilters operation again
+ * with the NextToken parameter in the request set to the value of the
+ * NextToken field in the response.
The name of the call analytics job. You can't use the string "." or ".." by themselves as the job name. The name
- * must also be unique within an Amazon Web Services account. If you try to create a call analytics job with the same
- * name as a previous call analytics job, you get a ConflictException error.
The name of the call analytics job. You can't use the string "." or ".." by themselves as
+ * the job name. The name must also be unique within an Amazon Web Services account. If you
+ * try to create a call analytics job with the same name as a previous call analytics job, you get
+ * a ConflictException error.
The Amazon S3 location where the output of the call analytics job is stored. You can provide the following - * location types to store the output of call analytics job:
+ *The Amazon S3 location where the output of the call analytics job is stored. You can + * provide the following location types to store the output of call analytics job:
*s3://DOC-EXAMPLE-BUCKET1
- *If you specify a bucket, Amazon Transcribe saves the output of the analytics job as a JSON file at the root level of the - * bucket.
+ *If you specify a bucket, Amazon Transcribe saves the output of the analytics job as a JSON file + * at the root level of the bucket.
*s3://DOC-EXAMPLE-BUCKET1/folder/
*f you specify a path, Amazon Transcribe saves the output of the analytics job as - * s3://DOC-EXAMPLE-BUCKET1/folder/your-transcription-job-name.json
+ * s3://DOC-EXAMPLE-BUCKET1/folder/your-transcription-job-name.json. *If you specify a folder, you must provide a trailing slash.
*s3://DOC-EXAMPLE-BUCKET1/folder/filename.json
- *If you provide a path that has the filename specified, Amazon Transcribe saves the output of the analytics job as - * s3://DOC-EXAMPLEBUCKET1/folder/filename.json
+ *s3://DOC-EXAMPLE-BUCKET1/folder/filename.json.
+ *If you provide a path that has the filename specified, Amazon Transcribe saves the output of + * the analytics job as s3://DOC-EXAMPLEBUCKET1/folder/filename.json.
*You can specify an Amazon Web Services Key Management Service (KMS) key to encrypt the output of our
- * analytics job using the OutputEncryptionKMSKeyId parameter. If you don't specify a KMS key,
- * Amazon Transcribe uses the default Amazon S3 key for server-side encryption of the analytics job output that is placed in your
- * S3 bucket.
You can specify an Amazon Web Services Key Management Service (KMS) key to encrypt
+ * the output of our analytics job using the OutputEncryptionKMSKeyId parameter.
+ * If you don't specify a KMS key, Amazon Transcribe uses the default Amazon S3 key for server-side encryption
+ * of the analytics job output that is placed in your S3 bucket.
The Amazon Resource Name (ARN) of the Amazon Web Services Key Management Service key used to encrypt - * the output of the call analytics job. The user calling the operation must - * have permission to use the specified KMS key.
- *You use either of the following to identify an Amazon Web Services KMS key in the current account:
+ *The Amazon Resource Name (ARN) of the Amazon Web Services Key Management Service + * key used to encrypt the output of the call analytics job. The user calling the + * operation must have permission to use the + * specified KMS key.
+ *You use either of the following to identify an Amazon Web Services KMS key in the current + * account:
*KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
@@ -3349,39 +3497,45 @@ export interface StartCallAnalyticsJobRequest { *KMS Key Alias: "alias/ExampleAlias"
*You can use either of the following to identify a KMS key in the current account or another account:
+ *You can use either of the following to identify a KMS key in the current account or + * another account:
*Amazon Resource Name (ARN) of a KMS key in the current account or another account: + *
Amazon Resource Name (ARN) of a KMS key in the current account or + * another account: * "arn:aws:kms:region:account ID:key/1234abcd-12ab-34cd-56ef1234567890ab"
*ARN of a KMS Key Alias: "arn:aws:kms:region:account ID:alias/ExampleAlias"
+ *ARN of a KMS Key Alias: + * "arn:aws:kms:region:accountID:alias/ExampleAlias"
*If you don't specify an encryption key, the output of the call analytics job is encrypted with the default Amazon - * S3 key (SSE-S3).
- *If you specify a KMS key to encrypt your output, you must also specify an output location in the
- * OutputLocation parameter.
If you don't specify an encryption key, the output of the call analytics job is encrypted + * with the default Amazon S3 key (SSE-S3).
+ *If you specify a KMS key to encrypt your output, you must also specify an output location
+ * in the OutputLocation parameter.
The Amazon Resource Name (ARN) of a role that has access to the S3 bucket that contains your input files. - * Amazon Transcribe assumes this role to read queued audio files. If you have specified an output S3 bucket for your transcription - * results, this role should have access to the output bucket as well.
+ *The Amazon Resource Name (ARN) of a role that has access to the S3 bucket that + * contains your input files. Amazon Transcribe assumes this role to read queued audio files. If you have + * specified an output S3 bucket for your transcription results, this role should have access to + * the output bucket as well.
*/ DataAccessRoleArn: string | undefined; /** - *A Settings object that provides optional settings for a call analytics job.
A Settings object that provides optional settings for a call analytics
+ * job.
When you start a call analytics job, you must pass an array that maps the agent and the customer to specific - * audio channels. The values you can assign to a channel are 0 and 1. The agent and the customer must each have - * their own channel. You can't assign more than one channel to an agent or customer.
+ *When you start a call analytics job, you must pass an array that maps the agent and the + * customer to specific audio channels. The values you can assign to a channel are 0 and 1. The + * agent and the customer must each have their own channel. You can't assign more than one + * channel to an agent or customer.
*/ ChannelDefinitions?: ChannelDefinition[]; } @@ -3413,25 +3567,27 @@ export namespace StartCallAnalyticsJobResponse { export interface StartMedicalTranscriptionJobRequest { /** - *The name of the medical transcription job. You can't use the strings "." or ".."
- * by themselves as the job name. The name must also be unique within an Amazon Web Services account. If you try to
- * create a medical transcription job with the same name as a previous medical transcription job, you get a
- * ConflictException error.
The name of the medical transcription job. You can't use the strings "."
+ * or ".." by themselves as the job name. The name must also be unique within an
+ * Amazon Web Services account. If you try to create a medical transcription job with the same
+ * name as a previous medical transcription job, you get a ConflictException
+ * error.
The language code for the language spoken in the input media file. US English (en-US) is the valid value for
- * medical transcription jobs. Any other value you enter for language code results in a
- * BadRequestException error.
The language code for the language spoken in the input media file. US English (en-US) is
+ * the valid value for medical transcription jobs. Any other value you enter for language code
+ * results in a BadRequestException error.
The sample rate, in Hertz, of the audio track in the input media file.
- *If you do not specify the media sample rate, Amazon Transcribe Medical determines the sample rate. If you specify the sample rate,
- * it must match the rate detected by Amazon Transcribe Medical. In most cases, you should leave the
- * MediaSampleRateHertz field blank and let Amazon Transcribe Medical determine the sample rate.
If you do not specify the media sample rate, Amazon Transcribe Medical determines the sample rate. If you
+ * specify the sample rate, it must match the rate detected by Amazon Transcribe Medical. In most cases, you
+ * should leave the MediaSampleRateHertz field blank and let Amazon Transcribe Medical determine
+ * the sample rate.
The Amazon S3 location where the transcription is stored.
- *You must set OutputBucketName for Amazon Transcribe Medical to store the transcription results. Your transcript
- * appears in the S3 location you specify. When you call the GetMedicalTranscriptionJob, the operation
- * returns this location in the TranscriptFileUri field. The S3 bucket must have permissions that allow
- * Amazon Transcribe Medical to put files in the bucket. For more information, see Permissions Required for
- * IAM User Roles.
You can specify an Amazon Web Services Key Management Service (KMS) key to encrypt the output of your
- * transcription using the OutputEncryptionKMSKeyId parameter. If you don't specify a KMS key, Amazon Transcribe Medical
- * uses the default Amazon S3 key for server-side encryption of transcripts that are placed in your S3 bucket.
You must set OutputBucketName for Amazon Transcribe Medical to store the transcription
+ * results. Your transcript appears in the S3 location you specify. When you call the
+ * GetMedicalTranscriptionJob, the operation returns this location in the
+ * TranscriptFileUri field. The S3 bucket must have permissions that allow
+ * Amazon Transcribe Medical to put files in the bucket. For more information, see Permissions Required for IAM User Roles.
You can specify an Amazon Web Services Key Management Service (KMS) key to encrypt
+ * the output of your transcription using the OutputEncryptionKMSKeyId parameter.
+ * If you don't specify a KMS key, Amazon Transcribe Medical uses the default Amazon S3 key for server-side
+ * encryption of transcripts that are placed in your S3 bucket.
You can specify a location in an Amazon S3 bucket to store the output of your medical transcription job.
- *If you don't specify an output key, Amazon Transcribe Medical stores the output of your transcription job in the Amazon S3 bucket you - * specified. By default, the object key is "your-transcription-job-name.json".
- *You can use output keys to specify the Amazon S3 prefix and file name of the transcription output. For example, - * specifying the Amazon S3 prefix, "folder1/folder2/", as an output key would lead to the output being stored as - * "folder1/folder2/your-transcription-job-name.json". If you specify "my-other-job-name.json" as the output key, the object - * key is changed to "my-other-job-name.json". You can use an output key to change both the prefix and the file name, for - * example "folder/my-other-job-name.json".
- *If you specify an output key, you must also specify an S3 bucket in the OutputBucketName
- * parameter.
You can specify a location in an Amazon S3 bucket to store the output of your medical + * transcription job.
+ *If you don't specify an output key, Amazon Transcribe Medical stores the output of your transcription job in + * the Amazon S3 bucket you specified. By default, the object key is + * "your-transcription-job-name.json".
+ *You can use output keys to specify the Amazon S3 prefix and file name of the transcription + * output. For example, specifying the Amazon S3 prefix, "folder1/folder2/", as an output key would + * lead to the output being stored as "folder1/folder2/your-transcription-job-name.json". If you + * specify "my-other-job-name.json" as the output key, the object key is changed to + * "my-other-job-name.json". You can use an output key to change both the prefix and the file + * name, for example "folder/my-other-job-name.json".
+ *If you specify an output key, you must also specify an S3 bucket in the
+ * OutputBucketName parameter.
The Amazon Resource Name (ARN) of the Amazon Web Services Key Management Service (KMS) key used to - * encrypt the output of the transcription job. The user calling the StartMedicalTranscriptionJob - * operation must have permission to use the specified KMS key.
+ *The Amazon Resource Name (ARN) of the Amazon Web Services Key Management Service + * (KMS) key used to encrypt the output of the transcription job. The user calling the + * StartMedicalTranscriptionJob operation must have permission to use the + * specified KMS key.
*You use either of the following to identify a KMS key in the current account:
*KMS Key Alias: "alias/ExampleAlias"
*You can use either of the following to identify a KMS key in the current account or another account:
+ *You can use either of the following to identify a KMS key in the current account or + * another account:
*Amazon Resource Name (ARN) of a KMS key in the current account or another @@ -3495,16 +3657,16 @@ export interface StartMedicalTranscriptionJobRequest { *
ARN of a KMS Key Alias: "arn:aws:kms:region:account ID:alias/ExampleAlias"
*If you don't specify an encryption key, the output of the medical transcription job is encrypted with the default Amazon S3 - * key (SSE-S3).
- *If you specify a KMS key to encrypt your output, you must also specify an output location in the
- * OutputBucketName parameter.
If you don't specify an encryption key, the output of the medical transcription job is + * encrypted with the default Amazon S3 key (SSE-S3).
+ *If you specify a KMS key to encrypt your output, you must also specify an output location
+ * in the OutputBucketName parameter.
A map of plain text, non-secret key:value pairs, known as encryption context pairs, that provide an added - * layer of security for your data.
+ *A map of plain text, non-secret key:value pairs, known as encryption context pairs, that + * provide an added layer of security for your data.
*/ KMSEncryptionContext?: { [key: string]: string }; @@ -3514,8 +3676,9 @@ export interface StartMedicalTranscriptionJobRequest { Settings?: MedicalTranscriptionSetting; /** - *You can configure Amazon Transcribe Medical to label content in the transcription output. If you specify PHI,
- * Amazon Transcribe Medical labels the personal health information (PHI) that it identifies in the transcription output.
You can configure Amazon Transcribe Medical to label content in the transcription output. If you specify
+ * PHI, Amazon Transcribe Medical labels the personal health information (PHI) that it identifies in the
+ * transcription output.
The type of speech in the input audio. CONVERSATION refers to conversations between two or
- * more speakers, e.g., a conversations between doctors and patients. DICTATION refers to
- * single-speaker dictated speech, such as clinical notes.
The type of speech in the input audio. CONVERSATION refers to
+ * conversations between two or more speakers, e.g., a conversations between doctors and
+ * patients. DICTATION refers to single-speaker dictated speech, such as clinical
+ * notes.
The name of the job. You can't use the strings "." or ".." by themselves as the
- * job name. The name must also be unique within an Amazon Web Services account. If you try to create a transcription
- * job with the same name as a previous transcription job, you get a ConflictException error.
The name of the job. You can't use the strings "." or ".."
+ * by themselves as the job name. The name must also be unique within an Amazon Web Services
+ * account. If you try to create a transcription job with the same name as a previous
+ * transcription job, you get a ConflictException error.
The language code for the language used in the input media file.
- *To transcribe speech in Modern Standard Arabic (ar-SA), your audio or video file must be encoded at a sample - * rate of 16,000 Hz or higher.
+ *To transcribe speech in Modern Standard Arabic (ar-SA), your audio or video file must + * be encoded at a sample rate of 16,000 Hz or higher.
*/ LanguageCode?: LanguageCode | string; /** *The sample rate, in Hertz, of the audio track in the input media file.
- *If you do not specify the media sample rate, Amazon Transcribe determines the sample rate. If you specify the sample rate, it
- * must match the sample rate detected by Amazon Transcribe. In most cases, you should leave the
- * MediaSampleRateHertz field blank and let Amazon Transcribe determine the sample rate.
If you do not specify the media sample rate, Amazon Transcribe determines the sample rate. If you
+ * specify the sample rate, it must match the sample rate detected by Amazon Transcribe. In most cases,
+ * you should leave the MediaSampleRateHertz field blank and let Amazon Transcribe
+ * determine the sample rate.
The location where the transcription is stored.
- *If you set the OutputBucketName, Amazon Transcribe puts the transcript in the specified S3 bucket. When
- * you call the GetTranscriptionJob operation, the operation returns this location in the
- * TranscriptFileUri field. If you enable content redaction, the redacted transcript appears in
- * RedactedTranscriptFileUri. If you enable content redaction and choose to output an unredacted
- * transcript, that transcript's location still appears in the TranscriptFileUri. The S3 bucket must have
- * permissions that allow Amazon Transcribe to put files in the bucket. For more information, see Permissions Required for
- * IAM User Roles.
You can specify an Amazon Web Services Key Management Service (KMS) key to encrypt the output of your
- * transcription using the OutputEncryptionKMSKeyId parameter. If you don't specify a KMS key, Amazon Transcribe
- * uses the default Amazon S3 key for server-side encryption of transcripts that are placed in your S3 bucket.
If you don't set the OutputBucketName, Amazon Transcribe generates a pre-signed URL, a shareable URL that
- * provides secure access to your transcription, and returns it in the TranscriptFileUri field. Use this URL
- * to download the transcription.
If you set the OutputBucketName, Amazon Transcribe puts the transcript in the
+ * specified S3 bucket. When you call the GetTranscriptionJob operation, the
+ * operation returns this location in the TranscriptFileUri field. If you enable
+ * content redaction, the redacted transcript appears in
+ * RedactedTranscriptFileUri. If you enable content redaction and choose to
+ * output an unredacted transcript, that transcript's location still appears in the
+ * TranscriptFileUri. The S3 bucket must have permissions that allow Amazon Transcribe to
+ * put files in the bucket. For more information, see Permissions
+ * Required for IAM User Roles.
You can specify an Amazon Web Services Key Management Service (KMS) key to encrypt
+ * the output of your transcription using the OutputEncryptionKMSKeyId
+ * parameter. If you don't specify a KMS key, Amazon Transcribe uses the default Amazon S3 key for
+ * server-side encryption of transcripts that are placed in your S3 bucket.
If you don't set the OutputBucketName, Amazon Transcribe generates a pre-signed URL,
+ * a shareable URL that provides secure access to your transcription, and returns it in the
+ * TranscriptFileUri field. Use this URL to download the transcription.
You can specify a location in an Amazon S3 bucket to store the output of your transcription job.
- *If you don't specify an output key, Amazon Transcribe stores the output of your transcription job in the Amazon S3 bucket you - * specified. By default, the object key is "your-transcription-job-name.json".
- *You can use output keys to specify the Amazon S3 prefix and file name of the transcription output. For example, - * specifying the Amazon S3 prefix, "folder1/folder2/", as an output key would lead to the output being stored as - * "folder1/folder2/your-transcription-job-name.json". If you specify "my-other-job-name.json" as the output key, the - * object key is changed to "my-other-job-name.json". You can use an output key to change both the prefix and the file + *
You can specify a location in an Amazon S3 bucket to store the output of your transcription + * job.
+ *If you don't specify an output key, Amazon Transcribe stores the output of your transcription job in + * the Amazon S3 bucket you specified. By default, the object key is + * "your-transcription-job-name.json".
+ *You can use output keys to specify the Amazon S3 prefix and file name of the transcription + * output. For example, specifying the Amazon S3 prefix, "folder1/folder2/", as an output key would + * lead to the output being stored as "folder1/folder2/your-transcription-job-name.json". If you + * specify "my-other-job-name.json" as the output key, the object key is changed to + * "my-other-job-name.json". You can use an output key to change both the prefix and the file * name, for example "folder/my-other-job-name.json".
- *If you specify an output key, you must also specify an S3 bucket in the OutputBucketName
- * parameter.
If you specify an output key, you must also specify an S3 bucket in the
+ * OutputBucketName parameter.
The Amazon Resource Name (ARN) of the Amazon Web Services Key Management Service (KMS) key used to
- * encrypt the output of the transcription job. The user calling the StartTranscriptionJob
- * operation must have permission to use the specified KMS key.
The Amazon Resource Name (ARN) of the Amazon Web Services Key Management
+ * Service (KMS) key used to encrypt the output of the transcription job. The user calling the
+ * StartTranscriptionJob operation must have permission to use the specified
+ * KMS key.
You can use either of the following to identify a KMS key in the current account:
*KMS Key Alias: "alias/ExampleAlias"
*You can use either of the following to identify a KMS key in the current account or another account:
+ *You can use either of the following to identify a KMS key in the current account or + * another account:
*Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:region:account @@ -3669,33 +3843,35 @@ export interface StartTranscriptionJobRequest { *
ARN of a KMS Key Alias: "arn:aws:kms:region:account-ID:alias/ExampleAlias"
*If you don't specify an encryption key, the output of the transcription job is encrypted with the default - * Amazon S3 key (SSE-S3).
- *If you specify a KMS key to encrypt your output, you must also specify an output location in the
- * OutputBucketName parameter.
If you don't specify an encryption key, the output of the transcription job is encrypted + * with the default Amazon S3 key (SSE-S3).
+ *If you specify a KMS key to encrypt your output, you must also specify an output location
+ * in the OutputBucketName parameter.
A map of plain text, non-secret key:value pairs, known as encryption context pairs, that provide an added - * layer of security for your data.
+ *A map of plain text, non-secret key:value pairs, known as encryption context pairs, that + * provide an added layer of security for your data.
*/ KMSEncryptionContext?: { [key: string]: string }; /** - *A Settings object that provides optional settings for a transcription job.
A Settings object that provides optional settings for a transcription
+ * job.
Choose the custom language model you use for your transcription job in this parameter.
+ *Choose the custom language model you use for your transcription job in this + * parameter.
*/ ModelSettings?: ModelSettings; /** - *Provides information about how a transcription job is executed. Use this field to indicate that the job can be - * queued for deferred execution if the concurrency limit is reached and there are no slots available to immediately run - * the job.
+ *Provides information about how a transcription job is executed. Use this field to indicate + * that the job can be queued for deferred execution if the concurrency limit is reached and + * there are no slots available to immediately run the job.
*/ JobExecutionSettings?: JobExecutionSettings; @@ -3705,17 +3881,19 @@ export interface StartTranscriptionJobRequest { ContentRedaction?: ContentRedaction; /** - *Set this field to true to enable automatic language identification. Automatic language identification
- * is disabled by default. You receive a BadRequestException error if you enter a value for a
+ *
Set this field to true to enable automatic language identification.
+ * Automatic language identification is disabled by default. You receive a
+ * BadRequestException error if you enter a value for a
* LanguageCode.
An object containing a list of languages that might be present in your collection of audio files. Automatic language - * identification chooses a language that best matches the source audio from that list.
- *To transcribe speech in Modern Standard Arabic (ar-SA), your audio or video file must be encoded at a sample - * rate of 16,000 Hz or higher.
+ *An object containing a list of languages that might be present in your collection of + * audio files. Automatic language identification chooses a language that best matches the + * source audio from that list.
+ *To transcribe speech in Modern Standard Arabic (ar-SA), your audio or video file must + * be encoded at a sample rate of 16,000 Hz or higher.
*/ LanguageOptions?: (LanguageCode | string)[]; @@ -3730,9 +3908,9 @@ export interface StartTranscriptionJobRequest { Tags?: Tag[]; /** - *The language identification settings associated with your transcription job. These settings include
- * VocabularyName, VocabularyFilterName, and
- * LanguageModelName.
The language identification settings associated with your transcription job. These
+ * settings include VocabularyName, VocabularyFilterName,
+ * and LanguageModelName.
The Amazon Resource Name (ARN) of the Amazon Transcribe resource you want to tag. ARNs have the format
- * arn:partition:service:region:account-id:resource-type/resource-id (for example,
- * arn:aws:transcribe:us-east-1:account-id:transcription-job/your-job-name). Valid
- * values for resource-type are: transcription-job,
+ *
The Amazon Resource Name (ARN) of the Amazon Transcribe resource you want to tag. ARNs have
+ * the format arn:partition:service:region:account-id:resource-type/resource-id
+ * (for example,
+ * arn:aws:transcribe:us-east-1:account-id:transcription-job/your-job-name).
+ * Valid values for resource-type are: transcription-job,
* medical-transcription-job, vocabulary,
* medical-vocabulary, vocabulary-filter, and
* language-model.
The Amazon Resource Name (ARN) of the Amazon Transcribe resource you want to remove tags from. - * ARNs have the format + *
The Amazon Resource Name (ARN) of the Amazon Transcribe resource you want to remove tags
+ * from. ARNs have the format
* arn:partition:service:region:account-id:resource-type/resource-id (for example,
- * arn:aws:transcribe:us-east-1:account-id:transcription-job/your-job-name). Valid
- * values for resource-type are: transcription-job,
+ * arn:aws:transcribe:us-east-1:account-id:transcription-job/your-job-name).
+ * Valid values for resource-type are: transcription-job,
* medical-transcription-job, vocabulary,
* medical-vocabulary, vocabulary-filter, and
* language-model.
The name of the analytics category to update. The name is case sensitive. If you try to update a call analytics
- * category with the same name as a previous category you will receive a ConflictException error.
The name of the analytics category to update. The name is case sensitive. If you try
+ * to update a call analytics category with the same name as a previous category you will
+ * receive a ConflictException error.
The rules used for the updated analytics category. The rules that you provide in this field replace the ones - * that are currently being used.
+ *The rules used for the updated analytics category. The rules that you provide in this + * field replace the ones that are currently being used.
*/ Rules: Rule[] | undefined; } @@ -3865,8 +4045,9 @@ export namespace UpdateCallAnalyticsCategoryRequest { export interface UpdateCallAnalyticsCategoryResponse { /** - *The attributes describing the analytics category. You can see information such as the rules that you've used - * to update the category and when the category was originally created.
+ *The attributes describing the analytics category. You can see information such as the + * rules that you've used to update the category and when the category was originally + * created.
*/ CategoryProperties?: CategoryProperties; } @@ -3885,32 +4066,33 @@ export namespace UpdateCallAnalyticsCategoryResponse { export interface UpdateMedicalVocabularyRequest { /** - *The name of the vocabulary to update. The name is case sensitive. If you try to update a vocabulary with the
- * same name as a vocabulary you've already made, you get a ConflictException error.
The name of the vocabulary to update. The name is case sensitive. If you try to update
+ * a vocabulary with the same name as a vocabulary you've already made, you get a
+ * ConflictException error.
The language code of the language used for the entries in the updated vocabulary. US English (en-US) is the - * only valid language code in Amazon Transcribe Medical.
+ *The language code of the language used for the entries in the updated vocabulary. + * U.S. English (en-US) is the only valid language code in Amazon Transcribe Medical.
*/ LanguageCode: LanguageCode | string | undefined; /** - *The location in Amazon S3 of the text file that contains your custom vocabulary. The URI must be in the same - * Amazon Web Services Region as the resource that you are calling. The following is the format for a URI:
+ *The location in Amazon S3 of the text file that contains your custom vocabulary. The URI must + * be in the same Amazon Web Services Region as the resource that you are calling. The following + * is the format for a URI:
*
- *
- * https://s3.
+ * https://s3.
*
For example:
*
* https://s3.us-east-1.amazonaws.com/AWSDOC-EXAMPLE-BUCKET/vocab.txt
*
For more information about Amazon S3 object names, see Object Keys in the Amazon S3 - * Developer Guide.
- *For more information about custom vocabularies in Amazon Transcribe Medical, see Medical Custom Vocabularies.
+ *For more information about Amazon S3 object names, see Object Keys in the + * Amazon S3 Developer Guide.
+ *For more information about custom vocabularies in Amazon Transcribe Medical, see Medical Custom + * Vocabularies.
*/ VocabularyFileUri?: string; } @@ -3931,8 +4113,8 @@ export interface UpdateMedicalVocabularyResponse { VocabularyName?: string; /** - *The language code for the language of the text file used to update the custom vocabulary. US English (en-US) - * is the only language supported in Amazon Transcribe Medical.
+ *The language code for the language of the text file used to update the custom + * vocabulary. US English (en-US) is the only language supported in Amazon Transcribe Medical.
*/ LanguageCode?: LanguageCode | string; @@ -3942,9 +4124,9 @@ export interface UpdateMedicalVocabularyResponse { LastModifiedTime?: Date; /** - *The processing state of the update to the vocabulary. When the VocabularyState field is
- * READY, the vocabulary is ready to be used in a StartMedicalTranscriptionJob
- * request.
The processing state of the update to the vocabulary. When the
+ * VocabularyState field is READY, the vocabulary is ready to
+ * be used in a StartMedicalTranscriptionJob request.
The name of the vocabulary to update. The name is case sensitive. If you try to update a vocabulary with the
- * same name as a previous vocabulary you will receive a ConflictException error.
The name of the vocabulary to update. The name is case sensitive. If you try to update
+ * a vocabulary with the same name as a previous vocabulary you will receive a
+ * ConflictException error.
The language code of the vocabulary entries. For a list of languages and their corresponding language codes, - * see transcribe-whatis.
+ *The language code of the vocabulary entries. For a list of languages and their + * corresponding language codes, see Supported languages.
*/ LanguageCode: LanguageCode | string | undefined; @@ -3977,14 +4160,20 @@ export interface UpdateVocabularyRequest { Phrases?: string[]; /** - *The S3 location of the text file that contains the definition of the custom vocabulary. The URI must be in the - * same region as the API endpoint that you are calling. The general form is
- * + *The S3 location of the text file that contains the definition of the custom vocabulary. + * The URI must be in the same region as the API endpoint that you are calling. The general form + * is:
+ *
+ * https://s3.
+ *
For example:
- * - *For more information about S3 object names, see Object Keys in the Amazon S3 - * Developer Guide.
- *For more information about custom vocabularies, see Custom Vocabularies.
+ *
+ * https://s3.us-east-1.amazonaws.com/AWSDOC-EXAMPLE-BUCKET/vocab.txt
+ *
For more information about S3 object names, see Object Keys in the + * Amazon S3 Developer Guide.
+ *For more information about custom vocabularies, see Custom + * Vocabularies.
*/ VocabularyFileUri?: string; } @@ -4015,9 +4204,9 @@ export interface UpdateVocabularyResponse { LastModifiedTime?: Date; /** - *The processing state of the vocabulary. When the VocabularyState field contains
- * READY the vocabulary is ready to be used in a StartTranscriptionJob
- * request.
The processing state of the vocabulary. When the VocabularyState
+ * field contains READY the vocabulary is ready to be used in a
+ * StartTranscriptionJob request.
The name of the vocabulary filter to update. If you try to update a vocabulary filter with the same name as
- * another vocabulary filter, you get a ConflictException error.
The name of the vocabulary filter to update. If you try to update a vocabulary filter with
+ * the same name as another vocabulary filter, you get a ConflictException
+ * error.
The words to use in the vocabulary filter. Only use characters from the character set defined for custom - * vocabularies. For a list of character sets, see Character Sets for Custom Vocabularies.
+ *The words to use in the vocabulary filter. Only use characters from the character + * set defined for custom vocabularies. For a list of character sets, see + * Character + * Sets for Custom Vocabularies.
*If you provide a list of words in the Words parameter, you can't use the
* VocabularyFilterFileUri parameter.
The Amazon S3 location of a text file used as input to create the vocabulary filter. Only use characters from - * the character set defined for custom vocabularies. For a list of character sets, see Character Sets for Custom Vocabularies.
+ *The Amazon S3 location of a text file used as input to create the vocabulary filter. + * Only use characters from the character set defined for custom vocabularies. For a list of + * character sets, see Character Sets for Custom + * Vocabularies.
*The specified file must be less than 50 KB of UTF-8 characters.
- *If you provide the location of a list of words in the
- * VocabularyFilterFileUri parameter, you can't use the Words
- * parameter.
If you provide the location of a list of words in the VocabularyFilterFileUri
+ * parameter, you can't use the Words parameter.
Creates a client-add-in for Amazon Connect within a directory. You can create only + * one Amazon Connect client add-in within a directory.
+ * + *This client add-in allows WorkSpaces users to seamlessly connect to Amazon Connect.
+ */ + public createConnectClientAddIn( + args: CreateConnectClientAddInCommandInput, + options?: __HttpHandlerOptions + ): PromiseCreates the specified connection alias for use with cross-Region redirection. For more information, see
*
@@ -643,6 +698,39 @@ export class WorkSpaces extends WorkSpacesClient {
}
}
+ /**
+ * Deletes a client-add-in for Amazon Connect that is configured within a
+ * directory. Deletes the specified connection alias. For more information, see
* Cross-Region Redirection for Amazon WorkSpaces. Retrieves a list of Amazon Connect client add-ins that have been created.