\n Create Compute Savings Plans, EC2 Instance Savings Plans, or EC2 Reserved Instances commitments that you want to model in a Bill Scenario.\n
", + "smithy.api#documentation": "\n Create Compute Savings Plans, EC2 Instance Savings Plans, or EC2 Reserved Instances commitments that you want to model in a Bill Scenario.\n
\nThe BatchCreateBillScenarioCommitmentModification operation doesn't have its own IAM permission. To authorize this operation for Amazon Web Services principals, \n include the permission bcm-pricing-calculator:CreateBillScenarioCommitmentModification in your policies.
\n Create Amazon Web Services service usage that you want to model in a Bill Scenario.\n
", + "smithy.api#documentation": "\n Create Amazon Web Services service usage that you want to model in a Bill Scenario.\n
\nThe BatchCreateBillScenarioUsageModification operation doesn't have its own IAM permission. To authorize this operation for Amazon Web Services principals, \n include the permission bcm-pricing-calculator:CreateBillScenarioUsageModification in your policies.
\n Create Amazon Web Services service usage that you want to model in a Workload Estimate.\n
", + "smithy.api#documentation": "\n Create Amazon Web Services service usage that you want to model in a Workload Estimate.\n
\nThe BatchCreateWorkloadEstimateUsage operation doesn't have its own IAM permission. To authorize this operation for Amazon Web Services principals, \n include the permission bcm-pricing-calculator:CreateWorkloadEstimateUsage in your policies.
\n Delete commitment that you have created in a Bill Scenario. You can only delete a commitment that you had \n added and cannot model deletion (or removal) of a existing commitment. If you want model deletion of an existing \n commitment, see the negate \n BillScenarioCommitmentModificationAction of \n \n BatchCreateBillScenarioCommitmentModification operation.\n
", + "smithy.api#documentation": "\n Delete commitment that you have created in a Bill Scenario. You can only delete a commitment that you had \n added and cannot model deletion (or removal) of a existing commitment. If you want model deletion of an existing \n commitment, see the negate \n BillScenarioCommitmentModificationAction of \n \n BatchCreateBillScenarioCommitmentModification operation.\n
\nThe BatchDeleteBillScenarioCommitmentModification operation doesn't have its own IAM permission. To authorize this operation for Amazon Web Services principals, \n include the permission bcm-pricing-calculator:DeleteBillScenarioCommitmentModification in your policies.
\n Delete usage that you have created in a Bill Scenario. You can only delete usage that you had added and cannot model \n deletion (or removal) of a existing usage. If you want model removal of an existing usage, see \n \n BatchUpdateBillScenarioUsageModification.\n
", + "smithy.api#documentation": "\n Delete usage that you have created in a Bill Scenario. You can only delete usage that you had added and cannot model \n deletion (or removal) of a existing usage. If you want model removal of an existing usage, see \n \n BatchUpdateBillScenarioUsageModification.\n
\nThe BatchDeleteBillScenarioUsageModification operation doesn't have its own IAM permission. To authorize this operation for Amazon Web Services principals, \n include the permission bcm-pricing-calculator:DeleteBillScenarioUsageModification in your policies.
\n Delete usage that you have created in a Workload estimate. You can only delete usage that you had added and cannot model deletion \n (or removal) of a existing usage. If you want model removal of an existing usage, see \n \n BatchUpdateWorkloadEstimateUsage.\n
", + "smithy.api#documentation": "\n Delete usage that you have created in a Workload estimate. You can only delete usage that you had added and cannot model deletion \n (or removal) of a existing usage. If you want model removal of an existing usage, see \n \n BatchUpdateWorkloadEstimateUsage.\n
\nThe BatchDeleteWorkloadEstimateUsage operation doesn't have its own IAM permission. To authorize this operation for Amazon Web Services principals, \n include the permission bcm-pricing-calculator:DeleteWorkloadEstimateUsage in your policies.
\n Update a newly added or existing commitment. You can update the commitment group based on a commitment ID and a Bill scenario ID.\n
", + "smithy.api#documentation": "\n Update a newly added or existing commitment. You can update the commitment group based on a commitment ID and a Bill scenario ID.\n
\nThe BatchUpdateBillScenarioCommitmentModification operation doesn't have its own IAM permission. To authorize this operation for Amazon Web Services principals, \n include the permission bcm-pricing-calculator:UpdateBillScenarioCommitmentModification in your policies.
\n Update a newly added or existing usage lines. You can update the usage amounts, usage hour, and usage group based on a usage ID and a Bill scenario ID.\n
", + "smithy.api#documentation": "\n Update a newly added or existing usage lines. You can update the usage amounts, usage hour, and usage group based on a usage ID and a Bill scenario ID.\n
\nThe BatchUpdateBillScenarioUsageModification operation doesn't have its own IAM permission. To authorize this operation for Amazon Web Services principals, \n include the permission bcm-pricing-calculator:UpdateBillScenarioUsageModification in your policies.
\n Update a newly added or existing usage lines. You can update the usage amounts and usage group based on a usage ID and a Workload estimate ID.\n
", + "smithy.api#documentation": "\n Update a newly added or existing usage lines. You can update the usage amounts and usage group based on a usage ID and a Workload estimate ID.\n
\nThe BatchUpdateWorkloadEstimateUsage operation doesn't have its own IAM permission. To authorize this operation for Amazon Web Services principals, \n include the permission bcm-pricing-calculator:UpdateWorkloadEstimateUsage in your policies.
\n Filter bill estimates based on their creation date.\n
" + "smithy.api#documentation": "\n Filter bill estimates based on the creation date.\n
" } }, "expiresAtFilter": { "target": "com.amazonaws.bcmpricingcalculator#FilterTimestamp", "traits": { - "smithy.api#documentation": "\n Filter bill estimates based on their expiration date.\n
" + "smithy.api#documentation": "\n Filter bill estimates based on the expiration date.\n
" } }, "nextToken": { @@ -5207,13 +5222,13 @@ "createdAtFilter": { "target": "com.amazonaws.bcmpricingcalculator#FilterTimestamp", "traits": { - "smithy.api#documentation": "\n Filter bill scenarios based on their creation date.\n
" + "smithy.api#documentation": "\n Filter bill scenarios based on the creation date.\n
" } }, "expiresAtFilter": { "target": "com.amazonaws.bcmpricingcalculator#FilterTimestamp", "traits": { - "smithy.api#documentation": "\n Filter bill scenarios based on their expiration date.\n
" + "smithy.api#documentation": "\n Filter bill scenarios based on the expiration date.\n
" } }, "nextToken": { @@ -5587,13 +5602,13 @@ "createdAtFilter": { "target": "com.amazonaws.bcmpricingcalculator#FilterTimestamp", "traits": { - "smithy.api#documentation": "\n Filter workload estimates based on their creation date.\n
" + "smithy.api#documentation": "\n Filter workload estimates based on the creation date.\n
" } }, "expiresAtFilter": { "target": "com.amazonaws.bcmpricingcalculator#FilterTimestamp", "traits": { - "smithy.api#documentation": "\n Filter workload estimates based on their expiration date.\n
" + "smithy.api#documentation": "\n Filter workload estimates based on the expiration date.\n
" } }, "filters": { diff --git a/codegen/sdk/aws-models/ecr-public.json b/codegen/sdk/aws-models/ecr-public.json index 1144dedbd1c..f0277f17028 100644 --- a/codegen/sdk/aws-models/ecr-public.json +++ b/codegen/sdk/aws-models/ecr-public.json @@ -3131,6 +3131,31 @@ } ], "rules": [ + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + "aws", + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + } + ] + } + ], + "endpoint": { + "url": "https://ecr-public.{Region}.api.aws", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, { "conditions": [], "endpoint": { @@ -3176,54 +3201,67 @@ "smithy.rules#endpointTests": { "testCases": [ { - "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://api.ecr-public-fips.us-east-1.api.aws" + "url": "https://api.ecr-public.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": true + "UseFIPS": false, + "UseDualStack": false } }, { - "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://api.ecr-public-fips.us-east-1.amazonaws.com" + "url": "https://ecr-public.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", - "UseFIPS": true, + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api.ecr-public.us-west-2.amazonaws.com" + } + }, + "params": { + "Region": "us-west-2", + "UseFIPS": false, "UseDualStack": false } }, { - "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://api.ecr-public.us-east-1.api.aws" + "url": "https://api.ecr-public-fips.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", - "UseFIPS": false, + "UseFIPS": true, "UseDualStack": true } }, { - "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://api.ecr-public.us-east-1.amazonaws.com" + "url": "https://api.ecr-public-fips.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", - "UseFIPS": false, + "UseFIPS": true, "UseDualStack": false } }, diff --git a/codegen/sdk/aws-models/ecr.json b/codegen/sdk/aws-models/ecr.json index d0ae29a1b61..366c74a7cd3 100644 --- a/codegen/sdk/aws-models/ecr.json +++ b/codegen/sdk/aws-models/ecr.json @@ -378,6 +378,56 @@ } ], "rules": [ + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + "aws", + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + } + ] + } + ], + "endpoint": { + "url": "https://ecr-fips.{Region}.api.aws", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + "aws-us-gov", + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + } + ] + } + ], + "endpoint": { + "url": "https://ecr-fips.{Region}.api.aws", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, { "conditions": [], "endpoint": { @@ -532,6 +582,81 @@ } ], "rules": [ + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + "aws", + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + } + ] + } + ], + "endpoint": { + "url": "https://ecr.{Region}.api.aws", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + "aws-cn", + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + } + ] + } + ], + "endpoint": { + "url": "https://ecr.{Region}.api.amazonwebservices.com.cn", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + "aws-us-gov", + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + } + ] + } + ], + "endpoint": { + "url": "https://ecr.{Region}.api.aws", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, { "conditions": [], "endpoint": { @@ -590,356 +715,902 @@ } }, { - "documentation": "For region ap-east-1 with FIPS disabled and DualStack disabled", + "documentation": "For region af-south-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://api.ecr.ap-east-1.amazonaws.com" + "url": "https://ecr.af-south-1.api.aws" } }, "params": { - "Region": "ap-east-1", + "Region": "af-south-1", "UseFIPS": false, - "UseDualStack": false + "UseDualStack": true } }, { - "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", + "documentation": "For region ap-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://api.ecr.ap-northeast-1.amazonaws.com" + "url": "https://api.ecr.ap-east-1.amazonaws.com" } }, "params": { - "Region": "ap-northeast-1", + "Region": "ap-east-1", "UseFIPS": false, "UseDualStack": false } }, { - "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", + "documentation": "For region ap-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://api.ecr.ap-northeast-2.amazonaws.com" + "url": "https://ecr.ap-east-1.api.aws" } }, "params": { - "Region": "ap-northeast-2", + "Region": "ap-east-1", "UseFIPS": false, - "UseDualStack": false + "UseDualStack": true } }, { - "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack disabled", + "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://api.ecr.ap-northeast-3.amazonaws.com" + "url": "https://api.ecr.ap-northeast-1.amazonaws.com" } }, "params": { - "Region": "ap-northeast-3", + "Region": "ap-northeast-1", "UseFIPS": false, "UseDualStack": false } }, { - "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", + "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://api.ecr.ap-south-1.amazonaws.com" + "url": "https://ecr.ap-northeast-1.api.aws" } }, "params": { - "Region": "ap-south-1", + "Region": "ap-northeast-1", "UseFIPS": false, - "UseDualStack": false + "UseDualStack": true } }, { - "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", + "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://api.ecr.ap-southeast-1.amazonaws.com" + "url": "https://api.ecr.ap-northeast-2.amazonaws.com" } }, "params": { - "Region": "ap-southeast-1", + "Region": "ap-northeast-2", "UseFIPS": false, "UseDualStack": false } }, { - "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", + "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://api.ecr.ap-southeast-2.amazonaws.com" + "url": "https://ecr.ap-northeast-2.api.aws" } }, "params": { - "Region": "ap-southeast-2", + "Region": "ap-northeast-2", "UseFIPS": false, - "UseDualStack": false + "UseDualStack": true } }, { - "documentation": "For region ap-southeast-3 with FIPS disabled and DualStack disabled", + "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://api.ecr.ap-southeast-3.amazonaws.com" + "url": "https://api.ecr.ap-northeast-3.amazonaws.com" } }, "params": { - "Region": "ap-southeast-3", + "Region": "ap-northeast-3", "UseFIPS": false, "UseDualStack": false } }, { - "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", + "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://api.ecr.ca-central-1.amazonaws.com" + "url": "https://ecr.ap-northeast-3.api.aws" } }, "params": { - "Region": "ca-central-1", + "Region": "ap-northeast-3", "UseFIPS": false, - "UseDualStack": false + "UseDualStack": true } }, { - "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", + "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://api.ecr.eu-central-1.amazonaws.com" + "url": "https://api.ecr.ap-south-1.amazonaws.com" } }, "params": { - "Region": "eu-central-1", + "Region": "ap-south-1", "UseFIPS": false, "UseDualStack": false } }, { - "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", + "documentation": "For region ap-south-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://api.ecr.eu-north-1.amazonaws.com" + "url": "https://ecr.ap-south-1.api.aws" } }, "params": { - "Region": "eu-north-1", + "Region": "ap-south-1", "UseFIPS": false, - "UseDualStack": false + "UseDualStack": true } }, { - "documentation": "For region eu-south-1 with FIPS disabled and DualStack disabled", + "documentation": "For region ap-south-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://api.ecr.eu-south-1.amazonaws.com" + "url": "https://api.ecr.ap-south-2.amazonaws.com" } }, "params": { - "Region": "eu-south-1", + "Region": "ap-south-2", "UseFIPS": false, "UseDualStack": false } }, { - "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", + "documentation": "For region ap-south-2 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://api.ecr.eu-west-1.amazonaws.com" + "url": "https://ecr.ap-south-2.api.aws" } }, "params": { - "Region": "eu-west-1", + "Region": "ap-south-2", "UseFIPS": false, - "UseDualStack": false + "UseDualStack": true } }, { - "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", + "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://api.ecr.eu-west-2.amazonaws.com" + "url": "https://api.ecr.ap-southeast-1.amazonaws.com" } }, "params": { - "Region": "eu-west-2", + "Region": "ap-southeast-1", "UseFIPS": false, "UseDualStack": false } }, { - "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", + "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://api.ecr.eu-west-3.amazonaws.com" + "url": "https://ecr.ap-southeast-1.api.aws" } }, "params": { - "Region": "eu-west-3", + "Region": "ap-southeast-1", "UseFIPS": false, - "UseDualStack": false + "UseDualStack": true } }, { - "documentation": "For region me-south-1 with FIPS disabled and DualStack disabled", + "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://api.ecr.me-south-1.amazonaws.com" + "url": "https://api.ecr.ap-southeast-2.amazonaws.com" } }, "params": { - "Region": "me-south-1", + "Region": "ap-southeast-2", "UseFIPS": false, "UseDualStack": false } }, { - "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", + "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://api.ecr.sa-east-1.amazonaws.com" + "url": "https://ecr.ap-southeast-2.api.aws" } }, "params": { - "Region": "sa-east-1", + "Region": "ap-southeast-2", "UseFIPS": false, - "UseDualStack": false + "UseDualStack": true } }, { - "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "documentation": "For region ap-southeast-3 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://api.ecr.us-east-1.amazonaws.com" + "url": "https://api.ecr.ap-southeast-3.amazonaws.com" } }, "params": { - "Region": "us-east-1", + "Region": "ap-southeast-3", "UseFIPS": false, "UseDualStack": false } }, { - "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "documentation": "For region ap-southeast-3 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://ecr-fips.us-east-1.amazonaws.com" + "url": "https://ecr.ap-southeast-3.api.aws" } }, "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": false + "Region": "ap-southeast-3", + "UseFIPS": false, + "UseDualStack": true } }, { - "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", + "documentation": "For region ap-southeast-4 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://api.ecr.us-east-2.amazonaws.com" + "url": "https://api.ecr.ap-southeast-4.amazonaws.com" } }, "params": { - "Region": "us-east-2", + "Region": "ap-southeast-4", "UseFIPS": false, "UseDualStack": false } }, { - "documentation": "For region us-east-2 with FIPS enabled and DualStack disabled", + "documentation": "For region ap-southeast-4 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://ecr-fips.us-east-2.amazonaws.com" + "url": "https://ecr.ap-southeast-4.api.aws" } }, "params": { - "Region": "us-east-2", - "UseFIPS": true, - "UseDualStack": false + "Region": "ap-southeast-4", + "UseFIPS": false, + "UseDualStack": true } }, { - "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", + "documentation": "For region ap-southeast-5 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://api.ecr.us-west-1.amazonaws.com" + "url": "https://api.ecr.ap-southeast-5.amazonaws.com" } }, "params": { - "Region": "us-west-1", + "Region": "ap-southeast-5", "UseFIPS": false, "UseDualStack": false } }, { - "documentation": "For region us-west-1 with FIPS enabled and DualStack disabled", + "documentation": "For region ap-southeast-5 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://ecr-fips.us-west-1.amazonaws.com" + "url": "https://ecr.ap-southeast-5.api.aws" } }, "params": { - "Region": "us-west-1", - "UseFIPS": true, - "UseDualStack": false + "Region": "ap-southeast-5", + "UseFIPS": false, + "UseDualStack": true } }, { - "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", + "documentation": "For region ap-southeast-7 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://api.ecr.us-west-2.amazonaws.com" + "url": "https://api.ecr.ap-southeast-7.amazonaws.com" } }, "params": { - "Region": "us-west-2", + "Region": "ap-southeast-7", "UseFIPS": false, "UseDualStack": false } }, { - "documentation": "For region us-west-2 with FIPS enabled and DualStack disabled", + "documentation": "For region ap-southeast-7 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://ecr-fips.us-west-2.amazonaws.com" + "url": "https://ecr.ap-southeast-7.api.aws" } }, "params": { - "Region": "us-west-2", - "UseFIPS": true, - "UseDualStack": false + "Region": "ap-southeast-7", + "UseFIPS": false, + "UseDualStack": true } }, { - "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://api.ecr-fips.us-east-1.api.aws" + "url": "https://api.ecr.ca-central-1.amazonaws.com" } }, "params": { - "Region": "us-east-1", - "UseFIPS": true, + "Region": "ca-central-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ca-central-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ecr.ca-central-1.api.aws" + } + }, + "params": { + "Region": "ca-central-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region ca-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api.ecr.ca-west-1.amazonaws.com" + } + }, + "params": { + "Region": "ca-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ca-west-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ecr.ca-west-1.api.aws" + } + }, + "params": { + "Region": "ca-west-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api.ecr.eu-central-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-central-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-central-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ecr.eu-central-1.api.aws" + } + }, + "params": { + "Region": "eu-central-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region eu-central-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api.ecr.eu-central-2.amazonaws.com" + } + }, + "params": { + "Region": "eu-central-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-central-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ecr.eu-central-2.api.aws" + } + }, + "params": { + "Region": "eu-central-2", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api.ecr.eu-north-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-north-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ecr.eu-north-1.api.aws" + } + }, + "params": { + "Region": "eu-north-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region eu-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api.ecr.eu-south-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-south-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ecr.eu-south-1.api.aws" + } + }, + "params": { + "Region": "eu-south-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region eu-south-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api.ecr.eu-south-2.amazonaws.com" + } + }, + "params": { + "Region": "eu-south-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-south-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ecr.eu-south-2.api.aws" + } + }, + "params": { + "Region": "eu-south-2", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api.ecr.eu-west-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ecr.eu-west-1.api.aws" + } + }, + "params": { + "Region": "eu-west-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api.ecr.eu-west-2.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ecr.eu-west-2.api.aws" + } + }, + "params": { + "Region": "eu-west-2", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api.ecr.eu-west-3.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-3", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-3 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ecr.eu-west-3.api.aws" + } + }, + "params": { + "Region": "eu-west-3", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region il-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api.ecr.il-central-1.amazonaws.com" + } + }, + "params": { + "Region": "il-central-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region il-central-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ecr.il-central-1.api.aws" + } + }, + "params": { + "Region": "il-central-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region me-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api.ecr.me-central-1.amazonaws.com" + } + }, + "params": { + "Region": "me-central-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region me-central-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ecr.me-central-1.api.aws" + } + }, + "params": { + "Region": "me-central-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region me-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api.ecr.me-south-1.amazonaws.com" + } + }, + "params": { + "Region": "me-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region me-south-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ecr.me-south-1.api.aws" + } + }, + "params": { + "Region": "me-south-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api.ecr.sa-east-1.amazonaws.com" + } + }, + "params": { + "Region": "sa-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region sa-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ecr.sa-east-1.api.aws" + } + }, + "params": { + "Region": "sa-east-1", + "UseFIPS": false, "UseDualStack": true } }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api.ecr.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ecr-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://api.ecr.us-east-1.api.aws" + "url": "https://ecr.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ecr-fips.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api.ecr.us-east-2.amazonaws.com" + } + }, + "params": { + "Region": "us-east-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ecr-fips.us-east-2.amazonaws.com" + } + }, + "params": { + "Region": "us-east-2", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ecr.us-east-2.api.aws" + } + }, + "params": { + "Region": "us-east-2", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ecr-fips.us-east-2.api.aws" + } + }, + "params": { + "Region": "us-east-2", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api.ecr.us-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ecr-fips.us-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-west-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ecr.us-west-1.api.aws" + } + }, + "params": { + "Region": "us-west-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-west-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ecr-fips.us-west-1.api.aws" + } + }, + "params": { + "Region": "us-west-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api.ecr.us-west-2.amazonaws.com" + } + }, + "params": { + "Region": "us-west-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ecr-fips.us-west-2.amazonaws.com" + } + }, + "params": { + "Region": "us-west-2", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ecr.us-west-2.api.aws" + } + }, + "params": { + "Region": "us-west-2", "UseFIPS": false, "UseDualStack": true } }, + { + "documentation": "For region us-west-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ecr-fips.us-west-2.api.aws" + } + }, + "params": { + "Region": "us-west-2", + "UseFIPS": true, + "UseDualStack": true + } + }, { "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", "expect": { @@ -953,6 +1624,19 @@ "UseDualStack": false } }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ecr.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": true + } + }, { "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack disabled", "expect": { @@ -966,6 +1650,19 @@ "UseDualStack": false } }, + { + "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ecr.cn-northwest-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-northwest-1", + "UseFIPS": false, + "UseDualStack": true + } + }, { "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", "expect": { @@ -993,42 +1690,55 @@ } }, { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://api.ecr.cn-north-1.api.amazonwebservices.com.cn" + "url": "https://api.ecr.us-gov-east-1.amazonaws.com" } }, "params": { - "Region": "cn-north-1", + "Region": "us-gov-east-1", "UseFIPS": false, - "UseDualStack": true + "UseDualStack": false } }, { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://api.ecr.us-gov-east-1.amazonaws.com" + "url": "https://ecr-fips.us-gov-east-1.amazonaws.com" } }, "params": { "Region": "us-gov-east-1", - "UseFIPS": false, + "UseFIPS": true, "UseDualStack": false } }, { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://ecr-fips.us-gov-east-1.amazonaws.com" + "url": "https://ecr.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ecr-fips.us-gov-east-1.api.aws" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": true, - "UseDualStack": false + "UseDualStack": true } }, { @@ -1058,28 +1768,28 @@ } }, { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://api.ecr-fips.us-gov-east-1.api.aws" + "url": "https://ecr.us-gov-west-1.api.aws" } }, "params": { - "Region": "us-gov-east-1", - "UseFIPS": true, + "Region": "us-gov-west-1", + "UseFIPS": false, "UseDualStack": true } }, { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://api.ecr.us-gov-east-1.api.aws" + "url": "https://ecr-fips.us-gov-west-1.api.aws" } }, "params": { - "Region": "us-gov-east-1", - "UseFIPS": false, + "Region": "us-gov-west-1", + "UseFIPS": true, "UseDualStack": true } }, diff --git a/codegen/sdk/aws-models/mailmanager.json b/codegen/sdk/aws-models/mailmanager.json index 3a7c9a63fbc..58657e3ad93 100644 --- a/codegen/sdk/aws-models/mailmanager.json +++ b/codegen/sdk/aws-models/mailmanager.json @@ -268,6 +268,164 @@ "target": "com.amazonaws.mailmanager#AddonSubscription" } }, + "com.amazonaws.mailmanager#Address": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 320 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.mailmanager#AddressFilter": { + "type": "structure", + "members": { + "AddressPrefix": { + "target": "com.amazonaws.mailmanager#AddressPrefix", + "traits": { + "smithy.api#documentation": "Filter to limit the results to addresses having the provided prefix.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Filtering options for ListMembersOfAddressList operation.
" + } + }, + "com.amazonaws.mailmanager#AddressList": { + "type": "structure", + "members": { + "AddressListId": { + "target": "com.amazonaws.mailmanager#AddressListId", + "traits": { + "smithy.api#documentation": "The identifier of the address list.
", + "smithy.api#required": {} + } + }, + "AddressListArn": { + "target": "com.amazonaws.mailmanager#AddressListArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the address list.
", + "smithy.api#required": {} + } + }, + "AddressListName": { + "target": "com.amazonaws.mailmanager#AddressListName", + "traits": { + "smithy.api#documentation": "The user-friendly name of the address list.
", + "smithy.api#required": {} + } + }, + "CreatedTimestamp": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp of when the address list was created.
", + "smithy.api#required": {} + } + }, + "LastUpdatedTimestamp": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp of when the address list was last updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "An address list contains a list of emails and domains that are used in MailManager Ingress endpoints and Rules for email management.
" + } + }, + "com.amazonaws.mailmanager#AddressListArn": { + "type": "string", + "traits": { + "aws.api#arnReference": { + "service": "ses", + "resource": "com.amazon.pancetta.addresslist.management#AddressListResource" + } + } + }, + "com.amazonaws.mailmanager#AddressListId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^[a-zA-Z0-9-]+$" + } + }, + "com.amazonaws.mailmanager#AddressListName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^[a-zA-Z0-9_.-]+$" + } + }, + "com.amazonaws.mailmanager#AddressListResource": { + "type": "resource", + "identifiers": { + "AddressListId": { + "target": "com.amazonaws.mailmanager#AddressListId" + } + }, + "properties": { + "AddressListArn": { + "target": "com.amazonaws.mailmanager#AddressListArn" + }, + "AddressListName": { + "target": "com.amazonaws.mailmanager#AddressListName" + }, + "CreatedTimestamp": { + "target": "smithy.api#Timestamp" + }, + "LastUpdatedTimestamp": { + "target": "smithy.api#Timestamp" + }, + "Tags": { + "target": "com.amazonaws.mailmanager#TagList" + } + }, + "create": { + "target": "com.amazonaws.mailmanager#CreateAddressList" + }, + "read": { + "target": "com.amazonaws.mailmanager#GetAddressList" + }, + "delete": { + "target": "com.amazonaws.mailmanager#DeleteAddressList" + }, + "list": { + "target": "com.amazonaws.mailmanager#ListAddressLists" + } + }, + "com.amazonaws.mailmanager#AddressLists": { + "type": "list", + "member": { + "target": "com.amazonaws.mailmanager#AddressList" + } + }, + "com.amazonaws.mailmanager#AddressPageSize": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.mailmanager#AddressPrefix": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 320 + }, + "smithy.api#sensitive": {} + } + }, "com.amazonaws.mailmanager#Analysis": { "type": "structure", "members": { @@ -841,6 +999,164 @@ "smithy.api#output": {} } }, + "com.amazonaws.mailmanager#CreateAddressList": { + "type": "operation", + "input": { + "target": "com.amazonaws.mailmanager#CreateAddressListRequest" + }, + "output": { + "target": "com.amazonaws.mailmanager#CreateAddressListResponse" + }, + "errors": [ + { + "target": "com.amazonaws.mailmanager#AccessDeniedException" + }, + { + "target": "com.amazonaws.mailmanager#ConflictException" + }, + { + "target": "com.amazonaws.mailmanager#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.mailmanager#ThrottlingException" + }, + { + "target": "com.amazonaws.mailmanager#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a new address list.
", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.mailmanager#CreateAddressListImportJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.mailmanager#CreateAddressListImportJobRequest" + }, + "output": { + "target": "com.amazonaws.mailmanager#CreateAddressListImportJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.mailmanager#AccessDeniedException" + }, + { + "target": "com.amazonaws.mailmanager#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.mailmanager#ThrottlingException" + }, + { + "target": "com.amazonaws.mailmanager#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates an import job for an address list.
", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.mailmanager#CreateAddressListImportJobRequest": { + "type": "structure", + "members": { + "ClientToken": { + "target": "com.amazonaws.mailmanager#IdempotencyToken", + "traits": { + "smithy.api#documentation": "A unique token that Amazon SES uses to recognize subsequent retries of the same\n request.
", + "smithy.api#idempotencyToken": {} + } + }, + "AddressListId": { + "target": "com.amazonaws.mailmanager#AddressListId", + "traits": { + "smithy.api#documentation": "The unique identifier of the address list for importing addresses to.
", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.mailmanager#JobName", + "traits": { + "smithy.api#documentation": "A user-friendly name for the import job.
", + "smithy.api#required": {} + } + }, + "ImportDataFormat": { + "target": "com.amazonaws.mailmanager#ImportDataFormat", + "traits": { + "smithy.api#documentation": "The format of the input for an import job.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.mailmanager#CreateAddressListImportJobResponse": { + "type": "structure", + "members": { + "JobId": { + "target": "com.amazonaws.mailmanager#JobId", + "traits": { + "smithy.api#documentation": "The identifier of the created import job.
", + "smithy.api#required": {} + } + }, + "PreSignedUrl": { + "target": "com.amazonaws.mailmanager#PreSignedUrl", + "traits": { + "smithy.api#documentation": "The pre-signed URL target for uploading the input file.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.mailmanager#CreateAddressListRequest": { + "type": "structure", + "members": { + "ClientToken": { + "target": "com.amazonaws.mailmanager#IdempotencyToken", + "traits": { + "smithy.api#documentation": "A unique token that Amazon SES uses to recognize subsequent retries of the same\n request.
", + "smithy.api#idempotencyToken": {} + } + }, + "AddressListName": { + "target": "com.amazonaws.mailmanager#AddressListName", + "traits": { + "smithy.api#documentation": "A user-friendly name for the address list.
", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.mailmanager#TagList", + "traits": { + "smithy.api#documentation": "The tags used to organize, track, or control access for the resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.mailmanager#CreateAddressListResponse": { + "type": "structure", + "members": { + "AddressListId": { + "target": "com.amazonaws.mailmanager#AddressListId", + "traits": { + "smithy.api#documentation": "The identifier of the created address list.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.mailmanager#CreateArchive": { "type": "operation", "input": { @@ -1451,13 +1767,13 @@ "smithy.api#output": {} } }, - "com.amazonaws.mailmanager#DeleteArchive": { + "com.amazonaws.mailmanager#DeleteAddressList": { "type": "operation", "input": { - "target": "com.amazonaws.mailmanager#DeleteArchiveRequest" + "target": "com.amazonaws.mailmanager#DeleteAddressListRequest" }, "output": { - "target": "com.amazonaws.mailmanager#DeleteArchiveResponse" + "target": "com.amazonaws.mailmanager#DeleteAddressListResponse" }, "errors": [ { @@ -1468,41 +1784,87 @@ }, { "target": "com.amazonaws.mailmanager#ThrottlingException" - }, - { - "target": "com.amazonaws.mailmanager#ValidationException" } ], "traits": { - "smithy.api#documentation": "Initiates deletion of an email archive. This changes the archive state to pending\n deletion. In this state, no new emails can be added, and existing archived emails become\n inaccessible (search, export, download). The archive and all of its contents will be\n permanently deleted 30 days after entering the pending deletion state, regardless of the\n configured retention period.
", + "smithy.api#documentation": "Deletes an address list.
", "smithy.api#idempotent": {} } }, - "com.amazonaws.mailmanager#DeleteArchiveRequest": { + "com.amazonaws.mailmanager#DeleteAddressListRequest": { "type": "structure", "members": { - "ArchiveId": { - "target": "com.amazonaws.mailmanager#ArchiveIdString", + "AddressListId": { + "target": "com.amazonaws.mailmanager#AddressListId", "traits": { - "smithy.api#documentation": "The identifier of the archive to delete.
", + "smithy.api#documentation": "The identifier of an existing address list resource to delete.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "The request to initiate deletion of an email archive.
", "smithy.api#input": {} } }, - "com.amazonaws.mailmanager#DeleteArchiveResponse": { + "com.amazonaws.mailmanager#DeleteAddressListResponse": { "type": "structure", "members": {}, "traits": { - "smithy.api#documentation": "The response indicating if the archive deletion was successfully initiated.
\nOn success, returns an HTTP 200 status code. On failure, returns an error\n message.
", "smithy.api#output": {} } }, - "com.amazonaws.mailmanager#DeleteIngressPoint": { + "com.amazonaws.mailmanager#DeleteArchive": { + "type": "operation", + "input": { + "target": "com.amazonaws.mailmanager#DeleteArchiveRequest" + }, + "output": { + "target": "com.amazonaws.mailmanager#DeleteArchiveResponse" + }, + "errors": [ + { + "target": "com.amazonaws.mailmanager#AccessDeniedException" + }, + { + "target": "com.amazonaws.mailmanager#ConflictException" + }, + { + "target": "com.amazonaws.mailmanager#ThrottlingException" + }, + { + "target": "com.amazonaws.mailmanager#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Initiates deletion of an email archive. This changes the archive state to pending\n deletion. In this state, no new emails can be added, and existing archived emails become\n inaccessible (search, export, download). The archive and all of its contents will be\n permanently deleted 30 days after entering the pending deletion state, regardless of the\n configured retention period.
", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.mailmanager#DeleteArchiveRequest": { + "type": "structure", + "members": { + "ArchiveId": { + "target": "com.amazonaws.mailmanager#ArchiveIdString", + "traits": { + "smithy.api#documentation": "The identifier of the archive to delete.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The request to initiate deletion of an email archive.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.mailmanager#DeleteArchiveResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "The response indicating if the archive deletion was successfully initiated.
\nOn success, returns an HTTP 200 status code. On failure, returns an error\n message.
", + "smithy.api#output": {} + } + }, + "com.amazonaws.mailmanager#DeleteIngressPoint": { "type": "operation", "input": { "target": "com.amazonaws.mailmanager#DeleteIngressPointRequest" @@ -1764,6 +2126,62 @@ "smithy.api#documentation": "The action to deliver incoming emails to an Amazon Q Business application for indexing.
" } }, + "com.amazonaws.mailmanager#DeregisterMemberFromAddressList": { + "type": "operation", + "input": { + "target": "com.amazonaws.mailmanager#DeregisterMemberFromAddressListRequest" + }, + "output": { + "target": "com.amazonaws.mailmanager#DeregisterMemberFromAddressListResponse" + }, + "errors": [ + { + "target": "com.amazonaws.mailmanager#AccessDeniedException" + }, + { + "target": "com.amazonaws.mailmanager#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.mailmanager#ThrottlingException" + }, + { + "target": "com.amazonaws.mailmanager#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Removes a member from an address list.
", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.mailmanager#DeregisterMemberFromAddressListRequest": { + "type": "structure", + "members": { + "AddressListId": { + "target": "com.amazonaws.mailmanager#AddressListId", + "traits": { + "smithy.api#documentation": "The unique identifier of the address list to remove the address from.
", + "smithy.api#required": {} + } + }, + "Address": { + "target": "com.amazonaws.mailmanager#Address", + "traits": { + "smithy.api#documentation": "The address to be removed from the address list.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.mailmanager#DeregisterMemberFromAddressListResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.mailmanager#DropAction": { "type": "structure", "members": {}, @@ -2072,6 +2490,220 @@ "smithy.api#output": {} } }, + "com.amazonaws.mailmanager#GetAddressList": { + "type": "operation", + "input": { + "target": "com.amazonaws.mailmanager#GetAddressListRequest" + }, + "output": { + "target": "com.amazonaws.mailmanager#GetAddressListResponse" + }, + "errors": [ + { + "target": "com.amazonaws.mailmanager#AccessDeniedException" + }, + { + "target": "com.amazonaws.mailmanager#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.mailmanager#ThrottlingException" + }, + { + "target": "com.amazonaws.mailmanager#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Fetch attributes of an address list.
", + "smithy.api#readonly": {} + } + }, + "com.amazonaws.mailmanager#GetAddressListImportJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.mailmanager#GetAddressListImportJobRequest" + }, + "output": { + "target": "com.amazonaws.mailmanager#GetAddressListImportJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.mailmanager#AccessDeniedException" + }, + { + "target": "com.amazonaws.mailmanager#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.mailmanager#ThrottlingException" + }, + { + "target": "com.amazonaws.mailmanager#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Fetch attributes of an import job.
", + "smithy.api#readonly": {} + } + }, + "com.amazonaws.mailmanager#GetAddressListImportJobRequest": { + "type": "structure", + "members": { + "JobId": { + "target": "com.amazonaws.mailmanager#JobId", + "traits": { + "smithy.api#documentation": "The identifier of the import job that needs to be retrieved.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.mailmanager#GetAddressListImportJobResponse": { + "type": "structure", + "members": { + "JobId": { + "target": "com.amazonaws.mailmanager#JobId", + "traits": { + "smithy.api#documentation": "The identifier of the import job.
", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.mailmanager#JobName", + "traits": { + "smithy.api#documentation": "A user-friendly name for the import job.
", + "smithy.api#required": {} + } + }, + "Status": { + "target": "com.amazonaws.mailmanager#ImportJobStatus", + "traits": { + "smithy.api#documentation": "The status of the import job.
", + "smithy.api#required": {} + } + }, + "PreSignedUrl": { + "target": "com.amazonaws.mailmanager#PreSignedUrl", + "traits": { + "smithy.api#documentation": "The pre-signed URL target for uploading the input file.
", + "smithy.api#required": {} + } + }, + "ImportedItemsCount": { + "target": "com.amazonaws.mailmanager#JobItemsCount", + "traits": { + "smithy.api#documentation": "The number of input addresses successfully imported into the address list.
" + } + }, + "FailedItemsCount": { + "target": "com.amazonaws.mailmanager#JobItemsCount", + "traits": { + "smithy.api#documentation": "The number of input addresses that failed to be imported into the address list.
" + } + }, + "ImportDataFormat": { + "target": "com.amazonaws.mailmanager#ImportDataFormat", + "traits": { + "smithy.api#documentation": "The format of the input for an import job.
", + "smithy.api#required": {} + } + }, + "AddressListId": { + "target": "com.amazonaws.mailmanager#AddressListId", + "traits": { + "smithy.api#documentation": "The unique identifier of the address list the import job was created for.
", + "smithy.api#required": {} + } + }, + "CreatedTimestamp": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp of when the import job was created.
", + "smithy.api#required": {} + } + }, + "StartTimestamp": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp of when the import job was started.
" + } + }, + "CompletedTimestamp": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp of when the import job was completed.
" + } + }, + "Error": { + "target": "com.amazonaws.mailmanager#ErrorMessage", + "traits": { + "smithy.api#documentation": "The reason for failure of an import job.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.mailmanager#GetAddressListRequest": { + "type": "structure", + "members": { + "AddressListId": { + "target": "com.amazonaws.mailmanager#AddressListId", + "traits": { + "smithy.api#documentation": "The identifier of an existing address list resource to be retrieved.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.mailmanager#GetAddressListResponse": { + "type": "structure", + "members": { + "AddressListId": { + "target": "com.amazonaws.mailmanager#AddressListId", + "traits": { + "smithy.api#documentation": "The identifier of the address list resource.
", + "smithy.api#required": {} + } + }, + "AddressListArn": { + "target": "com.amazonaws.mailmanager#AddressListArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the address list resource.
", + "smithy.api#required": {} + } + }, + "AddressListName": { + "target": "com.amazonaws.mailmanager#AddressListName", + "traits": { + "smithy.api#documentation": "A user-friendly name for the address list resource.
", + "smithy.api#required": {} + } + }, + "CreatedTimestamp": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The date of when then address list was created.
", + "smithy.api#required": {} + } + }, + "LastUpdatedTimestamp": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The date of when the address list was last updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.mailmanager#GetArchive": { "type": "operation", "input": { @@ -2676,17 +3308,88 @@ "smithy.api#output": {} } }, - "com.amazonaws.mailmanager#GetRelay": { + "com.amazonaws.mailmanager#GetMemberOfAddressList": { "type": "operation", "input": { - "target": "com.amazonaws.mailmanager#GetRelayRequest" + "target": "com.amazonaws.mailmanager#GetMemberOfAddressListRequest" }, "output": { - "target": "com.amazonaws.mailmanager#GetRelayResponse" + "target": "com.amazonaws.mailmanager#GetMemberOfAddressListResponse" }, "errors": [ { - "target": "com.amazonaws.mailmanager#ResourceNotFoundException" + "target": "com.amazonaws.mailmanager#AccessDeniedException" + }, + { + "target": "com.amazonaws.mailmanager#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.mailmanager#ThrottlingException" + }, + { + "target": "com.amazonaws.mailmanager#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Fetch attributes of a member in an address list.
", + "smithy.api#readonly": {} + } + }, + "com.amazonaws.mailmanager#GetMemberOfAddressListRequest": { + "type": "structure", + "members": { + "AddressListId": { + "target": "com.amazonaws.mailmanager#AddressListId", + "traits": { + "smithy.api#documentation": "The unique identifier of the address list to retrieve the address from.
", + "smithy.api#required": {} + } + }, + "Address": { + "target": "com.amazonaws.mailmanager#Address", + "traits": { + "smithy.api#documentation": "The address to be retrieved from the address list.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.mailmanager#GetMemberOfAddressListResponse": { + "type": "structure", + "members": { + "Address": { + "target": "com.amazonaws.mailmanager#Address", + "traits": { + "smithy.api#documentation": "The address retrieved from the address list.
", + "smithy.api#required": {} + } + }, + "CreatedTimestamp": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp of when the address was created.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.mailmanager#GetRelay": { + "type": "operation", + "input": { + "target": "com.amazonaws.mailmanager#GetRelayRequest" + }, + "output": { + "target": "com.amazonaws.mailmanager#GetRelayResponse" + }, + "errors": [ + { + "target": "com.amazonaws.mailmanager#ResourceNotFoundException" }, { "target": "com.amazonaws.mailmanager#ValidationException" @@ -3034,6 +3737,190 @@ } } }, + "com.amazonaws.mailmanager#ImportDataFormat": { + "type": "structure", + "members": { + "ImportDataType": { + "target": "com.amazonaws.mailmanager#ImportDataType", + "traits": { + "smithy.api#documentation": "The type of file that would be passed as an input for the address list import job.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The import data format contains the specifications of the input file that would be passed to the address list\n import job.
" + } + }, + "com.amazonaws.mailmanager#ImportDataType": { + "type": "enum", + "members": { + "CSV": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CSV" + } + }, + "JSON": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "JSON" + } + } + } + }, + "com.amazonaws.mailmanager#ImportJob": { + "type": "structure", + "members": { + "JobId": { + "target": "com.amazonaws.mailmanager#JobId", + "traits": { + "smithy.api#documentation": "The identifier of the import job.
", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.mailmanager#JobName", + "traits": { + "smithy.api#documentation": "A user-friendly name for the import job.
", + "smithy.api#required": {} + } + }, + "Status": { + "target": "com.amazonaws.mailmanager#ImportJobStatus", + "traits": { + "smithy.api#documentation": "The status of the import job.
", + "smithy.api#required": {} + } + }, + "PreSignedUrl": { + "target": "com.amazonaws.mailmanager#PreSignedUrl", + "traits": { + "smithy.api#documentation": "The pre-signed URL target for uploading the input file.
", + "smithy.api#required": {} + } + }, + "ImportedItemsCount": { + "target": "com.amazonaws.mailmanager#JobItemsCount", + "traits": { + "smithy.api#documentation": "The number of addresses in the input that were successfully imported into the address list.
" + } + }, + "FailedItemsCount": { + "target": "com.amazonaws.mailmanager#JobItemsCount", + "traits": { + "smithy.api#documentation": "The number of addresses in the input that failed to get imported into address list.
" + } + }, + "ImportDataFormat": { + "target": "com.amazonaws.mailmanager#ImportDataFormat", + "traits": { + "smithy.api#documentation": "The format of the input for the import job.
", + "smithy.api#required": {} + } + }, + "AddressListId": { + "target": "com.amazonaws.mailmanager#AddressListId", + "traits": { + "smithy.api#documentation": "The unique identifier of the address list the import job was created for.
", + "smithy.api#required": {} + } + }, + "CreatedTimestamp": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp of when the import job was created.
", + "smithy.api#required": {} + } + }, + "StartTimestamp": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp of when the import job was started.
" + } + }, + "CompletedTimestamp": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp of when the import job was completed.
" + } + }, + "Error": { + "target": "com.amazonaws.mailmanager#ErrorMessage", + "traits": { + "smithy.api#documentation": "The reason for failure of an import job.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Details about an import job.
" + } + }, + "com.amazonaws.mailmanager#ImportJobStatus": { + "type": "enum", + "members": { + "CREATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATED" + } + }, + "PROCESSING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PROCESSING" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETED" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "STOPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STOPPED" + } + } + } + }, + "com.amazonaws.mailmanager#ImportJobs": { + "type": "list", + "member": { + "target": "com.amazonaws.mailmanager#ImportJob" + } + }, + "com.amazonaws.mailmanager#IngressAddressListArnList": { + "type": "list", + "member": { + "target": "com.amazonaws.mailmanager#AddressListArn" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + }, + "smithy.api#uniqueItems": {} + } + }, + "com.amazonaws.mailmanager#IngressAddressListEmailAttribute": { + "type": "enum", + "members": { + "RECIPIENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RECIPIENT" + } + } + } + }, "com.amazonaws.mailmanager#IngressAnalysis": { "type": "structure", "members": { @@ -3103,6 +3990,12 @@ "traits": { "smithy.api#documentation": "The structure type for a boolean condition stating the Add On ARN and its returned\n value.
" } + }, + "IsInAddressList": { + "target": "com.amazonaws.mailmanager#IngressIsInAddressList", + "traits": { + "smithy.api#documentation": "The structure type for a boolean condition that provides the address lists to evaluate incoming traffic on.
" + } } }, "traits": { @@ -3180,6 +4073,28 @@ "smithy.api#documentation": "The union type representing the allowed types for the left hand side of an IP\n condition.
" } }, + "com.amazonaws.mailmanager#IngressIsInAddressList": { + "type": "structure", + "members": { + "Attribute": { + "target": "com.amazonaws.mailmanager#IngressAddressListEmailAttribute", + "traits": { + "smithy.api#documentation": "The email attribute that needs to be evaluated against the address list.
", + "smithy.api#required": {} + } + }, + "AddressLists": { + "target": "com.amazonaws.mailmanager#IngressAddressListArnList", + "traits": { + "smithy.api#documentation": "The address lists that will be used for evaluation.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The address lists and the address list attribute value that is evaluated in a policy statement's\n conditional expression to either deny or block the incoming email.
" + } + }, "com.amazonaws.mailmanager#IngressPoint": { "type": "structure", "members": { @@ -3615,6 +4530,29 @@ "target": "com.amazonaws.mailmanager#Ipv4Cidr" } }, + "com.amazonaws.mailmanager#JobId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^[a-zA-Z0-9-]+$" + } + }, + "com.amazonaws.mailmanager#JobItemsCount": { + "type": "integer" + }, + "com.amazonaws.mailmanager#JobName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^[a-zA-Z0-9_.-]+$" + } + }, "com.amazonaws.mailmanager#KmsKeyArn": { "type": "string", "traits": { @@ -3759,6 +4697,158 @@ "smithy.api#output": {} } }, + "com.amazonaws.mailmanager#ListAddressListImportJobs": { + "type": "operation", + "input": { + "target": "com.amazonaws.mailmanager#ListAddressListImportJobsRequest" + }, + "output": { + "target": "com.amazonaws.mailmanager#ListAddressListImportJobsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.mailmanager#AccessDeniedException" + }, + { + "target": "com.amazonaws.mailmanager#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.mailmanager#ThrottlingException" + }, + { + "target": "com.amazonaws.mailmanager#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists jobs for an address list.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ImportJobs", + "pageSize": "PageSize" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.mailmanager#ListAddressListImportJobsRequest": { + "type": "structure", + "members": { + "AddressListId": { + "target": "com.amazonaws.mailmanager#AddressListId", + "traits": { + "smithy.api#documentation": "The unique identifier of the address list for listing import jobs.
", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.mailmanager#PaginationToken", + "traits": { + "smithy.api#documentation": "If you received a pagination token from a previous call to this API, you can provide it here to continue paginating through the next page of results.
" + } + }, + "PageSize": { + "target": "com.amazonaws.mailmanager#PageSize", + "traits": { + "smithy.api#documentation": "The maximum number of import jobs that are returned per call. You can use NextToken to retrieve the next page of jobs.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.mailmanager#ListAddressListImportJobsResponse": { + "type": "structure", + "members": { + "ImportJobs": { + "target": "com.amazonaws.mailmanager#ImportJobs", + "traits": { + "smithy.api#documentation": "The list of import jobs.
", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.mailmanager#PaginationToken", + "traits": { + "smithy.api#documentation": "If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.mailmanager#ListAddressLists": { + "type": "operation", + "input": { + "target": "com.amazonaws.mailmanager#ListAddressListsRequest" + }, + "output": { + "target": "com.amazonaws.mailmanager#ListAddressListsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.mailmanager#AccessDeniedException" + }, + { + "target": "com.amazonaws.mailmanager#ThrottlingException" + }, + { + "target": "com.amazonaws.mailmanager#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists address lists for this account.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "AddressLists", + "pageSize": "PageSize" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.mailmanager#ListAddressListsRequest": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.mailmanager#PaginationToken", + "traits": { + "smithy.api#documentation": "If you received a pagination token from a previous call to this API, you can provide it here to continue paginating through the next page of results.
" + } + }, + "PageSize": { + "target": "com.amazonaws.mailmanager#PageSize", + "traits": { + "smithy.api#documentation": "The maximum number of address list resources that are returned per call. You can use\n NextToken to retrieve the next page of address lists.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.mailmanager#ListAddressListsResponse": { + "type": "structure", + "members": { + "AddressLists": { + "target": "com.amazonaws.mailmanager#AddressLists", + "traits": { + "smithy.api#documentation": "The list of address lists.
", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.mailmanager#PaginationToken", + "traits": { + "smithy.api#documentation": "If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.mailmanager#ListArchiveExports": { "type": "operation", "input": { @@ -4091,13 +5181,100 @@ "smithy.api#input": {} } }, - "com.amazonaws.mailmanager#ListIngressPointsResponse": { + "com.amazonaws.mailmanager#ListIngressPointsResponse": { + "type": "structure", + "members": { + "IngressPoints": { + "target": "com.amazonaws.mailmanager#IngressPointsList", + "traits": { + "smithy.api#documentation": "The list of ingress endpoints.
" + } + }, + "NextToken": { + "target": "com.amazonaws.mailmanager#PaginationToken", + "traits": { + "smithy.api#documentation": "If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.mailmanager#ListMembersOfAddressList": { + "type": "operation", + "input": { + "target": "com.amazonaws.mailmanager#ListMembersOfAddressListRequest" + }, + "output": { + "target": "com.amazonaws.mailmanager#ListMembersOfAddressListResponse" + }, + "errors": [ + { + "target": "com.amazonaws.mailmanager#AccessDeniedException" + }, + { + "target": "com.amazonaws.mailmanager#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.mailmanager#ThrottlingException" + }, + { + "target": "com.amazonaws.mailmanager#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists members of an address list.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Addresses", + "pageSize": "PageSize" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.mailmanager#ListMembersOfAddressListRequest": { + "type": "structure", + "members": { + "AddressListId": { + "target": "com.amazonaws.mailmanager#AddressListId", + "traits": { + "smithy.api#documentation": "The unique identifier of the address list to list the addresses from.
", + "smithy.api#required": {} + } + }, + "Filter": { + "target": "com.amazonaws.mailmanager#AddressFilter", + "traits": { + "smithy.api#documentation": "Filter to be used to limit the results.
" + } + }, + "NextToken": { + "target": "com.amazonaws.mailmanager#PaginationToken", + "traits": { + "smithy.api#documentation": "If you received a pagination token from a previous call to this API, you can provide it here to continue paginating through the next page of results.
" + } + }, + "PageSize": { + "target": "com.amazonaws.mailmanager#AddressPageSize", + "traits": { + "smithy.api#documentation": "The maximum number of address list members that are returned per call.\n You can use NextToken to retrieve the next page of members.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.mailmanager#ListMembersOfAddressListResponse": { "type": "structure", "members": { - "IngressPoints": { - "target": "com.amazonaws.mailmanager#IngressPointsList", + "Addresses": { + "target": "com.amazonaws.mailmanager#SavedAddresses", "traits": { - "smithy.api#documentation": "The list of ingress endpoints.
" + "smithy.api#documentation": "The list of addresses.
", + "smithy.api#required": {} } }, "NextToken": { @@ -4422,6 +5599,15 @@ "type": "service", "version": "2023-10-17", "operations": [ + { + "target": "com.amazonaws.mailmanager#CreateAddressListImportJob" + }, + { + "target": "com.amazonaws.mailmanager#DeregisterMemberFromAddressList" + }, + { + "target": "com.amazonaws.mailmanager#GetAddressListImportJob" + }, { "target": "com.amazonaws.mailmanager#GetArchiveExport" }, @@ -4437,21 +5623,39 @@ { "target": "com.amazonaws.mailmanager#GetArchiveSearchResults" }, + { + "target": "com.amazonaws.mailmanager#GetMemberOfAddressList" + }, + { + "target": "com.amazonaws.mailmanager#ListAddressListImportJobs" + }, { "target": "com.amazonaws.mailmanager#ListArchiveExports" }, { "target": "com.amazonaws.mailmanager#ListArchiveSearches" }, + { + "target": "com.amazonaws.mailmanager#ListMembersOfAddressList" + }, { "target": "com.amazonaws.mailmanager#ListTagsForResource" }, + { + "target": "com.amazonaws.mailmanager#RegisterMemberToAddressList" + }, + { + "target": "com.amazonaws.mailmanager#StartAddressListImportJob" + }, { "target": "com.amazonaws.mailmanager#StartArchiveExport" }, { "target": "com.amazonaws.mailmanager#StartArchiveSearch" }, + { + "target": "com.amazonaws.mailmanager#StopAddressListImportJob" + }, { "target": "com.amazonaws.mailmanager#StopArchiveExport" }, @@ -4472,6 +5676,9 @@ { "target": "com.amazonaws.mailmanager#AddonSubscriptionResource" }, + { + "target": "com.amazonaws.mailmanager#AddressListResource" + }, { "target": "com.amazonaws.mailmanager#ArchiveResource" }, @@ -5373,6 +6580,12 @@ "target": "com.amazonaws.mailmanager#PolicyStatement" } }, + "com.amazonaws.mailmanager#PreSignedUrl": { + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } + }, "com.amazonaws.mailmanager#QBusinessApplicationId": { "type": "string", "traits": { @@ -5406,6 +6619,65 @@ "smithy.api#uniqueItems": {} } }, + "com.amazonaws.mailmanager#RegisterMemberToAddressList": { + "type": "operation", + "input": { + "target": "com.amazonaws.mailmanager#RegisterMemberToAddressListRequest" + }, + "output": { + "target": "com.amazonaws.mailmanager#RegisterMemberToAddressListResponse" + }, + "errors": [ + { + "target": "com.amazonaws.mailmanager#AccessDeniedException" + }, + { + "target": "com.amazonaws.mailmanager#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.mailmanager#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.mailmanager#ThrottlingException" + }, + { + "target": "com.amazonaws.mailmanager#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Adds a member to an address list.
", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.mailmanager#RegisterMemberToAddressListRequest": { + "type": "structure", + "members": { + "AddressListId": { + "target": "com.amazonaws.mailmanager#AddressListId", + "traits": { + "smithy.api#documentation": "The unique identifier of the address list where the address should be added.
", + "smithy.api#required": {} + } + }, + "Address": { + "target": "com.amazonaws.mailmanager#Address", + "traits": { + "smithy.api#documentation": "The address to be added to the address list.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.mailmanager#RegisterMemberToAddressListResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.mailmanager#Relay": { "type": "structure", "members": { @@ -5951,6 +7223,60 @@ } } }, + "com.amazonaws.mailmanager#RuleAddressListArnList": { + "type": "list", + "member": { + "target": "com.amazonaws.mailmanager#AddressListArn" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + }, + "smithy.api#uniqueItems": {} + } + }, + "com.amazonaws.mailmanager#RuleAddressListEmailAttribute": { + "type": "enum", + "members": { + "RECIPIENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RECIPIENT" + } + }, + "MAIL_FROM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MAIL_FROM" + } + }, + "SENDER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SENDER" + } + }, + "FROM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FROM" + } + }, + "TO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TO" + } + }, + "CC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CC" + } + } + } + }, "com.amazonaws.mailmanager#RuleBooleanEmailAttribute": { "type": "enum", "members": { @@ -6021,6 +7347,12 @@ "traits": { "smithy.api#documentation": "The boolean type representing the allowed attribute types for an email.
" } + }, + "IsInAddressList": { + "target": "com.amazonaws.mailmanager#RuleIsInAddressList", + "traits": { + "smithy.api#documentation": "The structure representing the address lists and address list attribute that will be used in evaluation of boolean expression.
" + } } }, "traits": { @@ -6250,6 +7582,28 @@ } } }, + "com.amazonaws.mailmanager#RuleIsInAddressList": { + "type": "structure", + "members": { + "Attribute": { + "target": "com.amazonaws.mailmanager#RuleAddressListEmailAttribute", + "traits": { + "smithy.api#documentation": "The email attribute that needs to be evaluated against the address list.
", + "smithy.api#required": {} + } + }, + "AddressLists": { + "target": "com.amazonaws.mailmanager#RuleAddressListArnList", + "traits": { + "smithy.api#documentation": "The address lists that will be used for evaluation.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The structure type for a boolean condition that provides the address lists and address list attribute to evaluate.
" + } + }, "com.amazonaws.mailmanager#RuleName": { "type": "string", "traits": { @@ -6837,6 +8191,34 @@ "com.amazonaws.mailmanager#S3PresignedURL": { "type": "string" }, + "com.amazonaws.mailmanager#SavedAddress": { + "type": "structure", + "members": { + "Address": { + "target": "com.amazonaws.mailmanager#Address", + "traits": { + "smithy.api#documentation": "The email or domain that constitutes the address.
", + "smithy.api#required": {} + } + }, + "CreatedTimestamp": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp of when the address was added to the address list.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "An address that is a member of an address list.
" + } + }, + "com.amazonaws.mailmanager#SavedAddresses": { + "type": "list", + "member": { + "target": "com.amazonaws.mailmanager#SavedAddress" + } + }, "com.amazonaws.mailmanager#SearchId": { "type": "string", "traits": { @@ -7008,6 +8390,61 @@ "smithy.api#sensitive": {} } }, + "com.amazonaws.mailmanager#StartAddressListImportJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.mailmanager#StartAddressListImportJobRequest" + }, + "output": { + "target": "com.amazonaws.mailmanager#StartAddressListImportJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.mailmanager#AccessDeniedException" + }, + { + "target": "com.amazonaws.mailmanager#ConflictException" + }, + { + "target": "com.amazonaws.mailmanager#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.mailmanager#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.mailmanager#ThrottlingException" + }, + { + "target": "com.amazonaws.mailmanager#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Starts an import job for an address list.
", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.mailmanager#StartAddressListImportJobRequest": { + "type": "structure", + "members": { + "JobId": { + "target": "com.amazonaws.mailmanager#JobId", + "traits": { + "smithy.api#documentation": "The identifier of the import job that needs to be started.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.mailmanager#StartAddressListImportJobResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.mailmanager#StartArchiveExport": { "type": "operation", "input": { @@ -7197,6 +8634,58 @@ "smithy.api#output": {} } }, + "com.amazonaws.mailmanager#StopAddressListImportJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.mailmanager#StopAddressListImportJobRequest" + }, + "output": { + "target": "com.amazonaws.mailmanager#StopAddressListImportJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.mailmanager#AccessDeniedException" + }, + { + "target": "com.amazonaws.mailmanager#ConflictException" + }, + { + "target": "com.amazonaws.mailmanager#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.mailmanager#ThrottlingException" + }, + { + "target": "com.amazonaws.mailmanager#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Stops an ongoing import job for an address list.
", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.mailmanager#StopAddressListImportJobRequest": { + "type": "structure", + "members": { + "JobId": { + "target": "com.amazonaws.mailmanager#JobId", + "traits": { + "smithy.api#documentation": "The identifier of the import job that needs to be stopped.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.mailmanager#StopAddressListImportJobResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.mailmanager#StopArchiveExport": { "type": "operation", "input": { @@ -7348,8 +8837,7 @@ "min": 1, "max": 128 }, - "smithy.api#pattern": "^[a-zA-Z0-9/_\\+=\\.:@\\-]+$", - "smithy.api#sensitive": {} + "smithy.api#pattern": "^[a-zA-Z0-9/_\\+=\\.:@\\-]+$" } }, "com.amazonaws.mailmanager#TagKeyList": { @@ -7439,8 +8927,7 @@ "min": 0, "max": 256 }, - "smithy.api#pattern": "^[a-zA-Z0-9/_\\+=\\.:@\\-]*$", - "smithy.api#sensitive": {} + "smithy.api#pattern": "^[a-zA-Z0-9/_\\+=\\.:@\\-]*$" } }, "com.amazonaws.mailmanager#TaggableResourceArn": { diff --git a/codegen/sdk/aws-models/s3.json b/codegen/sdk/aws-models/s3.json index faff31ddabb..7a78ede71ee 100644 --- a/codegen/sdk/aws-models/s3.json +++ b/codegen/sdk/aws-models/s3.json @@ -29784,7 +29784,7 @@ "type": "integer" }, "com.amazonaws.s3#MpuObjectSize": { - "type": "string" + "type": "long" }, "com.amazonaws.s3#MultipartUpload": { "type": "structure", diff --git a/codegen/sdk/aws-models/transcribe-streaming.json b/codegen/sdk/aws-models/transcribe-streaming.json index aaba2505c66..e4956d3259d 100644 --- a/codegen/sdk/aws-models/transcribe-streaming.json +++ b/codegen/sdk/aws-models/transcribe-streaming.json @@ -70,7 +70,7 @@ "AudioChunk": { "target": "com.amazonaws.transcribestreaming#AudioChunk", "traits": { - "smithy.api#documentation": "An audio blob that contains the next part of the audio that you want to transcribe. The\n maximum audio chunk size is 32 KB.
", + "smithy.api#documentation": "\n An audio blob containing the next segment of audio from your application,\n with a maximum duration of 1 second. \n The maximum size in bytes varies based on audio properties.\n
\nFind recommended size in Transcribing streaming best practices.\n
\n\n Size calculation: Duration (s) * Sample Rate (Hz) * Number of Channels * 2 (Bytes per Sample)\n
\n For example, a 1-second chunk of 16 kHz, 2-channel, 16-bit audio would be \n 1 * 16000 * 2 * 2 = 64000 bytes.\n
\n For 8 kHz, 1-channel, 16-bit audio, a 1-second chunk would be \n 1 * 8000 * 1 * 2 = 16000 bytes.\n
Provides the location, using character count, in your transcript where a match is identified. For example, \n the location of an issue or a category match within a segment.
" } }, + "com.amazonaws.transcribestreaming#ClinicalNoteGenerationResult": { + "type": "structure", + "members": { + "ClinicalNoteOutputLocation": { + "target": "com.amazonaws.transcribestreaming#Uri", + "traits": { + "smithy.api#documentation": "Holds the Amazon S3 URI for the output Clinical Note.
" + } + }, + "TranscriptOutputLocation": { + "target": "com.amazonaws.transcribestreaming#Uri", + "traits": { + "smithy.api#documentation": "Holds the Amazon S3 URI for the output Transcript.
" + } + }, + "Status": { + "target": "com.amazonaws.transcribestreaming#ClinicalNoteGenerationStatus", + "traits": { + "smithy.api#documentation": "The status of the clinical note generation.
\nPossible Values:
\n\n IN_PROGRESS\n
\n FAILED\n
\n COMPLETED\n
\n After audio streaming finishes, and you send a MedicalScribeSessionControlEvent event (with END_OF_SESSION as the Type),\n the status is set to IN_PROGRESS.\n If the status is COMPLETED, the analytics completed successfully, and you can find the\n results at the locations specified in ClinicalNoteOutputLocation and TranscriptOutputLocation.\n If the status is FAILED, FailureReason provides details about the failure.\n
If ClinicalNoteGenerationResult is FAILED, information about why it failed.
The details for clinical note generation,\n including status, and output locations for clinical note and aggregated transcript if the analytics completed,\n or failure reason if the analytics failed.\n
" + } + }, + "com.amazonaws.transcribestreaming#ClinicalNoteGenerationSettings": { + "type": "structure", + "members": { + "OutputBucketName": { + "target": "com.amazonaws.transcribestreaming#BucketName", + "traits": { + "smithy.api#documentation": "The name of the Amazon S3 bucket where you want the output of Amazon Web Services HealthScribe post-stream analytics stored. Don't include the S3:// prefix of the specified bucket.
HealthScribe outputs transcript and clinical note files under the prefix:\n S3://$output-bucket-name/healthscribe-streaming/session-id/post-stream-analytics/clinical-notes\n
The role ResourceAccessRoleArn specified in the MedicalScribeConfigurationEvent must have\n permission to use the specified location. You can change Amazon S3 permissions using the \n Amazon Web Services Management Console\n . See also Permissions Required for IAM User Roles .
The output configuration for aggregated transcript and clinical note generation.
" + } + }, + "com.amazonaws.transcribestreaming#ClinicalNoteGenerationStatus": { + "type": "enum", + "members": { + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN_PROGRESS" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETED" + } + } + } + }, "com.amazonaws.transcribestreaming#Confidence": { "type": "double" }, @@ -481,6 +561,9 @@ } } }, + "com.amazonaws.transcribestreaming#DateTime": { + "type": "timestamp" + }, "com.amazonaws.transcribestreaming#Double": { "type": "double", "traits": { @@ -539,6 +622,77 @@ "target": "com.amazonaws.transcribestreaming#Entity" } }, + "com.amazonaws.transcribestreaming#GetMedicalScribeStream": { + "type": "operation", + "input": { + "target": "com.amazonaws.transcribestreaming#GetMedicalScribeStreamRequest" + }, + "output": { + "target": "com.amazonaws.transcribestreaming#GetMedicalScribeStreamResponse" + }, + "errors": [ + { + "target": "com.amazonaws.transcribestreaming#BadRequestException" + }, + { + "target": "com.amazonaws.transcribestreaming#InternalFailureException" + }, + { + "target": "com.amazonaws.transcribestreaming#LimitExceededException" + }, + { + "target": "com.amazonaws.transcribestreaming#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Provides details about the specified Amazon Web Services HealthScribe streaming session.\n To view the status of the streaming session, check the StreamStatus field in the response. To get the\n details of post-stream analytics, including its status, check the PostStreamAnalyticsResult field in the response.\n
The identifier of the HealthScribe streaming session you want information about.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.transcribestreaming#GetMedicalScribeStreamResponse": { + "type": "structure", + "members": { + "MedicalScribeStreamDetails": { + "target": "com.amazonaws.transcribestreaming#MedicalScribeStreamDetails", + "traits": { + "smithy.api#documentation": "Provides details about a HealthScribe streaming session.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.transcribestreaming#IamRoleArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^arn:(aws|aws-cn|aws-us-gov|aws-iso-{0,1}[a-z]{0,1}):iam::[0-9]{0,63}:role/[A-Za-z0-9:_/+=,@.-]{0,1024}$" + } + }, "com.amazonaws.transcribestreaming#Integer": { "type": "integer" }, @@ -657,6 +811,31 @@ } } }, + "com.amazonaws.transcribestreaming#KMSEncryptionContextMap": { + "type": "map", + "key": { + "target": "com.amazonaws.transcribestreaming#NonEmptyString" + }, + "value": { + "target": "com.amazonaws.transcribestreaming#NonEmptyString" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.transcribestreaming#KMSKeyId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,2048}$" + } + }, "com.amazonaws.transcribestreaming#LanguageCode": { "type": "enum", "members": { @@ -1126,60 +1305,609 @@ "com.amazonaws.transcribestreaming#MedicalEntity": { "type": "structure", "members": { - "StartTime": { - "target": "com.amazonaws.transcribestreaming#Double", + "StartTime": { + "target": "com.amazonaws.transcribestreaming#Double", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The start time, in milliseconds, of the utterance that was identified as PHI.
" + } + }, + "EndTime": { + "target": "com.amazonaws.transcribestreaming#Double", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The end time, in milliseconds, of the utterance that was identified as PHI.
" + } + }, + "Category": { + "target": "com.amazonaws.transcribestreaming#String", + "traits": { + "smithy.api#documentation": "The category of information identified. The only category is PHI.
The word or words identified as PHI.
" + } + }, + "Confidence": { + "target": "com.amazonaws.transcribestreaming#Confidence", + "traits": { + "smithy.api#documentation": "The confidence score associated with the identified PHI entity in your audio.
\nConfidence scores are values between 0 and 1. A larger value indicates a higher\n probability that the identified entity correctly matches the entity spoken in your\n media.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains entities identified as personal health information (PHI) in your\n transcription output, along with various associated attributes. Examples include\n category, confidence score, type, stability score, and start and end times.
" + } + }, + "com.amazonaws.transcribestreaming#MedicalEntityList": { + "type": "list", + "member": { + "target": "com.amazonaws.transcribestreaming#MedicalEntity" + } + }, + "com.amazonaws.transcribestreaming#MedicalItem": { + "type": "structure", + "members": { + "StartTime": { + "target": "com.amazonaws.transcribestreaming#Double", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The start time, in milliseconds, of the transcribed item.
" + } + }, + "EndTime": { + "target": "com.amazonaws.transcribestreaming#Double", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The end time, in milliseconds, of the transcribed item.
" + } + }, + "Type": { + "target": "com.amazonaws.transcribestreaming#ItemType", + "traits": { + "smithy.api#documentation": "The type of item identified. Options are: PRONUNCIATION (spoken \n words) and PUNCTUATION.
The word or punctuation that was transcribed.
" + } + }, + "Confidence": { + "target": "com.amazonaws.transcribestreaming#Confidence", + "traits": { + "smithy.api#documentation": "The confidence score associated with a word or phrase in your transcript.
\nConfidence scores are values between 0 and 1. A larger value indicates a higher\n probability that the identified item correctly matches the item spoken in your\n media.
" + } + }, + "Speaker": { + "target": "com.amazonaws.transcribestreaming#String", + "traits": { + "smithy.api#documentation": "If speaker partitioning is enabled, Speaker labels the speaker of the\n specified item.
A word, phrase, or punctuation mark in your transcription output, along with various \n associated attributes, such as confidence score, type, and start and end times.
" + } + }, + "com.amazonaws.transcribestreaming#MedicalItemList": { + "type": "list", + "member": { + "target": "com.amazonaws.transcribestreaming#MedicalItem" + } + }, + "com.amazonaws.transcribestreaming#MedicalResult": { + "type": "structure", + "members": { + "ResultId": { + "target": "com.amazonaws.transcribestreaming#String", + "traits": { + "smithy.api#documentation": "Provides a unique identifier for the Result.
The start time, in milliseconds, of the Result.
The end time, in milliseconds, of the Result.
Indicates if the segment is complete.
\nIf IsPartial is true, the segment is not complete. If\n IsPartial is false, the segment is complete.
A list of possible alternative transcriptions for the input audio. Each alternative may \n contain one or more of Items, Entities, or\n Transcript.
Indicates the channel identified for the Result.
The Result associated with a \n .
Contains a set of transcription results from one or more audio segments, along with\n additional information per your request parameters. This can include information relating to\n alternative transcriptions, channel identification, partial result stabilization, language \n identification, and other transcription-related data.
" + } + }, + "com.amazonaws.transcribestreaming#MedicalResultList": { + "type": "list", + "member": { + "target": "com.amazonaws.transcribestreaming#MedicalResult" + } + }, + "com.amazonaws.transcribestreaming#MedicalScribeAudioEvent": { + "type": "structure", + "members": { + "AudioChunk": { + "target": "com.amazonaws.transcribestreaming#AudioChunk", + "traits": { + "smithy.api#documentation": "\n An audio blob containing the next segment of audio from your application,\n with a maximum duration of 1 second. \n The maximum size in bytes varies based on audio properties.\n
\nFind recommended size in Transcribing streaming best practices.\n
\n\n Size calculation: Duration (s) * Sample Rate (Hz) * Number of Channels * 2 (Bytes per Sample)\n
\n For example, a 1-second chunk of 16 kHz, 2-channel, 16-bit audio would be \n 1 * 16000 * 2 * 2 = 64000 bytes.\n
\n For 8 kHz, 1-channel, 16-bit audio, a 1-second chunk would be \n 1 * 8000 * 1 * 2 = 16000 bytes.\n
A wrapper for your audio chunks
\nFor more information, see Event stream encoding.\n
" + } + }, + "com.amazonaws.transcribestreaming#MedicalScribeChannelDefinition": { + "type": "structure", + "members": { + "ChannelId": { + "target": "com.amazonaws.transcribestreaming#MedicalScribeChannelId", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "Specify the audio channel you want to define.
", + "smithy.api#required": {} + } + }, + "ParticipantRole": { + "target": "com.amazonaws.transcribestreaming#MedicalScribeParticipantRole", + "traits": { + "smithy.api#documentation": "Specify the participant that you want to flag.\n The allowed options are CLINICIAN and\n PATIENT.\n
Makes it possible to specify which speaker is on which channel.\n For example, if the clinician is the first participant to speak, you would set the ChannelId of the first\n ChannelDefinition\n in the list to 0 (to indicate the first channel) and ParticipantRole to\n CLINICIAN\n (to indicate that it's the clinician speaking).\n Then you would set the ChannelId of the second ChannelDefinition in the list to\n 1\n (to indicate the second channel) and ParticipantRole to PATIENT (to indicate that it's the patient speaking).\n
If you don't specify a channel definition, HealthScribe will diarize the transcription and identify speaker roles for each speaker.
" + } + }, + "com.amazonaws.transcribestreaming#MedicalScribeChannelDefinitions": { + "type": "list", + "member": { + "target": "com.amazonaws.transcribestreaming#MedicalScribeChannelDefinition" + }, + "traits": { + "smithy.api#length": { + "min": 2, + "max": 2 + } + } + }, + "com.amazonaws.transcribestreaming#MedicalScribeChannelId": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0, + "max": 1 + } + } + }, + "com.amazonaws.transcribestreaming#MedicalScribeConfigurationEvent": { + "type": "structure", + "members": { + "VocabularyName": { + "target": "com.amazonaws.transcribestreaming#VocabularyName", + "traits": { + "smithy.api#documentation": "Specify the name of the custom vocabulary you want to use for your streaming session.\n Custom vocabulary names are case-sensitive.\n
" + } + }, + "VocabularyFilterName": { + "target": "com.amazonaws.transcribestreaming#VocabularyFilterName", + "traits": { + "smithy.api#documentation": "Specify the name of the custom vocabulary filter you want to include in your streaming session.\n Custom vocabulary filter names are case-sensitive.\n
\nIf you include VocabularyFilterName in the MedicalScribeConfigurationEvent,\n you must also include VocabularyFilterMethod.\n
Specify how you want your custom vocabulary filter applied to the streaming session.
\nTo replace words with ***, specify mask.\n
To delete words, specify remove.\n
To flag words without changing them, specify tag.\n
The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 output\n bucket you specified, and use your KMS key if supplied. If the role that you specify doesn’t have the\n appropriate permissions, your request fails.
\n\n IAM\n role ARNs have the format\n arn:partition:iam::account:role/role-name-with-path.\n For example: arn:aws:iam::111122223333:role/Admin.\n
For more information, see Amazon Web Services HealthScribe.
", + "smithy.api#required": {} + } + }, + "ChannelDefinitions": { + "target": "com.amazonaws.transcribestreaming#MedicalScribeChannelDefinitions", + "traits": { + "smithy.api#documentation": "Specify which speaker is on which audio channel.
" + } + }, + "EncryptionSettings": { + "target": "com.amazonaws.transcribestreaming#MedicalScribeEncryptionSettings", + "traits": { + "smithy.api#documentation": "Specify the encryption settings for your streaming session.
" + } + }, + "PostStreamAnalyticsSettings": { + "target": "com.amazonaws.transcribestreaming#MedicalScribePostStreamAnalyticsSettings", + "traits": { + "smithy.api#documentation": "Specify settings for post-stream analytics.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Specify details to configure the streaming session, including channel definitions, encryption settings, post-stream analytics\n settings, resource access role ARN and vocabulary settings.\n
\nWhether you are starting a new session or resuming an existing session, \n your first event must be a MedicalScribeConfigurationEvent.\n If you are resuming a session, then this event must have the same configurations that you provided to start the session.\n
A map of plain text, non-secret key:value pairs, known as encryption context pairs, that provide an added layer of\n security for your data. For more information, see KMSencryption context and Asymmetric keys in KMS\n .
" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.transcribestreaming#KMSKeyId", + "traits": { + "smithy.api#documentation": "The ID of the KMS key you want to use for your streaming session. You\n can specify its KMS key ID, key Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". \n To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.
For example:
\nKey ID: 1234abcd-12ab-34cd-56ef-1234567890ab
\nKey ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
\n\n Alias name: alias/ExampleAlias
\n\n Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias \n
\n\n To get the key ID and key ARN for a KMS key, use the ListKeys or DescribeKey KMS API operations. \n To get the alias name and alias ARN, use ListKeys API operation. \n
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains encryption related settings to be used for data encryption with Key Management Service, including KmsEncryptionContext and KmsKeyId.\n The KmsKeyId is required, while KmsEncryptionContext is optional for additional layer of security.\n
\nBy default, Amazon Web Services HealthScribe provides encryption at rest to protect sensitive customer data using Amazon S3-managed keys. HealthScribe uses the KMS key you specify as a second layer of\n encryption.
\n\n Your ResourceAccessRoleArn\n must permission to use your KMS key.\n For more information, see Data Encryption at rest for Amazon Web Services HealthScribe.\n
Specify the lifecycle of your streaming session, such as ending the session.
" + } + }, + "ConfigurationEvent": { + "target": "com.amazonaws.transcribestreaming#MedicalScribeConfigurationEvent", + "traits": { + "smithy.api#documentation": "Specify additional streaming session configurations beyond those provided in your initial start request headers. For example, specify\n channel definitions, encryption settings, and post-stream analytics settings.\n
\nWhether you are starting a new session or resuming an existing session, \n your first event must be a MedicalScribeConfigurationEvent.\n
An encoded stream of events. The stream is encoded as HTTP/2 data frames.
\nAn input stream consists of the following types of events. The first element of the input stream must be the MedicalScribeConfigurationEvent event type.
\n MedicalScribeConfigurationEvent\n
\n MedicalScribeAudioEvent\n
\n MedicalScribeSessionControlEvent\n
Provides the Clinical Note Generation result for post-stream analytics.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details for the result of post-stream analytics.\n
" + } + }, + "com.amazonaws.transcribestreaming#MedicalScribePostStreamAnalyticsSettings": { + "type": "structure", + "members": { + "ClinicalNoteGenerationSettings": { + "target": "com.amazonaws.transcribestreaming#ClinicalNoteGenerationSettings", + "traits": { + "smithy.api#documentation": "Specify settings for the post-stream clinical note generation.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The settings for post-stream analytics.\n
" + } + }, + "com.amazonaws.transcribestreaming#MedicalScribeResultStream": { + "type": "union", + "members": { + "TranscriptEvent": { + "target": "com.amazonaws.transcribestreaming#MedicalScribeTranscriptEvent", + "traits": { + "smithy.api#documentation": "The transcript event that contains real-time transcription results.\n
" + } + }, + "BadRequestException": { + "target": "com.amazonaws.transcribestreaming#BadRequestException" + }, + "LimitExceededException": { + "target": "com.amazonaws.transcribestreaming#LimitExceededException" + }, + "InternalFailureException": { + "target": "com.amazonaws.transcribestreaming#InternalFailureException" + }, + "ConflictException": { + "target": "com.amazonaws.transcribestreaming#ConflictException" + }, + "ServiceUnavailableException": { + "target": "com.amazonaws.transcribestreaming#ServiceUnavailableException" + } + }, + "traits": { + "smithy.api#documentation": "Result stream where you will receive the output events.\n The details are provided in the MedicalScribeTranscriptEvent object.\n
The type of MedicalScribeSessionControlEvent.\n
Possible Values:
\n\n END_OF_SESSION - Indicates the audio streaming is complete. After you\n send an END_OF_SESSION event, Amazon Web Services HealthScribe starts the post-stream analytics.\n The session can't be resumed after this event is sent. After Amazon Web Services HealthScribe processes the event, the real-time StreamStatus is COMPLETED.\n You get the StreamStatus and other stream details with the GetMedicalScribeStream API operation.\n For more information about different streaming statuses, see the StreamStatus description in the MedicalScribeStreamDetails. \n
Specify the lifecycle of your streaming session.
" + } + }, + "com.amazonaws.transcribestreaming#MedicalScribeSessionControlEventType": { + "type": "enum", + "members": { + "END_OF_SESSION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "END_OF_SESSION" + } + } + } + }, + "com.amazonaws.transcribestreaming#MedicalScribeStreamDetails": { + "type": "structure", + "members": { + "SessionId": { + "target": "com.amazonaws.transcribestreaming#SessionId", + "traits": { + "smithy.api#documentation": "The identifier of the HealthScribe streaming session.
" + } + }, + "StreamCreatedAt": { + "target": "com.amazonaws.transcribestreaming#DateTime", + "traits": { + "smithy.api#documentation": "The date and time when the HealthScribe streaming session was created.
" + } + }, + "StreamEndedAt": { + "target": "com.amazonaws.transcribestreaming#DateTime", + "traits": { + "smithy.api#documentation": "The date and time when the HealthScribe streaming session was ended.
" + } + }, + "LanguageCode": { + "target": "com.amazonaws.transcribestreaming#MedicalScribeLanguageCode", + "traits": { + "smithy.api#documentation": "The Language Code of the HealthScribe streaming session.
" + } + }, + "MediaSampleRateHertz": { + "target": "com.amazonaws.transcribestreaming#MedicalScribeMediaSampleRateHertz", + "traits": { + "smithy.api#documentation": "The sample rate (in hertz) of the HealthScribe streaming session.
" + } + }, + "MediaEncoding": { + "target": "com.amazonaws.transcribestreaming#MedicalScribeMediaEncoding", + "traits": { + "smithy.api#documentation": "The Media Encoding of the HealthScribe streaming session.
" + } + }, + "VocabularyName": { + "target": "com.amazonaws.transcribestreaming#VocabularyName", + "traits": { + "smithy.api#documentation": "The vocabulary name of the HealthScribe streaming session.
" + } + }, + "VocabularyFilterName": { + "target": "com.amazonaws.transcribestreaming#VocabularyFilterName", + "traits": { + "smithy.api#documentation": "The name of the vocabulary filter used for the HealthScribe streaming session .
" + } + }, + "VocabularyFilterMethod": { + "target": "com.amazonaws.transcribestreaming#MedicalScribeVocabularyFilterMethod", + "traits": { + "smithy.api#documentation": "The method of the vocabulary filter for the HealthScribe streaming session.
" + } + }, + "ResourceAccessRoleArn": { + "target": "com.amazonaws.transcribestreaming#IamRoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the role used in the HealthScribe streaming session.
" + } + }, + "ChannelDefinitions": { + "target": "com.amazonaws.transcribestreaming#MedicalScribeChannelDefinitions", + "traits": { + "smithy.api#documentation": "The Channel Definitions of the HealthScribe streaming session.
" + } + }, + "EncryptionSettings": { + "target": "com.amazonaws.transcribestreaming#MedicalScribeEncryptionSettings", + "traits": { + "smithy.api#documentation": "The Encryption Settings of the HealthScribe streaming session.
" + } + }, + "StreamStatus": { + "target": "com.amazonaws.transcribestreaming#MedicalScribeStreamStatus", + "traits": { + "smithy.api#documentation": "The streaming status of the HealthScribe streaming session.
\nPossible Values:
\n\n IN_PROGRESS\n
\n PAUSED\n
\n FAILED\n
\n COMPLETED\n
This status is specific to real-time streaming.\n A COMPLETED status doesn't mean that the post-stream analytics is complete.\n To get status of an analytics result, check the Status field for the analytics result within the\n MedicalScribePostStreamAnalyticsResult. For example, you can view the status of the \n ClinicalNoteGenerationResult.\n
The post-stream analytics settings of the HealthScribe streaming session.
" + } + }, + "PostStreamAnalyticsResult": { + "target": "com.amazonaws.transcribestreaming#MedicalScribePostStreamAnalyticsResult", + "traits": { + "smithy.api#documentation": "The result of post-stream analytics for the HealthScribe streaming session.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about a Amazon Web Services HealthScribe streaming session.
" + } + }, + "com.amazonaws.transcribestreaming#MedicalScribeStreamStatus": { + "type": "enum", + "members": { + "IN_PROGRESS": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The start time, in milliseconds, of the utterance that was identified as PHI.
" + "smithy.api#enumValue": "IN_PROGRESS" } }, - "EndTime": { - "target": "com.amazonaws.transcribestreaming#Double", + "PAUSED": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The end time, in milliseconds, of the utterance that was identified as PHI.
" + "smithy.api#enumValue": "PAUSED" } }, - "Category": { - "target": "com.amazonaws.transcribestreaming#String", + "FAILED": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The category of information identified. The only category is PHI.
The word or words identified as PHI.
" + "smithy.api#enumValue": "COMPLETED" } - }, - "Confidence": { - "target": "com.amazonaws.transcribestreaming#Confidence", + } + } + }, + "com.amazonaws.transcribestreaming#MedicalScribeTranscriptEvent": { + "type": "structure", + "members": { + "TranscriptSegment": { + "target": "com.amazonaws.transcribestreaming#MedicalScribeTranscriptSegment", "traits": { - "smithy.api#documentation": "The confidence score associated with the identified PHI entity in your audio.
\nConfidence scores are values between 0 and 1. A larger value indicates a higher\n probability that the identified entity correctly matches the entity spoken in your\n media.
" + "smithy.api#documentation": "The TranscriptSegment associated with a MedicalScribeTranscriptEvent.\n
Contains entities identified as personal health information (PHI) in your\n transcription output, along with various associated attributes. Examples include\n category, confidence score, type, stability score, and start and end times.
" - } - }, - "com.amazonaws.transcribestreaming#MedicalEntityList": { - "type": "list", - "member": { - "target": "com.amazonaws.transcribestreaming#MedicalEntity" + "smithy.api#documentation": "The event associated with MedicalScribeResultStream.\n
Contains MedicalScribeTranscriptSegment, which contains segment related information.\n
The start time, in milliseconds, of the transcribed item.
" } }, - "EndTime": { + "EndAudioTime": { "target": "com.amazonaws.transcribestreaming#Double", "traits": { "smithy.api#default": 0, @@ -1187,91 +1915,131 @@ } }, "Type": { - "target": "com.amazonaws.transcribestreaming#ItemType", + "target": "com.amazonaws.transcribestreaming#MedicalScribeTranscriptItemType", "traits": { - "smithy.api#documentation": "The type of item identified. Options are: PRONUNCIATION (spoken \n words) and PUNCTUATION.
The word or punctuation that was transcribed.
" + "smithy.api#documentation": "The type of item identified. Options are: PRONUNCIATION (spoken words)\n and PUNCTUATION.\n
The confidence score associated with a word or phrase in your transcript.
\nConfidence scores are values between 0 and 1. A larger value indicates a higher\n probability that the identified item correctly matches the item spoken in your\n media.
" + "smithy.api#documentation": "The confidence score associated with a word or phrase in your transcript.
\nConfidence scores are values between 0 and 1. A larger value indicates a higher\n probability that the identified item correctly matches the item spoken in your media.\n
" } }, - "Speaker": { + "Content": { "target": "com.amazonaws.transcribestreaming#String", "traits": { - "smithy.api#documentation": "If speaker partitioning is enabled, Speaker labels the speaker of the\n specified item.
The word, phrase or punctuation mark that was transcribed.
" + } + }, + "VocabularyFilterMatch": { + "target": "com.amazonaws.transcribestreaming#NullableBoolean", + "traits": { + "smithy.api#documentation": "Indicates whether the specified item matches a word in the vocabulary filter included in\n your configuration event. If true, there is a vocabulary filter match.\n
A word, phrase, or punctuation mark in your transcription output, along with various \n associated attributes, such as confidence score, type, and start and end times.
" + "smithy.api#documentation": "A word, phrase, or punctuation mark in your transcription output, along with various associated\n attributes, such as confidence score, type, and start and end times.\n
" } }, - "com.amazonaws.transcribestreaming#MedicalItemList": { + "com.amazonaws.transcribestreaming#MedicalScribeTranscriptItemList": { "type": "list", "member": { - "target": "com.amazonaws.transcribestreaming#MedicalItem" + "target": "com.amazonaws.transcribestreaming#MedicalScribeTranscriptItem" } }, - "com.amazonaws.transcribestreaming#MedicalResult": { + "com.amazonaws.transcribestreaming#MedicalScribeTranscriptItemType": { + "type": "enum", + "members": { + "PRONUNCIATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pronunciation" + } + }, + "PUNCTUATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "punctuation" + } + } + } + }, + "com.amazonaws.transcribestreaming#MedicalScribeTranscriptSegment": { "type": "structure", "members": { - "ResultId": { + "SegmentId": { "target": "com.amazonaws.transcribestreaming#String", "traits": { - "smithy.api#documentation": "Provides a unique identifier for the Result.
The identifier of the segment.
" } }, - "StartTime": { + "BeginAudioTime": { "target": "com.amazonaws.transcribestreaming#Double", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "The start time, in milliseconds, of the Result.
The start time, in milliseconds, of the segment.
" } }, - "EndTime": { + "EndAudioTime": { "target": "com.amazonaws.transcribestreaming#Double", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "The end time, in milliseconds, of the Result.
The end time, in milliseconds, of the segment.
" } }, - "IsPartial": { - "target": "com.amazonaws.transcribestreaming#Boolean", + "Content": { + "target": "com.amazonaws.transcribestreaming#String", "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "Indicates if the segment is complete.
\nIf IsPartial is true, the segment is not complete. If\n IsPartial is false, the segment is complete.
Contains transcribed text of the segment.
" } }, - "Alternatives": { - "target": "com.amazonaws.transcribestreaming#MedicalAlternativeList", + "Items": { + "target": "com.amazonaws.transcribestreaming#MedicalScribeTranscriptItemList", "traits": { - "smithy.api#documentation": "A list of possible alternative transcriptions for the input audio. Each alternative may \n contain one or more of Items, Entities, or\n Transcript.
Contains words, phrases, or punctuation marks in your segment.
" + } + }, + "IsPartial": { + "target": "com.amazonaws.transcribestreaming#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Indicates if the segment is complete.
\nIf IsPartial is true, the segment is not complete.\n If IsPartial is false, the segment is complete.\n
Indicates the channel identified for the Result.
Indicates which audio channel is associated with the MedicalScribeTranscriptSegment.\n
If MedicalScribeChannelDefinition is not provided in the MedicalScribeConfigurationEvent,\n then this field will not be included.\n
The Result associated with a \n .
Contains a set of transcription results from one or more audio segments, along with\n additional information per your request parameters. This can include information relating to\n alternative transcriptions, channel identification, partial result stabilization, language \n identification, and other transcription-related data.
" + "smithy.api#documentation": "Contains a set of transcription results, along with additional information of the segment.
" } }, - "com.amazonaws.transcribestreaming#MedicalResultList": { - "type": "list", - "member": { - "target": "com.amazonaws.transcribestreaming#MedicalResult" + "com.amazonaws.transcribestreaming#MedicalScribeVocabularyFilterMethod": { + "type": "enum", + "members": { + "REMOVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "remove" + } + }, + "MASK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "mask" + } + }, + "TAG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "tag" + } + } } }, "com.amazonaws.transcribestreaming#MedicalTranscript": { @@ -1342,6 +2110,19 @@ "smithy.api#pattern": "^[0-9a-zA-Z._-]+$" } }, + "com.amazonaws.transcribestreaming#NonEmptyString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2000 + }, + "smithy.api#pattern": "\\S" + } + }, + "com.amazonaws.transcribestreaming#NullableBoolean": { + "type": "boolean" + }, "com.amazonaws.transcribestreaming#NumberOfChannels": { "type": "integer", "traits": { @@ -1451,6 +2232,19 @@ "com.amazonaws.transcribestreaming#RequestId": { "type": "string" }, + "com.amazonaws.transcribestreaming#ResourceNotFoundException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.transcribestreaming#String" + } + }, + "traits": { + "smithy.api#documentation": "The request references a resource which doesn't exist.
", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, "com.amazonaws.transcribestreaming#Result": { "type": "structure", "members": { @@ -1871,6 +2665,137 @@ "smithy.api#output": {} } }, + "com.amazonaws.transcribestreaming#StartMedicalScribeStream": { + "type": "operation", + "input": { + "target": "com.amazonaws.transcribestreaming#StartMedicalScribeStreamRequest" + }, + "output": { + "target": "com.amazonaws.transcribestreaming#StartMedicalScribeStreamResponse" + }, + "errors": [ + { + "target": "com.amazonaws.transcribestreaming#BadRequestException" + }, + { + "target": "com.amazonaws.transcribestreaming#ConflictException" + }, + { + "target": "com.amazonaws.transcribestreaming#InternalFailureException" + }, + { + "target": "com.amazonaws.transcribestreaming#LimitExceededException" + }, + { + "target": "com.amazonaws.transcribestreaming#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "Starts a bidirectional HTTP/2 stream, where audio is streamed to\n Amazon Web Services HealthScribe\n and the transcription results are streamed to your application.
\nWhen you start a stream, you first specify the stream configuration in a MedicalScribeConfigurationEvent. \n This event includes channel definitions, encryption settings, and post-stream analytics settings, such as the output configuration for aggregated transcript and clinical note generation. These are additional\n streaming session configurations beyond those provided in your initial start request headers. Whether you are starting a new session or resuming an existing session, \n your first event must be a MedicalScribeConfigurationEvent.
\n After you send a MedicalScribeConfigurationEvent, you start AudioEvents and Amazon Web Services HealthScribe \n responds with real-time transcription results. When you are finished, to start processing the results with the post-stream analytics, send a MedicalScribeSessionControlEvent with a Type of \n END_OF_SESSION and Amazon Web Services HealthScribe starts the analytics.\n
You can pause or resume streaming.\n To pause streaming, complete the input stream without sending the\n MedicalScribeSessionControlEvent.\n To resume streaming, call the StartMedicalScribeStream and specify the same SessionId you used to start the stream.\n
The following parameters are required:
\n\n language-code\n
\n media-encoding\n
\n media-sample-rate-hertz\n
For more information on streaming with\n Amazon Web Services HealthScribe,\n see Amazon Web Services HealthScribe.\n
", + "smithy.api#http": { + "method": "POST", + "uri": "/medical-scribe-stream", + "code": 200 + } + } + }, + "com.amazonaws.transcribestreaming#StartMedicalScribeStreamRequest": { + "type": "structure", + "members": { + "SessionId": { + "target": "com.amazonaws.transcribestreaming#SessionId", + "traits": { + "smithy.api#documentation": "Specify an identifier for your streaming session (in UUID format).\n If you don't include a SessionId in your request,\n Amazon Web Services HealthScribe generates an ID and returns it in the response.\n
", + "smithy.api#httpHeader": "x-amzn-transcribe-session-id" + } + }, + "LanguageCode": { + "target": "com.amazonaws.transcribestreaming#MedicalScribeLanguageCode", + "traits": { + "smithy.api#documentation": "Specify the language code for your HealthScribe streaming session.
", + "smithy.api#httpHeader": "x-amzn-transcribe-language-code", + "smithy.api#required": {} + } + }, + "MediaSampleRateHertz": { + "target": "com.amazonaws.transcribestreaming#MedicalScribeMediaSampleRateHertz", + "traits": { + "smithy.api#documentation": "Specify the sample rate of the input audio (in hertz).\n Amazon Web Services HealthScribe supports a range from 16,000 Hz to 48,000 Hz.\n The sample rate you specify must match that of your audio.\n
", + "smithy.api#httpHeader": "x-amzn-transcribe-sample-rate", + "smithy.api#required": {} + } + }, + "MediaEncoding": { + "target": "com.amazonaws.transcribestreaming#MedicalScribeMediaEncoding", + "traits": { + "smithy.api#documentation": "Specify the encoding used for the input audio.
\nSupported formats are:
\nFLAC
\nOPUS-encoded audio in an Ogg container
\nPCM (only signed 16-bit little-endian audio formats, which does not include\n WAV)\n
\nFor more information, see Media\n formats.\n
", + "smithy.api#httpHeader": "x-amzn-transcribe-media-encoding", + "smithy.api#required": {} + } + }, + "InputStream": { + "target": "com.amazonaws.transcribestreaming#MedicalScribeInputStream", + "traits": { + "smithy.api#documentation": "Specify the input stream where you will send events in real time.
\nThe first element of the input stream must be a MedicalScribeConfigurationEvent.\n
The identifier (in UUID format) for your streaming session.
\nIf you already started streaming, this is same ID as the one you specified in your initial StartMedicalScribeStreamRequest.\n
The unique identifier for your streaming request.\n
", + "smithy.api#httpHeader": "x-amzn-request-id" + } + }, + "LanguageCode": { + "target": "com.amazonaws.transcribestreaming#MedicalScribeLanguageCode", + "traits": { + "smithy.api#documentation": "The Language Code that you specified in your request.\n Same as provided in the StartMedicalScribeStreamRequest.\n
The sample rate (in hertz) that you specified in your request.\n Same as provided in the\n StartMedicalScribeStreamRequest\n
The Media Encoding you specified in your request.\n Same as provided in the\n StartMedicalScribeStreamRequest\n
The result stream where you will receive the output events.\n
", + "smithy.api#httpPayload": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.transcribestreaming#StartMedicalStreamTranscription": { "type": "operation", "input": { @@ -2536,9 +3461,15 @@ "type": "service", "version": "2017-10-26", "operations": [ + { + "target": "com.amazonaws.transcribestreaming#GetMedicalScribeStream" + }, { "target": "com.amazonaws.transcribestreaming#StartCallAnalyticsStreamTranscription" }, + { + "target": "com.amazonaws.transcribestreaming#StartMedicalScribeStream" + }, { "target": "com.amazonaws.transcribestreaming#StartMedicalStreamTranscription" }, @@ -2566,7 +3497,7 @@ "h2" ] }, - "smithy.api#documentation": "Amazon Transcribe streaming offers three main types of real-time transcription: \n Standard, Medical, and \n Call Analytics.
\n\n Standard transcriptions are the most common option. Refer\n to for details.
\n\n Medical transcriptions are tailored to medical professionals \n and incorporate medical terms. A common use case for this service is transcribing doctor-patient \n dialogue in real time, so doctors can focus on their patient instead of taking notes. Refer to\n for details.
\n\n Call Analytics transcriptions are designed for use with call\n center audio on two different channels; if you're looking for insight into customer service calls, use this \n option. Refer to for details.
\nAmazon Transcribe streaming offers four main types of real-time transcription:\n Standard, Medical,\n Call Analytics,\n and Health Scribe.
\n\n Standard transcriptions are the most common option. Refer\n to for details.
\n\n Medical transcriptions are tailored to medical professionals \n and incorporate medical terms. A common use case for this service is transcribing doctor-patient \n dialogue in real time, so doctors can focus on their patient instead of taking notes. Refer to\n for details.
\n\n Call Analytics transcriptions are designed for use with call\n center audio on two different channels; if you're looking for insight into customer service calls, use this \n option. Refer to for details.
\n\n HealthScribe transcriptions are designed to\n automatically create clinical notes from patient-clinician conversations using generative AI.\n Refer to [here] for details.
\n