Skip to content

Commit b99e527

Browse files
authored
docs: call out @deprecated in comments for shapes/members (#1876)
1 parent fc22682 commit b99e527

File tree

76 files changed

+298
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

76 files changed

+298
-0
lines changed

clients/client-application-discovery-service/ApplicationDiscoveryService.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -566,6 +566,8 @@ export class ApplicationDiscoveryService extends ApplicationDiscoveryServiceClie
566566
}
567567

568568
/**
569+
* @deprecated
570+
*
569571
* <p>
570572
* <code>DescribeExportConfigurations</code> is deprecated. Use <a href="https://docs.aws.amazon.com/application-discovery/latest/APIReference/API_DescribeExportTasks.html">DescribeImportTasks</a>, instead.</p>
571573
*/
@@ -743,6 +745,8 @@ export class ApplicationDiscoveryService extends ApplicationDiscoveryServiceClie
743745
}
744746

745747
/**
748+
* @deprecated
749+
*
746750
* <p>Deprecated. Use <code>StartExportTask</code> instead.</p>
747751
* <p>Exports all discovered configuration data to an Amazon S3 bucket or an application that
748752
* enables you to view and evaluate the data. Data includes tags and tag associations, processes,

clients/client-application-discovery-service/commands/DescribeExportConfigurationsCommand.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,8 @@ export type DescribeExportConfigurationsCommandInput = DescribeExportConfigurati
2525
export type DescribeExportConfigurationsCommandOutput = DescribeExportConfigurationsResponse & __MetadataBearer;
2626

2727
/**
28+
* @deprecated
29+
*
2830
* <p>
2931
* <code>DescribeExportConfigurations</code> is deprecated. Use <a href="https://docs.aws.amazon.com/application-discovery/latest/APIReference/API_DescribeExportTasks.html">DescribeImportTasks</a>, instead.</p>
3032
*/

clients/client-application-discovery-service/commands/ExportConfigurationsCommand.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,8 @@ export type ExportConfigurationsCommandInput = {};
2525
export type ExportConfigurationsCommandOutput = ExportConfigurationsResponse & __MetadataBearer;
2626

