From 2ec8d4fd6e1bef7170f08beb34726a2096fe7621 Mon Sep 17 00:00:00 2001 From: awstools Date: Mon, 23 Oct 2023 18:15:38 +0000 Subject: [PATCH] feat(client-marketplace-commerce-analytics): The StartSupportDataExport operation has been deprecated as part of the Product Support Connection deprecation. As of December 2022, Product Support Connection is no longer supported. --- .../commands/StartSupportDataExportCommand.ts | 4 +- .../src/endpoint/ruleset.ts | 44 +++++----- .../src/models/models_0.ts | 24 +++--- .../marketplace-commerce-analytics.json | 82 +++++++++++-------- 4 files changed, 87 insertions(+), 67 deletions(-) diff --git a/clients/client-marketplace-commerce-analytics/src/commands/StartSupportDataExportCommand.ts b/clients/client-marketplace-commerce-analytics/src/commands/StartSupportDataExportCommand.ts index cd981887c4b5..81dd41bb805c 100644 --- a/clients/client-marketplace-commerce-analytics/src/commands/StartSupportDataExportCommand.ts +++ b/clients/client-marketplace-commerce-analytics/src/commands/StartSupportDataExportCommand.ts @@ -41,7 +41,9 @@ export interface StartSupportDataExportCommandOutput extends StartSupportDataExp /** * @public - * Given a data set type and a from date, asynchronously publishes the requested customer support data + * @deprecated + * + * This target has been deprecated. Given a data set type and a from date, asynchronously publishes the requested customer support data * to the specified S3 bucket and notifies the specified SNS topic once the data is available. Returns a unique request * identifier that can be used to correlate requests with notifications from the SNS topic. * Data sets will be published in comma-separated values (CSV) format with the file name \{data_set_type\}_YYYY-MM-DD'T'HH-mm-ss'Z'.csv. diff --git a/clients/client-marketplace-commerce-analytics/src/endpoint/ruleset.ts b/clients/client-marketplace-commerce-analytics/src/endpoint/ruleset.ts index e2dbc8a8a0db..dd4607fc2375 100644 --- a/clients/client-marketplace-commerce-analytics/src/endpoint/ruleset.ts +++ b/clients/client-marketplace-commerce-analytics/src/endpoint/ruleset.ts @@ -6,25 +6,27 @@ import { RuleSetObject } from "@smithy/types"; or see "smithy.rules#endpointRuleSet" in codegen/sdk-codegen/aws-models/marketplace-commerce-analytics.json */ -const q="required", -r="fn", -s="argv", -t="ref"; -const a="isSet", -b="tree", -c="error", -d="endpoint", -e="PartitionResult", -f={[q]:false,"type":"String"}, -g={[q]:true,"default":false,"type":"Boolean"}, -h={[t]:"Endpoint"}, -i={[r]:"booleanEquals",[s]:[{[t]:"UseFIPS"},true]}, -j={[r]:"booleanEquals",[s]:[{[t]:"UseDualStack"},true]}, -k={}, -l={[r]:"booleanEquals",[s]:[true,{[r]:"getAttr",[s]:[{[t]:e},"supportsFIPS"]}]}, -m={[r]:"booleanEquals",[s]:[true,{[r]:"getAttr",[s]:[{[t]:e},"supportsDualStack"]}]}, -n=[i], -o=[j], -p=[{[t]:"Region"}]; -const _data={version:"1.0",parameters:{Region:f,UseDualStack:g,UseFIPS:g,Endpoint:f},rules:[{conditions:[{[r]:a,[s]:[h]}],type:b,rules:[{conditions:n,error:"Invalid Configuration: FIPS and custom endpoint are not supported",type:c},{conditions:o,error:"Invalid Configuration: Dualstack and custom endpoint are not supported",type:c},{endpoint:{url:h,properties:k,headers:k},type:d}]},{conditions:[{[r]:a,[s]:p}],type:b,rules:[{conditions:[{[r]:"aws.partition",[s]:p,assign:e}],type:b,rules:[{conditions:[i,j],type:b,rules:[{conditions:[l,m],type:b,rules:[{endpoint:{url:"https://marketplacecommerceanalytics-fips.{Region}.{PartitionResult#dualStackDnsSuffix}",properties:k,headers:k},type:d}]},{error:"FIPS and DualStack are enabled, but this partition does not support one or both",type:c}]},{conditions:n,type:b,rules:[{conditions:[l],type:b,rules:[{endpoint:{url:"https://marketplacecommerceanalytics-fips.{Region}.{PartitionResult#dnsSuffix}",properties:k,headers:k},type:d}]},{error:"FIPS is enabled but this partition does not support FIPS",type:c}]},{conditions:o,type:b,rules:[{conditions:[m],type:b,rules:[{endpoint:{url:"https://marketplacecommerceanalytics.{Region}.{PartitionResult#dualStackDnsSuffix}",properties:k,headers:k},type:d}]},{error:"DualStack is enabled but this partition does not support DualStack",type:c}]},{endpoint:{url:"https://marketplacecommerceanalytics.{Region}.{PartitionResult#dnsSuffix}",properties:k,headers:k},type:d}]}]},{error:"Invalid Configuration: Missing Region",type:c}]}; +const s="required", +t="fn", +u="argv", +v="ref"; +const a=true, +b="isSet", +c="booleanEquals", +d="error", +e="endpoint", +f="tree", +g="PartitionResult", +h={[s]:false,"type":"String"}, +i={[s]:true,"default":false,"type":"Boolean"}, +j={[v]:"Endpoint"}, +k={[t]:c,[u]:[{[v]:"UseFIPS"},true]}, +l={[t]:c,[u]:[{[v]:"UseDualStack"},true]}, +m={}, +n={[t]:"getAttr",[u]:[{[v]:g},"supportsFIPS"]}, +o={[t]:c,[u]:[true,{[t]:"getAttr",[u]:[{[v]:g},"supportsDualStack"]}]}, +p=[k], +q=[l], +r=[{[v]:"Region"}]; +const _data={version:"1.0",parameters:{Region:h,UseDualStack:i,UseFIPS:i,Endpoint:h},rules:[{conditions:[{[t]:b,[u]:[j]}],rules:[{conditions:p,error:"Invalid Configuration: FIPS and custom endpoint are not supported",type:d},{conditions:q,error:"Invalid Configuration: Dualstack and custom endpoint are not supported",type:d},{endpoint:{url:j,properties:m,headers:m},type:e}],type:f},{conditions:[{[t]:b,[u]:r}],rules:[{conditions:[{[t]:"aws.partition",[u]:r,assign:g}],rules:[{conditions:[k,l],rules:[{conditions:[{[t]:c,[u]:[a,n]},o],rules:[{endpoint:{url:"https://marketplacecommerceanalytics-fips.{Region}.{PartitionResult#dualStackDnsSuffix}",properties:m,headers:m},type:e}],type:f},{error:"FIPS and DualStack are enabled, but this partition does not support one or both",type:d}],type:f},{conditions:p,rules:[{conditions:[{[t]:c,[u]:[n,a]}],rules:[{endpoint:{url:"https://marketplacecommerceanalytics-fips.{Region}.{PartitionResult#dnsSuffix}",properties:m,headers:m},type:e}],type:f},{error:"FIPS is enabled but this partition does not support FIPS",type:d}],type:f},{conditions:q,rules:[{conditions:[o],rules:[{endpoint:{url:"https://marketplacecommerceanalytics.{Region}.{PartitionResult#dualStackDnsSuffix}",properties:m,headers:m},type:e}],type:f},{error:"DualStack is enabled but this partition does not support DualStack",type:d}],type:f},{endpoint:{url:"https://marketplacecommerceanalytics.{Region}.{PartitionResult#dnsSuffix}",properties:m,headers:m},type:e}],type:f}],type:f},{error:"Invalid Configuration: Missing Region",type:d}]}; export const ruleSet: RuleSetObject = _data; diff --git a/clients/client-marketplace-commerce-analytics/src/models/models_0.ts b/clients/client-marketplace-commerce-analytics/src/models/models_0.ts index a41e60e26dca..2c84898ba995 100644 --- a/clients/client-marketplace-commerce-analytics/src/models/models_0.ts +++ b/clients/client-marketplace-commerce-analytics/src/models/models_0.ts @@ -253,13 +253,15 @@ export type SupportDataSetType = (typeof SupportDataSetType)[keyof typeof Suppor /** * @public - * Container for the parameters to the StartSupportDataExport operation. + * @deprecated + * + * This target has been deprecated. Container for the parameters to the StartSupportDataExport operation. */ export interface StartSupportDataExportRequest { /** * @public *

- * Specifies the data set type to be written to the output csv file. The data set types customer_support_contacts_data and + * This target has been deprecated. Specifies the data set type to be written to the output csv file. The data set types customer_support_contacts_data and * test_customer_support_contacts_data both result in a csv file containing the following fields: Product Id, Product Code, Customer Guid, * Subscription Guid, Subscription Start Date, Organization, AWS Account Id, Given Name, Surname, Telephone Number, Email, Title, * Country Code, ZIP Code, Operation Type, and Operation Time. @@ -275,26 +277,26 @@ export interface StartSupportDataExportRequest { /** * @public - * The start date from which to retrieve the data set in UTC. This parameter only affects the customer_support_contacts_data data set type. + * This target has been deprecated. The start date from which to retrieve the data set in UTC. This parameter only affects the customer_support_contacts_data data set type. */ fromDate: Date | undefined; /** * @public - * The Amazon Resource Name (ARN) of the Role with an attached permissions policy to interact with the provided + * This target has been deprecated. The Amazon Resource Name (ARN) of the Role with an attached permissions policy to interact with the provided * AWS services. */ roleNameArn: string | undefined; /** * @public - * The name (friendly name, not ARN) of the destination S3 bucket. + * This target has been deprecated. The name (friendly name, not ARN) of the destination S3 bucket. */ destinationS3BucketName: string | undefined; /** * @public - * (Optional) The desired S3 prefix for the published data set, similar to a directory path in standard file systems. + * This target has been deprecated. (Optional) The desired S3 prefix for the published data set, similar to a directory path in standard file systems. * For example, if given the bucket name "mybucket" and the prefix "myprefix/mydatasets", the output file * "outputfile" would be published to "s3://mybucket/myprefix/mydatasets/outputfile". * If the prefix directory structure does not exist, it will be created. @@ -304,14 +306,14 @@ export interface StartSupportDataExportRequest { /** * @public - * Amazon Resource Name (ARN) for the SNS Topic that will be notified when the data set has been published or if an + * This target has been deprecated. Amazon Resource Name (ARN) for the SNS Topic that will be notified when the data set has been published or if an * error has occurred. */ snsTopicArn: string | undefined; /** * @public - * (Optional) Key-value pairs which will be returned, unmodified, in the + * This target has been deprecated. (Optional) Key-value pairs which will be returned, unmodified, in the * Amazon SNS notification message and the data set metadata file. */ customerDefinedValues?: Record; @@ -319,12 +321,14 @@ export interface StartSupportDataExportRequest { /** * @public - * Container for the result of the StartSupportDataExport operation. + * @deprecated + * + * This target has been deprecated. Container for the result of the StartSupportDataExport operation. */ export interface StartSupportDataExportResult { /** * @public - * A unique identifier representing a specific request to the StartSupportDataExport operation. This identifier can be + * This target has been deprecated. A unique identifier representing a specific request to the StartSupportDataExport operation. This identifier can be * used to correlate a request with notifications from the SNS topic. */ dataSetRequestId?: string; diff --git a/codegen/sdk-codegen/aws-models/marketplace-commerce-analytics.json b/codegen/sdk-codegen/aws-models/marketplace-commerce-analytics.json index e8d0ddde16d5..f40bd2580fd8 100644 --- a/codegen/sdk-codegen/aws-models/marketplace-commerce-analytics.json +++ b/codegen/sdk-codegen/aws-models/marketplace-commerce-analytics.json @@ -215,7 +215,8 @@ "type": "string", "traits": { "smithy.api#length": { - "min": 1 + "min": 1, + "max": 63 } } }, @@ -384,7 +385,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -427,7 +427,8 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -440,7 +441,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -454,7 +454,6 @@ "assign": "PartitionResult" } ], - "type": "tree", "rules": [ { "conditions": [ @@ -477,7 +476,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -512,7 +510,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [], @@ -523,14 +520,16 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -544,14 +543,12 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ - true, { "fn": "getAttr", "argv": [ @@ -560,11 +557,11 @@ }, "supportsFIPS" ] - } + }, + true ] } ], - "type": "tree", "rules": [ { "conditions": [], @@ -575,14 +572,16 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -596,7 +595,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -616,7 +614,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [], @@ -627,14 +624,16 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [], @@ -645,9 +644,11 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" } - ] + ], + "type": "tree" }, { "conditions": [], @@ -1009,7 +1010,8 @@ "type": "string", "traits": { "smithy.api#length": { - "min": 1 + "min": 1, + "max": 2048 } } }, @@ -1017,7 +1019,8 @@ "type": "string", "traits": { "smithy.api#length": { - "min": 1 + "min": 1, + "max": 256 } } }, @@ -1035,7 +1038,10 @@ } ], "traits": { - "smithy.api#documentation": "Given a data set type and a from date, asynchronously publishes the requested customer support data\n to the specified S3 bucket and notifies the specified SNS topic once the data is available. Returns a unique request\n identifier that can be used to correlate requests with notifications from the SNS topic.\n Data sets will be published in comma-separated values (CSV) format with the file name {data_set_type}_YYYY-MM-DD'T'HH-mm-ss'Z'.csv.\n If a file with the same name already exists (e.g. if the same data set is requested twice), the original file will\n be overwritten by the new file.\n Requires a Role with an attached permissions policy providing Allow permissions for the following actions:\n s3:PutObject, s3:GetBucketLocation, sns:GetTopicAttributes, sns:Publish, iam:GetRolePolicy." + "smithy.api#deprecated": { + "message": "This target has been deprecated. As of December 2022 Product Support Connection is no longer supported." + }, + "smithy.api#documentation": "This target has been deprecated. Given a data set type and a from date, asynchronously publishes the requested customer support data\n to the specified S3 bucket and notifies the specified SNS topic once the data is available. Returns a unique request\n identifier that can be used to correlate requests with notifications from the SNS topic.\n Data sets will be published in comma-separated values (CSV) format with the file name {data_set_type}_YYYY-MM-DD'T'HH-mm-ss'Z'.csv.\n If a file with the same name already exists (e.g. if the same data set is requested twice), the original file will\n be overwritten by the new file.\n Requires a Role with an attached permissions policy providing Allow permissions for the following actions:\n s3:PutObject, s3:GetBucketLocation, sns:GetTopicAttributes, sns:Publish, iam:GetRolePolicy." } }, "com.amazonaws.marketplacecommerceanalytics#StartSupportDataExportRequest": { @@ -1044,53 +1050,56 @@ "dataSetType": { "target": "com.amazonaws.marketplacecommerceanalytics#SupportDataSetType", "traits": { - "smithy.api#documentation": "

\n Specifies the data set type to be written to the output csv file. The data set types customer_support_contacts_data and\n test_customer_support_contacts_data both result in a csv file containing the following fields: Product Id, Product Code, Customer Guid,\n Subscription Guid, Subscription Start Date, Organization, AWS Account Id, Given Name, Surname, Telephone Number, Email, Title,\n Country Code, ZIP Code, Operation Type, and Operation Time.\n

\n

\n

\n

", + "smithy.api#documentation": "

\n This target has been deprecated. Specifies the data set type to be written to the output csv file. The data set types customer_support_contacts_data and\n test_customer_support_contacts_data both result in a csv file containing the following fields: Product Id, Product Code, Customer Guid,\n Subscription Guid, Subscription Start Date, Organization, AWS Account Id, Given Name, Surname, Telephone Number, Email, Title,\n Country Code, ZIP Code, Operation Type, and Operation Time.\n

\n

\n

\n

", "smithy.api#required": {} } }, "fromDate": { "target": "com.amazonaws.marketplacecommerceanalytics#FromDate", "traits": { - "smithy.api#documentation": "The start date from which to retrieve the data set in UTC. This parameter only affects the customer_support_contacts_data data set type.", + "smithy.api#documentation": "This target has been deprecated. The start date from which to retrieve the data set in UTC. This parameter only affects the customer_support_contacts_data data set type.", "smithy.api#required": {} } }, "roleNameArn": { "target": "com.amazonaws.marketplacecommerceanalytics#RoleNameArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Role with an attached permissions policy to interact with the provided\n AWS services.", + "smithy.api#documentation": "This target has been deprecated. The Amazon Resource Name (ARN) of the Role with an attached permissions policy to interact with the provided\n AWS services.", "smithy.api#required": {} } }, "destinationS3BucketName": { "target": "com.amazonaws.marketplacecommerceanalytics#DestinationS3BucketName", "traits": { - "smithy.api#documentation": "The name (friendly name, not ARN) of the destination S3 bucket.", + "smithy.api#documentation": "This target has been deprecated. The name (friendly name, not ARN) of the destination S3 bucket.", "smithy.api#required": {} } }, "destinationS3Prefix": { "target": "com.amazonaws.marketplacecommerceanalytics#DestinationS3Prefix", "traits": { - "smithy.api#documentation": "(Optional) The desired S3 prefix for the published data set, similar to a directory path in standard file systems.\n For example, if given the bucket name \"mybucket\" and the prefix \"myprefix/mydatasets\", the output file\n \"outputfile\" would be published to \"s3://mybucket/myprefix/mydatasets/outputfile\".\n If the prefix directory structure does not exist, it will be created.\n If no prefix is provided, the data set will be published to the S3 bucket root." + "smithy.api#documentation": "This target has been deprecated. (Optional) The desired S3 prefix for the published data set, similar to a directory path in standard file systems.\n For example, if given the bucket name \"mybucket\" and the prefix \"myprefix/mydatasets\", the output file\n \"outputfile\" would be published to \"s3://mybucket/myprefix/mydatasets/outputfile\".\n If the prefix directory structure does not exist, it will be created.\n If no prefix is provided, the data set will be published to the S3 bucket root." } }, "snsTopicArn": { "target": "com.amazonaws.marketplacecommerceanalytics#SnsTopicArn", "traits": { - "smithy.api#documentation": "Amazon Resource Name (ARN) for the SNS Topic that will be notified when the data set has been published or if an\n error has occurred.", + "smithy.api#documentation": "This target has been deprecated. Amazon Resource Name (ARN) for the SNS Topic that will be notified when the data set has been published or if an\n error has occurred.", "smithy.api#required": {} } }, "customerDefinedValues": { "target": "com.amazonaws.marketplacecommerceanalytics#CustomerDefinedValues", "traits": { - "smithy.api#documentation": "(Optional) Key-value pairs which will be returned, unmodified, in the\n Amazon SNS notification message and the data set metadata file." + "smithy.api#documentation": "This target has been deprecated. (Optional) Key-value pairs which will be returned, unmodified, in the\n Amazon SNS notification message and the data set metadata file." } } }, "traits": { - "smithy.api#documentation": "Container for the parameters to the StartSupportDataExport operation.", + "smithy.api#deprecated": { + "message": "This target has been deprecated. As of December 2022 Product Support Connection is no longer supported." + }, + "smithy.api#documentation": "This target has been deprecated. Container for the parameters to the StartSupportDataExport operation.", "smithy.api#input": {} } }, @@ -1100,12 +1109,15 @@ "dataSetRequestId": { "target": "com.amazonaws.marketplacecommerceanalytics#DataSetRequestId", "traits": { - "smithy.api#documentation": "A unique identifier representing a specific request to the StartSupportDataExport operation. This identifier can be\n used to correlate a request with notifications from the SNS topic." + "smithy.api#documentation": "This target has been deprecated. A unique identifier representing a specific request to the StartSupportDataExport operation. This identifier can be\n used to correlate a request with notifications from the SNS topic." } } }, "traits": { - "smithy.api#documentation": "Container for the result of the StartSupportDataExport operation.", + "smithy.api#deprecated": { + "message": "This target has been deprecated. As of December 2022 Product Support Connection is no longer supported." + }, + "smithy.api#documentation": "This target has been deprecated. Container for the result of the StartSupportDataExport operation.", "smithy.api#output": {} } }, @@ -1133,4 +1145,4 @@ } } } -} \ No newline at end of file +}