2727
/**
28+
* @deprecated
29+
*
2830
* <p>Deprecated. Use <code>StartExportTask</code> instead.</p>
2931
* <p>Exports all discovered configuration data to an Amazon S3 bucket or an application that
3032
* enables you to view and evaluate the data. Data includes tags and tag associations, processes,

clients/client-appstream/models/models_0.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3786,6 +3786,8 @@ export interface UpdateFleetRequest {
37863786
DisconnectTimeoutInSeconds?: number;
37873787

37883788
/**
3789+
* @deprecated
3790+
*
37893791
* <p>Deletes the VPC association for the specified fleet.</p>
37903792
*/
37913793
DeleteVpcConfig?: boolean;
@@ -3935,6 +3937,8 @@ export interface UpdateStackRequest {
39353937
StorageConnectors?: StorageConnector[];
39363938

39373939
/**
3940+
* @deprecated
3941+
*
39383942
* <p>Deletes the storage connectors currently enabled for the stack.</p>
39393943
*/
39403944
DeleteStorageConnectors?: boolean;

clients/client-auto-scaling/models/models_0.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3546,6 +3546,8 @@ export interface ScalingPolicy {
35463546
AdjustmentType?: string;
35473547

35483548
/**
3549+
* @deprecated
3550+
*
35493551
* <p>Available for backward compatibility. Use <code>MinAdjustmentMagnitude</code>
35503552
* instead.</p>
35513553
*/
@@ -4524,6 +4526,8 @@ export interface PutScalingPolicyType {
45244526
AdjustmentType?: string;
45254527

45264528
/**
4529+
* @deprecated
4530+
*
45274531
* <p>Available for backward compatibility. Use <code>MinAdjustmentMagnitude</code>
45284532
* instead.</p>
45294533
*/

clients/client-batch/models/models_0.ts

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -435,6 +435,8 @@ export interface ComputeResource {
435435
instanceTypes?: string[];
436436

437437
/**
438+
* @deprecated
439+
*
438440
* <p>The Amazon Machine Image (AMI) ID used for instances launched in the compute environment. This parameter is
439441
* overridden by the <code>imageIdOverride</code> member of the <code>Ec2Configuration</code> structure.</p>
440442
* <note>
@@ -1645,6 +1647,8 @@ export interface ContainerProperties {
16451647
image?: string;
16461648

16471649
/**
1650+
* @deprecated
1651+
*
16481652
* <p>This parameter is deprecated and not supported for jobs run on Fargate resources, see
16491653
* <code>resourceRequirement</code>. The number of vCPUs reserved for the container. Jobs running on EC2 resources can
16501654
* specify the vCPU requirement for the job using <code>resourceRequirements</code> but the vCPU requirements can't be
@@ -1661,6 +1665,8 @@ export interface ContainerProperties {
16611665
vcpus?: number;
16621666

16631667
/**
1668+
* @deprecated
1669+
*
16641670
* <p>This parameter is deprecated and not supported for jobs run on Fargate resources, use
16651671
* <code>ResourceRequirement</code>. For jobs run on EC2 resources can specify the memory requirement using the
16661672
* <code>ResourceRequirement</code> structure. The hard limit (in MiB) of memory to present to the container. If your
@@ -2969,6 +2975,8 @@ export namespace RegisterJobDefinitionResponse {
29692975
*/
29702976
export interface ContainerOverrides {
29712977
/**
2978+
* @deprecated
2979+
*
29722980
* <p>This parameter is deprecated and not supported for jobs run on Fargate resources, see
29732981
* <code>resourceRequirement</code>. For jobs run on EC2 resources, the number of vCPUs to reserve for the container.
29742982
* This value overrides the value set in the job definition. Jobs run on EC2 resources can specify the vCPU requirement
@@ -2985,6 +2993,8 @@ export interface ContainerOverrides {
29852993
vcpus?: number;
29862994

29872995
/**
2996+
* @deprecated
2997+
*
29882998
* <p>This parameter is deprecated and not supported for jobs run on Fargate resources, use
29892999
* <code>ResourceRequirement</code>. For jobs run on EC2 resource, the number of MiB of memory reserved for the job.
29903000
* This value overrides the value set in the job definition.</p>

clients/client-cloudfront/models/models_0.ts

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -884,6 +884,8 @@ export interface CacheBehavior {
884884
OriginRequestPolicyId?: string;
885885

886886
/**
887+
* @deprecated
888+
*
887889
* <p>This field is deprecated. We recommend that you use a cache policy or an origin
888890
* request policy instead of this field. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/working-with-policies.html">Working with policies</a> in the
889891
* <i>Amazon CloudFront Developer Guide</i>.</p>
@@ -898,6 +900,8 @@ export interface CacheBehavior {
898900
ForwardedValues?: ForwardedValues;
899901

900902
/**
903+
* @deprecated
904+
*
901905
* <p>This field is deprecated. We recommend that you use the <code>MinTTL</code> field in a cache
902906
* policy instead of this field. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy">Creating cache policies</a> or <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html">Using the managed cache policies</a> in the
903907
* <i>Amazon CloudFront Developer Guide</i>.</p>
@@ -913,6 +917,8 @@ export interface CacheBehavior {
913917
MinTTL?: number;
914918

915919
/**
920+
* @deprecated
921+
*
916922
* <p>This field is deprecated. We recommend that you use the <code>DefaultTTL</code> field in a
917923
* cache policy instead of this field. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy">Creating cache policies</a> or <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html">Using the managed cache policies</a> in the
918924
* <i>Amazon CloudFront Developer Guide</i>.</p>
@@ -926,6 +932,8 @@ export interface CacheBehavior {
926932
DefaultTTL?: number;
927933

928934
/**
935+
* @deprecated
936+
*
929937
* <p>This field is deprecated. We recommend that you use the <code>MaxTTL</code> field in a cache
930938
* policy instead of this field. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy">Creating cache policies</a> or <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html">Using the managed cache policies</a> in the
931939
* <i>Amazon CloudFront Developer Guide</i>.</p>
@@ -2072,6 +2080,8 @@ export interface DefaultCacheBehavior {
20722080
OriginRequestPolicyId?: string;
20732081

20742082
/**
2083+
* @deprecated
2084+
*
20752085
* <p>This field is deprecated. We recommend that you use a cache policy or an origin request
20762086
* policy instead of this field. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/working-with-policies.html">Working with policies</a> in the
20772087
* <i>Amazon CloudFront Developer Guide</i>.</p>
@@ -2086,6 +2096,8 @@ export interface DefaultCacheBehavior {
20862096
ForwardedValues?: ForwardedValues;
20872097

20882098
/**
2099+
* @deprecated
2100+
*
20892101
* <p>This field is deprecated. We recommend that you use the <code>MinTTL</code> field in a cache
20902102
* policy instead of this field. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy">Creating cache policies</a> or <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html">Using the managed cache policies</a> in the
20912103
* <i>Amazon CloudFront Developer Guide</i>.</p>
@@ -2100,6 +2112,8 @@ export interface DefaultCacheBehavior {
21002112
MinTTL?: number;
21012113

21022114
/**
2115+
* @deprecated
2116+
*
21032117
* <p>This field is deprecated. We recommend that you use the <code>DefaultTTL</code> field in a
21042118
* cache policy instead of this field. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy">Creating cache policies</a> or <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html">Using the managed cache policies</a> in the
21052119
* <i>Amazon CloudFront Developer Guide</i>.</p>
@@ -2113,6 +2127,8 @@ export interface DefaultCacheBehavior {
21132127
DefaultTTL?: number;
21142128

21152129
/**
2130+
* @deprecated
2131+
*
21162132
* <p>This field is deprecated. We recommend that you use the <code>MaxTTL</code> field in a cache
21172133
* policy instead of this field. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy">Creating cache policies</a> or <a href="https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html">Using the managed cache policies</a> in the
21182134
* <i>Amazon CloudFront Developer Guide</i>.</p>
@@ -2935,6 +2951,8 @@ export interface ViewerCertificate {
29352951
MinimumProtocolVersion?: MinimumProtocolVersion | string;
29362952

29372953
/**
2954+
* @deprecated
2955+
*
29382956
* <p>This field is deprecated. Use one of the following fields instead:</p>
29392957
* <ul>
29402958
* <li>
@@ -2959,6 +2977,8 @@ export interface ViewerCertificate {
29592977
Certificate?: string;
29602978

29612979
/**
2980+
* @deprecated
2981+
*
29622982
* <p>This field is deprecated. Use one of the following fields instead:</p>
29632983
* <ul>
29642984
* <li>

clients/client-cloudtrail/models/models_0.ts

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -627,6 +627,8 @@ export interface CreateTrailResponse {
627627
S3KeyPrefix?: string;
628628

629629
/**
630+
* @deprecated
631+
*
630632
* <p>This field is no longer in use. Use SnsTopicARN.</p>
631633
*/
632634
SnsTopicName?: string;
@@ -912,6 +914,8 @@ export namespace KmsException {
912914
}
913915

914916
/**
917+
* @deprecated
918+
*
915919
* <p>This exception is no longer in use.</p>
916920
*/
917921
export interface KmsKeyDisabledException extends __SmithyException, $MetadataBearer {
@@ -1188,6 +1192,8 @@ export interface Trail {
11881192
S3KeyPrefix?: string;
11891193

11901194
/**
1195+
* @deprecated
1196+
*
11911197
* <p>This field is no longer in use. Use SnsTopicARN.</p>
11921198
*/
11931199
SnsTopicName?: string;
@@ -2680,6 +2686,8 @@ export interface UpdateTrailResponse {
26802686
S3KeyPrefix?: string;
26812687

26822688
/**
2689+
* @deprecated
2690+
*
26832691
* <p>This field is no longer in use. Use SnsTopicARN.</p>
26842692
*/
26852693
SnsTopicName?: string;

clients/client-cloudwatch-logs/models/models_0.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -831,6 +831,8 @@ export interface LogStream {
831831
arn?: string;
832832

833833
/**
834+
* @deprecated
835+
*
834836
* <p>The number of bytes stored.</p>
835837
* <p>
836838
* <b>Important:</b> On June 17, 2019, this parameter was
@@ -1434,6 +1436,8 @@ export interface FilterLogEventsRequest {
14341436
limit?: number;
14351437

14361438
/**
1439+
* @deprecated
1440+
*
14371441
* <p>If the value is true, the operation makes a best effort to provide responses that
14381442
* contain events from multiple log streams within the log group, interleaved in a single
14391443
* response. If the value is false, all the matched log events in the first log stream are

clients/client-codedeploy/CodeDeploy.ts

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -464,6 +464,8 @@ export class CodeDeploy extends CodeDeployClient {
464464
}
465465

466466
/**
467+
* @deprecated
468+
*
467469
* <note>
468470
* <p> This method works, but is deprecated. Use <code>BatchGetDeploymentTargets</code>
469471
* instead. </p>
@@ -1152,6 +1154,8 @@ export class CodeDeploy extends CodeDeployClient {
11521154
}
11531155

11541156
/**
1157+
* @deprecated
1158+
*
11551159
* <p>Gets information about an instance as part of a deployment.</p>
11561160
*/
11571161
public getDeploymentInstance(
@@ -1377,6 +1381,8 @@ export class CodeDeploy extends CodeDeployClient {
13771381
}
13781382

13791383
/**
1384+
* @deprecated
1385+
*
13801386
* <note>
13811387
* <p> The newer <code>BatchGetDeploymentTargets</code> should be used instead because
13821388
* it works with all compute types. <code>ListDeploymentInstances</code> throws an
@@ -1721,6 +1727,8 @@ export class CodeDeploy extends CodeDeployClient {
17211727
}
17221728

17231729
/**
1730+
* @deprecated
1731+
*
17241732
* <p>In a blue/green deployment, overrides any specified wait time and starts terminating
17251733
* instances immediately after the traffic routing is complete.</p>
17261734
*/

clients/client-codedeploy/commands/BatchGetDeploymentInstancesCommand.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,8 @@ export type BatchGetDeploymentInstancesCommandInput = BatchGetDeploymentInstance
2121
export type BatchGetDeploymentInstancesCommandOutput = BatchGetDeploymentInstancesOutput & __MetadataBearer;
2222

2323
/**
24+
* @deprecated
25+
*
2426
* <note>
2527
* <p> This method works, but is deprecated. Use <code>BatchGetDeploymentTargets</code>
2628
* instead. </p>

clients/client-codedeploy/commands/GetDeploymentInstanceCommand.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,8 @@ export type GetDeploymentInstanceCommandInput = GetDeploymentInstanceInput;
2121
export type GetDeploymentInstanceCommandOutput = GetDeploymentInstanceOutput & __MetadataBearer;
2222

2323
/**
24+
* @deprecated
25+
*
2426
* <p>Gets information about an instance as part of a deployment.</p>
2527
*/
2628
export class GetDeploymentInstanceCommand extends $Command<

clients/client-codedeploy/commands/ListDeploymentInstancesCommand.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,8 @@ export type ListDeploymentInstancesCommandInput = ListDeploymentInstancesInput;
2121
export type ListDeploymentInstancesCommandOutput = ListDeploymentInstancesOutput & __MetadataBearer;
2222

2323
/**
24+
* @deprecated
25+
*
2426
* <note>
2527
* <p> The newer <code>BatchGetDeploymentTargets</code> should be used instead because
2628
* it works with all compute types. <code>ListDeploymentInstances</code> throws an

clients/client-codedeploy/commands/SkipWaitTimeForInstanceTerminationCommand.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,8 @@ export type SkipWaitTimeForInstanceTerminationCommandInput = SkipWaitTimeForInst
2121
export type SkipWaitTimeForInstanceTerminationCommandOutput = __MetadataBearer;
2222

2323
/**
24+
* @deprecated
25+
*
2426
* <p>In a blue/green deployment, overrides any specified wait time and starts terminating
2527
* instances immediately after the traffic routing is complete.</p>
2628
*/

0 commit comments

Comments
 (0)