The VPC subnets where the compute resources are launched. These subnets must be within the same VPC. Fargate\n compute resources can contain up to 16 subnets. For more information, see VPCs and subnets in the Amazon VPC User\n Guide.
", + "smithy.api#documentation": "The VPC subnets where the compute resources are launched. These subnets must be within the same VPC. Fargate\n compute resources can contain up to 16 subnets. For more information, see VPCs and subnets in the Amazon VPC User\n Guide.
\nBatch on Amazon EC2 and Batch on Amazon EKS support Local Zones. For more information, see\n Local Zones in the Amazon EC2 User Guide for Linux Instances, Amazon EKS and Amazon Web Services Local\n Zones in the Amazon EKS User Guide and \n Amazon ECS clusters in Local Zones, Wavelength Zones, and Amazon Web Services Outposts in the\n Amazon ECS Developer Guide.
\nBatch on Fargate doesn't currently support Local Zones.
\nThe maximum percentage that a Spot Instance price can be when compared with the On-Demand price for that\n instance type before instances are launched. For example, if your maximum percentage is 20%, then the Spot price must\n be less than 20% of the current On-Demand price for that Amazon EC2 instance. You always pay the lowest (market) price and\n never more than your maximum percentage. If you leave this field empty, the default value is 100% of the On-Demand\n price.
\nThis parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
\nThe maximum percentage that a Spot Instance price can be when compared with the On-Demand price for that\n instance type before instances are launched. For example, if your maximum percentage is 20%, then the Spot price must\n be less than 20% of the current On-Demand price for that Amazon EC2 instance. You always pay the lowest (market) price and\n never more than your maximum percentage. If you leave this field empty, the default value is 100% of the On-Demand\n price. For most use cases, we recommend\n leaving this field empty.
\nThis parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
\nThe VPC subnets where the compute resources are launched. Fargate compute resources can contain up to 16\n subnets. For Fargate compute resources, providing an empty list will be handled as if this parameter wasn't\n specified and no change is made. For EC2 compute resources, providing an empty list removes the VPC subnets from the\n compute resource. For more information, see VPCs and subnets in the Amazon VPC User Guide.
\nWhen updating a compute environment, changing the VPC subnets requires an infrastructure update of the compute\n environment. For more information, see Updating compute environments in the Batch User Guide.
" + "smithy.api#documentation": "The VPC subnets where the compute resources are launched. Fargate compute resources can\n contain up to 16 subnets. For Fargate compute resources, providing an empty list will be\n handled as if this parameter wasn't specified and no change is made. For EC2 compute resources,\n providing an empty list removes the VPC subnets from the compute resource. For more information,\n see VPCs and\n subnets in the Amazon VPC User Guide.
\nWhen updating a compute environment, changing the VPC subnets requires an infrastructure\n update of the compute environment. For more information, see Updating compute environments in the\n Batch User Guide.
\nBatch on Amazon EC2 and Batch on Amazon EKS support Local Zones. For more information, see\n Local Zones in the Amazon EC2 User Guide for Linux Instances, Amazon EKS and Amazon Web Services Local\n Zones in the Amazon EKS User Guide and \n Amazon ECS clusters in Local Zones, Wavelength Zones, and Amazon Web Services Outposts in the\n Amazon ECS Developer Guide.
\nBatch on Fargate doesn't currently support Local Zones.
\nThe maximum percentage that a Spot Instance price can be when compared with the On-Demand price for that\n instance type before instances are launched. For example, if your maximum percentage is 20%, the Spot price must be\n less than 20% of the current On-Demand price for that Amazon EC2 instance. You always pay the lowest (market) price and\n never more than your maximum percentage.
\nWhen updating a compute environment, changing the bid percentage requires an infrastructure update of the\n compute environment. For more information, see Updating compute environments in the\n Batch User Guide.
\nThis parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
\nThe maximum percentage that a Spot Instance price can be when compared with the On-Demand price for that\n instance type before instances are launched. For example, if your maximum percentage is 20%, the Spot price must be\n less than 20% of the current On-Demand price for that Amazon EC2 instance. You always pay the lowest (market) price and\n never more than your maximum percentage. For\n most use cases, we recommend leaving this field empty.
\nWhen updating a compute environment, changing the bid percentage requires an infrastructure update of the\n compute environment. For more information, see Updating compute environments in the\n Batch User Guide.
\nThis parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
\nA list of job attempts that are associated with this job.
" } + }, + "isCancelled": { + "target": "com.amazonaws.batch#Boolean", + "traits": { + "smithy.api#documentation": "Indicates whether the job is canceled.
" + } + }, + "isTerminated": { + "target": "com.amazonaws.batch#Boolean", + "traits": { + "smithy.api#documentation": "Indicates whether the job is terminated.
" + } } }, "traits": { @@ -5422,7 +5425,7 @@ "attemptDurationSeconds": { "target": "com.amazonaws.batch#Integer", "traits": { - "smithy.api#documentation": "The job timeout time (in seconds) that's measured from the job attempt's startedAt timestamp. After\n this time passes, Batch terminates your jobs if they aren't finished. The minimum value for the timeout is 60\n seconds.
The job timeout time (in seconds) that's measured from the job attempt's startedAt timestamp. After\n this time passes, Batch terminates your jobs if they aren't finished. The minimum value for the timeout is 60\n seconds.
For array jobs, the timeout applies to the child jobs, not to the parent array job.
\nFor multi-node parallel (MNP) jobs, the timeout applies to the whole job, not to the individual nodes.
" } } }, diff --git a/codegen/sdk-codegen/aws-models/ec2.json b/codegen/sdk-codegen/aws-models/ec2.json index 95da1992d91..f82e2353bf3 100644 --- a/codegen/sdk-codegen/aws-models/ec2.json +++ b/codegen/sdk-codegen/aws-models/ec2.json @@ -4087,9 +4087,9 @@ } }, "params": { - "UseDualStack": true, + "UseFIPS": true, "Region": "ap-south-2", - "UseFIPS": true + "UseDualStack": true } }, { @@ -4100,9 +4100,9 @@ } }, "params": { - "UseDualStack": false, + "UseFIPS": true, "Region": "ap-south-2", - "UseFIPS": true + "UseDualStack": false } }, { @@ -4113,9 +4113,9 @@ } }, "params": { - "UseDualStack": true, + "UseFIPS": false, "Region": "ap-south-2", - "UseFIPS": false + "UseDualStack": true } }, { @@ -4126,9 +4126,9 @@ } }, "params": { - "UseDualStack": false, + "UseFIPS": false, "Region": "ap-south-2", - "UseFIPS": false + "UseDualStack": false } }, { @@ -4139,9 +4139,9 @@ } }, "params": { - "UseDualStack": true, + "UseFIPS": true, "Region": "ap-south-1", - "UseFIPS": true + "UseDualStack": true } }, { @@ -4152,9 +4152,9 @@ } }, "params": { - "UseDualStack": false, + "UseFIPS": true, "Region": "ap-south-1", - "UseFIPS": true + "UseDualStack": false } }, { @@ -4165,9 +4165,9 @@ } }, "params": { - "UseDualStack": true, + "UseFIPS": false, "Region": "ap-south-1", - "UseFIPS": false + "UseDualStack": true } }, { @@ -4178,9 +4178,9 @@ } }, "params": { - "UseDualStack": false, + "UseFIPS": false, "Region": "ap-south-1", - "UseFIPS": false + "UseDualStack": false } }, { @@ -4191,9 +4191,9 @@ } }, "params": { - "UseDualStack": true, + "UseFIPS": true, "Region": "eu-south-1", - "UseFIPS": true + "UseDualStack": true } }, { @@ -4204,9 +4204,9 @@ } }, "params": { - "UseDualStack": false, + "UseFIPS": true, "Region": "eu-south-1", - "UseFIPS": true + "UseDualStack": false } }, { @@ -4217,9 +4217,9 @@ } }, "params": { - "UseDualStack": true, + "UseFIPS": false, "Region": "eu-south-1", - "UseFIPS": false + "UseDualStack": true } }, { @@ -4230,9 +4230,9 @@ } }, "params": { - "UseDualStack": false, + "UseFIPS": false, "Region": "eu-south-1", - "UseFIPS": false + "UseDualStack": false } }, { @@ -4243,9 +4243,9 @@ } }, "params": { - "UseDualStack": true, + "UseFIPS": true, "Region": "eu-south-2", - "UseFIPS": true + "UseDualStack": true } }, { @@ -4256,9 +4256,9 @@ } }, "params": { - "UseDualStack": false, + "UseFIPS": true, "Region": "eu-south-2", - "UseFIPS": true + "UseDualStack": false } }, { @@ -4269,9 +4269,9 @@ } }, "params": { - "UseDualStack": true, + "UseFIPS": false, "Region": "eu-south-2", - "UseFIPS": false + "UseDualStack": true } }, { @@ -4282,9 +4282,9 @@ } }, "params": { - "UseDualStack": false, + "UseFIPS": false, "Region": "eu-south-2", - "UseFIPS": false + "UseDualStack": false } }, { @@ -4295,9 +4295,9 @@ } }, "params": { - "UseDualStack": true, + "UseFIPS": true, "Region": "us-gov-east-1", - "UseFIPS": true + "UseDualStack": true } }, { @@ -4308,9 +4308,9 @@ } }, "params": { - "UseDualStack": false, + "UseFIPS": true, "Region": "us-gov-east-1", - "UseFIPS": true + "UseDualStack": false } }, { @@ -4321,9 +4321,9 @@ } }, "params": { - "UseDualStack": true, + "UseFIPS": false, "Region": "us-gov-east-1", - "UseFIPS": false + "UseDualStack": true } }, { @@ -4334,9 +4334,9 @@ } }, "params": { - "UseDualStack": false, + "UseFIPS": false, "Region": "us-gov-east-1", - "UseFIPS": false + "UseDualStack": false } }, { @@ -4347,9 +4347,9 @@ } }, "params": { - "UseDualStack": true, + "UseFIPS": true, "Region": "me-central-1", - "UseFIPS": true + "UseDualStack": true } }, { @@ -4360,9 +4360,9 @@ } }, "params": { - "UseDualStack": false, + "UseFIPS": true, "Region": "me-central-1", - "UseFIPS": true + "UseDualStack": false } }, { @@ -4373,9 +4373,9 @@ } }, "params": { - "UseDualStack": true, + "UseFIPS": false, "Region": "me-central-1", - "UseFIPS": false + "UseDualStack": true } }, { @@ -4386,9 +4386,9 @@ } }, "params": { - "UseDualStack": false, + "UseFIPS": false, "Region": "me-central-1", - "UseFIPS": false + "UseDualStack": false } }, { @@ -4399,9 +4399,9 @@ } }, "params": { - "UseDualStack": true, + "UseFIPS": true, "Region": "ca-central-1", - "UseFIPS": true + "UseDualStack": true } }, { @@ -4412,9 +4412,9 @@ } }, "params": { - "UseDualStack": false, + "UseFIPS": true, "Region": "ca-central-1", - "UseFIPS": true + "UseDualStack": false } }, { @@ -4425,9 +4425,9 @@ } }, "params": { - "UseDualStack": true, + "UseFIPS": false, "Region": "ca-central-1", - "UseFIPS": false + "UseDualStack": true } }, { @@ -4438,9 +4438,9 @@ } }, "params": { - "UseDualStack": false, + "UseFIPS": false, "Region": "ca-central-1", - "UseFIPS": false + "UseDualStack": false } }, { @@ -4451,9 +4451,9 @@ } }, "params": { - "UseDualStack": true, + "UseFIPS": true, "Region": "eu-central-1", - "UseFIPS": true + "UseDualStack": true } }, { @@ -4464,9 +4464,9 @@ } }, "params": { - "UseDualStack": false, + "UseFIPS": true, "Region": "eu-central-1", - "UseFIPS": true + "UseDualStack": false } }, { @@ -4477,9 +4477,9 @@ } }, "params": { - "UseDualStack": true, + "UseFIPS": false, "Region": "eu-central-1", - "UseFIPS": false + "UseDualStack": true } }, { @@ -4490,9 +4490,9 @@ } }, "params": { - "UseDualStack": false, + "UseFIPS": false, "Region": "eu-central-1", - "UseFIPS": false + "UseDualStack": false } }, { @@ -4501,9 +4501,9 @@ "error": "FIPS and DualStack are enabled, but this partition does not support one or both" }, "params": { - "UseDualStack": true, + "UseFIPS": true, "Region": "us-iso-west-1", - "UseFIPS": true + "UseDualStack": true } }, { @@ -4514,9 +4514,9 @@ } }, "params": { - "UseDualStack": false, + "UseFIPS": true, "Region": "us-iso-west-1", - "UseFIPS": true + "UseDualStack": false } }, { @@ -4525,9 +4525,9 @@ "error": "DualStack is enabled but this partition does not support DualStack" }, "params": { - "UseDualStack": true, + "UseFIPS": false, "Region": "us-iso-west-1", - "UseFIPS": false + "UseDualStack": true } }, { @@ -4538,9 +4538,9 @@ } }, "params": { - "UseDualStack": false, + "UseFIPS": false, "Region": "us-iso-west-1", - "UseFIPS": false + "UseDualStack": false } }, { @@ -4551,9 +4551,9 @@ } }, "params": { - "UseDualStack": true, + "UseFIPS": true, "Region": "eu-central-2", - "UseFIPS": true + "UseDualStack": true } }, { @@ -4564,9 +4564,9 @@ } }, "params": { - "UseDualStack": false, + "UseFIPS": true, "Region": "eu-central-2", - "UseFIPS": true + "UseDualStack": false } }, { @@ -4577,9 +4577,9 @@ } }, "params": { - "UseDualStack": true, + "UseFIPS": false, "Region": "eu-central-2", - "UseFIPS": false + "UseDualStack": true } }, { @@ -4590,9 +4590,9 @@ } }, "params": { - "UseDualStack": false, + "UseFIPS": false, "Region": "eu-central-2", - "UseFIPS": false + "UseDualStack": false } }, { @@ -4603,9 +4603,9 @@ } }, "params": { - "UseDualStack": true, + "UseFIPS": true, "Region": "us-west-1", - "UseFIPS": true + "UseDualStack": true } }, { @@ -4616,9 +4616,9 @@ } }, "params": { - "UseDualStack": false, + "UseFIPS": true, "Region": "us-west-1", - "UseFIPS": true + "UseDualStack": false } }, { @@ -4629,9 +4629,9 @@ } }, "params": { - "UseDualStack": true, + "UseFIPS": false, "Region": "us-west-1", - "UseFIPS": false + "UseDualStack": true } }, { @@ -4642,9 +4642,9 @@ } }, "params": { - "UseDualStack": false, + "UseFIPS": false, "Region": "us-west-1", - "UseFIPS": false + "UseDualStack": false } }, { @@ -4655,9 +4655,9 @@ } }, "params": { - "UseDualStack": true, + "UseFIPS": true, "Region": "us-west-2", - "UseFIPS": true + "UseDualStack": true } }, { @@ -4668,9 +4668,9 @@ } }, "params": { - "UseDualStack": false, + "UseFIPS": true, "Region": "us-west-2", - "UseFIPS": true + "UseDualStack": false } }, { @@ -4681,9 +4681,9 @@ } }, "params": { - "UseDualStack": true, + "UseFIPS": false, "Region": "us-west-2", - "UseFIPS": false + "UseDualStack": true } }, { @@ -4694,9 +4694,9 @@ } }, "params": { - "UseDualStack": false, + "UseFIPS": false, "Region": "us-west-2", - "UseFIPS": false + "UseDualStack": false } }, { @@ -4705,9 +4705,9 @@ "error": "FIPS and DualStack are enabled, but this partition does not support one or both" }, "params": { - "UseDualStack": true, + "UseFIPS": true, "Region": "us-isob-west-1", - "UseFIPS": true + "UseDualStack": true } }, { @@ -4718,9 +4718,9 @@ } }, "params": { - "UseDualStack": false, + "UseFIPS": true, "Region": "us-isob-west-1", - "UseFIPS": true + "UseDualStack": false } }, { @@ -4729,9 +4729,9 @@ "error": "DualStack is enabled but this partition does not support DualStack" }, "params": { - "UseDualStack": true, + "UseFIPS": false, "Region": "us-isob-west-1", - "UseFIPS": false + "UseDualStack": true } }, { @@ -4742,9 +4742,9 @@ } }, "params": { - "UseDualStack": false, + "UseFIPS": false, "Region": "us-isob-west-1", - "UseFIPS": false + "UseDualStack": false } }, { @@ -4755,9 +4755,9 @@ } }, "params": { - "UseDualStack": true, + "UseFIPS": true, "Region": "af-south-1", - "UseFIPS": true + "UseDualStack": true } }, { @@ -4768,9 +4768,9 @@ } }, "params": { - "UseDualStack": false, + "UseFIPS": true, "Region": "af-south-1", - "UseFIPS": true + "UseDualStack": false } }, { @@ -4781,9 +4781,9 @@ } }, "params": { - "UseDualStack": true, + "UseFIPS": false, "Region": "af-south-1", - "UseFIPS": false + "UseDualStack": true } }, { @@ -4794,9 +4794,9 @@ } }, "params": { - "UseDualStack": false, + "UseFIPS": false, "Region": "af-south-1", - "UseFIPS": false + "UseDualStack": false } }, { @@ -4807,9 +4807,9 @@ } }, "params": { - "UseDualStack": true, + "UseFIPS": true, "Region": "eu-north-1", - "UseFIPS": true + "UseDualStack": true } }, { @@ -4820,9 +4820,9 @@ } }, "params": { - "UseDualStack": false, + "UseFIPS": true, "Region": "eu-north-1", - "UseFIPS": true + "UseDualStack": false } }, { @@ -4833,9 +4833,9 @@ } }, "params": { - "UseDualStack": true, + "UseFIPS": false, "Region": "eu-north-1", - "UseFIPS": false + "UseDualStack": true } }, { @@ -4846,9 +4846,9 @@ } }, "params": { - "UseDualStack": false, + "UseFIPS": false, "Region": "eu-north-1", - "UseFIPS": false + "UseDualStack": false } }, { @@ -4859,9 +4859,9 @@ } }, "params": { - "UseDualStack": true, + "UseFIPS": true, "Region": "eu-west-3", - "UseFIPS": true + "UseDualStack": true } }, { @@ -4872,9 +4872,9 @@ } }, "params": { - "UseDualStack": false, + "UseFIPS": true, "Region": "eu-west-3", - "UseFIPS": true + "UseDualStack": false } }, { @@ -4885,9 +4885,9 @@ } }, "params": { - "UseDualStack": true, + "UseFIPS": false, "Region": "eu-west-3", - "UseFIPS": false + "UseDualStack": true } }, { @@ -4898,9 +4898,9 @@ } }, "params": { - "UseDualStack": false, + "UseFIPS": false, "Region": "eu-west-3", - "UseFIPS": false + "UseDualStack": false } }, { @@ -4911,9 +4911,9 @@ } }, "params": { - "UseDualStack": true, + "UseFIPS": true, "Region": "eu-west-2", - "UseFIPS": true + "UseDualStack": true } }, { @@ -4924,9 +4924,9 @@ } }, "params": { - "UseDualStack": false, + "UseFIPS": true, "Region": "eu-west-2", - "UseFIPS": true + "UseDualStack": false } }, { @@ -4937,9 +4937,9 @@ } }, "params": { - "UseDualStack": true, + "UseFIPS": false, "Region": "eu-west-2", - "UseFIPS": false + "UseDualStack": true } }, { @@ -4950,9 +4950,9 @@ } }, "params": { - "UseDualStack": false, + "UseFIPS": false, "Region": "eu-west-2", - "UseFIPS": false + "UseDualStack": false } }, { @@ -4963,9 +4963,9 @@ } }, "params": { - "UseDualStack": true, + "UseFIPS": true, "Region": "eu-west-1", - "UseFIPS": true + "UseDualStack": true } }, { @@ -4976,9 +4976,9 @@ } }, "params": { - "UseDualStack": false, + "UseFIPS": true, "Region": "eu-west-1", - "UseFIPS": true + "UseDualStack": false } }, { @@ -4989,9 +4989,9 @@ } }, "params": { - "UseDualStack": true, + "UseFIPS": false, "Region": "eu-west-1", - "UseFIPS": false + "UseDualStack": true } }, { @@ -5002,9 +5002,9 @@ } }, "params": { - "UseDualStack": false, + "UseFIPS": false, "Region": "eu-west-1", - "UseFIPS": false + "UseDualStack": false } }, { @@ -5015,9 +5015,9 @@ } }, "params": { - "UseDualStack": true, + "UseFIPS": true, "Region": "ap-northeast-3", - "UseFIPS": true + "UseDualStack": true } }, { @@ -5028,9 +5028,9 @@ } }, "params": { - "UseDualStack": false, + "UseFIPS": true, "Region": "ap-northeast-3", - "UseFIPS": true + "UseDualStack": false } }, { @@ -5041,9 +5041,9 @@ } }, "params": { - "UseDualStack": true, + "UseFIPS": false, "Region": "ap-northeast-3", - "UseFIPS": false + "UseDualStack": true } }, { @@ -5054,9 +5054,9 @@ } }, "params": { - "UseDualStack": false, + "UseFIPS": false, "Region": "ap-northeast-3", - "UseFIPS": false + "UseDualStack": false } }, { @@ -5067,9 +5067,9 @@ } }, "params": { - "UseDualStack": true, + "UseFIPS": true, "Region": "ap-northeast-2", - "UseFIPS": true + "UseDualStack": true } }, { @@ -5080,9 +5080,9 @@ } }, "params": { - "UseDualStack": false, + "UseFIPS": true, "Region": "ap-northeast-2", - "UseFIPS": true + "UseDualStack": false } }, { @@ -5093,9 +5093,9 @@ } }, "params": { - "UseDualStack": true, + "UseFIPS": false, "Region": "ap-northeast-2", - "UseFIPS": false + "UseDualStack": true } }, { @@ -5106,9 +5106,9 @@ } }, "params": { - "UseDualStack": false, + "UseFIPS": false, "Region": "ap-northeast-2", - "UseFIPS": false + "UseDualStack": false } }, { @@ -5119,9 +5119,9 @@ } }, "params": { - "UseDualStack": true, + "UseFIPS": true, "Region": "ap-northeast-1", - "UseFIPS": true + "UseDualStack": true } }, { @@ -5132,9 +5132,9 @@ } }, "params": { - "UseDualStack": false, + "UseFIPS": true, "Region": "ap-northeast-1", - "UseFIPS": true + "UseDualStack": false } }, { @@ -5145,9 +5145,9 @@ } }, "params": { - "UseDualStack": true, + "UseFIPS": false, "Region": "ap-northeast-1", - "UseFIPS": false + "UseDualStack": true } }, { @@ -5158,9 +5158,9 @@ } }, "params": { - "UseDualStack": false, + "UseFIPS": false, "Region": "ap-northeast-1", - "UseFIPS": false + "UseDualStack": false } }, { @@ -5171,9 +5171,9 @@ } }, "params": { - "UseDualStack": true, + "UseFIPS": true, "Region": "me-south-1", - "UseFIPS": true + "UseDualStack": true } }, { @@ -5184,9 +5184,9 @@ } }, "params": { - "UseDualStack": false, + "UseFIPS": true, "Region": "me-south-1", - "UseFIPS": true + "UseDualStack": false } }, { @@ -5197,9 +5197,9 @@ } }, "params": { - "UseDualStack": true, + "UseFIPS": false, "Region": "me-south-1", - "UseFIPS": false + "UseDualStack": true } }, { @@ -5210,9 +5210,9 @@ } }, "params": { - "UseDualStack": false, + "UseFIPS": false, "Region": "me-south-1", - "UseFIPS": false + "UseDualStack": false } }, { @@ -5223,9 +5223,9 @@ } }, "params": { - "UseDualStack": true, + "UseFIPS": true, "Region": "sa-east-1", - "UseFIPS": true + "UseDualStack": true } }, { @@ -5236,9 +5236,9 @@ } }, "params": { - "UseDualStack": false, + "UseFIPS": true, "Region": "sa-east-1", - "UseFIPS": true + "UseDualStack": false } }, { @@ -5249,9 +5249,9 @@ } }, "params": { - "UseDualStack": true, + "UseFIPS": false, "Region": "sa-east-1", - "UseFIPS": false + "UseDualStack": true } }, { @@ -5262,9 +5262,9 @@ } }, "params": { - "UseDualStack": false, + "UseFIPS": false, "Region": "sa-east-1", - "UseFIPS": false + "UseDualStack": false } }, { @@ -5275,9 +5275,9 @@ } }, "params": { - "UseDualStack": true, + "UseFIPS": true, "Region": "ap-east-1", - "UseFIPS": true + "UseDualStack": true } }, { @@ -5288,9 +5288,9 @@ } }, "params": { - "UseDualStack": false, + "UseFIPS": true, "Region": "ap-east-1", - "UseFIPS": true + "UseDualStack": false } }, { @@ -5301,9 +5301,9 @@ } }, "params": { - "UseDualStack": true, + "UseFIPS": false, "Region": "ap-east-1", - "UseFIPS": false + "UseDualStack": true } }, { @@ -5314,9 +5314,9 @@ } }, "params": { - "UseDualStack": false, + "UseFIPS": false, "Region": "ap-east-1", - "UseFIPS": false + "UseDualStack": false } }, { @@ -5327,9 +5327,9 @@ } }, "params": { - "UseDualStack": true, + "UseFIPS": true, "Region": "cn-north-1", - "UseFIPS": true + "UseDualStack": true } }, { @@ -5340,9 +5340,9 @@ } }, "params": { - "UseDualStack": false, + "UseFIPS": true, "Region": "cn-north-1", - "UseFIPS": true + "UseDualStack": false } }, { @@ -5353,9 +5353,9 @@ } }, "params": { - "UseDualStack": true, + "UseFIPS": false, "Region": "cn-north-1", - "UseFIPS": false + "UseDualStack": true } }, { @@ -5366,9 +5366,9 @@ } }, "params": { - "UseDualStack": false, + "UseFIPS": false, "Region": "cn-north-1", - "UseFIPS": false + "UseDualStack": false } }, { @@ -5379,9 +5379,9 @@ } }, "params": { - "UseDualStack": true, + "UseFIPS": true, "Region": "ca-west-1", - "UseFIPS": true + "UseDualStack": true } }, { @@ -5392,9 +5392,9 @@ } }, "params": { - "UseDualStack": false, + "UseFIPS": true, "Region": "ca-west-1", - "UseFIPS": true + "UseDualStack": false } }, { @@ -5405,9 +5405,9 @@ } }, "params": { - "UseDualStack": true, + "UseFIPS": false, "Region": "ca-west-1", - "UseFIPS": false + "UseDualStack": true } }, { @@ -5418,9 +5418,9 @@ } }, "params": { - "UseDualStack": false, + "UseFIPS": false, "Region": "ca-west-1", - "UseFIPS": false + "UseDualStack": false } }, { @@ -5431,9 +5431,9 @@ } }, "params": { - "UseDualStack": true, + "UseFIPS": true, "Region": "us-gov-west-1", - "UseFIPS": true + "UseDualStack": true } }, { @@ -5444,9 +5444,9 @@ } }, "params": { - "UseDualStack": false, + "UseFIPS": true, "Region": "us-gov-west-1", - "UseFIPS": true + "UseDualStack": false } }, { @@ -5457,9 +5457,9 @@ } }, "params": { - "UseDualStack": true, + "UseFIPS": false, "Region": "us-gov-west-1", - "UseFIPS": false + "UseDualStack": true } }, { @@ -5470,9 +5470,9 @@ } }, "params": { - "UseDualStack": false, + "UseFIPS": false, "Region": "us-gov-west-1", - "UseFIPS": false + "UseDualStack": false } }, { @@ -5483,9 +5483,9 @@ } }, "params": { - "UseDualStack": true, + "UseFIPS": true, "Region": "ap-southeast-1", - "UseFIPS": true + "UseDualStack": true } }, { @@ -5496,9 +5496,9 @@ } }, "params": { - "UseDualStack": false, + "UseFIPS": true, "Region": "ap-southeast-1", - "UseFIPS": true + "UseDualStack": false } }, { @@ -5509,9 +5509,9 @@ } }, "params": { - "UseDualStack": true, + "UseFIPS": false, "Region": "ap-southeast-1", - "UseFIPS": false + "UseDualStack": true } }, { @@ -5522,9 +5522,9 @@ } }, "params": { - "UseDualStack": false, + "UseFIPS": false, "Region": "ap-southeast-1", - "UseFIPS": false + "UseDualStack": false } }, { @@ -5535,9 +5535,9 @@ } }, "params": { - "UseDualStack": true, + "UseFIPS": true, "Region": "ap-southeast-2", - "UseFIPS": true + "UseDualStack": true } }, { @@ -5548,9 +5548,9 @@ } }, "params": { - "UseDualStack": false, + "UseFIPS": true, "Region": "ap-southeast-2", - "UseFIPS": true + "UseDualStack": false } }, { @@ -5561,9 +5561,9 @@ } }, "params": { - "UseDualStack": true, + "UseFIPS": false, "Region": "ap-southeast-2", - "UseFIPS": false + "UseDualStack": true } }, { @@ -5574,9 +5574,9 @@ } }, "params": { - "UseDualStack": false, + "UseFIPS": false, "Region": "ap-southeast-2", - "UseFIPS": false + "UseDualStack": false } }, { @@ -5585,9 +5585,9 @@ "error": "FIPS and DualStack are enabled, but this partition does not support one or both" }, "params": { - "UseDualStack": true, + "UseFIPS": true, "Region": "us-iso-east-1", - "UseFIPS": true + "UseDualStack": true } }, { @@ -5598,9 +5598,9 @@ } }, "params": { - "UseDualStack": false, + "UseFIPS": true, "Region": "us-iso-east-1", - "UseFIPS": true + "UseDualStack": false } }, { @@ -5609,9 +5609,9 @@ "error": "DualStack is enabled but this partition does not support DualStack" }, "params": { - "UseDualStack": true, + "UseFIPS": false, "Region": "us-iso-east-1", - "UseFIPS": false + "UseDualStack": true } }, { @@ -5622,9 +5622,9 @@ } }, "params": { - "UseDualStack": false, + "UseFIPS": false, "Region": "us-iso-east-1", - "UseFIPS": false + "UseDualStack": false } }, { @@ -5635,9 +5635,9 @@ } }, "params": { - "UseDualStack": true, + "UseFIPS": true, "Region": "ap-southeast-3", - "UseFIPS": true + "UseDualStack": true } }, { @@ -5648,9 +5648,9 @@ } }, "params": { - "UseDualStack": false, + "UseFIPS": true, "Region": "ap-southeast-3", - "UseFIPS": true + "UseDualStack": false } }, { @@ -5661,9 +5661,9 @@ } }, "params": { - "UseDualStack": true, + "UseFIPS": false, "Region": "ap-southeast-3", - "UseFIPS": false + "UseDualStack": true } }, { @@ -5674,9 +5674,9 @@ } }, "params": { - "UseDualStack": false, + "UseFIPS": false, "Region": "ap-southeast-3", - "UseFIPS": false + "UseDualStack": false } }, { @@ -5687,9 +5687,9 @@ } }, "params": { - "UseDualStack": true, + "UseFIPS": true, "Region": "ap-southeast-4", - "UseFIPS": true + "UseDualStack": true } }, { @@ -5700,9 +5700,9 @@ } }, "params": { - "UseDualStack": false, + "UseFIPS": true, "Region": "ap-southeast-4", - "UseFIPS": true + "UseDualStack": false } }, { @@ -5713,9 +5713,9 @@ } }, "params": { - "UseDualStack": true, + "UseFIPS": false, "Region": "ap-southeast-4", - "UseFIPS": false + "UseDualStack": true } }, { @@ -5726,9 +5726,9 @@ } }, "params": { - "UseDualStack": false, + "UseFIPS": false, "Region": "ap-southeast-4", - "UseFIPS": false + "UseDualStack": false } }, { @@ -5739,9 +5739,9 @@ } }, "params": { - "UseDualStack": true, + "UseFIPS": true, "Region": "us-east-1", - "UseFIPS": true + "UseDualStack": true } }, { @@ -5752,9 +5752,9 @@ } }, "params": { - "UseDualStack": false, + "UseFIPS": true, "Region": "us-east-1", - "UseFIPS": true + "UseDualStack": false } }, { @@ -5765,9 +5765,9 @@ } }, "params": { - "UseDualStack": true, + "UseFIPS": false, "Region": "us-east-1", - "UseFIPS": false + "UseDualStack": true } }, { @@ -5778,9 +5778,9 @@ } }, "params": { - "UseDualStack": false, + "UseFIPS": false, "Region": "us-east-1", - "UseFIPS": false + "UseDualStack": false } }, { @@ -5791,9 +5791,9 @@ } }, "params": { - "UseDualStack": true, + "UseFIPS": true, "Region": "us-east-2", - "UseFIPS": true + "UseDualStack": true } }, { @@ -5804,9 +5804,9 @@ } }, "params": { - "UseDualStack": false, + "UseFIPS": true, "Region": "us-east-2", - "UseFIPS": true + "UseDualStack": false } }, { @@ -5817,9 +5817,9 @@ } }, "params": { - "UseDualStack": true, + "UseFIPS": false, "Region": "us-east-2", - "UseFIPS": false + "UseDualStack": true } }, { @@ -5830,9 +5830,9 @@ } }, "params": { - "UseDualStack": false, + "UseFIPS": false, "Region": "us-east-2", - "UseFIPS": false + "UseDualStack": false } }, { @@ -5843,9 +5843,9 @@ } }, "params": { - "UseDualStack": true, + "UseFIPS": true, "Region": "cn-northwest-1", - "UseFIPS": true + "UseDualStack": true } }, { @@ -5856,9 +5856,9 @@ } }, "params": { - "UseDualStack": false, + "UseFIPS": true, "Region": "cn-northwest-1", - "UseFIPS": true + "UseDualStack": false } }, { @@ -5869,9 +5869,9 @@ } }, "params": { - "UseDualStack": true, + "UseFIPS": false, "Region": "cn-northwest-1", - "UseFIPS": false + "UseDualStack": true } }, { @@ -5882,9 +5882,9 @@ } }, "params": { - "UseDualStack": false, + "UseFIPS": false, "Region": "cn-northwest-1", - "UseFIPS": false + "UseDualStack": false } }, { @@ -5893,9 +5893,9 @@ "error": "FIPS and DualStack are enabled, but this partition does not support one or both" }, "params": { - "UseDualStack": true, + "UseFIPS": true, "Region": "us-isob-east-1", - "UseFIPS": true + "UseDualStack": true } }, { @@ -5906,9 +5906,9 @@ } }, "params": { - "UseDualStack": false, + "UseFIPS": true, "Region": "us-isob-east-1", - "UseFIPS": true + "UseDualStack": false } }, { @@ -5917,9 +5917,9 @@ "error": "DualStack is enabled but this partition does not support DualStack" }, "params": { - "UseDualStack": true, + "UseFIPS": false, "Region": "us-isob-east-1", - "UseFIPS": false + "UseDualStack": true } }, { @@ -5930,9 +5930,9 @@ } }, "params": { - "UseDualStack": false, + "UseFIPS": false, "Region": "us-isob-east-1", - "UseFIPS": false + "UseDualStack": false } }, { @@ -5943,9 +5943,9 @@ } }, "params": { - "UseDualStack": false, - "Region": "us-east-1", "UseFIPS": false, + "Region": "us-east-1", + "UseDualStack": false, "Endpoint": "https://example.com" } }, @@ -5955,9 +5955,9 @@ "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { - "UseDualStack": false, - "Region": "us-east-1", "UseFIPS": true, + "Region": "us-east-1", + "UseDualStack": false, "Endpoint": "https://example.com" } }, @@ -5967,9 +5967,9 @@ "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { - "UseDualStack": true, - "Region": "us-east-1", "UseFIPS": false, + "Region": "us-east-1", + "UseDualStack": true, "Endpoint": "https://example.com" } } @@ -9952,7 +9952,7 @@ "target": "com.amazonaws.ec2#CancelImageLaunchPermissionResult" }, "traits": { - "smithy.api#documentation": "Removes your Amazon Web Services account from the launch permissions for the specified AMI. For more\n information, see Cancel having an AMI shared with your Amazon Web Services account \n in the Amazon Elastic Compute Cloud User Guide.
" + "smithy.api#documentation": "Removes your Amazon Web Services account from the launch permissions for the specified AMI. For more\n information, see Cancel having an AMI shared with your Amazon Web Services account \n in the Amazon EC2 User Guide.
" } }, "com.amazonaws.ec2#CancelImageLaunchPermissionRequest": { @@ -13184,7 +13184,7 @@ "target": "com.amazonaws.ec2#CopyImageResult" }, "traits": { - "smithy.api#documentation": "Initiates the copy of an AMI. You can copy an AMI from one Region to another, or from a\n Region to an Outpost. You can't copy an AMI from an Outpost to a Region, from one Outpost\n to another, or within the same Outpost. To copy an AMI to another partition, see CreateStoreImageTask.
\nTo copy an AMI from one Region to another, specify the source Region using the \n \t\tSourceRegion parameter, and specify the \n \t\tdestination Region using its endpoint. Copies of encrypted backing snapshots for\n \t\tthe AMI are encrypted. Copies of unencrypted backing snapshots remain unencrypted, \n \t\tunless you set Encrypted during the copy operation. You cannot \n \t\tcreate an unencrypted copy of an encrypted backing snapshot.
To copy an AMI from a Region to an Outpost, specify the source Region using the \n \t\tSourceRegion parameter, and specify the \n \t\tARN of the destination Outpost using DestinationOutpostArn. \n \t\tBacking snapshots copied to an Outpost are encrypted by default using the default\n \t\tencryption key for the Region, or a different key that you specify in the request using \n \t\tKmsKeyId. Outposts do not support unencrypted \n \t\tsnapshots. For more information, \n \t\t\tAmazon EBS local snapshots on Outposts in the Amazon Elastic Compute Cloud User Guide.
\nFor more information about the prerequisites and limits when copying an AMI, see Copy an AMI in the\n Amazon Elastic Compute Cloud User Guide.
" + "smithy.api#documentation": "Initiates the copy of an AMI. You can copy an AMI from one Region to another, or from a\n Region to an Outpost. You can't copy an AMI from an Outpost to a Region, from one Outpost\n to another, or within the same Outpost. To copy an AMI to another partition, see CreateStoreImageTask.
\nTo copy an AMI from one Region to another, specify the source Region using the \n \t\tSourceRegion parameter, and specify the \n \t\tdestination Region using its endpoint. Copies of encrypted backing snapshots for\n \t\tthe AMI are encrypted. Copies of unencrypted backing snapshots remain unencrypted, \n \t\tunless you set Encrypted during the copy operation. You cannot \n \t\tcreate an unencrypted copy of an encrypted backing snapshot.
To copy an AMI from a Region to an Outpost, specify the source Region using the \n \t\tSourceRegion parameter, and specify the \n \t\tARN of the destination Outpost using DestinationOutpostArn. \n \t\tBacking snapshots copied to an Outpost are encrypted by default using the default\n \t\tencryption key for the Region, or a different key that you specify in the request using \n \t\tKmsKeyId. Outposts do not support unencrypted \n \t\tsnapshots. For more information, \n \t\t\tAmazon EBS local snapshots on Outposts in the Amazon EC2 User Guide.
\nFor more information about the prerequisites and limits when copying an AMI, see Copy an AMI in the\n Amazon EC2 User Guide.
" } }, "com.amazonaws.ec2#CopyImageRequest": { @@ -13208,7 +13208,7 @@ "aws.protocols#ec2QueryName": "Encrypted", "smithy.api#clientOptional": {}, "smithy.api#default": false, - "smithy.api#documentation": "Specifies whether the destination snapshots of the copied image should be encrypted. You\n can encrypt a copy of an unencrypted snapshot, but you cannot create an unencrypted copy of an\n encrypted snapshot. The default KMS key for Amazon EBS is used unless you specify a non-default\n Key Management Service (KMS) KMS key using KmsKeyId. For more information, see Amazon EBS encryption in the\n Amazon Elastic Compute Cloud User Guide.
Specifies whether the destination snapshots of the copied image should be encrypted. You\n can encrypt a copy of an unencrypted snapshot, but you cannot create an unencrypted copy of an\n encrypted snapshot. The default KMS key for Amazon EBS is used unless you specify a non-default\n Key Management Service (KMS) KMS key using KmsKeyId. For more information, see Amazon EBS encryption in the\n Amazon EC2 User Guide.
The Amazon Resource Name (ARN) of the Outpost to which to copy the AMI. Only \n \t\tspecify this parameter when copying an AMI from an Amazon Web Services Region to an Outpost. \n \t\tThe AMI must be in the Region of the destination Outpost. You cannot copy an \n \t\tAMI from an Outpost to a Region, from one Outpost to another, or within the same \n \t\tOutpost.
\nFor more information, see Copy AMIs from an Amazon Web Services\n Region to an Outpost in the Amazon Elastic Compute Cloud User Guide.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Outpost to which to copy the AMI. Only \n \t\tspecify this parameter when copying an AMI from an Amazon Web Services Region to an Outpost. \n \t\tThe AMI must be in the Region of the destination Outpost. You cannot copy an \n \t\tAMI from an Outpost to a Region, from one Outpost to another, or within the same \n \t\tOutpost.
\nFor more information, see Copy AMIs from an Amazon Web Services\n Region to an Outpost in the Amazon EC2 User Guide.
" } }, "DryRun": { @@ -17084,7 +17084,7 @@ "target": "com.amazonaws.ec2#CreateRestoreImageTaskResult" }, "traits": { - "smithy.api#documentation": "Starts a task that restores an AMI from an Amazon S3 object that was previously created by using\n CreateStoreImageTask.
\nTo use this API, you must have the required permissions. For more information, see Permissions for storing and restoring AMIs using Amazon S3 in the\n Amazon Elastic Compute Cloud User Guide.
\nFor more information, see Store and restore an AMI using\n \tAmazon S3 in the Amazon Elastic Compute Cloud User Guide.
" + "smithy.api#documentation": "Starts a task that restores an AMI from an Amazon S3 object that was previously created by using\n CreateStoreImageTask.
\nTo use this API, you must have the required permissions. For more information, see Permissions for storing and restoring AMIs using Amazon S3 in the\n Amazon EC2 User Guide.
\nFor more information, see Store and restore an AMI using\n \tAmazon S3 in the Amazon EC2 User Guide.
" } }, "com.amazonaws.ec2#CreateRestoreImageTaskRequest": { @@ -17627,7 +17627,7 @@ "target": "com.amazonaws.ec2#CreateStoreImageTaskResult" }, "traits": { - "smithy.api#documentation": "Stores an AMI as a single object in an Amazon S3 bucket.
\nTo use this API, you must have the required permissions. For more information, see Permissions for storing and restoring AMIs using Amazon S3 in the\n Amazon Elastic Compute Cloud User Guide.
\nFor more information, see Store and restore an AMI using\n \tAmazon S3 in the Amazon Elastic Compute Cloud User Guide.
" + "smithy.api#documentation": "Stores an AMI as a single object in an Amazon S3 bucket.
\nTo use this API, you must have the required permissions. For more information, see Permissions for storing and restoring AMIs using Amazon S3 in the\n Amazon EC2 User Guide.
\nFor more information, see Store and restore an AMI using\n \tAmazon S3 in the Amazon EC2 User Guide.
" } }, "com.amazonaws.ec2#CreateStoreImageTaskRequest": { @@ -24635,7 +24635,7 @@ "target": "smithy.api#Unit" }, "traits": { - "smithy.api#documentation": "Deregisters the specified AMI. After you deregister an AMI, it can't be used to \n launch new instances.
\nIf you deregister an AMI that matches a Recycle Bin retention rule, the AMI is retained\n in the Recycle Bin for the specified retention period. For more information, see Recycle Bin in\n the Amazon Elastic Compute Cloud User Guide.
\nWhen you deregister an AMI, it doesn't affect any instances that you've already \n launched from the AMI. You'll continue to incur usage costs for those instances until \n you terminate them.
\nWhen you deregister an Amazon EBS-backed AMI, it doesn't affect the snapshot that was\n\t\t\tcreated for the root volume of the instance during the AMI creation process. When you\n\t\t\tderegister an instance store-backed AMI, it doesn't affect the files that you uploaded\n\t\t\tto Amazon S3 when you created the AMI.
" + "smithy.api#documentation": "Deregisters the specified AMI. After you deregister an AMI, it can't be used to \n launch new instances.
\nIf you deregister an AMI that matches a Recycle Bin retention rule, the AMI is retained\n in the Recycle Bin for the specified retention period. For more information, see Recycle Bin in\n the Amazon EC2 User Guide.
\nWhen you deregister an AMI, it doesn't affect any instances that you've already \n launched from the AMI. You'll continue to incur usage costs for those instances until \n you terminate them.
\nWhen you deregister an Amazon EBS-backed AMI, it doesn't affect the snapshot that was\n\t\t\tcreated for the root volume of the instance during the AMI creation process. When you\n\t\t\tderegister an instance store-backed AMI, it doesn't affect the files that you uploaded\n\t\t\tto Amazon S3 when you created the AMI.
" } }, "com.amazonaws.ec2#DeregisterImageRequest": { @@ -28456,6 +28456,12 @@ }, "traits": { "smithy.api#documentation": "Describes the specified images (AMIs, AKIs, and ARIs) available to you or all of the images available to you.
\nThe images available to you include public images, private images that you own, and private images owned by other \n Amazon Web Services accounts for which you have explicit launch permissions.
\nRecently deregistered images appear in the returned results for a short interval and then\n return empty results. After all instances that reference a deregistered AMI are terminated,\n specifying the ID of the image will eventually return an error indicating that the AMI ID\n cannot be found.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Images", + "pageSize": "MaxResults" + }, "smithy.api#suppress": [ "WaitableTraitInvalidErrorType" ], @@ -28557,6 +28563,20 @@ "smithy.api#documentation": "Checks whether you have the required permissions for the action, without actually making the request, \n\t\t\tand provides an error response. If you have the required permissions, the error response is \n\t\t\tDryRunOperation. Otherwise, it is UnauthorizedOperation.
The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.
The token for the next page of results.
" + } } } }, @@ -28570,6 +28590,14 @@ "smithy.api#documentation": "Information about the images.
", "smithy.api#xmlName": "imagesSet" } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Describes the progress of the AMI store tasks. You can describe the store tasks for\n specified AMIs. If you don't specify the AMIs, you get a paginated list of store tasks from\n the last 31 days.
\nFor each AMI task, the response indicates if the task is InProgress,\n Completed, or Failed. For tasks InProgress, the\n response shows the estimated progress as a percentage.
Tasks are listed in reverse chronological order. Currently, only tasks from the past 31\n days can be viewed.
\nTo use this API, you must have the required permissions. For more information, see Permissions for storing and restoring AMIs using Amazon S3 in the\n Amazon Elastic Compute Cloud User Guide.
\nFor more information, see Store and restore an AMI using\n \tAmazon S3 in the Amazon Elastic Compute Cloud User Guide.
", + "smithy.api#documentation": "Describes the progress of the AMI store tasks. You can describe the store tasks for\n specified AMIs. If you don't specify the AMIs, you get a paginated list of store tasks from\n the last 31 days.
\nFor each AMI task, the response indicates if the task is InProgress,\n Completed, or Failed. For tasks InProgress, the\n response shows the estimated progress as a percentage.
Tasks are listed in reverse chronological order. Currently, only tasks from the past 31\n days can be viewed.
\nTo use this API, you must have the required permissions. For more information, see Permissions for storing and restoring AMIs using Amazon S3 in the\n Amazon EC2 User Guide.
\nFor more information, see Store and restore an AMI using\n \tAmazon S3 in the Amazon EC2 User Guide.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -37987,13 +38015,13 @@ } }, "InstanceId": { - "target": "com.amazonaws.ec2#InstanceId", + "target": "com.amazonaws.ec2#InstanceIdForResolver", "traits": { "smithy.api#documentation": "The ID of the instance. If you are detaching a Multi-Attach enabled volume, you must specify an instance ID.
" } }, "VolumeId": { - "target": "com.amazonaws.ec2#VolumeId", + "target": "com.amazonaws.ec2#VolumeIdWithResolver", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The ID of the volume.
", @@ -38779,7 +38807,7 @@ "target": "com.amazonaws.ec2#DisableImageDeprecationResult" }, "traits": { - "smithy.api#documentation": "Cancels the deprecation of the specified AMI.
\nFor more information, see Deprecate an AMI in the\n Amazon Elastic Compute Cloud User Guide.
" + "smithy.api#documentation": "Cancels the deprecation of the specified AMI.
\nFor more information, see Deprecate an AMI in the\n Amazon EC2 User Guide.
" } }, "com.amazonaws.ec2#DisableImageDeprecationRequest": { @@ -41489,7 +41517,7 @@ "target": "com.amazonaws.ec2#EnableImageDeprecationResult" }, "traits": { - "smithy.api#documentation": "Enables deprecation of the specified AMI at the specified date and time.
\nFor more information, see Deprecate an AMI in the Amazon Elastic Compute Cloud User Guide.
" + "smithy.api#documentation": "Enables deprecation of the specified AMI at the specified date and time.
\nFor more information, see Deprecate an AMI in the Amazon EC2 User Guide.
" } }, "com.amazonaws.ec2#EnableImageDeprecationRequest": { @@ -49356,7 +49384,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "PlatformDetails", - "smithy.api#documentation": "The platform details associated with the billing code of the AMI. For more information,\n see Understand\n AMI billing information in the Amazon Elastic Compute Cloud User Guide.
", + "smithy.api#documentation": "The platform details associated with the billing code of the AMI. For more information,\n see Understand\n AMI billing information in the Amazon EC2 User Guide.
", "smithy.api#xmlName": "platformDetails" } }, @@ -49494,7 +49522,7 @@ "target": "com.amazonaws.ec2#BootModeValues", "traits": { "aws.protocols#ec2QueryName": "BootMode", - "smithy.api#documentation": "The boot mode of the image. For more information, see Boot modes in the\n Amazon Elastic Compute Cloud User Guide.
", + "smithy.api#documentation": "The boot mode of the image. For more information, see Boot modes in the\n Amazon EC2 User Guide.
", "smithy.api#xmlName": "bootMode" } }, @@ -49502,7 +49530,7 @@ "target": "com.amazonaws.ec2#TpmSupportValues", "traits": { "aws.protocols#ec2QueryName": "TpmSupport", - "smithy.api#documentation": "If the image is configured for NitroTPM support, the value is v2.0. \n For more information, see NitroTPM in the\n Amazon Elastic Compute Cloud User Guide.
If the image is configured for NitroTPM support, the value is v2.0. \n For more information, see NitroTPM in the\n Amazon EC2 User Guide.
If v2.0, it indicates that IMDSv2 is specified in the AMI. Instances launched\n from this AMI will have HttpTokens automatically set to required so\n that, by default, the instance requires that IMDSv2 is used when requesting instance metadata.\n In addition, HttpPutResponseHopLimit is set to 2. For more\n information, see Configure\n the AMI in the Amazon Elastic Compute Cloud User Guide.
If v2.0, it indicates that IMDSv2 is specified in the AMI. Instances launched\n from this AMI will have HttpTokens automatically set to required so\n that, by default, the instance requires that IMDSv2 is used when requesting instance metadata.\n In addition, HttpPutResponseHopLimit is set to 2. For more\n information, see Configure\n the AMI in the Amazon EC2 User Guide.
Base64 representation of the non-volatile UEFI variable store. To retrieve the UEFI data,\n use the GetInstanceUefiData command. You can inspect and modify the UEFI data by using the\n python-uefivars tool on\n GitHub. For more information, see UEFI Secure Boot in the\n Amazon Elastic Compute Cloud User Guide.
", + "smithy.api#documentation": "Base64 representation of the non-volatile UEFI variable store. To retrieve the UEFI data,\n use the GetInstanceUefiData command. You can inspect and modify the UEFI data by using the\n python-uefivars tool on\n GitHub. For more information, see UEFI Secure Boot in the\n Amazon EC2 User Guide.
", "smithy.api#xmlName": "uefiData" } }, @@ -49630,7 +49658,7 @@ "target": "com.amazonaws.ec2#AttributeValue", "traits": { "aws.protocols#ec2QueryName": "ImdsSupport", - "smithy.api#documentation": "If v2.0, it indicates that IMDSv2 is specified in the AMI. Instances launched\n from this AMI will have HttpTokens automatically set to required so\n that, by default, the instance requires that IMDSv2 is used when requesting instance metadata.\n In addition, HttpPutResponseHopLimit is set to 2. For more\n information, see Configure\n the AMI in the Amazon Elastic Compute Cloud User Guide.
If v2.0, it indicates that IMDSv2 is specified in the AMI. Instances launched\n from this AMI will have HttpTokens automatically set to required so\n that, by default, the instance requires that IMDSv2 is used when requesting instance metadata.\n In addition, HttpPutResponseHopLimit is set to 2. For more\n information, see Configure\n the AMI in the Amazon EC2 User Guide.
Lists one or more AMIs that are currently in the Recycle Bin. For more information, \n see Recycle\n Bin in the Amazon Elastic Compute Cloud User Guide.
", + "smithy.api#documentation": "Lists one or more AMIs that are currently in the Recycle Bin. For more information, \n see Recycle\n Bin in the Amazon EC2 User Guide.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -74918,7 +74949,7 @@ "target": "com.amazonaws.ec2#RegisterImageResult" }, "traits": { - "smithy.api#documentation": "Registers an AMI. When you're creating an AMI, this is the final step you must complete\n before you can launch an instance from the AMI. For more information about creating AMIs, see\n Create your\n own AMI in the Amazon Elastic Compute Cloud User Guide.
\nFor Amazon EBS-backed instances, CreateImage creates and registers the AMI\n in a single request, so you don't have to register the AMI yourself. We recommend that you\n always use CreateImage unless you have a specific reason to use\n RegisterImage.
\nIf needed, you can deregister an AMI at any time. Any modifications you make to an AMI backed by an instance store volume invalidates its registration. \n If you make changes to an image, deregister the previous image and register the new image.
\n\n Register a snapshot of a root device volume\n
\nYou can use RegisterImage to create an Amazon EBS-backed Linux AMI from\n a snapshot of a root device volume. You specify the snapshot using a block device mapping.\n You can't set the encryption state of the volume using the block device mapping. If the \n snapshot is encrypted, or encryption by default is enabled, the root volume of an instance \n launched from the AMI is encrypted.
For more information, see Create a Linux AMI from a snapshot and Use encryption with Amazon EBS-backed AMIs\n in the Amazon Elastic Compute Cloud User Guide.
\n\n Amazon Web Services Marketplace product codes\n
\nIf any snapshots have Amazon Web Services Marketplace product codes, they are copied to the new\n AMI.
\nWindows and some Linux distributions, such as Red Hat Enterprise Linux (RHEL) and SUSE\n Linux Enterprise Server (SLES), use the Amazon EC2 billing product code associated with an AMI to\n verify the subscription status for package updates. To create a new AMI for operating systems\n that require a billing product code, instead of registering the AMI, do the following to\n preserve the billing product code association:
\nLaunch an instance from an existing AMI with that billing product code.
\nCustomize the instance.
\nCreate an AMI from the instance using CreateImage.
\nIf you purchase a Reserved Instance to apply to an On-Demand Instance that was launched\n from an AMI with a billing product code, make sure that the Reserved Instance has the matching\n billing product code. If you purchase a Reserved Instance without the matching billing product\n code, the Reserved Instance will not be applied to the On-Demand Instance. For information\n about how to obtain the platform details and billing information of an AMI, see Understand AMI\n billing information in the Amazon Elastic Compute Cloud User Guide.
" + "smithy.api#documentation": "Registers an AMI. When you're creating an AMI, this is the final step you must complete\n before you can launch an instance from the AMI. For more information about creating AMIs, see\n Create your\n own AMI in the Amazon Elastic Compute Cloud User Guide.
\nFor Amazon EBS-backed instances, CreateImage creates and registers the AMI\n in a single request, so you don't have to register the AMI yourself. We recommend that you\n always use CreateImage unless you have a specific reason to use\n RegisterImage.
\nIf needed, you can deregister an AMI at any time. Any modifications you make to an AMI backed by an instance store volume invalidates its registration. \n If you make changes to an image, deregister the previous image and register the new image.
\n\n Register a snapshot of a root device volume\n
\nYou can use RegisterImage to create an Amazon EBS-backed Linux AMI from\n a snapshot of a root device volume. You specify the snapshot using a block device mapping.\n You can't set the encryption state of the volume using the block device mapping. If the \n snapshot is encrypted, or encryption by default is enabled, the root volume of an instance \n launched from the AMI is encrypted.
For more information, see Create a Linux AMI from a snapshot and Use encryption with Amazon EBS-backed AMIs\n in the Amazon Elastic Compute Cloud User Guide.
\n\n Amazon Web Services Marketplace product codes\n
\nIf any snapshots have Amazon Web Services Marketplace product codes, they are copied to the new\n AMI.
\nWindows and some Linux distributions, such as Red Hat Enterprise Linux (RHEL) and SUSE\n Linux Enterprise Server (SLES), use the Amazon EC2 billing product code associated with an AMI to\n verify the subscription status for package updates. To create a new AMI for operating systems\n that require a billing product code, instead of registering the AMI, do the following to\n preserve the billing product code association:
\nLaunch an instance from an existing AMI with that billing product code.
\nCustomize the instance.
\nCreate an AMI from the instance using CreateImage.
\nIf you purchase a Reserved Instance to apply to an On-Demand Instance that was launched\n from an AMI with a billing product code, make sure that the Reserved Instance has the matching\n billing product code. If you purchase a Reserved Instance without the matching billing product\n code, the Reserved Instance will not be applied to the On-Demand Instance. For information\n about how to obtain the platform details and billing information of an AMI, see Understand AMI\n billing information in the Amazon EC2 User Guide.
" } }, "com.amazonaws.ec2#RegisterImageRequest": { @@ -74941,7 +74972,7 @@ "BlockDeviceMappings": { "target": "com.amazonaws.ec2#BlockDeviceMappingRequestList", "traits": { - "smithy.api#documentation": "The block device mapping entries.
\nIf you specify an Amazon EBS volume using the ID of an Amazon EBS snapshot, you can't specify the encryption state of the volume.
\nIf you create an AMI on an Outpost, then all backing snapshots must be on the same Outpost or in the Region \n \t of that Outpost. AMIs on an Outpost that include local snapshots can be used to launch instances on the same Outpost \n \t only. For more information, \n \t \tAmazon EBS local snapshots on Outposts in the Amazon Elastic Compute Cloud User Guide.
", + "smithy.api#documentation": "The block device mapping entries.
\nIf you specify an Amazon EBS volume using the ID of an Amazon EBS snapshot, you can't specify the encryption state of the volume.
\nIf you create an AMI on an Outpost, then all backing snapshots must be on the same\n Outpost or in the Region of that Outpost. AMIs on an Outpost that include local snapshots can\n be used to launch instances on the same Outpost only. For more information, Amazon EBS local\n snapshots on Outposts in the Amazon EC2 User Guide.
", "smithy.api#xmlName": "BlockDeviceMapping" } }, @@ -74994,7 +75025,7 @@ "BillingProducts": { "target": "com.amazonaws.ec2#BillingProductList", "traits": { - "smithy.api#documentation": "The billing product codes. Your account must be authorized to specify billing product codes. Otherwise,\n \tyou can use the Amazon Web Services Marketplace to bill for the use of an AMI.
", + "smithy.api#documentation": "The billing product codes. Your account must be authorized to specify billing product codes.
\nIf your account is not authorized to specify billing product codes, you can publish AMIs\n that include billable software and list them on the Amazon Web Services Marketplace. You must first register as a seller\n on the Amazon Web Services Marketplace. For more information, see Getting started as a\n seller and AMI-based\n products in the Amazon Web Services Marketplace Seller Guide.
", "smithy.api#xmlName": "BillingProduct" } }, @@ -75033,25 +75064,25 @@ "BootMode": { "target": "com.amazonaws.ec2#BootModeValues", "traits": { - "smithy.api#documentation": "The boot mode of the AMI. For more information, see Boot modes in the\n Amazon Elastic Compute Cloud User Guide.
" + "smithy.api#documentation": "The boot mode of the AMI. For more information, see Boot modes in the\n Amazon EC2 User Guide.
" } }, "TpmSupport": { "target": "com.amazonaws.ec2#TpmSupportValues", "traits": { - "smithy.api#documentation": "Set to v2.0 to enable Trusted Platform Module (TPM) support. For more\n information, see NitroTPM in the Amazon Elastic Compute Cloud User Guide.
Set to v2.0 to enable Trusted Platform Module (TPM) support. For more\n information, see NitroTPM in the Amazon EC2 User Guide.
Base64 representation of the non-volatile UEFI variable store. To retrieve the UEFI data,\n use the GetInstanceUefiData command. You can inspect and modify the UEFI data by using the\n python-uefivars tool on\n GitHub. For more information, see UEFI Secure Boot in the\n Amazon Elastic Compute Cloud User Guide.
" + "smithy.api#documentation": "Base64 representation of the non-volatile UEFI variable store. To retrieve the UEFI data,\n use the GetInstanceUefiData command. You can inspect and modify the UEFI data by using the\n python-uefivars tool on\n GitHub. For more information, see UEFI Secure Boot in the\n Amazon EC2 User Guide.
" } }, "ImdsSupport": { "target": "com.amazonaws.ec2#ImdsSupportValues", "traits": { - "smithy.api#documentation": "Set to v2.0 to indicate that IMDSv2 is specified in the AMI. Instances\n launched from this AMI will have HttpTokens automatically set to\n required so that, by default, the instance requires that IMDSv2 is used when\n requesting instance metadata. In addition, HttpPutResponseHopLimit is set to\n 2. For more information, see Configure\n the AMI in the Amazon Elastic Compute Cloud User Guide.
If you set the value to v2.0, make sure that your AMI software can support IMDSv2.
Set to v2.0 to indicate that IMDSv2 is specified in the AMI. Instances\n launched from this AMI will have HttpTokens automatically set to\n required so that, by default, the instance requires that IMDSv2 is used when\n requesting instance metadata. In addition, HttpPutResponseHopLimit is set to\n 2. For more information, see Configure\n the AMI in the Amazon EC2 User Guide.
If you set the value to v2.0, make sure that your AMI software can support IMDSv2.
Restores an AMI from the Recycle Bin. For more information, see Recycle Bin in the Amazon Elastic Compute Cloud User Guide.
" + "smithy.api#documentation": "Restores an AMI from the Recycle Bin. For more information, see Recycle Bin in the Amazon EC2 User Guide.
" } }, "com.amazonaws.ec2#RestoreImageFromRecycleBinRequest": { @@ -93314,6 +93345,9 @@ } } }, + "com.amazonaws.ec2#VolumeIdWithResolver": { + "type": "string" + }, "com.amazonaws.ec2#VolumeList": { "type": "list", "member": { diff --git a/codegen/sdk-codegen/aws-models/lookoutequipment.json b/codegen/sdk-codegen/aws-models/lookoutequipment.json index 456f28574f5..4e15b10cf5a 100644 --- a/codegen/sdk-codegen/aws-models/lookoutequipment.json +++ b/codegen/sdk-codegen/aws-models/lookoutequipment.json @@ -1,5 +1,5 @@ { - "smithy": "1.0", + "smithy": "2.0", "metadata": { "suppressions": [ { @@ -31,21 +31,6 @@ "shapes": { "com.amazonaws.lookoutequipment#AWSLookoutEquipmentFrontendService": { "type": "service", - "traits": { - "aws.api#service": { - "sdkId": "LookoutEquipment", - "arnNamespace": "lookoutequipment", - "cloudFormationName": "LookoutEquipment", - "cloudTrailEventSource": "lookoutequipment.amazonaws.com", - "endpointPrefix": "lookoutequipment" - }, - "aws.auth#sigv4": { - "name": "lookoutequipment" - }, - "aws.protocols#awsJson1_0": {}, - "smithy.api#documentation": "Amazon Lookout for Equipment is a machine learning service that uses advanced analytics to identify\n anomalies in machines from sensor data for use in predictive maintenance.
", - "smithy.api#title": "Amazon Lookout for Equipment" - }, "version": "2020-12-15", "operations": [ { @@ -147,7 +132,527 @@ { "target": "com.amazonaws.lookoutequipment#UpdateLabelGroup" } - ] + ], + "traits": { + "aws.api#service": { + "sdkId": "LookoutEquipment", + "arnNamespace": "lookoutequipment", + "cloudFormationName": "LookoutEquipment", + "cloudTrailEventSource": "lookoutequipment.amazonaws.com", + "endpointPrefix": "lookoutequipment" + }, + "aws.auth#sigv4": { + "name": "lookoutequipment" + }, + "aws.protocols#awsJson1_0": {}, + "smithy.api#documentation": "Amazon Lookout for Equipment is a machine learning service that uses advanced analytics to identify\n anomalies in machines from sensor data for use in predictive maintenance.
", + "smithy.api#title": "Amazon Lookout for Equipment", + "smithy.rules#endpointRuleSet": { + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": true, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://lookoutequipment-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://lookoutequipment-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://lookoutequipment.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ] + }, + { + "conditions": [], + "endpoint": { + "url": "https://lookoutequipment.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ + { + "documentation": "For region eu-west-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://lookoutequipment-fips.eu-west-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": true, + "Region": "eu-west-1" + } + }, + { + "documentation": "For region eu-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lookoutequipment-fips.eu-west-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": false, + "Region": "eu-west-1" + } + }, + { + "documentation": "For region eu-west-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://lookoutequipment.eu-west-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": true, + "Region": "eu-west-1" + } + }, + { + "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lookoutequipment.eu-west-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Region": "eu-west-1" + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://lookoutequipment-fips.ap-northeast-2.api.aws" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": true, + "Region": "ap-northeast-2" + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lookoutequipment-fips.ap-northeast-2.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": false, + "Region": "ap-northeast-2" + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://lookoutequipment.ap-northeast-2.api.aws" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": true, + "Region": "ap-northeast-2" + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lookoutequipment.ap-northeast-2.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Region": "ap-northeast-2" + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://lookoutequipment-fips.us-east-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": true, + "Region": "us-east-1" + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lookoutequipment-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "UseDualStack": false, + "Region": "us-east-1" + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://lookoutequipment.us-east-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": true, + "Region": "us-east-1" + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lookoutequipment.us-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Region": "us-east-1" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Region": "us-east-1", + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips enabled and dualstack disabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "UseFIPS": true, + "UseDualStack": false, + "Region": "us-east-1", + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "params": { + "UseFIPS": false, + "UseDualStack": true, + "Region": "us-east-1", + "Endpoint": "https://example.com" + } + } + ], + "version": "1.0" + } + } }, "com.amazonaws.lookoutequipment#AccessDeniedException": { "type": "structure", @@ -175,7 +680,10 @@ } }, "com.amazonaws.lookoutequipment#Boolean": { - "type": "boolean" + "type": "boolean", + "traits": { + "smithy.api#default": false + } }, "com.amazonaws.lookoutequipment#BoundedLengthString": { "type": "string", @@ -267,6 +775,7 @@ "Percentage": { "target": "com.amazonaws.lookoutequipment#Float", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "Indicates the percentage of occurances of the given statistic.
", "smithy.api#required": {} } @@ -834,7 +1343,6 @@ "com.amazonaws.lookoutequipment#DataDelayOffsetInMinutes": { "type": "long", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 0, "max": 60 @@ -945,37 +1453,44 @@ "com.amazonaws.lookoutequipment#DataSizeInBytes": { "type": "long", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 0 } } }, "com.amazonaws.lookoutequipment#DataUploadFrequency": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "PT5M", - "name": "PT5M" - }, - { - "value": "PT10M", - "name": "PT10M" - }, - { - "value": "PT15M", - "name": "PT15M" - }, - { - "value": "PT30M", - "name": "PT30M" - }, - { - "value": "PT1H", - "name": "PT1H" + "type": "enum", + "members": { + "PT5M": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PT5M" } - ] + }, + "PT10M": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PT10M" + } + }, + "PT15M": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PT15M" + } + }, + "PT30M": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PT30M" + } + }, + "PT1H": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PT1H" + } + } } }, "com.amazonaws.lookoutequipment#DatasetArn": { @@ -1023,22 +1538,26 @@ } }, "com.amazonaws.lookoutequipment#DatasetStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "CREATED", - "name": "CREATED" - }, - { - "value": "INGESTION_IN_PROGRESS", - "name": "INGESTION_IN_PROGRESS" - }, - { - "value": "ACTIVE", - "name": "ACTIVE" + "type": "enum", + "members": { + "CREATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATED" + } + }, + "INGESTION_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INGESTION_IN_PROGRESS" } - ] + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + } } }, "com.amazonaws.lookoutequipment#DatasetSummaries": { @@ -1102,6 +1621,9 @@ }, { "target": "com.amazonaws.lookoutequipment#ThrottlingException" + }, + { + "target": "com.amazonaws.lookoutequipment#ValidationException" } ], "traits": { @@ -1187,6 +1709,9 @@ }, { "target": "com.amazonaws.lookoutequipment#ThrottlingException" + }, + { + "target": "com.amazonaws.lookoutequipment#ValidationException" } ], "traits": { @@ -1216,6 +1741,9 @@ }, { "target": "com.amazonaws.lookoutequipment#ThrottlingException" + }, + { + "target": "com.amazonaws.lookoutequipment#ValidationException" } ], "traits": { @@ -1276,6 +1804,9 @@ }, { "target": "com.amazonaws.lookoutequipment#ThrottlingException" + }, + { + "target": "com.amazonaws.lookoutequipment#ValidationException" } ], "traits": { @@ -2058,7 +2589,6 @@ "com.amazonaws.lookoutequipment#EventDurationInSeconds": { "type": "long", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 0 } @@ -2093,7 +2623,10 @@ } }, "com.amazonaws.lookoutequipment#Float": { - "type": "float" + "type": "float", + "traits": { + "smithy.api#default": 0 + } }, "com.amazonaws.lookoutequipment#IamRoleArn": { "type": "string", @@ -2166,22 +2699,26 @@ } }, "com.amazonaws.lookoutequipment#InferenceExecutionStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "IN_PROGRESS", - "name": "IN_PROGRESS" - }, - { - "value": "SUCCESS", - "name": "SUCCESS" - }, - { - "value": "FAILED", - "name": "FAILED" + "type": "enum", + "members": { + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN_PROGRESS" + } + }, + "SUCCESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUCCESS" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" } - ] + } } }, "com.amazonaws.lookoutequipment#InferenceExecutionSummaries": { @@ -2410,26 +2947,32 @@ } }, "com.amazonaws.lookoutequipment#InferenceSchedulerStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "PENDING", - "name": "PENDING" - }, - { - "value": "RUNNING", - "name": "RUNNING" - }, - { - "value": "STOPPING", - "name": "STOPPING" - }, - { - "value": "STOPPED", - "name": "STOPPED" + "type": "enum", + "members": { + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING" } - ] + }, + "RUNNING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RUNNING" + } + }, + "STOPPING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STOPPING" + } + }, + "STOPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STOPPED" + } + } } }, "com.amazonaws.lookoutequipment#InferenceSchedulerSummaries": { @@ -2548,22 +3091,26 @@ } }, "com.amazonaws.lookoutequipment#IngestionJobStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "IN_PROGRESS", - "name": "IN_PROGRESS" - }, - { - "value": "SUCCESS", - "name": "SUCCESS" - }, - { - "value": "FAILED", - "name": "FAILED" + "type": "enum", + "members": { + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN_PROGRESS" } - ] + }, + "SUCCESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUCCESS" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + } } }, "com.amazonaws.lookoutequipment#IngestionS3InputConfiguration": { @@ -2616,10 +3163,7 @@ } }, "com.amazonaws.lookoutequipment#Integer": { - "type": "integer", - "traits": { - "smithy.api#box": {} - } + "type": "integer" }, "com.amazonaws.lookoutequipment#InternalServerException": { "type": "structure", @@ -2747,22 +3291,26 @@ } }, "com.amazonaws.lookoutequipment#LabelRating": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ANOMALY", - "name": "ANOMALY" - }, - { - "value": "NO_ANOMALY", - "name": "NO_ANOMALY" - }, - { - "value": "NEUTRAL", - "name": "NEUTRAL" + "type": "enum", + "members": { + "ANOMALY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ANOMALY" + } + }, + "NO_ANOMALY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NO_ANOMALY" } - ] + }, + "NEUTRAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NEUTRAL" + } + } } }, "com.amazonaws.lookoutequipment#LabelSummaries": { @@ -2902,18 +3450,20 @@ } }, "com.amazonaws.lookoutequipment#LatestInferenceResult": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ANOMALOUS", - "name": "ANOMALOUS" - }, - { - "value": "NORMAL", - "name": "NORMAL" + "type": "enum", + "members": { + "ANOMALOUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ANOMALOUS" } - ] + }, + "NORMAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NORMAL" + } + } } }, "com.amazonaws.lookoutequipment#ListDataIngestionJobs": { @@ -3303,6 +3853,12 @@ "traits": { "smithy.api#documentation": "The name of the ML model used by the inference scheduler to be listed.
" } + }, + "Status": { + "target": "com.amazonaws.lookoutequipment#InferenceSchedulerStatus", + "traits": { + "smithy.api#documentation": "Specifies the current status of the inference schedulers to list.
" + } } } }, @@ -3720,7 +4276,6 @@ "com.amazonaws.lookoutequipment#MaxResults": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 1, "max": 500 @@ -3794,22 +4349,26 @@ } }, "com.amazonaws.lookoutequipment#ModelStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "IN_PROGRESS", - "name": "IN_PROGRESS" - }, - { - "value": "SUCCESS", - "name": "SUCCESS" - }, - { - "value": "FAILED", - "name": "FAILED" + "type": "enum", + "members": { + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN_PROGRESS" } - ] + }, + "SUCCESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUCCESS" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + } } }, "com.amazonaws.lookoutequipment#ModelSummaries": { @@ -3884,22 +4443,26 @@ } }, "com.amazonaws.lookoutequipment#Monotonicity": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "DECREASING", - "name": "DECREASING" - }, - { - "value": "INCREASING", - "name": "INCREASING" - }, - { - "value": "STATIC", - "name": "STATIC" + "type": "enum", + "members": { + "DECREASING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DECREASING" + } + }, + "INCREASING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INCREASING" } - ] + }, + "STATIC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STATIC" + } + } } }, "com.amazonaws.lookoutequipment#MultipleOperatingModes": { @@ -4048,6 +4611,7 @@ "DataExists": { "target": "com.amazonaws.lookoutequipment#Boolean", "traits": { + "smithy.api#default": false, "smithy.api#documentation": "Parameter that indicates whether data exists for the sensor that the statistics belong\n to.
" } }, @@ -4313,18 +4877,20 @@ } }, "com.amazonaws.lookoutequipment#StatisticalIssueStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "POTENTIAL_ISSUE_DETECTED", - "name": "POTENTIAL_ISSUE_DETECTED" - }, - { - "value": "NO_ISSUE_DETECTED", - "name": "NO_ISSUE_DETECTED" + "type": "enum", + "members": { + "POTENTIAL_ISSUE_DETECTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "POTENTIAL_ISSUE_DETECTED" + } + }, + "NO_ISSUE_DETECTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NO_ISSUE_DETECTED" } - ] + } } }, "com.amazonaws.lookoutequipment#StopInferenceScheduler": { @@ -4548,54 +5114,74 @@ } }, "com.amazonaws.lookoutequipment#TargetSamplingRate": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "PT1S", - "name": "PT1S" - }, - { - "value": "PT5S", - "name": "PT5S" - }, - { - "value": "PT10S", - "name": "PT10S" - }, - { - "value": "PT15S", - "name": "PT15S" - }, - { - "value": "PT30S", - "name": "PT30S" - }, - { - "value": "PT1M", - "name": "PT1M" - }, - { - "value": "PT5M", - "name": "PT5M" - }, - { - "value": "PT10M", - "name": "PT10M" - }, - { - "value": "PT15M", - "name": "PT15M" - }, - { - "value": "PT30M", - "name": "PT30M" - }, - { - "value": "PT1H", - "name": "PT1H" + "type": "enum", + "members": { + "PT1S": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PT1S" + } + }, + "PT5S": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PT5S" + } + }, + "PT10S": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PT10S" } - ] + }, + "PT15S": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PT15S" + } + }, + "PT30S": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PT30S" + } + }, + "PT1M": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PT1M" + } + }, + "PT5M": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PT5M" + } + }, + "PT10M": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PT10M" + } + }, + "PT15M": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PT15M" + } + }, + "PT30M": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PT30M" + } + }, + "PT1H": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PT1H" + } + } } }, "com.amazonaws.lookoutequipment#ThrottlingException": { diff --git a/codegen/sdk-codegen/aws-models/medialive.json b/codegen/sdk-codegen/aws-models/medialive.json index 60c0af83aab..48975796079 100644 --- a/codegen/sdk-codegen/aws-models/medialive.json +++ b/codegen/sdk-codegen/aws-models/medialive.json @@ -956,6 +956,22 @@ "smithy.api#documentation": "Audio Description Language Code Control" } }, + "com.amazonaws.medialive#AudioDolbyEDecode": { + "type": "structure", + "members": { + "ProgramSelection": { + "target": "com.amazonaws.medialive#DolbyEProgramSelection", + "traits": { + "smithy.api#documentation": "Applies only to Dolby E. Enter the program ID (according to the metadata in the audio) of the Dolby E program to extract from the specified track. One program extracted per audio selector. To select multiple programs, create multiple selectors with the same Track and different Program numbers. “All channels” means to ignore the program IDs and include all the channels in this selector; useful if metadata is known to be incorrect.", + "smithy.api#jsonName": "programSelection", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Audio Dolby EDecode" + } + }, "com.amazonaws.medialive#AudioHlsRenditionSelection": { "type": "structure", "members": { @@ -1298,6 +1314,13 @@ "smithy.api#jsonName": "tracks", "smithy.api#required": {} } + }, + "DolbyEDecode": { + "target": "com.amazonaws.medialive#AudioDolbyEDecode", + "traits": { + "smithy.api#documentation": "Configure decoding options for Dolby E streams - these should be Dolby E frames carried in PCM streams tagged with SMPTE-337", + "smithy.api#jsonName": "dolbyEDecode" + } } }, "traits": { @@ -6750,11 +6773,73 @@ "smithy.api#documentation": "The status of software on the input device." } }, + "com.amazonaws.medialive#DolbyEProgramSelection": { + "type": "enum", + "members": { + "ALL_CHANNELS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALL_CHANNELS" + } + }, + "PROGRAM_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PROGRAM_1" + } + }, + "PROGRAM_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PROGRAM_2" + } + }, + "PROGRAM_3": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PROGRAM_3" + } + }, + "PROGRAM_4": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PROGRAM_4" + } + }, + "PROGRAM_5": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PROGRAM_5" + } + }, + "PROGRAM_6": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PROGRAM_6" + } + }, + "PROGRAM_7": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PROGRAM_7" + } + }, + "PROGRAM_8": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PROGRAM_8" + } + } + }, + "traits": { + "smithy.api#documentation": "Dolby EProgram Selection" + } + }, "com.amazonaws.medialive#DolbyVision81Settings": { "type": "structure", "members": {}, "traits": { - "smithy.api#documentation": "Dolby Vision Profile 8.1 Settings" + "smithy.api#documentation": "Dolby Vision81 Settings" } }, "com.amazonaws.medialive#DvbNitSettings": { @@ -8252,7 +8337,7 @@ "PasswordParam": { "target": "com.amazonaws.medialive#__string", "traits": { - "smithy.api#documentation": "Password if credentials are required to access the POIS endpoint. This is a reference to an AWS parameter store name from which the password can be retrieved. AWS Parameter store format: \"ssm://Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If you don’t specify a client token, the AWS SDK automatically generates a\n client token and uses it for the request to ensure idempotency.
", + "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If you don’t specify a client token, the Amazon Web Services SDK automatically\n generates a client token and uses it for the request to ensure idempotency.
", "smithy.api#httpHeader": "X-Amz-Client-Token", "smithy.api#idempotencyToken": {} } @@ -109,7 +109,7 @@ } }, "traits": { - "smithy.api#documentation": "You are not authorized to perform this operation. Check your IAM policies, and ensure\n that you are using the correct access keys.
", + "smithy.api#documentation": "You are not authorized to perform this operation. Check your IAM\n policies, and ensure that you are using the correct access keys.
", "smithy.api#error": "client", "smithy.api#httpError": 403 } @@ -180,7 +180,7 @@ "directoryId": { "target": "com.amazonaws.nimble#DirectoryId", "traits": { - "smithy.api#documentation": "The directory ID of the Directory Service for Microsoft Active Directory to access\n using this studio component.
" + "smithy.api#documentation": "The directory ID of the Directory Service for Microsoft Active Directory to access using this studio\n component.
" } }, "organizationalUnitDistinguishedName": { @@ -191,7 +191,7 @@ } }, "traits": { - "smithy.api#documentation": "The configuration for a Microsoft Active Directory (Microsoft AD) studio\n resource.
" + "smithy.api#documentation": "The configuration for a Directory Service for Microsoft Active Directory studio resource.
" } }, "com.amazonaws.nimble#ActiveDirectoryDnsIpAddress": { @@ -219,6 +219,23 @@ } } }, + "com.amazonaws.nimble#AutomaticTerminationMode": { + "type": "enum", + "members": { + "DEACTIVATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEACTIVATED" + } + }, + "ACTIVATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVATED" + } + } + } + }, "com.amazonaws.nimble#ClientToken": { "type": "string", "traits": { @@ -337,7 +354,7 @@ "target": "com.amazonaws.nimble#ClientToken", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, - "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If you don’t specify a client token, the AWS SDK automatically generates a\n client token and uses it for the request to ensure idempotency.
", + "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If you don’t specify a client token, the Amazon Web Services SDK automatically\n generates a client token and uses it for the request to ensure idempotency.
", "smithy.api#httpHeader": "X-Amz-Client-Token", "smithy.api#idempotencyToken": {} } @@ -397,7 +414,7 @@ "tags": { "target": "com.amazonaws.nimble#Tags", "traits": { - "smithy.api#documentation": "A collection of labels, in the form of key:value pairs, that apply to this\n resource.
" + "smithy.api#documentation": "A collection of labels, in the form of key-value pairs, that apply to this\n resource.
" } } }, @@ -483,7 +500,7 @@ "target": "com.amazonaws.nimble#ClientToken", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, - "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If you don’t specify a client token, the AWS SDK automatically generates a\n client token and uses it for the request to ensure idempotency.
", + "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If you don’t specify a client token, the Amazon Web Services SDK automatically\n generates a client token and uses it for the request to ensure idempotency.
", "smithy.api#httpHeader": "X-Amz-Client-Token", "smithy.api#idempotencyToken": {} } @@ -521,7 +538,7 @@ "target": "com.amazonaws.nimble#Tags", "traits": { "aws.cloudformation#cfnMutability": "create-and-read", - "smithy.api#documentation": "A collection of labels, in the form of key:value pairs, that apply to this\n resource.
" + "smithy.api#documentation": "A collection of labels, in the form of key-value pairs, that apply to this\n resource.
" } } }, @@ -592,7 +609,7 @@ "nimble:GetLaunchProfile", "nimble:ListEulaAcceptances" ], - "smithy.api#documentation": "Creates a streaming session in a studio.
\nAfter invoking this operation, you must poll GetStreamingSession until the streaming\n session is in state READY.
", + "smithy.api#documentation": "Creates a streaming session in a studio.
\nAfter invoking this operation, you must poll GetStreamingSession until the streaming\n session is in the READY state.
Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If you don’t specify a client token, the AWS SDK automatically generates a\n client token and uses it for the request to ensure idempotency.
", + "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If you don’t specify a client token, the Amazon Web Services SDK automatically\n generates a client token and uses it for the request to ensure idempotency.
", "smithy.api#httpHeader": "X-Amz-Client-Token", "smithy.api#idempotencyToken": {} } @@ -620,7 +637,8 @@ "launchProfileId": { "target": "com.amazonaws.nimble#String", "traits": { - "smithy.api#documentation": "The launch profile ID.
" + "smithy.api#documentation": "The ID of the launch profile used to control access from the streaming session.
", + "smithy.api#required": {} } }, "ownedBy": { @@ -646,7 +664,7 @@ "tags": { "target": "com.amazonaws.nimble#Tags", "traits": { - "smithy.api#documentation": "A collection of labels, in the form of key:value pairs, that apply to this\n resource.
" + "smithy.api#documentation": "A collection of labels, in the form of key-value pairs, that apply to this\n resource.
" } } }, @@ -709,7 +727,7 @@ "aws.iam#conditionKeys": [ "nimble:requesterPrincipalId" ], - "smithy.api#documentation": "Creates a streaming session stream for a streaming session.
\nAfter invoking this API, invoke GetStreamingSessionStream with the returned streamId\n to poll the resource until it is in state READY.
", + "smithy.api#documentation": "Creates a streaming session stream for a streaming session.
\nAfter invoking this API, invoke GetStreamingSessionStream with the returned streamId\n to poll the resource until it is in the READY state.
Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If you don’t specify a client token, the AWS SDK automatically generates a\n client token and uses it for the request to ensure idempotency.
", + "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If you don’t specify a client token, the Amazon Web Services SDK automatically\n generates a client token and uses it for the request to ensure idempotency.
", "smithy.api#httpHeader": "X-Amz-Client-Token", "smithy.api#idempotencyToken": {} } @@ -732,7 +750,7 @@ "expirationInSeconds": { "target": "com.amazonaws.nimble#StreamingSessionStreamExpirationInSeconds", "traits": { - "smithy.api#default": 0, + "smithy.api#default": 120, "smithy.api#documentation": "The expiration time in seconds.
" } }, @@ -817,7 +835,7 @@ "sso:CreateManagedApplicationInstance", "iam:PassRole" ], - "smithy.api#documentation": "Create a new Studio.
\nWhen creating a Studio, two IAM roles must be provided: the admin role and the user\n Role. These roles are assumed by your users when they log in to the Nimble Studio\n portal.
\nThe user role must have the AmazonNimbleStudio-StudioUser managed policy attached for\n the portal to function properly.
\nThe Admin Role must have the AmazonNimbleStudio-StudioAdmin managed policy attached\n for the portal to function properly.
\nYou may optionally specify a KMS key in the StudioEncryptionConfiguration.
\nIn Nimble Studio, resource names, descriptions, initialization scripts, and other\n data you provide are always encrypted at rest using an KMS key. By default, this key is\n owned by Amazon Web Services and managed on your behalf. You may provide your own KMS\n key when calling CreateStudio to encrypt this data using a key you own and\n manage.
\nWhen providing an KMS key during studio creation, Nimble Studio creates KMS\n grants in your account to provide your studio user and admin roles access to these KMS\n keys.
\nIf you delete this grant, the studio will no longer be accessible to your portal\n users.
\nIf you delete the studio KMS key, your studio will no longer be accessible.
", + "smithy.api#documentation": "Create a new studio.
\nWhen creating a studio, two IAM roles must be provided: the admin role\n and the user role. These roles are assumed by your users when they log in to the Nimble Studio portal.
\nThe user role must have the AmazonNimbleStudio-StudioUser managed policy\n attached for the portal to function properly.
The admin role must have the AmazonNimbleStudio-StudioAdmin managed\n policy attached for the portal to function properly.
You may optionally specify a KMS key in the\n StudioEncryptionConfiguration.
In Nimble Studio, resource names, descriptions, initialization scripts, and other\n data you provide are always encrypted at rest using an KMS key. By default, this key is\n owned by Amazon Web Services and managed on your behalf. You may provide your own KMS key\n when calling CreateStudio to encrypt this data using a key you own and\n manage.
When providing an KMS key during studio creation, Nimble Studio creates KMS\n grants in your account to provide your studio user and admin roles access to these KMS\n keys.
\nIf you delete this grant, the studio will no longer be accessible to your portal\n users.
\nIf you delete the studio KMS key, your studio will no longer be accessible.
", "smithy.api#http": { "method": "POST", "uri": "/2020-08-01/studios", @@ -883,7 +901,7 @@ "target": "com.amazonaws.nimble#ClientToken", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, - "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If you don’t specify a client token, the AWS SDK automatically generates a\n client token and uses it for the request to ensure idempotency.
", + "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If you don’t specify a client token, the Amazon Web Services SDK automatically\n generates a client token and uses it for the request to ensure idempotency.
", "smithy.api#httpHeader": "X-Amz-Client-Token", "smithy.api#idempotencyToken": {} } @@ -945,7 +963,7 @@ "target": "com.amazonaws.nimble#Tags", "traits": { "aws.cloudformation#cfnMutability": "create-and-read", - "smithy.api#documentation": "A collection of labels, in the form of key:value pairs, that apply to this\n resource.
" + "smithy.api#documentation": "A collection of labels, in the form of key-value pairs, that apply to this\n resource.
" } }, "type": { @@ -959,14 +977,14 @@ "target": "com.amazonaws.nimble#RoleArn", "traits": { "aws.cloudformation#cfnMutability": "full", - "smithy.api#documentation": "An IAM role attached to Studio Component when the system initialization script runs which give the studio component access to AWS resources when the system initialization script runs.
" + "smithy.api#documentation": "An IAM role attached to Studio Component when the system initialization\n script runs which give the studio component access to Amazon Web Services resources when\n the system initialization script runs.
" } }, "runtimeRoleArn": { "target": "com.amazonaws.nimble#RoleArn", "traits": { "aws.cloudformation#cfnMutability": "full", - "smithy.api#documentation": "An IAM role attached to a Studio Component that gives the studio component access to AWS resources at anytime while the instance is running.
" + "smithy.api#documentation": "An IAM role attached to a Studio Component that gives the studio\n component access to Amazon Web Services resources at anytime while the instance is\n running.
" } } }, @@ -999,7 +1017,7 @@ "adminRoleArn": { "target": "com.amazonaws.nimble#RoleArn", "traits": { - "smithy.api#documentation": "The IAM role that Studio Admins will assume when logging in to the Nimble Studio\n portal.
", + "smithy.api#documentation": "The IAM role that studio admins will assume when logging in to the\n Nimble Studio portal.
", "smithy.api#required": {} } }, @@ -1007,7 +1025,7 @@ "target": "com.amazonaws.nimble#ClientToken", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, - "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If you don’t specify a client token, the AWS SDK automatically generates a\n client token and uses it for the request to ensure idempotency.
", + "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If you don’t specify a client token, the Amazon Web Services SDK automatically\n generates a client token and uses it for the request to ensure idempotency.
", "smithy.api#httpHeader": "X-Amz-Client-Token", "smithy.api#idempotencyToken": {} } @@ -1037,14 +1055,14 @@ "tags": { "target": "com.amazonaws.nimble#Tags", "traits": { - "smithy.api#documentation": "A collection of labels, in the form of key:value pairs, that apply to this\n resource.
" + "smithy.api#documentation": "A collection of labels, in the form of key-value pairs, that apply to this\n resource.
" } }, "userRoleArn": { "target": "com.amazonaws.nimble#RoleArn", "traits": { "aws.cloudformation#cfnMutability": "full", - "smithy.api#documentation": "The IAM role that Studio Users will assume when logging in to the Nimble Studio\n portal.
", + "smithy.api#documentation": "The IAM role that studio users will assume when logging in to the\n Nimble Studio portal.
", "smithy.api#required": {} } } @@ -1157,7 +1175,7 @@ "clientToken": { "target": "com.amazonaws.nimble#ClientToken", "traits": { - "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If you don’t specify a client token, the AWS SDK automatically generates a\n client token and uses it for the request to ensure idempotency.
", + "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If you don’t specify a client token, the Amazon Web Services SDK automatically\n generates a client token and uses it for the request to ensure idempotency.
", "smithy.api#httpHeader": "X-Amz-Client-Token", "smithy.api#idempotencyToken": {} } @@ -1165,7 +1183,7 @@ "launchProfileId": { "target": "com.amazonaws.nimble#String", "traits": { - "smithy.api#documentation": "The Launch Profile ID.
", + "smithy.api#documentation": "The ID of the launch profile used to control access from the streaming session.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1205,7 +1223,7 @@ "target": "com.amazonaws.nimble#ClientToken", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, - "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If you don’t specify a client token, the AWS SDK automatically generates a\n client token and uses it for the request to ensure idempotency.
", + "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If you don’t specify a client token, the Amazon Web Services SDK automatically\n generates a client token and uses it for the request to ensure idempotency.
", "smithy.api#httpHeader": "X-Amz-Client-Token", "smithy.api#idempotencyToken": {} } @@ -1213,7 +1231,7 @@ "launchProfileId": { "target": "com.amazonaws.nimble#String", "traits": { - "smithy.api#documentation": "The Launch Profile ID.
", + "smithy.api#documentation": "The ID of the launch profile used to control access from the streaming session.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1300,7 +1318,7 @@ "target": "com.amazonaws.nimble#ClientToken", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, - "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If you don’t specify a client token, the AWS SDK automatically generates a\n client token and uses it for the request to ensure idempotency.
", + "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If you don’t specify a client token, the Amazon Web Services SDK automatically\n generates a client token and uses it for the request to ensure idempotency.
", "smithy.api#httpHeader": "X-Amz-Client-Token", "smithy.api#idempotencyToken": {} } @@ -1379,7 +1397,7 @@ "aws.iam#requiredActions": [ "ec2:DeleteNetworkInterface" ], - "smithy.api#documentation": "Deletes streaming session resource.
\nAfter invoking this operation, use GetStreamingSession to poll the resource until it\n transitions to a DELETED state.
\nA streaming session will count against your streaming session quota until it is marked\n DELETED.
", + "smithy.api#documentation": "Deletes streaming session resource.
\nAfter invoking this operation, use GetStreamingSession to poll the resource until it\n transitions to a DELETED state.
A streaming session will count against your streaming session quota until it is marked\n DELETED.
Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If you don’t specify a client token, the AWS SDK automatically generates a\n client token and uses it for the request to ensure idempotency.
", + "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If you don’t specify a client token, the Amazon Web Services SDK automatically\n generates a client token and uses it for the request to ensure idempotency.
", "smithy.api#httpHeader": "X-Amz-Client-Token", "smithy.api#idempotencyToken": {} } @@ -1528,7 +1546,7 @@ "target": "com.amazonaws.nimble#ClientToken", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, - "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If you don’t specify a client token, the AWS SDK automatically generates a\n client token and uses it for the request to ensure idempotency.
", + "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If you don’t specify a client token, the Amazon Web Services SDK automatically\n generates a client token and uses it for the request to ensure idempotency.
", "smithy.api#httpHeader": "X-Amz-Client-Token", "smithy.api#idempotencyToken": {} } @@ -1616,7 +1634,7 @@ "clientToken": { "target": "com.amazonaws.nimble#ClientToken", "traits": { - "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If you don’t specify a client token, the AWS SDK automatically generates a\n client token and uses it for the request to ensure idempotency.
", + "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If you don’t specify a client token, the Amazon Web Services SDK automatically\n generates a client token and uses it for the request to ensure idempotency.
", "smithy.api#httpHeader": "X-Amz-Client-Token", "smithy.api#idempotencyToken": {} } @@ -1655,7 +1673,7 @@ "clientToken": { "target": "com.amazonaws.nimble#ClientToken", "traits": { - "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If you don’t specify a client token, the AWS SDK automatically generates a\n client token and uses it for the request to ensure idempotency.
", + "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If you don’t specify a client token, the Amazon Web Services SDK automatically\n generates a client token and uses it for the request to ensure idempotency.
", "smithy.api#httpHeader": "X-Amz-Client-Token", "smithy.api#idempotencyToken": {} } @@ -1724,7 +1742,7 @@ "createdAt": { "target": "com.amazonaws.nimble#Timestamp", "traits": { - "smithy.api#documentation": "The Unix epoch timestamp in seconds for when the resource was created.
" + "smithy.api#documentation": "The ISO timestamp in seconds for when the resource was created.
" } }, "eulaId": { @@ -1742,7 +1760,7 @@ "updatedAt": { "target": "com.amazonaws.nimble#Timestamp", "traits": { - "smithy.api#documentation": "The Unix epoch timestamp in seconds for when the resource was updated.
" + "smithy.api#documentation": "The ISO timestamp in seconds for when the resource was updated.
" } } }, @@ -1756,7 +1774,7 @@ "acceptedAt": { "target": "com.amazonaws.nimble#Timestamp", "traits": { - "smithy.api#documentation": "The Unix epoch timestamp in seconds for when the EULA was accepted.
" + "smithy.api#documentation": "The ISO timestamp in seconds for when the EULA was accepted.
" } }, "acceptedBy": { @@ -1905,7 +1923,7 @@ "target": "com.amazonaws.nimble#String" }, "traits": { - "smithy.api#documentation": "ExceptionContext is a set of key-value pairs that provide you with more information\n about the error that occurred. For example, when the service returns a 404\n ResourceNotFound error, ExceptionContext will contain the key `resourceId` with the\n value of resource that was not found.
\nExceptionContext enables scripts and other programmatic clients to provide for better\n error handling.
" + "smithy.api#documentation": "ExceptionContext is a set of key-value pairs that provide you with more information\n about the error that occurred. For example, when the service returns a 404\n ResourceNotFound error, ExceptionContext will contain the key `resourceId` with the\n value of resource that was not found.
\n\n ExceptionContext allows scripts and other programmatic clients to provide\n better error handling.
Get Eula.
", + "smithy.api#documentation": "Get EULA.
", "smithy.api#http": { "method": "GET", "uri": "/2020-08-01/eulas/{eulaId}", @@ -2136,7 +2154,7 @@ "launchProfileId": { "target": "com.amazonaws.nimble#String", "traits": { - "smithy.api#documentation": "The Launch Profile ID.
", + "smithy.api#documentation": "The ID of the launch profile used to control access from the streaming session.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2233,7 +2251,7 @@ "launchProfileId": { "target": "com.amazonaws.nimble#String", "traits": { - "smithy.api#documentation": "The Launch Profile ID.
", + "smithy.api#documentation": "The ID of the launch profile used to control access from the streaming session.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2257,7 +2275,7 @@ "platform": { "target": "com.amazonaws.nimble#String", "traits": { - "smithy.api#documentation": "The platform where this Launch Profile will be used, either WINDOWS or LINUX.
", + "smithy.api#documentation": "The platform where this Launch Profile will be used, either Windows or Linux.
", "smithy.api#httpQuery": "platform", "smithy.api#required": {} } @@ -2337,7 +2355,7 @@ "launchProfileId": { "target": "com.amazonaws.nimble#String", "traits": { - "smithy.api#documentation": "The Launch Profile ID.
", + "smithy.api#documentation": "The ID of the launch profile used to control access from the streaming session.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2383,7 +2401,7 @@ "launchProfileId": { "target": "com.amazonaws.nimble#String", "traits": { - "smithy.api#documentation": "The Launch Profile ID.
", + "smithy.api#documentation": "The ID of the launch profile used to control access from the streaming session.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2697,6 +2715,86 @@ } } }, + "com.amazonaws.nimble#GetStreamingSessionBackup": { + "type": "operation", + "input": { + "target": "com.amazonaws.nimble#GetStreamingSessionBackupRequest" + }, + "output": { + "target": "com.amazonaws.nimble#GetStreamingSessionBackupResponse" + }, + "errors": [ + { + "target": "com.amazonaws.nimble#AccessDeniedException" + }, + { + "target": "com.amazonaws.nimble#ConflictException" + }, + { + "target": "com.amazonaws.nimble#InternalServerErrorException" + }, + { + "target": "com.amazonaws.nimble#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.nimble#ThrottlingException" + }, + { + "target": "com.amazonaws.nimble#ValidationException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to get a streaming session backup", + "aws.iam#conditionKeys": [ + "nimble:requesterPrincipalId" + ], + "smithy.api#documentation": "Gets StreamingSessionBackup resource.
Invoke this operation to poll for a streaming session backup while stopping a\n streaming session.
", + "smithy.api#http": { + "method": "GET", + "uri": "/2020-08-01/studios/{studioId}/streaming-session-backups/{backupId}", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.nimble#GetStreamingSessionBackupRequest": { + "type": "structure", + "members": { + "backupId": { + "target": "com.amazonaws.nimble#String", + "traits": { + "smithy.api#documentation": "The ID of the backup.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "studioId": { + "target": "com.amazonaws.nimble#String", + "traits": { + "smithy.api#documentation": "The studio ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.nimble#GetStreamingSessionBackupResponse": { + "type": "structure", + "members": { + "streamingSessionBackup": { + "target": "com.amazonaws.nimble#StreamingSessionBackup", + "traits": { + "smithy.api#documentation": "Information about the streaming session backup.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.nimble#GetStreamingSessionRequest": { "type": "structure", "members": { @@ -2771,7 +2869,7 @@ "aws.iam#conditionKeys": [ "nimble:requesterPrincipalId" ], - "smithy.api#documentation": "Gets a StreamingSessionStream for a streaming session.
\nInvoke this operation to poll the resource after invoking\n CreateStreamingSessionStream.
\nAfter the StreamingSessionStream changes to the state READY, the url property will\n contain a stream to be used with the DCV streaming client.
", + "smithy.api#documentation": "Gets a StreamingSessionStream for a streaming session.
\nInvoke this operation to poll the resource after invoking\n CreateStreamingSessionStream.
After the StreamingSessionStream changes to the READY state,\n the url property will contain a stream to be used with the DCV streaming client.
Get a Studio resource.
", + "smithy.api#documentation": "Get a studio resource.
", "smithy.api#http": { "method": "GET", "uri": "/2020-08-01/studios/{studioId}", @@ -3252,14 +3350,14 @@ "target": "com.amazonaws.nimble#String", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, - "smithy.api#documentation": "The ARN of the resource.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely\n identifies it. ARNs are unique across all Regions.
" } }, "createdAt": { "target": "com.amazonaws.nimble#Timestamp", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, - "smithy.api#documentation": "The Unix epoch timestamp in seconds for when the resource was created.
" + "smithy.api#documentation": "The ISO timestamp in seconds for when the resource was created.
" } }, "createdBy": { @@ -3286,7 +3384,7 @@ "launchProfileId": { "target": "com.amazonaws.nimble#LaunchProfileId", "traits": { - "smithy.api#documentation": "The launch profile ID.
" + "smithy.api#documentation": "The ID of the launch profile used to control access from the streaming session.
" } }, "launchProfileProtocolVersions": { @@ -3342,14 +3440,14 @@ "target": "com.amazonaws.nimble#Tags", "traits": { "aws.cloudformation#cfnMutability": "create-and-read", - "smithy.api#documentation": "A collection of labels, in the form of key:value pairs, that apply to this\n resource.
" + "smithy.api#documentation": "A collection of labels, in the form of key-value pairs, that apply to this\n resource.
" } }, "updatedAt": { "target": "com.amazonaws.nimble#Timestamp", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, - "smithy.api#documentation": "The Unix epoch timestamp in seconds for when the resource was updated.
" + "smithy.api#documentation": "The ISO timestamp in seconds for when the resource was updated.
" } }, "updatedBy": { @@ -3368,7 +3466,7 @@ } }, "traits": { - "smithy.api#documentation": "A launch profile controls your artist workforce’s access to studio components, like\n compute farms, shared file systems, managed file systems, and license server\n configurations, as well as instance types and Amazon Machine Images (AMIs).
\n\nStudio administrators create launch profiles in the Nimble Studio console.\n Artists can use their launch profiles to launch an instance from the Nimble Studio\n portal. Each user’s launch profile defines how they can launch a streaming session. By\n default, studio admins can use all launch profiles.
" + "smithy.api#documentation": "A launch profile controls your artist workforce’s access to studio components, like\n compute farms, shared file systems, managed file systems, and license server\n configurations, as well as instance types and Amazon Machine Images (AMIs).
\nStudio administrators create launch profiles in the Nimble Studio console.\n Artists can use their launch profiles to launch an instance from the Nimble Studio\n portal. Each user’s launch profile defines how they can launch a streaming session. By\n default, studio admins can use all launch profiles.
" } }, "com.amazonaws.nimble#LaunchProfileDescription": { @@ -3398,7 +3496,7 @@ "activeDirectory": { "target": "com.amazonaws.nimble#LaunchProfileInitializationActiveDirectory", "traits": { - "smithy.api#documentation": "A LaunchProfileInitializationActiveDirectory resource.
" + "smithy.api#documentation": "A LaunchProfileInitializationActiveDirectory resource.
The launch profile ID.
" + "smithy.api#documentation": "The ID of the launch profile used to control access from the streaming session.
" } }, "launchProfileProtocolVersion": { @@ -3434,7 +3532,7 @@ "platform": { "target": "com.amazonaws.nimble#LaunchProfilePlatform", "traits": { - "smithy.api#documentation": "The platform of the launch platform, either WINDOWS or LINUX.
" + "smithy.api#documentation": "The platform of the launch platform, either Windows or Linux.
" } }, "systemInitializationScripts": { @@ -3451,7 +3549,7 @@ } }, "traits": { - "smithy.api#documentation": "A Launch Profile Initialization contains information required for a workstation or\n server to connect to a launch profile.
\nThis includes scripts, endpoints, security groups, subnets, and other\n configuration.
" + "smithy.api#documentation": "A launch profile initialization contains information required for a workstation or\n server to connect to a launch profile.
\nThis includes scripts, endpoints, security groups, subnets, and other\n configuration.
" } }, "com.amazonaws.nimble#LaunchProfileInitializationActiveDirectory": { @@ -3466,7 +3564,7 @@ "directoryId": { "target": "com.amazonaws.nimble#DirectoryId", "traits": { - "smithy.api#documentation": "The directory ID of the Directory Service for Microsoft Active Directory to access\n using this launch profile.
" + "smithy.api#documentation": "The directory ID of the Directory Service for Microsoft Active Directory to access using this launch\n profile.
" } }, "directoryName": { @@ -3501,7 +3599,7 @@ } }, "traits": { - "smithy.api#documentation": "The Launch Profile Initialization Active Directory contains information required for\n the launch profile to connect to the Active Directory.
" + "smithy.api#documentation": "The launch profile initialization Active Directory contains information required for\n the launch profile to connect to the Active Directory.
" } }, "com.amazonaws.nimble#LaunchProfileInitializationScript": { @@ -3528,18 +3626,18 @@ "secureInitializationRoleArn": { "target": "com.amazonaws.nimble#RoleArn", "traits": { - "smithy.api#documentation": "An IAM role attached to Studio Component when the system initialization script runs which give the studio component access to AWS resources when the system initialization script runs.
" + "smithy.api#documentation": "An IAM role attached to Studio Component when the system initialization\n script runs which give the studio component access to Amazon Web Services resources when\n the system initialization script runs.
" } }, "runtimeRoleArn": { "target": "com.amazonaws.nimble#RoleArn", "traits": { - "smithy.api#documentation": "An IAM role attached to a Studio Component that gives the studio component access to AWS resources at anytime while the instance is running.
" + "smithy.api#documentation": "An IAM role attached to a Studio Component that gives the studio\n component access to Amazon Web Services resources at anytime while the instance is\n running.
" } } }, "traits": { - "smithy.api#documentation": "The Launch Profile Initialization Script is used when start streaming session\n runs.
" + "smithy.api#documentation": "The launch profile initialization script is used when start streaming session\n runs.
" } }, "com.amazonaws.nimble#LaunchProfileInitializationScriptList": { @@ -3583,7 +3681,7 @@ } }, "traits": { - "smithy.api#documentation": "Launch profile membership enables your studio admins to delegate launch profile access\n to other studio users in the Nimble Studio portal without needing to write or\n maintain complex IAM policies. A launch profile member is a user association from your\n studio identity source who is granted permissions to a launch profile.
\nA launch profile member (type USER) provides the following permissions to that launch\n profile:
\nGetLaunchProfile
\nGetLaunchProfileInitialization
\nGetLaunchProfileMembers
\nGetLaunchProfileMember
\nCreateStreamingSession
\nGetLaunchProfileDetails
\nStudio admins can use launch profile membership to delegate launch profile access to\n studio users in the Nimble Studio portal without writing or maintaining complex\n IAM policies. A launch profile member is a user association from your\n studio identity source who is granted permissions to a launch profile.
\nA launch profile member (type USER) provides the following permissions to that launch\n profile:
\nGetLaunchProfile
\nGetLaunchProfileInitialization
\nGetLaunchProfileMembers
\nGetLaunchProfileMember
\nCreateStreamingSession
\nGetLaunchProfileDetails
\nList Eula Acceptances.
", + "smithy.api#documentation": "List EULA acceptances.
", "smithy.api#http": { "method": "GET", "uri": "/2020-08-01/studios/{studioId}/eula-acceptances", @@ -4049,7 +4221,7 @@ "nextToken": { "target": "com.amazonaws.nimble#String", "traits": { - "smithy.api#documentation": "The token to request the next page of results.
", + "smithy.api#documentation": "The token for the next set of results, or null if there are no more results.
", "smithy.api#httpQuery": "nextToken" } }, @@ -4119,7 +4291,7 @@ ], "traits": { "aws.iam#actionPermissionDescription": "Grants permission to list EULAs", - "smithy.api#documentation": "List Eulas.
", + "smithy.api#documentation": "List EULAs.
", "smithy.api#http": { "method": "GET", "uri": "/2020-08-01/eulas", @@ -4146,7 +4318,7 @@ "nextToken": { "target": "com.amazonaws.nimble#String", "traits": { - "smithy.api#documentation": "The token to request the next page of results.
", + "smithy.api#documentation": "The token for the next set of results, or null if there are no more results.
", "smithy.api#httpQuery": "nextToken" } } @@ -4229,7 +4401,7 @@ "launchProfileId": { "target": "com.amazonaws.nimble#String", "traits": { - "smithy.api#documentation": "The Launch Profile ID.
", + "smithy.api#documentation": "The ID of the launch profile used to control access from the streaming session.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4237,7 +4409,7 @@ "maxResults": { "target": "com.amazonaws.nimble#MaxResults", "traits": { - "smithy.api#default": 0, + "smithy.api#default": 100, "smithy.api#documentation": "The max number of results to return in the response.
", "smithy.api#httpQuery": "maxResults" } @@ -4245,7 +4417,7 @@ "nextToken": { "target": "com.amazonaws.nimble#String", "traits": { - "smithy.api#documentation": "The token to request the next page of results.
", + "smithy.api#documentation": "The token for the next set of results, or null if there are no more results.
", "smithy.api#httpQuery": "nextToken" } }, @@ -4340,7 +4512,7 @@ "maxResults": { "target": "com.amazonaws.nimble#MaxResults", "traits": { - "smithy.api#default": 0, + "smithy.api#default": 100, "smithy.api#documentation": "The max number of results to return in the response.
", "smithy.api#httpQuery": "maxResults" } @@ -4348,7 +4520,7 @@ "nextToken": { "target": "com.amazonaws.nimble#String", "traits": { - "smithy.api#documentation": "The token to request the next page of results.
", + "smithy.api#documentation": "The token for the next set of results, or null if there are no more results.
", "smithy.api#httpQuery": "nextToken" } }, @@ -4452,7 +4624,7 @@ "nextToken": { "target": "com.amazonaws.nimble#String", "traits": { - "smithy.api#documentation": "The token to request the next page of results.
", + "smithy.api#documentation": "The token for the next set of results, or null if there are no more results.
", "smithy.api#httpQuery": "nextToken" } }, @@ -4496,6 +4668,104 @@ "smithy.api#output": {} } }, + "com.amazonaws.nimble#ListStreamingSessionBackups": { + "type": "operation", + "input": { + "target": "com.amazonaws.nimble#ListStreamingSessionBackupsRequest" + }, + "output": { + "target": "com.amazonaws.nimble#ListStreamingSessionBackupsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.nimble#AccessDeniedException" + }, + { + "target": "com.amazonaws.nimble#ConflictException" + }, + { + "target": "com.amazonaws.nimble#InternalServerErrorException" + }, + { + "target": "com.amazonaws.nimble#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.nimble#ThrottlingException" + }, + { + "target": "com.amazonaws.nimble#ValidationException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to list streaming session backups", + "aws.iam#conditionKeys": [ + "nimble:ownedBy", + "nimble:requesterPrincipalId" + ], + "smithy.api#documentation": "Lists the backups of a streaming session in a studio.
", + "smithy.api#http": { + "method": "GET", + "uri": "/2020-08-01/studios/{studioId}/streaming-session-backups", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "streamingSessionBackups" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.nimble#ListStreamingSessionBackupsRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.nimble#String", + "traits": { + "smithy.api#documentation": "The token for the next set of results, or null if there are no more results.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "ownedBy": { + "target": "com.amazonaws.nimble#String", + "traits": { + "smithy.api#documentation": "The user ID of the user that owns the streaming session.
", + "smithy.api#httpQuery": "ownedBy" + } + }, + "studioId": { + "target": "com.amazonaws.nimble#String", + "traits": { + "smithy.api#documentation": "The studio ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.nimble#ListStreamingSessionBackupsResponse": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.nimble#String", + "traits": { + "smithy.api#documentation": "The token for the next set of results, or null if there are no more results.
" + } + }, + "streamingSessionBackups": { + "target": "com.amazonaws.nimble#StreamingSessionBackupList", + "traits": { + "smithy.api#documentation": "Information about the streaming session backups.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.nimble#ListStreamingSessions": { "type": "operation", "input": { @@ -4561,7 +4831,7 @@ "nextToken": { "target": "com.amazonaws.nimble#String", "traits": { - "smithy.api#documentation": "The token to request the next page of results.
", + "smithy.api#documentation": "The token for the next set of results, or null if there are no more results.
", "smithy.api#httpQuery": "nextToken" } }, @@ -4645,7 +4915,7 @@ ], "traits": { "aws.iam#actionPermissionDescription": "Grants permission to list studio components", - "smithy.api#documentation": "Lists the StudioComponents in a studio.
", + "smithy.api#documentation": "Lists the StudioComponents in a studio.
The max number of results to return in the response.
", "smithy.api#httpQuery": "maxResults" } @@ -4674,7 +4944,7 @@ "nextToken": { "target": "com.amazonaws.nimble#String", "traits": { - "smithy.api#documentation": "The token to request the next page of results.
", + "smithy.api#documentation": "The token for the next set of results, or null if there are no more results.
", "smithy.api#httpQuery": "nextToken" } }, @@ -4779,7 +5049,7 @@ "maxResults": { "target": "com.amazonaws.nimble#MaxResults", "traits": { - "smithy.api#default": 0, + "smithy.api#default": 100, "smithy.api#documentation": "The max number of results to return in the response.
", "smithy.api#httpQuery": "maxResults" } @@ -4787,7 +5057,7 @@ "nextToken": { "target": "com.amazonaws.nimble#String", "traits": { - "smithy.api#documentation": "The token to request the next page of results.
", + "smithy.api#documentation": "The token for the next set of results, or null if there are no more results.
", "smithy.api#httpQuery": "nextToken" } }, @@ -4857,7 +5127,7 @@ ], "traits": { "aws.iam#actionPermissionDescription": "Grants permission to list studios", - "smithy.api#documentation": "List studios in your Amazon Web Services account in the requested Amazon Web Services\n Region.
", + "smithy.api#documentation": "List studios in your Amazon Web Services accounts in the requested Amazon Web Services Region.
", "smithy.api#http": { "method": "GET", "uri": "/2020-08-01/studios", @@ -4877,7 +5147,7 @@ "nextToken": { "target": "com.amazonaws.nimble#String", "traits": { - "smithy.api#documentation": "The token to request the next page of results.
", + "smithy.api#documentation": "The token for the next set of results, or null if there are no more results.
", "smithy.api#httpQuery": "nextToken" } } @@ -5003,7 +5273,7 @@ "tags": { "target": "com.amazonaws.nimble#Tags", "traits": { - "smithy.api#documentation": "A collection of labels, in the form of key:value pairs, that apply to this\n resource.
" + "smithy.api#documentation": "A collection of labels, in the form of key-value pairs, that apply to this\n resource.
" } } }, @@ -5014,7 +5284,7 @@ "com.amazonaws.nimble#MaxResults": { "type": "integer", "traits": { - "smithy.api#default": 0, + "smithy.api#default": 100, "smithy.api#range": { "min": 1, "max": 100 @@ -5139,7 +5409,7 @@ "clientToken": { "target": "com.amazonaws.nimble#ClientToken", "traits": { - "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If you don’t specify a client token, the AWS SDK automatically generates a\n client token and uses it for the request to ensure idempotency.
", + "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If you don’t specify a client token, the Amazon Web Services SDK automatically\n generates a client token and uses it for the request to ensure idempotency.
", "smithy.api#httpHeader": "X-Amz-Client-Token", "smithy.api#idempotencyToken": {} } @@ -5154,7 +5424,7 @@ "launchProfileId": { "target": "com.amazonaws.nimble#String", "traits": { - "smithy.api#documentation": "The Launch Profile ID.
", + "smithy.api#documentation": "The ID of the launch profile used to control access from the streaming session.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5236,7 +5506,7 @@ "clientToken": { "target": "com.amazonaws.nimble#ClientToken", "traits": { - "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If you don’t specify a client token, the AWS SDK automatically generates a\n client token and uses it for the request to ensure idempotency.
", + "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If you don’t specify a client token, the Amazon Web Services SDK automatically\n generates a client token and uses it for the request to ensure idempotency.
", "smithy.api#httpHeader": "X-Amz-Client-Token", "smithy.api#idempotencyToken": {} } @@ -5350,7 +5620,7 @@ } }, "traits": { - "smithy.api#documentation": "A parameter for a studio component script, in the form of a key:value pair.
" + "smithy.api#documentation": "A parameter for a studio component script, in the form of a key-value pair.
" } }, "com.amazonaws.nimble#ScriptParameterValue": { @@ -5395,11 +5665,45 @@ } }, "traits": { - "smithy.api#documentation": "Your current quota does not allow you to perform the request action. You can request\n increases for some quotas, and other quotas cannot be increased.
\nPlease use AWS Service Quotas to request an increase.
", + "smithy.api#documentation": "Your current quota does not allow you to perform the request action. You can request\n increases for some quotas, and other quotas cannot be increased.
\nPlease use Amazon Web Services Service Quotas to request an increase.
", "smithy.api#error": "client", "smithy.api#httpError": 402 } }, + "com.amazonaws.nimble#SessionBackupMode": { + "type": "enum", + "members": { + "AUTOMATIC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUTOMATIC" + } + }, + "DEACTIVATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEACTIVATED" + } + } + } + }, + "com.amazonaws.nimble#SessionPersistenceMode": { + "type": "enum", + "members": { + "DEACTIVATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEACTIVATED" + } + }, + "ACTIVATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVATED" + } + } + } + }, "com.amazonaws.nimble#SharedFileSystemConfiguration": { "type": "structure", "members": { @@ -5478,7 +5782,7 @@ "nimble:GetLaunchProfile", "nimble:GetLaunchProfileMember" ], - "smithy.api#documentation": "Transitions sessions from the STOPPED state into the READY state. The\n START_IN_PROGRESS state is the intermediate state between the STOPPED and READY\n states.
", + "smithy.api#documentation": "Transitions sessions from the STOPPED state into the READY\n state. The START_IN_PROGRESS state is the intermediate state between the\n STOPPED and READY states.
Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If you don’t specify a client token, the AWS SDK automatically generates a\n client token and uses it for the request to ensure idempotency.
", + "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If you don’t specify a client token, the Amazon Web Services SDK automatically\n generates a client token and uses it for the request to ensure idempotency.
", "smithy.api#httpHeader": "X-Amz-Client-Token", "smithy.api#idempotencyToken": {} } @@ -5501,7 +5805,7 @@ "sessionId": { "target": "com.amazonaws.nimble#String", "traits": { - "smithy.api#documentation": "The streaming session ID for the StartStreamingSessionRequest.
", + "smithy.api#documentation": "The streaming session ID for the StartStreamingSessionRequest.
The ID of the backup.
" + } } }, "traits": { @@ -5567,7 +5877,7 @@ "sso:CreateManagedApplicationInstance", "sso:GetManagedApplicationInstance" ], - "smithy.api#documentation": "Repairs the IAM Identity Center configuration for a given studio.
\nIf the studio has a valid IAM Identity Center configuration currently associated with\n it, this operation will fail with a validation error.
\nIf the studio does not have a valid IAM Identity Center configuration currently\n associated with it, then a new IAM Identity Center application is created for the studio\n and the studio is changed to the READY state.
\nAfter the IAM Identity Center application is repaired, you must use the Amazon Nimble Studio console to add administrators and users to your studio.
", + "smithy.api#documentation": "Repairs the IAM Identity Center configuration for a given studio.
\nIf the studio has a valid IAM Identity Center configuration currently associated with\n it, this operation will fail with a validation error.
\nIf the studio does not have a valid IAM Identity Center configuration currently\n associated with it, then a new IAM Identity Center application is created for the studio\n and the studio is changed to the READY state.
After the IAM Identity Center application is repaired, you must use the Amazon Nimble Studio console to add administrators and users to your studio.
", "smithy.api#http": { "method": "PUT", "uri": "/2020-08-01/studios/{studioId}/sso-configuration", @@ -5582,7 +5892,7 @@ "clientToken": { "target": "com.amazonaws.nimble#ClientToken", "traits": { - "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If you don’t specify a client token, the AWS SDK automatically generates a\n client token and uses it for the request to ensure idempotency.
", + "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If you don’t specify a client token, the Amazon Web Services SDK automatically\n generates a client token and uses it for the request to ensure idempotency.
", "smithy.api#httpHeader": "X-Amz-Client-Token", "smithy.api#idempotencyToken": {} } @@ -5654,7 +5964,7 @@ "aws.iam#requiredActions": [ "nimble:GetLaunchProfile" ], - "smithy.api#documentation": "Transitions sessions from the READY state into the STOPPED state. The STOP_IN_PROGRESS\n state is the intermediate state between the READY and STOPPED states.
", + "smithy.api#documentation": "Transitions sessions from the READY state into the STOPPED\n state. The STOP_IN_PROGRESS state is the intermediate state between the\n READY and STOPPED states.
Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If you don’t specify a client token, the AWS SDK automatically generates a\n client token and uses it for the request to ensure idempotency.
", + "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If you don’t specify a client token, the Amazon Web Services SDK automatically\n generates a client token and uses it for the request to ensure idempotency.
", "smithy.api#httpHeader": "X-Amz-Client-Token", "smithy.api#idempotencyToken": {} } @@ -5677,7 +5987,7 @@ "sessionId": { "target": "com.amazonaws.nimble#String", "traits": { - "smithy.api#documentation": "The streaming session ID for the StopStreamingSessionRequest.
", + "smithy.api#documentation": "The streaming session ID for the StopStreamingSessionRequest.
Adds additional instructions to a streaming session stop action to either retain the\n EBS volumes or delete the EBS volumes.
" + } } }, "traits": { @@ -5712,7 +6028,7 @@ "clipboardMode": { "target": "com.amazonaws.nimble#StreamingClipboardMode", "traits": { - "smithy.api#documentation": "Enable or disable the use of the system clipboard to copy and paste between the\n streaming session and streaming client.
", + "smithy.api#documentation": "Allows or deactivates the use of the system clipboard to copy and paste between the\n streaming session and streaming client.
", "smithy.api#required": {} } }, @@ -5726,7 +6042,7 @@ "maxSessionLengthInMinutes": { "target": "com.amazonaws.nimble#StreamConfigurationMaxSessionLengthInMinutes", "traits": { - "smithy.api#default": 0, + "smithy.api#default": 690, "smithy.api#documentation": "The length of time, in minutes, that a streaming session can be active before it is\n stopped or terminated. After this point, Nimble Studio automatically terminates or\n stops the session. The default length of time is 690 minutes, and the maximum length of\n time is 30 days.
" } }, @@ -5741,13 +6057,37 @@ "target": "com.amazonaws.nimble#StreamConfigurationMaxStoppedSessionLengthInMinutes", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "Integer that determines if you can start and stop your sessions and how long a session\n can stay in the STOPPED state. The default value is 0. The maximum value is 5760.
\nIf the value is missing or set to 0, your sessions can’t be stopped. If you then call\n StopStreamingSession, the session fails. If the time that a session\n stays in the READY state exceeds the maxSessionLengthInMinutes value, the\n session will automatically be terminated (instead of stopped).
If the value is set to a positive number, the session can be stopped. You can call\n StopStreamingSession to stop sessions in the READY state. If the time\n that a session stays in the READY state exceeds the\n maxSessionLengthInMinutes value, the session will automatically be\n stopped (instead of terminated).
Integer that determines if you can start and stop your sessions and how long a session\n can stay in the STOPPED state. The default value is 0. The maximum value is\n 5760.
This field is allowed only when sessionPersistenceMode is\n ACTIVATED and automaticTerminationMode is\n ACTIVATED.
If the value is set to 0, your sessions can’t be STOPPED. If you then\n call StopStreamingSession, the session fails. If the time that a session\n stays in the READY state exceeds the maxSessionLengthInMinutes\n value, the session will automatically be terminated (instead of\n STOPPED).
If the value is set to a positive number, the session can be stopped. You can call\n StopStreamingSession to stop sessions in the READY state.\n If the time that a session stays in the READY state exceeds the\n maxSessionLengthInMinutes value, the session will automatically be\n stopped (instead of terminated).
(Optional) The upload storage for a streaming session.
" + "smithy.api#documentation": "The upload storage for a streaming session.
" + } + }, + "sessionBackup": { + "target": "com.amazonaws.nimble#StreamConfigurationSessionBackup", + "traits": { + "smithy.api#documentation": "Information about the streaming session backup.
" + } + }, + "sessionPersistenceMode": { + "target": "com.amazonaws.nimble#SessionPersistenceMode", + "traits": { + "smithy.api#documentation": "Determine if a streaming session created from this launch profile can configure\n persistent storage. This means that volumeConfiguration and\n automaticTerminationMode are configured.
Custom volume configuration for the root volumes that are attached to streaming\n sessions.
\nThis parameter is only allowed when sessionPersistenceMode is\n ACTIVATED.
Indicates if a streaming session created from this launch profile should be terminated\n automatically or retained without termination after being in a STOPPED\n state.
When ACTIVATED, the streaming session is scheduled for\n termination after being in the STOPPED state for the time specified\n in maxStoppedSessionLengthInMinutes.
When DEACTIVATED, the streaming session can remain in the\n STOPPED state indefinitely.
This parameter is only allowed when sessionPersistenceMode is\n ACTIVATED. When allowed, the default value for this parameter is\n DEACTIVATED.
Enable or disable the use of the system clipboard to copy and paste between the\n streaming session and streaming client.
", + "smithy.api#documentation": "Allows or deactivates the use of the system clipboard to copy and paste between the\n streaming session and streaming client.
", "smithy.api#required": {} } }, @@ -5775,7 +6115,7 @@ "maxSessionLengthInMinutes": { "target": "com.amazonaws.nimble#StreamConfigurationMaxSessionLengthInMinutes", "traits": { - "smithy.api#default": 0, + "smithy.api#default": 690, "smithy.api#documentation": "The length of time, in minutes, that a streaming session can be active before it is\n stopped or terminated. After this point, Nimble Studio automatically terminates or\n stops the session. The default length of time is 690 minutes, and the maximum length of\n time is 30 days.
" } }, @@ -5790,13 +6130,37 @@ "target": "com.amazonaws.nimble#StreamConfigurationMaxStoppedSessionLengthInMinutes", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "Integer that determines if you can start and stop your sessions and how long a session\n can stay in the STOPPED state. The default value is 0. The maximum value is 5760.
\nIf the value is missing or set to 0, your sessions can’t be stopped. If you then call\n StopStreamingSession, the session fails. If the time that a session\n stays in the READY state exceeds the maxSessionLengthInMinutes value, the\n session will automatically be terminated (instead of stopped).
If the value is set to a positive number, the session can be stopped. You can call\n StopStreamingSession to stop sessions in the READY state. If the time\n that a session stays in the READY state exceeds the\n maxSessionLengthInMinutes value, the session will automatically be\n stopped (instead of terminated).
Integer that determines if you can start and stop your sessions and how long a session\n can stay in the STOPPED state. The default value is 0. The maximum value is\n 5760.
This field is allowed only when sessionPersistenceMode is\n ACTIVATED and automaticTerminationMode is\n ACTIVATED.
If the value is set to 0, your sessions can’t be STOPPED. If you then\n call StopStreamingSession, the session fails. If the time that a session\n stays in the READY state exceeds the maxSessionLengthInMinutes\n value, the session will automatically be terminated (instead of\n STOPPED).
If the value is set to a positive number, the session can be stopped. You can call\n StopStreamingSession to stop sessions in the READY state.\n If the time that a session stays in the READY state exceeds the\n maxSessionLengthInMinutes value, the session will automatically be\n stopped (instead of terminated).
(Optional) The upload storage for a streaming workstation that is created using this\n launch profile.
" + "smithy.api#documentation": "The upload storage for a streaming workstation that is created using this launch\n profile.
" + } + }, + "sessionBackup": { + "target": "com.amazonaws.nimble#StreamConfigurationSessionBackup", + "traits": { + "smithy.api#documentation": "Configures how streaming sessions are backed up when launched from this launch\n profile.
" + } + }, + "sessionPersistenceMode": { + "target": "com.amazonaws.nimble#SessionPersistenceMode", + "traits": { + "smithy.api#documentation": "Determine if a streaming session created from this launch profile can configure\n persistent storage. This means that volumeConfiguration and\n automaticTerminationMode are configured.
Custom volume configuration for the root volumes that are attached to streaming\n sessions.
\nThis parameter is only allowed when sessionPersistenceMode is\n ACTIVATED.
Indicates if a streaming session created from this launch profile should be terminated\n automatically or retained without termination after being in a STOPPED\n state.
When ACTIVATED, the streaming session is scheduled for\n termination after being in the STOPPED state for the time specified\n in maxStoppedSessionLengthInMinutes.
When DEACTIVATED, the streaming session can remain in the\n STOPPED state indefinitely.
This parameter is only allowed when sessionPersistenceMode is\n ACTIVATED. When allowed, the default value for this parameter is\n DEACTIVATED.
Configuration for streaming workstations created using this launch profile.
" } }, - "com.amazonaws.nimble#StreamConfigurationMaxSessionLengthInMinutes": { + "com.amazonaws.nimble#StreamConfigurationMaxBackupsToRetain": { "type": "integer", "traits": { "smithy.api#default": 0, + "smithy.api#range": { + "min": 0, + "max": 10 + } + } + }, + "com.amazonaws.nimble#StreamConfigurationMaxSessionLengthInMinutes": { + "type": "integer", + "traits": { + "smithy.api#default": 690, "smithy.api#range": { "min": 1, "max": 43200 @@ -5824,6 +6198,27 @@ } } }, + "com.amazonaws.nimble#StreamConfigurationSessionBackup": { + "type": "structure", + "members": { + "mode": { + "target": "com.amazonaws.nimble#SessionBackupMode", + "traits": { + "smithy.api#documentation": "Specifies how artists sessions are backed up.
\nConfigures backups for streaming sessions launched with this launch profile. The\n default value is DEACTIVATED, which means that backups are deactivated. To\n allow backups, set this value to AUTOMATIC.
The maximum number of backups that each streaming session created from this launch\n profile can have.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Configures how streaming sessions are backed up when launched from this launch\n profile.
" + } + }, "com.amazonaws.nimble#StreamConfigurationSessionStorage": { "type": "structure", "members": { @@ -5846,18 +6241,20 @@ } }, "com.amazonaws.nimble#StreamingClipboardMode": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ENABLED", - "name": "ENABLED" - }, - { - "value": "DISABLED", - "name": "DISABLED" + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" } - ] + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } } }, "com.amazonaws.nimble#StreamingImage": { @@ -5867,7 +6264,7 @@ "target": "com.amazonaws.nimble#String", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, - "smithy.api#documentation": "The ARN of the resource.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely\n identifies it. ARNs are unique across all Regions.
" } }, "description": { @@ -5909,14 +6306,14 @@ "target": "com.amazonaws.nimble#StreamingImageOwner", "traits": { "aws.cloudformation#cfnMutability": "read", - "smithy.api#documentation": "The owner of the streaming image, either the studioId that contains the streaming\n image, or 'amazon' for images that are provided by Amazon Nimble Studio.
" + "smithy.api#documentation": "The owner of the streaming image, either the studioId that contains the\n streaming image, or amazon for images that are provided by Amazon Nimble Studio.
The platform of the streaming image, either WINDOWS or LINUX.
" + "smithy.api#documentation": "The platform of the streaming image, either Windows or Linux.
" } }, "state": { @@ -5950,12 +6347,12 @@ "tags": { "target": "com.amazonaws.nimble#Tags", "traits": { - "smithy.api#documentation": "A collection of labels, in the form of key:value pairs, that apply to this\n resource.
" + "smithy.api#documentation": "A collection of labels, in the form of key-value pairs, that apply to this\n resource.
" } } }, "traits": { - "smithy.api#documentation": "Represents a streaming image resource.
\nStreaming images are used by studio users to select which operating system and\n software they want to use in a Nimble Studio streaming session.
\nAmazon provides a number of streaming images that include popular 3rd-party\n software.
\nYou can create your own streaming images using an Amazon Elastic Compute Cloud (Amazon\n EC2) machine image that you create for this purpose. You can also include software that\n your users require.
" + "smithy.api#documentation": "Represents a streaming image resource.
\nStreaming images are used by studio users to select which operating system and\n software they want to use in a Nimble Studio streaming session.
\nAmazon provides a number of streaming images that include popular 3rd-party\n software.
\nYou can create your own streaming images using an Amazon EC2 machine image\n that you create for this purpose. You can also include software that your users\n require.
" } }, "com.amazonaws.nimble#StreamingImageDescription": { @@ -6000,14 +6397,14 @@ } }, "com.amazonaws.nimble#StreamingImageEncryptionConfigurationKeyType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "CUSTOMER_MANAGED_KEY", - "name": "CUSTOMER_MANAGED_KEY" + "type": "enum", + "members": { + "CUSTOMER_MANAGED_KEY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CUSTOMER_MANAGED_KEY" } - ] + } } }, "com.amazonaws.nimble#StreamingImageId": { @@ -6053,13 +6450,13 @@ "com.amazonaws.nimble#StreamingImageOwner": { "type": "string", "traits": { - "smithy.api#documentation": "StreamingImageOwner is the owner of a particular streaming image.
\nThis string is either the studioId that contains the streaming image, or the word\n 'AMAZON' for images provided by Nimble Studio.
" + "smithy.api#documentation": "StreamingImageOwner is the owner of a particular streaming image.
\nThis string is either the studioId that contains the streaming image, or the word\n AMAZON for images provided by Nimble Studio.
The platform of this Streaming Image, either WINDOWS or LINUX.
", + "smithy.api#documentation": "The platform of this streaming image, either Windows or Linux.
", "smithy.api#pattern": "^[a-zA-Z]*$" } }, @@ -6112,140 +6509,189 @@ } }, "com.amazonaws.nimble#StreamingImageState": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "CREATE_IN_PROGRESS", - "name": "CREATE_IN_PROGRESS" - }, - { - "value": "READY", - "name": "READY" - }, - { - "value": "DELETE_IN_PROGRESS", - "name": "DELETE_IN_PROGRESS" - }, - { - "value": "DELETED", - "name": "DELETED" - }, - { - "value": "UPDATE_IN_PROGRESS", - "name": "UPDATE_IN_PROGRESS" - }, - { - "value": "UPDATE_FAILED", - "name": "UPDATE_FAILED" - }, - { - "value": "CREATE_FAILED", - "name": "CREATE_FAILED" - }, - { - "value": "DELETE_FAILED", - "name": "DELETE_FAILED" + "type": "enum", + "members": { + "CREATE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_IN_PROGRESS" } - ] + }, + "READY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "READY" + } + }, + "DELETE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_IN_PROGRESS" + } + }, + "DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETED" + } + }, + "UPDATE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATE_IN_PROGRESS" + } + }, + "UPDATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATE_FAILED" + } + }, + "CREATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_FAILED" + } + }, + "DELETE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_FAILED" + } + } } }, "com.amazonaws.nimble#StreamingImageStatusCode": { - "type": "string", - "traits": { - "smithy.api#documentation": "The status code.
", - "smithy.api#enum": [ - { - "value": "STREAMING_IMAGE_CREATE_IN_PROGRESS", - "name": "STREAMING_IMAGE_CREATE_IN_PROGRESS" - }, - { - "value": "STREAMING_IMAGE_READY", - "name": "STREAMING_IMAGE_READY" - }, - { - "value": "STREAMING_IMAGE_DELETE_IN_PROGRESS", - "name": "STREAMING_IMAGE_DELETE_IN_PROGRESS" - }, - { - "value": "STREAMING_IMAGE_DELETED", - "name": "STREAMING_IMAGE_DELETED" - }, - { - "value": "STREAMING_IMAGE_UPDATE_IN_PROGRESS", - "name": "STREAMING_IMAGE_UPDATE_IN_PROGRESS" - }, - { - "value": "INTERNAL_ERROR", - "name": "INTERNAL_ERROR" - }, - { - "value": "ACCESS_DENIED", - "name": "ACCESS_DENIED" + "type": "enum", + "members": { + "STREAMING_IMAGE_CREATE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STREAMING_IMAGE_CREATE_IN_PROGRESS" } - ] + }, + "STREAMING_IMAGE_READY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STREAMING_IMAGE_READY" + } + }, + "STREAMING_IMAGE_DELETE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STREAMING_IMAGE_DELETE_IN_PROGRESS" + } + }, + "STREAMING_IMAGE_DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STREAMING_IMAGE_DELETED" + } + }, + "STREAMING_IMAGE_UPDATE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STREAMING_IMAGE_UPDATE_IN_PROGRESS" + } + }, + "INTERNAL_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INTERNAL_ERROR" + } + }, + "ACCESS_DENIED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACCESS_DENIED" + } + } + }, + "traits": { + "smithy.api#documentation": "The status code.
" } }, "com.amazonaws.nimble#StreamingInstanceType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "g4dn.xlarge", - "name": "g4dn_xlarge" - }, - { - "value": "g4dn.2xlarge", - "name": "g4dn_2xlarge" - }, - { - "value": "g4dn.4xlarge", - "name": "g4dn_4xlarge" - }, - { - "value": "g4dn.8xlarge", - "name": "g4dn_8xlarge" - }, - { - "value": "g4dn.12xlarge", - "name": "g4dn_12xlarge" - }, - { - "value": "g4dn.16xlarge", - "name": "g4dn_16xlarge" - }, - { - "value": "g3.4xlarge", - "name": "g3_4xlarge" - }, - { - "value": "g3s.xlarge", - "name": "g3s_xlarge" - }, - { - "value": "g5.xlarge", - "name": "g5_xlarge" - }, - { - "value": "g5.2xlarge", - "name": "g5_2xlarge" - }, - { - "value": "g5.4xlarge", - "name": "g5_4xlarge" - }, - { - "value": "g5.8xlarge", - "name": "g5_8xlarge" - }, - { - "value": "g5.16xlarge", - "name": "g5_16xlarge" + "type": "enum", + "members": { + "g4dn_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "g4dn.xlarge" } - ], - "smithy.api#suppress": [ - "EnumTrait" - ] + }, + "g4dn_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "g4dn.2xlarge" + } + }, + "g4dn_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "g4dn.4xlarge" + } + }, + "g4dn_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "g4dn.8xlarge" + } + }, + "g4dn_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "g4dn.12xlarge" + } + }, + "g4dn_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "g4dn.16xlarge" + } + }, + "g3_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "g3.4xlarge" + } + }, + "g3s_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "g3s.xlarge" + } + }, + "g5_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "g5.xlarge" + } + }, + "g5_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "g5.2xlarge" + } + }, + "g5_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "g5.4xlarge" + } + }, + "g5_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "g5.8xlarge" + } + }, + "g5_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "g5.16xlarge" + } + } } }, "com.amazonaws.nimble#StreamingInstanceTypeList": { @@ -6267,13 +6713,13 @@ "arn": { "target": "com.amazonaws.nimble#String", "traits": { - "smithy.api#documentation": "The ARN of the resource.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely\n identifies it. ARNs are unique across all Regions.
" } }, "createdAt": { "target": "com.amazonaws.nimble#Timestamp", "traits": { - "smithy.api#documentation": "The Unix epoch timestamp in seconds for when the resource was created.
" + "smithy.api#documentation": "The ISO timestamp in seconds for when the resource was created.
" } }, "createdBy": { @@ -6333,7 +6779,7 @@ "tags": { "target": "com.amazonaws.nimble#Tags", "traits": { - "smithy.api#documentation": "A collection of labels, in the form of key:value pairs, that apply to this\n resource.
" + "smithy.api#documentation": "A collection of labels, in the form of key-value pairs, that apply to this\n resource.
" } }, "terminateAt": { @@ -6345,7 +6791,7 @@ "updatedAt": { "target": "com.amazonaws.nimble#Timestamp", "traits": { - "smithy.api#documentation": "The Unix epoch timestamp in seconds for when the resource was updated.
" + "smithy.api#documentation": "The ISO timestamp in seconds for when the resource was updated.
" } }, "updatedBy": { @@ -6357,7 +6803,7 @@ "stoppedAt": { "target": "com.amazonaws.nimble#Timestamp", "traits": { - "smithy.api#documentation": "The time the session entered STOP_IN_PROGRESS state.
" + "smithy.api#documentation": "The time the session entered STOP_IN_PROGRESS state.
The time the session entered START_IN_PROGRESS state.
" + "smithy.api#documentation": "The time the session entered START_IN_PROGRESS state.
The time the streaming session will automatically be stopped if the user doesn’t stop\n the session themselves.
" } + }, + "startedFromBackupId": { + "target": "com.amazonaws.nimble#String", + "traits": { + "smithy.api#documentation": "The backup ID used to restore a streaming session.
" + } + }, + "backupMode": { + "target": "com.amazonaws.nimble#SessionBackupMode", + "traits": { + "smithy.api#documentation": "Shows the current backup setting of the session.
" + } + }, + "maxBackupsToRetain": { + "target": "com.amazonaws.nimble#StreamConfigurationMaxBackupsToRetain", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The maximum number of backups of a streaming session that you can have. When the\n maximum number of backups is reached, the oldest backup is deleted.
" + } + }, + "volumeRetentionMode": { + "target": "com.amazonaws.nimble#VolumeRetentionMode", + "traits": { + "smithy.api#documentation": "Determine if an EBS volume created from this streaming session will be backed\n up.
" + } + }, + "sessionPersistenceMode": { + "target": "com.amazonaws.nimble#SessionPersistenceMode", + "traits": { + "smithy.api#documentation": "Determine if a streaming session created from this launch profile can configure\n persistent storage. This means that volumeConfiguration and\n automaticTerminationMode are configured.
Custom volume configuration for the root volumes that are attached to streaming\n sessions.
\nThis parameter is only allowed when sessionPersistenceMode is\n ACTIVATED.
Indicates if a streaming session created from this launch profile should be terminated\n automatically or retained without termination after being in a STOPPED\n state.
When ACTIVATED, the streaming session is scheduled for\n termination after being in the STOPPED state for the time specified\n in maxStoppedSessionLengthInMinutes.
When DEACTIVATED, the streaming session can remain in the\n STOPPED state indefinitely.
This parameter is only allowed when sessionPersistenceMode is\n ACTIVATED. When allowed, the default value for this parameter is\n DEACTIVATED.
A streaming session is a virtual workstation created using a particular launch\n profile.
" } }, + "com.amazonaws.nimble#StreamingSessionBackup": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.nimble#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely\n identifies it. ARNs are unique across all Regions.
" + } + }, + "createdAt": { + "target": "com.amazonaws.nimble#Timestamp", + "traits": { + "smithy.api#documentation": "The ISO timestamp in for when the resource was created.
" + } + }, + "launchProfileId": { + "target": "com.amazonaws.nimble#String", + "traits": { + "smithy.api#documentation": "The ID of the launch profile which allowed the backups for the streaming\n session.
" + } + }, + "ownedBy": { + "target": "com.amazonaws.nimble#String", + "traits": { + "smithy.api#documentation": "The user ID of the user that owns the streaming session.
" + } + }, + "sessionId": { + "target": "com.amazonaws.nimble#StreamingSessionId", + "traits": { + "smithy.api#documentation": "The streaming session ID for the StreamingSessionBackup.
The status code.
" + } + }, + "statusMessage": { + "target": "com.amazonaws.nimble#String", + "traits": { + "smithy.api#documentation": "The status message for the streaming session backup.
" + } + }, + "backupId": { + "target": "com.amazonaws.nimble#String", + "traits": { + "smithy.api#documentation": "The ID of the backup.
" + } + }, + "tags": { + "target": "com.amazonaws.nimble#Tags", + "traits": { + "smithy.api#documentation": "A collection of labels, in the form of key-value pairs, that apply to this\n resource.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about the streaming session backup.
" + } + }, + "com.amazonaws.nimble#StreamingSessionBackupList": { + "type": "list", + "member": { + "target": "com.amazonaws.nimble#StreamingSessionBackup" + } + }, + "com.amazonaws.nimble#StreamingSessionBackupResource": { + "type": "resource", + "identifiers": { + "backupId": { + "target": "com.amazonaws.nimble#String" + } + }, + "read": { + "target": "com.amazonaws.nimble#GetStreamingSessionBackup" + }, + "list": { + "target": "com.amazonaws.nimble#ListStreamingSessionBackups" + }, + "traits": { + "aws.api#arn": { + "template": "streaming-session-backup/{backupId}" + }, + "aws.iam#conditionKeys": [ + "aws:ResourceTag/${TagKey}", + "nimble:ownedBy" + ], + "aws.iam#disableConditionKeyInference": {}, + "smithy.api#documentation": "Represents a streaming session backup originated from a studio user launched streaming session" + } + }, "com.amazonaws.nimble#StreamingSessionId": { "type": "string" }, @@ -6449,137 +7034,189 @@ } }, "com.amazonaws.nimble#StreamingSessionState": { - "type": "string", - "traits": { - "smithy.api#documentation": "The streaming session state.
", - "smithy.api#enum": [ - { - "value": "CREATE_IN_PROGRESS", - "name": "CREATE_IN_PROGRESS" - }, - { - "value": "DELETE_IN_PROGRESS", - "name": "DELETE_IN_PROGRESS" - }, - { - "value": "READY", - "name": "READY" - }, - { - "value": "DELETED", - "name": "DELETED" - }, - { - "value": "CREATE_FAILED", - "name": "CREATE_FAILED" - }, - { - "value": "DELETE_FAILED", - "name": "DELETE_FAILED" - }, - { - "value": "STOP_IN_PROGRESS", - "name": "STOP_IN_PROGRESS" - }, - { - "value": "START_IN_PROGRESS", - "name": "START_IN_PROGRESS" - }, - { - "value": "STOPPED", - "name": "STOPPED" - }, - { - "value": "STOP_FAILED", - "name": "STOP_FAILED" - }, - { - "value": "START_FAILED", - "name": "START_FAILED" + "type": "enum", + "members": { + "CREATE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_IN_PROGRESS" } - ] + }, + "DELETE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_IN_PROGRESS" + } + }, + "READY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "READY" + } + }, + "DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETED" + } + }, + "CREATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_FAILED" + } + }, + "DELETE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_FAILED" + } + }, + "STOP_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STOP_IN_PROGRESS" + } + }, + "START_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "START_IN_PROGRESS" + } + }, + "STOPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STOPPED" + } + }, + "STOP_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STOP_FAILED" + } + }, + "START_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "START_FAILED" + } + } + }, + "traits": { + "smithy.api#documentation": "The streaming session state.
" } }, "com.amazonaws.nimble#StreamingSessionStatusCode": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "STREAMING_SESSION_READY", - "name": "STREAMING_SESSION_READY" - }, - { - "value": "STREAMING_SESSION_DELETED", - "name": "STREAMING_SESSION_DELETED" - }, - { - "value": "STREAMING_SESSION_CREATE_IN_PROGRESS", - "name": "STREAMING_SESSION_CREATE_IN_PROGRESS" - }, - { - "value": "STREAMING_SESSION_DELETE_IN_PROGRESS", - "name": "STREAMING_SESSION_DELETE_IN_PROGRESS" - }, - { - "value": "INTERNAL_ERROR", - "name": "INTERNAL_ERROR" - }, - { - "value": "INSUFFICIENT_CAPACITY", - "name": "INSUFFICIENT_CAPACITY" - }, - { - "value": "ACTIVE_DIRECTORY_DOMAIN_JOIN_ERROR", - "name": "ACTIVE_DIRECTORY_DOMAIN_JOIN_ERROR" - }, - { - "value": "NETWORK_CONNECTION_ERROR", - "name": "NETWORK_CONNECTION_ERROR" - }, - { - "value": "INITIALIZATION_SCRIPT_ERROR", - "name": "INITIALIZATION_SCRIPT_ERROR" - }, - { - "value": "DECRYPT_STREAMING_IMAGE_ERROR", - "name": "DECRYPT_STREAMING_IMAGE_ERROR" - }, - { - "value": "NETWORK_INTERFACE_ERROR", - "name": "NETWORK_INTERFACE_ERROR" - }, - { - "value": "STREAMING_SESSION_STOPPED", - "name": "STREAMING_SESSION_STOPPED" - }, - { - "value": "STREAMING_SESSION_STARTED", - "name": "STREAMING_SESSION_STARTED" - }, - { - "value": "STREAMING_SESSION_STOP_IN_PROGRESS", - "name": "STREAMING_SESSION_STOP_IN_PROGRESS" - }, - { - "value": "STREAMING_SESSION_START_IN_PROGRESS", - "name": "STREAMING_SESSION_START_IN_PROGRESS" - }, - { - "value": "AMI_VALIDATION_ERROR", - "name": "AMI_VALIDATION_ERROR" + "type": "enum", + "members": { + "STREAMING_SESSION_READY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STREAMING_SESSION_READY" } - ] + }, + "STREAMING_SESSION_DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STREAMING_SESSION_DELETED" + } + }, + "STREAMING_SESSION_CREATE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STREAMING_SESSION_CREATE_IN_PROGRESS" + } + }, + "STREAMING_SESSION_DELETE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STREAMING_SESSION_DELETE_IN_PROGRESS" + } + }, + "INTERNAL_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INTERNAL_ERROR" + } + }, + "INSUFFICIENT_CAPACITY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INSUFFICIENT_CAPACITY" + } + }, + "ACTIVE_DIRECTORY_DOMAIN_JOIN_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE_DIRECTORY_DOMAIN_JOIN_ERROR" + } + }, + "NETWORK_CONNECTION_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NETWORK_CONNECTION_ERROR" + } + }, + "INITIALIZATION_SCRIPT_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INITIALIZATION_SCRIPT_ERROR" + } + }, + "DECRYPT_STREAMING_IMAGE_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DECRYPT_STREAMING_IMAGE_ERROR" + } + }, + "NETWORK_INTERFACE_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NETWORK_INTERFACE_ERROR" + } + }, + "STREAMING_SESSION_STOPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STREAMING_SESSION_STOPPED" + } + }, + "STREAMING_SESSION_STARTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STREAMING_SESSION_STARTED" + } + }, + "STREAMING_SESSION_STOP_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STREAMING_SESSION_STOP_IN_PROGRESS" + } + }, + "STREAMING_SESSION_START_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STREAMING_SESSION_START_IN_PROGRESS" + } + }, + "AMI_VALIDATION_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AMI_VALIDATION_ERROR" + } + } } }, "com.amazonaws.nimble#StreamingSessionStorageMode": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "UPLOAD", - "name": "UPLOAD" + "type": "enum", + "members": { + "UPLOAD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPLOAD" } - ] + } } }, "com.amazonaws.nimble#StreamingSessionStorageModeList": { @@ -6641,7 +7278,7 @@ "createdAt": { "target": "com.amazonaws.nimble#Timestamp", "traits": { - "smithy.api#documentation": "The Unix epoch timestamp in seconds for when the resource was created.
" + "smithy.api#documentation": "The ISO timestamp in seconds for when the resource was created.
" } }, "createdBy": { @@ -6653,7 +7290,7 @@ "expiresAt": { "target": "com.amazonaws.nimble#Timestamp", "traits": { - "smithy.api#documentation": "The Unix epoch timestamp in seconds for when the resource expires.
" + "smithy.api#documentation": "The ISO timestamp in seconds for when the resource expires.
" } }, "ownedBy": { @@ -6694,7 +7331,7 @@ "com.amazonaws.nimble#StreamingSessionStreamExpirationInSeconds": { "type": "integer", "traits": { - "smithy.api#default": 0, + "smithy.api#default": 120, "smithy.api#range": { "min": 60, "max": 3600 @@ -6702,65 +7339,85 @@ } }, "com.amazonaws.nimble#StreamingSessionStreamState": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "READY", - "name": "READY" - }, - { - "value": "CREATE_IN_PROGRESS", - "name": "CREATE_IN_PROGRESS" - }, - { - "value": "DELETE_IN_PROGRESS", - "name": "DELETE_IN_PROGRESS" - }, - { - "value": "DELETED", - "name": "DELETED" - }, - { - "value": "CREATE_FAILED", - "name": "CREATE_FAILED" - }, - { - "value": "DELETE_FAILED", - "name": "DELETE_FAILED" + "type": "enum", + "members": { + "READY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "READY" } - ] + }, + "CREATE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_IN_PROGRESS" + } + }, + "DELETE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_IN_PROGRESS" + } + }, + "DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETED" + } + }, + "CREATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_FAILED" + } + }, + "DELETE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_FAILED" + } + } } }, "com.amazonaws.nimble#StreamingSessionStreamStatusCode": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "STREAM_CREATE_IN_PROGRESS", - "name": "STREAM_CREATE_IN_PROGRESS" - }, - { - "value": "STREAM_READY", - "name": "STREAM_READY" - }, - { - "value": "STREAM_DELETE_IN_PROGRESS", - "name": "STREAM_DELETE_IN_PROGRESS" - }, - { - "value": "STREAM_DELETED", - "name": "STREAM_DELETED" - }, - { - "value": "INTERNAL_ERROR", - "name": "INTERNAL_ERROR" - }, - { - "value": "NETWORK_CONNECTION_ERROR", - "name": "NETWORK_CONNECTION_ERROR" + "type": "enum", + "members": { + "STREAM_CREATE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STREAM_CREATE_IN_PROGRESS" } - ] + }, + "STREAM_READY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STREAM_READY" + } + }, + "STREAM_DELETE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STREAM_DELETE_IN_PROGRESS" + } + }, + "STREAM_DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STREAM_DELETED" + } + }, + "INTERNAL_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INTERNAL_ERROR" + } + }, + "NETWORK_CONNECTION_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NETWORK_CONNECTION_ERROR" + } + } } }, "com.amazonaws.nimble#String": { @@ -6779,7 +7436,7 @@ "target": "com.amazonaws.nimble#RoleArn", "traits": { "aws.cloudformation#cfnMutability": "full", - "smithy.api#documentation": "The IAM role that studio admins assume when logging in to the Nimble Studio\n portal.
" + "smithy.api#documentation": "The IAM role that studio admins assume when logging in to the Nimble Studio portal.
" } }, "arn": { @@ -6793,7 +7450,7 @@ "target": "com.amazonaws.nimble#Timestamp", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, - "smithy.api#documentation": "The Unix epoch timestamp in seconds for when the resource was created.
" + "smithy.api#documentation": "The ISO timestamp in seconds for when the resource was created.
" } }, "displayName": { @@ -6813,7 +7470,7 @@ "target": "com.amazonaws.nimble#String", "traits": { "aws.cloudformation#cfnMutability": "read", - "smithy.api#documentation": "The IAM Identity Center application client ID used to integrate with IAM Identity Center\n to enable IAM Identity Center users to log in to Nimble Studio portal.
" + "smithy.api#documentation": "The IAM Identity Center application client ID used to integrate with IAM Identity Center. This ID allows IAM Identity Center users to log in to Nimble Studio\n portal.
" } }, "state": { @@ -6867,26 +7524,26 @@ "target": "com.amazonaws.nimble#Tags", "traits": { "aws.cloudformation#cfnMutability": "create-and-read", - "smithy.api#documentation": "A collection of labels, in the form of key:value pairs, that apply to this\n resource.
" + "smithy.api#documentation": "A collection of labels, in the form of key-value pairs, that apply to this\n resource.
" } }, "updatedAt": { "target": "com.amazonaws.nimble#Timestamp", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, - "smithy.api#documentation": "The Unix epoch timestamp in seconds for when the resource was updated.
" + "smithy.api#documentation": "The ISO timestamp in seconds for when the resource was updated.
" } }, "userRoleArn": { "target": "com.amazonaws.nimble#RoleArn", "traits": { "aws.cloudformation#cfnMutability": "full", - "smithy.api#documentation": "The IAM role that studio users assume when logging in to the Nimble Studio\n portal.
" + "smithy.api#documentation": "The IAM role that studio users assume when logging in to the Nimble Studio portal.
" } } }, "traits": { - "smithy.api#documentation": "Represents a studio resource.
\nA studio is the core resource used with Nimble Studio. You must create a studio\n first, before any other resource type can be created. All other resources you create and\n manage in Nimble Studio are contained within a studio.
\nWhen creating a studio, you must provides two IAM roles for use with the Nimble Studio portal. These roles are assumed by your users when they log in to the\n Nimble Studio portal via IAM Identity Center and your identity source.
\nThe user role must have the AmazonNimbleStudio-StudioUser managed policy attached for\n the portal to function properly.
\nThe admin role must have the AmazonNimbleStudio-StudioAdmin managed policy attached\n for the portal to function properly.
\nYour studio roles must trust the identity.nimble.amazonaws.com service principal to\n function properly.
" + "smithy.api#documentation": "Represents a studio resource.
\nA studio is the core resource used with Nimble Studio. You must create a studio\n first, before any other resource type can be created. All other resources you create and\n manage in Nimble Studio are contained within a studio.
\nWhen creating a studio, you must provides two IAM roles for use with\n the Nimble Studio portal. These roles are assumed by your users when they log in to\n the Nimble Studio portal via IAM Identity Center and your identity source.
\nThe user role must have the AmazonNimbleStudio-StudioUser managed policy\n attached for the portal to function properly.
The admin role must have the AmazonNimbleStudio-StudioAdmin managed\n policy attached for the portal to function properly.
Your studio roles must trust the identity.nimble.amazonaws.com service\n principal to function properly.
The ARN of the resource.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely\n identifies it. ARNs are unique across all Regions.
" } }, "configuration": { @@ -6910,7 +7567,7 @@ "target": "com.amazonaws.nimble#Timestamp", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, - "smithy.api#documentation": "The Unix epoch timestamp in seconds for when the resource was created.
" + "smithy.api#documentation": "The ISO timestamp in seconds for when the resource was created.
" } }, "createdBy": { @@ -6992,7 +7649,7 @@ "tags": { "target": "com.amazonaws.nimble#Tags", "traits": { - "smithy.api#documentation": "A collection of labels, in the form of key:value pairs, that apply to this\n resource.
" + "smithy.api#documentation": "A collection of labels, in the form of key-value pairs, that apply to this\n resource.
" } }, "type": { @@ -7006,7 +7663,7 @@ "target": "com.amazonaws.nimble#Timestamp", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, - "smithy.api#documentation": "The Unix epoch timestamp in seconds for when the resource was updated.
" + "smithy.api#documentation": "The ISO timestamp in seconds for when the resource was updated.
" } }, "updatedBy": { @@ -7020,14 +7677,14 @@ "target": "com.amazonaws.nimble#RoleArn", "traits": { "aws.cloudformation#cfnMutability": "full", - "smithy.api#documentation": "An IAM role attached to Studio Component when the system initialization script runs which give the studio component access to AWS resources when the system initialization script runs.
" + "smithy.api#documentation": "An IAM role attached to Studio Component when the system initialization\n script runs which give the studio component access to Amazon Web Services resources when\n the system initialization script runs.
" } }, "runtimeRoleArn": { "target": "com.amazonaws.nimble#RoleArn", "traits": { "aws.cloudformation#cfnMutability": "full", - "smithy.api#documentation": "An IAM role attached to a Studio Component that gives the studio component access to AWS resources at anytime while the instance is running.
" + "smithy.api#documentation": "An IAM role attached to a Studio Component that gives the studio\n component access to Amazon Web Services resources at anytime while the instance is\n running.
" } } }, @@ -7041,7 +7698,7 @@ "activeDirectoryConfiguration": { "target": "com.amazonaws.nimble#ActiveDirectoryConfiguration", "traits": { - "smithy.api#documentation": "The configuration for a Microsoft Active Directory (Microsoft AD) studio\n resource.
" + "smithy.api#documentation": "The configuration for a Directory Service for Microsoft Active Directory studio resource.
" } }, "computeFarmConfiguration": { @@ -7099,7 +7756,7 @@ "platform": { "target": "com.amazonaws.nimble#LaunchProfilePlatform", "traits": { - "smithy.api#documentation": "The platform of the initialization script, either WINDOWS or LINUX.
" + "smithy.api#documentation": "The platform of the initialization script, either Windows or Linux.
" } }, "runContext": { @@ -7136,18 +7793,20 @@ } }, "com.amazonaws.nimble#StudioComponentInitializationScriptRunContext": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "SYSTEM_INITIALIZATION", - "name": "SYSTEM_INITIALIZATION" - }, - { - "value": "USER_INITIALIZATION", - "name": "USER_INITIALIZATION" + "type": "enum", + "members": { + "SYSTEM_INITIALIZATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SYSTEM_INITIALIZATION" } - ] + }, + "USER_INITIALIZATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "USER_INITIALIZATION" + } + } } }, "com.amazonaws.nimble#StudioComponentList": { @@ -7230,59 +7889,75 @@ "min": 0, "max": 30 }, - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.nimble#StudioComponentSecurityGroupIdList": { - "type": "list", - "member": { - "target": "com.amazonaws.nimble#SecurityGroupId" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 30 + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.nimble#StudioComponentSecurityGroupIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.nimble#SecurityGroupId" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 30 + } + } + }, + "com.amazonaws.nimble#StudioComponentState": { + "type": "enum", + "members": { + "CREATE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_IN_PROGRESS" + } + }, + "READY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "READY" + } + }, + "UPDATE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATE_IN_PROGRESS" + } + }, + "DELETE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_IN_PROGRESS" + } + }, + "DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETED" + } + }, + "DELETE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_FAILED" + } + }, + "CREATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_FAILED" + } + }, + "UPDATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATE_FAILED" + } } - } - }, - "com.amazonaws.nimble#StudioComponentState": { - "type": "string", + }, "traits": { - "smithy.api#documentation": "The current state of the studio component resource.
\nWhile a studio component is being created, modified, or deleted, its state will equal\n \"CREATE_IN_PROGRESS\", \"UPDATE_IN_PROGRESS\", or \"DELETE_IN_PROGRESS\"
\nThese are called 'transition states'.
\nNo modifications may be made to the studio component while it is in a transition\n state.
\nIf creation of the resource fails, the state will change to `CREATE_FAILED`. The\n resource StatusCode and StatusMessage will provide more information of why creation\n failed. The resource in this state will automatically be deleted from your account after\n a period of time.
\nIf updating the resource fails, the state will change to `UPDATE_FAILED`. The resource\n StatusCode and StatusMessage will provide more information of why the update failed. The\n resource will be returned to the state it was in when the update request was\n invoked.
\nIf deleting the resource fails, the state will change to `DELETE_FAILED`. The resource\n StatusCode and StatusMessage will provide more information of why the update failed. The\n resource will be returned to the state it was in when the update request was invoked.\n After the resource is deleted successfully, it will change to the \"DELETED\" state. The\n resource will no longer count against service quotas and cannot be used or acted upon\n any futher. It will be removed from your account after a period of time.
", - "smithy.api#enum": [ - { - "value": "CREATE_IN_PROGRESS", - "name": "CREATE_IN_PROGRESS" - }, - { - "value": "READY", - "name": "READY" - }, - { - "value": "UPDATE_IN_PROGRESS", - "name": "UPDATE_IN_PROGRESS" - }, - { - "value": "DELETE_IN_PROGRESS", - "name": "DELETE_IN_PROGRESS" - }, - { - "value": "DELETED", - "name": "DELETED" - }, - { - "value": "DELETE_FAILED", - "name": "DELETE_FAILED" - }, - { - "value": "CREATE_FAILED", - "name": "CREATE_FAILED" - }, - { - "value": "UPDATE_FAILED", - "name": "UPDATE_FAILED" - } - ] + "smithy.api#documentation": "The current state of the studio component resource.
\nWhile a studio component is being created, modified, or deleted, its state will be\n CREATE_IN_PROGRESS, UPDATE_IN_PROGRESS, or\n DELETE_IN_PROGRESS.
These are called transition states.
\nNo modifications may be made to the studio component while it is in a transition\n state.
\nIf creation of the resource fails, the state will change to\n CREATE_FAILED. The resource StatusCode and\n StatusMessage will provide more information of why creation failed. The\n resource in this state will automatically be deleted from your account after a period of\n time.
If updating the resource fails, the state will change to UPDATE_FAILED.\n The resource StatusCode and StatusMessage will provide more\n information of why the update failed. The resource will be returned to the state it was\n in when the update request was invoked.
If deleting the resource fails, the state will change to DELETE_FAILED.\n The resource StatusCode and StatusMessage will provide more\n information of why the update failed. The resource will be returned to the state it was\n in when the update request was invoked. After the resource is deleted successfully, it\n will change to the DELETED state. The resource will no longer count against\n service quotas and cannot be used or acted upon any futher. It will be removed from your\n account after a period of time.
The current status of the studio component resource.
\nWhen the resource is in the 'READY' state, the status code signals what the last\n mutation made to the resource was.
\nWhen the resource is in a CREATE_FAILED/UPDATE_FAILED/DELETE_FAILED state, the status\n code signals what went wrong and why the mutation failed.
", - "smithy.api#enum": [ - { - "value": "ACTIVE_DIRECTORY_ALREADY_EXISTS", - "name": "ACTIVE_DIRECTORY_ALREADY_EXISTS" - }, - { - "value": "STUDIO_COMPONENT_CREATED", - "name": "STUDIO_COMPONENT_CREATED" - }, - { - "value": "STUDIO_COMPONENT_UPDATED", - "name": "STUDIO_COMPONENT_UPDATED" - }, - { - "value": "STUDIO_COMPONENT_DELETED", - "name": "STUDIO_COMPONENT_DELETED" - }, - { - "value": "ENCRYPTION_KEY_ACCESS_DENIED", - "name": "ENCRYPTION_KEY_ACCESS_DENIED" - }, - { - "value": "ENCRYPTION_KEY_NOT_FOUND", - "name": "ENCRYPTION_KEY_NOT_FOUND" - }, - { - "value": "STUDIO_COMPONENT_CREATE_IN_PROGRESS", - "name": "STUDIO_COMPONENT_CREATE_IN_PROGRESS" - }, - { - "value": "STUDIO_COMPONENT_UPDATE_IN_PROGRESS", - "name": "STUDIO_COMPONENT_UPDATE_IN_PROGRESS" - }, - { - "value": "STUDIO_COMPONENT_DELETE_IN_PROGRESS", - "name": "STUDIO_COMPONENT_DELETE_IN_PROGRESS" - }, - { - "value": "INTERNAL_ERROR", - "name": "INTERNAL_ERROR" + "type": "enum", + "members": { + "ACTIVE_DIRECTORY_ALREADY_EXISTS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE_DIRECTORY_ALREADY_EXISTS" } - ] + }, + "STUDIO_COMPONENT_CREATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STUDIO_COMPONENT_CREATED" + } + }, + "STUDIO_COMPONENT_UPDATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STUDIO_COMPONENT_UPDATED" + } + }, + "STUDIO_COMPONENT_DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STUDIO_COMPONENT_DELETED" + } + }, + "ENCRYPTION_KEY_ACCESS_DENIED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENCRYPTION_KEY_ACCESS_DENIED" + } + }, + "ENCRYPTION_KEY_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENCRYPTION_KEY_NOT_FOUND" + } + }, + "STUDIO_COMPONENT_CREATE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STUDIO_COMPONENT_CREATE_IN_PROGRESS" + } + }, + "STUDIO_COMPONENT_UPDATE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STUDIO_COMPONENT_UPDATE_IN_PROGRESS" + } + }, + "STUDIO_COMPONENT_DELETE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STUDIO_COMPONENT_DELETE_IN_PROGRESS" + } + }, + "INTERNAL_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INTERNAL_ERROR" + } + } + }, + "traits": { + "smithy.api#documentation": "The current status of the studio component resource.
\nWhen the resource is in the READY state, the status code signals what the\n last mutation made to the resource was.
When the resource is in a CREATE_FAILED, UPDATE_FAILED, or\n DELETE_FAILED state, the status code signals what went wrong and why\n the mutation failed.
The Unix epoch timestamp in seconds for when the resource was created.
" + "smithy.api#documentation": "The ISO timestamp in seconds for when the resource was created.
" } }, "createdBy": { @@ -7410,7 +8111,7 @@ "updatedAt": { "target": "com.amazonaws.nimble#Timestamp", "traits": { - "smithy.api#documentation": "The Unix epoch timestamp in seconds for when the resource was updated.
" + "smithy.api#documentation": "The ISO timestamp in seconds for when the resource was updated.
" } }, "updatedBy": { @@ -7431,30 +8132,38 @@ } }, "com.amazonaws.nimble#StudioComponentType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ACTIVE_DIRECTORY", - "name": "ACTIVE_DIRECTORY" - }, - { - "value": "SHARED_FILE_SYSTEM", - "name": "SHARED_FILE_SYSTEM" - }, - { - "value": "COMPUTE_FARM", - "name": "COMPUTE_FARM" - }, - { - "value": "LICENSE_SERVICE", - "name": "LICENSE_SERVICE" - }, - { - "value": "CUSTOM", - "name": "CUSTOM" + "type": "enum", + "members": { + "ACTIVE_DIRECTORY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE_DIRECTORY" } - ] + }, + "SHARED_FILE_SYSTEM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SHARED_FILE_SYSTEM" + } + }, + "COMPUTE_FARM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPUTE_FARM" + } + }, + "LICENSE_SERVICE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LICENSE_SERVICE" + } + }, + "CUSTOM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CUSTOM" + } + } } }, "com.amazonaws.nimble#StudioComponentTypeList": { @@ -7505,19 +8214,23 @@ } }, "com.amazonaws.nimble#StudioEncryptionConfigurationKeyType": { - "type": "string", - "traits": { - "smithy.api#documentation": "The type of KMS key that is used to encrypt studio data.
", - "smithy.api#enum": [ - { - "value": "AWS_OWNED_KEY", - "name": "AWS_OWNED_KEY" - }, - { - "value": "CUSTOMER_MANAGED_KEY", - "name": "CUSTOMER_MANAGED_KEY" + "type": "enum", + "members": { + "AWS_OWNED_KEY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS_OWNED_KEY" } - ] + }, + "CUSTOMER_MANAGED_KEY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CUSTOMER_MANAGED_KEY" + } + } + }, + "traits": { + "smithy.api#documentation": "The type of KMS key that is used to encrypt studio data.
" } }, "com.amazonaws.nimble#StudioList": { @@ -7555,7 +8268,7 @@ } }, "traits": { - "smithy.api#documentation": "A studio member is an association of a user from your studio identity source to\n elevated permissions that they are granted in the studio.
\nWhen you add a user to your studio using the Nimble Studio console, they are\n given access to the studio's IAM Identity Center application and are given access to log in to the\n Nimble Studio portal. These users have the permissions provided by the studio's\n user IAM role and do not appear in the studio membership collection. Only studio admins\n appear in studio membership.
\nWhen you add a user to studio membership with the persona ADMIN, upon logging in to\n the Nimble Studio portal, they are granted permissions specified by the Studio's\n Admin IAM role.
" + "smithy.api#documentation": "A studio member is an association of a user from your studio identity source to\n elevated permissions that they are granted in the studio.
\nWhen you add a user to your studio using the Nimble Studio console, they are\n given access to the studio's IAM Identity Center application and are given access to log\n in to the Nimble Studio portal. These users have the permissions provided by the\n studio's user IAM role and do not appear in the studio membership\n collection. Only studio admins appear in studio membership.
\nWhen you add a user to studio membership with the ADMIN persona, upon logging in to\n the Nimble Studio portal, they are granted permissions specified by the Studio's\n Admin IAM role.
" } }, "com.amazonaws.nimble#StudioMembershipList": { @@ -7581,14 +8294,14 @@ } }, "com.amazonaws.nimble#StudioPersona": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ADMINISTRATOR", - "name": "ADMINISTRATOR" + "type": "enum", + "members": { + "ADMINISTRATOR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ADMINISTRATOR" } - ] + } } }, "com.amazonaws.nimble#StudioResource": { @@ -7617,162 +8330,218 @@ { "target": "com.amazonaws.nimble#DeleteStudioMember" }, - { - "target": "com.amazonaws.nimble#GetStudioMember" + { + "target": "com.amazonaws.nimble#GetStudioMember" + }, + { + "target": "com.amazonaws.nimble#ListStudioMembers" + }, + { + "target": "com.amazonaws.nimble#PutStudioMembers" + }, + { + "target": "com.amazonaws.nimble#StartStudioSSOConfigurationRepair" + } + ], + "traits": { + "aws.api#arn": { + "template": "studio/{studioId}" + }, + "aws.cloudformation#cfnResource": { + "name": "Studio", + "additionalSchemas": [ + "com.amazonaws.nimble#Studio" + ] + }, + "aws.iam#conditionKeys": [ + "aws:ResourceTag/${TagKey}", + "aws:RequestTag/${TagKey}", + "aws:TagKeys", + "nimble:studioId" + ], + "aws.iam#disableConditionKeyInference": {}, + "aws.iam#iamResource": { + "name": "studio" + }, + "smithy.api#documentation": "Represents a studio that contains other Nimble Studio resources", + "smithy.api#externalDocumentation": { + "CFNSourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-nimblestudio" + } + } + }, + "com.amazonaws.nimble#StudioState": { + "type": "enum", + "members": { + "CREATE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_IN_PROGRESS" + } + }, + "READY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "READY" + } + }, + "UPDATE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATE_IN_PROGRESS" + } + }, + "DELETE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_IN_PROGRESS" + } + }, + "DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETED" + } + }, + "DELETE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_FAILED" + } + }, + "CREATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_FAILED" + } + }, + "UPDATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATE_FAILED" + } + } + } + }, + "com.amazonaws.nimble#StudioStatusCode": { + "type": "enum", + "members": { + "STUDIO_CREATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STUDIO_CREATED" + } + }, + "STUDIO_DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STUDIO_DELETED" + } + }, + "STUDIO_UPDATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STUDIO_UPDATED" + } + }, + "STUDIO_CREATE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STUDIO_CREATE_IN_PROGRESS" + } + }, + "STUDIO_UPDATE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STUDIO_UPDATE_IN_PROGRESS" + } + }, + "STUDIO_DELETE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STUDIO_DELETE_IN_PROGRESS" + } + }, + "STUDIO_WITH_LAUNCH_PROFILES_NOT_DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STUDIO_WITH_LAUNCH_PROFILES_NOT_DELETED" + } + }, + "STUDIO_WITH_STUDIO_COMPONENTS_NOT_DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STUDIO_WITH_STUDIO_COMPONENTS_NOT_DELETED" + } }, - { - "target": "com.amazonaws.nimble#ListStudioMembers" + "STUDIO_WITH_STREAMING_IMAGES_NOT_DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STUDIO_WITH_STREAMING_IMAGES_NOT_DELETED" + } }, - { - "target": "com.amazonaws.nimble#PutStudioMembers" + "AWS_SSO_NOT_ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS_SSO_NOT_ENABLED" + } }, - { - "target": "com.amazonaws.nimble#StartStudioSSOConfigurationRepair" - } - ], - "traits": { - "aws.api#arn": { - "template": "studio/{studioId}" + "AWS_SSO_ACCESS_DENIED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS_SSO_ACCESS_DENIED" + } }, - "aws.cloudformation#cfnResource": { - "name": "Studio", - "additionalSchemas": [ - "com.amazonaws.nimble#Studio" - ] + "ROLE_NOT_OWNED_BY_STUDIO_OWNER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ROLE_NOT_OWNED_BY_STUDIO_OWNER" + } }, - "aws.iam#conditionKeys": [ - "aws:ResourceTag/${TagKey}", - "aws:RequestTag/${TagKey}", - "aws:TagKeys", - "nimble:studioId" - ], - "aws.iam#disableConditionKeyInference": {}, - "aws.iam#iamResource": { - "name": "studio" + "ROLE_COULD_NOT_BE_ASSUMED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ROLE_COULD_NOT_BE_ASSUMED" + } }, - "smithy.api#documentation": "Represents a studio that contains other Nimble Studio resources", - "smithy.api#externalDocumentation": { - "CFNSourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-nimblestudio" - } - } - }, - "com.amazonaws.nimble#StudioState": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "CREATE_IN_PROGRESS", - "name": "CREATE_IN_PROGRESS" - }, - { - "value": "READY", - "name": "READY" - }, - { - "value": "UPDATE_IN_PROGRESS", - "name": "UPDATE_IN_PROGRESS" - }, - { - "value": "DELETE_IN_PROGRESS", - "name": "DELETE_IN_PROGRESS" - }, - { - "value": "DELETED", - "name": "DELETED" - }, - { - "value": "DELETE_FAILED", - "name": "DELETE_FAILED" - }, - { - "value": "CREATE_FAILED", - "name": "CREATE_FAILED" - }, - { - "value": "UPDATE_FAILED", - "name": "UPDATE_FAILED" + "INTERNAL_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INTERNAL_ERROR" } - ] - } - }, - "com.amazonaws.nimble#StudioStatusCode": { - "type": "string", - "traits": { - "smithy.api#documentation": "The status code.
", - "smithy.api#enum": [ - { - "value": "STUDIO_CREATED", - "name": "STUDIO_CREATED" - }, - { - "value": "STUDIO_DELETED", - "name": "STUDIO_DELETED" - }, - { - "value": "STUDIO_UPDATED", - "name": "STUDIO_UPDATED" - }, - { - "value": "STUDIO_CREATE_IN_PROGRESS", - "name": "STUDIO_CREATE_IN_PROGRESS" - }, - { - "value": "STUDIO_UPDATE_IN_PROGRESS", - "name": "STUDIO_UPDATE_IN_PROGRESS" - }, - { - "value": "STUDIO_DELETE_IN_PROGRESS", - "name": "STUDIO_DELETE_IN_PROGRESS" - }, - { - "value": "STUDIO_WITH_LAUNCH_PROFILES_NOT_DELETED", - "name": "STUDIO_WITH_LAUNCH_PROFILES_NOT_DELETED" - }, - { - "value": "STUDIO_WITH_STUDIO_COMPONENTS_NOT_DELETED", - "name": "STUDIO_WITH_STUDIO_COMPONENTS_NOT_DELETED" - }, - { - "value": "STUDIO_WITH_STREAMING_IMAGES_NOT_DELETED", - "name": "STUDIO_WITH_STREAMING_IMAGES_NOT_DELETED" - }, - { - "value": "AWS_SSO_NOT_ENABLED", - "name": "AWS_SSO_NOT_ENABLED" - }, - { - "value": "AWS_SSO_ACCESS_DENIED", - "name": "AWS_SSO_ACCESS_DENIED" - }, - { - "value": "ROLE_NOT_OWNED_BY_STUDIO_OWNER", - "name": "ROLE_NOT_OWNED_BY_STUDIO_OWNER" - }, - { - "value": "ROLE_COULD_NOT_BE_ASSUMED", - "name": "ROLE_COULD_NOT_BE_ASSUMED" - }, - { - "value": "INTERNAL_ERROR", - "name": "INTERNAL_ERROR" - }, - { - "value": "ENCRYPTION_KEY_NOT_FOUND", - "name": "ENCRYPTION_KEY_NOT_FOUND" - }, - { - "value": "ENCRYPTION_KEY_ACCESS_DENIED", - "name": "ENCRYPTION_KEY_ACCESS_DENIED" - }, - { - "value": "AWS_SSO_CONFIGURATION_REPAIRED", - "name": "AWS_SSO_CONFIGURATION_REPAIRED" - }, - { - "value": "AWS_SSO_CONFIGURATION_REPAIR_IN_PROGRESS", - "name": "AWS_SSO_CONFIGURATION_REPAIR_IN_PROGRESS" + }, + "ENCRYPTION_KEY_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENCRYPTION_KEY_NOT_FOUND" } - ] + }, + "ENCRYPTION_KEY_ACCESS_DENIED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENCRYPTION_KEY_ACCESS_DENIED" + } + }, + "AWS_SSO_CONFIGURATION_REPAIRED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS_SSO_CONFIGURATION_REPAIRED" + } + }, + "AWS_SSO_CONFIGURATION_REPAIR_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS_SSO_CONFIGURATION_REPAIR_IN_PROGRESS" + } + }, + "AWS_STS_REGION_DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS_STS_REGION_DISABLED" + } + } + }, + "traits": { + "smithy.api#documentation": "The status code.
" } }, "com.amazonaws.nimble#TagResource": { @@ -7822,7 +8591,7 @@ "resourceArn": { "target": "com.amazonaws.nimble#String", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource you want to add tags to.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource you want to add tags to.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -7830,7 +8599,7 @@ "tags": { "target": "com.amazonaws.nimble#Tags", "traits": { - "smithy.api#documentation": "A collection of labels, in the form of key:value pairs, that apply to this\n resource.
" + "smithy.api#documentation": "A collection of labels, in the form of key-value pairs, that apply to this\n resource.
" } } }, @@ -8121,7 +8890,7 @@ "clientToken": { "target": "com.amazonaws.nimble#ClientToken", "traits": { - "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If you don’t specify a client token, the AWS SDK automatically generates a\n client token and uses it for the request to ensure idempotency.
", + "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If you don’t specify a client token, the Amazon Web Services SDK automatically\n generates a client token and uses it for the request to ensure idempotency.
", "smithy.api#httpHeader": "X-Amz-Client-Token", "smithy.api#idempotencyToken": {} } @@ -8129,7 +8898,7 @@ "launchProfileId": { "target": "com.amazonaws.nimble#String", "traits": { - "smithy.api#documentation": "The Launch Profile ID.
", + "smithy.api#documentation": "The ID of the launch profile used to control access from the streaming session.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -8183,7 +8952,7 @@ "target": "com.amazonaws.nimble#ClientToken", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, - "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If you don’t specify a client token, the AWS SDK automatically generates a\n client token and uses it for the request to ensure idempotency.
", + "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If you don’t specify a client token, the Amazon Web Services SDK automatically\n generates a client token and uses it for the request to ensure idempotency.
", "smithy.api#httpHeader": "X-Amz-Client-Token", "smithy.api#idempotencyToken": {} } @@ -8197,7 +8966,7 @@ "launchProfileId": { "target": "com.amazonaws.nimble#String", "traits": { - "smithy.api#documentation": "The Launch Profile ID.
", + "smithy.api#documentation": "The ID of the launch profile used to control access from the streaming session.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -8302,7 +9071,7 @@ "target": "com.amazonaws.nimble#ClientToken", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, - "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If you don’t specify a client token, the AWS SDK automatically generates a\n client token and uses it for the request to ensure idempotency.
", + "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If you don’t specify a client token, the Amazon Web Services SDK automatically\n generates a client token and uses it for the request to ensure idempotency.
", "smithy.api#httpHeader": "X-Amz-Client-Token", "smithy.api#idempotencyToken": {} } @@ -8449,7 +9218,7 @@ "target": "com.amazonaws.nimble#ClientToken", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, - "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If you don’t specify a client token, the AWS SDK automatically generates a\n client token and uses it for the request to ensure idempotency.
", + "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If you don’t specify a client token, the Amazon Web Services SDK automatically\n generates a client token and uses it for the request to ensure idempotency.
", "smithy.api#httpHeader": "X-Amz-Client-Token", "smithy.api#idempotencyToken": {} } @@ -8522,14 +9291,14 @@ "target": "com.amazonaws.nimble#RoleArn", "traits": { "aws.cloudformation#cfnMutability": "full", - "smithy.api#documentation": "An IAM role attached to Studio Component when the system initialization script runs which give the studio component access to AWS resources when the system initialization script runs.
" + "smithy.api#documentation": "An IAM role attached to Studio Component when the system initialization\n script runs which give the studio component access to Amazon Web Services resources when\n the system initialization script runs.
" } }, "runtimeRoleArn": { "target": "com.amazonaws.nimble#RoleArn", "traits": { "aws.cloudformation#cfnMutability": "full", - "smithy.api#documentation": "An IAM role attached to a Studio Component that gives the studio component access to AWS resources at anytime while the instance is running.
" + "smithy.api#documentation": "An IAM role attached to a Studio Component that gives the studio\n component access to Amazon Web Services resources at anytime while the instance is\n running.
" } } }, @@ -8557,14 +9326,14 @@ "adminRoleArn": { "target": "com.amazonaws.nimble#RoleArn", "traits": { - "smithy.api#documentation": "The IAM role that Studio Admins will assume when logging in to the Nimble Studio\n portal.
" + "smithy.api#documentation": "The IAM role that Studio Admins will assume when logging in to the\n Nimble Studio portal.
" } }, "clientToken": { "target": "com.amazonaws.nimble#ClientToken", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, - "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If you don’t specify a client token, the AWS SDK automatically generates a\n client token and uses it for the request to ensure idempotency.
", + "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If you don’t specify a client token, the Amazon Web Services SDK automatically\n generates a client token and uses it for the request to ensure idempotency.
", "smithy.api#httpHeader": "X-Amz-Client-Token", "smithy.api#idempotencyToken": {} } @@ -8586,7 +9355,7 @@ "userRoleArn": { "target": "com.amazonaws.nimble#RoleArn", "traits": { - "smithy.api#documentation": "The IAM role that Studio Users will assume when logging in to the Nimble Studio\n portal.
" + "smithy.api#documentation": "The IAM role that Studio Users will assume when logging in to the\n Nimble Studio portal.
" } } }, @@ -8679,6 +9448,82 @@ "target": "com.amazonaws.nimble#ValidationResult" } }, + "com.amazonaws.nimble#VolumeConfiguration": { + "type": "structure", + "members": { + "size": { + "target": "com.amazonaws.nimble#VolumeSizeInGiB", + "traits": { + "smithy.api#default": 500, + "smithy.api#documentation": "The size of the root volume that is attached to the streaming session. The root volume\n size is measured in GiBs.
" + } + }, + "throughput": { + "target": "com.amazonaws.nimble#VolumeThroughputInMiBs", + "traits": { + "smithy.api#default": 125, + "smithy.api#documentation": "The throughput to provision for the root volume that is attached to the streaming\n session. The throughput is measured in MiB/s.
" + } + }, + "iops": { + "target": "com.amazonaws.nimble#VolumeIops", + "traits": { + "smithy.api#default": 3000, + "smithy.api#documentation": "The number of I/O operations per second for the root volume that is attached to\n streaming session.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Custom volume configuration for the root volumes that are attached to streaming\n sessions.
\nThis parameter is only allowed when sessionPersistenceMode is\n ACTIVATED.
Welcome to the Amazon Nimble Studio API reference. This API reference provides\n methods, schema, resources, parameters, and more to help you get the most out of Nimble\n Studio.
\nNimble Studio is a virtual studio that empowers visual effects, animation, and\n interactive content teams to create content securely within a scalable, private cloud\n service.
", - "smithy.api#title": "AmazonNimbleStudio" + "smithy.api#title": "AmazonNimbleStudio", + "smithy.rules#endpointRuleSet": { + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": true, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://nimble-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://nimble-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://nimble.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ] + }, + { + "conditions": [], + "endpoint": { + "url": "https://nimble.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ + { + "documentation": "For region ca-central-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://nimble-fips.ca-central-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "ca-central-1", + "UseFIPS": true + } + }, + { + "documentation": "For region ca-central-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://nimble-fips.ca-central-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "ca-central-1", + "UseFIPS": true + } + }, + { + "documentation": "For region ca-central-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://nimble.ca-central-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "ca-central-1", + "UseFIPS": false + } + }, + { + "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://nimble.ca-central-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "ca-central-1", + "UseFIPS": false + } + }, + { + "documentation": "For region us-west-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://nimble-fips.us-west-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "us-west-2", + "UseFIPS": true + } + }, + { + "documentation": "For region us-west-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://nimble-fips.us-west-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "us-west-2", + "UseFIPS": true + } + }, + { + "documentation": "For region us-west-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://nimble.us-west-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "us-west-2", + "UseFIPS": false + } + }, + { + "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://nimble.us-west-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "us-west-2", + "UseFIPS": false + } + }, + { + "documentation": "For region eu-west-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://nimble-fips.eu-west-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "eu-west-2", + "UseFIPS": true + } + }, + { + "documentation": "For region eu-west-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://nimble-fips.eu-west-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "eu-west-2", + "UseFIPS": true + } + }, + { + "documentation": "For region eu-west-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://nimble.eu-west-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "eu-west-2", + "UseFIPS": false + } + }, + { + "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://nimble.eu-west-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "eu-west-2", + "UseFIPS": false + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://nimble-fips.ap-northeast-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "ap-northeast-1", + "UseFIPS": true + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://nimble-fips.ap-northeast-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "ap-northeast-1", + "UseFIPS": true + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://nimble.ap-northeast-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "ap-northeast-1", + "UseFIPS": false + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://nimble.ap-northeast-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "ap-northeast-1", + "UseFIPS": false + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://nimble-fips.ap-southeast-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "ap-southeast-2", + "UseFIPS": true + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://nimble-fips.ap-southeast-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "ap-southeast-2", + "UseFIPS": true + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://nimble.ap-southeast-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "ap-southeast-2", + "UseFIPS": false + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://nimble.ap-southeast-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "ap-southeast-2", + "UseFIPS": false + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://nimble-fips.us-east-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "us-east-1", + "UseFIPS": true + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://nimble-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "us-east-1", + "UseFIPS": true + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://nimble.us-east-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "Region": "us-east-1", + "UseFIPS": false + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://nimble.us-east-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "us-east-1", + "UseFIPS": false + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseDualStack": false, + "Region": "us-east-1", + "UseFIPS": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips enabled and dualstack disabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "UseDualStack": false, + "Region": "us-east-1", + "UseFIPS": true, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "params": { + "UseDualStack": true, + "Region": "us-east-1", + "UseFIPS": false, + "Endpoint": "https://example.com" + } + } + ], + "version": "1.0" + } } } } diff --git a/codegen/sdk-codegen/aws-models/resource-explorer-2.json b/codegen/sdk-codegen/aws-models/resource-explorer-2.json index 1e36e339d81..d4def561052 100644 --- a/codegen/sdk-codegen/aws-models/resource-explorer-2.json +++ b/codegen/sdk-codegen/aws-models/resource-explorer-2.json @@ -260,7 +260,7 @@ } ], "traits": { - "smithy.api#documentation": "Turns on Amazon Web Services Resource Explorer in the Amazon Web Services Region in which you called this operation by creating\n an index. Resource Explorer begins discovering the resources in this Region and stores the details\n about the resources in the index so that they can be queried by using the Search operation. You can create only one index in a Region.
\nThis operation creates only a local index. To promote the\n local index in one Amazon Web Services Region into the aggregator index for the Amazon Web Services account, use the\n UpdateIndexType operation. For more information, see Turning on cross-Region search by creating an aggregator index in the\n Amazon Web Services Resource Explorer User Guide.
\nFor more details about what happens when you turn on Resource Explorer in an Amazon Web Services Region, see\n Turn\n on Resource Explorer to index your resources in an Amazon Web Services Region in the\n Amazon Web Services Resource Explorer User Guide.
\nIf this is the first Amazon Web Services Region in which you've created an index for Resource Explorer, then\n this operation also creates a\n service-linked role in your Amazon Web Services account that allows Resource Explorer to enumerate\n your resources to populate the index.
\n\n Action:\n resource-explorer-2:CreateIndex\n
\n Resource: The ARN of the index (as it will\n exist after the operation completes) in the Amazon Web Services Region and account in which\n you're trying to create the index. Use the wildcard character (*)\n at the end of the string to match the eventual UUID. For example, the following\n Resource element restricts the role or user to creating an\n index in only the us-east-2 Region of the specified account.
\n \"Resource\":\n \"arn:aws:resource-explorer-2:us-west-2:<account-id>:index/*\"\n
Alternatively, you can use \"Resource\": \"*\" to allow the role or\n user to create an index in any Region.
\n Action:\n iam:CreateServiceLinkedRole\n
\n Resource: No specific resource (*).
\nThis permission is required only the first time you create an index to turn on\n Resource Explorer in the account. Resource Explorer uses this to create the service-linked\n role needed to index the resources in your account. Resource Explorer uses the\n same service-linked role for all additional indexes you create\n afterwards.
\nTurns on Amazon Web Services Resource Explorer in the Amazon Web Services Region in which you called this operation by creating\n an index. Resource Explorer begins discovering the resources in this Region and stores the details\n about the resources in the index so that they can be queried by using the Search operation. You can create only one index in a Region.
\nThis operation creates only a local index. To promote the\n local index in one Amazon Web Services Region into the aggregator index for the Amazon Web Services account, use the\n UpdateIndexType operation. For more information, see Turning on cross-Region search by creating an aggregator index in the\n Amazon Web Services Resource Explorer User Guide.
\nFor more details about what happens when you turn on Resource Explorer in an Amazon Web Services Region, see\n Turn\n on Resource Explorer to index your resources in an Amazon Web Services Region in the\n Amazon Web Services Resource Explorer User Guide.
\nIf this is the first Amazon Web Services Region in which you've created an index for Resource Explorer, then\n this operation also creates a\n service-linked role in your Amazon Web Services account that allows Resource Explorer to enumerate\n your resources to populate the index.
\n\n Action:\n resource-explorer-2:CreateIndex\n
\n Resource: The ARN of the index (as it will\n exist after the operation completes) in the Amazon Web Services Region and account in which\n you're trying to create the index. Use the wildcard character (*)\n at the end of the string to match the eventual UUID. For example, the following\n Resource element restricts the role or user to creating an\n index in only the us-east-2 Region of the specified account.
\n \"Resource\":\n \"arn:aws:resource-explorer-2:us-west-2:<account-id>:index/*\"\n
Alternatively, you can use \"Resource\": \"*\" to allow the role or\n user to create an index in any Region.
\n Action:\n iam:CreateServiceLinkedRole\n
\n Resource: No specific resource (*).
\nThis permission is required only the first time you create an index to turn on\n Resource Explorer in the account. Resource Explorer uses this to create the service-linked\n role needed to index the resources in your account. Resource Explorer uses the\n same service-linked role for all additional indexes you create\n afterwards.
\nCreates a view that users can query by using the Search operation.\n Results from queries that you make using this view include only resources that match the\n view's Filters. For more information about Amazon Web Services Resource Explorer views, see Managing views\n in the Amazon Web Services Resource Explorer User Guide.
Only the principals with an IAM identity-based policy that grants Allow\n to the Search action on a Resource with the Amazon resource name (ARN) of\n this view can Search using views you create with this\n operation.
Creates a view that users can query by using the Search operation.\n Results from queries that you make using this view include only resources that match the\n view's Filters. For more information about Amazon Web Services Resource Explorer views, see Managing views\n in the Amazon Web Services Resource Explorer User Guide.
Only the principals with an IAM identity-based policy that grants Allow\n to the Search action on a Resource with the Amazon resource name (ARN) of\n this view can Search using views you create with this\n operation.
Deletes the specified index and turns off Amazon Web Services Resource Explorer in the specified Amazon Web Services Region.\n When you delete an index, Resource Explorer stops discovering and indexing resources in that\n Region. Resource Explorer also deletes all views in that Region. These actions occur as\n asynchronous background tasks. You can check to see when the actions are complete by\n using the GetIndex operation and checking the Status\n response value.
Deletes the specified index and turns off Amazon Web Services Resource Explorer in the specified Amazon Web Services Region.\n When you delete an index, Resource Explorer stops discovering and indexing resources in that\n Region. Resource Explorer also deletes all views in that Region. These actions occur as\n asynchronous background tasks. You can check to see when the actions are complete by\n using the GetIndex operation and checking the Status\n response value.
If the index you delete is the aggregator index for the Amazon Web Services account, you must\n wait 24 hours before you can promote another local index to be the\n aggregator index for the account. Users can't perform account-wide searches using\n Resource Explorer until another aggregator index is configured.
\nSpecifies the type of the index in this Region. For information about the aggregator\n index and how it differs from a local index, see Turning on cross-Region search\n by creating an aggregator index.
" + "smithy.api#documentation": "The type of the index in this Region. For information about the aggregator index and\n how it differs from a local index, see Turning on cross-Region search\n by creating an aggregator index.
" } }, "State": { "target": "com.amazonaws.resourceexplorer2#IndexState", "traits": { - "smithy.api#documentation": "Indicates the current state of the index in this Amazon Web Services Region.
" + "smithy.api#documentation": "The current state of the index in this Amazon Web Services Region.
" } }, "ReplicatingFrom": { "target": "com.amazonaws.resourceexplorer2#RegionList", "traits": { - "smithy.api#documentation": "If this index is Type=AGGREGATOR, then this response value contains a\n list of the Amazon Web Services Regions that replicate their content to the index in this Region. Not\n present for a local index.
This response value is present only if this index is\n Type=AGGREGATOR.
A list of the Amazon Web Services Regions that replicate their content to the index in this\n Region.
" } }, "ReplicatingTo": { "target": "com.amazonaws.resourceexplorer2#RegionList", "traits": { - "smithy.api#documentation": "Identifies the Amazon Web Services Region that has an index set to Type=AGGREGATOR, if\n one exists. If it does, then the Region you called this operation in replicates its\n index information to the Region specified in this response value. Not present if there\n isn't an aggregator index in the account.
This response value is present only if this index is Type=LOCAL.
The Amazon Web Services Region that contains the aggregator index, if one exists. If an aggregator index\n does exist then the Region in which you called this operation replicates its index\n information to the Region specified in this response value.
" } }, "CreatedAt": { @@ -1364,14 +1364,14 @@ "x-amz-source-account" ] }, - "smithy.api#documentation": "Amazon Web Services Resource Explorer is a resource search and discovery service. By using Resource Explorer, you can\n explore your resources using an internet search engine-like experience. Examples of\n resources include Amazon Relational Database Service (Amazon RDS) instances, Amazon Simple Storage Service (Amazon S3) buckets, or Amazon DynamoDB\n tables. You can search for your resources using resource metadata like names, tags, and\n IDs. Resource Explorer can search across all of the Amazon Web Services Regions in your account in which you turn\n the service on, to simplify your cross-Region workloads.
\nResource Explorer scans the resources in each of the Amazon Web Services Regions in your Amazon Web Services account in which\n you turn on Resource Explorer. Resource Explorer creates and\n maintains an index in each Region, with the details of that Region's\n resources.
\nYou can search across all of the indexed\n Regions in your account by designating one of your Amazon Web Services Regions to contain\n the aggregator index for the account. When you promote a local index in\n a Region to become the aggregator index for the account, Resource Explorer automatically\n replicates the index information from all local indexes in the other Regions to the\n aggregator index. Therefore, the Region with the aggregator index has a copy of all resource\n information for all Regions in the account where you turned on Resource Explorer. As a result,\n views in the aggregator index Region include resources from all of the indexed Regions in your\n account.
\nFor more information about Amazon Web Services Resource Explorer, including how to enable and configure the\n service, see the Amazon Web Services Resource Explorer User Guide.
", + "smithy.api#documentation": "Amazon Web Services Resource Explorer is a resource search and discovery service. By using Resource Explorer, you can\n explore your resources using an internet search engine-like experience. Examples of\n resources include Amazon Relational Database Service (Amazon RDS) instances, Amazon Simple Storage Service (Amazon S3) buckets, or Amazon DynamoDB\n tables. You can search for your resources using resource metadata like names, tags, and\n IDs. Resource Explorer can search across all of the Amazon Web Services Regions in your account in which you turn\n the service on, to simplify your cross-Region workloads.
\nResource Explorer scans the resources in each of the Amazon Web Services Regions in your Amazon Web Services account in which\n you turn on Resource Explorer. Resource Explorer creates\n and maintains an index in each Region, with the details of that Region's\n resources.
\nYou can search across all of the\n indexed Regions in your account by designating one of your Amazon Web Services Regions to\n contain the aggregator index for the account. When you promote a local index\n in a Region to become the aggregator index for the account, Resource Explorer automatically\n replicates the index information from all local indexes in the other Regions to the\n aggregator index. Therefore, the Region with the aggregator index has a copy of all resource\n information for all Regions in the account where you turned on Resource Explorer. As a result,\n views in the aggregator index Region include resources from all of the indexed Regions in your\n account.
\nFor more information about Amazon Web Services Resource Explorer, including how to enable and configure the\n service, see the Amazon Web Services Resource Explorer User Guide.
", "smithy.api#title": "AWS Resource Explorer", "smithy.rules#endpointRuleSet": { "version": "1.0", "parameters": { "Region": { "builtIn": "AWS::Region", - "required": false, + "required": true, "documentation": "The AWS region used to dispatch the request.", "type": "String" }, @@ -1413,15 +1413,6 @@ "ref": "Endpoint" } ] - }, - { - "fn": "parseURL", - "argv": [ - { - "ref": "Endpoint" - } - ], - "assign": "url" } ], "type": "tree", @@ -1616,6 +1607,58 @@ }, "smithy.rules#endpointTests": { "testCases": [ + { + "documentation": "For region ap-south-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://resource-explorer-2-fips.ap-south-2.api.aws" + } + }, + "params": { + "Region": "ap-south-2", + "UseDualStack": true, + "UseFIPS": true + } + }, + { + "documentation": "For region ap-south-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://resource-explorer-2-fips.ap-south-2.api.aws" + } + }, + "params": { + "Region": "ap-south-2", + "UseDualStack": false, + "UseFIPS": true + } + }, + { + "documentation": "For region ap-south-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://resource-explorer-2.ap-south-2.api.aws" + } + }, + "params": { + "Region": "ap-south-2", + "UseDualStack": true, + "UseFIPS": false + } + }, + { + "documentation": "For region ap-south-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://resource-explorer-2.ap-south-2.api.aws" + } + }, + "params": { + "Region": "ap-south-2", + "UseDualStack": false, + "UseFIPS": false + } + }, { "documentation": "For region ap-south-1 with FIPS enabled and DualStack enabled", "expect": { @@ -1624,9 +1667,9 @@ } }, "params": { + "Region": "ap-south-1", "UseDualStack": true, - "UseFIPS": true, - "Region": "ap-south-1" + "UseFIPS": true } }, { @@ -1637,9 +1680,9 @@ } }, "params": { + "Region": "ap-south-1", "UseDualStack": false, - "UseFIPS": true, - "Region": "ap-south-1" + "UseFIPS": true } }, { @@ -1650,9 +1693,9 @@ } }, "params": { + "Region": "ap-south-1", "UseDualStack": true, - "UseFIPS": false, - "Region": "ap-south-1" + "UseFIPS": false } }, { @@ -1663,9 +1706,9 @@ } }, "params": { + "Region": "ap-south-1", "UseDualStack": false, - "UseFIPS": false, - "Region": "ap-south-1" + "UseFIPS": false } }, { @@ -1676,9 +1719,9 @@ } }, "params": { + "Region": "eu-south-1", "UseDualStack": true, - "UseFIPS": true, - "Region": "eu-south-1" + "UseFIPS": true } }, { @@ -1689,9 +1732,9 @@ } }, "params": { + "Region": "eu-south-1", "UseDualStack": false, - "UseFIPS": true, - "Region": "eu-south-1" + "UseFIPS": true } }, { @@ -1702,9 +1745,9 @@ } }, "params": { + "Region": "eu-south-1", "UseDualStack": true, - "UseFIPS": false, - "Region": "eu-south-1" + "UseFIPS": false } }, { @@ -1715,9 +1758,9 @@ } }, "params": { + "Region": "eu-south-1", "UseDualStack": false, - "UseFIPS": false, - "Region": "eu-south-1" + "UseFIPS": false } }, { @@ -1728,9 +1771,9 @@ } }, "params": { + "Region": "eu-south-2", "UseDualStack": true, - "UseFIPS": true, - "Region": "eu-south-2" + "UseFIPS": true } }, { @@ -1741,9 +1784,9 @@ } }, "params": { + "Region": "eu-south-2", "UseDualStack": false, - "UseFIPS": true, - "Region": "eu-south-2" + "UseFIPS": true } }, { @@ -1754,9 +1797,9 @@ } }, "params": { + "Region": "eu-south-2", "UseDualStack": true, - "UseFIPS": false, - "Region": "eu-south-2" + "UseFIPS": false } }, { @@ -1767,9 +1810,61 @@ } }, "params": { + "Region": "eu-south-2", "UseDualStack": false, - "UseFIPS": false, - "Region": "eu-south-2" + "UseFIPS": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://resource-explorer-2-fips.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseDualStack": true, + "UseFIPS": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://resource-explorer-2-fips.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseDualStack": false, + "UseFIPS": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://resource-explorer-2.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseDualStack": true, + "UseFIPS": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://resource-explorer-2.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseDualStack": false, + "UseFIPS": false } }, { @@ -1780,9 +1875,9 @@ } }, "params": { + "Region": "me-central-1", "UseDualStack": true, - "UseFIPS": true, - "Region": "me-central-1" + "UseFIPS": true } }, { @@ -1793,9 +1888,9 @@ } }, "params": { + "Region": "me-central-1", "UseDualStack": false, - "UseFIPS": true, - "Region": "me-central-1" + "UseFIPS": true } }, { @@ -1806,9 +1901,9 @@ } }, "params": { + "Region": "me-central-1", "UseDualStack": true, - "UseFIPS": false, - "Region": "me-central-1" + "UseFIPS": false } }, { @@ -1819,9 +1914,9 @@ } }, "params": { + "Region": "me-central-1", "UseDualStack": false, - "UseFIPS": false, - "Region": "me-central-1" + "UseFIPS": false } }, { @@ -1832,9 +1927,9 @@ } }, "params": { + "Region": "ca-central-1", "UseDualStack": true, - "UseFIPS": true, - "Region": "ca-central-1" + "UseFIPS": true } }, { @@ -1845,9 +1940,9 @@ } }, "params": { + "Region": "ca-central-1", "UseDualStack": false, - "UseFIPS": true, - "Region": "ca-central-1" + "UseFIPS": true } }, { @@ -1858,9 +1953,9 @@ } }, "params": { + "Region": "ca-central-1", "UseDualStack": true, - "UseFIPS": false, - "Region": "ca-central-1" + "UseFIPS": false } }, { @@ -1871,9 +1966,9 @@ } }, "params": { + "Region": "ca-central-1", "UseDualStack": false, - "UseFIPS": false, - "Region": "ca-central-1" + "UseFIPS": false } }, { @@ -1884,9 +1979,9 @@ } }, "params": { + "Region": "eu-central-1", "UseDualStack": true, - "UseFIPS": true, - "Region": "eu-central-1" + "UseFIPS": true } }, { @@ -1897,9 +1992,9 @@ } }, "params": { + "Region": "eu-central-1", "UseDualStack": false, - "UseFIPS": true, - "Region": "eu-central-1" + "UseFIPS": true } }, { @@ -1910,9 +2005,9 @@ } }, "params": { + "Region": "eu-central-1", "UseDualStack": true, - "UseFIPS": false, - "Region": "eu-central-1" + "UseFIPS": false } }, { @@ -1923,9 +2018,61 @@ } }, "params": { + "Region": "eu-central-1", "UseDualStack": false, - "UseFIPS": false, - "Region": "eu-central-1" + "UseFIPS": false + } + }, + { + "documentation": "For region eu-central-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://resource-explorer-2-fips.eu-central-2.api.aws" + } + }, + "params": { + "Region": "eu-central-2", + "UseDualStack": true, + "UseFIPS": true + } + }, + { + "documentation": "For region eu-central-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://resource-explorer-2-fips.eu-central-2.api.aws" + } + }, + "params": { + "Region": "eu-central-2", + "UseDualStack": false, + "UseFIPS": true + } + }, + { + "documentation": "For region eu-central-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://resource-explorer-2.eu-central-2.api.aws" + } + }, + "params": { + "Region": "eu-central-2", + "UseDualStack": true, + "UseFIPS": false + } + }, + { + "documentation": "For region eu-central-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://resource-explorer-2.eu-central-2.api.aws" + } + }, + "params": { + "Region": "eu-central-2", + "UseDualStack": false, + "UseFIPS": false } }, { @@ -1936,9 +2083,9 @@ } }, "params": { + "Region": "us-west-1", "UseDualStack": true, - "UseFIPS": true, - "Region": "us-west-1" + "UseFIPS": true } }, { @@ -1949,9 +2096,9 @@ } }, "params": { + "Region": "us-west-1", "UseDualStack": false, - "UseFIPS": true, - "Region": "us-west-1" + "UseFIPS": true } }, { @@ -1962,9 +2109,9 @@ } }, "params": { + "Region": "us-west-1", "UseDualStack": true, - "UseFIPS": false, - "Region": "us-west-1" + "UseFIPS": false } }, { @@ -1975,9 +2122,9 @@ } }, "params": { + "Region": "us-west-1", "UseDualStack": false, - "UseFIPS": false, - "Region": "us-west-1" + "UseFIPS": false } }, { @@ -1988,9 +2135,9 @@ } }, "params": { + "Region": "us-west-2", "UseDualStack": true, - "UseFIPS": true, - "Region": "us-west-2" + "UseFIPS": true } }, { @@ -2001,9 +2148,9 @@ } }, "params": { + "Region": "us-west-2", "UseDualStack": false, - "UseFIPS": true, - "Region": "us-west-2" + "UseFIPS": true } }, { @@ -2014,9 +2161,9 @@ } }, "params": { + "Region": "us-west-2", "UseDualStack": true, - "UseFIPS": false, - "Region": "us-west-2" + "UseFIPS": false } }, { @@ -2027,9 +2174,61 @@ } }, "params": { + "Region": "us-west-2", "UseDualStack": false, - "UseFIPS": false, - "Region": "us-west-2" + "UseFIPS": false + } + }, + { + "documentation": "For region af-south-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://resource-explorer-2-fips.af-south-1.api.aws" + } + }, + "params": { + "Region": "af-south-1", + "UseDualStack": true, + "UseFIPS": true + } + }, + { + "documentation": "For region af-south-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://resource-explorer-2-fips.af-south-1.api.aws" + } + }, + "params": { + "Region": "af-south-1", + "UseDualStack": false, + "UseFIPS": true + } + }, + { + "documentation": "For region af-south-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://resource-explorer-2.af-south-1.api.aws" + } + }, + "params": { + "Region": "af-south-1", + "UseDualStack": true, + "UseFIPS": false + } + }, + { + "documentation": "For region af-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://resource-explorer-2.af-south-1.api.aws" + } + }, + "params": { + "Region": "af-south-1", + "UseDualStack": false, + "UseFIPS": false } }, { @@ -2040,9 +2239,9 @@ } }, "params": { + "Region": "eu-north-1", "UseDualStack": true, - "UseFIPS": true, - "Region": "eu-north-1" + "UseFIPS": true } }, { @@ -2053,9 +2252,9 @@ } }, "params": { + "Region": "eu-north-1", "UseDualStack": false, - "UseFIPS": true, - "Region": "eu-north-1" + "UseFIPS": true } }, { @@ -2066,9 +2265,9 @@ } }, "params": { + "Region": "eu-north-1", "UseDualStack": true, - "UseFIPS": false, - "Region": "eu-north-1" + "UseFIPS": false } }, { @@ -2079,9 +2278,9 @@ } }, "params": { + "Region": "eu-north-1", "UseDualStack": false, - "UseFIPS": false, - "Region": "eu-north-1" + "UseFIPS": false } }, { @@ -2092,9 +2291,9 @@ } }, "params": { + "Region": "eu-west-3", "UseDualStack": true, - "UseFIPS": true, - "Region": "eu-west-3" + "UseFIPS": true } }, { @@ -2105,9 +2304,9 @@ } }, "params": { + "Region": "eu-west-3", "UseDualStack": false, - "UseFIPS": true, - "Region": "eu-west-3" + "UseFIPS": true } }, { @@ -2118,9 +2317,9 @@ } }, "params": { + "Region": "eu-west-3", "UseDualStack": true, - "UseFIPS": false, - "Region": "eu-west-3" + "UseFIPS": false } }, { @@ -2131,9 +2330,9 @@ } }, "params": { + "Region": "eu-west-3", "UseDualStack": false, - "UseFIPS": false, - "Region": "eu-west-3" + "UseFIPS": false } }, { @@ -2144,9 +2343,9 @@ } }, "params": { + "Region": "eu-west-2", "UseDualStack": true, - "UseFIPS": true, - "Region": "eu-west-2" + "UseFIPS": true } }, { @@ -2157,9 +2356,9 @@ } }, "params": { + "Region": "eu-west-2", "UseDualStack": false, - "UseFIPS": true, - "Region": "eu-west-2" + "UseFIPS": true } }, { @@ -2170,9 +2369,9 @@ } }, "params": { + "Region": "eu-west-2", "UseDualStack": true, - "UseFIPS": false, - "Region": "eu-west-2" + "UseFIPS": false } }, { @@ -2183,9 +2382,9 @@ } }, "params": { + "Region": "eu-west-2", "UseDualStack": false, - "UseFIPS": false, - "Region": "eu-west-2" + "UseFIPS": false } }, { @@ -2196,9 +2395,9 @@ } }, "params": { + "Region": "eu-west-1", "UseDualStack": true, - "UseFIPS": true, - "Region": "eu-west-1" + "UseFIPS": true } }, { @@ -2209,9 +2408,9 @@ } }, "params": { + "Region": "eu-west-1", "UseDualStack": false, - "UseFIPS": true, - "Region": "eu-west-1" + "UseFIPS": true } }, { @@ -2222,9 +2421,9 @@ } }, "params": { + "Region": "eu-west-1", "UseDualStack": true, - "UseFIPS": false, - "Region": "eu-west-1" + "UseFIPS": false } }, { @@ -2235,9 +2434,9 @@ } }, "params": { + "Region": "eu-west-1", "UseDualStack": false, - "UseFIPS": false, - "Region": "eu-west-1" + "UseFIPS": false } }, { @@ -2248,9 +2447,9 @@ } }, "params": { + "Region": "ap-northeast-3", "UseDualStack": true, - "UseFIPS": true, - "Region": "ap-northeast-3" + "UseFIPS": true } }, { @@ -2261,9 +2460,9 @@ } }, "params": { + "Region": "ap-northeast-3", "UseDualStack": false, - "UseFIPS": true, - "Region": "ap-northeast-3" + "UseFIPS": true } }, { @@ -2274,9 +2473,9 @@ } }, "params": { + "Region": "ap-northeast-3", "UseDualStack": true, - "UseFIPS": false, - "Region": "ap-northeast-3" + "UseFIPS": false } }, { @@ -2287,9 +2486,9 @@ } }, "params": { + "Region": "ap-northeast-3", "UseDualStack": false, - "UseFIPS": false, - "Region": "ap-northeast-3" + "UseFIPS": false } }, { @@ -2300,9 +2499,9 @@ } }, "params": { + "Region": "ap-northeast-2", "UseDualStack": true, - "UseFIPS": true, - "Region": "ap-northeast-2" + "UseFIPS": true } }, { @@ -2313,9 +2512,9 @@ } }, "params": { + "Region": "ap-northeast-2", "UseDualStack": false, - "UseFIPS": true, - "Region": "ap-northeast-2" + "UseFIPS": true } }, { @@ -2326,9 +2525,9 @@ } }, "params": { + "Region": "ap-northeast-2", "UseDualStack": true, - "UseFIPS": false, - "Region": "ap-northeast-2" + "UseFIPS": false } }, { @@ -2339,9 +2538,9 @@ } }, "params": { + "Region": "ap-northeast-2", "UseDualStack": false, - "UseFIPS": false, - "Region": "ap-northeast-2" + "UseFIPS": false } }, { @@ -2352,9 +2551,9 @@ } }, "params": { + "Region": "ap-northeast-1", "UseDualStack": true, - "UseFIPS": true, - "Region": "ap-northeast-1" + "UseFIPS": true } }, { @@ -2365,9 +2564,9 @@ } }, "params": { + "Region": "ap-northeast-1", "UseDualStack": false, - "UseFIPS": true, - "Region": "ap-northeast-1" + "UseFIPS": true } }, { @@ -2378,9 +2577,9 @@ } }, "params": { + "Region": "ap-northeast-1", "UseDualStack": true, - "UseFIPS": false, - "Region": "ap-northeast-1" + "UseFIPS": false } }, { @@ -2391,9 +2590,9 @@ } }, "params": { + "Region": "ap-northeast-1", "UseDualStack": false, - "UseFIPS": false, - "Region": "ap-northeast-1" + "UseFIPS": false } }, { @@ -2404,9 +2603,9 @@ } }, "params": { + "Region": "me-south-1", "UseDualStack": true, - "UseFIPS": true, - "Region": "me-south-1" + "UseFIPS": true } }, { @@ -2417,9 +2616,9 @@ } }, "params": { + "Region": "me-south-1", "UseDualStack": false, - "UseFIPS": true, - "Region": "me-south-1" + "UseFIPS": true } }, { @@ -2430,9 +2629,9 @@ } }, "params": { + "Region": "me-south-1", "UseDualStack": true, - "UseFIPS": false, - "Region": "me-south-1" + "UseFIPS": false } }, { @@ -2443,9 +2642,9 @@ } }, "params": { + "Region": "me-south-1", "UseDualStack": false, - "UseFIPS": false, - "Region": "me-south-1" + "UseFIPS": false } }, { @@ -2456,9 +2655,9 @@ } }, "params": { + "Region": "sa-east-1", "UseDualStack": true, - "UseFIPS": true, - "Region": "sa-east-1" + "UseFIPS": true } }, { @@ -2469,9 +2668,9 @@ } }, "params": { + "Region": "sa-east-1", "UseDualStack": false, - "UseFIPS": true, - "Region": "sa-east-1" + "UseFIPS": true } }, { @@ -2482,9 +2681,9 @@ } }, "params": { + "Region": "sa-east-1", "UseDualStack": true, - "UseFIPS": false, - "Region": "sa-east-1" + "UseFIPS": false } }, { @@ -2495,165 +2694,477 @@ } }, "params": { + "Region": "sa-east-1", "UseDualStack": false, - "UseFIPS": false, - "Region": "sa-east-1" + "UseFIPS": false } }, { - "documentation": "For region ap-southeast-1 with FIPS enabled and DualStack enabled", + "documentation": "For region ap-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://resource-explorer-2-fips.ap-southeast-1.api.aws" + "url": "https://resource-explorer-2-fips.ap-east-1.api.aws" } }, "params": { + "Region": "ap-east-1", "UseDualStack": true, - "UseFIPS": true, - "Region": "ap-southeast-1" + "UseFIPS": true } }, { - "documentation": "For region ap-southeast-1 with FIPS enabled and DualStack disabled", + "documentation": "For region ap-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://resource-explorer-2-fips.ap-southeast-1.api.aws" + "url": "https://resource-explorer-2-fips.ap-east-1.api.aws" } }, "params": { + "Region": "ap-east-1", "UseDualStack": false, - "UseFIPS": true, - "Region": "ap-southeast-1" + "UseFIPS": true } }, { - "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack enabled", + "documentation": "For region ap-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://resource-explorer-2.ap-southeast-1.api.aws" + "url": "https://resource-explorer-2.ap-east-1.api.aws" } }, "params": { + "Region": "ap-east-1", "UseDualStack": true, - "UseFIPS": false, - "Region": "ap-southeast-1" + "UseFIPS": false } }, { - "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", + "documentation": "For region ap-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://resource-explorer-2.ap-southeast-1.api.aws" + "url": "https://resource-explorer-2.ap-east-1.api.aws" } }, "params": { + "Region": "ap-east-1", "UseDualStack": false, - "UseFIPS": false, - "Region": "ap-southeast-1" + "UseFIPS": false } }, { - "documentation": "For region ap-southeast-2 with FIPS enabled and DualStack enabled", + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://resource-explorer-2-fips.ap-southeast-2.api.aws" + "url": "https://resource-explorer-2-fips.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { + "Region": "cn-north-1", "UseDualStack": true, - "UseFIPS": true, - "Region": "ap-southeast-2" + "UseFIPS": true } }, { - "documentation": "For region ap-southeast-2 with FIPS enabled and DualStack disabled", + "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://resource-explorer-2-fips.ap-southeast-2.api.aws" + "url": "https://resource-explorer-2-fips.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { + "Region": "cn-north-1", "UseDualStack": false, - "UseFIPS": true, - "Region": "ap-southeast-2" + "UseFIPS": true } }, { - "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack enabled", + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://resource-explorer-2.ap-southeast-2.api.aws" + "url": "https://resource-explorer-2.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { + "Region": "cn-north-1", "UseDualStack": true, - "UseFIPS": false, - "Region": "ap-southeast-2" + "UseFIPS": false } }, { - "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://resource-explorer-2.ap-southeast-2.api.aws" + "url": "https://resource-explorer-2.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { + "Region": "cn-north-1", "UseDualStack": false, - "UseFIPS": false, - "Region": "ap-southeast-2" + "UseFIPS": false } }, { - "documentation": "For region ap-southeast-3 with FIPS enabled and DualStack enabled", + "documentation": "For region ca-west-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://resource-explorer-2-fips.ap-southeast-3.api.aws" + "url": "https://resource-explorer-2-fips.ca-west-1.api.aws" } }, "params": { + "Region": "ca-west-1", "UseDualStack": true, - "UseFIPS": true, - "Region": "ap-southeast-3" + "UseFIPS": true } }, { - "documentation": "For region ap-southeast-3 with FIPS enabled and DualStack disabled", + "documentation": "For region ca-west-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://resource-explorer-2-fips.ap-southeast-3.api.aws" + "url": "https://resource-explorer-2-fips.ca-west-1.api.aws" } }, "params": { + "Region": "ca-west-1", "UseDualStack": false, - "UseFIPS": true, - "Region": "ap-southeast-3" + "UseFIPS": true } }, { - "documentation": "For region ap-southeast-3 with FIPS disabled and DualStack enabled", + "documentation": "For region ca-west-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://resource-explorer-2.ap-southeast-3.api.aws" + "url": "https://resource-explorer-2.ca-west-1.api.aws" } }, "params": { + "Region": "ca-west-1", "UseDualStack": true, - "UseFIPS": false, - "Region": "ap-southeast-3" + "UseFIPS": false } }, { - "documentation": "For region ap-southeast-3 with FIPS disabled and DualStack disabled", + "documentation": "For region ca-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://resource-explorer-2.ap-southeast-3.api.aws" + "url": "https://resource-explorer-2.ca-west-1.api.aws" } }, "params": { + "Region": "ca-west-1", "UseDualStack": false, - "UseFIPS": false, - "Region": "ap-southeast-3" + "UseFIPS": false + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://resource-explorer-2-fips.us-gov-west-1.api.aws" + } + }, + "params": { + "Region": "us-gov-west-1", + "UseDualStack": true, + "UseFIPS": true + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://resource-explorer-2-fips.us-gov-west-1.api.aws" + } + }, + "params": { + "Region": "us-gov-west-1", + "UseDualStack": false, + "UseFIPS": true + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://resource-explorer-2.us-gov-west-1.api.aws" + } + }, + "params": { + "Region": "us-gov-west-1", + "UseDualStack": true, + "UseFIPS": false + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://resource-explorer-2.us-gov-west-1.api.aws" + } + }, + "params": { + "Region": "us-gov-west-1", + "UseDualStack": false, + "UseFIPS": false + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://resource-explorer-2-fips.ap-southeast-1.api.aws" + } + }, + "params": { + "Region": "ap-southeast-1", + "UseDualStack": true, + "UseFIPS": true + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://resource-explorer-2-fips.ap-southeast-1.api.aws" + } + }, + "params": { + "Region": "ap-southeast-1", + "UseDualStack": false, + "UseFIPS": true + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://resource-explorer-2.ap-southeast-1.api.aws" + } + }, + "params": { + "Region": "ap-southeast-1", + "UseDualStack": true, + "UseFIPS": false + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://resource-explorer-2.ap-southeast-1.api.aws" + } + }, + "params": { + "Region": "ap-southeast-1", + "UseDualStack": false, + "UseFIPS": false + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://resource-explorer-2-fips.ap-southeast-2.api.aws" + } + }, + "params": { + "Region": "ap-southeast-2", + "UseDualStack": true, + "UseFIPS": true + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://resource-explorer-2-fips.ap-southeast-2.api.aws" + } + }, + "params": { + "Region": "ap-southeast-2", + "UseDualStack": false, + "UseFIPS": true + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://resource-explorer-2.ap-southeast-2.api.aws" + } + }, + "params": { + "Region": "ap-southeast-2", + "UseDualStack": true, + "UseFIPS": false + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://resource-explorer-2.ap-southeast-2.api.aws" + } + }, + "params": { + "Region": "ap-southeast-2", + "UseDualStack": false, + "UseFIPS": false + } + }, + { + "documentation": "For region ap-southeast-3 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://resource-explorer-2-fips.ap-southeast-3.api.aws" + } + }, + "params": { + "Region": "ap-southeast-3", + "UseDualStack": true, + "UseFIPS": true + } + }, + { + "documentation": "For region ap-southeast-3 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://resource-explorer-2-fips.ap-southeast-3.api.aws" + } + }, + "params": { + "Region": "ap-southeast-3", + "UseDualStack": false, + "UseFIPS": true + } + }, + { + "documentation": "For region ap-southeast-3 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://resource-explorer-2.ap-southeast-3.api.aws" + } + }, + "params": { + "Region": "ap-southeast-3", + "UseDualStack": true, + "UseFIPS": false + } + }, + { + "documentation": "For region ap-southeast-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://resource-explorer-2.ap-southeast-3.api.aws" + } + }, + "params": { + "Region": "ap-southeast-3", + "UseDualStack": false, + "UseFIPS": false + } + }, + { + "documentation": "For region ap-southeast-4 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://resource-explorer-2-fips.ap-southeast-4.api.aws" + } + }, + "params": { + "Region": "ap-southeast-4", + "UseDualStack": true, + "UseFIPS": true + } + }, + { + "documentation": "For region ap-southeast-4 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://resource-explorer-2-fips.ap-southeast-4.api.aws" + } + }, + "params": { + "Region": "ap-southeast-4", + "UseDualStack": false, + "UseFIPS": true + } + }, + { + "documentation": "For region ap-southeast-4 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://resource-explorer-2.ap-southeast-4.api.aws" + } + }, + "params": { + "Region": "ap-southeast-4", + "UseDualStack": true, + "UseFIPS": false + } + }, + { + "documentation": "For region ap-southeast-4 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://resource-explorer-2.ap-southeast-4.api.aws" + } + }, + "params": { + "Region": "ap-southeast-4", + "UseDualStack": false, + "UseFIPS": false + } + }, + { + "documentation": "For region ap-southeast-5 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://resource-explorer-2-fips.ap-southeast-5.api.aws" + } + }, + "params": { + "Region": "ap-southeast-5", + "UseDualStack": true, + "UseFIPS": true + } + }, + { + "documentation": "For region ap-southeast-5 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://resource-explorer-2-fips.ap-southeast-5.api.aws" + } + }, + "params": { + "Region": "ap-southeast-5", + "UseDualStack": false, + "UseFIPS": true + } + }, + { + "documentation": "For region ap-southeast-5 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://resource-explorer-2.ap-southeast-5.api.aws" + } + }, + "params": { + "Region": "ap-southeast-5", + "UseDualStack": true, + "UseFIPS": false + } + }, + { + "documentation": "For region ap-southeast-5 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://resource-explorer-2.ap-southeast-5.api.aws" + } + }, + "params": { + "Region": "ap-southeast-5", + "UseDualStack": false, + "UseFIPS": false } }, { @@ -2664,9 +3175,9 @@ } }, "params": { + "Region": "us-east-1", "UseDualStack": true, - "UseFIPS": true, - "Region": "us-east-1" + "UseFIPS": true } }, { @@ -2677,9 +3188,9 @@ } }, "params": { + "Region": "us-east-1", "UseDualStack": false, - "UseFIPS": true, - "Region": "us-east-1" + "UseFIPS": true } }, { @@ -2690,9 +3201,9 @@ } }, "params": { + "Region": "us-east-1", "UseDualStack": true, - "UseFIPS": false, - "Region": "us-east-1" + "UseFIPS": false } }, { @@ -2703,9 +3214,61 @@ } }, "params": { + "Region": "us-east-1", "UseDualStack": false, - "UseFIPS": false, - "Region": "us-east-1" + "UseFIPS": false + } + }, + { + "documentation": "For region ap-southeast-6 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://resource-explorer-2-fips.ap-southeast-6.api.aws" + } + }, + "params": { + "Region": "ap-southeast-6", + "UseDualStack": true, + "UseFIPS": true + } + }, + { + "documentation": "For region ap-southeast-6 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://resource-explorer-2-fips.ap-southeast-6.api.aws" + } + }, + "params": { + "Region": "ap-southeast-6", + "UseDualStack": false, + "UseFIPS": true + } + }, + { + "documentation": "For region ap-southeast-6 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://resource-explorer-2.ap-southeast-6.api.aws" + } + }, + "params": { + "Region": "ap-southeast-6", + "UseDualStack": true, + "UseFIPS": false + } + }, + { + "documentation": "For region ap-southeast-6 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://resource-explorer-2.ap-southeast-6.api.aws" + } + }, + "params": { + "Region": "ap-southeast-6", + "UseDualStack": false, + "UseFIPS": false } }, { @@ -2716,9 +3279,9 @@ } }, "params": { + "Region": "us-east-2", "UseDualStack": true, - "UseFIPS": true, - "Region": "us-east-2" + "UseFIPS": true } }, { @@ -2729,9 +3292,9 @@ } }, "params": { + "Region": "us-east-2", "UseDualStack": false, - "UseFIPS": true, - "Region": "us-east-2" + "UseFIPS": true } }, { @@ -2742,9 +3305,9 @@ } }, "params": { + "Region": "us-east-2", "UseDualStack": true, - "UseFIPS": false, - "Region": "us-east-2" + "UseFIPS": false } }, { @@ -2755,9 +3318,61 @@ } }, "params": { + "Region": "us-east-2", "UseDualStack": false, - "UseFIPS": false, - "Region": "us-east-2" + "UseFIPS": false + } + }, + { + "documentation": "For region cn-northwest-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://resource-explorer-2-fips.cn-northwest-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-northwest-1", + "UseDualStack": true, + "UseFIPS": true + } + }, + { + "documentation": "For region cn-northwest-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://resource-explorer-2-fips.cn-northwest-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-northwest-1", + "UseDualStack": false, + "UseFIPS": true + } + }, + { + "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://resource-explorer-2.cn-northwest-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-northwest-1", + "UseDualStack": true, + "UseFIPS": false + } + }, + { + "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://resource-explorer-2.cn-northwest-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-northwest-1", + "UseDualStack": false, + "UseFIPS": false } }, { @@ -2768,9 +3383,9 @@ } }, "params": { + "Region": "us-east-1", "UseDualStack": false, "UseFIPS": false, - "Region": "us-east-1", "Endpoint": "https://example.com" } }, @@ -2780,9 +3395,9 @@ "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { + "Region": "us-east-1", "UseDualStack": false, "UseFIPS": true, - "Region": "us-east-1", "Endpoint": "https://example.com" } } @@ -3235,7 +3850,7 @@ } ], "traits": { - "smithy.api#documentation": "Changes the type of the index from one of the following types to the other. For more\n information about indexes and the role they perform in Amazon Web Services Resource Explorer, see Turning on\n cross-Region search by creating an aggregator index in the\n Amazon Web Services Resource Explorer User Guide.
\n\n \n AGGREGATOR index type\n
The index contains information about resources from all Amazon Web Services Regions in the\n Amazon Web Services account in which you've created a Resource Explorer index. Resource information from\n all other Regions is replicated to this Region's index.
\nWhen you change the index type to AGGREGATOR, Resource Explorer turns on\n replication of all discovered resource information from the other Amazon Web Services Regions\n in your account to this index. You can then, from this Region only, perform\n resource search queries that span all Amazon Web Services Regions in the Amazon Web Services account.\n Turning on replication from all other Regions is performed by asynchronous\n background tasks. You can check the status of the asynchronous tasks by using\n the GetIndex operation. When the asynchronous tasks complete,\n the Status response of that operation changes from\n UPDATING to ACTIVE. After that, you can start to\n see results from other Amazon Web Services Regions in query results. However, it can take\n several hours for replication from all other Regions to complete.
You can have only one aggregator index per Amazon Web Services account. Before you can\n promote a different index to be the aggregator index for the account, you must\n first demote the existing aggregator index to type LOCAL.
\n \n LOCAL index type\n
The index contains information about resources in only the Amazon Web Services Region in\n which the index exists. If an aggregator index in another Region exists, then\n information in this local index is replicated to the aggregator index.
\nWhen you change the index type to LOCAL, Resource Explorer turns off the\n replication of resource information from all other Amazon Web Services Regions in the\n Amazon Web Services account to this Region. The aggregator index remains in the\n UPDATING state until all replication with other Regions\n successfully stops. You can check the status of the asynchronous task by using\n the GetIndex operation. When Resource Explorer successfully stops all\n replication with other Regions, the Status response of that\n operation changes from UPDATING to ACTIVE. Separately,\n the resource information from other Regions that was previously stored in the\n index is deleted within 30 days by another background task. Until that\n asynchronous task completes, some results from other Regions can continue to\n appear in search results.
After you demote an aggregator index to a local index, you must wait\n 24 hours before you can promote another index to be the new\n aggregator index for the account.
\nChanges the type of the index from one of the following types to the other. For more\n information about indexes and the role they perform in Amazon Web Services Resource Explorer, see Turning on\n cross-Region search by creating an aggregator index in the\n Amazon Web Services Resource Explorer User Guide.
\n\n \n AGGREGATOR index type\n
The index contains information about resources from all Amazon Web Services Regions in the\n Amazon Web Services account in which you've created a Resource Explorer index. Resource information from\n all other Regions is replicated to this Region's index.
\nWhen you change the index type to AGGREGATOR, Resource Explorer turns on\n replication of all discovered resource information from the other Amazon Web Services Regions\n in your account to this index. You can then, from this Region only, perform\n resource search queries that span all Amazon Web Services Regions in the Amazon Web Services account.\n Turning on replication from all other Regions is performed by asynchronous\n background tasks. You can check the status of the asynchronous tasks by using\n the GetIndex operation. When the asynchronous tasks complete,\n the Status response of that operation changes from\n UPDATING to ACTIVE. After that, you can start to\n see results from other Amazon Web Services Regions in query results. However, it can take\n several hours for replication from all other Regions to complete.
You can have only one aggregator index per Amazon Web Services account. Before you can\n promote a different index to be the aggregator index for the account, you must\n first demote the existing aggregator index to type LOCAL.
\n \n LOCAL index type\n
The index contains information about resources in only the Amazon Web Services Region in\n which the index exists. If an aggregator index in another Region exists, then\n information in this local index is replicated to the aggregator index.
\nWhen you change the index type to LOCAL, Resource Explorer turns off the\n replication of resource information from all other Amazon Web Services Regions in the\n Amazon Web Services account to this Region. The aggregator index remains in the\n UPDATING state until all replication with other Regions\n successfully stops. You can check the status of the asynchronous task by using\n the GetIndex operation. When Resource Explorer successfully stops all\n replication with other Regions, the Status response of that\n operation changes from UPDATING to ACTIVE. Separately,\n the resource information from other Regions that was previously stored in the\n index is deleted within 30 days by another background task. Until that\n asynchronous task completes, some results from other Regions can continue to\n appear in search results.
After you demote an aggregator index to a local index, you must wait\n 24 hours before you can promote another index to be the new\n aggregator index for the account.
\nAccepts the transfer of a domain from another Amazon Web Services account to the\n\t\t\t\tcurrentAmazon Web Services account. You initiate a transfer between Amazon Web Services accounts using TransferDomainToAnotherAwsAccount.
\n\t\tIf you use the CLI command at accept-domain-transfer-from-another-aws-account, use JSON format as input\n\t\t\tinstead of text because otherwise CLI will throw an error from domain\n\t\t\ttransfer input that includes single quotes.
\n\n\t\tUse either \n\t\t\tListOperations or \n\t\t\tGetOperationDetail \n\t\t\tto determine whether the operation succeeded. \n\t\t\tGetOperationDetail \n\t\t\tprovides additional information, for example, Domain Transfer from Aws Account 111122223333 has been cancelled. \n\t\t
Accepts the transfer of a domain from another Amazon Web Services account to the\n\t\t\t\tcurrentAmazon Web Services account. You initiate a transfer between Amazon Web Services accounts using TransferDomainToAnotherAwsAccount.
\nIf you use the CLI command at accept-domain-transfer-from-another-aws-account, use JSON format as input\n\t\t\tinstead of text because otherwise CLI will throw an error from domain\n\t\t\ttransfer input that includes single quotes.
\nUse either ListOperations or GetOperationDetail to determine whether the operation succeeded. GetOperationDetail provides additional information, for example,\n\t\t\t\tDomain Transfer from Aws Account 111122223333 has been cancelled.
The name of the domain that was specified when another Amazon Web Services account submitted a \n\t\t\tTransferDomainToAnotherAwsAccount\n\t\t\trequest.\n\t\t
", + "smithy.api#documentation": "The name of the domain that was specified when another Amazon Web Services account\n\t\t\tsubmitted a TransferDomainToAnotherAwsAccount request.
", "smithy.api#required": {} } }, "Password": { "target": "com.amazonaws.route53domains#String", "traits": { - "smithy.api#documentation": "The password that was returned by the \n\t\t\tTransferDomainToAnotherAwsAccount\n\t\t\trequest.\n\t\t
", + "smithy.api#documentation": "The password that was returned by the TransferDomainToAnotherAwsAccount request.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "The AcceptDomainTransferFromAnotherAwsAccount request includes the following elements.
" + "smithy.api#documentation": "The AcceptDomainTransferFromAnotherAwsAccount request includes the following\n\t\t\telements.
" } }, "com.amazonaws.route53domains#AcceptDomainTransferFromAnotherAwsAccountResponse": { @@ -83,12 +83,12 @@ "OperationId": { "target": "com.amazonaws.route53domains#OperationId", "traits": { - "smithy.api#documentation": "Identifier for tracking the progress of the request. To query the operation status, use \n\t\t\tGetOperationDetail.
" + "smithy.api#documentation": "Identifier for tracking the progress of the request. To query the operation status,\n\t\t\tuse GetOperationDetail.
" } } }, "traits": { - "smithy.api#documentation": "The AcceptDomainTransferFromAnotherAwsAccount response includes the following element.
" + "smithy.api#documentation": "The AcceptDomainTransferFromAnotherAwsAccount response includes the following\n\t\t\telement.
" } }, "com.amazonaws.route53domains#AccountId": { @@ -110,13 +110,75 @@ } } }, + "com.amazonaws.route53domains#AssociateDelegationSignerToDomain": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53domains#AssociateDelegationSignerToDomainRequest" + }, + "output": { + "target": "com.amazonaws.route53domains#AssociateDelegationSignerToDomainResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53domains#DnssecLimitExceeded" + }, + { + "target": "com.amazonaws.route53domains#DuplicateRequest" + }, + { + "target": "com.amazonaws.route53domains#InvalidInput" + }, + { + "target": "com.amazonaws.route53domains#OperationLimitExceeded" + }, + { + "target": "com.amazonaws.route53domains#TLDRulesViolation" + }, + { + "target": "com.amazonaws.route53domains#UnsupportedTLD" + } + ], + "traits": { + "smithy.api#documentation": "Creates a delegation signer (DS) record in the registry zone for this domain\n\t\t\tname.
\nNote that creating DS record at the registry impacts DNSSEC validation of your DNS\n\t\t\trecords. This action may render your domain name unavailable on the internet if the\n\t\t\tsteps are completed in the wrong order, or with incorrect timing. For more information\n\t\t\tabout DNSSEC signing, see Configuring DNSSEC\n\t\t\t\tsigning in the Route 53 developer\n\t\t\tguide.
" + } + }, + "com.amazonaws.route53domains#AssociateDelegationSignerToDomainRequest": { + "type": "structure", + "members": { + "DomainName": { + "target": "com.amazonaws.route53domains#DomainName", + "traits": { + "smithy.api#documentation": "The name of the domain.
", + "smithy.api#required": {} + } + }, + "SigningAttributes": { + "target": "com.amazonaws.route53domains#DnssecSigningAttributes", + "traits": { + "smithy.api#documentation": "The information about a key, including the algorithm, public key-value, and\n\t\t\tflags.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.route53domains#AssociateDelegationSignerToDomainResponse": { + "type": "structure", + "members": { + "OperationId": { + "target": "com.amazonaws.route53domains#OperationId", + "traits": { + "smithy.api#documentation": "The identifier for tracking the progress of the request. To query the operation\n\t\t\tstatus, use GetOperationDetail.
" + } + } + } + }, "com.amazonaws.route53domains#BillingRecord": { "type": "structure", "members": { "DomainName": { "target": "com.amazonaws.route53domains#DomainName", "traits": { - "smithy.api#documentation": "The name of the domain that the billing record applies to. If the domain name contains characters \n\t\t\tother than a-z, 0-9, and - (hyphen), such as an internationalized domain name, then this value is in Punycode. \n\t\t\tFor more information, see \n\t\t\tDNS Domain Name Format \n\t\t\tin the Amazon Route 53 Developer Guide.
" + "smithy.api#documentation": "The name of the domain that the billing record applies to. If the domain name contains\n\t\t\tcharacters other than a-z, 0-9, and - (hyphen), such as an internationalized domain\n\t\t\tname, then this value is in Punycode. For more information, see DNS\n\t\t\t\tDomain Name Format in the Amazon Route 53 Developer\n\t\t\t\tGuide.
" } }, "Operation": { @@ -140,7 +202,8 @@ "Price": { "target": "com.amazonaws.route53domains#Price", "traits": { - "smithy.api#documentation": "The price that you were charged for the operation, in US dollars.
\n\t\tExample value: 12.0
" + "smithy.api#default": 0, + "smithy.api#documentation": "The price that you were charged for the operation, in US dollars.
\nExample value: 12.0
" } } }, @@ -155,10 +218,7 @@ } }, "com.amazonaws.route53domains#Boolean": { - "type": "boolean", - "traits": { - "smithy.api#box": {} - } + "type": "boolean" }, "com.amazonaws.route53domains#CancelDomainTransferToAnotherAwsAccount": { "type": "operation", @@ -180,7 +240,7 @@ } ], "traits": { - "smithy.api#documentation": "Cancels the transfer of a domain from the current Amazon Web Services account to another Amazon Web Services account. You initiate a transfer betweenAmazon Web Services accounts using \n\t\t\tTransferDomainToAnotherAwsAccount.\n\t\t
\n\t\t\n\t\tYou must cancel the transfer before the other Amazon Web Services account accepts the transfer using \n\t\t\t\tAcceptDomainTransferFromAnotherAwsAccount.
\n\t\tUse either \n\t\t\tListOperations or \n\t\t\tGetOperationDetail \n\t\t\tto determine whether the operation succeeded. \n\t\t\tGetOperationDetail \n\t\t\tprovides additional information, for example, Domain Transfer from Aws Account 111122223333 has been cancelled. \n\t\t
Cancels the transfer of a domain from the current Amazon Web Services account to\n\t\t\tanother Amazon Web Services account. You initiate a transfer betweenAmazon Web Services accounts using TransferDomainToAnotherAwsAccount.
\nYou must cancel the transfer before the other Amazon Web Services account accepts\n\t\t\t\tthe transfer using AcceptDomainTransferFromAnotherAwsAccount.
\nUse either ListOperations or GetOperationDetail to determine whether the operation succeeded. GetOperationDetail provides additional information, for example,\n\t\t\t\tDomain Transfer from Aws Account 111122223333 has been cancelled.
The CancelDomainTransferToAnotherAwsAccount request includes the following element.
" + "smithy.api#documentation": "The CancelDomainTransferToAnotherAwsAccount request includes the following\n\t\t\telement.
" } }, "com.amazonaws.route53domains#CancelDomainTransferToAnotherAwsAccountResponse": { @@ -204,12 +264,12 @@ "OperationId": { "target": "com.amazonaws.route53domains#OperationId", "traits": { - "smithy.api#documentation": "The identifier that TransferDomainToAnotherAwsAccount returned to track the progress of the request. \n\t\t\tBecause the transfer request was canceled, the value is no longer valid, and you can't use GetOperationDetail \n\t\t\tto query the operation status.
The identifier that TransferDomainToAnotherAwsAccount returned to track\n\t\t\tthe progress of the request. Because the transfer request was canceled, the value is no\n\t\t\tlonger valid, and you can't use GetOperationDetail to query the operation\n\t\t\tstatus.
The CancelDomainTransferToAnotherAwsAccount response includes the following element.
The CancelDomainTransferToAnotherAwsAccount response includes the\n\t\t\tfollowing element.
This operation checks the availability of one domain name. Note that if the availability status of a domain is pending, you must \n\t\t\tsubmit another request to determine the availability of the domain name.
" + "smithy.api#documentation": "This operation checks the availability of one domain name. Note that if the\n\t\t\tavailability status of a domain is pending, you must submit another request to determine\n\t\t\tthe availability of the domain name.
" } }, "com.amazonaws.route53domains#CheckDomainAvailabilityRequest": { @@ -238,7 +298,7 @@ "DomainName": { "target": "com.amazonaws.route53domains#DomainName", "traits": { - "smithy.api#documentation": "The name of the domain that you want to get availability for. The top-level domain (TLD), such as .com, must be a TLD that Route 53 supports. \n\t\t\tFor a list of supported TLDs, see \n\t\t\tDomains that You Can Register with Amazon Route 53 in the \n\t\t\tAmazon Route 53 Developer Guide.
\n\t\tThe domain name can contain only the following characters:
\n\t\tLetters a through z. Domain names are not case sensitive.
\nNumbers 0 through 9.
\nHyphen (-). You can't specify a hyphen at the beginning or end of a label.
\nPeriod (.) to separate the labels in the name, such as the . in example.com.
Internationalized domain names are not supported for some top-level domains. To determine whether the TLD that you want to use supports \n\t\t\tinternationalized domain names, see \n\t\t\tDomains that You Can Register with Amazon Route 53. \n\t\t\tFor more information, see \n\t\t\tFormatting Internationalized Domain Names.\n\t\t
", + "smithy.api#documentation": "The name of the domain that you want to get availability for. The top-level domain\n\t\t\t(TLD), such as .com, must be a TLD that Route 53 supports. For a list of supported TLDs,\n\t\t\tsee Domains that You Can\n\t\t\t\tRegister with Amazon Route 53 in the Amazon Route 53 Developer\n\t\t\t\tGuide.
\nThe domain name can contain only the following characters:
\nLetters a through z. Domain names are not case sensitive.
\nNumbers 0 through 9.
\nHyphen (-). You can't specify a hyphen at the beginning or end of a label.\n\t\t\t\t
\nPeriod (.) to separate the labels in the name, such as the . in\n\t\t\t\t\t\texample.com.
Internationalized domain names are not supported for some top-level domains. To\n\t\t\tdetermine whether the TLD that you want to use supports internationalized domain names,\n\t\t\tsee Domains that You Can\n\t\t\t\tRegister with Amazon Route 53. For more information, see Formatting Internationalized Domain Names.
", "smithy.api#required": {} } }, @@ -259,8 +319,7 @@ "Availability": { "target": "com.amazonaws.route53domains#DomainAvailability", "traits": { - "smithy.api#documentation": "Whether the domain name is available for registering.
\n\t\tYou can register only domains designated as AVAILABLE.
Valid values:
\n\t\tThe domain name is available.
\nThe domain name is reserved under specific conditions.
\nThe domain name is available and can be preordered.
\nThe TLD registry didn't reply with a definitive answer about whether the domain name is available. \n\t\t\t\t\tRoute 53 can return this response for a variety of reasons, for example, the registry is performing maintenance. \n\t\t\t\t\tTry again later.
\nThe TLD registry didn't return a response in the expected amount of time. When the response is delayed, \n\t\t\t\t\tit usually takes just a few extra seconds. You can resubmit the request immediately.
\nThe domain name has been reserved for another person or organization.
\nThe domain name is not available.
\nThe domain name is not available.
\nThe domain name is forbidden.
\nWhether the domain name is available for registering.
\nYou can register only domains designated as AVAILABLE.
Valid values:
\nThe domain name is available.
\nThe domain name is reserved under specific conditions.
\nThe domain name is available and can be preordered.
\nThe TLD registry didn't reply with a definitive answer about whether the\n\t\t\t\t\t\tdomain name is available. Route 53 can return this response for a variety of\n\t\t\t\t\t\treasons, for example, the registry is performing maintenance. Try again\n\t\t\t\t\t\tlater.
\nThe TLD registry didn't return a response in the expected amount of time.\n\t\t\t\t\t\tWhen the response is delayed, it usually takes just a few extra seconds. You\n\t\t\t\t\t\tcan resubmit the request immediately.
\nThe domain name has been reserved for another person or\n\t\t\t\t\t\torganization.
\nThe domain name is not available.
\nThe domain name is not available.
\nThe domain name is forbidden.
\nThe name of the domain that you want to transfer to Route 53. The top-level domain (TLD), such as .com, must be a TLD that Route 53 supports. \n\t\t\tFor a list of supported TLDs, see \n\t\t\tDomains that You Can Register with Amazon Route 53 in the \n\t\t\tAmazon Route 53 Developer Guide.
\n\t\tThe domain name can contain only the following characters:
\n\t\tLetters a through z. Domain names are not case sensitive.
\nNumbers 0 through 9.
\nHyphen (-). You can't specify a hyphen at the beginning or end of a label.
\nPeriod (.) to separate the labels in the name, such as the . in example.com.
The name of the domain that you want to transfer to Route 53. The top-level domain\n\t\t\t(TLD), such as .com, must be a TLD that Route 53 supports. For a list of supported TLDs,\n\t\t\tsee Domains that You Can\n\t\t\t\tRegister with Amazon Route 53 in the Amazon Route 53 Developer\n\t\t\t\tGuide.
\nThe domain name can contain only the following characters:
\nLetters a through z. Domain names are not case sensitive.
\nNumbers 0 through 9.
\nHyphen (-). You can't specify a hyphen at the beginning or end of a label.\n\t\t\t\t
\nPeriod (.) to separate the labels in the name, such as the . in\n\t\t\t\t\t\texample.com.
If the registrar for the top-level domain (TLD) requires an authorization code to transfer the domain, \n\t\t\tthe code that you got from the current registrar for the domain.
" + "smithy.api#documentation": "If the registrar for the top-level domain (TLD) requires an authorization code to\n\t\t\ttransfer the domain, the code that you got from the current registrar for the\n\t\t\tdomain.
" } } }, @@ -315,8 +374,7 @@ "Transferability": { "target": "com.amazonaws.route53domains#DomainTransferability", "traits": { - "smithy.api#documentation": "A complex type that contains information about whether the specified domain can be transferred to Route 53.
", - "smithy.api#required": {} + "smithy.api#documentation": "A complex type that contains information about whether the specified domain can be\n\t\t\ttransferred to Route 53.
" } } }, @@ -333,6 +391,29 @@ } } }, + "com.amazonaws.route53domains#Consent": { + "type": "structure", + "members": { + "MaxPrice": { + "target": "com.amazonaws.route53domains#Price", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "Maximum amount the customer agreed to accept.
", + "smithy.api#required": {} + } + }, + "Currency": { + "target": "com.amazonaws.route53domains#Currency", + "traits": { + "smithy.api#documentation": " Currency for the MaxPrice.
Customer's consent for the owner change request.
" + } + }, "com.amazonaws.route53domains#ContactDetail": { "type": "structure", "members": { @@ -351,7 +432,7 @@ "ContactType": { "target": "com.amazonaws.route53domains#ContactType", "traits": { - "smithy.api#documentation": "Indicates whether the contact is a person, company, association, or public organization. Note the following:
\n\t\tIf you specify a value other than PERSON, you must also specify a value for \n\t\t\t\tOrganizationName.
For some TLDs, the privacy protection available depends on the value that you specify for \n\t\t\t\tContact Type. For the privacy protection settings for your TLD, see \n\t\t\t\tDomains that You Can \n\t\t\t\t\tRegister with Amazon Route 53 in the Amazon Route 53 Developer Guide\n
For .es domains, the value of ContactType must be PERSON for all three contacts.
Indicates whether the contact is a person, company, association, or public\n\t\t\torganization. Note the following:
\nIf you specify a value other than PERSON, you must also specify a\n\t\t\t\t\tvalue for OrganizationName.
For some TLDs, the privacy protection available depends on the value that you\n\t\t\t\t\tspecify for Contact Type. For the privacy protection settings for\n\t\t\t\t\tyour TLD, see Domains that You\n\t\t\t\t\t\tCan Register with Amazon Route 53 in the Amazon Route 53\n\t\t\t\t\t\tDeveloper Guide\n
For .es domains, the value of ContactType must be\n\t\t\t\t\t\tPERSON for all three contacts.
The phone number of the contact.
\n\t\tConstraints: Phone number must be specified in the format \"+[country\tdialing code].[number including any area code>]\". \n\t\t\tFor example, a US phone number might appear as \"+1.1234567890\".
The phone number of the contact.
\nConstraints: Phone number must be specified in the format \"+[country dialing\n\t\t\tcode].[number including any area code>]\". For example, a US phone number might appear\n\t\t\tas \"+1.1234567890\".
Fax number of the contact.
\n\t\tConstraints: Phone number must be specified in the format \"+[country dialing code].[number including any area code]\". \n\t\t\tFor example, a US phone number might appear as \"+1.1234567890\".
Fax number of the contact.
\nConstraints: Phone number must be specified in the format \"+[country dialing\n\t\t\tcode].[number including any area code]\". For example, a US phone number might appear as\n\t\t\t\t\"+1.1234567890\".
A list of name-value pairs for parameters required by certain top-level domains.
" + "smithy.api#documentation": "A list of name-value pairs for parameters required by certain top-level\n\t\t\tdomains.
" } } }, @@ -445,1041 +526,1549 @@ } }, "com.amazonaws.route53domains#ContactType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "PERSON", - "name": "PERSON" - }, - { - "value": "COMPANY", - "name": "COMPANY" - }, - { - "value": "ASSOCIATION", - "name": "ASSOCIATION" - }, - { - "value": "PUBLIC_BODY", - "name": "PUBLIC_BODY" - }, - { - "value": "RESELLER", - "name": "RESELLER" + "type": "enum", + "members": { + "PERSON": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PERSON" + } + }, + "COMPANY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPANY" + } + }, + "ASSOCIATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ASSOCIATION" + } + }, + "PUBLIC_BODY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PUBLIC_BODY" } - ] + }, + "RESELLER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RESELLER" + } + } } }, "com.amazonaws.route53domains#CountryCode": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "AC", - "name": "AC" - }, - { - "value": "AD", - "name": "AD" - }, - { - "value": "AE", - "name": "AE" - }, - { - "value": "AF", - "name": "AF" - }, - { - "value": "AG", - "name": "AG" - }, - { - "value": "AI", - "name": "AI" - }, - { - "value": "AL", - "name": "AL" - }, - { - "value": "AM", - "name": "AM" - }, - { - "value": "AN", - "name": "AN" - }, - { - "value": "AO", - "name": "AO" - }, - { - "value": "AQ", - "name": "AQ" - }, - { - "value": "AR", - "name": "AR" - }, - { - "value": "AS", - "name": "AS" - }, - { - "value": "AT", - "name": "AT" - }, - { - "value": "AU", - "name": "AU" - }, - { - "value": "AW", - "name": "AW" - }, - { - "value": "AX", - "name": "AX" - }, - { - "value": "AZ", - "name": "AZ" - }, - { - "value": "BA", - "name": "BA" - }, - { - "value": "BB", - "name": "BB" - }, - { - "value": "BD", - "name": "BD" - }, - { - "value": "BE", - "name": "BE" - }, - { - "value": "BF", - "name": "BF" - }, - { - "value": "BG", - "name": "BG" - }, - { - "value": "BH", - "name": "BH" - }, - { - "value": "BI", - "name": "BI" - }, - { - "value": "BJ", - "name": "BJ" - }, - { - "value": "BL", - "name": "BL" - }, - { - "value": "BM", - "name": "BM" - }, - { - "value": "BN", - "name": "BN" - }, - { - "value": "BO", - "name": "BO" - }, - { - "value": "BQ", - "name": "BQ" - }, - { - "value": "BR", - "name": "BR" - }, - { - "value": "BS", - "name": "BS" - }, - { - "value": "BT", - "name": "BT" - }, - { - "value": "BV", - "name": "BV" - }, - { - "value": "BW", - "name": "BW" - }, - { - "value": "BY", - "name": "BY" - }, - { - "value": "BZ", - "name": "BZ" - }, - { - "value": "CA", - "name": "CA" - }, - { - "value": "CC", - "name": "CC" - }, - { - "value": "CD", - "name": "CD" - }, - { - "value": "CF", - "name": "CF" - }, - { - "value": "CG", - "name": "CG" - }, - { - "value": "CH", - "name": "CH" - }, - { - "value": "CI", - "name": "CI" - }, - { - "value": "CK", - "name": "CK" - }, - { - "value": "CL", - "name": "CL" - }, - { - "value": "CM", - "name": "CM" - }, - { - "value": "CN", - "name": "CN" - }, - { - "value": "CO", - "name": "CO" - }, - { - "value": "CR", - "name": "CR" - }, - { - "value": "CU", - "name": "CU" - }, - { - "value": "CV", - "name": "CV" - }, - { - "value": "CW", - "name": "CW" - }, - { - "value": "CX", - "name": "CX" - }, - { - "value": "CY", - "name": "CY" - }, - { - "value": "CZ", - "name": "CZ" - }, - { - "value": "DE", - "name": "DE" - }, - { - "value": "DJ", - "name": "DJ" - }, - { - "value": "DK", - "name": "DK" - }, - { - "value": "DM", - "name": "DM" - }, - { - "value": "DO", - "name": "DO" - }, - { - "value": "DZ", - "name": "DZ" - }, - { - "value": "EC", - "name": "EC" - }, - { - "value": "EE", - "name": "EE" - }, - { - "value": "EG", - "name": "EG" - }, - { - "value": "EH", - "name": "EH" - }, - { - "value": "ER", - "name": "ER" - }, - { - "value": "ES", - "name": "ES" - }, - { - "value": "ET", - "name": "ET" - }, - { - "value": "FI", - "name": "FI" - }, - { - "value": "FJ", - "name": "FJ" - }, - { - "value": "FK", - "name": "FK" - }, - { - "value": "FM", - "name": "FM" - }, - { - "value": "FO", - "name": "FO" - }, - { - "value": "FR", - "name": "FR" - }, - { - "value": "GA", - "name": "GA" - }, - { - "value": "GB", - "name": "GB" - }, - { - "value": "GD", - "name": "GD" - }, - { - "value": "GE", - "name": "GE" - }, - { - "value": "GF", - "name": "GF" - }, - { - "value": "GG", - "name": "GG" - }, - { - "value": "GH", - "name": "GH" - }, - { - "value": "GI", - "name": "GI" - }, - { - "value": "GL", - "name": "GL" - }, - { - "value": "GM", - "name": "GM" - }, - { - "value": "GN", - "name": "GN" - }, - { - "value": "GP", - "name": "GP" - }, - { - "value": "GQ", - "name": "GQ" - }, - { - "value": "GR", - "name": "GR" - }, - { - "value": "GS", - "name": "GS" - }, - { - "value": "GT", - "name": "GT" - }, - { - "value": "GU", - "name": "GU" - }, - { - "value": "GW", - "name": "GW" - }, - { - "value": "GY", - "name": "GY" - }, - { - "value": "HK", - "name": "HK" - }, - { - "value": "HM", - "name": "HM" - }, - { - "value": "HN", - "name": "HN" - }, - { - "value": "HR", - "name": "HR" - }, - { - "value": "HT", - "name": "HT" - }, - { - "value": "HU", - "name": "HU" - }, - { - "value": "ID", - "name": "ID" - }, - { - "value": "IE", - "name": "IE" - }, - { - "value": "IL", - "name": "IL" - }, - { - "value": "IM", - "name": "IM" - }, - { - "value": "IN", - "name": "IN" - }, - { - "value": "IO", - "name": "IO" - }, - { - "value": "IQ", - "name": "IQ" - }, - { - "value": "IR", - "name": "IR" - }, - { - "value": "IS", - "name": "IS" - }, - { - "value": "IT", - "name": "IT" - }, - { - "value": "JE", - "name": "JE" - }, - { - "value": "JM", - "name": "JM" - }, - { - "value": "JO", - "name": "JO" - }, - { - "value": "JP", - "name": "JP" - }, - { - "value": "KE", - "name": "KE" - }, - { - "value": "KG", - "name": "KG" - }, - { - "value": "KH", - "name": "KH" - }, - { - "value": "KI", - "name": "KI" - }, - { - "value": "KM", - "name": "KM" - }, - { - "value": "KN", - "name": "KN" - }, - { - "value": "KP", - "name": "KP" - }, - { - "value": "KR", - "name": "KR" - }, - { - "value": "KW", - "name": "KW" - }, - { - "value": "KY", - "name": "KY" - }, - { - "value": "KZ", - "name": "KZ" - }, - { - "value": "LA", - "name": "LA" - }, - { - "value": "LB", - "name": "LB" - }, - { - "value": "LC", - "name": "LC" - }, - { - "value": "LI", - "name": "LI" - }, - { - "value": "LK", - "name": "LK" - }, - { - "value": "LR", - "name": "LR" - }, - { - "value": "LS", - "name": "LS" - }, - { - "value": "LT", - "name": "LT" - }, - { - "value": "LU", - "name": "LU" - }, - { - "value": "LV", - "name": "LV" - }, - { - "value": "LY", - "name": "LY" - }, - { - "value": "MA", - "name": "MA" - }, - { - "value": "MC", - "name": "MC" - }, - { - "value": "MD", - "name": "MD" - }, - { - "value": "ME", - "name": "ME" - }, - { - "value": "MF", - "name": "MF" - }, - { - "value": "MG", - "name": "MG" - }, - { - "value": "MH", - "name": "MH" - }, - { - "value": "MK", - "name": "MK" - }, - { - "value": "ML", - "name": "ML" - }, - { - "value": "MM", - "name": "MM" - }, - { - "value": "MN", - "name": "MN" - }, - { - "value": "MO", - "name": "MO" - }, - { - "value": "MP", - "name": "MP" - }, - { - "value": "MQ", - "name": "MQ" - }, - { - "value": "MR", - "name": "MR" - }, - { - "value": "MS", - "name": "MS" - }, - { - "value": "MT", - "name": "MT" - }, - { - "value": "MU", - "name": "MU" - }, - { - "value": "MV", - "name": "MV" - }, - { - "value": "MW", - "name": "MW" - }, - { - "value": "MX", - "name": "MX" - }, - { - "value": "MY", - "name": "MY" - }, - { - "value": "MZ", - "name": "MZ" - }, - { - "value": "NA", - "name": "NA" - }, - { - "value": "NC", - "name": "NC" - }, - { - "value": "NE", - "name": "NE" - }, - { - "value": "NF", - "name": "NF" - }, - { - "value": "NG", - "name": "NG" - }, - { - "value": "NI", - "name": "NI" - }, - { - "value": "NL", - "name": "NL" - }, - { - "value": "NO", - "name": "NO" - }, - { - "value": "NP", - "name": "NP" - }, - { - "value": "NR", - "name": "NR" - }, - { - "value": "NU", - "name": "NU" - }, - { - "value": "NZ", - "name": "NZ" - }, - { - "value": "OM", - "name": "OM" - }, - { - "value": "PA", - "name": "PA" - }, - { - "value": "PE", - "name": "PE" - }, - { - "value": "PF", - "name": "PF" - }, - { - "value": "PG", - "name": "PG" - }, - { - "value": "PH", - "name": "PH" - }, - { - "value": "PK", - "name": "PK" - }, - { - "value": "PL", - "name": "PL" - }, - { - "value": "PM", - "name": "PM" - }, - { - "value": "PN", - "name": "PN" - }, - { - "value": "PR", - "name": "PR" - }, - { - "value": "PS", - "name": "PS" - }, - { - "value": "PT", - "name": "PT" - }, - { - "value": "PW", - "name": "PW" - }, - { - "value": "PY", - "name": "PY" - }, - { - "value": "QA", - "name": "QA" - }, - { - "value": "RE", - "name": "RE" - }, - { - "value": "RO", - "name": "RO" - }, - { - "value": "RS", - "name": "RS" - }, - { - "value": "RU", - "name": "RU" - }, - { - "value": "RW", - "name": "RW" - }, - { - "value": "SA", - "name": "SA" - }, - { - "value": "SB", - "name": "SB" - }, - { - "value": "SC", - "name": "SC" - }, - { - "value": "SD", - "name": "SD" - }, - { - "value": "SE", - "name": "SE" - }, - { - "value": "SG", - "name": "SG" - }, - { - "value": "SH", - "name": "SH" - }, - { - "value": "SI", - "name": "SI" - }, - { - "value": "SJ", - "name": "SJ" - }, - { - "value": "SK", - "name": "SK" - }, - { - "value": "SL", - "name": "SL" - }, - { - "value": "SM", - "name": "SM" - }, - { - "value": "SN", - "name": "SN" - }, - { - "value": "SO", - "name": "SO" - }, - { - "value": "SR", - "name": "SR" - }, - { - "value": "SS", - "name": "SS" - }, - { - "value": "ST", - "name": "ST" - }, - { - "value": "SV", - "name": "SV" - }, - { - "value": "SX", - "name": "SX" - }, - { - "value": "SY", - "name": "SY" - }, - { - "value": "SZ", - "name": "SZ" - }, - { - "value": "TC", - "name": "TC" - }, - { - "value": "TD", - "name": "TD" - }, - { - "value": "TF", - "name": "TF" - }, - { - "value": "TG", - "name": "TG" - }, - { - "value": "TH", - "name": "TH" - }, - { - "value": "TJ", - "name": "TJ" - }, - { - "value": "TK", - "name": "TK" - }, - { - "value": "TL", - "name": "TL" - }, - { - "value": "TM", - "name": "TM" - }, - { - "value": "TN", - "name": "TN" - }, - { - "value": "TO", - "name": "TO" - }, - { - "value": "TP", - "name": "TP" - }, - { - "value": "TR", - "name": "TR" - }, - { - "value": "TT", - "name": "TT" - }, - { - "value": "TV", - "name": "TV" - }, - { - "value": "TW", - "name": "TW" - }, - { - "value": "TZ", - "name": "TZ" - }, - { - "value": "UA", - "name": "UA" - }, - { - "value": "UG", - "name": "UG" - }, - { - "value": "US", - "name": "US" - }, - { - "value": "UY", - "name": "UY" - }, - { - "value": "UZ", - "name": "UZ" - }, - { - "value": "VA", - "name": "VA" - }, - { - "value": "VC", - "name": "VC" - }, - { - "value": "VE", - "name": "VE" - }, - { - "value": "VG", - "name": "VG" - }, - { - "value": "VI", - "name": "VI" - }, - { - "value": "VN", - "name": "VN" - }, - { - "value": "VU", - "name": "VU" - }, - { - "value": "WF", - "name": "WF" - }, - { - "value": "WS", - "name": "WS" - }, - { - "value": "YE", - "name": "YE" - }, - { - "value": "YT", - "name": "YT" - }, - { - "value": "ZA", - "name": "ZA" - }, - { - "value": "ZM", - "name": "ZM" - }, - { - "value": "ZW", - "name": "ZW" + "type": "enum", + "members": { + "AC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AC" + } + }, + "AD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AD" + } + }, + "AE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AE" + } + }, + "AF": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AF" + } + }, + "AG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AG" + } + }, + "AI": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AI" + } + }, + "AL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AL" + } + }, + "AM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AM" + } + }, + "AN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AN" + } + }, + "AO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AO" + } + }, + "AQ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AQ" + } + }, + "AR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AR" + } + }, + "AS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AS" + } + }, + "AT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AT" + } + }, + "AU": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AU" + } + }, + "AW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AW" + } + }, + "AX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AX" + } + }, + "AZ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AZ" + } + }, + "BA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BA" + } + }, + "BB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BB" + } + }, + "BD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BD" + } + }, + "BE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BE" + } + }, + "BF": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BF" + } + }, + "BG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BG" + } + }, + "BH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BH" + } + }, + "BI": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BI" + } + }, + "BJ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BJ" + } + }, + "BL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BL" + } + }, + "BM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BM" + } + }, + "BN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BN" + } + }, + "BO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BO" + } + }, + "BQ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BQ" + } + }, + "BR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BR" + } + }, + "BS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BS" + } + }, + "BT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BT" + } + }, + "BV": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BV" + } + }, + "BW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BW" + } + }, + "BY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BY" + } + }, + "BZ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BZ" + } + }, + "CA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CA" + } + }, + "CC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CC" + } + }, + "CD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CD" + } + }, + "CF": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CF" + } + }, + "CG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CG" + } + }, + "CH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CH" + } + }, + "CI": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CI" + } + }, + "CK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CK" + } + }, + "CL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CL" + } + }, + "CM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CM" + } + }, + "CN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CN" + } + }, + "CO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CO" + } + }, + "CR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CR" + } + }, + "CU": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CU" + } + }, + "CV": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CV" + } + }, + "CW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CW" + } + }, + "CX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CX" + } + }, + "CY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CY" + } + }, + "CZ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CZ" + } + }, + "DE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DE" + } + }, + "DJ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DJ" + } + }, + "DK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DK" + } + }, + "DM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DM" + } + }, + "DO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DO" + } + }, + "DZ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DZ" + } + }, + "EC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EC" + } + }, + "EE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EE" + } + }, + "EG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EG" + } + }, + "EH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EH" + } + }, + "ER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ER" + } + }, + "ES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ES" + } + }, + "ET": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ET" + } + }, + "FI": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FI" + } + }, + "FJ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FJ" + } + }, + "FK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FK" + } + }, + "FM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FM" + } + }, + "FO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FO" + } + }, + "FR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FR" + } + }, + "GA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GA" + } + }, + "GB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GB" + } + }, + "GD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GD" + } + }, + "GE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GE" + } + }, + "GF": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GF" + } + }, + "GG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GG" + } + }, + "GH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GH" + } + }, + "GI": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GI" + } + }, + "GL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GL" + } + }, + "GM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GM" + } + }, + "GN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GN" + } + }, + "GP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GP" + } + }, + "GQ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GQ" + } + }, + "GR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GR" + } + }, + "GS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GS" + } + }, + "GT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GT" + } + }, + "GU": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GU" + } + }, + "GW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GW" + } + }, + "GY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GY" + } + }, + "HK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HK" + } + }, + "HM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HM" + } + }, + "HN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HN" + } + }, + "HR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HR" + } + }, + "HT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HT" + } + }, + "HU": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HU" + } + }, + "ID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ID" + } + }, + "IE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IE" + } + }, + "IL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IL" + } + }, + "IM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IM" + } + }, + "IN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN" + } + }, + "IO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IO" + } + }, + "IQ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IQ" + } + }, + "IR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IR" + } + }, + "IS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IS" + } + }, + "IT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IT" + } + }, + "JE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "JE" + } + }, + "JM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "JM" + } + }, + "JO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "JO" + } + }, + "JP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "JP" + } + }, + "KE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KE" + } + }, + "KG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KG" + } + }, + "KH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KH" + } + }, + "KI": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KI" + } + }, + "KM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KM" + } + }, + "KN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KN" + } + }, + "KP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KP" + } + }, + "KR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KR" + } + }, + "KW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KW" + } + }, + "KY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KY" + } + }, + "KZ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KZ" + } + }, + "LA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LA" + } + }, + "LB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LB" + } + }, + "LC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LC" + } + }, + "LI": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LI" + } + }, + "LK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LK" + } + }, + "LR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LR" + } + }, + "LS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LS" + } + }, + "LT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LT" + } + }, + "LU": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LU" + } + }, + "LV": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LV" + } + }, + "LY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LY" + } + }, + "MA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MA" + } + }, + "MC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MC" + } + }, + "MD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MD" + } + }, + "ME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ME" + } + }, + "MF": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MF" + } + }, + "MG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MG" + } + }, + "MH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MH" + } + }, + "MK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MK" + } + }, + "ML": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ML" + } + }, + "MM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MM" + } + }, + "MN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MN" + } + }, + "MO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MO" + } + }, + "MP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MP" + } + }, + "MQ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MQ" + } + }, + "MR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MR" + } + }, + "MS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MS" + } + }, + "MT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MT" + } + }, + "MU": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MU" + } + }, + "MV": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MV" + } + }, + "MW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MW" + } + }, + "MX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MX" + } + }, + "MY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MY" + } + }, + "MZ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MZ" + } + }, + "NA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NA" + } + }, + "NC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NC" + } + }, + "NE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NE" + } + }, + "NF": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NF" + } + }, + "NG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NG" + } + }, + "NI": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NI" + } + }, + "NL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NL" + } + }, + "NO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NO" + } + }, + "NP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NP" + } + }, + "NR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NR" + } + }, + "NU": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NU" + } + }, + "NZ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NZ" + } + }, + "OM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OM" + } + }, + "PA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PA" + } + }, + "PE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PE" + } + }, + "PF": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PF" + } + }, + "PG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PG" + } + }, + "PH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PH" + } + }, + "PK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PK" + } + }, + "PL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PL" + } + }, + "PM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PM" + } + }, + "PN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PN" + } + }, + "PR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PR" + } + }, + "PS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PS" + } + }, + "PT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PT" + } + }, + "PW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PW" + } + }, + "PY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PY" + } + }, + "QA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "QA" + } + }, + "RE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RE" + } + }, + "RO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RO" + } + }, + "RS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RS" + } + }, + "RU": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RU" + } + }, + "RW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RW" + } + }, + "SA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SA" + } + }, + "SB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SB" + } + }, + "SC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SC" + } + }, + "SD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SD" + } + }, + "SE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SE" + } + }, + "SG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SG" + } + }, + "SH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SH" + } + }, + "SI": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SI" + } + }, + "SJ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SJ" + } + }, + "SK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SK" + } + }, + "SL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SL" + } + }, + "SM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SM" + } + }, + "SN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SN" + } + }, + "SO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SO" + } + }, + "SR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SR" + } + }, + "SS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SS" + } + }, + "ST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ST" + } + }, + "SV": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SV" + } + }, + "SX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SX" + } + }, + "SY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SY" + } + }, + "SZ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SZ" + } + }, + "TC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TC" + } + }, + "TD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TD" + } + }, + "TF": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TF" + } + }, + "TG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TG" + } + }, + "TH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TH" + } + }, + "TJ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TJ" + } + }, + "TK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TK" + } + }, + "TL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TL" + } + }, + "TM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TM" + } + }, + "TN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TN" + } + }, + "TO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TO" + } + }, + "TP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TP" + } + }, + "TR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TR" + } + }, + "TT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TT" + } + }, + "TV": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TV" + } + }, + "TW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TW" + } + }, + "TZ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TZ" + } + }, + "UA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UA" + } + }, + "UG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UG" + } + }, + "US": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "US" + } + }, + "UY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UY" + } + }, + "UZ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UZ" + } + }, + "VA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VA" + } + }, + "VC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VC" + } + }, + "VE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VE" + } + }, + "VG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VG" + } + }, + "VI": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VI" + } + }, + "VN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VN" + } + }, + "VU": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VU" + } + }, + "WF": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WF" + } + }, + "WS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WS" + } + }, + "YE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "YE" + } + }, + "YT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "YT" + } + }, + "ZA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ZA" + } + }, + "ZM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ZM" + } + }, + "ZW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ZW" } - ] + } } }, "com.amazonaws.route53domains#Currency": { @@ -1492,7 +2081,10 @@ } }, "com.amazonaws.route53domains#CurrentExpiryYear": { - "type": "integer" + "type": "integer", + "traits": { + "smithy.api#default": 0 + } }, "com.amazonaws.route53domains#DNSSec": { "type": "string" @@ -1520,7 +2112,7 @@ } ], "traits": { - "smithy.api#documentation": "This operation deletes the specified domain. This action is permanent. For more information,\n\t\t\tsee Deleting a domain name registration.
\n\t\tTo transfer the domain registration to another registrar, use the transfer process that’s\n\t\t\tprovided by the registrar to which you want to transfer the registration. Otherwise,\n\t\t\tthe following apply:
\n\t\tYou can’t get a refund for the cost of a deleted domain registration.
\nThe registry for the top-level domain might hold the domain name for a brief time before releasing it for other users to register (varies by registry).
\nWhen the registration has been deleted, we'll send you a confirmation to the registrant\n\t\t\t\tcontact. The email will come from\n\t\t\t\tnoreply@domainnameverification.net or\n\t\t\t\tnoreply@registrar.amazon.com.
This operation deletes the specified domain. This action is permanent. For more\n\t\t\tinformation, see Deleting a domain name\n\t\t\t\tregistration.
\nTo transfer the domain registration to another registrar, use the transfer process\n\t\t\tthat’s provided by the registrar to which you want to transfer the registration.\n\t\t\tOtherwise, the following apply:
\nYou can’t get a refund for the cost of a deleted domain registration.
\nThe registry for the top-level domain might hold the domain name for a brief\n\t\t\t\t\ttime before releasing it for other users to register (varies by registry).\n\t\t\t\t
\nWhen the registration has been deleted, we'll send you a confirmation to the\n\t\t\t\t\tregistrant contact. The email will come from\n\t\t\t\t\t\tnoreply@domainnameverification.net or\n\t\t\t\t\t\tnoreply@registrar.amazon.com.
Identifier for tracking the progress of the request. \n\t\t\tTo query the operation status, use GetOperationDetail.
" + "smithy.api#documentation": "Identifier for tracking the progress of the request. To query the operation status,\n\t\t\tuse GetOperationDetail.
" } } } @@ -1566,7 +2158,7 @@ } ], "traits": { - "smithy.api#documentation": "This operation deletes the specified tags for a domain.
\n\t\tAll tag operations are eventually consistent; subsequent operations might not immediately represent all issued operations.
" + "smithy.api#documentation": "This operation deletes the specified tags for a domain.
\nAll tag operations are eventually consistent; subsequent operations might not\n\t\t\timmediately represent all issued operations.
" } }, "com.amazonaws.route53domains#DeleteTagsForDomainRequest": { @@ -1612,7 +2204,7 @@ } ], "traits": { - "smithy.api#documentation": "This operation disables automatic renewal of domain registration for the specified domain.
" + "smithy.api#documentation": "This operation disables automatic renewal of domain registration for the specified\n\t\t\tdomain.
" } }, "com.amazonaws.route53domains#DisableDomainAutoRenewRequest": { @@ -1657,7 +2249,7 @@ } ], "traits": { - "smithy.api#documentation": "This operation removes the transfer lock on the domain (specifically the\n\t\t\tclientTransferProhibited status) to allow domain transfers. We recommend\n\t\t\tyou refrain from performing this action unless you intend to transfer the domain to a\n\t\t\tdifferent registrar. Successful submission returns an operation ID that you can use to track\n\t\t\tthe progress and completion of the action. If the request is not completed successfully, the\n\t\t\tdomain registrant will be notified by email.
This operation removes the transfer lock on the domain (specifically the\n\t\t\t\tclientTransferProhibited status) to allow domain transfers. We\n\t\t\trecommend you refrain from performing this action unless you intend to transfer the\n\t\t\tdomain to a different registrar. Successful submission returns an operation ID that you\n\t\t\tcan use to track the progress and completion of the action. If the request is not\n\t\t\tcompleted successfully, the domain registrant will be notified by email.
Identifier for tracking the progress of the request. To query the operation status, use \n\t\t\tGetOperationDetail.
", - "smithy.api#required": {} + "smithy.api#documentation": "Identifier for tracking the progress of the request. To query the operation status,\n\t\t\tuse GetOperationDetail.
" } } }, @@ -1690,6 +2281,169 @@ "smithy.api#documentation": "The DisableDomainTransferLock response includes the following element.
" } }, + "com.amazonaws.route53domains#DisassociateDelegationSignerFromDomain": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53domains#DisassociateDelegationSignerFromDomainRequest" + }, + "output": { + "target": "com.amazonaws.route53domains#DisassociateDelegationSignerFromDomainResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53domains#DuplicateRequest" + }, + { + "target": "com.amazonaws.route53domains#InvalidInput" + }, + { + "target": "com.amazonaws.route53domains#OperationLimitExceeded" + }, + { + "target": "com.amazonaws.route53domains#TLDRulesViolation" + }, + { + "target": "com.amazonaws.route53domains#UnsupportedTLD" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a delegation signer (DS) record in the registry zone for this domain\n\t\t\tname.
" + } + }, + "com.amazonaws.route53domains#DisassociateDelegationSignerFromDomainRequest": { + "type": "structure", + "members": { + "DomainName": { + "target": "com.amazonaws.route53domains#DomainName", + "traits": { + "smithy.api#documentation": "Name of the domain.
", + "smithy.api#required": {} + } + }, + "Id": { + "target": "com.amazonaws.route53domains#String", + "traits": { + "smithy.api#documentation": "An internal identification number assigned to each DS record after it’s created. You\n\t\t\tcan retrieve it as part of DNSSEC information returned by GetDomainDetail.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.route53domains#DisassociateDelegationSignerFromDomainResponse": { + "type": "structure", + "members": { + "OperationId": { + "target": "com.amazonaws.route53domains#OperationId", + "traits": { + "smithy.api#documentation": "Identifier for tracking the progress of the request. To query the operation status,\n\t\t\tuse GetOperationDetail.
" + } + } + } + }, + "com.amazonaws.route53domains#DnssecKey": { + "type": "structure", + "members": { + "Algorithm": { + "target": "com.amazonaws.route53domains#NullableInteger", + "traits": { + "smithy.api#documentation": "The number of the public key’s cryptographic algorithm according to an IANA assignment.
\nIf Route 53 is your DNS service, set this to 13.
\nFor more information about enabling DNSSEC signing, see Enabling DNSSEC signing and establishing a chain of trust.
" + } + }, + "Flags": { + "target": "com.amazonaws.route53domains#NullableInteger", + "traits": { + "smithy.api#documentation": "Defines the type of key. It can be either a KSK (key-signing-key, value 257) or ZSK\n\t\t\t(zone-signing-key, value 256). Using KSK is always encouraged. Only use ZSK if your DNS\n\t\t\tprovider isn't Route 53 and you don’t have KSK available.
\nIf you have KSK and ZSK keys, always use KSK to create a delegations signer (DS)\n\t\t\trecord. If you have ZSK keys only – use ZSK to create a DS record.
" + } + }, + "PublicKey": { + "target": "com.amazonaws.route53domains#DnssecPublicKey", + "traits": { + "smithy.api#documentation": "The base64-encoded public key part of the key pair that is passed to the registry\n\t\t\t.
" + } + }, + "DigestType": { + "target": "com.amazonaws.route53domains#NullableInteger", + "traits": { + "smithy.api#documentation": "The number of the DS digest algorithm according to an IANA assignment.
\nFor more information, see IANA\n\t\t\tfor DNSSEC Delegation Signer (DS) Resource Record (RR) Type Digest Algorithms.
" + } + }, + "Digest": { + "target": "com.amazonaws.route53domains#String", + "traits": { + "smithy.api#documentation": "The delegation signer digest.
\nDigest is calculated from the public key provided using specified digest algorithm and\n\t\t\tthis digest is the actual value returned from the registry nameservers as the value of\n\t\t\tDS records.
" + } + }, + "KeyTag": { + "target": "com.amazonaws.route53domains#NullableInteger", + "traits": { + "smithy.api#documentation": "A numeric identification of the DNSKEY record referred to by this DS record.
" + } + }, + "Id": { + "target": "com.amazonaws.route53domains#String", + "traits": { + "smithy.api#documentation": "An ID assigned to each DS record created by AssociateDelegationSignerToDomain.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about the DNSSEC key.
\nYou get this from your DNS provider and then give it to Route 53 (by using\n\t\t\t\tAssociateDelegationSignerToDomain) to pass it to the registry to establish\n\t\t\tthe chain of trust.
" + } + }, + "com.amazonaws.route53domains#DnssecKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.route53domains#DnssecKey" + } + }, + "com.amazonaws.route53domains#DnssecLimitExceeded": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53domains#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": " This error is returned if you call AssociateDelegationSignerToDomain\n\t\t\twhen the specified domain has reached the maximum number of DS records. You can't add\n\t\t\tany additional DS records unless you delete an existing one first.
Algorithm which was used to generate the digest from the public key.
" + } + }, + "Flags": { + "target": "com.amazonaws.route53domains#NullableInteger", + "traits": { + "smithy.api#documentation": "Defines the type of key. It can be either a KSK (key-signing-key, value 257) or ZSK\n\t\t\t(zone-signing-key, value 256). Using KSK is always encouraged. Only use ZSK if your DNS\n\t\t\tprovider isn't Route 53 and you don’t have KSK available.
\nIf you have KSK and ZSK keys, always use KSK to create a delegations signer (DS)\n\t\t\trecord. If you have ZSK keys only – use ZSK to create a DS record.
" + } + }, + "PublicKey": { + "target": "com.amazonaws.route53domains#DnssecPublicKey", + "traits": { + "smithy.api#documentation": "The base64-encoded public key part of the key pair that is passed to the registry.\n\t\t
" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about a delegation signer (DS) record that was created in the registry by\n\t\t\t\tAssociateDelegationSignerToDomain.
" + } + }, "com.amazonaws.route53domains#DomainAuthCode": { "type": "string", "traits": { @@ -1701,42 +2455,56 @@ } }, "com.amazonaws.route53domains#DomainAvailability": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "AVAILABLE", - "name": "AVAILABLE" - }, - { - "value": "AVAILABLE_RESERVED", - "name": "AVAILABLE_RESERVED" - }, - { - "value": "AVAILABLE_PREORDER", - "name": "AVAILABLE_PREORDER" - }, - { - "value": "UNAVAILABLE", - "name": "UNAVAILABLE" - }, - { - "value": "UNAVAILABLE_PREMIUM", - "name": "UNAVAILABLE_PREMIUM" - }, - { - "value": "UNAVAILABLE_RESTRICTED", - "name": "UNAVAILABLE_RESTRICTED" - }, - { - "value": "RESERVED", - "name": "RESERVED" - }, - { - "value": "DONT_KNOW", - "name": "DONT_KNOW" + "type": "enum", + "members": { + "AVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AVAILABLE" + } + }, + "AVAILABLE_RESERVED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AVAILABLE_RESERVED" + } + }, + "AVAILABLE_PREORDER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AVAILABLE_PREORDER" + } + }, + "UNAVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNAVAILABLE" + } + }, + "UNAVAILABLE_PREMIUM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNAVAILABLE_PREMIUM" + } + }, + "UNAVAILABLE_RESTRICTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNAVAILABLE_RESTRICTED" + } + }, + "RESERVED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RESERVED" + } + }, + "DONT_KNOW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DONT_KNOW" } - ] + } } }, "com.amazonaws.route53domains#DomainLimitExceeded": { @@ -1844,7 +2612,7 @@ "Availability": { "target": "com.amazonaws.route53domains#String", "traits": { - "smithy.api#documentation": "Whether the domain name is available for registering.
\n\t\tYou can register only the domains that are designated as AVAILABLE.
Valid values:
\n\t\tThe domain name is available.
\nThe domain name is reserved under specific conditions.
\nThe domain name is available and can be preordered.
\nThe TLD registry didn't reply with a definitive answer about whether the domain name is available. \n\t\t\t\t\tRoute 53 can return this response for a variety of reasons, for example, the registry is performing maintenance. \n\t\t\t\t\tTry again later.
\nThe TLD registry didn't return a response in the expected amount of time. When the response is delayed, \n\t\t\t\t\tit usually takes just a few extra seconds. You can resubmit the request immediately.
\nThe domain name has been reserved for another person or organization.
\nThe domain name is not available.
\nThe domain name is not available.
\nThe domain name is forbidden.
\nWhether the domain name is available for registering.
\nYou can register only the domains that are designated as\n\t\t\t\tAVAILABLE.
Valid values:
\nThe domain name is available.
\nThe domain name is reserved under specific conditions.
\nThe domain name is available and can be preordered.
\nThe TLD registry didn't reply with a definitive answer about whether the\n\t\t\t\t\t\tdomain name is available. Route 53 can return this response for a variety of\n\t\t\t\t\t\treasons, for example, the registry is performing maintenance. Try again\n\t\t\t\t\t\tlater.
\nThe TLD registry didn't return a response in the expected amount of time.\n\t\t\t\t\t\tWhen the response is delayed, it usually takes just a few extra seconds. You\n\t\t\t\t\t\tcan resubmit the request immediately.
\nThe domain name has been reserved for another person or\n\t\t\t\t\t\torganization.
\nThe domain name is not available.
\nThe domain name is not available.
\nThe domain name is forbidden.
\nThe name of the domain that the summary information applies to.
", - "smithy.api#required": {} + "smithy.api#documentation": "The name of the domain that the summary information applies to.
" } }, "AutoRenew": { @@ -1877,13 +2644,13 @@ "TransferLock": { "target": "com.amazonaws.route53domains#Boolean", "traits": { - "smithy.api#documentation": "Indicates whether a domain is locked from unauthorized transfer to another party.
" + "smithy.api#documentation": "Indicates whether a domain is locked from unauthorized transfer to another\n\t\t\tparty.
" } }, "Expiry": { "target": "com.amazonaws.route53domains#Timestamp", "traits": { - "smithy.api#documentation": "Expiration date of the domain in Unix time format and Coordinated Universal Time (UTC).
" + "smithy.api#documentation": "Expiration date of the domain in Unix time format and Coordinated Universal Time\n\t\t\t(UTC).
" } } }, @@ -1905,7 +2672,7 @@ } }, "traits": { - "smithy.api#documentation": "A complex type that contains information about whether the specified domain can be transferred to Route 53.
" + "smithy.api#documentation": "A complex type that contains information about whether the specified domain can be\n\t\t\ttransferred to Route 53.
" } }, "com.amazonaws.route53domains#DuplicateRequest": { @@ -1927,7 +2694,6 @@ "com.amazonaws.route53domains#DurationInYears": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 1, "max": 10 @@ -1963,7 +2729,7 @@ } ], "traits": { - "smithy.api#documentation": "This operation configures Amazon Route 53 to automatically renew the specified domain before the domain registration expires. \n\t\t\tThe cost of renewing your domain registration is billed to your Amazon Web Services account.
\n\t\tThe period during which you can renew a domain name varies by TLD. For a list of TLDs and their renewal policies, see \n\t\t\tDomains That You Can Register with Amazon Route 53 \n\t\t\tin the Amazon Route 53 Developer Guide. Route 53 requires that you renew before the end of the renewal period \n\t\t\tso we can complete processing before the deadline.
" + "smithy.api#documentation": "This operation configures Amazon Route 53 to automatically renew the specified domain\n\t\t\tbefore the domain registration expires. The cost of renewing your domain registration is\n\t\t\tbilled to your Amazon Web Services account.
\nThe period during which you can renew a domain name varies by TLD. For a list of TLDs\n\t\t\tand their renewal policies, see Domains That You Can\n\t\t\t\tRegister with Amazon Route 53 in the Amazon Route 53 Developer\n\t\t\t\tGuide. Route 53 requires that you renew before the end of the renewal\n\t\t\tperiod so we can complete processing before the deadline.
" } }, "com.amazonaws.route53domains#EnableDomainAutoRenewRequest": { @@ -2008,7 +2774,7 @@ } ], "traits": { - "smithy.api#documentation": "This operation sets the transfer lock on the domain (specifically the clientTransferProhibited status) \n\t\t\tto prevent domain transfers. Successful submission returns an operation ID that you can use to track the progress and \n\t\t\tcompletion of the action. If the request is not completed successfully, the domain registrant will be notified by email.
This operation sets the transfer lock on the domain (specifically the\n\t\t\t\tclientTransferProhibited status) to prevent domain transfers.\n\t\t\tSuccessful submission returns an operation ID that you can use to track the progress and\n\t\t\tcompletion of the action. If the request is not completed successfully, the domain\n\t\t\tregistrant will be notified by email.
Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail.
", - "smithy.api#required": {} + "smithy.api#documentation": "Identifier for tracking the progress of the request. To use this ID to query the\n\t\t\toperation status, use GetOperationDetail.
" } } }, @@ -2050,153 +2815,217 @@ "Name": { "target": "com.amazonaws.route53domains#ExtraParamName", "traits": { - "smithy.api#documentation": "The name of an additional parameter that is required by a top-level domain. Here are the top-level domains that require \n\t\t\tadditional parameters and the names of the parameters that they require:
\n\n\t\t\n AU_ID_NUMBER\n
\n AU_ID_TYPE\n
Valid values include the following:
\n\t\t\t\t\t\t\t\n ABN (Australian business number)
\n ACN (Australian company number)
\n TM (Trademark number)
\n BRAND_NUMBER\n
\n CA_BUSINESS_ENTITY_TYPE\n
Valid values include the following:
\n\t\t\t\t\t\t\t\n BANK (Bank)
\n COMMERCIAL_COMPANY (Commercial company)
\n COMPANY (Company)
\n COOPERATION (Cooperation)
\n COOPERATIVE (Cooperative)
\n COOPRIX (Cooprix)
\n CORP (Corporation)
\n CREDIT_UNION (Credit union)
\n FOMIA (Federation of mutual insurance associations)
\n INC (Incorporated)
\n LTD (Limited)
\n LTEE (Limitée)
\n LLC (Limited liability corporation)
\n LLP (Limited liability partnership)
\n LTE (Lte.)
\n MBA (Mutual benefit association)
\n MIC (Mutual insurance company)
\n NFP (Not-for-profit corporation)
\n SA (S.A.)
\n SAVINGS_COMPANY (Savings company)
\n SAVINGS_UNION (Savings union)
\n SARL (Société à responsabilité limitée)
\n TRUST (Trust)
\n ULC (Unlimited liability corporation)
\n CA_LEGAL_TYPE\n
When ContactType is PERSON, valid values include the following:
\n ABO (Aboriginal Peoples indigenous to Canada)
\n CCT (Canadian citizen)
\n LGR (Legal Representative of a Canadian Citizen or Permanent Resident)
\n RES (Permanent resident of Canada)
When ContactType is a value other than PERSON, valid values include the following:
\n ASS (Canadian unincorporated association)
\n CCO (Canadian corporation)
\n EDU (Canadian educational institution)
\n GOV (Government or government entity in Canada)
\n HOP (Canadian Hospital)
\n INB (Indian Band recognized by the Indian Act of Canada)
\n LAM (Canadian Library, Archive, or Museum)
\n MAJ (Her/His Majesty the Queen/King)
\n OMK (Official mark registered in Canada)
\n PLT (Canadian Political Party)
\n PRT (Partnership Registered in Canada)
\n TDM (Trademark registered in Canada)
\n TRD (Canadian Trade Union)
\n TRS (Trust established in Canada)
\n ES_IDENTIFICATION\n
The value of ES_IDENTIFICATION depends on the following values:
The value of ES_LEGAL_FORM\n
The value of ES_IDENTIFICATION_TYPE\n
\n If ES_LEGAL_FORM is any value other than INDIVIDUAL:\n
Specify 1 letter + 8 numbers (CIF [Certificado de Identificación Fiscal])
\nExample: B12345678
\n\n If ES_LEGAL_FORM is INDIVIDUAL, the value that you specify for \n\t\t\t\t\t\t\t\tES_IDENTIFICATION depends on the value of ES_IDENTIFICATION_TYPE:\n
If ES_IDENTIFICATION_TYPE is DNI_AND_NIF (for Spanish contacts):
Specify 8 numbers + 1 letter (DNI [Documento Nacional de Identidad], NIF [Número de Identificación Fiscal])
\nExample: 12345678M
\nIf ES_IDENTIFICATION_TYPE is NIE (for foreigners with legal residence):
Specify 1 letter + 7 numbers + 1 letter ( NIE [Número de Identidad de Extranjero])
\nExample: Y1234567X
\nIf ES_IDENTIFICATION_TYPE is OTHER (for contacts outside of Spain):
Specify a passport number, drivers license number, or national identity card number
\n\n ES_IDENTIFICATION_TYPE\n
Valid values include the following:
\n\t\t\t\t\t\t\t\n DNI_AND_NIF (For Spanish contacts)
\n NIE (For foreigners with legal residence)
\n OTHER (For contacts outside of Spain)
\n ES_LEGAL_FORM\n
Valid values include the following:
\n\t\t\t\t\t\t\t\n ASSOCIATION\n
\n CENTRAL_GOVERNMENT_BODY\n
\n CIVIL_SOCIETY\n
\n COMMUNITY_OF_OWNERS\n
\n COMMUNITY_PROPERTY\n
\n CONSULATE\n
\n COOPERATIVE\n
\n DESIGNATION_OF_ORIGIN_SUPERVISORY_COUNCIL\n
\n ECONOMIC_INTEREST_GROUP\n
\n EMBASSY\n
\n ENTITY_MANAGING_NATURAL_AREAS\n
\n FARM_PARTNERSHIP\n
\n FOUNDATION\n
\n GENERAL_AND_LIMITED_PARTNERSHIP\n
\n GENERAL_PARTNERSHIP\n
\n INDIVIDUAL\n
\n LIMITED_COMPANY\n
\n LOCAL_AUTHORITY\n
\n LOCAL_PUBLIC_ENTITY\n
\n MUTUAL_INSURANCE_COMPANY\n
\n NATIONAL_PUBLIC_ENTITY\n
\n ORDER_OR_RELIGIOUS_INSTITUTION\n
\n OTHERS (Only for contacts outside of Spain)\n
\n POLITICAL_PARTY\n
\n PROFESSIONAL_ASSOCIATION\n
\n PUBLIC_LAW_ASSOCIATION\n
\n PUBLIC_LIMITED_COMPANY\n
\n REGIONAL_GOVERNMENT_BODY\n
\n REGIONAL_PUBLIC_ENTITY\n
\n SAVINGS_BANK\n
\n SPANISH_OFFICE\n
\n SPORTS_ASSOCIATION\n
\n SPORTS_FEDERATION\n
\n SPORTS_LIMITED_COMPANY\n
\n TEMPORARY_ALLIANCE_OF_ENTERPRISES\n
\n TRADE_UNION\n
\n WORKER_OWNED_COMPANY\n
\n WORKER_OWNED_LIMITED_COMPANY\n
\n EU_COUNTRY_OF_CITIZENSHIP\n
\n BIRTH_DATE_IN_YYYY_MM_DD\n
\n FI_BUSINESS_NUMBER\n
\n FI_ID_NUMBER\n
\n FI_NATIONALITY\n
Valid values include the following:
\n\t\t\t\t\t\t\t\n FINNISH\n
\n NOT_FINNISH\n
\n FI_ORGANIZATION_TYPE\n
Valid values include the following:
\n\t\t\t\t\t\t\t\n COMPANY\n
\n CORPORATION\n
\n GOVERNMENT\n
\n INSTITUTION\n
\n POLITICAL_PARTY\n
\n PUBLIC_COMMUNITY\n
\n TOWNSHIP\n
\n BIRTH_CITY\n
\n BIRTH_COUNTRY\n
\n BIRTH_DATE_IN_YYYY_MM_DD\n
\n BIRTH_DEPARTMENT: Specify the INSEE code that corresponds with the department where the contact was born. \n\t\t\t\t\t\t\tIf the contact was born somewhere other than France or its overseas departments, specify 99. For more information, \n\t\t\t\t\t\t\tincluding a list of departments and the corresponding INSEE numbers, see the Wikipedia entry \n\t\t\t\t\t\t\tDepartments of France.
\n BRAND_NUMBER\n
\n IT_NATIONALITY\n
\n IT_PIN\n
\n IT_REGISTRANT_ENTITY_TYPE\n
Valid values include the following:
\n\t\t\t\t\t\t\t\n FOREIGNERS\n
\n FREELANCE_WORKERS (Freelance workers and professionals)
\n ITALIAN_COMPANIES (Italian companies and one-person companies)
\n NON_PROFIT_ORGANIZATIONS\n
\n OTHER_SUBJECTS\n
\n PUBLIC_ORGANIZATIONS\n
\n BIRTH_DATE_IN_YYYY_MM_DD\n
\n RU_PASSPORT_DATA\n
\n BIRTH_COUNTRY\n
\n SE_ID_NUMBER\n
\n SG_ID_NUMBER\n
\n UK_CONTACT_TYPE\n
Valid values include the following:
\n\t\t\t\t\t\t\t\n CRC (UK Corporation by Royal Charter)
\n FCORP (Non-UK Corporation)
\n FIND (Non-UK Individual, representing self)
\n FOTHER (Non-UK Entity that does not fit into any other category)
\n GOV (UK Government Body)
\n IND (UK Individual (representing self))
\n IP (UK Industrial/Provident Registered Company)
\n LLP (UK Limited Liability Partnership)
\n LTD (UK Limited Company)
\n OTHER (UK Entity that does not fit into any other category)
\n PLC (UK Public Limited Company)
\n PTNR (UK Partnership)
\n RCHAR (UK Registered Charity)
\n SCH (UK School)
\n STAT (UK Statutory Body)
\n STRA (UK Sole Trader)
\n UK_COMPANY_NUMBER\n
In addition, many TLDs require a VAT_NUMBER.
The name of an additional parameter that is required by a top-level domain. Here are\n\t\t\tthe top-level domains that require additional parameters and the names of the parameters\n\t\t\tthat they require:
\n\n AU_ID_NUMBER\n
\n AU_ID_TYPE\n
Valid values include the following:
\n\n ABN (Australian business number)
\n ACN (Australian company number)
\n TM (Trademark number)
\n BRAND_NUMBER\n
\n CA_BUSINESS_ENTITY_TYPE\n
Valid values include the following:
\n\n BANK (Bank)
\n COMMERCIAL_COMPANY (Commercial\n\t\t\t\t\t\t\t\t\t\tcompany)
\n COMPANY (Company)
\n COOPERATION (Cooperation)
\n COOPERATIVE (Cooperative)
\n COOPRIX (Cooprix)
\n CORP (Corporation)
\n CREDIT_UNION (Credit union)
\n FOMIA (Federation of mutual insurance\n\t\t\t\t\t\t\t\t\t\tassociations)
\n INC (Incorporated)
\n LTD (Limited)
\n LTEE (Limitée)
\n LLC (Limited liability corporation)
\n LLP (Limited liability partnership)
\n LTE (Lte.)
\n MBA (Mutual benefit association)
\n MIC (Mutual insurance company)
\n NFP (Not-for-profit corporation)
\n SA (S.A.)
\n SAVINGS_COMPANY (Savings company)
\n SAVINGS_UNION (Savings union)
\n SARL (Société à responsabilité\n\t\t\t\t\t\t\t\t\t\tlimitée)
\n TRUST (Trust)
\n ULC (Unlimited liability corporation)
\n CA_LEGAL_TYPE\n
When ContactType is PERSON, valid values\n\t\t\t\t\t\t\t\tinclude the following:
\n ABO (Aboriginal Peoples indigenous to\n\t\t\t\t\t\t\t\t\t\tCanada)
\n CCT (Canadian citizen)
\n LGR (Legal Representative of a Canadian\n\t\t\t\t\t\t\t\t\t\tCitizen or Permanent Resident)
\n RES (Permanent resident of Canada)
When ContactType is a value other than\n\t\t\t\t\t\t\t\t\tPERSON, valid values include the following:
\n ASS (Canadian unincorporated\n\t\t\t\t\t\t\t\t\t\tassociation)
\n CCO (Canadian corporation)
\n EDU (Canadian educational institution)
\n GOV (Government or government entity in\n\t\t\t\t\t\t\t\t\t\tCanada)
\n HOP (Canadian Hospital)
\n INB (Indian Band recognized by the Indian Act\n\t\t\t\t\t\t\t\t\t\tof Canada)
\n LAM (Canadian Library, Archive, or\n\t\t\t\t\t\t\t\t\t\tMuseum)
\n MAJ (Her/His Majesty the Queen/King)
\n OMK (Official mark registered in\n\t\t\t\t\t\t\t\t\t\tCanada)
\n PLT (Canadian Political Party)
\n PRT (Partnership Registered in Canada)
\n TDM (Trademark registered in Canada)
\n TRD (Canadian Trade Union)
\n TRS (Trust established in Canada)
\n ES_IDENTIFICATION\n
The value of ES_IDENTIFICATION depends on the\n\t\t\t\t\t\t\t\tfollowing values:
The value of ES_LEGAL_FORM\n
The value of ES_IDENTIFICATION_TYPE\n
\n If ES_LEGAL_FORM is any value\n\t\t\t\t\t\t\t\t\tother than INDIVIDUAL:\n
Specify 1 letter + 8 numbers (CIF [Certificado de\n\t\t\t\t\t\t\t\t\t\tIdentificación Fiscal])
\nExample: B12345678
\n\n If ES_LEGAL_FORM is\n\t\t\t\t\t\t\t\t\t\tINDIVIDUAL, the value that you specify for\n\t\t\t\t\t\t\t\t\t\tES_IDENTIFICATION depends on the value of\n\t\t\t\t\t\t\t\t\t\tES_IDENTIFICATION_TYPE:\n
If ES_IDENTIFICATION_TYPE is\n\t\t\t\t\t\t\t\t\t\t\tDNI_AND_NIF (for Spanish contacts):
Specify 8 numbers + 1 letter (DNI [Documento\n\t\t\t\t\t\t\t\t\t\t\t\tNacional de Identidad], NIF [Número de\n\t\t\t\t\t\t\t\t\t\t\t\tIdentificación Fiscal])
\nExample: 12345678M
\nIf ES_IDENTIFICATION_TYPE is NIE\n\t\t\t\t\t\t\t\t\t\t(for foreigners with legal residence):
Specify 1 letter + 7 numbers + 1 letter ( NIE\n\t\t\t\t\t\t\t\t\t\t\t\t[Número de Identidad de Extranjero])
\nExample: Y1234567X
\nIf ES_IDENTIFICATION_TYPE is\n\t\t\t\t\t\t\t\t\t\t\tOTHER (for contacts outside of\n\t\t\t\t\t\t\t\t\t\tSpain):
Specify a passport number, drivers license number,\n\t\t\t\t\t\t\t\t\t\t\t\tor national identity card number
\n\n ES_IDENTIFICATION_TYPE\n
Valid values include the following:
\n\n DNI_AND_NIF (For Spanish contacts)
\n NIE (For foreigners with legal\n\t\t\t\t\t\t\t\t\t\tresidence)
\n OTHER (For contacts outside of Spain)
\n ES_LEGAL_FORM\n
Valid values include the following:
\n\n ASSOCIATION\n
\n CENTRAL_GOVERNMENT_BODY\n
\n CIVIL_SOCIETY\n
\n COMMUNITY_OF_OWNERS\n
\n COMMUNITY_PROPERTY\n
\n CONSULATE\n
\n COOPERATIVE\n
\n DESIGNATION_OF_ORIGIN_SUPERVISORY_COUNCIL\n
\n ECONOMIC_INTEREST_GROUP\n
\n EMBASSY\n
\n ENTITY_MANAGING_NATURAL_AREAS\n
\n FARM_PARTNERSHIP\n
\n FOUNDATION\n
\n GENERAL_AND_LIMITED_PARTNERSHIP\n
\n GENERAL_PARTNERSHIP\n
\n INDIVIDUAL\n
\n LIMITED_COMPANY\n
\n LOCAL_AUTHORITY\n
\n LOCAL_PUBLIC_ENTITY\n
\n MUTUAL_INSURANCE_COMPANY\n
\n NATIONAL_PUBLIC_ENTITY\n
\n ORDER_OR_RELIGIOUS_INSTITUTION\n
\n OTHERS (Only for contacts outside of\n\t\t\t\t\t\t\t\t\t\tSpain)\n
\n POLITICAL_PARTY\n
\n PROFESSIONAL_ASSOCIATION\n
\n PUBLIC_LAW_ASSOCIATION\n
\n PUBLIC_LIMITED_COMPANY\n
\n REGIONAL_GOVERNMENT_BODY\n
\n REGIONAL_PUBLIC_ENTITY\n
\n SAVINGS_BANK\n
\n SPANISH_OFFICE\n
\n SPORTS_ASSOCIATION\n
\n SPORTS_FEDERATION\n
\n SPORTS_LIMITED_COMPANY\n
\n TEMPORARY_ALLIANCE_OF_ENTERPRISES\n
\n TRADE_UNION\n
\n WORKER_OWNED_COMPANY\n
\n WORKER_OWNED_LIMITED_COMPANY\n
\n EU_COUNTRY_OF_CITIZENSHIP\n
\n BIRTH_DATE_IN_YYYY_MM_DD\n
\n FI_BUSINESS_NUMBER\n
\n FI_ID_NUMBER\n
\n FI_NATIONALITY\n
Valid values include the following:
\n\n FINNISH\n
\n NOT_FINNISH\n
\n FI_ORGANIZATION_TYPE\n
Valid values include the following:
\n\n COMPANY\n
\n CORPORATION\n
\n GOVERNMENT\n
\n INSTITUTION\n
\n POLITICAL_PARTY\n
\n PUBLIC_COMMUNITY\n
\n TOWNSHIP\n
\n BIRTH_CITY\n
\n BIRTH_COUNTRY\n
\n BIRTH_DATE_IN_YYYY_MM_DD\n
\n BIRTH_DEPARTMENT: Specify the INSEE code that\n\t\t\t\t\t\t\t\tcorresponds with the department where the contact was born. If the\n\t\t\t\t\t\t\t\tcontact was born somewhere other than France or its overseas\n\t\t\t\t\t\t\t\tdepartments, specify 99. For more information,\n\t\t\t\t\t\t\t\tincluding a list of departments and the corresponding INSEE numbers,\n\t\t\t\t\t\t\t\tsee the Wikipedia entry Departments of France.
\n BRAND_NUMBER\n
\n IT_NATIONALITY\n
\n IT_PIN\n
\n IT_REGISTRANT_ENTITY_TYPE\n
Valid values include the following:
\n\n FOREIGNERS\n
\n FREELANCE_WORKERS (Freelance workers and\n\t\t\t\t\t\t\t\t\t\tprofessionals)
\n ITALIAN_COMPANIES (Italian companies and\n\t\t\t\t\t\t\t\t\t\tone-person companies)
\n NON_PROFIT_ORGANIZATIONS\n
\n OTHER_SUBJECTS\n
\n PUBLIC_ORGANIZATIONS\n
\n BIRTH_DATE_IN_YYYY_MM_DD\n
\n RU_PASSPORT_DATA\n
\n BIRTH_COUNTRY\n
\n SE_ID_NUMBER\n
\n SG_ID_NUMBER\n
\n UK_CONTACT_TYPE\n
Valid values include the following:
\n\n CRC (UK Corporation by Royal Charter)
\n FCORP (Non-UK Corporation)
\n FIND (Non-UK Individual, representing\n\t\t\t\t\t\t\t\t\t\tself)
\n FOTHER (Non-UK Entity that does not fit into\n\t\t\t\t\t\t\t\t\t\tany other category)
\n GOV (UK Government Body)
\n IND (UK Individual (representing\n\t\t\t\t\t\t\t\t\t\tself))
\n IP (UK Industrial/Provident Registered\n\t\t\t\t\t\t\t\t\t\tCompany)
\n LLP (UK Limited Liability Partnership)
\n LTD (UK Limited Company)
\n OTHER (UK Entity that does not fit into any\n\t\t\t\t\t\t\t\t\t\tother category)
\n PLC (UK Public Limited Company)
\n PTNR (UK Partnership)
\n RCHAR (UK Registered Charity)
\n SCH (UK School)
\n STAT (UK Statutory Body)
\n STRA (UK Sole Trader)
\n UK_COMPANY_NUMBER\n
In addition, many TLDs require a VAT_NUMBER.
The value that corresponds with the name of an extra parameter.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "ExtraParam includes the following elements.
" + } + }, + "com.amazonaws.route53domains#ExtraParamList": { + "type": "list", + "member": { + "target": "com.amazonaws.route53domains#ExtraParam" + } + }, + "com.amazonaws.route53domains#ExtraParamName": { + "type": "enum", + "members": { + "DUNS_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DUNS_NUMBER" + } + }, + "BRAND_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BRAND_NUMBER" + } + }, + "BIRTH_DEPARTMENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BIRTH_DEPARTMENT" + } + }, + "BIRTH_DATE_IN_YYYY_MM_DD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BIRTH_DATE_IN_YYYY_MM_DD" + } + }, + "BIRTH_COUNTRY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BIRTH_COUNTRY" + } + }, + "BIRTH_CITY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BIRTH_CITY" + } + }, + "DOCUMENT_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DOCUMENT_NUMBER" + } + }, + "AU_ID_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AU_ID_NUMBER" + } + }, + "AU_ID_TYPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AU_ID_TYPE" + } + }, + "CA_LEGAL_TYPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CA_LEGAL_TYPE" + } + }, + "CA_BUSINESS_ENTITY_TYPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CA_BUSINESS_ENTITY_TYPE" + } + }, + "CA_LEGAL_REPRESENTATIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CA_LEGAL_REPRESENTATIVE" + } + }, + "CA_LEGAL_REPRESENTATIVE_CAPACITY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CA_LEGAL_REPRESENTATIVE_CAPACITY" + } + }, + "ES_IDENTIFICATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ES_IDENTIFICATION" + } + }, + "ES_IDENTIFICATION_TYPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ES_IDENTIFICATION_TYPE" + } + }, + "ES_LEGAL_FORM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ES_LEGAL_FORM" + } + }, + "FI_BUSINESS_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FI_BUSINESS_NUMBER" + } + }, + "ONWER_FI_ID_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FI_ID_NUMBER" + } + }, + "FI_NATIONALITY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FI_NATIONALITY" + } + }, + "FI_ORGANIZATION_TYPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FI_ORGANIZATION_TYPE" + } + }, + "IT_NATIONALITY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IT_NATIONALITY" + } + }, + "IT_PIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IT_PIN" + } + }, + "IT_REGISTRANT_ENTITY_TYPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IT_REGISTRANT_ENTITY_TYPE" + } + }, + "RU_PASSPORT_DATA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RU_PASSPORT_DATA" + } + }, + "SE_ID_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SE_ID_NUMBER" + } + }, + "SG_ID_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SG_ID_NUMBER" } }, - "Value": { - "target": "com.amazonaws.route53domains#ExtraParamValue", + "VAT_NUMBER": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The value that corresponds with the name of an extra parameter.
", - "smithy.api#required": {} + "smithy.api#enumValue": "VAT_NUMBER" } - } - }, - "traits": { - "smithy.api#documentation": "ExtraParam includes the following elements.
" - } - }, - "com.amazonaws.route53domains#ExtraParamList": { - "type": "list", - "member": { - "target": "com.amazonaws.route53domains#ExtraParam" - } - }, - "com.amazonaws.route53domains#ExtraParamName": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "DUNS_NUMBER", - "name": "DUNS_NUMBER" - }, - { - "value": "BRAND_NUMBER", - "name": "BRAND_NUMBER" - }, - { - "value": "BIRTH_DEPARTMENT", - "name": "BIRTH_DEPARTMENT" - }, - { - "value": "BIRTH_DATE_IN_YYYY_MM_DD", - "name": "BIRTH_DATE_IN_YYYY_MM_DD" - }, - { - "value": "BIRTH_COUNTRY", - "name": "BIRTH_COUNTRY" - }, - { - "value": "BIRTH_CITY", - "name": "BIRTH_CITY" - }, - { - "value": "DOCUMENT_NUMBER", - "name": "DOCUMENT_NUMBER" - }, - { - "value": "AU_ID_NUMBER", - "name": "AU_ID_NUMBER" - }, - { - "value": "AU_ID_TYPE", - "name": "AU_ID_TYPE" - }, - { - "value": "CA_LEGAL_TYPE", - "name": "CA_LEGAL_TYPE" - }, - { - "value": "CA_BUSINESS_ENTITY_TYPE", - "name": "CA_BUSINESS_ENTITY_TYPE" - }, - { - "value": "CA_LEGAL_REPRESENTATIVE", - "name": "CA_LEGAL_REPRESENTATIVE" - }, - { - "value": "CA_LEGAL_REPRESENTATIVE_CAPACITY", - "name": "CA_LEGAL_REPRESENTATIVE_CAPACITY" - }, - { - "value": "ES_IDENTIFICATION", - "name": "ES_IDENTIFICATION" - }, - { - "value": "ES_IDENTIFICATION_TYPE", - "name": "ES_IDENTIFICATION_TYPE" - }, - { - "value": "ES_LEGAL_FORM", - "name": "ES_LEGAL_FORM" - }, - { - "value": "FI_BUSINESS_NUMBER", - "name": "FI_BUSINESS_NUMBER" - }, - { - "value": "FI_ID_NUMBER", - "name": "ONWER_FI_ID_NUMBER" - }, - { - "value": "FI_NATIONALITY", - "name": "FI_NATIONALITY" - }, - { - "value": "FI_ORGANIZATION_TYPE", - "name": "FI_ORGANIZATION_TYPE" - }, - { - "value": "IT_NATIONALITY", - "name": "IT_NATIONALITY" - }, - { - "value": "IT_PIN", - "name": "IT_PIN" - }, - { - "value": "IT_REGISTRANT_ENTITY_TYPE", - "name": "IT_REGISTRANT_ENTITY_TYPE" - }, - { - "value": "RU_PASSPORT_DATA", - "name": "RU_PASSPORT_DATA" - }, - { - "value": "SE_ID_NUMBER", - "name": "SE_ID_NUMBER" - }, - { - "value": "SG_ID_NUMBER", - "name": "SG_ID_NUMBER" - }, - { - "value": "VAT_NUMBER", - "name": "VAT_NUMBER" - }, - { - "value": "UK_CONTACT_TYPE", - "name": "UK_CONTACT_TYPE" - }, - { - "value": "UK_COMPANY_NUMBER", - "name": "UK_COMPANY_NUMBER" - }, - { - "value": "EU_COUNTRY_OF_CITIZENSHIP", - "name": "EU_COUNTRY_OF_CITIZENSHIP" + }, + "UK_CONTACT_TYPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UK_CONTACT_TYPE" + } + }, + "UK_COMPANY_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UK_COMPANY_NUMBER" + } + }, + "EU_COUNTRY_OF_CITIZENSHIP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EU_COUNTRY_OF_CITIZENSHIP" + } + }, + "AU_PRIORITY_TOKEN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AU_PRIORITY_TOKEN" } - ] + } } }, "com.amazonaws.route53domains#ExtraParamValue": { @@ -2232,20 +3061,20 @@ "Operator": { "target": "com.amazonaws.route53domains#Operator", "traits": { - "smithy.api#documentation": "The operator values for filtering domain names. The values can be:
\n\t\t\n LE: Less than, or equal to
\n GE: Greater than, or equal to
\n BEGINS_WITH: Begins with
The operator values for filtering domain names. The values can be:
\n\n LE: Less than, or equal to
\n GE: Greater than, or equal to
\n BEGINS_WITH: Begins with
An array of strings presenting values to compare. Only 1 item in the list is currently supported.
", + "smithy.api#documentation": "An array of strings presenting values to compare. Only 1 item in the list is\n\t\t\tcurrently supported.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Information for the filtering of a list of domains returned by \n\t\t\tListDomains.
" + "smithy.api#documentation": "Information for the filtering of a list of domains returned by ListDomains.
" } }, "com.amazonaws.route53domains#FilterConditions": { @@ -2274,7 +3103,7 @@ } ], "traits": { - "smithy.api#documentation": "For operations that require confirmation that the email address for the registrant contact is valid, \n\t\t\tsuch as registering a new domain, this operation returns information about whether the registrant contact has responded.
\n\t\tIf you want us to resend the email, use the ResendContactReachabilityEmail operation.
For operations that require confirmation that the email address for the registrant\n\t\t\tcontact is valid, such as registering a new domain, this operation returns information\n\t\t\tabout whether the registrant contact has responded.
\nIf you want us to resend the email, use the\n\t\t\t\tResendContactReachabilityEmail operation.
The name of the domain for which you want to know whether the registrant contact has confirmed that the email address is valid.
" + "smithy.api#documentation": "The name of the domain for which you want to know whether the registrant contact has\n\t\t\tconfirmed that the email address is valid.
" } } } @@ -2300,7 +3129,7 @@ "status": { "target": "com.amazonaws.route53domains#ReachabilityStatus", "traits": { - "smithy.api#documentation": "Whether the registrant contact has responded. Values include the following:
\n\t\tWe sent the confirmation email and haven't received a response yet.
\nWe sent the email and got confirmation from the registrant contact.
\nThe time limit expired before the registrant contact responded.
\nWhether the registrant contact has responded. Values include the following:
\nWe sent the confirmation email and haven't received a response yet.
\nWe sent the email and got confirmation from the registrant contact.
\nThe time limit expired before the registrant contact responded.
\nThis operation returns detailed information about a specified domain that is associated with the current Amazon Web Services account. \n\t\t\tContact information for the domain is also returned as part of the output.
" + "smithy.api#documentation": "This operation returns detailed information about a specified domain that is\n\t\t\tassociated with the current Amazon Web Services account. Contact information for the\n\t\t\tdomain is also returned as part of the output.
" } }, "com.amazonaws.route53domains#GetDomainDetailRequest": { @@ -2346,15 +3175,13 @@ "DomainName": { "target": "com.amazonaws.route53domains#DomainName", "traits": { - "smithy.api#documentation": "The name of a domain.
", - "smithy.api#required": {} + "smithy.api#documentation": "The name of a domain.
" } }, "Nameservers": { "target": "com.amazonaws.route53domains#NameserverList", "traits": { - "smithy.api#documentation": "The\n\t\t\tname of the domain.
", - "smithy.api#required": {} + "smithy.api#documentation": "The name servers of the domain.
" } }, "AutoRenew": { @@ -2366,52 +3193,49 @@ "AdminContact": { "target": "com.amazonaws.route53domains#ContactDetail", "traits": { - "smithy.api#documentation": "Provides details about the domain administrative contact.
", - "smithy.api#required": {} + "smithy.api#documentation": "Provides details about the domain administrative contact.
" } }, "RegistrantContact": { "target": "com.amazonaws.route53domains#ContactDetail", "traits": { - "smithy.api#documentation": "Provides details about the domain registrant.
", - "smithy.api#required": {} + "smithy.api#documentation": "Provides details about the domain registrant.
" } }, "TechContact": { "target": "com.amazonaws.route53domains#ContactDetail", "traits": { - "smithy.api#documentation": "Provides details about the domain technical contact.
", - "smithy.api#required": {} + "smithy.api#documentation": "Provides details about the domain technical contact.
" } }, "AdminPrivacy": { "target": "com.amazonaws.route53domains#Boolean", "traits": { - "smithy.api#documentation": "Specifies whether contact information is concealed from WHOIS\n\t\t\tqueries. If the value is true, WHOIS (\"who is\") queries return contact\n\t\t\tinformation either for Amazon Registrar (for .com, .net, and .org domains) or for our\n\t\t\tregistrar associate, Gandi (for all other TLDs). If the value is false,\n\t\t\tWHOIS queries return the information that you entered for the admin contact.
Specifies whether contact information is concealed from WHOIS queries. If the value is\n\t\t\t\ttrue, WHOIS (\"who is\") queries return contact information either for\n\t\t\tAmazon Registrar (for .com, .net, and .org domains) or for our registrar associate,\n\t\t\tGandi (for all other TLDs). If the value is false, WHOIS queries return the\n\t\t\tinformation that you entered for the admin contact.
Specifies whether contact information is concealed from WHOIS queries. If the value is true, \n\t\t\tWHOIS (\"who is\") queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) \n\t\t\tor for our registrar associate, Gandi (for all other TLDs). If the value is false, \n\t\t\tWHOIS queries return the information that you entered for the registrant contact (domain owner).
Specifies whether contact information is concealed from WHOIS queries. If the value is\n\t\t\t\ttrue, WHOIS (\"who is\") queries return contact information either for\n\t\t\tAmazon Registrar (for .com, .net, and .org domains) or for our registrar associate,\n\t\t\tGandi (for all other TLDs). If the value is false, WHOIS queries return the\n\t\t\tinformation that you entered for the registrant contact (domain owner).
Specifies whether contact information is concealed from WHOIS queries. If the value is true, \n\t\t\tWHOIS (\"who is\") queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) \n\t\t\tor for our registrar associate, Gandi (for all other TLDs). If the value is false, \n\t\t\tWHOIS queries return the information that you entered for the technical contact.
Specifies whether contact information is concealed from WHOIS queries. If the value is\n\t\t\t\ttrue, WHOIS (\"who is\") queries return contact information either for\n\t\t\tAmazon Registrar (for .com, .net, and .org domains) or for our registrar associate,\n\t\t\tGandi (for all other TLDs). If the value is false, WHOIS queries return the\n\t\t\tinformation that you entered for the technical contact.
Name of the registrar of the domain as identified in the registry. Domains with a .com, .net, or .org TLD are registered by \n\t\t\tAmazon Registrar. All other domains are registered by our registrar associate, Gandi. The value for domains that are registered by \n\t\t\tGandi is \"GANDI SAS\".
Name of the registrar of the domain as identified in the registry. Domains with a\n\t\t\t.com, .net, or .org TLD are registered by Amazon Registrar. All other domains are\n\t\t\tregistered by our registrar associate, Gandi. The value for domains that are registered\n\t\t\tby Gandi is \"GANDI SAS\".
The fully qualified name of the WHOIS server that can answer the WHOIS query for the domain.
" + "smithy.api#documentation": "The fully qualified name of the WHOIS server that can answer the WHOIS query for the\n\t\t\tdomain.
" } }, "RegistrarUrl": { @@ -2423,7 +3247,7 @@ "AbuseContactEmail": { "target": "com.amazonaws.route53domains#Email", "traits": { - "smithy.api#documentation": "Email address to contact to report incorrect contact information for a domain, to report that the domain \n\t\t\tis being used to send spam, to report that someone is cybersquatting on a domain name, or report some other type of abuse.
" + "smithy.api#documentation": "Email address to contact to report incorrect contact information for a domain, to\n\t\t\treport that the domain is being used to send spam, to report that someone is\n\t\t\tcybersquatting on a domain name, or report some other type of abuse.
" } }, "AbuseContactPhone": { @@ -2441,25 +3265,25 @@ "CreationDate": { "target": "com.amazonaws.route53domains#Timestamp", "traits": { - "smithy.api#documentation": "The date when the domain was created as found in the response to a WHOIS query. The date and time is in \n\t\t\tUnix time format and Coordinated Universal time (UTC).
" + "smithy.api#documentation": "The date when the domain was created as found in the response to a WHOIS query. The\n\t\t\tdate and time is in Unix time format and Coordinated Universal time (UTC).
" } }, "UpdatedDate": { "target": "com.amazonaws.route53domains#Timestamp", "traits": { - "smithy.api#documentation": "The last updated date of the domain as found in the response to a WHOIS query. The date and time is in \n\t\t\tUnix time format and Coordinated Universal time (UTC).
" + "smithy.api#documentation": "The last updated date of the domain as found in the response to a WHOIS query. The\n\t\t\tdate and time is in Unix time format and Coordinated Universal time (UTC).
" } }, "ExpirationDate": { "target": "com.amazonaws.route53domains#Timestamp", "traits": { - "smithy.api#documentation": "The date when the registration for the domain is set to expire. The date and time is in \n\t\t\tUnix time format and Coordinated Universal time (UTC).
" + "smithy.api#documentation": "The date when the registration for the domain is set to expire. The date and time is\n\t\t\tin Unix time format and Coordinated Universal time (UTC).
" } }, "Reseller": { "target": "com.amazonaws.route53domains#Reseller", "traits": { - "smithy.api#documentation": "Reseller of the domain. Domains registered or transferred using Route 53 domains will have \"Amazon\" \n\t\t\tas the reseller.
Reseller of the domain. Domains registered or transferred using Route 53 domains will\n\t\t\thave \"Amazon\" as the reseller.
An array of domain name status codes, also known as Extensible Provisioning Protocol (EPP) status codes.
\n\t\tICANN, the organization that maintains a central database of domain names, has developed a set of domain name \n\t\t\tstatus codes that tell you the status of a variety of operations on a domain name, for example, registering a domain name, \n\t\t\ttransferring a domain name to another registrar, renewing the registration for a domain name, and so on. All registrars \n\t\t\tuse this same set of status codes.
\n\t\tFor a current list of domain name status codes and an explanation of what each code means, go to the\n\t\t\tICANN website and search for epp status codes.\n\t\t\t(Search on the ICANN website; web searches sometimes return an old version of the document.)
An array of domain name status codes, also known as Extensible Provisioning Protocol\n\t\t\t(EPP) status codes.
\nICANN, the organization that maintains a central database of domain names, has\n\t\t\tdeveloped a set of domain name status codes that tell you the status of a variety of\n\t\t\toperations on a domain name, for example, registering a domain name, transferring a\n\t\t\tdomain name to another registrar, renewing the registration for a domain name, and so\n\t\t\ton. All registrars use this same set of status codes.
\nFor a current list of domain name status codes and an explanation of what each code\n\t\t\tmeans, go to the ICANN website and search\n\t\t\tfor epp status codes. (Search on the ICANN website; web searches sometimes\n\t\t\treturn an old version of the document.)
A complex type that contains information about the DNSSEC configuration.
" } } }, @@ -2505,21 +3335,22 @@ "DomainName": { "target": "com.amazonaws.route53domains#DomainName", "traits": { - "smithy.api#documentation": "A domain name that you want to use as the basis for a list of possible domain names. The top-level domain (TLD), such as .com, \n\t\t\tmust be a TLD that Route 53 supports. For a list of supported TLDs, see \n\t\t\tDomains that You Can Register with Amazon Route 53 in the \n\t\t\tAmazon Route 53 Developer Guide.
\n\t\tThe domain name can contain only the following characters:
\n\t\tLetters a through z. Domain names are not case sensitive.
\nNumbers 0 through 9.
\nHyphen (-). You can't specify a hyphen at the beginning or end of a label.
\nPeriod (.) to separate the labels in the name, such as the . in example.com.
Internationalized domain names are not supported for some top-level domains. To determine whether the TLD that you want to use \n\t\t\tsupports internationalized domain names, see \n\t\t\tDomains that You Can Register with Amazon Route 53. \n\t\t\t
", + "smithy.api#documentation": "A domain name that you want to use as the basis for a list of possible domain names.\n\t\t\tThe top-level domain (TLD), such as .com, must be a TLD that Route 53 supports. For a\n\t\t\tlist of supported TLDs, see Domains that You Can\n\t\t\t\tRegister with Amazon Route 53 in the Amazon Route 53 Developer\n\t\t\t\tGuide.
\nThe domain name can contain only the following characters:
\nLetters a through z. Domain names are not case sensitive.
\nNumbers 0 through 9.
\nHyphen (-). You can't specify a hyphen at the beginning or end of a label.\n\t\t\t\t
\nPeriod (.) to separate the labels in the name, such as the . in\n\t\t\t\t\t\texample.com.
Internationalized domain names are not supported for some top-level domains. To\n\t\t\tdetermine whether the TLD that you want to use supports internationalized domain names,\n\t\t\tsee Domains that You Can\n\t\t\t\tRegister with Amazon Route 53.
", "smithy.api#required": {} } }, "SuggestionCount": { "target": "com.amazonaws.route53domains#Integer", "traits": { - "smithy.api#documentation": "The number of suggested domain names that you want Route 53 to return. Specify a value between 1 and 50.
", + "smithy.api#default": 0, + "smithy.api#documentation": "The number of suggested domain names that you want Route 53 to return. Specify a value\n\t\t\tbetween 1 and 50.
", "smithy.api#required": {} } }, "OnlyAvailable": { "target": "com.amazonaws.route53domains#Boolean", "traits": { - "smithy.api#documentation": "If OnlyAvailable is true, Route 53 returns only domain names that are available. \n\t\t\tIf OnlyAvailable is false, Route 53 returns domain names without checking whether they're \n\t\t\tavailable to be registered. To determine whether the domain is available, you can call checkDomainAvailability \n\t\t\tfor each suggestion.
If OnlyAvailable is true, Route 53 returns only domain names\n\t\t\tthat are available. If OnlyAvailable is false, Route 53\n\t\t\treturns domain names without checking whether they're available to be registered. To\n\t\t\tdetermine whether the domain is available, you can call\n\t\t\t\tcheckDomainAvailability for each suggestion.
A list of possible domain names. If you specified true for OnlyAvailable in the request, \n\t\t\tthe list contains only domains that are available for registration.
A list of possible domain names. If you specified true for\n\t\t\t\tOnlyAvailable in the request, the list contains only domains that are\n\t\t\tavailable for registration.
This operation returns the current status of an operation that is not completed.
" + "smithy.api#documentation": "This operation returns the current status of an operation that is not\n\t\t\tcompleted.
" } }, "com.amazonaws.route53domains#GetOperationDetailRequest": { @@ -2559,13 +3390,13 @@ "OperationId": { "target": "com.amazonaws.route53domains#OperationId", "traits": { - "smithy.api#documentation": "The identifier for the operation for which you want to get the status. Route 53 returned the identifier \n\t\t\tin the response to the original request.
", + "smithy.api#documentation": "The identifier for the operation for which you want to get the status. Route 53\n\t\t\treturned the identifier in the response to the original request.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "The \n\t\t\tGetOperationDetail \n\t\t\trequest includes the following element.
" + "smithy.api#documentation": "The GetOperationDetail request includes the following element.
" } }, "com.amazonaws.route53domains#GetOperationDetailResponse": { @@ -2606,6 +3437,18 @@ "traits": { "smithy.api#documentation": "The date when the request was submitted.
" } + }, + "LastUpdatedDate": { + "target": "com.amazonaws.route53domains#Timestamp", + "traits": { + "smithy.api#documentation": "The date when the operation was last updated.
" + } + }, + "StatusFlag": { + "target": "com.amazonaws.route53domains#StatusFlag", + "traits": { + "smithy.api#documentation": "Lists any outstanding operations that require customer action. Valid values\n\t\t\tare:
\n\n PENDING_ACCEPTANCE: The operation is waiting for acceptance from\n\t\t\t\t\tthe account that is receiving the domain.
\n PENDING_CUSTOMER_ACTION: The operation is waiting for customer\n\t\t\t\t\taction, for example, returning an email.
\n PENDING_AUTHORIZATION: The operation is waiting for the form of\n\t\t\t\t\tauthorization. For more information, see ResendOperationAuthorization.
\n PENDING_PAYMENT_VERIFICATION: The operation is waiting for the\n\t\t\t\t\tpayment method to validate.
\n PENDING_SUPPORT_CASE: The operation includes a support case and\n\t\t\t\t\tis waiting for its resolution.
The requested item is not acceptable. For example, for an OperationId it might refer to the ID of an operation \n\t\t\tthat is already completed. For a domain name, it might not be a valid domain name or belong to the requester account.
" + "smithy.api#documentation": "The requested item is not acceptable. For example, for an OperationId it might refer\n\t\t\tto the ID of an operation that is already completed. For a domain name, it might not be\n\t\t\ta valid domain name or belong to the requester account.
" } } }, "traits": { - "smithy.api#documentation": "The requested item is not acceptable. For example, for APIs that accept a domain name, the request might specify a domain name \n\t\t\tthat doesn't belong to the account that submitted the request. For AcceptDomainTransferFromAnotherAwsAccount, \n\t\t\tthe password might be invalid.
The requested item is not acceptable. For example, for APIs that accept a domain name,\n\t\t\tthe request might specify a domain name that doesn't belong to the account that\n\t\t\tsubmitted the request. For AcceptDomainTransferFromAnotherAwsAccount, the\n\t\t\tpassword might be invalid.
This operation returns all the domain names registered with Amazon Route 53 for the current Amazon Web Services account\n\t\t\t if no filtering conditions are used.
", + "smithy.api#documentation": "This operation returns all the domain names registered with Amazon Route 53 for the\n\t\t\tcurrent Amazon Web Services account if no filtering conditions are used.
", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "NextPageMarker", @@ -2692,18 +3547,20 @@ } }, "com.amazonaws.route53domains#ListDomainsAttributeName": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "DomainName", - "name": "DomainName" - }, - { - "value": "Expiry", - "name": "Expiry" + "type": "enum", + "members": { + "DomainName": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DomainName" + } + }, + "Expiry": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Expiry" } - ] + } } }, "com.amazonaws.route53domains#ListDomainsRequest": { @@ -2712,25 +3569,25 @@ "FilterConditions": { "target": "com.amazonaws.route53domains#FilterConditions", "traits": { - "smithy.api#documentation": "A complex type that contains information about the filters applied during the ListDomains request. The filter conditions can\n\t\t\tinclude domain name and domain expiration.
A complex type that contains information about the filters applied during the\n\t\t\t\tListDomains request. The filter conditions can include domain name and\n\t\t\tdomain expiration.
A complex type that contains information about the requested ordering of domains in the returned list.
" + "smithy.api#documentation": "A complex type that contains information about the requested ordering of domains in\n\t\t\tthe returned list.
" } }, "Marker": { "target": "com.amazonaws.route53domains#PageMarker", "traits": { - "smithy.api#documentation": "For an initial request for a list of domains, omit this element. If the number of domains\n\t\t\tthat are associated with the current Amazon Web Services account is greater than the value that you specified for\n\t\t\tMaxItems, you can use Marker to return additional domains. Get the value of\n\t\t\tNextPageMarker from the previous response, and submit another request that includes the\n\t\t\tvalue of NextPageMarker in the Marker element.
Constraints: The marker must match the value specified in the previous request.
" + "smithy.api#documentation": "For an initial request for a list of domains, omit this element. If the number of\n\t\t\tdomains that are associated with the current Amazon Web Services account is greater than\n\t\t\tthe value that you specified for MaxItems, you can use Marker\n\t\t\tto return additional domains. Get the value of NextPageMarker from the\n\t\t\tprevious response, and submit another request that includes the value of\n\t\t\t\tNextPageMarker in the Marker element.
Constraints: The marker must match the value specified in the previous request.
" } }, "MaxItems": { "target": "com.amazonaws.route53domains#PageMaxItems", "traits": { - "smithy.api#documentation": "Number of domains to be returned.
\n\t\tDefault: 20
" + "smithy.api#documentation": "Number of domains to be returned.
\nDefault: 20
" } } }, @@ -2744,14 +3601,13 @@ "Domains": { "target": "com.amazonaws.route53domains#DomainSummaryList", "traits": { - "smithy.api#documentation": "A list of domains.
", - "smithy.api#required": {} + "smithy.api#documentation": "A list of domains.
" } }, "NextPageMarker": { "target": "com.amazonaws.route53domains#PageMarker", "traits": { - "smithy.api#documentation": "If there are more domains than you specified for MaxItems in the request, submit another\n\t\t\trequest and include the value of NextPageMarker in the value of Marker.
If there are more domains than you specified for MaxItems in the request,\n\t\t\tsubmit another request and include the value of NextPageMarker in the value\n\t\t\tof Marker.
Returns information about all of the operations that return an operation ID and that have ever been \n\t\t\tperformed on domains that were registered by the current account.
\n\t\tThis command runs only in the us-east-1 Region.
", + "smithy.api#documentation": "Returns information about all of the operations that return an operation ID and that\n\t\t\thave ever been performed on domains that were registered by the current account.
\nThis command runs only in the us-east-1 Region.
", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "NextPageMarker", @@ -2788,19 +3644,43 @@ "SubmittedSince": { "target": "com.amazonaws.route53domains#Timestamp", "traits": { - "smithy.api#documentation": "An optional parameter that lets you get information about all the operations that you submitted after a specified date and time. \n\t\t\tSpecify the date and time in Unix time format and Coordinated Universal time (UTC).
" + "smithy.api#documentation": "An optional parameter that lets you get information about all the operations that you\n\t\t\tsubmitted after a specified date and time. Specify the date and time in Unix time format\n\t\t\tand Coordinated Universal time (UTC).
" } }, "Marker": { "target": "com.amazonaws.route53domains#PageMarker", "traits": { - "smithy.api#documentation": "For an initial request for a list of operations, omit this element. If the number of operations that are\n\t\t\tnot yet complete is greater than the value that you specified for MaxItems, you can use Marker\n\t\t\tto return additional operations. Get the value of NextPageMarker from the previous response,\n\t\t\tand submit another request that includes the value of NextPageMarker in the Marker element.
For an initial request for a list of operations, omit this element. If the number of\n\t\t\toperations that are not yet complete is greater than the value that you specified for\n\t\t\t\tMaxItems, you can use Marker to return additional\n\t\t\toperations. Get the value of NextPageMarker from the previous response, and\n\t\t\tsubmit another request that includes the value of NextPageMarker in the\n\t\t\t\tMarker element.
Number of domains to be returned.
\n\t\tDefault: 20
" + "smithy.api#documentation": "Number of domains to be returned.
\nDefault: 20
" + } + }, + "Status": { + "target": "com.amazonaws.route53domains#OperationStatusList", + "traits": { + "smithy.api#documentation": "The status of the operations.
" + } + }, + "Type": { + "target": "com.amazonaws.route53domains#OperationTypeList", + "traits": { + "smithy.api#documentation": "An arrays of the domains operation types.
" + } + }, + "SortBy": { + "target": "com.amazonaws.route53domains#ListOperationsSortAttributeName", + "traits": { + "smithy.api#documentation": "The sort type for returned values.
" + } + }, + "SortOrder": { + "target": "com.amazonaws.route53domains#SortOrder", + "traits": { + "smithy.api#documentation": "The sort order ofr returned values, either ascending or descending.
" } } }, @@ -2814,14 +3694,13 @@ "Operations": { "target": "com.amazonaws.route53domains#OperationSummaryList", "traits": { - "smithy.api#documentation": "Lists summaries of the operations.
", - "smithy.api#required": {} + "smithy.api#documentation": "Lists summaries of the operations.
" } }, "NextPageMarker": { "target": "com.amazonaws.route53domains#PageMarker", "traits": { - "smithy.api#documentation": "If there are more operations than you specified for MaxItems in the request, submit another\n\t\t\trequest and include the value of NextPageMarker in the value of Marker.
If there are more operations than you specified for MaxItems in the\n\t\t\trequest, submit another request and include the value of NextPageMarker in\n\t\t\tthe value of Marker.
The ListOperations response includes the following elements.
" } }, + "com.amazonaws.route53domains#ListOperationsSortAttributeName": { + "type": "enum", + "members": { + "SubmittedDate": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SubmittedDate" + } + } + } + }, "com.amazonaws.route53domains#ListPrices": { "type": "operation", "input": { @@ -2846,7 +3736,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists the following prices for either all the TLDs supported by Route 53, or the specified TLD:
\n\t\tRegistration
\nTransfer
\nOwner change
\nDomain renewal
\nDomain restoration
\nLists the following prices for either all the TLDs supported by Route 53, or\n\t\t\tthe specified TLD:
\nRegistration
\nTransfer
\nOwner change
\nDomain renewal
\nDomain restoration
\nThe TLD for which you want to receive the pricing information. For example.\n\t\t\t\t.net.
If a Tld value is not provided, a list of prices for all TLDs supported by Route 53\n\t\tis returned.
The TLD for which you want to receive the pricing information. For example.\n\t\t\t\t.net.
If a Tld value is not provided, a list of prices for all TLDs supported\n\t\t\tby Route 53 is returned.
For an initial request for a list of prices, omit this element. \n\t\t\tIf the number of prices that are not yet complete is greater than the value that you specified for MaxItems, \n\t\t\tyou can use Marker to return additional prices. Get the value of NextPageMarker from the previous response, \n\t\t\tand submit another request that includes the value of NextPageMarker in the Marker element.
Used only for all TLDs. If you specify a TLD, don't specify a Marker.
For an initial request for a list of prices, omit this element. If the number of\n\t\t\tprices that are not yet complete is greater than the value that you specified for\n\t\t\t\tMaxItems, you can use Marker to return additional prices.\n\t\t\tGet the value of NextPageMarker from the previous response, and submit\n\t\t\tanother request that includes the value of NextPageMarker in the\n\t\t\t\tMarker element.
Used only for all TLDs. If you specify a TLD, don't specify a\n\t\t\tMarker.
Number of Prices to be returned.
Used only for all TLDs. If you specify a TLD, don't specify a MaxItems.
Number of Prices to be returned.
Used only for all TLDs. If you specify a TLD, don't specify a\n\t\t\tMaxItems.
A complex type that includes all the pricing information. If you specify a TLD, this array\n\t\t\tcontains only the pricing for that TLD.
", - "smithy.api#required": {} + "smithy.api#documentation": "A complex type that includes all the pricing information. If you specify a TLD, this\n\t\t\tarray contains only the pricing for that TLD.
" } }, "NextPageMarker": { "target": "com.amazonaws.route53domains#PageMarker", "traits": { - "smithy.api#documentation": "If there are more prices than you specified for MaxItems in the request, submit another request and include the value of \n\t\t\tNextPageMarker in the value of Marker.
Used only for all TLDs. If you specify a TLD, don't specify a\n\t\t\tNextPageMarker.
If there are more prices than you specified for MaxItems in the request,\n\t\t\tsubmit another request and include the value of NextPageMarker in the value\n\t\t\tof Marker.
Used only for all TLDs. If you specify a TLD, don't specify a\n\t\t\t\tNextPageMarker.
This operation returns all of the tags that are associated with the specified domain.
\n\t\tAll tag operations are eventually consistent; subsequent operations might not immediately represent all issued operations.
" + "smithy.api#documentation": "This operation returns all of the tags that are associated with the specified\n\t\t\tdomain.
\nAll tag operations are eventually consistent; subsequent operations might not\n\t\t\timmediately represent all issued operations.
" } }, "com.amazonaws.route53domains#ListTagsForDomainRequest": { @@ -2940,8 +3829,7 @@ "TagList": { "target": "com.amazonaws.route53domains#TagList", "traits": { - "smithy.api#documentation": "A list of the tags that are associated with the specified domain.
", - "smithy.api#required": {} + "smithy.api#documentation": "A list of the tags that are associated with the specified domain.
" } } }, @@ -2955,19 +3843,19 @@ "Name": { "target": "com.amazonaws.route53domains#HostName", "traits": { - "smithy.api#documentation": "The fully qualified host name of the name server.
\n\t\tConstraint: Maximum 255 characters
", + "smithy.api#documentation": "The fully qualified host name of the name server.
\nConstraint: Maximum 255 characters
", "smithy.api#required": {} } }, "GlueIps": { "target": "com.amazonaws.route53domains#GlueIpList", "traits": { - "smithy.api#documentation": "Glue IP address of a name server entry. Glue IP addresses are required only when the name of the name server \n\t\t\tis a subdomain of the domain. For example, if your domain is example.com and the name server for the domain is \n\t\t\tns.example.com, you need to specify the IP address for ns.example.com.
\n\t\tConstraints: The list can contain only one IPv4 and one IPv6 address.
" + "smithy.api#documentation": "Glue IP address of a name server entry. Glue IP addresses are required only when the\n\t\t\tname of the name server is a subdomain of the domain. For example, if your domain is\n\t\t\texample.com and the name server for the domain is ns.example.com, you need to specify\n\t\t\tthe IP address for ns.example.com.
\nConstraints: The list can contain only one IPv4 and one IPv6 address.
" } } }, "traits": { - "smithy.api#documentation": "Nameserver includes the following elements.
" + "smithy.api#documentation": "Name server includes the following elements.
" } }, "com.amazonaws.route53domains#NameserverList": { @@ -2976,6 +3864,9 @@ "target": "com.amazonaws.route53domains#Nameserver" } }, + "com.amazonaws.route53domains#NullableInteger": { + "type": "integer" + }, "com.amazonaws.route53domains#OperationId": { "type": "string", "traits": { @@ -2991,181 +3882,271 @@ "message": { "target": "com.amazonaws.route53domains#ErrorMessage", "traits": { - "smithy.api#documentation": "The number of operations or jobs running exceeded the allowed threshold for the account.
" + "smithy.api#documentation": "The number of operations or jobs running exceeded the allowed threshold for the\n\t\t\taccount.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The number of operations or jobs running exceeded the allowed threshold for the\n\t\t\taccount.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.route53domains#OperationStatus": { + "type": "enum", + "members": { + "SUBMITTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUBMITTED" + } + }, + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN_PROGRESS" + } + }, + "ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ERROR" + } + }, + "SUCCESSFUL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUCCESSFUL" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + } + } + }, + "com.amazonaws.route53domains#OperationStatusList": { + "type": "list", + "member": { + "target": "com.amazonaws.route53domains#OperationStatus" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 5 + } + } + }, + "com.amazonaws.route53domains#OperationSummary": { + "type": "structure", + "members": { + "OperationId": { + "target": "com.amazonaws.route53domains#OperationId", + "traits": { + "smithy.api#documentation": "Identifier returned to track the requested action.
" + } + }, + "Status": { + "target": "com.amazonaws.route53domains#OperationStatus", + "traits": { + "smithy.api#documentation": "The current status of the requested operation in the system.
" + } + }, + "Type": { + "target": "com.amazonaws.route53domains#OperationType", + "traits": { + "smithy.api#documentation": "Type of the action requested.
" + } + }, + "SubmittedDate": { + "target": "com.amazonaws.route53domains#Timestamp", + "traits": { + "smithy.api#documentation": "The date when the request was submitted.
" + } + }, + "DomainName": { + "target": "com.amazonaws.route53domains#DomainName", + "traits": { + "smithy.api#documentation": "Name of the domain.
" + } + }, + "Message": { + "target": "com.amazonaws.route53domains#ErrorMessage", + "traits": { + "smithy.api#documentation": "Message about the operation.
" + } + }, + "StatusFlag": { + "target": "com.amazonaws.route53domains#StatusFlag", + "traits": { + "smithy.api#documentation": "Automatically checks whether there are no outstanding operations on domains that need\n\t\t\tcustomer attention.
\nValid values are:
\n\n PENDING_ACCEPTANCE: The operation is waiting for acceptance from\n\t\t\t\t\tthe account that is receiving the domain.
\n PENDING_CUSTOMER_ACTION: The operation is waiting for customer\n\t\t\t\t\taction, for example, returning an email.
\n PENDING_AUTHORIZATION: The operation is waiting for the form of\n\t\t\t\t\tauthorization. For more information, see ResendOperationAuthorization.
\n PENDING_PAYMENT_VERIFICATION: The operation is waiting for the\n\t\t\t\t\tpayment method to validate.
\n PENDING_SUPPORT_CASE: The operation includes a support case and\n\t\t\t\t\tis waiting for its resolution.
The date when the last change was made in Unix time format and Coordinated Universal\n\t\t\tTime (UTC).
" + } + } + }, + "traits": { + "smithy.api#documentation": "OperationSummary includes the following elements.
" + } + }, + "com.amazonaws.route53domains#OperationSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.route53domains#OperationSummary" + } + }, + "com.amazonaws.route53domains#OperationType": { + "type": "enum", + "members": { + "REGISTER_DOMAIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REGISTER_DOMAIN" + } + }, + "DELETE_DOMAIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_DOMAIN" + } + }, + "TRANSFER_IN_DOMAIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TRANSFER_IN_DOMAIN" + } + }, + "UPDATE_DOMAIN_CONTACT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATE_DOMAIN_CONTACT" + } + }, + "UPDATE_NAMESERVER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATE_NAMESERVER" + } + }, + "CHANGE_PRIVACY_PROTECTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CHANGE_PRIVACY_PROTECTION" + } + }, + "DOMAIN_LOCK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DOMAIN_LOCK" + } + }, + "ENABLE_AUTORENEW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLE_AUTORENEW" + } + }, + "DISABLE_AUTORENEW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLE_AUTORENEW" + } + }, + "ADD_DNSSEC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ADD_DNSSEC" + } + }, + "REMOVE_DNSSEC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REMOVE_DNSSEC" + } + }, + "EXPIRE_DOMAIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXPIRE_DOMAIN" + } + }, + "TRANSFER_OUT_DOMAIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TRANSFER_OUT_DOMAIN" } - } - }, - "traits": { - "smithy.api#documentation": "The number of operations or jobs running exceeded the allowed threshold for the account.
", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.route53domains#OperationStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "SUBMITTED", - "name": "SUBMITTED" - }, - { - "value": "IN_PROGRESS", - "name": "IN_PROGRESS" - }, - { - "value": "ERROR", - "name": "ERROR" - }, - { - "value": "SUCCESSFUL", - "name": "SUCCESSFUL" - }, - { - "value": "FAILED", - "name": "FAILED" + }, + "CHANGE_DOMAIN_OWNER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CHANGE_DOMAIN_OWNER" } - ] - } - }, - "com.amazonaws.route53domains#OperationSummary": { - "type": "structure", - "members": { - "OperationId": { - "target": "com.amazonaws.route53domains#OperationId", + }, + "RENEW_DOMAIN": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "Identifier returned to track the requested action.
", - "smithy.api#required": {} + "smithy.api#enumValue": "RENEW_DOMAIN" } }, - "Status": { - "target": "com.amazonaws.route53domains#OperationStatus", + "PUSH_DOMAIN": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The current status of the requested operation in the system.
", - "smithy.api#required": {} + "smithy.api#enumValue": "PUSH_DOMAIN" } }, - "Type": { - "target": "com.amazonaws.route53domains#OperationType", + "INTERNAL_TRANSFER_OUT_DOMAIN": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "Type of the action requested.
", - "smithy.api#required": {} + "smithy.api#enumValue": "INTERNAL_TRANSFER_OUT_DOMAIN" } }, - "SubmittedDate": { - "target": "com.amazonaws.route53domains#Timestamp", + "INTERNAL_TRANSFER_IN_DOMAIN": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The date when the request was submitted.
", - "smithy.api#required": {} + "smithy.api#enumValue": "INTERNAL_TRANSFER_IN_DOMAIN" } } - }, - "traits": { - "smithy.api#documentation": "OperationSummary includes the following elements.
" } }, - "com.amazonaws.route53domains#OperationSummaryList": { + "com.amazonaws.route53domains#OperationTypeList": { "type": "list", "member": { - "target": "com.amazonaws.route53domains#OperationSummary" - } - }, - "com.amazonaws.route53domains#OperationType": { - "type": "string", + "target": "com.amazonaws.route53domains#OperationType" + }, "traits": { - "smithy.api#enum": [ - { - "value": "REGISTER_DOMAIN", - "name": "REGISTER_DOMAIN" - }, - { - "value": "DELETE_DOMAIN", - "name": "DELETE_DOMAIN" - }, - { - "value": "TRANSFER_IN_DOMAIN", - "name": "TRANSFER_IN_DOMAIN" - }, - { - "value": "UPDATE_DOMAIN_CONTACT", - "name": "UPDATE_DOMAIN_CONTACT" - }, - { - "value": "UPDATE_NAMESERVER", - "name": "UPDATE_NAMESERVER" - }, - { - "value": "CHANGE_PRIVACY_PROTECTION", - "name": "CHANGE_PRIVACY_PROTECTION" - }, - { - "value": "DOMAIN_LOCK", - "name": "DOMAIN_LOCK" - }, - { - "value": "ENABLE_AUTORENEW", - "name": "ENABLE_AUTORENEW" - }, - { - "value": "DISABLE_AUTORENEW", - "name": "DISABLE_AUTORENEW" - }, - { - "value": "ADD_DNSSEC", - "name": "ADD_DNSSEC" - }, - { - "value": "REMOVE_DNSSEC", - "name": "REMOVE_DNSSEC" - }, - { - "value": "EXPIRE_DOMAIN", - "name": "EXPIRE_DOMAIN" - }, - { - "value": "TRANSFER_OUT_DOMAIN", - "name": "TRANSFER_OUT_DOMAIN" - }, - { - "value": "CHANGE_DOMAIN_OWNER", - "name": "CHANGE_DOMAIN_OWNER" - }, - { - "value": "RENEW_DOMAIN", - "name": "RENEW_DOMAIN" - }, - { - "value": "PUSH_DOMAIN", - "name": "PUSH_DOMAIN" - }, - { - "value": "INTERNAL_TRANSFER_OUT_DOMAIN", - "name": "INTERNAL_TRANSFER_OUT_DOMAIN" - }, - { - "value": "INTERNAL_TRANSFER_IN_DOMAIN", - "name": "INTERNAL_TRANSFER_IN_DOMAIN" - } - ] + "smithy.api#length": { + "min": 0, + "max": 18 + } } }, "com.amazonaws.route53domains#Operator": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "LE", - "name": "LE" - }, - { - "value": "GE", - "name": "GE" - }, - { - "value": "BEGINS_WITH", - "name": "BEGINS_WITH" + "type": "enum", + "members": { + "LE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LE" } - ] + }, + "GE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GE" + } + }, + "BEGINS_WITH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BEGINS_WITH" + } + } } }, "com.amazonaws.route53domains#PageMarker": { @@ -3180,14 +4161,16 @@ "com.amazonaws.route53domains#PageMaxItems": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "max": 100 } } }, "com.amazonaws.route53domains#Price": { - "type": "double" + "type": "double", + "traits": { + "smithy.api#default": 0 + } }, "com.amazonaws.route53domains#PriceWithCurrency": { "type": "structure", @@ -3195,6 +4178,7 @@ "Price": { "target": "com.amazonaws.route53domains#Price", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The price of a domain, in a specific currency.
", "smithy.api#required": {} } @@ -3211,23 +4195,69 @@ "smithy.api#documentation": "Currency-specific price information.
" } }, - "com.amazonaws.route53domains#ReachabilityStatus": { - "type": "string", + "com.amazonaws.route53domains#PushDomain": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53domains#PushDomainRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.route53domains#InvalidInput" + }, + { + "target": "com.amazonaws.route53domains#OperationLimitExceeded" + }, + { + "target": "com.amazonaws.route53domains#UnsupportedTLD" + } + ], "traits": { - "smithy.api#enum": [ - { - "value": "PENDING", - "name": "PENDING" - }, - { - "value": "DONE", - "name": "DONE" - }, - { - "value": "EXPIRED", - "name": "EXPIRED" + "smithy.api#documentation": "Moves a domain from Amazon Web Services to another registrar.
\nSupported actions:
\nChanges the IPS tags of a .uk domain, and pushes it to transit. Transit means\n\t\t\t\t\tthat the domain is ready to be transferred to another registrar.
\nName of the domain.
", + "smithy.api#required": {} + } + }, + "Target": { + "target": "com.amazonaws.route53domains#Label", + "traits": { + "smithy.api#documentation": "New IPS tag for the domain.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.route53domains#ReachabilityStatus": { + "type": "enum", + "members": { + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING" } - ] + }, + "DONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DONE" + } + }, + "EXPIRED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXPIRED" + } + } } }, "com.amazonaws.route53domains#RegisterDomain": { @@ -3259,7 +4289,7 @@ } ], "traits": { - "smithy.api#documentation": "This operation registers a domain. Domains are registered either by Amazon Registrar (for .com, .net, and .org domains) or by \n\t\t\tour registrar associate, Gandi (for all other domains). For some top-level domains (TLDs), this operation requires extra parameters.
\n\t\tWhen you register a domain, Amazon Route 53 does the following:
\n\t\t\tCreates a Route 53 hosted zone that has the same name as the domain. Route 53 assigns four name servers \n\t\t\t\t\tto your hosted zone and automatically updates your domain registration with the names of these name servers.
\nEnables autorenew, so your domain registration will renew automatically each year. We'll notify you \n\t\t\t\t\tin advance of the renewal date so you can choose whether to renew the registration.
\nOptionally enables privacy protection, so WHOIS queries return contact information either for Amazon Registrar \n\t\t\t\t\t(for .com, .net, and .org domains) or for our registrar associate, Gandi (for all other TLDs). If you don't enable privacy \n\t\t\t\t\tprotection, WHOIS queries return the information that you entered for the administrative, registrant, and technical contacts.
\n\t\t\t\t\tYou must specify the same privacy setting for the administrative, registrant, and technical contacts.
\n\t\t\t\t\tIf registration is successful, returns an operation ID that you can use to track the progress and \n\t\t\t\t\tcompletion of the action. If the request is not completed successfully, the domain registrant is notified by email.
\nCharges your Amazon Web Services account an amount based on the top-level domain. For more information, see \n\t\t\t\t\tAmazon Route 53 Pricing.
\nThis operation registers a domain. Domains are registered either by Amazon Registrar\n\t\t\t(for .com, .net, and .org domains) or by our registrar associate, Gandi (for all other\n\t\t\tdomains). For some top-level domains (TLDs), this operation requires extra\n\t\t\tparameters.
\nWhen you register a domain, Amazon Route 53 does the following:
\nCreates a Route 53 hosted zone that has the same name as the domain. Route 53\n\t\t\t\t\tassigns four name servers to your hosted zone and automatically updates your\n\t\t\t\t\tdomain registration with the names of these name servers.
\nEnables auto renew, so your domain registration will renew automatically each\n\t\t\t\t\tyear. We'll notify you in advance of the renewal date so you can choose whether\n\t\t\t\t\tto renew the registration.
\nOptionally enables privacy protection, so WHOIS queries return contact\n\t\t\t\t\tinformation either for Amazon Registrar (for .com, .net, and .org domains) or\n\t\t\t\t\tfor our registrar associate, Gandi (for all other TLDs). If you don't enable\n\t\t\t\t\tprivacy protection, WHOIS queries return the information that you entered for\n\t\t\t\t\tthe administrative, registrant, and technical contacts.
\nYou must specify the same privacy setting for the administrative,\n\t\t\t\t\t\tregistrant, and technical contacts.
\nIf registration is successful, returns an operation ID that you can use to\n\t\t\t\t\ttrack the progress and completion of the action. If the request is not completed\n\t\t\t\t\tsuccessfully, the domain registrant is notified by email.
\nCharges your Amazon Web Services account an amount based on the top-level\n\t\t\t\t\tdomain. For more information, see Amazon Route 53 Pricing.
\nThe domain name that you want to register. The top-level domain (TLD), such as .com, must be a TLD that Route 53 supports. \n\t\t\tFor a list of supported TLDs, see \n\t\t\tDomains that You Can Register with Amazon Route 53 in the \n\t\t\tAmazon Route 53 Developer Guide.
\n\t\tThe domain name can contain only the following characters:
\n\t\tLetters a through z. Domain names are not case sensitive.
\nNumbers 0 through 9.
\nHyphen (-). You can't specify a hyphen at the beginning or end of a label.
\nPeriod (.) to separate the labels in the name, such as the . in example.com.
Internationalized domain names are not supported for some top-level domains. To determine whether the TLD that you want to use supports \n\t\t\tinternationalized domain names, see \n\t\t\tDomains that You Can Register with Amazon Route 53. \n\t\t\tFor more information, see \n\t\t\tFormatting Internationalized Domain Names.\n\t\t
", + "smithy.api#documentation": "The domain name that you want to register. The top-level domain (TLD), such as .com,\n\t\t\tmust be a TLD that Route 53 supports. For a list of supported TLDs, see Domains that You Can Register with Amazon Route 53 in the Amazon\n\t\t\t\tRoute 53 Developer Guide.
\nThe domain name can contain only the following characters:
\nLetters a through z. Domain names are not case sensitive.
\nNumbers 0 through 9.
\nHyphen (-). You can't specify a hyphen at the beginning or end of a label.\n\t\t\t\t
\nPeriod (.) to separate the labels in the name, such as the . in\n\t\t\t\t\t\texample.com.
Internationalized domain names are not supported for some top-level domains. To\n\t\t\tdetermine whether the TLD that you want to use supports internationalized domain names,\n\t\t\tsee Domains that You Can\n\t\t\t\tRegister with Amazon Route 53. For more information, see Formatting Internationalized Domain Names.
", "smithy.api#required": {} } }, @@ -3281,53 +4311,53 @@ "DurationInYears": { "target": "com.amazonaws.route53domains#DurationInYears", "traits": { - "smithy.api#documentation": "The number of years that you want to register the domain for. Domains are registered for a minimum of one year. \n\t\t\tThe maximum period depends on the top-level domain. For the range of valid values for your domain, see \n\t\t\tDomains that You Can Register with Amazon Route 53 in the \n\t\t\tAmazon Route 53 Developer Guide.
\n\t\tDefault: 1
", + "smithy.api#documentation": "The number of years that you want to register the domain for. Domains are registered\n\t\t\tfor a minimum of one year. The maximum period depends on the top-level domain. For the\n\t\t\trange of valid values for your domain, see Domains that You Can\n\t\t\t\tRegister with Amazon Route 53 in the Amazon Route 53 Developer\n\t\t\t\tGuide.
\nDefault: 1
", "smithy.api#required": {} } }, "AutoRenew": { "target": "com.amazonaws.route53domains#Boolean", "traits": { - "smithy.api#documentation": "Indicates whether the domain will be automatically renewed (true) or not (false). \n\t\t\tAutorenewal only takes effect after the account is charged.
Default: true\n
Indicates whether the domain will be automatically renewed (true) or not\n\t\t\t\t(false). Auto renewal only takes effect after the account is\n\t\t\tcharged.
Default: true\n
Provides detailed contact information. For information about the values that you specify for each element, see \n\t\t\tContactDetail.
", + "smithy.api#documentation": "Provides detailed contact information. For information about the values that you\n\t\t\tspecify for each element, see ContactDetail.
", "smithy.api#required": {} } }, "RegistrantContact": { "target": "com.amazonaws.route53domains#ContactDetail", "traits": { - "smithy.api#documentation": "Provides detailed contact information. For information about the values that you specify for each element, see \n\t\t\tContactDetail.
", + "smithy.api#documentation": "Provides detailed contact information. For information about the values that you\n\t\t\tspecify for each element, see ContactDetail.
", "smithy.api#required": {} } }, "TechContact": { "target": "com.amazonaws.route53domains#ContactDetail", "traits": { - "smithy.api#documentation": "Provides detailed contact information. For information about the values that you specify for each element, see \n\t\t\tContactDetail.
", + "smithy.api#documentation": "Provides detailed contact information. For information about the values that you\n\t\t\tspecify for each element, see ContactDetail.
", "smithy.api#required": {} } }, "PrivacyProtectAdminContact": { "target": "com.amazonaws.route53domains#Boolean", "traits": { - "smithy.api#documentation": "Whether you want to conceal contact information from WHOIS queries. If you specify true, \n\t\t\tWHOIS (\"who is\") queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) \n\t\t\tor for our registrar associate, Gandi (for all other TLDs). If you specify false, \n\t\t\tWHOIS queries return the information that you entered for the admin contact.
You must specify the same privacy setting for the administrative, registrant, and technical contacts.
\n\t\tDefault: true\n
Whether you want to conceal contact information from WHOIS queries. If you specify\n\t\t\t\ttrue, WHOIS (\"who is\") queries return contact information either for\n\t\t\tAmazon Registrar (for .com, .net, and .org domains) or for our registrar associate,\n\t\t\tGandi (for all other TLDs). If you specify false, WHOIS queries return the\n\t\t\tinformation that you entered for the admin contact.
You must specify the same privacy setting for the administrative, registrant, and\n\t\t\t\ttechnical contacts.
\nDefault: true\n
Whether you want to conceal contact information from WHOIS queries. If you specify true, \n\t\t\tWHOIS (\"who is\") queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) \n\t\t\tor for our registrar associate, Gandi (for all other TLDs). If you specify false, \n\t\t\tWHOIS queries return the information that you entered for the registrant contact (the domain owner).
You must specify the same privacy setting for the administrative, registrant, and technical contacts.
\n\t\tDefault: true\n
Whether you want to conceal contact information from WHOIS queries. If you specify\n\t\t\t\ttrue, WHOIS (\"who is\") queries return contact information either for\n\t\t\tAmazon Registrar (for .com, .net, and .org domains) or for our registrar associate,\n\t\t\tGandi (for all other TLDs). If you specify false, WHOIS queries return the\n\t\t\tinformation that you entered for the registrant contact (the domain owner).
You must specify the same privacy setting for the administrative, registrant, and\n\t\t\t\ttechnical contacts.
\nDefault: true\n
Whether you want to conceal contact information from WHOIS queries. If you specify true, \n\t\t\tWHOIS (\"who is\") queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) \n\t\t\tor for our registrar associate, Gandi (for all other TLDs). If you specify false, \n\t\t\tWHOIS queries return the information that you entered for the technical contact.
You must specify the same privacy setting for the administrative, registrant, and technical contacts.
\n\t\tDefault: true\n
Whether you want to conceal contact information from WHOIS queries. If you specify\n\t\t\t\ttrue, WHOIS (\"who is\") queries return contact information either for\n\t\t\tAmazon Registrar (for .com, .net, and .org domains) or for our registrar associate,\n\t\t\tGandi (for all other TLDs). If you specify false, WHOIS queries return the\n\t\t\tinformation that you entered for the technical contact.
You must specify the same privacy setting for the administrative, registrant, and\n\t\t\t\ttechnical contacts.
\nDefault: true\n
Identifier for tracking the progress of the request. To query the operation status, use \n\t\t\tGetOperationDetail.
", - "smithy.api#required": {} + "smithy.api#documentation": "Identifier for tracking the progress of the request. To query the operation status,\n\t\t\tuse GetOperationDetail.
" } } }, @@ -3382,7 +4411,7 @@ } ], "traits": { - "smithy.api#documentation": "Rejects the transfer of a domain from another Amazon Web Services account to the current Amazon Web Services account. You initiate a transfer betweenAmazon Web Services accounts using \n\t\t\tTransferDomainToAnotherAwsAccount.\n\t\t
\n\t\t\n\t\tUse either \n\t\t\tListOperations or \n\t\t\tGetOperationDetail \n\t\t\tto determine whether the operation succeeded. \n\t\t\tGetOperationDetail \n\t\t\tprovides additional information, for example, Domain Transfer from Aws Account 111122223333 has been cancelled. \n\t\t
Rejects the transfer of a domain from another Amazon Web Services account to the\n\t\t\tcurrent Amazon Web Services account. You initiate a transfer betweenAmazon Web Services accounts using TransferDomainToAnotherAwsAccount.
\nUse either ListOperations or GetOperationDetail to determine whether the operation succeeded. GetOperationDetail provides additional information, for example,\n\t\t\t\tDomain Transfer from Aws Account 111122223333 has been cancelled.
The name of the domain that was specified when another Amazon Web Services account submitted a \n\t\t\tTransferDomainToAnotherAwsAccount\n\t\t\trequest.\n\t\t
", + "smithy.api#documentation": "The name of the domain that was specified when another Amazon Web Services account\n\t\t\tsubmitted a TransferDomainToAnotherAwsAccount request.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "The RejectDomainTransferFromAnotherAwsAccount request includes the following element.
" + "smithy.api#documentation": "The RejectDomainTransferFromAnotherAwsAccount request includes the following\n\t\t\telement.
" } }, "com.amazonaws.route53domains#RejectDomainTransferFromAnotherAwsAccountResponse": { @@ -3406,12 +4435,12 @@ "OperationId": { "target": "com.amazonaws.route53domains#OperationId", "traits": { - "smithy.api#documentation": "The identifier that TransferDomainToAnotherAwsAccount returned to track the progress of the request. \n\t\t\tBecause the transfer request was rejected, the value is no longer valid, and you can't use GetOperationDetail \n\t\t\tto query the operation status.
The identifier that TransferDomainToAnotherAwsAccount returned to track\n\t\t\tthe progress of the request. Because the transfer request was rejected, the value is no\n\t\t\tlonger valid, and you can't use GetOperationDetail to query the operation\n\t\t\tstatus.
The RejectDomainTransferFromAnotherAwsAccount response includes the following element.
" + "smithy.api#documentation": "The RejectDomainTransferFromAnotherAwsAccount response includes the following\n\t\t\telement.
" } }, "com.amazonaws.route53domains#RenewDomain": { @@ -3440,7 +4469,7 @@ } ], "traits": { - "smithy.api#documentation": "This operation renews a domain for the specified number of years. The cost of renewing your domain is billed to your Amazon Web Services account.
\n\t\tWe recommend that you renew your domain several weeks before the expiration date. Some TLD registries delete domains before the \n\t\t\texpiration date if you haven't renewed far enough in advance. For more information about renewing domain registration, see \n\t\t\tRenewing Registration for a Domain \n\t\t\tin the Amazon Route 53 Developer Guide.
" + "smithy.api#documentation": "This operation renews a domain for the specified number of years. The cost of renewing\n\t\t\tyour domain is billed to your Amazon Web Services account.
\nWe recommend that you renew your domain several weeks before the expiration date. Some\n\t\t\tTLD registries delete domains before the expiration date if you haven't renewed far\n\t\t\tenough in advance. For more information about renewing domain registration, see Renewing\n\t\t\t\tRegistration for a Domain in the Amazon Route 53 Developer\n\t\t\t\tGuide.
" } }, "com.amazonaws.route53domains#RenewDomainRequest": { @@ -3456,19 +4485,20 @@ "DurationInYears": { "target": "com.amazonaws.route53domains#DurationInYears", "traits": { - "smithy.api#documentation": "The number of years that you want to renew the domain for. The maximum number of years depends on the top-level domain. \n\t\t\tFor the range of valid values for your domain, see \n\t\t\tDomains that You Can Register with Amazon Route 53 in the \n\t\t\tAmazon Route 53 Developer Guide.
\n\t\tDefault: 1
" + "smithy.api#documentation": "The number of years that you want to renew the domain for. The maximum number of years\n\t\t\tdepends on the top-level domain. For the range of valid values for your domain, see\n\t\t\t\tDomains that You Can\n\t\t\t\tRegister with Amazon Route 53 in the Amazon Route 53 Developer\n\t\t\t\tGuide.
\nDefault: 1
" } }, "CurrentExpiryYear": { "target": "com.amazonaws.route53domains#CurrentExpiryYear", "traits": { - "smithy.api#documentation": "The year when the registration for the domain is set to expire. This value must match the current expiration date for the domain.
", + "smithy.api#default": 0, + "smithy.api#documentation": "The year when the registration for the domain is set to expire. This value must match\n\t\t\tthe current expiration date for the domain.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "A RenewDomain request includes the number of years that you want to renew for and the current expiration year.
A RenewDomain request includes the number of years that you want to renew\n\t\t\tfor and the current expiration year.
Identifier for tracking the progress of the request. To query the operation status, use \n\t\t\tGetOperationDetail.
", - "smithy.api#required": {} + "smithy.api#documentation": "Identifier for tracking the progress of the request. To query the operation status,\n\t\t\tuse GetOperationDetail.
" } } } @@ -3506,7 +4535,7 @@ } ], "traits": { - "smithy.api#documentation": "For operations that require confirmation that the email address for the registrant contact is valid, \n\t\t\tsuch as registering a new domain, this operation resends the confirmation email to the current email address for the registrant contact.
" + "smithy.api#documentation": "For operations that require confirmation that the email address for the registrant\n\t\t\tcontact is valid, such as registering a new domain, this operation resends the\n\t\t\tconfirmation email to the current email address for the registrant contact.
" } }, "com.amazonaws.route53domains#ResendContactReachabilityEmailRequest": { @@ -3515,7 +4544,7 @@ "domainName": { "target": "com.amazonaws.route53domains#DomainName", "traits": { - "smithy.api#documentation": "The name of the domain for which you want Route 53 to resend a confirmation email to the registrant contact.
" + "smithy.api#documentation": "The name of the domain for which you want Route 53 to resend a confirmation email to\n\t\t\tthe registrant contact.
" } } } @@ -3532,13 +4561,42 @@ "emailAddress": { "target": "com.amazonaws.route53domains#Email", "traits": { - "smithy.api#documentation": "The email address for the registrant contact at the time that we sent the verification email.
" + "smithy.api#documentation": "The email address for the registrant contact at the time that we sent the verification\n\t\t\temail.
" } }, "isAlreadyVerified": { "target": "com.amazonaws.route53domains#Boolean", "traits": { - "smithy.api#documentation": "\n True if the email address for the registrant contact has already been verified, and false otherwise. \n\t\t\tIf the email address has already been verified, we don't send another confirmation email.
\n True if the email address for the registrant contact has already been\n\t\t\tverified, and false otherwise. If the email address has already been\n\t\t\tverified, we don't send another confirmation email.
Resend the form of authorization email for this operation.
" + } + }, + "com.amazonaws.route53domains#ResendOperationAuthorizationRequest": { + "type": "structure", + "members": { + "OperationId": { + "target": "com.amazonaws.route53domains#OperationId", + "traits": { + "smithy.api#documentation": "Operation ID.
", + "smithy.api#required": {} } } } @@ -3560,7 +4618,7 @@ } ], "traits": { - "smithy.api#documentation": "This operation returns the AuthCode for the domain. To transfer a domain to another registrar, you provide this value to the new registrar.
" + "smithy.api#documentation": "This operation returns the authorization code for the domain. To transfer a domain to\n\t\t\tanother registrar, you provide this value to the new registrar.
" } }, "com.amazonaws.route53domains#RetrieveDomainAuthCodeRequest": { @@ -3575,7 +4633,7 @@ } }, "traits": { - "smithy.api#documentation": "A request for the authorization code for the specified domain. To transfer a domain to another registrar, you provide \n\t\t\tthis value to the new registrar.
" + "smithy.api#documentation": "A request for the authorization code for the specified domain. To transfer a domain to\n\t\t\tanother registrar, you provide this value to the new registrar.
" } }, "com.amazonaws.route53domains#RetrieveDomainAuthCodeResponse": { @@ -3584,8 +4642,7 @@ "AuthCode": { "target": "com.amazonaws.route53domains#DomainAuthCode", "traits": { - "smithy.api#documentation": "The authorization code for the domain.
", - "smithy.api#required": {} + "smithy.api#documentation": "The authorization code for the domain.
" } } }, @@ -3595,29 +4652,14 @@ }, "com.amazonaws.route53domains#Route53Domains_v20140515": { "type": "service", - "traits": { - "aws.api#service": { - "sdkId": "Route 53 Domains", - "arnNamespace": "route53domains", - "cloudFormationName": "Route53Domains", - "cloudTrailEventSource": "route53domains.amazonaws.com", - "endpointPrefix": "route53domains" - }, - "aws.auth#sigv4": { - "name": "route53domains" - }, - "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "Amazon Route 53 API actions let you register domain names and perform related operations.
", - "smithy.api#title": "Amazon Route 53 Domains", - "smithy.api#xmlNamespace": { - "uri": "https://route53domains.amazonaws.com/doc/2014-05-15/" - } - }, "version": "2014-05-15", "operations": [ { "target": "com.amazonaws.route53domains#AcceptDomainTransferFromAnotherAwsAccount" }, + { + "target": "com.amazonaws.route53domains#AssociateDelegationSignerToDomain" + }, { "target": "com.amazonaws.route53domains#CancelDomainTransferToAnotherAwsAccount" }, @@ -3639,6 +4681,9 @@ { "target": "com.amazonaws.route53domains#DisableDomainTransferLock" }, + { + "target": "com.amazonaws.route53domains#DisassociateDelegationSignerFromDomain" + }, { "target": "com.amazonaws.route53domains#EnableDomainAutoRenew" }, @@ -3669,6 +4714,9 @@ { "target": "com.amazonaws.route53domains#ListTagsForDomain" }, + { + "target": "com.amazonaws.route53domains#PushDomain" + }, { "target": "com.amazonaws.route53domains#RegisterDomain" }, @@ -3681,6 +4729,9 @@ { "target": "com.amazonaws.route53domains#ResendContactReachabilityEmail" }, + { + "target": "com.amazonaws.route53domains#ResendOperationAuthorization" + }, { "target": "com.amazonaws.route53domains#RetrieveDomainAuthCode" }, @@ -3705,7 +4756,426 @@ { "target": "com.amazonaws.route53domains#ViewBilling" } - ] + ], + "traits": { + "aws.api#service": { + "sdkId": "Route 53 Domains", + "arnNamespace": "route53domains", + "cloudFormationName": "Route53Domains", + "cloudTrailEventSource": "route53domains.amazonaws.com", + "endpointPrefix": "route53domains" + }, + "aws.auth#sigv4": { + "name": "route53domains" + }, + "aws.protocols#awsJson1_1": {}, + "smithy.api#documentation": "Amazon Route 53 API actions let you register domain names and perform related\n\t\t\toperations.
", + "smithy.api#title": "Amazon Route 53 Domains", + "smithy.api#xmlNamespace": { + "uri": "https://route53domains.amazonaws.com/doc/2014-05-15/" + }, + "smithy.rules#endpointRuleSet": { + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": true, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://route53domains-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://route53domains-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://route53domains.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ] + }, + { + "conditions": [], + "endpoint": { + "url": "https://route53domains.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://route53domains-fips.us-east-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-east-1", + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://route53domains-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-east-1", + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://route53domains.us-east-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-east-1", + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://route53domains.us-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-east-1", + "UseDualStack": false + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-east-1", + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips enabled and dualstack disabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "UseFIPS": true, + "Region": "us-east-1", + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "params": { + "UseFIPS": false, + "Region": "us-east-1", + "UseDualStack": true, + "Endpoint": "https://example.com" + } + } + ], + "version": "1.0" + } + } }, "com.amazonaws.route53domains#SortCondition": { "type": "structure", @@ -3713,14 +5183,14 @@ "Name": { "target": "com.amazonaws.route53domains#ListDomainsAttributeName", "traits": { - "smithy.api#documentation": "Field to be used for sorting the list of domains. It can be either the name or the expiration for a domain. Note that if \n\t\t\tfilterCondition is used in the same \n\t\t\tListDomains\n\t\t\t call, the field used for sorting has to be the same as the field used for filtering.
Field to be used for sorting the list of domains. It can be either the name or the\n\t\t\texpiration for a domain. Note that if filterCondition is used in the same\n\t\t\t\tListDomains\n\t\t\tcall, the field used for sorting has to be the same as the field used for\n\t\t\tfiltering.
The sort order for a list of domains. Either ascending (ASC) or descending (DES).
", + "smithy.api#documentation": "The sort order for a list of domains. Either ascending (ASC) or descending\n\t\t\t(DES).
", "smithy.api#required": {} } } @@ -3730,18 +5200,20 @@ } }, "com.amazonaws.route53domains#SortOrder": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ASC", - "name": "ASC" - }, - { - "value": "DESC", - "name": "DESC" + "type": "enum", + "members": { + "ASC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ASC" + } + }, + "DESC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DESC" } - ] + } } }, "com.amazonaws.route53domains#State": { @@ -3753,6 +5225,41 @@ } } }, + "com.amazonaws.route53domains#StatusFlag": { + "type": "enum", + "members": { + "PENDING_ACCEPTANCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING_ACCEPTANCE" + } + }, + "PENDING_CUSTOMER_ACTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING_CUSTOMER_ACTION" + } + }, + "PENDING_AUTHORIZATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING_AUTHORIZATION" + } + }, + "PENDING_PAYMENT_VERIFICATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING_PAYMENT_VERIFICATION" + } + }, + "PENDING_SUPPORT_CASE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING_SUPPORT_CASE" + } + } + } + }, "com.amazonaws.route53domains#String": { "type": "string" }, @@ -3778,13 +5285,13 @@ "Key": { "target": "com.amazonaws.route53domains#TagKey", "traits": { - "smithy.api#documentation": "The key (name) of a tag.
\n\t\tValid values: A-Z, a-z, 0-9, space, \".:/=+\\-@\"
\n\t\tConstraints: Each key can be 1-128 characters long.
" + "smithy.api#documentation": "The key (name) of a tag.
\nValid values: A-Z, a-z, 0-9, space, \".:/=+\\-@\"
\nConstraints: Each key can be 1-128 characters long.
" } }, "Value": { "target": "com.amazonaws.route53domains#TagValue", "traits": { - "smithy.api#documentation": "The value of a tag.
\n\t\tValid values: A-Z, a-z, 0-9, space, \".:/=+\\-@\"
\n\t\tConstraints: Each value can be 0-256 characters long.
" + "smithy.api#documentation": "The value of a tag.
\nValid values: A-Z, a-z, 0-9, space, \".:/=+\\-@\"
\nConstraints: Each value can be 0-256 characters long.
" } } }, @@ -3829,7 +5336,7 @@ "type": "string", "traits": { "smithy.api#length": { - "min": 1, + "min": 2, "max": 255 } } @@ -3863,7 +5370,7 @@ } ], "traits": { - "smithy.api#documentation": "Transfers a domain from another registrar to Amazon Route 53. When the transfer is complete, the domain is registered either with \n\t\t\tAmazon Registrar (for .com, .net, and .org domains) or with our registrar associate, Gandi (for all other TLDs).
\n\t\tFor more information about transferring domains, see the following topics:
\n\t\tFor transfer requirements, a detailed procedure, and information about viewing the status of a domain that you're transferring \n\t\t\t\tto Route 53, see \n\t\t\t\tTransferring Registration for a \n\t\t\t\tDomain to Amazon Route 53 in the Amazon Route 53 Developer Guide.
\nFor information about how to transfer a domain from one Amazon Web Services account to another, see \n\t\t\t\tTransferDomainToAnotherAwsAccount.\n\t\t\t\t
\n\t\t\tFor information about how to transfer a domain to another domain registrar, see \n\t\t\t\tTransferring a Domain from \n\t\t\t\tAmazon Route 53 to Another Registrar in the Amazon Route 53 Developer Guide.
\nIf the registrar for your domain is also the DNS service provider for the domain, we highly recommend that you \n\t\t\ttransfer your DNS service to Route 53 or to another DNS service provider before you transfer your registration. Some registrars \n\t\t\tprovide free DNS service when you purchase a domain registration. When you transfer the registration, the previous registrar \n\t\t\twill not renew your domain registration and could end your DNS service at any time.
\n\t\t\n\t\t\tIf the registrar for your domain is also the DNS service provider for the domain and you don't \n\t\t\t\t\ttransfer DNS service to another provider, your website, email, and the web applications associated with the domain \n\t\t\t\t\tmight become unavailable.
\n\t\t\tIf the transfer is successful, this method returns an operation ID that you can use to track the progress and \n\t\t\tcompletion of the action. If the transfer doesn't complete successfully, the domain registrant will be notified by email.
" + "smithy.api#documentation": "Transfers a domain from another registrar to Amazon Route 53. When the transfer is\n\t\t\tcomplete, the domain is registered either with Amazon Registrar (for .com, .net, and\n\t\t\t.org domains) or with our registrar associate, Gandi (for all other TLDs).
\nFor more information about transferring domains, see the following topics:
\nFor transfer requirements, a detailed procedure, and information about viewing\n\t\t\t\t\tthe status of a domain that you're transferring to Route 53, see Transferring Registration for a Domain to Amazon Route 53 in the\n\t\t\t\t\t\tAmazon Route 53 Developer Guide.
\nFor information about how to transfer a domain from one Amazon Web Services account to another, see TransferDomainToAnotherAwsAccount.
\nFor information about how to transfer a domain to another domain registrar,\n\t\t\t\t\tsee Transferring a Domain from Amazon Route 53 to Another Registrar in\n\t\t\t\t\tthe Amazon Route 53 Developer Guide.
\nIf the registrar for your domain is also the DNS service provider for the domain, we\n\t\t\thighly recommend that you transfer your DNS service to Route 53 or to another DNS\n\t\t\tservice provider before you transfer your registration. Some registrars provide free DNS\n\t\t\tservice when you purchase a domain registration. When you transfer the registration, the\n\t\t\tprevious registrar will not renew your domain registration and could end your DNS\n\t\t\tservice at any time.
\nIf the registrar for your domain is also the DNS service provider for the domain\n\t\t\t\tand you don't transfer DNS service to another provider, your website, email, and the\n\t\t\t\tweb applications associated with the domain might become unavailable.
\nIf the transfer is successful, this method returns an operation ID that you can use to\n\t\t\ttrack the progress and completion of the action. If the transfer doesn't complete\n\t\t\tsuccessfully, the domain registrant will be notified by email.
" } }, "com.amazonaws.route53domains#TransferDomainRequest": { @@ -3872,7 +5379,7 @@ "DomainName": { "target": "com.amazonaws.route53domains#DomainName", "traits": { - "smithy.api#documentation": "The name of the domain that you want to transfer to Route 53. The top-level domain (TLD), such as .com, must be a TLD that Route 53 supports. \n\t\t\tFor a list of supported TLDs, see \n\t\t\tDomains that You Can Register with Amazon Route 53 in the \n\t\t\tAmazon Route 53 Developer Guide.
\n\t\tThe domain name can contain only the following characters:
\n\t\tLetters a through z. Domain names are not case sensitive.
\nNumbers 0 through 9.
\nHyphen (-). You can't specify a hyphen at the beginning or end of a label.
\nPeriod (.) to separate the labels in the name, such as the . in example.com.
The name of the domain that you want to transfer to Route 53. The top-level domain\n\t\t\t(TLD), such as .com, must be a TLD that Route 53 supports. For a list of supported TLDs,\n\t\t\tsee Domains that You Can\n\t\t\t\tRegister with Amazon Route 53 in the Amazon Route 53 Developer\n\t\t\t\tGuide.
\nThe domain name can contain only the following characters:
\nLetters a through z. Domain names are not case sensitive.
\nNumbers 0 through 9.
\nHyphen (-). You can't specify a hyphen at the beginning or end of a label.\n\t\t\t\t
\nPeriod (.) to separate the labels in the name, such as the . in\n\t\t\t\t\t\texample.com.
The number of years that you want to register the domain for. Domains are registered for a minimum of one year. \n\t\t\tThe maximum period depends on the top-level domain.
\n\t\tDefault: 1
", + "smithy.api#documentation": "The number of years that you want to register the domain for. Domains are registered\n\t\t\tfor a minimum of one year. The maximum period depends on the top-level domain.
\nDefault: 1
", "smithy.api#required": {} } }, @@ -3898,13 +5405,13 @@ "AuthCode": { "target": "com.amazonaws.route53domains#DomainAuthCode", "traits": { - "smithy.api#documentation": "The authorization code for the domain. You get this value from the current registrar.
" + "smithy.api#documentation": "The authorization code for the domain. You get this value from the current\n\t\t\tregistrar.
" } }, "AutoRenew": { "target": "com.amazonaws.route53domains#Boolean", "traits": { - "smithy.api#documentation": "Indicates whether the domain will be automatically renewed (true) or not (false). Autorenewal only takes effect \n\t\t\tafter the account is charged.
\n\t\tDefault: true
" + "smithy.api#documentation": "Indicates whether the domain will be automatically renewed (true) or not (false). Auto\n\t\t\trenewal only takes effect after the account is charged.
\nDefault: true
" } }, "AdminContact": { @@ -3931,19 +5438,19 @@ "PrivacyProtectAdminContact": { "target": "com.amazonaws.route53domains#Boolean", "traits": { - "smithy.api#documentation": "Whether you want to conceal contact information from WHOIS queries. If you specify true, \n\t\t\tWHOIS (\"who is\") queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) \n\t\t\tor for our registrar associate, Gandi (for all other TLDs). If you specify false, \n\t\t\tWHOIS queries return the information that you entered for the admin contact.
You must specify the same privacy setting for the administrative, registrant, and technical contacts.
\n\t\tDefault: true\n
Whether you want to conceal contact information from WHOIS queries. If you specify\n\t\t\t\ttrue, WHOIS (\"who is\") queries return contact information either for\n\t\t\tAmazon Registrar (for .com, .net, and .org domains) or for our registrar associate,\n\t\t\tGandi (for all other TLDs). If you specify false, WHOIS queries return the\n\t\t\tinformation that you entered for the admin contact.
You must specify the same privacy setting for the administrative, registrant, and\n\t\t\t\ttechnical contacts.
\nDefault: true\n
Whether you want to conceal contact information from WHOIS queries. If you specify true, \n\t\t\tWHOIS (\"who is\") queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) \n\t\t\tor for our registrar associate, Gandi (for all other TLDs). If you specify false, \n\t\t\tWHOIS queries return the information that you entered for the registrant contact (domain owner).
You must specify the same privacy setting for the administrative, registrant, and technical contacts.
\n\t\tDefault: true\n
Whether you want to conceal contact information from WHOIS queries. If you specify\n\t\t\t\ttrue, WHOIS (\"who is\") queries return contact information either for\n\t\t\tAmazon Registrar (for .com, .net, and .org domains) or for our registrar associate,\n\t\t\tGandi (for all other TLDs). If you specify false, WHOIS queries return the\n\t\t\tinformation that you entered for the registrant contact (domain owner).
You must specify the same privacy setting for the administrative, registrant, and\n\t\t\t\ttechnical contacts.
\nDefault: true\n
Whether you want to conceal contact information from WHOIS queries. If you specify true, \n\t\t\tWHOIS (\"who is\") queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) \n\t\t\tor for our registrar associate, Gandi (for all other TLDs). If you specify false, \n\t\t\tWHOIS queries return the information that you entered for the technical contact.
You must specify the same privacy setting for the administrative, registrant, and technical contacts.
\n\t\tDefault: true\n
Whether you want to conceal contact information from WHOIS queries. If you specify\n\t\t\t\ttrue, WHOIS (\"who is\") queries return contact information either for\n\t\t\tAmazon Registrar (for .com, .net, and .org domains) or for our registrar associate,\n\t\t\tGandi (for all other TLDs). If you specify false, WHOIS queries return the\n\t\t\tinformation that you entered for the technical contact.
You must specify the same privacy setting for the administrative, registrant, and\n\t\t\t\ttechnical contacts.
\nDefault: true\n
Identifier for tracking the progress of the request. To query the operation status, use \n\t\t\tGetOperationDetail.
", - "smithy.api#required": {} + "smithy.api#documentation": "Identifier for tracking the progress of the request. To query the operation status,\n\t\t\tuse GetOperationDetail.
" } } }, @@ -3989,7 +5495,7 @@ } ], "traits": { - "smithy.api#documentation": "Transfers a domain from the current Amazon Web Services account to another Amazon Web Services account. Note the following:
\n\t\tThe Amazon Web Services account that you're transferring the domain to must accept the transfer. If the other account \n\t\t\t\tdoesn't accept the transfer within 3 days, we cancel the transfer. See \n\t\t\t\tAcceptDomainTransferFromAnotherAwsAccount.\n\t\t\t\t
\n\t\t\tYou can cancel the transfer before the other account accepts it. See \n\t\t\t\tCancelDomainTransferToAnotherAwsAccount.\n\t\t\t\t
\n\t\t\tThe other account can reject the transfer. See \n\t\t\t\t\tRejectDomainTransferFromAnotherAwsAccount.\n\t\t\t\t
\n\t\t\tWhen you transfer a domain from one Amazon Web Services account to another, Route 53 doesn't transfer the hosted zone that is associated \n\t\t\t\twith the domain. DNS resolution isn't affected if the domain and the hosted zone are owned by separate accounts, \n\t\t\t\tso transferring the hosted zone is optional. For information about transferring the hosted zone to another Amazon Web Services account, see \n\t\t\t\tMigrating a Hosted Zone to a \n\t\t\t\t\tDifferent Amazon Web Services Account in the Amazon Route 53 Developer Guide.
\n\t\tUse either \n\t\t\tListOperations or \n\t\t\tGetOperationDetail \n\t\t\tto determine whether the operation succeeded. \n\t\t\tGetOperationDetail \n\t\t\tprovides additional information, for example, Domain Transfer from Aws Account 111122223333 has been cancelled. \n\t\t
Transfers a domain from the current Amazon Web Services account to another Amazon Web Services account. Note the following:
\nThe Amazon Web Services account that you're transferring the domain to must\n\t\t\t\t\taccept the transfer. If the other account doesn't accept the transfer within 3\n\t\t\t\t\tdays, we cancel the transfer. See AcceptDomainTransferFromAnotherAwsAccount.
\nYou can cancel the transfer before the other account accepts it. See CancelDomainTransferToAnotherAwsAccount.
\nThe other account can reject the transfer. See RejectDomainTransferFromAnotherAwsAccount.
\nWhen you transfer a domain from one Amazon Web Services account to another, Route\n\t\t\t\t53 doesn't transfer the hosted zone that is associated with the domain. DNS\n\t\t\t\tresolution isn't affected if the domain and the hosted zone are owned by separate\n\t\t\t\taccounts, so transferring the hosted zone is optional. For information about\n\t\t\t\ttransferring the hosted zone to another Amazon Web Services account, see Migrating a\n\t\t\t\t\tHosted Zone to a Different Amazon Web Services Account in the\n\t\t\t\t\tAmazon Route 53 Developer Guide.
\nUse either ListOperations or GetOperationDetail to determine whether the operation succeeded. GetOperationDetail provides additional information, for example,\n\t\t\t\tDomain Transfer from Aws Account 111122223333 has been cancelled.
The account ID of the Amazon Web Services account that you want to transfer the domain to, for example, 111122223333.
The account ID of the Amazon Web Services account that you want to transfer the domain\n\t\t\tto, for example, 111122223333.
Identifier for tracking the progress of the request. To query the operation status, use \n\t\t\tGetOperationDetail.
" + "smithy.api#documentation": "Identifier for tracking the progress of the request. To query the operation status,\n\t\t\tuse GetOperationDetail.
" } }, "Password": { "target": "com.amazonaws.route53domains#String", "traits": { - "smithy.api#documentation": "To finish transferring a domain to another Amazon Web Services account, the account that the domain is being transferred to must submit an \n\t\t\tAcceptDomainTransferFromAnotherAwsAccount\n\t\t\trequest. The request must include the value of the Password element that was returned in the \n\t\t\tTransferDomainToAnotherAwsAccount response.
To finish transferring a domain to another Amazon Web Services account, the account\n\t\t\tthat the domain is being transferred to must submit an AcceptDomainTransferFromAnotherAwsAccount request. The request must include\n\t\t\tthe value of the Password element that was returned in the\n\t\t\t\tTransferDomainToAnotherAwsAccount response.
The TransferDomainToAnotherAwsAccount response includes the following elements.
The TransferDomainToAnotherAwsAccount response includes the following\n\t\t\telements.
Whether the domain name can be transferred to Route 53.
\n\t\tYou can transfer only domains that have a value of TRANSFERABLE for Transferable.
Valid values:
\n\t\tThe domain name can be transferred to Route 53.
\nThe domain name can't be transferred to Route 53.
\nReserved for future use.
\nWhether the domain name can be transferred to Route 53.
\nYou can transfer only domains that have a value of TRANSFERABLE or\n\t\t\t\t\tTransferable.
Valid values:
\nThe domain name can be transferred to Route 53.
\nThe domain name can't be transferred to Route 53.
\nReserved for future use.
\nThe domain already exists in the current Amazon Web Services account.
\nthe domain exists in another Amazon Web Services account.
\nPremium domain transfer is not supported.
\nThis operation updates the contact information for a particular domain. You must specify information for at least one contact: \n\t\t\tregistrant, administrator, or technical.
\n\t\tIf the update is successful, this method returns an operation ID that you can use to track the progress and completion of the action. \n\t\t\tIf the request is not completed successfully, the domain registrant will be notified by email.
" + "smithy.api#documentation": "This operation updates the contact information for a particular domain. You must\n\t\t\tspecify information for at least one contact: registrant, administrator, or\n\t\t\ttechnical.
\nIf the update is successful, this method returns an operation ID that you can use to\n\t\t\ttrack the progress and completion of the operation. If the request is not completed\n\t\t\tsuccessfully, the domain registrant will be notified by email.
" } }, "com.amazonaws.route53domains#UpdateDomainContactPrivacy": { @@ -4125,7 +5655,7 @@ } ], "traits": { - "smithy.api#documentation": "This operation updates the specified domain contact's privacy setting. When privacy protection is enabled, \n\t\t\tcontact information such as email address is replaced either with contact information for Amazon Registrar (for .com, .net, and .org \n\t\t\tdomains) or with contact information for our registrar associate, Gandi.
\n\t\tYou must specify the same privacy setting for the administrative, registrant, and technical contacts.
\n\t\tThis operation affects only the contact information for the specified contact type (administrative, registrant, or technical). \n\t\t\tIf the request succeeds, Amazon Route 53 returns an operation ID that you can use with \n\t\t\tGetOperationDetail\n\t\t\tto track the progress and completion of the action. If the request doesn't complete successfully, the domain registrant will be notified by email.
\n\t\tBy disabling the privacy service via API, you consent to the publication of the contact information provided for this domain \n\t\t\tvia the public WHOIS database. You certify that you are the registrant of this domain name and have the authority to make this decision. \n\t\t\tYou may withdraw your consent at any time by enabling privacy protection using either UpdateDomainContactPrivacy or the \n\t\t\tRoute 53 console. Enabling privacy protection removes the contact information provided for this domain from the WHOIS database. \n\t\t\tFor more information on our privacy practices, see \n\t\t\thttps://aws.amazon.com/privacy/.
This operation updates the specified domain contact's privacy setting. When privacy\n\t\t\tprotection is enabled, contact information such as email address is replaced either with\n\t\t\tcontact information for Amazon Registrar (for .com, .net, and .org domains) or with\n\t\t\tcontact information for our registrar associate, Gandi.
\nYou must specify the same privacy setting for the administrative, registrant, and\n\t\t\t\ttechnical contacts.
\nThis operation affects only the contact information for the specified contact type\n\t\t\t(administrative, registrant, or technical). If the request succeeds, Amazon Route 53\n\t\t\treturns an operation ID that you can use with GetOperationDetail to track the progress and completion of the action. If\n\t\t\tthe request doesn't complete successfully, the domain registrant will be notified by\n\t\t\temail.
\nBy disabling the privacy service via API, you consent to the publication of the\n\t\t\t\tcontact information provided for this domain via the public WHOIS database. You\n\t\t\t\tcertify that you are the registrant of this domain name and have the authority to\n\t\t\t\tmake this decision. You may withdraw your consent at any time by enabling privacy\n\t\t\t\tprotection using either UpdateDomainContactPrivacy or the Route 53\n\t\t\t\tconsole. Enabling privacy protection removes the contact information provided for\n\t\t\t\tthis domain from the WHOIS database. For more information on our privacy practices,\n\t\t\t\tsee https://aws.amazon.com/privacy/.
Whether you want to conceal contact information from WHOIS queries. If you specify true, \n\t\t\tWHOIS (\"who is\") queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) \n\t\t\tor for our registrar associate, Gandi (for all other TLDs). If you specify false, \n\t\t\tWHOIS queries return the information that you entered for the admin contact.
You must specify the same privacy setting for the administrative, registrant, and technical contacts.
\n\t\tWhether you want to conceal contact information from WHOIS queries. If you specify\n\t\t\t\ttrue, WHOIS (\"who is\") queries return contact information either for\n\t\t\tAmazon Registrar (for .com, .net, and .org domains) or for our registrar associate,\n\t\t\tGandi (for all other TLDs). If you specify false, WHOIS queries return the\n\t\t\tinformation that you entered for the admin contact.
You must specify the same privacy setting for the administrative, registrant, and\n\t\t\t\ttechnical contacts.
\nWhether you want to conceal contact information from WHOIS queries. If you specify true, \n\t\t\tWHOIS (\"who is\") queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) \n\t\t\tor for our registrar associate, Gandi (for all other TLDs). If you specify false, \n\t\t\tWHOIS queries return the information that you entered for the registrant contact (domain owner).
You must specify the same privacy setting for the administrative, registrant, and technical contacts.
\n\t\tWhether you want to conceal contact information from WHOIS queries. If you specify\n\t\t\t\ttrue, WHOIS (\"who is\") queries return contact information either for\n\t\t\tAmazon Registrar (for .com, .net, and .org domains) or for our registrar associate,\n\t\t\tGandi (for all other TLDs). If you specify false, WHOIS queries return the\n\t\t\tinformation that you entered for the registrant contact (domain owner).
You must specify the same privacy setting for the administrative, registrant, and\n\t\t\t\ttechnical contacts.
\nWhether you want to conceal contact information from WHOIS queries. If you specify true, \n\t\t\tWHOIS (\"who is\") queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) \n\t\t\tor for our registrar associate, Gandi (for all other TLDs). If you specify false, \n\t\t\tWHOIS queries return the information that you entered for the technical contact.
You must specify the same privacy setting for the administrative, registrant, and technical contacts.
\n\t\tWhether you want to conceal contact information from WHOIS queries. If you specify\n\t\t\t\ttrue, WHOIS (\"who is\") queries return contact information either for\n\t\t\tAmazon Registrar (for .com, .net, and .org domains) or for our registrar associate,\n\t\t\tGandi (for all other TLDs). If you specify false, WHOIS queries return the\n\t\t\tinformation that you entered for the technical contact.
You must specify the same privacy setting for the administrative, registrant, and\n\t\t\t\ttechnical contacts.
\nIdentifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail.
", - "smithy.api#required": {} + "smithy.api#documentation": "Identifier for tracking the progress of the request. To use this ID to query the\n\t\t\toperation status, use GetOperationDetail.
" } } }, @@ -4203,6 +5732,12 @@ "traits": { "smithy.api#documentation": "Provides detailed contact information.
" } + }, + "Consent": { + "target": "com.amazonaws.route53domains#Consent", + "traits": { + "smithy.api#documentation": "Customer's consent for the owner change request.
" + } } }, "traits": { @@ -4215,8 +5750,7 @@ "OperationId": { "target": "com.amazonaws.route53domains#OperationId", "traits": { - "smithy.api#documentation": "Identifier for tracking the progress of the request. To query the operation status, use \n\t\t\tGetOperationDetail.
", - "smithy.api#required": {} + "smithy.api#documentation": "Identifier for tracking the progress of the request. To query the operation status,\n\t\t\tuse GetOperationDetail.
" } } }, @@ -4250,7 +5784,7 @@ } ], "traits": { - "smithy.api#documentation": "This operation replaces the current set of name servers for the domain with the specified set of name servers. \n\t\t\tIf you use Amazon Route 53 as your DNS service, specify the four name servers in the delegation set for the hosted zone for the domain.
\n\t\tIf successful, this operation returns an operation ID that you can use to track the progress and completion of the action. \n\t\t\tIf the request is not completed successfully, the domain registrant will be notified by email.
" + "smithy.api#documentation": "This operation replaces the current set of name servers for the domain with the\n\t\t\tspecified set of name servers. If you use Amazon Route 53 as your DNS service, specify\n\t\t\tthe four name servers in the delegation set for the hosted zone for the domain.
\nIf successful, this operation returns an operation ID that you can use to track the\n\t\t\tprogress and completion of the action. If the request is not completed successfully, the\n\t\t\tdomain registrant will be notified by email.
" } }, "com.amazonaws.route53domains#UpdateDomainNameserversRequest": { @@ -4279,7 +5813,7 @@ } }, "traits": { - "smithy.api#documentation": "Replaces the current set of name servers for the domain with the specified set of name servers. \n\t\t\tIf you use Amazon Route 53 as your DNS service, specify the four name servers in the delegation set for the hosted zone for the domain.
\n\t\tIf successful, this operation returns an operation ID that you can use to track the progress and \n\t\t\tcompletion of the action. If the request is not completed successfully, the domain registrant will be notified by email.
" + "smithy.api#documentation": "Replaces the current set of name servers for the domain with the specified set of name\n\t\t\tservers. If you use Amazon Route 53 as your DNS service, specify the four name servers\n\t\t\tin the delegation set for the hosted zone for the domain.
\nIf successful, this operation returns an operation ID that you can use to track the\n\t\t\tprogress and completion of the action. If the request is not completed successfully, the\n\t\t\tdomain registrant will be notified by email.
" } }, "com.amazonaws.route53domains#UpdateDomainNameserversResponse": { @@ -4288,8 +5822,7 @@ "OperationId": { "target": "com.amazonaws.route53domains#OperationId", "traits": { - "smithy.api#documentation": "Identifier for tracking the progress of the request. To query the operation status, use \n\t\t\tGetOperationDetail.
", - "smithy.api#required": {} + "smithy.api#documentation": "Identifier for tracking the progress of the request. To query the operation status,\n\t\t\tuse GetOperationDetail.
" } } }, @@ -4317,7 +5850,7 @@ } ], "traits": { - "smithy.api#documentation": "This operation adds or updates tags for a specified domain.
\n\t\tAll tag operations are eventually consistent; subsequent operations might not immediately represent all issued operations.
" + "smithy.api#documentation": "This operation adds or updates tags for a specified domain.
\nAll tag operations are eventually consistent; subsequent operations might not\n\t\t\timmediately represent all issued operations.
" } }, "com.amazonaws.route53domains#UpdateTagsForDomainRequest": { @@ -4333,7 +5866,7 @@ "TagsToUpdate": { "target": "com.amazonaws.route53domains#TagList", "traits": { - "smithy.api#documentation": "A list of the tag keys and values that you want to add or update. If you specify a key \n\t\t\tthat already exists, the corresponding value will be replaced.
" + "smithy.api#documentation": "A list of the tag keys and values that you want to add or update. If you specify a key\n\t\t\tthat already exists, the corresponding value will be replaced.
" } } }, @@ -4395,25 +5928,25 @@ "Start": { "target": "com.amazonaws.route53domains#Timestamp", "traits": { - "smithy.api#documentation": "The beginning date and time for the time period for which you want a list of billing records. Specify the date and time \n\t\t\tin Unix time format and Coordinated Universal time (UTC).
" + "smithy.api#documentation": "The beginning date and time for the time period for which you want a list of billing\n\t\t\trecords. Specify the date and time in Unix time format and Coordinated Universal time\n\t\t\t(UTC).
" } }, "End": { "target": "com.amazonaws.route53domains#Timestamp", "traits": { - "smithy.api#documentation": "The end date and time for the time period for which you want a list of billing records. Specify the date and time \n\t\t\tin Unix time format and Coordinated Universal time (UTC).
" + "smithy.api#documentation": "The end date and time for the time period for which you want a list of billing\n\t\t\trecords. Specify the date and time in Unix time format and Coordinated Universal time\n\t\t\t(UTC).
" } }, "Marker": { "target": "com.amazonaws.route53domains#PageMarker", "traits": { - "smithy.api#documentation": "For an initial request for a list of billing records, omit this element. If the number of billing records \n\t\t\tthat are associated with the current Amazon Web Services account during the specified period is greater than the value that \n\t\t\tyou specified for MaxItems, you can use Marker to return additional billing records. \n\t\t\tGet the value of NextPageMarker from the previous response, and submit another request that includes \n\t\t\tthe value of NextPageMarker in the Marker element.\n\t\t
Constraints: The marker must match the value of NextPageMarker that was returned in the previous response.
For an initial request for a list of billing records, omit this element. If the number\n\t\t\tof billing records that are associated with the current Amazon Web Services account\n\t\t\tduring the specified period is greater than the value that you specified for\n\t\t\t\tMaxItems, you can use Marker to return additional billing\n\t\t\trecords. Get the value of NextPageMarker from the previous response, and\n\t\t\tsubmit another request that includes the value of NextPageMarker in the\n\t\t\t\tMarker element.
Constraints: The marker must match the value of NextPageMarker that was\n\t\t\treturned in the previous response.
The number of billing records to be returned.
\n\t\tDefault: 20
" + "smithy.api#documentation": "The number of billing records to be returned.
\nDefault: 20
" } } }, @@ -4427,7 +5960,7 @@ "NextPageMarker": { "target": "com.amazonaws.route53domains#PageMarker", "traits": { - "smithy.api#documentation": "If there are more billing records than you specified for MaxItems in the request, submit another \n\t\t\trequest and include the value of NextPageMarker in the value of Marker.
If there are more billing records than you specified for MaxItems in the\n\t\t\trequest, submit another request and include the value of NextPageMarker in\n\t\t\tthe value of Marker.
The name of the objective metric used to measure the predictive quality of a machine\n learning system. This metric is optimized during training to provide the best estimate for\n model parameter values from data.
\nHere are the options:
\n\n MSE: The mean squared error (MSE) is the average of the squared\n differences between the predicted and actual values. It is used for regression. MSE\n values are always positive: the better a model is at predicting the actual values,\n the smaller the MSE value is. When the data contains outliers, they tend to dominate\n the MSE, which might cause subpar prediction performance.
\n Accuracy: The ratio of the number of correctly classified items to\n the total number of (correctly and incorrectly) classified items. It is used for\n binary and multiclass classification. It measures how close the predicted class\n values are to the actual values. Accuracy values vary between zero and one: one\n indicates perfect accuracy and zero indicates perfect inaccuracy.
\n F1: The F1 score is the harmonic mean of the precision and recall. It\n is used for binary classification into classes traditionally referred to as positive\n and negative. Predictions are said to be true when they match their actual (correct)\n class and false when they do not. Precision is the ratio of the true positive\n predictions to all positive predictions (including the false positives) in a data set\n and measures the quality of the prediction when it predicts the positive class.\n Recall (or sensitivity) is the ratio of the true positive predictions to all actual\n positive instances and measures how completely a model predicts the actual class\n members in a data set. The standard F1 score weighs precision and recall equally. But\n which metric is paramount typically depends on specific aspects of a problem. F1\n scores vary between zero and one: one indicates the best possible performance and\n zero the worst.
\n AUC: The area under the curve (AUC) metric is used to compare and\n evaluate binary classification by algorithms such as logistic regression that return\n probabilities. A threshold is needed to map the probabilities into classifications.\n The relevant curve is the receiver operating characteristic curve that plots the true\n positive rate (TPR) of predictions (or recall) against the false positive rate (FPR)\n as a function of the threshold value, above which a prediction is considered\n positive. Increasing the threshold results in fewer false positives but more false\n negatives. AUC is the area under this receiver operating characteristic curve and so\n provides an aggregated measure of the model performance across all possible\n classification thresholds. The AUC score can also be interpreted as the probability\n that a randomly selected positive data point is more likely to be predicted positive\n than a randomly selected negative example. AUC scores vary between zero and one: a\n score of one indicates perfect accuracy and a score of one half indicates that the\n prediction is not better than a random classifier. Values under one half predict less\n accurately than a random predictor. But such consistently bad predictors can simply\n be inverted to obtain better than random predictors.
\n F1macro: The F1macro score applies F1 scoring to multiclass\n classification. In this context, you have multiple classes to predict. You just\n calculate the precision and recall for each class as you did for the positive class\n in binary classification. Then, use these values to calculate the F1 score for each\n class and average them to obtain the F1macro score. F1macro scores vary between zero\n and one: one indicates the best possible performance and zero the worst.
If you do not specify a metric explicitly, the default behavior is to automatically\n use:
\n\n MSE: for regression.
\n F1: for binary classification
\n Accuracy: for multiclass classification.
The name of the objective metric used to measure the predictive quality of a machine\n learning system. This metric is optimized during training to provide the best estimate for\n model parameter values from data.
\nHere are the options:
\nThe ratio of the number of correctly classified items to the total number of\n (correctly and incorrectly) classified items. It is used for both binary and\n multiclass classification. Accuracy measures how close the predicted class values\n are to the actual values. Values for accuracy metrics vary between zero (0) and\n one (1). A value of 1 indicates perfect accuracy, and 0 indicates perfect\n inaccuracy.
\nThe area under the curve (AUC) metric is used to compare and evaluate binary\n classification by algorithms that return probabilities, such as logistic\n regression. To map the probabilities into classifications, these are compared\n against a threshold value.
\nThe relevant curve is the receiver operating characteristic curve (ROC curve).\n The ROC curve plots the true positive rate (TPR) of predictions (or recall)\n against the false positive rate (FPR) as a function of the threshold value, above\n which a prediction is considered positive. Increasing the threshold results in\n fewer false positives, but more false negatives.
\nAUC is the area under this ROC curve. Therefore, AUC provides an aggregated\n measure of the model performance across all possible classification thresholds.\n AUC scores vary between 0 and 1. A score of 1 indicates perfect accuracy, and a\n score of one half (0.5) indicates that the prediction is not better than a random\n classifier.
\n\n BalancedAccuracy is a metric that measures the ratio of accurate\n predictions to all predictions. This ratio is calculated after normalizing true\n positives (TP) and true negatives (TN) by the total number of positive (P) and\n negative (N) values. It is used in both binary and multiclass classification and\n is defined as follows: 0.5*((TP/P)+(TN/N)), with values ranging from 0 to 1.\n BalancedAccuracy gives a better measure of accuracy when the\n number of positives or negatives differ greatly from each other in an imbalanced\n dataset. For example, when only 1% of email is spam.
The F1 score is the harmonic mean of the precision and recall,\n defined as follows: F1 = 2 * (precision * recall) / (precision + recall). It is\n used for binary classification into classes traditionally referred to as positive\n and negative. Predictions are said to be true when they match their actual\n (correct) class, and false when they do not.
Precision is the ratio of the true positive predictions to all positive\n predictions, and it includes the false positives in a dataset. Precision measures\n the quality of the prediction when it predicts the positive class.
\nRecall (or sensitivity) is the ratio of the true positive predictions to all\n actual positive instances. Recall measures how completely a model predicts the\n actual class members in a dataset.
\nF1 scores vary between 0 and 1. A score of 1 indicates the best possible\n performance, and 0 indicates the worst.
\nThe F1macro score applies F1 scoring to multiclass classification\n problems. It does this by calculating the precision and recall, and then taking\n their harmonic mean to calculate the F1 score for each class. Lastly, the F1macro\n averages the individual scores to obtain the F1macro score.\n F1macro scores vary between 0 and 1. A score of 1 indicates the\n best possible performance, and 0 indicates the worst.
The mean absolute error (MAE) is a measure of how different the predicted and\n actual values are, when they're averaged over all values. MAE is commonly used in\n regression analysis to understand model prediction error. If there is linear\n regression, MAE represents the average distance from a predicted line to the\n actual value. MAE is defined as the sum of absolute errors divided by the number\n of observations. Values range from 0 to infinity, with smaller numbers indicating\n a better model fit to the data.
\nThe mean squared error (MSE) is the average of the squared differences between\n the predicted and actual values. It is used for regression. MSE values are always\n positive. The better a model is at predicting the actual values, the smaller the\n MSE value is
\nPrecision measures how well an algorithm predicts the true positives (TP) out\n of all of the positives that it identifies. It is defined as follows: Precision =\n TP/(TP+FP), with values ranging from zero (0) to one (1), and is used in binary\n classification. Precision is an important metric when the cost of a false positive\n is high. For example, the cost of a false positive is very high if an airplane\n safety system is falsely deemed safe to fly. A false positive (FP) reflects a\n positive prediction that is actually negative in the data.
\nThe precision macro computes precision for multiclass classification problems.\n It does this by calculating precision for each class and averaging scores to\n obtain precision for several classes. PrecisionMacro scores range\n from zero (0) to one (1). Higher scores reflect the model's ability to predict\n true positives (TP) out of all of the positives that it identifies, averaged\n across multiple classes.
R2, also known as the coefficient of determination, is used in regression to\n quantify how much a model can explain the variance of a dependent variable. Values\n range from one (1) to negative one (-1). Higher numbers indicate a higher fraction\n of explained variability. R2 values close to zero (0) indicate that\n very little of the dependent variable can be explained by the model. Negative\n values indicate a poor fit and that the model is outperformed by a constant\n function. For linear regression, this is a horizontal line.
Recall measures how well an algorithm correctly predicts all of the true\n positives (TP) in a dataset. A true positive is a positive prediction that is also\n an actual positive value in the data. Recall is defined as follows: Recall =\n TP/(TP+FN), with values ranging from 0 to 1. Higher scores reflect a better\n ability of the model to predict true positives (TP) in the data, and is used in\n binary classification.
\nRecall is important when testing for cancer because it's used to find all of\n the true positives. A false positive (FP) reflects a positive prediction that is\n actually negative in the data. It is often insufficient to measure only recall,\n because predicting every output as a true positive will yield a perfect recall\n score.
\nThe RecallMacro computes recall for multiclass classification problems by\n calculating recall for each class and averaging scores to obtain recall for\n several classes. RecallMacro scores range from 0 to 1. Higher scores reflect the\n model's ability to predict true positives (TP) in a dataset. Whereas, a true\n positive reflects a positive prediction that is also an actual positive value in\n the data. It is often insufficient to measure only recall, because predicting\n every output as a true positive will yield a perfect recall score.
\nRoot mean squared error (RMSE) measures the square root of the squared\n difference between predicted and actual values, and it's averaged over all values.\n It is used in regression analysis to understand model prediction error. It's an\n important metric to indicate the presence of large model errors and outliers.\n Values range from zero (0) to infinity, with smaller numbers indicating a better\n model fit to the data. RMSE is dependent on scale, and should not be used to\n compare datasets of different sizes.
\nIf you do not specify a metric explicitly, the default behavior is to automatically\n use:
\n\n MSE: for regression.
\n F1: for binary classification
\n Accuracy: for multiclass classification.
Creates an SageMaker experiment. An experiment is a collection of\n trials that are observed, compared and evaluated as a group. A trial is\n a set of steps, called trial components, that produce a machine learning\n model.
\nThe goal of an experiment is to determine the components that produce the best model.\n Multiple trials are performed, each one isolating and measuring the impact of a change to one\n or more inputs, while keeping the remaining inputs constant.
\nWhen you use SageMaker Studio or the SageMaker Python SDK, all experiments, trials, and trial\n components are automatically tracked, logged, and indexed. When you use the Amazon Web Services SDK for Python (Boto), you\n must use the logging APIs provided by the SDK.
\nYou can add tags to experiments, trials, trial components and then use the Search API to search for the tags.
\nTo add a description to an experiment, specify the optional Description\n parameter. To add a description later, or to change the description, call the UpdateExperiment API.
To get a list of all your experiments, call the ListExperiments API. To\n view an experiment's properties, call the DescribeExperiment API. To get a\n list of all the trials associated with an experiment, call the ListTrials\n API. To create a trial call the CreateTrial API.
" + "smithy.api#documentation": "Creates a SageMaker experiment. An experiment is a collection of\n trials that are observed, compared and evaluated as a group. A trial is\n a set of steps, called trial components, that produce a machine learning\n model.
\nIn the Studio UI, trials are referred to as run groups and trial\n components are referred to as runs.
\nThe goal of an experiment is to determine the components that produce the best model.\n Multiple trials are performed, each one isolating and measuring the impact of a change to one\n or more inputs, while keeping the remaining inputs constant.
\nWhen you use SageMaker Studio or the SageMaker Python SDK, all experiments, trials, and trial\n components are automatically tracked, logged, and indexed. When you use the Amazon Web Services SDK for Python (Boto), you\n must use the logging APIs provided by the SDK.
\nYou can add tags to experiments, trials, trial components and then use the Search API to search for the tags.
\nTo add a description to an experiment, specify the optional Description\n parameter. To add a description later, or to change the description, call the UpdateExperiment API.
To get a list of all your experiments, call the ListExperiments API. To\n view an experiment's properties, call the DescribeExperiment API. To get a\n list of all the trials associated with an experiment, call the ListTrials\n API. To create a trial call the CreateTrial API.
" } }, "com.amazonaws.sagemaker#CreateExperimentRequest": { @@ -13018,7 +13066,7 @@ "BestCandidate": { "target": "com.amazonaws.sagemaker#AutoMLCandidate", "traits": { - "smithy.api#documentation": "Returns the job's best AutoMLCandidate.
The best model candidate selected by SageMaker Autopilot using both the best objective metric and\n lowest InferenceLatency for\n an experiment.
" } }, "AutoMLJobStatus": { @@ -18812,7 +18860,7 @@ "Sources": { "target": "com.amazonaws.sagemaker#TrialComponentSources", "traits": { - "smithy.api#documentation": "A list of the Amazon Resource Name (ARN) and, if applicable, job type for multiple sources of an experiment run.
" + "smithy.api#documentation": "A list of ARNs and, if applicable, job types for multiple sources of an experiment\n run.
" } } } @@ -21527,7 +21575,7 @@ "ExperimentName": { "target": "com.amazonaws.sagemaker#ExperimentEntityName", "traits": { - "smithy.api#documentation": "The name of an existing experiment to associate the trial component with.
" + "smithy.api#documentation": "The name of an existing experiment to associate with the trial component.
" } }, "TrialName": { @@ -21545,7 +21593,7 @@ "RunName": { "target": "com.amazonaws.sagemaker#ExperimentEntityName", "traits": { - "smithy.api#documentation": "The name of the experiment run to associate the trial component with.
" + "smithy.api#documentation": "The name of the experiment run to associate with the trial component.
" } } }, @@ -24295,7 +24343,7 @@ "ParameterRanges": { "target": "com.amazonaws.sagemaker#ParameterRanges", "traits": { - "smithy.api#documentation": "The ParameterRanges object that specifies the ranges of\n hyperparameters that this tuning job searches over to find the optimal configuration for\n the highest model performance against .your chosen objective metric.
" + "smithy.api#documentation": "The ParameterRanges object that specifies the ranges of\n hyperparameters that this tuning job searches over to find the optimal configuration for\n the highest model performance against your chosen objective metric.
" } }, "TrainingJobEarlyStoppingType": { diff --git a/codegen/sdk-codegen/aws-models/transcribe.json b/codegen/sdk-codegen/aws-models/transcribe.json index ae8acd625c4..dc75131b695 100644 --- a/codegen/sdk-codegen/aws-models/transcribe.json +++ b/codegen/sdk-codegen/aws-models/transcribe.json @@ -58,7 +58,7 @@ } }, "traits": { - "smithy.api#documentation": "A time range, in milliseconds, between two points in your media file.
\nYou can use StartTime and EndTime to search a custom\n segment. For example, setting StartTime to 10000 and EndTime\n to 50000 only searches for your specified criteria in the audio contained between the\n 10,000 millisecond mark and the 50,000 millisecond mark of your media file. You must use\n StartTime and EndTime as a set; that is, if you include\n one, you must include both.
You can use also First to search from the start of the audio until the\n time that you specify, or Last to search from the time that you specify\n until the end of the audio. For example, setting First to 50000 only\n searches for your specified criteria in the audio contained between the start of the\n media file to the 50,000 millisecond mark. You can use First and\n Last independently of each other.
If you prefer to use percentage instead of milliseconds, see .
" + "smithy.api#documentation": "A time range, in milliseconds, between two points in your media file.
\nYou can use StartTime and EndTime to search a custom\n segment. For example, setting StartTime to 10000 and EndTime\n to 50000 only searches for your specified criteria in the audio contained between the\n 10,000 millisecond mark and the 50,000 millisecond mark of your media file. You must use\n StartTime and EndTime as a set; that is, if you include\n one, you must include both.
You can use also First to search from the start of the audio until the\n time that you specify, or Last to search from the time that you specify\n until the end of the audio. For example, setting First to 50000 only\n searches for your specified criteria in the audio contained between the start of the\n media file to the 50,000 millisecond mark. You can use First and\n Last independently of each other.
If you prefer to use percentage instead of milliseconds, see .
" } }, "com.amazonaws.transcribe#BadRequestException": { @@ -153,13 +153,13 @@ "CallAnalyticsJobStatus": { "target": "com.amazonaws.transcribe#CallAnalyticsJobStatus", "traits": { - "smithy.api#documentation": "Provides the status of the specified Call Analytics job.
\nIf the status is COMPLETED, the job is finished and you can find the\n results at the location specified in TranscriptFileUri (or\n RedactedTranscriptFileUri, if you requested transcript redaction). If\n the status is FAILED, FailureReason provides details on why\n your transcription job failed.
Provides the status of the specified Call Analytics job.
\nIf the status is COMPLETED, the job is finished and you can find the\n results at the location specified in TranscriptFileUri (or\n RedactedTranscriptFileUri, if you requested transcript redaction). If\n the status is FAILED, FailureReason provides details on why\n your transcription job failed.
The language code used to create your Call Analytics job. For a list of supported\n languages and their associated language codes, refer to the Supported languages\n table.
\nIf you don't know the language spoken in your media file, you can omit this field and\n let Amazon Transcribe automatically identify the language of your media. To improve the\n accuracy of language identification, you can include several language codes and Amazon Transcribe chooses the closest match for your transcription.
" + "smithy.api#documentation": "The language code used to create your Call Analytics job. For a list of supported\n languages and their associated language codes, refer to the Supported languages\n table.
\nIf you don't know the language spoken in your media file, you can omit this field and\n let Amazon Transcribe automatically identify the language of your media. To improve the\n accuracy of language identification, you can include several language codes and Amazon Transcribe chooses the closest match for your transcription.
" } }, "MediaSampleRateHertz": { @@ -186,25 +186,25 @@ "StartTime": { "target": "com.amazonaws.transcribe#DateTime", "traits": { - "smithy.api#documentation": "The date and time the specified Call Analytics job began processing.
\nTimestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.789000-07:00 represents a transcription job\n that started processing at 12:32 PM UTC-7 on May 4, 2022.
The date and time the specified Call Analytics job began processing.
\nTimestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.789000-07:00 represents a transcription job\n that started processing at 12:32 PM UTC-7 on May 4, 2022.
The date and time the specified Call Analytics job request was made.
\nTimestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.761000-07:00 represents a transcription job\n that started processing at 12:32 PM UTC-7 on May 4, 2022.
The date and time the specified Call Analytics job request was made.
\nTimestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.761000-07:00 represents a transcription job\n that started processing at 12:32 PM UTC-7 on May 4, 2022.
The date and time the specified Call Analytics job finished processing.
\nTimestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:33:13.922000-07:00 represents a transcription job\n that started processing at 12:33 PM UTC-7 on May 4, 2022.
The date and time the specified Call Analytics job finished processing.
\nTimestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:33:13.922000-07:00 represents a transcription job\n that started processing at 12:33 PM UTC-7 on May 4, 2022.
If CallAnalyticsJobStatus is FAILED,\n FailureReason contains information about why the Call Analytics job\n request failed.
The FailureReason field contains one of the following values:
\n Unsupported media format.
The media format specified in MediaFormat isn't valid. Refer to\n MediaFormat for a list of supported\n formats.
\n The media format provided does not match the detected media\n format.
The media format specified in MediaFormat doesn't match the\n format of the input file. Check the media format of your media file and correct\n the specified value.
\n Invalid sample rate for audio file.
The sample rate specified in MediaSampleRateHertz isn't valid.\n The sample rate must be between 8,000 and 48,000 hertz.
\n The sample rate provided does not match the detected sample\n rate.
The sample rate specified in MediaSampleRateHertz doesn't match\n the sample rate detected in your input media file. Check the sample rate of your\n media file and correct the specified value.
\n Invalid file size: file size too large.
The size of your media file is larger than what Amazon Transcribe can\n process. For more information, refer to Guidelines and\n quotas.
\n\n Invalid number of channels: number of channels too large.
Your audio contains more channels than Amazon Transcribe is able to process.\n For more information, refer to Guidelines and\n quotas.
\nIf CallAnalyticsJobStatus is FAILED,\n FailureReason contains information about why the Call Analytics job\n request failed.
The FailureReason field contains one of the following values:
\n Unsupported media format.
The media format specified in MediaFormat isn't valid. Refer to\n MediaFormat for a list of supported\n formats.
\n The media format provided does not match the detected media\n format.
The media format specified in MediaFormat doesn't match the\n format of the input file. Check the media format of your media file and correct\n the specified value.
\n Invalid sample rate for audio file.
The sample rate specified in MediaSampleRateHertz isn't valid.\n The sample rate must be between 8,000 and 48,000 hertz.
\n The sample rate provided does not match the detected sample\n rate.
The sample rate specified in MediaSampleRateHertz doesn't match\n the sample rate detected in your input media file. Check the sample rate of your\n media file and correct the specified value.
\n Invalid file size: file size too large.
The size of your media file is larger than what Amazon Transcribe can\n process. For more information, refer to Guidelines and\n quotas.
\n\n Invalid number of channels: number of channels too large.
Your audio contains more channels than Amazon Transcribe is able to process.\n For more information, refer to Guidelines and\n quotas.
\nThe confidence score associated with the language identified in your media\n file.
\nConfidence scores are values between 0 and 1; a larger value indicates a higher\n probability that the identified language correctly matches the language spoken in your\n media.
" + "smithy.api#documentation": "The confidence score associated with the language identified in your media\n file.
\nConfidence scores are values between 0 and 1; a larger value indicates a higher\n probability that the identified language correctly matches the language spoken in your\n media.
" } }, "Settings": { @@ -233,7 +233,7 @@ } }, "traits": { - "smithy.api#documentation": "Provides detailed information about a Call Analytics job.
\nTo view the job's status, refer to CallAnalyticsJobStatus. If the status\n is COMPLETED, the job is finished. You can find your completed transcript\n at the URI specified in TranscriptFileUri. If the status is\n FAILED, FailureReason provides details on why your\n transcription job failed.
If you enabled personally identifiable information (PII) redaction, the redacted\n transcript appears at the location specified in\n RedactedTranscriptFileUri.
If you chose to redact the audio in your media file, you can find your redacted media\n file at the location specified in the RedactedMediaFileUri field of your\n response.
Provides detailed information about a Call Analytics job.
\nTo view the job's status, refer to CallAnalyticsJobStatus. If the status\n is COMPLETED, the job is finished. You can find your completed transcript\n at the URI specified in TranscriptFileUri. If the status is\n FAILED, FailureReason provides details on why your\n transcription job failed.
If you enabled personally identifiable information (PII) redaction, the redacted\n transcript appears at the location specified in\n RedactedTranscriptFileUri.
If you chose to redact the audio in your media file, you can find your redacted media\n file at the location specified in the RedactedMediaFileUri field of your\n response.
The name of the custom vocabulary filter you want to include in your Call Analytics\n transcription request. Custom vocabulary filter names are case sensitive.
\nNote that if you include VocabularyFilterName in your request, you must\n also include VocabularyFilterMethod.
The name of the custom vocabulary filter you want to include in your Call Analytics\n transcription request. Custom vocabulary filter names are case sensitive.
\nNote that if you include VocabularyFilterName in your request, you must\n also include VocabularyFilterMethod.
Specify how you want your custom vocabulary filter applied to your transcript.
\nTo replace words with ***, choose mask.
To delete words, choose remove.
To flag words without changing them, choose tag.
Specify how you want your custom vocabulary filter applied to your transcript.
\nTo replace words with ***, choose mask.
To delete words, choose remove.
To flag words without changing them, choose tag.
The name of the custom language model you want to use when processing your Call\n Analytics job. Note that custom language model names are case sensitive.
\nThe language of the specified custom language model must match the language code that\n you specify in your transcription request. If the languages don't match, the custom\n language model isn't applied. There are no errors or warnings associated with a language\n mismatch.
" + "smithy.api#documentation": "The name of the custom language model you want to use when processing your Call\n Analytics job. Note that custom language model names are case sensitive.
\nThe language of the specified custom language model must match the language code that\n you specify in your transcription request. If the languages don't match, the custom\n language model isn't applied. There are no errors or warnings associated with a language\n mismatch.
" } }, "ContentRedaction": { @@ -279,13 +279,13 @@ "LanguageOptions": { "target": "com.amazonaws.transcribe#LanguageOptions", "traits": { - "smithy.api#documentation": "You can specify two or more language codes that represent the languages you think may\n be present in your media. Including more than five is not recommended. If you're unsure\n what languages are present, do not include this parameter.
\nIncluding language options can improve the accuracy of language identification.
\nFor a list of languages supported with Call Analytics, refer to the Supported\n languages table.
\nTo transcribe speech in Modern Standard Arabic (ar-SA), your media file\n must be encoded at a sample rate of 16,000 Hz or higher.
You can specify two or more language codes that represent the languages you think may\n be present in your media. Including more than five is not recommended. If you're unsure\n what languages are present, do not include this parameter.
\nIncluding language options can improve the accuracy of language identification.
\nFor a list of languages supported with Call Analytics, refer to the Supported\n languages table.
\nTo transcribe speech in Modern Standard Arabic (ar-SA), your media file\n must be encoded at a sample rate of 16,000 Hz or higher.
If using automatic language identification in your request and you want to apply a\n custom language model, a custom vocabulary, or a custom vocabulary filter, include\n LanguageIdSettings with the relevant sub-parameters\n (VocabularyName, LanguageModelName, and\n VocabularyFilterName).
\n LanguageIdSettings supports two to five language codes. Each language\n code you include can have an associated custom language model, custom vocabulary, and\n custom vocabulary filter. The language codes that you specify must match the languages\n of the associated custom language models, custom vocabularies, and custom vocabulary\n filters.
It's recommended that you include LanguageOptions when using\n LanguageIdSettings to ensure that the correct language dialect is\n identified. For example, if you specify a custom vocabulary that is in\n en-US but Amazon Transcribe determines that the language spoken in\n your media is en-AU, your custom vocabulary is not\n applied to your transcription. If you include LanguageOptions and include\n en-US as the only English language dialect, your custom vocabulary\n is applied to your transcription.
If you want to include a custom language model, custom vocabulary, or custom\n vocabulary filter with your request but do not want to\n use automatic language identification, use instead the parameter with the\n LanguageModelName, VocabularyName, or\n VocabularyFilterName sub-parameters.
For a list of languages supported with Call Analytics, refer to Supported languages and \n language-specific features.
" + "smithy.api#documentation": "If using automatic language identification in your request and you want to apply a\n custom language model, a custom vocabulary, or a custom vocabulary filter, include\n LanguageIdSettings with the relevant sub-parameters\n (VocabularyName, LanguageModelName, and\n VocabularyFilterName).
\n LanguageIdSettings supports two to five language codes. Each language\n code you include can have an associated custom language model, custom vocabulary, and\n custom vocabulary filter. The language codes that you specify must match the languages\n of the associated custom language models, custom vocabularies, and custom vocabulary\n filters.
It's recommended that you include LanguageOptions when using\n LanguageIdSettings to ensure that the correct language dialect is\n identified. For example, if you specify a custom vocabulary that is in\n en-US but Amazon Transcribe determines that the language spoken in\n your media is en-AU, your custom vocabulary is not\n applied to your transcription. If you include LanguageOptions and include\n en-US as the only English language dialect, your custom vocabulary\n is applied to your transcription.
If you want to include a custom language model, custom vocabulary, or custom\n vocabulary filter with your request but do not want to\n use automatic language identification, use instead the parameter with the\n LanguageModelName, VocabularyName, or\n VocabularyFilterName sub-parameters.
For a list of languages supported with Call Analytics, refer to Supported languages and \n language-specific features.
" } } }, @@ -340,19 +340,19 @@ "CreationTime": { "target": "com.amazonaws.transcribe#DateTime", "traits": { - "smithy.api#documentation": "The date and time the specified Call Analytics job request was made.
\nTimestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.761000-07:00 represents a transcription job\n that started processing at 12:32 PM UTC-7 on May 4, 2022.
The date and time the specified Call Analytics job request was made.
\nTimestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.761000-07:00 represents a transcription job\n that started processing at 12:32 PM UTC-7 on May 4, 2022.
The date and time your Call Analytics job began processing.
\nTimestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.789000-07:00 represents a transcription job\n that started processing at 12:32 PM UTC-7 on May 4, 2022.
The date and time your Call Analytics job began processing.
\nTimestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.789000-07:00 represents a transcription job\n that started processing at 12:32 PM UTC-7 on May 4, 2022.
The date and time the specified Call Analytics job finished processing.
\nTimestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:33:13.922000-07:00 represents a transcription job\n that started processing at 12:33 PM UTC-7 on May 4, 2022.
The date and time the specified Call Analytics job finished processing.
\nTimestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:33:13.922000-07:00 represents a transcription job\n that started processing at 12:33 PM UTC-7 on May 4, 2022.
Provides the status of your Call Analytics job.
\nIf the status is COMPLETED, the job is finished and you can find the\n results at the location specified in TranscriptFileUri (or\n RedactedTranscriptFileUri, if you requested transcript redaction). If\n the status is FAILED, FailureReason provides details on why\n your transcription job failed.
Provides the status of your Call Analytics job.
\nIf the status is COMPLETED, the job is finished and you can find the\n results at the location specified in TranscriptFileUri (or\n RedactedTranscriptFileUri, if you requested transcript redaction). If\n the status is FAILED, FailureReason provides details on why\n your transcription job failed.
The date and time the specified Call Analytics category was created.
\nTimestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May\n 4, 2022.
The date and time the specified Call Analytics category was created.
\nTimestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May\n 4, 2022.
The date and time the specified Call Analytics category was last updated.
\nTimestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-05T12:45:32.691000-07:00 represents 12:45 PM UTC-7 on May\n 5, 2022.
The date and time the specified Call Analytics category was last updated.
\nTimestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-05T12:45:32.691000-07:00 represents 12:45 PM UTC-7 on May\n 5, 2022.
Specify if you want only a redacted transcript, or if you want a redacted and an\n unredacted transcript.
\nWhen you choose redacted\n Amazon Transcribe creates only a redacted transcript.
When you choose redacted_and_unredacted\n Amazon Transcribe creates a redacted and an unredacted transcript (as two separate\n files).
Specify if you want only a redacted transcript, or if you want a redacted and an\n unredacted transcript.
\nWhen you choose redacted\n Amazon Transcribe creates only a redacted transcript.
When you choose redacted_and_unredacted\n Amazon Transcribe creates a redacted and an unredacted transcript (as two separate\n files).
Creates a new Call Analytics category.
\nAll categories are automatically applied to your Call Analytics transcriptions. Note that in\n order to apply categories to your transcriptions, you must create them before submitting your\n transcription request, as categories cannot be applied retroactively.
\nWhen creating a new category, you can use the InputType parameter to \n label the category as a batch category (POST_CALL) or a streaming category \n (REAL_TIME). Batch categories can only be applied to batch transcriptions and \n streaming categories can only be applied to streaming transcriptions. If you do not include \n InputType, your category is created as a batch category by default.
Call Analytics categories are composed of rules. For each category, you must create\n between 1 and 20 rules. Rules can include these parameters: , , , and .
\nTo update an existing category, see .
\nTo learn more about Call Analytics categories, see Creating categories for batch\n transcriptions and Creating categories for\n streaming transcriptions.
", + "smithy.api#documentation": "Creates a new Call Analytics category.
\nAll categories are automatically applied to your Call Analytics transcriptions. Note that in\n order to apply categories to your transcriptions, you must create them before submitting your\n transcription request, as categories cannot be applied retroactively.
\nWhen creating a new category, you can use the InputType parameter to \n label the category as a batch category (POST_CALL) or a streaming category \n (REAL_TIME). Batch categories can only be applied to batch transcriptions and \n streaming categories can only be applied to streaming transcriptions. If you do not include \n InputType, your category is created as a batch category by default.
Call Analytics categories are composed of rules. For each category, you must create\n between 1 and 20 rules. Rules can include these parameters: , , , and .
\nTo update an existing category, see .
\nTo learn more about Call Analytics categories, see Creating categories for batch\n transcriptions and Creating categories for\n streaming transcriptions.
", "smithy.api#http": { "method": "PUT", "uri": "/callanalyticscategories/{CategoryName}", @@ -553,7 +553,7 @@ "CategoryName": { "target": "com.amazonaws.transcribe#CategoryName", "traits": { - "smithy.api#documentation": "A unique name, chosen by you, for your Call Analytics category. It's helpful to use a\n detailed naming system that will make sense to you in the future. For example, it's\n better to use sentiment-positive-last30seconds for a category over a\n generic name like test-category.
Category names are case sensitive.
", + "smithy.api#documentation": "A unique name, chosen by you, for your Call Analytics category. It's helpful to use a\n detailed naming system that will make sense to you in the future. For example, it's\n better to use sentiment-positive-last30seconds for a category over a\n generic name like test-category.
Category names are case sensitive.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -568,7 +568,7 @@ "InputType": { "target": "com.amazonaws.transcribe#InputType", "traits": { - "smithy.api#documentation": "Choose whether you want to create a streaming or a batch category for your Call Analytics \n transcription.
\nSpecifying POST_CALL assigns your category to batch transcriptions; \n categories with this input type cannot be applied to streaming (real-time) \n transcriptions.
Specifying REAL_TIME assigns your category to streaming transcriptions; \n categories with this input type cannot be applied to batch (post-call)\n transcriptions.
If you do not include InputType, your category is created as a batch \n category by default.
Choose whether you want to create a streaming or a batch category for your Call Analytics \n transcription.
\nSpecifying POST_CALL assigns your category to batch transcriptions; \n categories with this input type cannot be applied to streaming (real-time) \n transcriptions.
Specifying REAL_TIME assigns your category to streaming transcriptions; \n categories with this input type cannot be applied to batch (post-call)\n transcriptions.
If you do not include InputType, your category is created as a batch \n category by default.
Creates a new custom language model.
\nWhen creating a new custom language model, you must specify:
\nIf you want a Wideband (audio sample rates over 16,000 Hz) or Narrowband\n (audio sample rates under 16,000 Hz) base model
\nThe location of your training and tuning files (this must be an Amazon S3 URI)
\nThe language of your model
\nA unique name for your model
\nCreates a new custom language model.
\nWhen creating a new custom language model, you must specify:
\nIf you want a Wideband (audio sample rates over 16,000 Hz) or Narrowband\n (audio sample rates under 16,000 Hz) base model
\nThe location of your training and tuning files (this must be an Amazon S3 URI)
\nThe language of your model
\nA unique name for your model
\nThe language code that represents the language of your model. Each custom language\n model must contain terms in only one language, and the language you select for your\n custom language model must match the language of your training and tuning data.
\nFor a list of supported languages and their associated language codes, refer to the\n Supported languages table. Note that\n US English\n (en-US) is the only language supported with Amazon Transcribe\n Medical.
A custom language model can only be used to transcribe files in the same language as\n the model. For example, if you create a custom language model using US English\n (en-US), you can only apply this model to files that contain English\n audio.
The language code that represents the language of your model. Each custom language\n model must contain terms in only one language, and the language you select for your\n custom language model must match the language of your training and tuning data.
\nFor a list of supported languages and their associated language codes, refer to the\n Supported languages table. Note that\n US English\n (en-US) is the only language supported with Amazon Transcribe\n Medical.
A custom language model can only be used to transcribe files in the same language as\n the model. For example, if you create a custom language model using US English\n (en-US), you can only apply this model to files that contain English\n audio.
The Amazon Transcribe standard language model, or base model, used to create your\n custom language model. Amazon Transcribe offers two options for base models: Wideband\n and Narrowband.
\nIf the audio you want to transcribe has a sample rate of 16,000 Hz or greater, choose\n WideBand. To transcribe audio with a sample rate less than 16,000 Hz,\n choose NarrowBand.
The Amazon Transcribe standard language model, or base model, used to create your\n custom language model. Amazon Transcribe offers two options for base models: Wideband\n and Narrowband.
\nIf the audio you want to transcribe has a sample rate of 16,000 Hz or greater, choose\n WideBand. To transcribe audio with a sample rate less than 16,000 Hz,\n choose NarrowBand.
A unique name, chosen by you, for your custom language model.
\nThis name is case sensitive, cannot contain spaces, and must be unique within an\n Amazon Web Services account. If you try to create a new custom language model with\n the same name as an existing custom language model, you get a\n ConflictException error.
A unique name, chosen by you, for your custom language model.
\nThis name is case sensitive, cannot contain spaces, and must be unique within an\n Amazon Web Services account. If you try to create a new custom language model with\n the same name as an existing custom language model, you get a\n ConflictException error.
Contains the Amazon S3 location of the training data you want to use to create\n a new custom language model, and permissions to access this location.
\nWhen using InputDataConfig, you must include these sub-parameters:\n S3Uri, which is the Amazon S3 location of your training data,\n and DataAccessRoleArn, which is the Amazon Resource Name (ARN) of the role\n that has permission to access your specified Amazon S3 location. You can\n optionally include TuningDataS3Uri, which is the Amazon S3 location\n of your tuning data. If you specify different Amazon S3 locations for training\n and tuning data, the ARN you use must have permissions to access both locations.
Contains the Amazon S3 location of the training data you want to use to create\n a new custom language model, and permissions to access this location.
\nWhen using InputDataConfig, you must include these sub-parameters:\n S3Uri, which is the Amazon S3 location of your training data,\n and DataAccessRoleArn, which is the Amazon Resource Name (ARN) of the role\n that has permission to access your specified Amazon S3 location. You can\n optionally include TuningDataS3Uri, which is the Amazon S3 location\n of your tuning data. If you specify different Amazon S3 locations for training\n and tuning data, the ARN you use must have permissions to access both locations.
Adds one or more custom tags, each in the form of a key:value pair, to a new custom\n language model at the time you create this new model.
\nTo learn more about using tags with Amazon Transcribe, refer to Tagging\n resources.
" + "smithy.api#documentation": "Adds one or more custom tags, each in the form of a key:value pair, to a new custom\n language model at the time you create this new model.
\nTo learn more about using tags with Amazon Transcribe, refer to Tagging\n resources.
" } } } @@ -713,7 +713,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a new custom medical vocabulary.
\nBefore creating a new custom medical vocabulary, you must first upload a text file\n that contains your new entries, phrases, and terms into an Amazon S3 bucket.\n Note that this differs from , where you can\n include a list of terms within your request using the Phrases flag;\n CreateMedicalVocabulary does not support the Phrases\n flag.
Each language has a character set that contains all allowed characters for that\n specific language. If you use unsupported characters, your custom vocabulary request\n fails. Refer to Character Sets for Custom Vocabularies to get the character set for your\n language.
\nFor more information, see Custom\n vocabularies.
", + "smithy.api#documentation": "Creates a new custom medical vocabulary.
\nBefore creating a new custom medical vocabulary, you must first upload a text file\n that contains your new entries, phrases, and terms into an Amazon S3 bucket.\n Note that this differs from , where you can\n include a list of terms within your request using the Phrases flag;\n CreateMedicalVocabulary does not support the Phrases\n flag.
Each language has a character set that contains all allowed characters for that\n specific language. If you use unsupported characters, your custom vocabulary request\n fails. Refer to Character Sets for Custom Vocabularies to get the character set for your\n language.
\nFor more information, see Custom\n vocabularies.
", "smithy.api#http": { "method": "PUT", "uri": "/medicalvocabularies/{VocabularyName}", @@ -727,7 +727,7 @@ "VocabularyName": { "target": "com.amazonaws.transcribe#VocabularyName", "traits": { - "smithy.api#documentation": "A unique name, chosen by you, for your new custom medical vocabulary.
\nThis name is case sensitive, cannot contain spaces, and must be unique within an\n Amazon Web Services account. If you try to create a new custom medical vocabulary\n with the same name as an existing custom medical vocabulary, you get a\n ConflictException error.
A unique name, chosen by you, for your new custom medical vocabulary.
\nThis name is case sensitive, cannot contain spaces, and must be unique within an\n Amazon Web Services account. If you try to create a new custom medical vocabulary\n with the same name as an existing custom medical vocabulary, you get a\n ConflictException error.
The Amazon S3 location (URI) of the text file that contains your custom\n medical vocabulary. The URI must be in the same Amazon Web Services Region as the\n resource you're calling.
\nHere's an example URI path:\n s3://DOC-EXAMPLE-BUCKET/my-vocab-file.txt\n
The Amazon S3 location (URI) of the text file that contains your custom\n medical vocabulary. The URI must be in the same Amazon Web Services Region as the\n resource you're calling.
\nHere's an example URI path:\n s3://DOC-EXAMPLE-BUCKET/my-vocab-file.txt\n
Adds one or more custom tags, each in the form of a key:value pair, to a new custom\n medical vocabulary at the time you create this new custom vocabulary.
\nTo learn more about using tags with Amazon Transcribe, refer to Tagging\n resources.
" + "smithy.api#documentation": "Adds one or more custom tags, each in the form of a key:value pair, to a new custom\n medical vocabulary at the time you create this new custom vocabulary.
\nTo learn more about using tags with Amazon Transcribe, refer to Tagging\n resources.
" } } } @@ -778,7 +778,7 @@ "LastModifiedTime": { "target": "com.amazonaws.transcribe#DateTime", "traits": { - "smithy.api#documentation": "The date and time you created your custom medical vocabulary.
\nTimestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May\n 4, 2022.
The date and time you created your custom medical vocabulary.
\nTimestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May\n 4, 2022.
Creates a new custom vocabulary.
\nWhen creating a new custom vocabulary, you can either upload a text file that contains\n your new entries, phrases, and terms into an Amazon S3 bucket and include the\n URI in your request. Or you can include a list of terms directly in your request using\n the Phrases flag.
Each language has a character set that contains all allowed characters for that\n specific language. If you use unsupported characters, your custom vocabulary request\n fails. Refer to Character Sets for Custom Vocabularies to get the character set for your\n language.
\nFor more information, see Custom\n vocabularies.
", + "smithy.api#documentation": "Creates a new custom vocabulary.
\nWhen creating a new custom vocabulary, you can either upload a text file that contains\n your new entries, phrases, and terms into an Amazon S3 bucket and include the\n URI in your request. Or you can include a list of terms directly in your request using\n the Phrases flag.
Each language has a character set that contains all allowed characters for that\n specific language. If you use unsupported characters, your custom vocabulary request\n fails. Refer to Character Sets for Custom Vocabularies to get the character set for your\n language.
\nFor more information, see Custom\n vocabularies.
", "smithy.api#http": { "method": "PUT", "uri": "/vocabularies/{VocabularyName}", @@ -843,7 +843,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a new custom vocabulary filter.
\nYou can use custom vocabulary filters to mask, delete, or flag specific words from\n your transcript. Custom vocabulary filters are commonly used to mask profanity in\n transcripts.
\nEach language has a character set that contains all allowed characters for that\n specific language. If you use unsupported characters, your custom vocabulary filter\n request fails. Refer to Character Sets for Custom\n Vocabularies to get the character set for your language.
\nFor more information, see Vocabulary\n filtering.
", + "smithy.api#documentation": "Creates a new custom vocabulary filter.
\nYou can use custom vocabulary filters to mask, delete, or flag specific words from\n your transcript. Custom vocabulary filters are commonly used to mask profanity in\n transcripts.
\nEach language has a character set that contains all allowed characters for that\n specific language. If you use unsupported characters, your custom vocabulary filter\n request fails. Refer to Character Sets for Custom\n Vocabularies to get the character set for your language.
\nFor more information, see Vocabulary\n filtering.
", "smithy.api#http": { "method": "POST", "uri": "/vocabularyFilters/{VocabularyFilterName}", @@ -857,7 +857,7 @@ "VocabularyFilterName": { "target": "com.amazonaws.transcribe#VocabularyFilterName", "traits": { - "smithy.api#documentation": "A unique name, chosen by you, for your new custom vocabulary filter.
\nThis name is case sensitive, cannot contain spaces, and must be unique within an\n Amazon Web Services account. If you try to create a new custom vocabulary filter with\n the same name as an existing custom vocabulary filter, you get a\n ConflictException error.
A unique name, chosen by you, for your new custom vocabulary filter.
\nThis name is case sensitive, cannot contain spaces, and must be unique within an\n Amazon Web Services account. If you try to create a new custom vocabulary filter with\n the same name as an existing custom vocabulary filter, you get a\n ConflictException error.
The language code that represents the language of the entries in your vocabulary\n filter. Each custom vocabulary filter must contain terms in only one language.
\nA custom vocabulary filter can only be used to transcribe files in the same language\n as the filter. For example, if you create a custom vocabulary filter using US English\n (en-US), you can only apply this filter to files that contain English\n audio.
For a list of supported languages and their associated language codes, refer to the\n Supported languages table.
", + "smithy.api#documentation": "The language code that represents the language of the entries in your vocabulary\n filter. Each custom vocabulary filter must contain terms in only one language.
\nA custom vocabulary filter can only be used to transcribe files in the same language\n as the filter. For example, if you create a custom vocabulary filter using US English\n (en-US), you can only apply this filter to files that contain English\n audio.
For a list of supported languages and their associated language codes, refer to the\n Supported languages table.
", "smithy.api#required": {} } }, "Words": { "target": "com.amazonaws.transcribe#Words", "traits": { - "smithy.api#documentation": "Use this parameter if you want to create your custom vocabulary filter by including\n all desired terms, as comma-separated values, within your request. The other option for\n creating your vocabulary filter is to save your entries in a text file and upload them\n to an Amazon S3 bucket, then specify the location of your file using the\n VocabularyFilterFileUri parameter.
Note that if you include Words in your request, you cannot use\n VocabularyFilterFileUri; you must choose one or the other.
Each language has a character set that contains all allowed characters for that\n specific language. If you use unsupported characters, your custom vocabulary filter\n request fails. Refer to Character Sets for Custom\n Vocabularies to get the character set for your language.
" + "smithy.api#documentation": "Use this parameter if you want to create your custom vocabulary filter by including\n all desired terms, as comma-separated values, within your request. The other option for\n creating your vocabulary filter is to save your entries in a text file and upload them\n to an Amazon S3 bucket, then specify the location of your file using the\n VocabularyFilterFileUri parameter.
Note that if you include Words in your request, you cannot use\n VocabularyFilterFileUri; you must choose one or the other.
Each language has a character set that contains all allowed characters for that\n specific language. If you use unsupported characters, your custom vocabulary filter\n request fails. Refer to Character Sets for Custom\n Vocabularies to get the character set for your language.
" } }, "VocabularyFilterFileUri": { "target": "com.amazonaws.transcribe#Uri", "traits": { - "smithy.api#documentation": "The Amazon S3 location of the text file that contains your custom vocabulary\n filter terms. The URI must be located in the same Amazon Web Services Region as the\n resource you're calling.
\nHere's an example URI path:\n s3://DOC-EXAMPLE-BUCKET/my-vocab-filter-file.txt\n
Note that if you include VocabularyFilterFileUri in your request, you\n cannot use Words; you must choose one or the other.
The Amazon S3 location of the text file that contains your custom vocabulary\n filter terms. The URI must be located in the same Amazon Web Services Region as the\n resource you're calling.
\nHere's an example URI path:\n s3://DOC-EXAMPLE-BUCKET/my-vocab-filter-file.txt\n
Note that if you include VocabularyFilterFileUri in your request, you\n cannot use Words; you must choose one or the other.
Adds one or more custom tags, each in the form of a key:value pair, to a new custom\n vocabulary filter at the time you create this new vocabulary filter.
\nTo learn more about using tags with Amazon Transcribe, refer to Tagging\n resources.
" + "smithy.api#documentation": "Adds one or more custom tags, each in the form of a key:value pair, to a new custom\n vocabulary filter at the time you create this new vocabulary filter.
\nTo learn more about using tags with Amazon Transcribe, refer to Tagging\n resources.
" } } } @@ -907,7 +907,7 @@ "LastModifiedTime": { "target": "com.amazonaws.transcribe#DateTime", "traits": { - "smithy.api#documentation": "The date and time you created your custom vocabulary filter.
\nTimestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May\n 4, 2022.
The date and time you created your custom vocabulary filter.
\nTimestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May\n 4, 2022.
A unique name, chosen by you, for your new custom vocabulary.
\nThis name is case sensitive, cannot contain spaces, and must be unique within an\n Amazon Web Services account. If you try to create a new custom vocabulary with the\n same name as an existing custom vocabulary, you get a ConflictException\n error.
A unique name, chosen by you, for your new custom vocabulary.
\nThis name is case sensitive, cannot contain spaces, and must be unique within an\n Amazon Web Services account. If you try to create a new custom vocabulary with the\n same name as an existing custom vocabulary, you get a ConflictException\n error.
The language code that represents the language of the entries in your custom\n vocabulary. Each custom vocabulary must contain terms in only one language.
\nA custom vocabulary can only be used to transcribe files in the same language as the\n custom vocabulary. For example, if you create a custom vocabulary using US English\n (en-US), you can only apply this custom vocabulary to files that\n contain English audio.
For a list of supported languages and their associated language codes, refer to the\n Supported languages table.
", + "smithy.api#documentation": "The language code that represents the language of the entries in your custom\n vocabulary. Each custom vocabulary must contain terms in only one language.
\nA custom vocabulary can only be used to transcribe files in the same language as the\n custom vocabulary. For example, if you create a custom vocabulary using US English\n (en-US), you can only apply this custom vocabulary to files that\n contain English audio.
For a list of supported languages and their associated language codes, refer to the\n Supported languages table.
", "smithy.api#required": {} } }, "Phrases": { "target": "com.amazonaws.transcribe#Phrases", "traits": { - "smithy.api#documentation": "Use this parameter if you want to create your custom vocabulary by including all\n desired terms, as comma-separated values, within your request. The other option for\n creating your custom vocabulary is to save your entries in a text file and upload them\n to an Amazon S3 bucket, then specify the location of your file using the\n VocabularyFileUri parameter.
Note that if you include Phrases in your request, you cannot use\n VocabularyFileUri; you must choose one or the other.
Each language has a character set that contains all allowed characters for that\n specific language. If you use unsupported characters, your custom vocabulary filter\n request fails. Refer to Character Sets for Custom\n Vocabularies to get the character set for your language.
" + "smithy.api#documentation": "Use this parameter if you want to create your custom vocabulary by including all\n desired terms, as comma-separated values, within your request. The other option for\n creating your custom vocabulary is to save your entries in a text file and upload them\n to an Amazon S3 bucket, then specify the location of your file using the\n VocabularyFileUri parameter.
Note that if you include Phrases in your request, you cannot use\n VocabularyFileUri; you must choose one or the other.
Each language has a character set that contains all allowed characters for that\n specific language. If you use unsupported characters, your custom vocabulary filter\n request fails. Refer to Character Sets for Custom\n Vocabularies to get the character set for your language.
" } }, "VocabularyFileUri": { "target": "com.amazonaws.transcribe#Uri", "traits": { - "smithy.api#documentation": "The Amazon S3 location of the text file that contains your custom vocabulary.\n The URI must be located in the same Amazon Web Services Region as the resource you're\n calling.
\nHere's an example URI path:\n s3://DOC-EXAMPLE-BUCKET/my-vocab-file.txt\n
Note that if you include VocabularyFileUri in your request, you cannot\n use the Phrases flag; you must choose one or the other.
The Amazon S3 location of the text file that contains your custom vocabulary.\n The URI must be located in the same Amazon Web Services Region as the resource you're\n calling.
\nHere's an example URI path:\n s3://DOC-EXAMPLE-BUCKET/my-vocab-file.txt\n
Note that if you include VocabularyFileUri in your request, you cannot\n use the Phrases flag; you must choose one or the other.
Adds one or more custom tags, each in the form of a key:value pair, to a new custom\n vocabulary at the time you create this new custom vocabulary.
\nTo learn more about using tags with Amazon Transcribe, refer to Tagging\n resources.
" + "smithy.api#documentation": "Adds one or more custom tags, each in the form of a key:value pair, to a new custom\n vocabulary at the time you create this new custom vocabulary.
\nTo learn more about using tags with Amazon Transcribe, refer to Tagging\n resources.
" } } } @@ -974,7 +974,7 @@ "LastModifiedTime": { "target": "com.amazonaws.transcribe#DateTime", "traits": { - "smithy.api#documentation": "The date and time you created your custom vocabulary.
\nTimestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May\n 4, 2022.
The date and time you created your custom vocabulary.
\nTimestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May\n 4, 2022.
Provides information about the specified custom language model.
\nThis operation also shows if the base language model that you used to create your\n custom language model has been updated. If Amazon Transcribe has updated the base\n model, you can create a new custom language model using the updated base model.
\nIf you tried to create a new custom language model and the request wasn't successful,\n you can use DescribeLanguageModel to help identify the reason for this\n failure.
Provides information about the specified custom language model.
\nThis operation also shows if the base language model that you used to create your\n custom language model has been updated. If Amazon Transcribe has updated the base\n model, you can create a new custom language model using the updated base model.
\nIf you tried to create a new custom language model and the request wasn't successful,\n you can use DescribeLanguageModel to help identify the reason for this\n failure.
Provides information about the specified custom language\n model.
\nThis parameter also shows if the base language model you used to create your custom\n language model has been updated. If Amazon Transcribe has updated the base model, you\n can create a new custom language model using the updated base model.
\nIf you tried to create a new custom language model and the request wasn't successful,\n you can use this DescribeLanguageModel to help identify the reason for this\n failure.
Provides information about the specified custom language\n model.
\nThis parameter also shows if the base language model you used to create your custom\n language model has been updated. If Amazon Transcribe has updated the base model, you\n can create a new custom language model using the updated base model.
\nIf you tried to create a new custom language model and the request wasn't successful,\n you can use this DescribeLanguageModel to help identify the reason for this\n failure.
Provides information about the specified Call Analytics category.
\nTo get a list of your Call Analytics categories, use the operation.
", + "smithy.api#documentation": "Provides information about the specified Call Analytics category.
\nTo get a list of your Call Analytics categories, use the operation.
", "smithy.api#http": { "method": "GET", "uri": "/callanalyticscategories/{CategoryName}", @@ -1485,7 +1485,7 @@ } ], "traits": { - "smithy.api#documentation": "Provides information about the specified Call Analytics job.
\nTo view the job's status, refer to CallAnalyticsJobStatus. If the status\n is COMPLETED, the job is finished. You can find your completed transcript\n at the URI specified in TranscriptFileUri. If the status is\n FAILED, FailureReason provides details on why your\n transcription job failed.
If you enabled personally identifiable information (PII) redaction, the redacted\n transcript appears at the location specified in\n RedactedTranscriptFileUri.
If you chose to redact the audio in your media file, you can find your redacted media\n file at the location specified in RedactedMediaFileUri.
To get a list of your Call Analytics jobs, use the operation.
", + "smithy.api#documentation": "Provides information about the specified Call Analytics job.
\nTo view the job's status, refer to CallAnalyticsJobStatus. If the status\n is COMPLETED, the job is finished. You can find your completed transcript\n at the URI specified in TranscriptFileUri. If the status is\n FAILED, FailureReason provides details on why your\n transcription job failed.
If you enabled personally identifiable information (PII) redaction, the redacted\n transcript appears at the location specified in\n RedactedTranscriptFileUri.
If you chose to redact the audio in your media file, you can find your redacted media\n file at the location specified in RedactedMediaFileUri.
To get a list of your Call Analytics jobs, use the operation.
", "smithy.api#http": { "method": "GET", "uri": "/callanalyticsjobs/{CallAnalyticsJobName}", @@ -1540,7 +1540,7 @@ } ], "traits": { - "smithy.api#documentation": "Provides information about the specified medical transcription job.
\nTo view the status of the specified medical transcription job, check the\n TranscriptionJobStatus field. If the status is COMPLETED,\n the job is finished. You can find the results at the location specified in\n TranscriptFileUri. If the status is FAILED,\n FailureReason provides details on why your transcription job\n failed.
To get a list of your medical transcription jobs, use the operation.
", + "smithy.api#documentation": "Provides information about the specified medical transcription job.
\nTo view the status of the specified medical transcription job, check the\n TranscriptionJobStatus field. If the status is COMPLETED,\n the job is finished. You can find the results at the location specified in\n TranscriptFileUri. If the status is FAILED,\n FailureReason provides details on why your transcription job\n failed.
To get a list of your medical transcription jobs, use the operation.
", "smithy.api#http": { "method": "GET", "uri": "/medicaltranscriptionjobs/{MedicalTranscriptionJobName}", @@ -1595,7 +1595,7 @@ } ], "traits": { - "smithy.api#documentation": "Provides information about the specified custom medical vocabulary.
\nTo view the status of the specified custom medical vocabulary, check the\n VocabularyState field. If the status is READY, your custom\n vocabulary is available to use. If the status is FAILED,\n FailureReason provides details on why your vocabulary failed.
To get a list of your custom medical vocabularies, use the operation.
", + "smithy.api#documentation": "Provides information about the specified custom medical vocabulary.
\nTo view the status of the specified custom medical vocabulary, check the\n VocabularyState field. If the status is READY, your custom\n vocabulary is available to use. If the status is FAILED,\n FailureReason provides details on why your vocabulary failed.
To get a list of your custom medical vocabularies, use the operation.
", "smithy.api#http": { "method": "GET", "uri": "/medicalvocabularies/{VocabularyName}", @@ -1640,7 +1640,7 @@ "LastModifiedTime": { "target": "com.amazonaws.transcribe#DateTime", "traits": { - "smithy.api#documentation": "The date and time the specified custom medical vocabulary was last modified.
\nTimestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May\n 4, 2022.
The date and time the specified custom medical vocabulary was last modified.
\nTimestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May\n 4, 2022.
Provides information about the specified transcription job.
\nTo view the status of the specified transcription job, check the\n TranscriptionJobStatus field. If the status is COMPLETED,\n the job is finished. You can find the results at the location specified in\n TranscriptFileUri. If the status is FAILED,\n FailureReason provides details on why your transcription job\n failed.
If you enabled content redaction, the redacted transcript can be found at the location\n specified in RedactedTranscriptFileUri.
To get a list of your transcription jobs, use the operation.
", + "smithy.api#documentation": "Provides information about the specified transcription job.
\nTo view the status of the specified transcription job, check the\n TranscriptionJobStatus field. If the status is COMPLETED,\n the job is finished. You can find the results at the location specified in\n TranscriptFileUri. If the status is FAILED,\n FailureReason provides details on why your transcription job\n failed.
If you enabled content redaction, the redacted transcript can be found at the location\n specified in RedactedTranscriptFileUri.
To get a list of your transcription jobs, use the operation.
", "smithy.api#http": { "method": "GET", "uri": "/transcriptionjobs/{TranscriptionJobName}", @@ -1735,7 +1735,7 @@ } ], "traits": { - "smithy.api#documentation": "Provides information about the specified custom vocabulary.
\nTo view the status of the specified custom vocabulary, check the\n VocabularyState field. If the status is READY, your custom\n vocabulary is available to use. If the status is FAILED,\n FailureReason provides details on why your custom vocabulary\n failed.
To get a list of your custom vocabularies, use the operation.
", + "smithy.api#documentation": "Provides information about the specified custom vocabulary.
\nTo view the status of the specified custom vocabulary, check the\n VocabularyState field. If the status is READY, your custom\n vocabulary is available to use. If the status is FAILED,\n FailureReason provides details on why your custom vocabulary\n failed.
To get a list of your custom vocabularies, use the operation.
", "smithy.api#http": { "method": "GET", "uri": "/vocabularies/{VocabularyName}", @@ -1766,7 +1766,7 @@ } ], "traits": { - "smithy.api#documentation": "Provides information about the specified custom vocabulary filter.
\nTo get a list of your custom vocabulary filters, use the operation.
", + "smithy.api#documentation": "Provides information about the specified custom vocabulary filter.
\nTo get a list of your custom vocabulary filters, use the operation.
", "smithy.api#http": { "method": "GET", "uri": "/vocabularyFilters/{VocabularyFilterName}", @@ -1805,7 +1805,7 @@ "LastModifiedTime": { "target": "com.amazonaws.transcribe#DateTime", "traits": { - "smithy.api#documentation": "The date and time the specified custom vocabulary filter was last modified.
\nTimestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May\n 4, 2022.
The date and time the specified custom vocabulary filter was last modified.
\nTimestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May\n 4, 2022.
The date and time the specified custom vocabulary was last modified.
\nTimestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May\n 4, 2022.
The date and time the specified custom vocabulary was last modified.
\nTimestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May\n 4, 2022.
The Amazon S3 location (URI) of the text files you want to use to train your\n custom language model.
\nHere's an example URI path:\n s3://DOC-EXAMPLE-BUCKET/my-model-training-data/\n
The Amazon S3 location (URI) of the text files you want to use to train your\n custom language model.
\nHere's an example URI path:\n s3://DOC-EXAMPLE-BUCKET/my-model-training-data/\n
The Amazon S3 location (URI) of the text files you want to use to tune your\n custom language model.
\nHere's an example URI path:\n s3://DOC-EXAMPLE-BUCKET/my-model-tuning-data/\n
The Amazon S3 location (URI) of the text files you want to use to tune your\n custom language model.
\nHere's an example URI path:\n s3://DOC-EXAMPLE-BUCKET/my-model-tuning-data/\n
The Amazon Resource Name (ARN) of an IAM role that has permissions to\n access the Amazon S3 bucket that contains your input files. If the role that you\n specify doesn’t have the appropriate permissions to access the specified Amazon S3 location, your request fails.
\nIAM role ARNs have the format\n arn:partition:iam::account:role/role-name-with-path. For example:\n arn:aws:iam::111122223333:role/Admin.
For more information, see IAM\n ARNs.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM role that has permissions to\n access the Amazon S3 bucket that contains your input files. If the role that you\n specify doesn’t have the appropriate permissions to access the specified Amazon S3 location, your request fails.
\nIAM role ARNs have the format\n arn:partition:iam::account:role/role-name-with-path. For example:\n arn:aws:iam::111122223333:role/Admin.
For more information, see IAM\n ARNs.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Contains the Amazon S3 location of the training data you want to use to create\n a new custom language model, and permissions to access this location.
\nWhen using InputDataConfig, you must include these sub-parameters:\n S3Uri and DataAccessRoleArn. You can optionally include\n TuningDataS3Uri.
Contains the Amazon S3 location of the training data you want to use to create\n a new custom language model, and permissions to access this location.
\nWhen using InputDataConfig, you must include these sub-parameters:\n S3Uri and DataAccessRoleArn. You can optionally include\n TuningDataS3Uri.
Flag the presence or absence of interruptions in your Call Analytics transcription\n output.
\nRules using InterruptionFilter are designed to match:
Instances where an agent interrupts a customer
\nInstances where a customer interrupts an agent
\nEither participant interrupting the other
\nA lack of interruptions
\nSee Rule criteria for batch \n categories for usage examples.
" + "smithy.api#documentation": "Flag the presence or absence of interruptions in your Call Analytics transcription\n output.
\nRules using InterruptionFilter are designed to match:
Instances where an agent interrupts a customer
\nInstances where a customer interrupts an agent
\nEither participant interrupting the other
\nA lack of interruptions
\nSee Rule criteria for batch \n categories for usage examples.
" } }, "com.amazonaws.transcribe#JobExecutionSettings": { @@ -1975,18 +1975,18 @@ "AllowDeferredExecution": { "target": "com.amazonaws.transcribe#Boolean", "traits": { - "smithy.api#documentation": "Makes it possible to enable job queuing when your concurrent request limit is\n exceeded. When AllowDeferredExecution is set to true,\n transcription job requests are placed in a queue until the number of jobs falls below\n the concurrent request limit. If AllowDeferredExecution is set to\n false and the number of transcription job requests exceed the\n concurrent request limit, you get a LimitExceededException error.
Note that job queuing is enabled by default for Call Analytics jobs.
\nIf you include AllowDeferredExecution in your request, you must also\n include DataAccessRoleArn.
Makes it possible to enable job queuing when your concurrent request limit is\n exceeded. When AllowDeferredExecution is set to true,\n transcription job requests are placed in a queue until the number of jobs falls below\n the concurrent request limit. If AllowDeferredExecution is set to\n false and the number of transcription job requests exceed the\n concurrent request limit, you get a LimitExceededException error.
Note that job queuing is enabled by default for Call Analytics jobs.
\nIf you include AllowDeferredExecution in your request, you must also\n include DataAccessRoleArn.
The Amazon Resource Name (ARN) of an IAM role that has permissions to\n access the Amazon S3 bucket that contains your input files. If the role that you\n specify doesn’t have the appropriate permissions to access the specified Amazon S3 \n location, your request fails.
\nIAM role ARNs have the format\n arn:partition:iam::account:role/role-name-with-path. For example:\n arn:aws:iam::111122223333:role/Admin. For more information, see IAM\n ARNs.
Note that if you include DataAccessRoleArn in your request, you must also\n include AllowDeferredExecution.
The Amazon Resource Name (ARN) of an IAM role that has permissions to\n access the Amazon S3 bucket that contains your input files. If the role that you\n specify doesn’t have the appropriate permissions to access the specified Amazon S3 \n location, your request fails.
\nIAM role ARNs have the format\n arn:partition:iam::account:role/role-name-with-path. For example:\n arn:aws:iam::111122223333:role/Admin. For more information, see IAM\n ARNs.
Note that if you include DataAccessRoleArn in your request, you must also\n include AllowDeferredExecution.
Makes it possible to control how your transcription job is processed. Currently, the\n only JobExecutionSettings modification you can choose is enabling job\n queueing using the AllowDeferredExecution sub-parameter.
If you include JobExecutionSettings in your request, you must also\n include the sub-parameters: AllowDeferredExecution and\n DataAccessRoleArn.
Makes it possible to control how your transcription job is processed. Currently, the\n only JobExecutionSettings modification you can choose is enabling job\n queueing using the AllowDeferredExecution sub-parameter.
If you include JobExecutionSettings in your request, you must also\n include the sub-parameters: AllowDeferredExecution and\n DataAccessRoleArn.
The name of the custom vocabulary you want to use when processing your transcription\n job. Custom vocabulary names are case sensitive.
\nThe language of the specified custom vocabulary must match the language code that you\n specify in your transcription request. If the languages don't match, the custom\n vocabulary isn't applied. There are no errors or warnings associated with a language\n mismatch.
" + "smithy.api#documentation": "The name of the custom vocabulary you want to use when processing your transcription\n job. Custom vocabulary names are case sensitive.
\nThe language of the specified custom vocabulary must match the language code that you\n specify in your transcription request. If the languages don't match, the custom\n vocabulary isn't applied. There are no errors or warnings associated with a language\n mismatch.
" } }, "VocabularyFilterName": { "target": "com.amazonaws.transcribe#VocabularyFilterName", "traits": { - "smithy.api#documentation": "The name of the custom vocabulary filter you want to use when processing your\n transcription job. Custom vocabulary filter names are case sensitive.
\nThe language of the specified custom vocabulary filter must match the language code\n that you specify in your transcription request. If the languages don't match, the custom\n vocabulary filter isn't applied. There are no errors or warnings associated with a\n language mismatch.
\nNote that if you include VocabularyFilterName in your request, you must\n also include VocabularyFilterMethod.
The name of the custom vocabulary filter you want to use when processing your\n transcription job. Custom vocabulary filter names are case sensitive.
\nThe language of the specified custom vocabulary filter must match the language code\n that you specify in your transcription request. If the languages don't match, the custom\n vocabulary filter isn't applied. There are no errors or warnings associated with a\n language mismatch.
\nNote that if you include VocabularyFilterName in your request, you must\n also include VocabularyFilterMethod.
The name of the custom language model you want to use when processing your\n transcription job. Note that custom language model names are case sensitive.
\nThe language of the specified custom language model must match the language code that\n you specify in your transcription request. If the languages don't match, the custom\n language model isn't applied. There are no errors or warnings associated with a language\n mismatch.
" + "smithy.api#documentation": "The name of the custom language model you want to use when processing your\n transcription job. Note that custom language model names are case sensitive.
\nThe language of the specified custom language model must match the language code that\n you specify in your transcription request. If the languages don't match, the custom\n language model isn't applied. There are no errors or warnings associated with a language\n mismatch.
" } } }, "traits": { - "smithy.api#documentation": "If using automatic language identification in your request and you want to apply a\n custom language model, a custom vocabulary, or a custom vocabulary filter, include\n LanguageIdSettings with the relevant sub-parameters\n (VocabularyName, LanguageModelName, and\n VocabularyFilterName). Note that multi-language identification\n (IdentifyMultipleLanguages) doesn't support custom language\n models.
\n LanguageIdSettings supports two to five language codes. Each language\n code you include can have an associated custom language model, custom vocabulary, and\n custom vocabulary filter. The language codes that you specify must match the languages\n of the associated custom language models, custom vocabularies, and custom vocabulary\n filters.
It's recommended that you include LanguageOptions when using\n LanguageIdSettings to ensure that the correct language dialect is\n identified. For example, if you specify a custom vocabulary that is in\n en-US but Amazon Transcribe determines that the language spoken in\n your media is en-AU, your custom vocabulary is not\n applied to your transcription. If you include LanguageOptions and include\n en-US as the only English language dialect, your custom vocabulary\n is applied to your transcription.
If you want to include a custom language model with your request but do not want to use automatic language identification, use\n instead the parameter with the\n LanguageModelName sub-parameter. If you want to include a custom\n vocabulary or a custom vocabulary filter (or both) with your request but do not want to use automatic language identification, use\n instead the parameter with the\n VocabularyName or VocabularyFilterName (or both)\n sub-parameter.
If using automatic language identification in your request and you want to apply a\n custom language model, a custom vocabulary, or a custom vocabulary filter, include\n LanguageIdSettings with the relevant sub-parameters\n (VocabularyName, LanguageModelName, and\n VocabularyFilterName). Note that multi-language identification\n (IdentifyMultipleLanguages) doesn't support custom language\n models.
\n LanguageIdSettings supports two to five language codes. Each language\n code you include can have an associated custom language model, custom vocabulary, and\n custom vocabulary filter. The language codes that you specify must match the languages\n of the associated custom language models, custom vocabularies, and custom vocabulary\n filters.
It's recommended that you include LanguageOptions when using\n LanguageIdSettings to ensure that the correct language dialect is\n identified. For example, if you specify a custom vocabulary that is in\n en-US but Amazon Transcribe determines that the language spoken in\n your media is en-AU, your custom vocabulary is not\n applied to your transcription. If you include LanguageOptions and include\n en-US as the only English language dialect, your custom vocabulary\n is applied to your transcription.
If you want to include a custom language model with your request but do not want to use automatic language identification, use\n instead the parameter with the\n LanguageModelName sub-parameter. If you want to include a custom\n vocabulary or a custom vocabulary filter (or both) with your request but do not want to use automatic language identification, use\n instead the parameter with the\n VocabularyName or VocabularyFilterName (or both)\n sub-parameter.
A unique name, chosen by you, for your custom language model.
\nThis name is case sensitive, cannot contain spaces, and must be unique within an\n Amazon Web Services account.
" + "smithy.api#documentation": "A unique name, chosen by you, for your custom language model.
\nThis name is case sensitive, cannot contain spaces, and must be unique within an\n Amazon Web Services account.
" } }, "CreateTime": { "target": "com.amazonaws.transcribe#DateTime", "traits": { - "smithy.api#documentation": "The date and time the specified custom language model was created.
\nTimestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May\n 4, 2022.
The date and time the specified custom language model was created.
\nTimestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May\n 4, 2022.
The date and time the specified custom language model was last modified.
\nTimestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May\n 4, 2022.
The date and time the specified custom language model was last modified.
\nTimestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May\n 4, 2022.
The language code used to create your custom language model. Each custom language\n model must contain terms in only one language, and the language you select for your\n custom language model must match the language of your training and tuning data.
\nFor a list of supported languages and their associated language codes, refer to the\n Supported languages table. Note that U.S. English (en-US) is\n the only language supported with Amazon Transcribe Medical.
The language code used to create your custom language model. Each custom language\n model must contain terms in only one language, and the language you select for your\n custom language model must match the language of your training and tuning data.
\nFor a list of supported languages and their associated language codes, refer to the\n Supported languages table. Note that U.S. English (en-US) is\n the only language supported with Amazon Transcribe Medical.
Shows if a more current base model is available for use with the specified custom\n language model.
\nIf false, your custom language model is using the most up-to-date base\n model.
If true, there is a newer base model available than the one your language\n model is using.
Note that to update a base model, you must recreate the custom language model using\n the new base model. Base model upgrades for existing custom language models are not\n supported.
" + "smithy.api#documentation": "Shows if a more current base model is available for use with the specified custom\n language model.
\nIf false, your custom language model is using the most up-to-date base\n model.
If true, there is a newer base model available than the one your language\n model is using.
Note that to update a base model, you must recreate the custom language model using\n the new base model. Base model upgrades for existing custom language models are not\n supported.
" } }, "FailureReason": { @@ -2414,7 +2426,7 @@ } ], "traits": { - "smithy.api#documentation": "Provides a list of Call Analytics categories, including all rules that make up each\n category.
\nTo get detailed information about a specific Call Analytics category, use the operation.
", + "smithy.api#documentation": "Provides a list of Call Analytics categories, including all rules that make up each\n category.
\nTo get detailed information about a specific Call Analytics category, use the operation.
", "smithy.api#http": { "method": "GET", "uri": "/callanalyticscategories", @@ -2483,7 +2495,7 @@ } ], "traits": { - "smithy.api#documentation": "Provides a list of Call Analytics jobs that match the specified criteria. If no\n criteria are specified, all Call Analytics jobs are returned.
\nTo get detailed information about a specific Call Analytics job, use the operation.
", + "smithy.api#documentation": "Provides a list of Call Analytics jobs that match the specified criteria. If no\n criteria are specified, all Call Analytics jobs are returned.
\nTo get detailed information about a specific Call Analytics job, use the operation.
", "smithy.api#http": { "method": "GET", "uri": "/callanalyticsjobs", @@ -2572,7 +2584,7 @@ } ], "traits": { - "smithy.api#documentation": "Provides a list of custom language models that match the specified criteria. If no\n criteria are specified, all custom language models are returned.
\nTo get detailed information about a specific custom language model, use the operation.
", + "smithy.api#documentation": "Provides a list of custom language models that match the specified criteria. If no\n criteria are specified, all custom language models are returned.
\nTo get detailed information about a specific custom language model, use the operation.
", "smithy.api#http": { "method": "GET", "uri": "/languagemodels", @@ -2655,7 +2667,7 @@ } ], "traits": { - "smithy.api#documentation": "Provides a list of medical transcription jobs that match the specified criteria. If no\n criteria are specified, all medical transcription jobs are returned.
\nTo get detailed information about a specific medical transcription job, use the operation.
", + "smithy.api#documentation": "Provides a list of medical transcription jobs that match the specified criteria. If no\n criteria are specified, all medical transcription jobs are returned.
\nTo get detailed information about a specific medical transcription job, use the operation.
", "smithy.api#http": { "method": "GET", "uri": "/medicaltranscriptionjobs", @@ -2744,7 +2756,7 @@ } ], "traits": { - "smithy.api#documentation": "Provides a list of custom medical vocabularies that match the specified criteria. If\n no criteria are specified, all custom medical vocabularies are returned.
\nTo get detailed information about a specific custom medical vocabulary, use the operation.
", + "smithy.api#documentation": "Provides a list of custom medical vocabularies that match the specified criteria. If\n no criteria are specified, all custom medical vocabularies are returned.
\nTo get detailed information about a specific custom medical vocabulary, use the operation.
", "smithy.api#http": { "method": "GET", "uri": "/medicalvocabularies", @@ -2836,7 +2848,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists all tags associated with the specified transcription job, vocabulary, model, or\n resource.
\nTo learn more about using tags with Amazon Transcribe, refer to Tagging\n resources.
", + "smithy.api#documentation": "Lists all tags associated with the specified transcription job, vocabulary, model, or\n resource.
\nTo learn more about using tags with Amazon Transcribe, refer to Tagging\n resources.
", "smithy.api#http": { "method": "GET", "uri": "/tags/{ResourceArn}", @@ -2850,7 +2862,7 @@ "ResourceArn": { "target": "com.amazonaws.transcribe#TranscribeArn", "traits": { - "smithy.api#documentation": "Returns a list of all tags associated with the specified Amazon Resource Name (ARN).\n ARNs have the format\n arn:partition:service:region:account-id:resource-type/resource-id.
For example,\n arn:aws:transcribe:us-west-2:111122223333:transcription-job/transcription-job-name.
Valid values for resource-type are: transcription-job,\n medical-transcription-job, vocabulary,\n medical-vocabulary, vocabulary-filter, and\n language-model.
Returns a list of all tags associated with the specified Amazon Resource Name (ARN).\n ARNs have the format\n arn:partition:service:region:account-id:resource-type/resource-id.
For example,\n arn:aws:transcribe:us-west-2:111122223333:transcription-job/transcription-job-name.
Valid values for resource-type are: transcription-job,\n medical-transcription-job, vocabulary,\n medical-vocabulary, vocabulary-filter, and\n language-model.
Provides a list of transcription jobs that match the specified criteria. If no\n criteria are specified, all transcription jobs are returned.
\nTo get detailed information about a specific transcription job, use the operation.
", + "smithy.api#documentation": "Provides a list of transcription jobs that match the specified criteria. If no\n criteria are specified, all transcription jobs are returned.
\nTo get detailed information about a specific transcription job, use the operation.
", "smithy.api#http": { "method": "GET", "uri": "/transcriptionjobs", @@ -2983,7 +2995,7 @@ } ], "traits": { - "smithy.api#documentation": "Provides a list of custom vocabularies that match the specified criteria. If no\n criteria are specified, all custom vocabularies are returned.
\nTo get detailed information about a specific custom vocabulary, use the operation.
", + "smithy.api#documentation": "Provides a list of custom vocabularies that match the specified criteria. If no\n criteria are specified, all custom vocabularies are returned.
\nTo get detailed information about a specific custom vocabulary, use the operation.
", "smithy.api#http": { "method": "GET", "uri": "/vocabularies", @@ -3072,7 +3084,7 @@ } ], "traits": { - "smithy.api#documentation": "Provides a list of custom vocabulary filters that match the specified criteria. If no\n criteria are specified, all custom vocabularies are returned.
\nTo get detailed information about a specific custom vocabulary filter, use the operation.
", + "smithy.api#documentation": "Provides a list of custom vocabulary filters that match the specified criteria. If no\n criteria are specified, all custom vocabularies are returned.
\nTo get detailed information about a specific custom vocabulary filter, use the operation.
", "smithy.api#http": { "method": "GET", "uri": "/vocabularyFilters", @@ -3161,18 +3173,18 @@ "MediaFileUri": { "target": "com.amazonaws.transcribe#Uri", "traits": { - "smithy.api#documentation": "The Amazon S3 location of the media file you want to transcribe. For\n example:
\n\n s3://DOC-EXAMPLE-BUCKET/my-media-file.flac\n
\n s3://DOC-EXAMPLE-BUCKET/media-files/my-media-file.flac\n
Note that the Amazon S3 bucket that contains your input media must be located\n in the same Amazon Web Services Region where you're making your transcription\n request.
" + "smithy.api#documentation": "The Amazon S3 location of the media file you want to transcribe. For\n example:
\n\n s3://DOC-EXAMPLE-BUCKET/my-media-file.flac\n
\n s3://DOC-EXAMPLE-BUCKET/media-files/my-media-file.flac\n
Note that the Amazon S3 bucket that contains your input media must be located\n in the same Amazon Web Services Region where you're making your transcription\n request.
" } }, "RedactedMediaFileUri": { "target": "com.amazonaws.transcribe#Uri", "traits": { - "smithy.api#documentation": "The Amazon S3 location of the media file you want to redact. For\n example:
\n\n s3://DOC-EXAMPLE-BUCKET/my-media-file.flac\n
\n s3://DOC-EXAMPLE-BUCKET/media-files/my-media-file.flac\n
Note that the Amazon S3 bucket that contains your input media must be located\n in the same Amazon Web Services Region where you're making your transcription\n request.
\n\n RedactedMediaFileUri produces a redacted audio file in addition to a \n redacted transcript. It is only supported for Call Analytics\n (StartCallAnalyticsJob) transcription requests.
The Amazon S3 location of the media file you want to redact. For\n example:
\n\n s3://DOC-EXAMPLE-BUCKET/my-media-file.flac\n
\n s3://DOC-EXAMPLE-BUCKET/media-files/my-media-file.flac\n
Note that the Amazon S3 bucket that contains your input media must be located\n in the same Amazon Web Services Region where you're making your transcription\n request.
\n\n RedactedMediaFileUri produces a redacted audio file in addition to a \n redacted transcript. It is only supported for Call Analytics\n (StartCallAnalyticsJob) transcription requests.
Describes the Amazon S3 location of the media file you want to use in your\n request.
\nFor information on supported media formats, refer to the MediaFormat parameter or the Media formats section \n in the Amazon S3 Developer Guide.
" + "smithy.api#documentation": "Describes the Amazon S3 location of the media file you want to use in your\n request.
\nFor information on supported media formats, refer to the MediaFormat parameter or the Media formats section \n in the Amazon S3 Developer Guide.
" } }, "com.amazonaws.transcribe#MediaFormat": { @@ -3257,7 +3269,7 @@ "TranscriptFileUri": { "target": "com.amazonaws.transcribe#Uri", "traits": { - "smithy.api#documentation": "The Amazon S3 location of your transcript. You can use this URI to access or\n download your transcript.
\nNote that this is the Amazon S3 location you specified in your request using the \n OutputBucketName parameter.
The Amazon S3 location of your transcript. You can use this URI to access or\n download your transcript.
\nNote that this is the Amazon S3 location you specified in your request using the \n OutputBucketName parameter.
Provides the status of the specified medical transcription job.
\nIf the status is COMPLETED, the job is finished and you can find the\n results at the location specified in TranscriptFileUri. If the status is\n FAILED, FailureReason provides details on why your\n transcription job failed.
Provides the status of the specified medical transcription job.
\nIf the status is COMPLETED, the job is finished and you can find the\n results at the location specified in TranscriptFileUri. If the status is\n FAILED, FailureReason provides details on why your\n transcription job failed.
The date and time the specified medical transcription job began processing.
\nTimestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.789000-07:00 represents a transcription job\n that started processing at 12:32 PM UTC-7 on May 4, 2022.
The date and time the specified medical transcription job began processing.
\nTimestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.789000-07:00 represents a transcription job\n that started processing at 12:32 PM UTC-7 on May 4, 2022.
The date and time the specified medical transcription job request was made.
\nTimestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.761000-07:00 represents a transcription job\n that started processing at 12:32 PM UTC-7 on May 4, 2022.
The date and time the specified medical transcription job request was made.
\nTimestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.761000-07:00 represents a transcription job\n that started processing at 12:32 PM UTC-7 on May 4, 2022.
The date and time the specified medical transcription job finished processing.
\nTimestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:33:13.922000-07:00 represents a transcription job\n that started processing at 12:33 PM UTC-7 on May 4, 2022.
The date and time the specified medical transcription job finished processing.
\nTimestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:33:13.922000-07:00 represents a transcription job\n that started processing at 12:33 PM UTC-7 on May 4, 2022.
If TranscriptionJobStatus is FAILED,\n FailureReason contains information about why the transcription job\n request failed.
The FailureReason field contains one of the following values:
\n Unsupported media format.
The media format specified in MediaFormat isn't valid. Refer to\n MediaFormat for a list of supported\n formats.
\n The media format provided does not match the detected media\n format.
The media format specified in MediaFormat doesn't match the\n format of the input file. Check the media format of your media file and correct\n the specified value.
\n Invalid sample rate for audio file.
The sample rate specified in MediaSampleRateHertz isn't valid.\n The sample rate must be between 16,000 and 48,000 hertz.
\n The sample rate provided does not match the detected sample\n rate.
The sample rate specified in MediaSampleRateHertz doesn't match\n the sample rate detected in your input media file. Check the sample rate of your\n media file and correct the specified value.
\n Invalid file size: file size too large.
The size of your media file is larger than what Amazon Transcribe can\n process. For more information, refer to Guidelines and\n quotas.
\n\n Invalid number of channels: number of channels too large.
Your audio contains more channels than Amazon Transcribe is able to process.\n For more information, refer to Guidelines and\n quotas.
\nIf TranscriptionJobStatus is FAILED,\n FailureReason contains information about why the transcription job\n request failed.
The FailureReason field contains one of the following values:
\n Unsupported media format.
The media format specified in MediaFormat isn't valid. Refer to\n MediaFormat for a list of supported\n formats.
\n The media format provided does not match the detected media\n format.
The media format specified in MediaFormat doesn't match the\n format of the input file. Check the media format of your media file and correct\n the specified value.
\n Invalid sample rate for audio file.
The sample rate specified in MediaSampleRateHertz isn't valid.\n The sample rate must be between 16,000 and 48,000 hertz.
\n The sample rate provided does not match the detected sample\n rate.
The sample rate specified in MediaSampleRateHertz doesn't match\n the sample rate detected in your input media file. Check the sample rate of your\n media file and correct the specified value.
\n Invalid file size: file size too large.
The size of your media file is larger than what Amazon Transcribe can\n process. For more information, refer to Guidelines and\n quotas.
\n\n Invalid number of channels: number of channels too large.
Your audio contains more channels than Amazon Transcribe is able to process.\n For more information, refer to Guidelines and\n quotas.
\nProvides detailed information about a medical transcription job.
\nTo view the status of the specified medical transcription job, check the\n TranscriptionJobStatus field. If the status is COMPLETED,\n the job is finished and you can find the results at the location specified in\n TranscriptFileUri. If the status is FAILED,\n FailureReason provides details on why your transcription job\n failed.
Provides detailed information about a medical transcription job.
\nTo view the status of the specified medical transcription job, check the\n TranscriptionJobStatus field. If the status is COMPLETED,\n the job is finished and you can find the results at the location specified in\n TranscriptFileUri. If the status is FAILED,\n FailureReason provides details on why your transcription job\n failed.
The date and time the specified medical transcription job request was made.
\nTimestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.761000-07:00 represents a transcription job\n that started processing at 12:32 PM UTC-7 on May 4, 2022.
The date and time the specified medical transcription job request was made.
\nTimestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.761000-07:00 represents a transcription job\n that started processing at 12:32 PM UTC-7 on May 4, 2022.
The date and time your medical transcription job began processing.
\nTimestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.789000-07:00 represents a transcription job\n that started processing at 12:32 PM UTC-7 on May 4, 2022.
The date and time your medical transcription job began processing.
\nTimestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.789000-07:00 represents a transcription job\n that started processing at 12:32 PM UTC-7 on May 4, 2022.
The date and time the specified medical transcription job finished processing.
\nTimestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:33:13.922000-07:00 represents a transcription job\n that started processing at 12:33 PM UTC-7 on May 4, 2022.
The date and time the specified medical transcription job finished processing.
\nTimestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:33:13.922000-07:00 represents a transcription job\n that started processing at 12:33 PM UTC-7 on May 4, 2022.
Provides the status of your medical transcription job.
\nIf the status is COMPLETED, the job is finished and you can find the\n results at the location specified in TranscriptFileUri. If the status is\n FAILED, FailureReason provides details on why your\n transcription job failed.
Provides the status of your medical transcription job.
\nIf the status is COMPLETED, the job is finished and you can find the\n results at the location specified in TranscriptFileUri. If the status is\n FAILED, FailureReason provides details on why your\n transcription job failed.
Indicates where the specified medical transcription output is stored.
\nIf the value is CUSTOMER_BUCKET, the location is the Amazon S3\n bucket you specified using the OutputBucketName parameter in your request. If you also included\n OutputKey in your request, your output is located in the path you\n specified in your request.
If the value is SERVICE_BUCKET, the location is a service-managed Amazon S3 bucket. To access a transcript stored in a service-managed bucket, use the\n URI shown in the TranscriptFileUri field.
Indicates where the specified medical transcription output is stored.
\nIf the value is CUSTOMER_BUCKET, the location is the Amazon S3\n bucket you specified using the OutputBucketName parameter in your request. If you also included\n OutputKey in your request, your output is located in the path you\n specified in your request.
If the value is SERVICE_BUCKET, the location is a service-managed Amazon S3 bucket. To access a transcript stored in a service-managed bucket, use the\n URI shown in the TranscriptFileUri field.
Enables speaker partitioning (diarization) in your transcription output. Speaker\n partitioning labels the speech from individual speakers in your media file.
\nIf you enable ShowSpeakerLabels in your request, you must also include\n MaxSpeakerLabels.
You can't include ShowSpeakerLabels and\n ChannelIdentification in the same request. Including both parameters\n returns a BadRequestException.
For more information, see Partitioning speakers\n (diarization).
" + "smithy.api#documentation": "Enables speaker partitioning (diarization) in your transcription output. Speaker\n partitioning labels the speech from individual speakers in your media file.
\nIf you enable ShowSpeakerLabels in your request, you must also include\n MaxSpeakerLabels.
You can't include ShowSpeakerLabels and\n ChannelIdentification in the same request. Including both parameters\n returns a BadRequestException.
For more information, see Partitioning speakers\n (diarization).
" } }, "MaxSpeakerLabels": { "target": "com.amazonaws.transcribe#MaxSpeakers", "traits": { - "smithy.api#documentation": "Specify the maximum number of speakers you want to partition in your media.
\nNote that if your media contains more speakers than the specified number, multiple\n speakers are treated as a single speaker.
\nIf you specify the MaxSpeakerLabels field, you must set the\n ShowSpeakerLabels field to true.
Specify the maximum number of speakers you want to partition in your media.
\nNote that if your media contains more speakers than the specified number, multiple\n speakers are treated as a single speaker.
\nIf you specify the MaxSpeakerLabels field, you must set the\n ShowSpeakerLabels field to true.
Enables channel identification in multi-channel audio.
\nChannel identification transcribes the audio on each channel independently, then\n appends the output for each channel into one transcript.
\nIf you have multi-channel audio and do not enable channel identification, your audio\n is transcribed in a continuous manner and your transcript does not separate the speech\n by channel.
\nYou can't include both ShowSpeakerLabels and\n ChannelIdentification in the same request. Including both parameters\n returns a BadRequestException.
For more information, see Transcribing multi-channel\n audio.
" + "smithy.api#documentation": "Enables channel identification in multi-channel audio.
\nChannel identification transcribes the audio on each channel independently, then\n appends the output for each channel into one transcript.
\nIf you have multi-channel audio and do not enable channel identification, your audio\n is transcribed in a continuous manner and your transcript does not separate the speech\n by channel.
\nYou can't include both ShowSpeakerLabels and\n ChannelIdentification in the same request. Including both parameters\n returns a BadRequestException.
For more information, see Transcribing multi-channel\n audio.
" } }, "ShowAlternatives": { "target": "com.amazonaws.transcribe#Boolean", "traits": { - "smithy.api#documentation": "To include alternative transcriptions within your transcription output, include\n ShowAlternatives in your transcription request.
If you include ShowAlternatives, you must also include\n MaxAlternatives, which is the maximum number of alternative\n transcriptions you want Amazon Transcribe Medical to generate.
For more information, see Alternative\n transcriptions.
" + "smithy.api#documentation": "To include alternative transcriptions within your transcription output, include\n ShowAlternatives in your transcription request.
If you include ShowAlternatives, you must also include\n MaxAlternatives, which is the maximum number of alternative\n transcriptions you want Amazon Transcribe Medical to generate.
For more information, see Alternative\n transcriptions.
" } }, "MaxAlternatives": { "target": "com.amazonaws.transcribe#MaxAlternatives", "traits": { - "smithy.api#documentation": "Indicate the maximum number of alternative transcriptions you want Amazon Transcribe\n Medical to include in your transcript.
\nIf you select a number greater than the number of alternative transcriptions generated\n by Amazon Transcribe Medical, only the actual number of alternative transcriptions are\n included.
\nIf you include MaxAlternatives in your request, you must also include\n ShowAlternatives with a value of true.
For more information, see Alternative\n transcriptions.
" + "smithy.api#documentation": "Indicate the maximum number of alternative transcriptions you want Amazon Transcribe\n Medical to include in your transcript.
\nIf you select a number greater than the number of alternative transcriptions generated\n by Amazon Transcribe Medical, only the actual number of alternative transcriptions are\n included.
\nIf you include MaxAlternatives in your request, you must also include\n ShowAlternatives with a value of true.
For more information, see Alternative\n transcriptions.
" } }, "VocabularyName": { "target": "com.amazonaws.transcribe#VocabularyName", "traits": { - "smithy.api#documentation": "The name of the custom vocabulary you want to use when processing your medical\n transcription job. Custom vocabulary names are case sensitive.
\nThe language of the specified custom vocabulary must match the language code that you\n specify in your transcription request. If the languages don't match, the custom\n vocabulary isn't applied. There are no errors or warnings associated with a language\n mismatch. US English (en-US) is the only valid language for Amazon Transcribe Medical.
The name of the custom vocabulary you want to use when processing your medical\n transcription job. Custom vocabulary names are case sensitive.
\nThe language of the specified custom vocabulary must match the language code that you\n specify in your transcription request. If the languages don't match, the custom\n vocabulary isn't applied. There are no errors or warnings associated with a language\n mismatch. US English (en-US) is the only valid language for Amazon Transcribe Medical.
The name of the custom language model you want to use when processing your\n transcription job. Note that custom language model names are case sensitive.
\nThe language of the specified custom language model must match the language code that\n you specify in your transcription request. If the languages don't match, the custom\n language model isn't applied. There are no errors or warnings associated with a language\n mismatch.
" + "smithy.api#documentation": "The name of the custom language model you want to use when processing your\n transcription job. Note that custom language model names are case sensitive.
\nThe language of the specified custom language model must match the language code that\n you specify in your transcription request. If the languages don't match, the custom\n language model isn't applied. There are no errors or warnings associated with a language\n mismatch.
" } } }, "traits": { - "smithy.api#documentation": "Provides the name of the custom language model that was included in the specified\n transcription job.
\nOnly use ModelSettings with the LanguageModelName\n sub-parameter if you're not using automatic language\n identification (). If using\n LanguageIdSettings in your request, this parameter contains a\n LanguageModelName sub-parameter.
Provides the name of the custom language model that was included in the specified\n transcription job.
\nOnly use ModelSettings with the LanguageModelName\n sub-parameter if you're not using automatic language\n identification (). If using\n LanguageIdSettings in your request, this parameter contains a\n LanguageModelName sub-parameter.
Flag the presence or absence of periods of silence in your Call Analytics\n transcription output.
\nRules using NonTalkTimeFilter are designed to match:
The presence of silence at specified periods throughout the call
\nThe presence of speech at specified periods throughout the call
\nSee Rule criteria for batch \n categories for usage examples.
" + "smithy.api#documentation": "Flag the presence or absence of periods of silence in your Call Analytics\n transcription output.
\nRules using NonTalkTimeFilter are designed to match:
The presence of silence at specified periods throughout the call
\nThe presence of speech at specified periods throughout the call
\nSee Rule criteria for batch \n categories for usage examples.
" } }, "com.amazonaws.transcribe#NotFoundException": { @@ -3833,7 +3845,7 @@ } }, "traits": { - "smithy.api#documentation": "A time range, in percentage, between two points in your media file.
\nYou can use StartPercentage and EndPercentage to search a\n custom segment. For example, setting StartPercentage to 10 and\n EndPercentage to 50 only searches for your specified criteria in the\n audio contained between the 10 percent mark and the 50 percent mark of your media\n file.
You can use also First to search from the start of the media file until\n the time that you specify. Or use Last to search from the time that you\n specify until the end of the media file. For example, setting First to 10\n only searches for your specified criteria in the audio contained in the first 10 percent\n of the media file.
If you prefer to use milliseconds instead of percentage, see .
" + "smithy.api#documentation": "A time range, in percentage, between two points in your media file.
\nYou can use StartPercentage and EndPercentage to search a\n custom segment. For example, setting StartPercentage to 10 and\n EndPercentage to 50 only searches for your specified criteria in the\n audio contained between the 10 percent mark and the 50 percent mark of your media\n file.
You can use also First to search from the start of the media file until\n the time that you specify. Or use Last to search from the time that you\n specify until the end of the media file. For example, setting First to 10\n only searches for your specified criteria in the audio contained in the first 10 percent\n of the media file.
If you prefer to use milliseconds instead of percentage, see .
" } }, "com.amazonaws.transcribe#Rule": { @@ -3865,7 +3877,7 @@ } }, "traits": { - "smithy.api#documentation": "A rule is a set of criteria that you can specify to flag an attribute in your Call\n Analytics output. Rules define a Call Analytics category.
\nRules can include these parameters: , , , and .
\nTo learn more about Call Analytics rules and categories, see Creating categories for batch\n transcriptions and Creating categories for\n streaming transcriptions.
\nTo learn more about Call Analytics, see Analyzing call center audio with Call\n Analytics.
" + "smithy.api#documentation": "A rule is a set of criteria that you can specify to flag an attribute in your Call\n Analytics output. Rules define a Call Analytics category.
\nRules can include these parameters: , , , and .
\nTo learn more about Call Analytics rules and categories, see Creating categories for batch\n transcriptions and Creating categories for\n streaming transcriptions.
\nTo learn more about Call Analytics, see Analyzing call center audio with Call\n Analytics.
" } }, "com.amazonaws.transcribe#RuleList": { @@ -3916,7 +3928,7 @@ } }, "traits": { - "smithy.api#documentation": "Flag the presence or absence of specific sentiments detected in your Call Analytics\n transcription output.
\nRules using SentimentFilter are designed to match:
The presence or absence of a positive sentiment felt by the customer, agent,\n or both at specified points in the call
\nThe presence or absence of a negative sentiment felt by the customer, agent,\n or both at specified points in the call
\nThe presence or absence of a neutral sentiment felt by the customer, agent, or\n both at specified points in the call
\nThe presence or absence of a mixed sentiment felt by the customer, the agent,\n or both at specified points in the call
\nSee Rule criteria for batch \n categories for usage examples.
" + "smithy.api#documentation": "Flag the presence or absence of specific sentiments detected in your Call Analytics\n transcription output.
\nRules using SentimentFilter are designed to match:
The presence or absence of a positive sentiment felt by the customer, agent,\n or both at specified points in the call
\nThe presence or absence of a negative sentiment felt by the customer, agent,\n or both at specified points in the call
\nThe presence or absence of a neutral sentiment felt by the customer, agent, or\n both at specified points in the call
\nThe presence or absence of a mixed sentiment felt by the customer, the agent,\n or both at specified points in the call
\nSee Rule criteria for batch \n categories for usage examples.
" } }, "com.amazonaws.transcribe#SentimentValue": { @@ -3972,43 +3984,43 @@ "ShowSpeakerLabels": { "target": "com.amazonaws.transcribe#Boolean", "traits": { - "smithy.api#documentation": "Enables speaker partitioning (diarization) in your transcription output. Speaker\n partitioning labels the speech from individual speakers in your media file.
\nIf you enable ShowSpeakerLabels in your request, you must also include\n MaxSpeakerLabels.
You can't include both ShowSpeakerLabels and\n ChannelIdentification in the same request. Including both parameters\n returns a BadRequestException.
For more information, see Partitioning speakers\n (diarization).
" + "smithy.api#documentation": "Enables speaker partitioning (diarization) in your transcription output. Speaker\n partitioning labels the speech from individual speakers in your media file.
\nIf you enable ShowSpeakerLabels in your request, you must also include\n MaxSpeakerLabels.
You can't include both ShowSpeakerLabels and\n ChannelIdentification in the same request. Including both parameters\n returns a BadRequestException.
For more information, see Partitioning speakers\n (diarization).
" } }, "MaxSpeakerLabels": { "target": "com.amazonaws.transcribe#MaxSpeakers", "traits": { - "smithy.api#documentation": "Specify the maximum number of speakers you want to partition in your media.
\nNote that if your media contains more speakers than the specified number, multiple\n speakers are treated as a single speaker.
\nIf you specify the MaxSpeakerLabels field, you must set the\n ShowSpeakerLabels field to true.
Specify the maximum number of speakers you want to partition in your media.
\nNote that if your media contains more speakers than the specified number, multiple\n speakers are treated as a single speaker.
\nIf you specify the MaxSpeakerLabels field, you must set the\n ShowSpeakerLabels field to true.
Enables channel identification in multi-channel audio.
\nChannel identification transcribes the audio on each channel independently, then\n appends the output for each channel into one transcript.
\nYou can't include both ShowSpeakerLabels and\n ChannelIdentification in the same request. Including both parameters\n returns a BadRequestException.
For more information, see Transcribing multi-channel\n audio.
" + "smithy.api#documentation": "Enables channel identification in multi-channel audio.
\nChannel identification transcribes the audio on each channel independently, then\n appends the output for each channel into one transcript.
\nYou can't include both ShowSpeakerLabels and\n ChannelIdentification in the same request. Including both parameters\n returns a BadRequestException.
For more information, see Transcribing multi-channel\n audio.
" } }, "ShowAlternatives": { "target": "com.amazonaws.transcribe#Boolean", "traits": { - "smithy.api#documentation": "To include alternative transcriptions within your transcription output, include\n ShowAlternatives in your transcription request.
If you have multi-channel audio and do not enable channel identification, your audio\n is transcribed in a continuous manner and your transcript does not separate the speech\n by channel.
\nIf you include ShowAlternatives, you must also include\n MaxAlternatives, which is the maximum number of alternative\n transcriptions you want Amazon Transcribe to generate.
For more information, see Alternative\n transcriptions.
" + "smithy.api#documentation": "To include alternative transcriptions within your transcription output, include\n ShowAlternatives in your transcription request.
If you have multi-channel audio and do not enable channel identification, your audio\n is transcribed in a continuous manner and your transcript does not separate the speech\n by channel.
\nIf you include ShowAlternatives, you must also include\n MaxAlternatives, which is the maximum number of alternative\n transcriptions you want Amazon Transcribe to generate.
For more information, see Alternative\n transcriptions.
" } }, "MaxAlternatives": { "target": "com.amazonaws.transcribe#MaxAlternatives", "traits": { - "smithy.api#documentation": "Indicate the maximum number of alternative transcriptions you want Amazon Transcribe\n to include in your transcript.
\nIf you select a number greater than the number of alternative transcriptions generated\n by Amazon Transcribe, only the actual number of alternative transcriptions are\n included.
\nIf you include MaxAlternatives in your request, you must also include\n ShowAlternatives with a value of true.
For more information, see Alternative\n transcriptions.
" + "smithy.api#documentation": "Indicate the maximum number of alternative transcriptions you want Amazon Transcribe\n to include in your transcript.
\nIf you select a number greater than the number of alternative transcriptions generated\n by Amazon Transcribe, only the actual number of alternative transcriptions are\n included.
\nIf you include MaxAlternatives in your request, you must also include\n ShowAlternatives with a value of true.
For more information, see Alternative\n transcriptions.
" } }, "VocabularyFilterName": { "target": "com.amazonaws.transcribe#VocabularyFilterName", "traits": { - "smithy.api#documentation": "The name of the custom vocabulary filter you want to use in your transcription job\n request. This name is case sensitive, cannot contain spaces, and must be unique within\n an Amazon Web Services account.
\nNote that if you include VocabularyFilterName in your request, you must\n also include VocabularyFilterMethod.
The name of the custom vocabulary filter you want to use in your transcription job\n request. This name is case sensitive, cannot contain spaces, and must be unique within\n an Amazon Web Services account.
\nNote that if you include VocabularyFilterName in your request, you must\n also include VocabularyFilterMethod.
Specify how you want your custom vocabulary filter applied to your transcript.
\nTo replace words with ***, choose mask.
To delete words, choose remove.
To flag words without changing them, choose tag.
Specify how you want your custom vocabulary filter applied to your transcript.
\nTo replace words with ***, choose mask.
To delete words, choose remove.
To flag words without changing them, choose tag.
Transcribes the audio from a customer service call and applies any additional Request\n Parameters you choose to include in your request.
\nIn addition to many standard transcription features, Call Analytics provides you with\n call characteristics, call summarization, speaker sentiment, and optional redaction of\n your text transcript and your audio file. You can also apply custom categories to flag\n specified conditions. To learn more about these features and insights, refer to Analyzing call\n center audio with Call Analytics.
\nIf you want to apply categories to your Call Analytics job, you must create them\n before submitting your job request. Categories cannot be retroactively applied to a job.\n To create a new category, use the \n operation. To learn more about Call Analytics categories, see Creating categories for batch \n transcriptions and Creating categories for \n streaming transcriptions.
\nTo make a StartCallAnalyticsJob request, you must first upload your media\n file into an Amazon S3 bucket; you can then specify the Amazon S3\n location of the file using the Media parameter.
You must include the following parameters in your StartCallAnalyticsJob\n request:
\n region: The Amazon Web Services Region where you are making your\n request. For a list of Amazon Web Services Regions supported with Amazon Transcribe, refer to Amazon Transcribe endpoints and\n quotas.
\n CallAnalyticsJobName: A custom name that you create for your\n transcription job that's unique within your Amazon Web Services account.
\n DataAccessRoleArn: The Amazon Resource Name (ARN) of an IAM role\n that has permissions to access the Amazon S3 bucket that contains your\n input files.
\n Media (MediaFileUri or\n RedactedMediaFileUri): The Amazon S3 location of your\n media file.
With Call Analytics, you can redact the audio contained in your media file by\n including RedactedMediaFileUri, instead of MediaFileUri,\n to specify the location of your input audio. If you choose to redact your audio, you\n can find your redacted media at the location specified in the\n RedactedMediaFileUri field of your response.
Transcribes the audio from a customer service call and applies any additional Request\n Parameters you choose to include in your request.
\nIn addition to many standard transcription features, Call Analytics provides you with\n call characteristics, call summarization, speaker sentiment, and optional redaction of\n your text transcript and your audio file. You can also apply custom categories to flag\n specified conditions. To learn more about these features and insights, refer to Analyzing call\n center audio with Call Analytics.
\nIf you want to apply categories to your Call Analytics job, you must create them\n before submitting your job request. Categories cannot be retroactively applied to a job.\n To create a new category, use the \n operation. To learn more about Call Analytics categories, see Creating categories for batch \n transcriptions and Creating categories for \n streaming transcriptions.
\nTo make a StartCallAnalyticsJob request, you must first upload your media\n file into an Amazon S3 bucket; you can then specify the Amazon S3\n location of the file using the Media parameter.
You must include the following parameters in your StartCallAnalyticsJob\n request:
\n region: The Amazon Web Services Region where you are making your\n request. For a list of Amazon Web Services Regions supported with Amazon Transcribe, refer to Amazon Transcribe endpoints and\n quotas.
\n CallAnalyticsJobName: A custom name that you create for your\n transcription job that's unique within your Amazon Web Services account.
\n DataAccessRoleArn: The Amazon Resource Name (ARN) of an IAM role\n that has permissions to access the Amazon S3 bucket that contains your\n input files.
\n Media (MediaFileUri or\n RedactedMediaFileUri): The Amazon S3 location of your\n media file.
With Call Analytics, you can redact the audio contained in your media file by\n including RedactedMediaFileUri, instead of MediaFileUri,\n to specify the location of your input audio. If you choose to redact your audio, you\n can find your redacted media at the location specified in the\n RedactedMediaFileUri field of your response.
A unique name, chosen by you, for your Call Analytics job.
\nThis name is case sensitive, cannot contain spaces, and must be unique within an\n Amazon Web Services account. If you try to create a new job with the same name as an\n existing job, you get a ConflictException error.
A unique name, chosen by you, for your Call Analytics job.
\nThis name is case sensitive, cannot contain spaces, and must be unique within an\n Amazon Web Services account. If you try to create a new job with the same name as an\n existing job, you get a ConflictException error.
The Amazon S3 location where you want your Call Analytics transcription output\n stored. You can use any of the following formats to specify the output location:
\ns3://DOC-EXAMPLE-BUCKET
\ns3://DOC-EXAMPLE-BUCKET/my-output-folder/
\ns3://DOC-EXAMPLE-BUCKET/my-output-folder/my-call-analytics-job.json
\nUnless you specify a file name (option 3), the name of your output file has a default\n value that matches the name you specified for your transcription job using the\n CallAnalyticsJobName parameter.
You can specify a KMS key to encrypt your output using the\n OutputEncryptionKMSKeyId parameter. If you don't specify a KMS key, Amazon Transcribe uses the default Amazon S3 key for\n server-side encryption.
If you don't specify OutputLocation, your transcript is placed in a\n service-managed Amazon S3 bucket and you are provided with a URI to access your\n transcript.
The Amazon S3 location where you want your Call Analytics transcription output\n stored. You can use any of the following formats to specify the output location:
\ns3://DOC-EXAMPLE-BUCKET
\ns3://DOC-EXAMPLE-BUCKET/my-output-folder/
\ns3://DOC-EXAMPLE-BUCKET/my-output-folder/my-call-analytics-job.json
\nUnless you specify a file name (option 3), the name of your output file has a default\n value that matches the name you specified for your transcription job using the\n CallAnalyticsJobName parameter.
You can specify a KMS key to encrypt your output using the\n OutputEncryptionKMSKeyId parameter. If you don't specify a KMS key, Amazon Transcribe uses the default Amazon S3 key for\n server-side encryption.
If you don't specify OutputLocation, your transcript is placed in a\n service-managed Amazon S3 bucket and you are provided with a URI to access your\n transcript.
The KMS key you want to use to encrypt your Call Analytics\n output.
\nIf using a key located in the current\n Amazon Web Services account, you can specify your KMS key in one of four\n ways:
\nUse the KMS key ID itself. For example,\n 1234abcd-12ab-34cd-56ef-1234567890ab.
Use an alias for the KMS key ID. For example,\n alias/ExampleAlias.
Use the Amazon Resource Name (ARN) for the KMS key ID. For\n example,\n arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.
Use the ARN for the KMS key alias. For example,\n arn:aws:kms:region:account-ID:alias/ExampleAlias.
If using a key located in a different\n Amazon Web Services account than the current Amazon Web Services account, you can specify\n your KMS key in one of two ways:
\nUse the ARN for the KMS key ID. For example,\n arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.
Use the ARN for the KMS key alias. For example,\n arn:aws:kms:region:account-ID:alias/ExampleAlias.
If you don't specify an encryption key, your output is encrypted with the default\n Amazon S3 key (SSE-S3).
\nIf you specify a KMS key to encrypt your output, you must also specify\n an output location using the OutputLocation parameter.
Note that the user making the request must\n have permission to use the specified KMS key.
" + "smithy.api#documentation": "The KMS key you want to use to encrypt your Call Analytics\n output.
\nIf using a key located in the current\n Amazon Web Services account, you can specify your KMS key in one of four\n ways:
\nUse the KMS key ID itself. For example,\n 1234abcd-12ab-34cd-56ef-1234567890ab.
Use an alias for the KMS key ID. For example,\n alias/ExampleAlias.
Use the Amazon Resource Name (ARN) for the KMS key ID. For\n example,\n arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.
Use the ARN for the KMS key alias. For example,\n arn:aws:kms:region:account-ID:alias/ExampleAlias.
If using a key located in a different\n Amazon Web Services account than the current Amazon Web Services account, you can specify\n your KMS key in one of two ways:
\nUse the ARN for the KMS key ID. For example,\n arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.
Use the ARN for the KMS key alias. For example,\n arn:aws:kms:region:account-ID:alias/ExampleAlias.
If you don't specify an encryption key, your output is encrypted with the default\n Amazon S3 key (SSE-S3).
\nIf you specify a KMS key to encrypt your output, you must also specify\n an output location using the OutputLocation parameter.
Note that the user making the request must\n have permission to use the specified KMS key.
" } }, "DataAccessRoleArn": { "target": "com.amazonaws.transcribe#DataAccessRoleArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM role that has permissions to\n access the Amazon S3 bucket that contains your input files. If the role that you\n specify doesn’t have the appropriate permissions to access the specified Amazon S3 location, your request fails.
\nIAM role ARNs have the format\n arn:partition:iam::account:role/role-name-with-path. For example:\n arn:aws:iam::111122223333:role/Admin.
For more information, see IAM\n ARNs.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM role that has permissions to\n access the Amazon S3 bucket that contains your input files. If the role that you\n specify doesn’t have the appropriate permissions to access the specified Amazon S3 location, your request fails.
\nIAM role ARNs have the format\n arn:partition:iam::account:role/role-name-with-path. For example:\n arn:aws:iam::111122223333:role/Admin.
For more information, see IAM\n ARNs.
" } }, "Settings": { @@ -4142,7 +4154,7 @@ } ], "traits": { - "smithy.api#documentation": "Transcribes the audio from a medical dictation or conversation and applies any\n additional Request Parameters you choose to include in your request.
\nIn addition to many standard transcription features, Amazon Transcribe Medical\n provides you with a robust medical vocabulary and, optionally, content identification,\n which adds flags to personal health information (PHI). To learn more about these\n features, refer to How Amazon Transcribe Medical\n works.
\nTo make a StartMedicalTranscriptionJob request, you must first upload\n your media file into an Amazon S3 bucket; you can then specify the S3 location\n of the file using the Media parameter.
You must include the following parameters in your\n StartMedicalTranscriptionJob request:
\n region: The Amazon Web Services Region where you are making your\n request. For a list of Amazon Web Services Regions supported with Amazon Transcribe, refer to Amazon Transcribe endpoints and\n quotas.
\n MedicalTranscriptionJobName: A custom name you create for your\n transcription job that is unique within your Amazon Web Services account.
\n Media (MediaFileUri): The Amazon S3 location\n of your media file.
\n LanguageCode: This must be en-US.
\n OutputBucketName: The Amazon S3 bucket where you want\n your transcript stored. If you want your output stored in a sub-folder of this\n bucket, you must also include OutputKey.
\n Specialty: This must be PRIMARYCARE.
\n Type: Choose whether your audio is a conversation or a\n dictation.
Transcribes the audio from a medical dictation or conversation and applies any\n additional Request Parameters you choose to include in your request.
\nIn addition to many standard transcription features, Amazon Transcribe Medical\n provides you with a robust medical vocabulary and, optionally, content identification,\n which adds flags to personal health information (PHI). To learn more about these\n features, refer to How Amazon Transcribe Medical\n works.
\nTo make a StartMedicalTranscriptionJob request, you must first upload\n your media file into an Amazon S3 bucket; you can then specify the S3 location\n of the file using the Media parameter.
You must include the following parameters in your\n StartMedicalTranscriptionJob request:
\n region: The Amazon Web Services Region where you are making your\n request. For a list of Amazon Web Services Regions supported with Amazon Transcribe, refer to Amazon Transcribe endpoints and\n quotas.
\n MedicalTranscriptionJobName: A custom name you create for your\n transcription job that is unique within your Amazon Web Services account.
\n Media (MediaFileUri): The Amazon S3 location\n of your media file.
\n LanguageCode: This must be en-US.
\n OutputBucketName: The Amazon S3 bucket where you want\n your transcript stored. If you want your output stored in a sub-folder of this\n bucket, you must also include OutputKey.
\n Specialty: This must be PRIMARYCARE.
\n Type: Choose whether your audio is a conversation or a\n dictation.
A unique name, chosen by you, for your medical transcription job. The name that you\n specify is also used as the default name of your transcription output file. If you want\n to specify a different name for your transcription output, use the\n OutputKey parameter.
This name is case sensitive, cannot contain spaces, and must be unique within an\n Amazon Web Services account. If you try to create a new job with the same name as an\n existing job, you get a ConflictException error.
A unique name, chosen by you, for your medical transcription job. The name that you\n specify is also used as the default name of your transcription output file. If you want\n to specify a different name for your transcription output, use the\n OutputKey parameter.
This name is case sensitive, cannot contain spaces, and must be unique within an\n Amazon Web Services account. If you try to create a new job with the same name as an\n existing job, you get a ConflictException error.
The sample rate, in hertz, of the audio track in your input media file.
\nIf you don't specify the media sample rate, Amazon Transcribe Medical determines it\n for you. If you specify the sample rate, it must match the rate detected by Amazon Transcribe Medical; if there's a mismatch between the value that you specify and the\n value detected, your job fails. Therefore, in most cases, it's advised to omit\n MediaSampleRateHertz and let Amazon Transcribe Medical determine the\n sample rate.
The sample rate, in hertz, of the audio track in your input media file.
\nIf you don't specify the media sample rate, Amazon Transcribe Medical determines it\n for you. If you specify the sample rate, it must match the rate detected by Amazon Transcribe Medical; if there's a mismatch between the value that you specify and the\n value detected, your job fails. Therefore, in most cases, it's advised to omit\n MediaSampleRateHertz and let Amazon Transcribe Medical determine the\n sample rate.
The name of the Amazon S3 bucket where you want your medical transcription\n output stored. Do not include the S3:// prefix of the specified\n bucket.
If you want your output to go to a sub-folder of this bucket, specify it using the\n OutputKey parameter; OutputBucketName only accepts the\n name of a bucket.
For example, if you want your output stored in S3://DOC-EXAMPLE-BUCKET,\n set OutputBucketName to DOC-EXAMPLE-BUCKET. However, if you\n want your output stored in S3://DOC-EXAMPLE-BUCKET/test-files/, set\n OutputBucketName to DOC-EXAMPLE-BUCKET and\n OutputKey to test-files/.
Note that Amazon Transcribe must have permission to use the specified location. You\n can change Amazon S3 permissions using the Amazon Web Services Management Console. See also Permissions Required for IAM User Roles.
", + "smithy.api#documentation": "The name of the Amazon S3 bucket where you want your medical transcription\n output stored. Do not include the S3:// prefix of the specified\n bucket.
If you want your output to go to a sub-folder of this bucket, specify it using the\n OutputKey parameter; OutputBucketName only accepts the\n name of a bucket.
For example, if you want your output stored in S3://DOC-EXAMPLE-BUCKET,\n set OutputBucketName to DOC-EXAMPLE-BUCKET. However, if you\n want your output stored in S3://DOC-EXAMPLE-BUCKET/test-files/, set\n OutputBucketName to DOC-EXAMPLE-BUCKET and\n OutputKey to test-files/.
Note that Amazon Transcribe must have permission to use the specified location. You\n can change Amazon S3 permissions using the Amazon Web Services Management Console. See also Permissions Required for IAM User Roles.
", "smithy.api#required": {} } }, "OutputKey": { "target": "com.amazonaws.transcribe#OutputKey", "traits": { - "smithy.api#documentation": "Use in combination with OutputBucketName to specify the output location\n of your transcript and, optionally, a unique name for your output file. The default name\n for your transcription output is the same as the name you specified for your medical\n transcription job (MedicalTranscriptionJobName).
Here are some examples of how you can use OutputKey:
If you specify 'DOC-EXAMPLE-BUCKET' as the OutputBucketName and\n 'my-transcript.json' as the OutputKey, your transcription output\n path is s3://DOC-EXAMPLE-BUCKET/my-transcript.json.
If you specify 'my-first-transcription' as the\n MedicalTranscriptionJobName, 'DOC-EXAMPLE-BUCKET' as the\n OutputBucketName, and 'my-transcript' as the\n OutputKey, your transcription output path is\n s3://DOC-EXAMPLE-BUCKET/my-transcript/my-first-transcription.json.
If you specify 'DOC-EXAMPLE-BUCKET' as the OutputBucketName and\n 'test-files/my-transcript.json' as the OutputKey, your\n transcription output path is\n s3://DOC-EXAMPLE-BUCKET/test-files/my-transcript.json.
If you specify 'my-first-transcription' as the\n MedicalTranscriptionJobName, 'DOC-EXAMPLE-BUCKET' as the\n OutputBucketName, and 'test-files/my-transcript' as the\n OutputKey, your transcription output path is\n s3://DOC-EXAMPLE-BUCKET/test-files/my-transcript/my-first-transcription.json.
If you specify the name of an Amazon S3 bucket sub-folder that doesn't exist,\n one is created for you.
" + "smithy.api#documentation": "Use in combination with OutputBucketName to specify the output location\n of your transcript and, optionally, a unique name for your output file. The default name\n for your transcription output is the same as the name you specified for your medical\n transcription job (MedicalTranscriptionJobName).
Here are some examples of how you can use OutputKey:
If you specify 'DOC-EXAMPLE-BUCKET' as the OutputBucketName and\n 'my-transcript.json' as the OutputKey, your transcription output\n path is s3://DOC-EXAMPLE-BUCKET/my-transcript.json.
If you specify 'my-first-transcription' as the\n MedicalTranscriptionJobName, 'DOC-EXAMPLE-BUCKET' as the\n OutputBucketName, and 'my-transcript' as the\n OutputKey, your transcription output path is\n s3://DOC-EXAMPLE-BUCKET/my-transcript/my-first-transcription.json.
If you specify 'DOC-EXAMPLE-BUCKET' as the OutputBucketName and\n 'test-files/my-transcript.json' as the OutputKey, your\n transcription output path is\n s3://DOC-EXAMPLE-BUCKET/test-files/my-transcript.json.
If you specify 'my-first-transcription' as the\n MedicalTranscriptionJobName, 'DOC-EXAMPLE-BUCKET' as the\n OutputBucketName, and 'test-files/my-transcript' as the\n OutputKey, your transcription output path is\n s3://DOC-EXAMPLE-BUCKET/test-files/my-transcript/my-first-transcription.json.
If you specify the name of an Amazon S3 bucket sub-folder that doesn't exist,\n one is created for you.
" } }, "OutputEncryptionKMSKeyId": { "target": "com.amazonaws.transcribe#KMSKeyId", "traits": { - "smithy.api#documentation": "The KMS key you want to use to encrypt your medical transcription\n output.
\nIf using a key located in the current\n Amazon Web Services account, you can specify your KMS key in one of four\n ways:
\nUse the KMS key ID itself. For example,\n 1234abcd-12ab-34cd-56ef-1234567890ab.
Use an alias for the KMS key ID. For example,\n alias/ExampleAlias.
Use the Amazon Resource Name (ARN) for the KMS key ID. For\n example,\n arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.
Use the ARN for the KMS key alias. For example,\n arn:aws:kms:region:account-ID:alias/ExampleAlias.
If using a key located in a different\n Amazon Web Services account than the current Amazon Web Services account, you can specify\n your KMS key in one of two ways:
\nUse the ARN for the KMS key ID. For example,\n arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.
Use the ARN for the KMS key alias. For example,\n arn:aws:kms:region:account-ID:alias/ExampleAlias.
If you don't specify an encryption key, your output is encrypted with the default\n Amazon S3 key (SSE-S3).
\nIf you specify a KMS key to encrypt your output, you must also specify\n an output location using the OutputLocation parameter.
Note that the user making the request must\n have permission to use the specified KMS key.
" + "smithy.api#documentation": "The KMS key you want to use to encrypt your medical transcription\n output.
\nIf using a key located in the current\n Amazon Web Services account, you can specify your KMS key in one of four\n ways:
\nUse the KMS key ID itself. For example,\n 1234abcd-12ab-34cd-56ef-1234567890ab.
Use an alias for the KMS key ID. For example,\n alias/ExampleAlias.
Use the Amazon Resource Name (ARN) for the KMS key ID. For\n example,\n arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.
Use the ARN for the KMS key alias. For example,\n arn:aws:kms:region:account-ID:alias/ExampleAlias.
If using a key located in a different\n Amazon Web Services account than the current Amazon Web Services account, you can specify\n your KMS key in one of two ways:
\nUse the ARN for the KMS key ID. For example,\n arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.
Use the ARN for the KMS key alias. For example,\n arn:aws:kms:region:account-ID:alias/ExampleAlias.
If you don't specify an encryption key, your output is encrypted with the default\n Amazon S3 key (SSE-S3).
\nIf you specify a KMS key to encrypt your output, you must also specify\n an output location using the OutputLocation parameter.
Note that the user making the request must\n have permission to use the specified KMS key.
" } }, "KMSEncryptionContext": { @@ -4233,14 +4245,14 @@ "Type": { "target": "com.amazonaws.transcribe#Type", "traits": { - "smithy.api#documentation": "Specify whether your input media contains only one person (DICTATION) or\n contains a conversation between two people (CONVERSATION).
For example, DICTATION could be used for a medical professional wanting\n to transcribe voice memos; CONVERSATION could be used for transcribing the\n doctor-patient dialogue during the patient's office visit.
Specify whether your input media contains only one person (DICTATION) or\n contains a conversation between two people (CONVERSATION).
For example, DICTATION could be used for a medical professional wanting\n to transcribe voice memos; CONVERSATION could be used for transcribing the\n doctor-patient dialogue during the patient's office visit.
Adds one or more custom tags, each in the form of a key:value pair, to a new medical\n transcription job at the time you start this new job.
\nTo learn more about using tags with Amazon Transcribe, refer to Tagging\n resources.
" + "smithy.api#documentation": "Adds one or more custom tags, each in the form of a key:value pair, to a new medical\n transcription job at the time you start this new job.
\nTo learn more about using tags with Amazon Transcribe, refer to Tagging\n resources.
" } } } @@ -4279,7 +4291,7 @@ } ], "traits": { - "smithy.api#documentation": "Transcribes the audio from a media file and applies any additional Request Parameters\n you choose to include in your request.
\nTo make a StartTranscriptionJob request, you must first upload your media\n file into an Amazon S3 bucket; you can then specify the Amazon S3\n location of the file using the Media parameter.
You must include the following parameters in your StartTranscriptionJob\n request:
\n region: The Amazon Web Services Region where you are making your\n request. For a list of Amazon Web Services Regions supported with Amazon Transcribe, refer to Amazon Transcribe endpoints and\n quotas.
\n TranscriptionJobName: A custom name you create for your\n transcription job that is unique within your Amazon Web Services account.
\n Media (MediaFileUri): The Amazon S3 location\n of your media file.
One of LanguageCode, IdentifyLanguage, or\n IdentifyMultipleLanguages: If you know the language of your\n media file, specify it using the LanguageCode parameter; you can\n find all valid language codes in the Supported\n languages table. If you don't know the languages spoken in your\n media, use either IdentifyLanguage or\n IdentifyMultipleLanguages and let Amazon Transcribe identify\n the languages for you.
Transcribes the audio from a media file and applies any additional Request Parameters\n you choose to include in your request.
\nTo make a StartTranscriptionJob request, you must first upload your media\n file into an Amazon S3 bucket; you can then specify the Amazon S3\n location of the file using the Media parameter.
You must include the following parameters in your StartTranscriptionJob\n request:
\n region: The Amazon Web Services Region where you are making your\n request. For a list of Amazon Web Services Regions supported with Amazon Transcribe, refer to Amazon Transcribe endpoints and\n quotas.
\n TranscriptionJobName: A custom name you create for your\n transcription job that is unique within your Amazon Web Services account.
\n Media (MediaFileUri): The Amazon S3 location\n of your media file.
One of LanguageCode, IdentifyLanguage, or\n IdentifyMultipleLanguages: If you know the language of your\n media file, specify it using the LanguageCode parameter; you can\n find all valid language codes in the Supported\n languages table. If you don't know the languages spoken in your\n media, use either IdentifyLanguage or\n IdentifyMultipleLanguages and let Amazon Transcribe identify\n the languages for you.
A unique name, chosen by you, for your transcription job. The name that you specify is\n also used as the default name of your transcription output file. If you want to specify\n a different name for your transcription output, use the OutputKey\n parameter.
This name is case sensitive, cannot contain spaces, and must be unique within an\n Amazon Web Services account. If you try to create a new job with the same name as an\n existing job, you get a ConflictException error.
A unique name, chosen by you, for your transcription job. The name that you specify is\n also used as the default name of your transcription output file. If you want to specify\n a different name for your transcription output, use the OutputKey\n parameter.
This name is case sensitive, cannot contain spaces, and must be unique within an\n Amazon Web Services account. If you try to create a new job with the same name as an\n existing job, you get a ConflictException error.
The language code that represents the language spoken in the input media file.
\nIf you're unsure of the language spoken in your media file, consider using\n IdentifyLanguage or IdentifyMultipleLanguages to enable\n automatic language identification.
Note that you must include one of LanguageCode,\n IdentifyLanguage, or IdentifyMultipleLanguages in your\n request. If you include more than one of these parameters, your transcription job\n fails.
For a list of supported languages and their associated language codes, refer to the\n Supported languages table.
\nTo transcribe speech in Modern Standard Arabic (ar-SA), your media\n file must be encoded at a sample rate of 16,000 Hz or higher.
The language code that represents the language spoken in the input media file.
\nIf you're unsure of the language spoken in your media file, consider using\n IdentifyLanguage or IdentifyMultipleLanguages to enable\n automatic language identification.
Note that you must include one of LanguageCode,\n IdentifyLanguage, or IdentifyMultipleLanguages in your\n request. If you include more than one of these parameters, your transcription job\n fails.
For a list of supported languages and their associated language codes, refer to the\n Supported languages table.
\nTo transcribe speech in Modern Standard Arabic (ar-SA), your media\n file must be encoded at a sample rate of 16,000 Hz or higher.
The sample rate, in hertz, of the audio track in your input media file.
\nIf you don't specify the media sample rate, Amazon Transcribe determines it for you.\n If you specify the sample rate, it must match the rate detected by Amazon Transcribe.\n If there's a mismatch between the value that you specify and the value detected, your\n job fails. In most cases, you can omit MediaSampleRateHertz and let Amazon Transcribe determine the sample rate.
The sample rate, in hertz, of the audio track in your input media file.
\nIf you don't specify the media sample rate, Amazon Transcribe determines it for you.\n If you specify the sample rate, it must match the rate detected by Amazon Transcribe.\n If there's a mismatch between the value that you specify and the value detected, your\n job fails. In most cases, you can omit MediaSampleRateHertz and let Amazon Transcribe determine the sample rate.
The name of the Amazon S3 bucket where you want your transcription output\n stored. Do not include the S3:// prefix of the specified bucket.
If you want your output to go to a sub-folder of this bucket, specify it using the\n OutputKey parameter; OutputBucketName only accepts the\n name of a bucket.
For example, if you want your output stored in S3://DOC-EXAMPLE-BUCKET,\n set OutputBucketName to DOC-EXAMPLE-BUCKET. However, if you\n want your output stored in S3://DOC-EXAMPLE-BUCKET/test-files/, set\n OutputBucketName to DOC-EXAMPLE-BUCKET and\n OutputKey to test-files/.
Note that Amazon Transcribe must have permission to use the specified location. You\n can change Amazon S3 permissions using the Amazon Web Services Management Console. See also Permissions Required for IAM User Roles.
\nIf you don't specify OutputBucketName, your transcript is placed in a\n service-managed Amazon S3 bucket and you are provided with a URI to access your\n transcript.
The name of the Amazon S3 bucket where you want your transcription output\n stored. Do not include the S3:// prefix of the specified bucket.
If you want your output to go to a sub-folder of this bucket, specify it using the\n OutputKey parameter; OutputBucketName only accepts the\n name of a bucket.
For example, if you want your output stored in S3://DOC-EXAMPLE-BUCKET,\n set OutputBucketName to DOC-EXAMPLE-BUCKET. However, if you\n want your output stored in S3://DOC-EXAMPLE-BUCKET/test-files/, set\n OutputBucketName to DOC-EXAMPLE-BUCKET and\n OutputKey to test-files/.
Note that Amazon Transcribe must have permission to use the specified location. You\n can change Amazon S3 permissions using the Amazon Web Services Management Console. See also Permissions Required for IAM User Roles.
\nIf you don't specify OutputBucketName, your transcript is placed in a\n service-managed Amazon S3 bucket and you are provided with a URI to access your\n transcript.
Use in combination with OutputBucketName to specify the output location\n of your transcript and, optionally, a unique name for your output file. The default name\n for your transcription output is the same as the name you specified for your\n transcription job (TranscriptionJobName).
Here are some examples of how you can use OutputKey:
If you specify 'DOC-EXAMPLE-BUCKET' as the OutputBucketName and\n 'my-transcript.json' as the OutputKey, your transcription output\n path is s3://DOC-EXAMPLE-BUCKET/my-transcript.json.
If you specify 'my-first-transcription' as the\n TranscriptionJobName, 'DOC-EXAMPLE-BUCKET' as the\n OutputBucketName, and 'my-transcript' as the\n OutputKey, your transcription output path is\n s3://DOC-EXAMPLE-BUCKET/my-transcript/my-first-transcription.json.
If you specify 'DOC-EXAMPLE-BUCKET' as the OutputBucketName and\n 'test-files/my-transcript.json' as the OutputKey, your\n transcription output path is\n s3://DOC-EXAMPLE-BUCKET/test-files/my-transcript.json.
If you specify 'my-first-transcription' as the\n TranscriptionJobName, 'DOC-EXAMPLE-BUCKET' as the\n OutputBucketName, and 'test-files/my-transcript' as the\n OutputKey, your transcription output path is\n s3://DOC-EXAMPLE-BUCKET/test-files/my-transcript/my-first-transcription.json.
If you specify the name of an Amazon S3 bucket sub-folder that doesn't exist,\n one is created for you.
" + "smithy.api#documentation": "Use in combination with OutputBucketName to specify the output location\n of your transcript and, optionally, a unique name for your output file. The default name\n for your transcription output is the same as the name you specified for your\n transcription job (TranscriptionJobName).
Here are some examples of how you can use OutputKey:
If you specify 'DOC-EXAMPLE-BUCKET' as the OutputBucketName and\n 'my-transcript.json' as the OutputKey, your transcription output\n path is s3://DOC-EXAMPLE-BUCKET/my-transcript.json.
If you specify 'my-first-transcription' as the\n TranscriptionJobName, 'DOC-EXAMPLE-BUCKET' as the\n OutputBucketName, and 'my-transcript' as the\n OutputKey, your transcription output path is\n s3://DOC-EXAMPLE-BUCKET/my-transcript/my-first-transcription.json.
If you specify 'DOC-EXAMPLE-BUCKET' as the OutputBucketName and\n 'test-files/my-transcript.json' as the OutputKey, your\n transcription output path is\n s3://DOC-EXAMPLE-BUCKET/test-files/my-transcript.json.
If you specify 'my-first-transcription' as the\n TranscriptionJobName, 'DOC-EXAMPLE-BUCKET' as the\n OutputBucketName, and 'test-files/my-transcript' as the\n OutputKey, your transcription output path is\n s3://DOC-EXAMPLE-BUCKET/test-files/my-transcript/my-first-transcription.json.
If you specify the name of an Amazon S3 bucket sub-folder that doesn't exist,\n one is created for you.
" } }, "OutputEncryptionKMSKeyId": { "target": "com.amazonaws.transcribe#KMSKeyId", "traits": { - "smithy.api#documentation": "The KMS key you want to use to encrypt your transcription\n output.
\nIf using a key located in the current\n Amazon Web Services account, you can specify your KMS key in one of four\n ways:
\nUse the KMS key ID itself. For example,\n 1234abcd-12ab-34cd-56ef-1234567890ab.
Use an alias for the KMS key ID. For example,\n alias/ExampleAlias.
Use the Amazon Resource Name (ARN) for the KMS key ID. For\n example,\n arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.
Use the ARN for the KMS key alias. For example,\n arn:aws:kms:region:account-ID:alias/ExampleAlias.
If using a key located in a different\n Amazon Web Services account than the current Amazon Web Services account, you can specify\n your KMS key in one of two ways:
\nUse the ARN for the KMS key ID. For example,\n arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.
Use the ARN for the KMS key alias. For example,\n arn:aws:kms:region:account-ID:alias/ExampleAlias.
If you don't specify an encryption key, your output is encrypted with the default\n Amazon S3 key (SSE-S3).
\nIf you specify a KMS key to encrypt your output, you must also specify\n an output location using the OutputLocation parameter.
Note that the user making the request must\n have permission to use the specified KMS key.
" + "smithy.api#documentation": "The KMS key you want to use to encrypt your transcription\n output.
\nIf using a key located in the current\n Amazon Web Services account, you can specify your KMS key in one of four\n ways:
\nUse the KMS key ID itself. For example,\n 1234abcd-12ab-34cd-56ef-1234567890ab.
Use an alias for the KMS key ID. For example,\n alias/ExampleAlias.
Use the Amazon Resource Name (ARN) for the KMS key ID. For\n example,\n arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.
Use the ARN for the KMS key alias. For example,\n arn:aws:kms:region:account-ID:alias/ExampleAlias.
If using a key located in a different\n Amazon Web Services account than the current Amazon Web Services account, you can specify\n your KMS key in one of two ways:
\nUse the ARN for the KMS key ID. For example,\n arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.
Use the ARN for the KMS key alias. For example,\n arn:aws:kms:region:account-ID:alias/ExampleAlias.
If you don't specify an encryption key, your output is encrypted with the default\n Amazon S3 key (SSE-S3).
\nIf you specify a KMS key to encrypt your output, you must also specify\n an output location using the OutputLocation parameter.
Note that the user making the request must\n have permission to use the specified KMS key.
" } }, "KMSEncryptionContext": { @@ -4350,19 +4362,19 @@ "Settings": { "target": "com.amazonaws.transcribe#Settings", "traits": { - "smithy.api#documentation": "Specify additional optional settings in your request, including channel identification, alternative transcriptions, speaker\n partitioning. You can use that to apply custom vocabularies and vocabulary filters.
\nIf you want to include a custom vocabulary or a custom vocabulary filter (or both)\n with your request but do not want to use automatic\n language identification, use Settings with the VocabularyName\n or VocabularyFilterName (or both) sub-parameter.
If you're using automatic language identification with your request and want to\n include a custom language model, a custom vocabulary, or a custom vocabulary filter, use\n instead the parameter with the\n LanguageModelName, VocabularyName or\n VocabularyFilterName sub-parameters.
Specify additional optional settings in your request, including channel identification, alternative transcriptions, speaker\n partitioning. You can use that to apply custom vocabularies and vocabulary filters.
\nIf you want to include a custom vocabulary or a custom vocabulary filter (or both)\n with your request but do not want to use automatic\n language identification, use Settings with the VocabularyName\n or VocabularyFilterName (or both) sub-parameter.
If you're using automatic language identification with your request and want to\n include a custom language model, a custom vocabulary, or a custom vocabulary filter, use\n instead the parameter with the\n LanguageModelName, VocabularyName or\n VocabularyFilterName sub-parameters.
Specify the custom language model you want to include with your transcription job. If\n you include ModelSettings in your request, you must include the\n LanguageModelName sub-parameter.
For more information, see Custom language\n models.
" + "smithy.api#documentation": "Specify the custom language model you want to include with your transcription job. If\n you include ModelSettings in your request, you must include the\n LanguageModelName sub-parameter.
For more information, see Custom language\n models.
" } }, "JobExecutionSettings": { "target": "com.amazonaws.transcribe#JobExecutionSettings", "traits": { - "smithy.api#documentation": "Makes it possible to control how your transcription job is processed. Currently, the\n only JobExecutionSettings modification you can choose is enabling job\n queueing using the AllowDeferredExecution sub-parameter.
If you include JobExecutionSettings in your request, you must also\n include the sub-parameters: AllowDeferredExecution and\n DataAccessRoleArn.
Makes it possible to control how your transcription job is processed. Currently, the\n only JobExecutionSettings modification you can choose is enabling job\n queueing using the AllowDeferredExecution sub-parameter.
If you include JobExecutionSettings in your request, you must also\n include the sub-parameters: AllowDeferredExecution and\n DataAccessRoleArn.
Enables automatic language identification in your transcription job request. Use this\n parameter if your media file contains only one language. If your media contains multiple\n languages, use IdentifyMultipleLanguages instead.
If you include IdentifyLanguage, you can optionally include a list of\n language codes, using LanguageOptions, that you think may be present in\n your media file. Including LanguageOptions restricts\n IdentifyLanguage to only the language options that you specify, which\n can improve transcription accuracy.
If you want to apply a custom language model, a custom vocabulary, or a custom\n vocabulary filter to your automatic language identification request, include\n LanguageIdSettings with the relevant sub-parameters\n (VocabularyName, LanguageModelName, and\n VocabularyFilterName). If you include LanguageIdSettings,\n also include LanguageOptions.
Note that you must include one of LanguageCode,\n IdentifyLanguage, or IdentifyMultipleLanguages in your\n request. If you include more than one of these parameters, your transcription job\n fails.
Enables automatic language identification in your transcription job request. Use this\n parameter if your media file contains only one language. If your media contains multiple\n languages, use IdentifyMultipleLanguages instead.
If you include IdentifyLanguage, you can optionally include a list of\n language codes, using LanguageOptions, that you think may be present in\n your media file. Including LanguageOptions restricts\n IdentifyLanguage to only the language options that you specify, which\n can improve transcription accuracy.
If you want to apply a custom language model, a custom vocabulary, or a custom\n vocabulary filter to your automatic language identification request, include\n LanguageIdSettings with the relevant sub-parameters\n (VocabularyName, LanguageModelName, and\n VocabularyFilterName). If you include LanguageIdSettings,\n also include LanguageOptions.
Note that you must include one of LanguageCode,\n IdentifyLanguage, or IdentifyMultipleLanguages in your\n request. If you include more than one of these parameters, your transcription job\n fails.
Enables automatic multi-language identification in your transcription job request. Use\n this parameter if your media file contains more than one language. If your media\n contains only one language, use IdentifyLanguage instead.
If you include IdentifyMultipleLanguages, you can optionally include a\n list of language codes, using LanguageOptions, that you think may be\n present in your media file. Including LanguageOptions restricts\n IdentifyLanguage to only the language options that you specify, which\n can improve transcription accuracy.
If you want to apply a custom vocabulary or a custom vocabulary filter to your\n automatic language identification request, include LanguageIdSettings with\n the relevant sub-parameters (VocabularyName and\n VocabularyFilterName). If you include LanguageIdSettings,\n also include LanguageOptions.
Note that you must include one of LanguageCode,\n IdentifyLanguage, or IdentifyMultipleLanguages in your\n request. If you include more than one of these parameters, your transcription job\n fails.
Enables automatic multi-language identification in your transcription job request. Use\n this parameter if your media file contains more than one language. If your media\n contains only one language, use IdentifyLanguage instead.
If you include IdentifyMultipleLanguages, you can optionally include a\n list of language codes, using LanguageOptions, that you think may be\n present in your media file. Including LanguageOptions restricts\n IdentifyLanguage to only the language options that you specify, which\n can improve transcription accuracy.
If you want to apply a custom vocabulary or a custom vocabulary filter to your\n automatic language identification request, include LanguageIdSettings with\n the relevant sub-parameters (VocabularyName and\n VocabularyFilterName). If you include LanguageIdSettings,\n also include LanguageOptions.
Note that you must include one of LanguageCode,\n IdentifyLanguage, or IdentifyMultipleLanguages in your\n request. If you include more than one of these parameters, your transcription job\n fails.
You can specify two or more language codes that represent the languages you think may\n be present in your media. Including more than five is not recommended. If you're unsure\n what languages are present, do not include this parameter.
\nIf you include LanguageOptions in your request, you must also include\n IdentifyLanguage.
For more information, refer to Supported\n languages.
\nTo transcribe speech in Modern Standard Arabic (ar-SA), your media file\n must be encoded at a sample rate of 16,000 Hz or higher.
You can specify two or more language codes that represent the languages you think may\n be present in your media. Including more than five is not recommended. If you're unsure\n what languages are present, do not include this parameter.
\nIf you include LanguageOptions in your request, you must also include\n IdentifyLanguage.
For more information, refer to Supported\n languages.
\nTo transcribe speech in Modern Standard Arabic (ar-SA), your media file\n must be encoded at a sample rate of 16,000 Hz or higher.
Adds one or more custom tags, each in the form of a key:value pair, to a new\n transcription job at the time you start this new job.
\nTo learn more about using tags with Amazon Transcribe, refer to Tagging\n resources.
" + "smithy.api#documentation": "Adds one or more custom tags, each in the form of a key:value pair, to a new\n transcription job at the time you start this new job.
\nTo learn more about using tags with Amazon Transcribe, refer to Tagging\n resources.
" } }, "LanguageIdSettings": { "target": "com.amazonaws.transcribe#LanguageIdSettingsMap", "traits": { - "smithy.api#documentation": "If using automatic language identification in your request and you want to apply a\n custom language model, a custom vocabulary, or a custom vocabulary filter, include\n LanguageIdSettings with the relevant sub-parameters\n (VocabularyName, LanguageModelName, and\n VocabularyFilterName). Note that multi-language identification\n (IdentifyMultipleLanguages) doesn't support custom language\n models.
\n LanguageIdSettings supports two to five language codes. Each language\n code you include can have an associated custom language model, custom vocabulary, and\n custom vocabulary filter. The language codes that you specify must match the languages\n of the associated custom language models, custom vocabularies, and custom vocabulary\n filters.
It's recommended that you include LanguageOptions when using\n LanguageIdSettings to ensure that the correct language dialect is\n identified. For example, if you specify a custom vocabulary that is in\n en-US but Amazon Transcribe determines that the language spoken in\n your media is en-AU, your custom vocabulary is not\n applied to your transcription. If you include LanguageOptions and include\n en-US as the only English language dialect, your custom vocabulary\n is applied to your transcription.
If you want to include a custom language model with your request but do not want to use automatic language identification, use\n instead the parameter with the\n LanguageModelName sub-parameter. If you want to include a custom\n vocabulary or a custom vocabulary filter (or both) with your request but do not want to use automatic language identification, use\n instead the parameter with the\n VocabularyName or VocabularyFilterName (or both)\n sub-parameter.
If using automatic language identification in your request and you want to apply a\n custom language model, a custom vocabulary, or a custom vocabulary filter, include\n LanguageIdSettings with the relevant sub-parameters\n (VocabularyName, LanguageModelName, and\n VocabularyFilterName). Note that multi-language identification\n (IdentifyMultipleLanguages) doesn't support custom language\n models.
\n LanguageIdSettings supports two to five language codes. Each language\n code you include can have an associated custom language model, custom vocabulary, and\n custom vocabulary filter. The language codes that you specify must match the languages\n of the associated custom language models, custom vocabularies, and custom vocabulary\n filters.
It's recommended that you include LanguageOptions when using\n LanguageIdSettings to ensure that the correct language dialect is\n identified. For example, if you specify a custom vocabulary that is in\n en-US but Amazon Transcribe determines that the language spoken in\n your media is en-AU, your custom vocabulary is not\n applied to your transcription. If you include LanguageOptions and include\n en-US as the only English language dialect, your custom vocabulary\n is applied to your transcription.
If you want to include a custom language model with your request but do not want to use automatic language identification, use\n instead the parameter with the\n LanguageModelName sub-parameter. If you want to include a custom\n vocabulary or a custom vocabulary filter (or both) with your request but do not want to use automatic language identification, use\n instead the parameter with the\n VocabularyName or VocabularyFilterName (or both)\n sub-parameter.
Specify the starting value that is assigned to the first subtitle segment.
\nThe default start index for Amazon Transcribe is 0, which differs from\n the more widely used standard of 1. If you're uncertain which value to use,\n we recommend choosing 1, as this may improve compatibility with other\n services.
Specify the starting value that is assigned to the first subtitle segment.
\nThe default start index for Amazon Transcribe is 0, which differs from\n the more widely used standard of 1. If you're uncertain which value to use,\n we recommend choosing 1, as this may improve compatibility with other\n services.
Generate subtitles for your media file with your transcription request.
\nYou can choose a start index of 0 or 1, and you can specify either WebVTT or SubRip\n (or both) as your output format.
\nNote that your subtitle files are placed in the same location as your transcription\n output.
" + "smithy.api#documentation": "Generate subtitles for your media file with your transcription request.
\nYou can choose a start index of 0 or 1, and you can specify either WebVTT or SubRip\n (or both) as your output format.
\nNote that your subtitle files are placed in the same location as your transcription\n output.
" } }, "com.amazonaws.transcribe#SubtitlesOutput": { @@ -4504,7 +4516,7 @@ "SubtitleFileUris": { "target": "com.amazonaws.transcribe#SubtitleFileUris", "traits": { - "smithy.api#documentation": "The Amazon S3 location of your transcript. You can use this URI to access or\n download your subtitle file. Your subtitle file is stored in the same location as your\n transcript. If you specified both WebVTT and SubRip subtitle formats, two URIs are\n provided.
\nIf you included OutputBucketName in your transcription job request, this\n is the URI of that bucket. If you also included OutputKey in your request,\n your output is located in the path you specified in your request.
If you didn't include OutputBucketName in your transcription job request,\n your subtitle file is stored in a service-managed bucket, and\n TranscriptFileUri provides you with a temporary URI you can use for\n secure access to your subtitle file.
Temporary URIs for service-managed Amazon S3 buckets are only valid for 15\n minutes. If you get an AccesDenied error, you can get a new temporary\n URI by running a GetTranscriptionJob or\n ListTranscriptionJob request.
The Amazon S3 location of your transcript. You can use this URI to access or\n download your subtitle file. Your subtitle file is stored in the same location as your\n transcript. If you specified both WebVTT and SubRip subtitle formats, two URIs are\n provided.
\nIf you included OutputBucketName in your transcription job request, this\n is the URI of that bucket. If you also included OutputKey in your request,\n your output is located in the path you specified in your request.
If you didn't include OutputBucketName in your transcription job request,\n your subtitle file is stored in a service-managed bucket, and\n TranscriptFileUri provides you with a temporary URI you can use for\n secure access to your subtitle file.
Temporary URIs for service-managed Amazon S3 buckets are only valid for 15\n minutes. If you get an AccesDenied error, you can get a new temporary\n URI by running a GetTranscriptionJob or\n ListTranscriptionJob request.
The second part of a key:value pair that forms a tag associated with a given resource.\n For example, in the tag Department:Sales, the value is 'Sales'.
Note that you can set the value of a tag to an empty string, but you can't set the\n value of a tag to null. Omitting the tag value is the same as using an empty\n string.
", + "smithy.api#documentation": "The second part of a key:value pair that forms a tag associated with a given resource.\n For example, in the tag Department:Sales, the value is 'Sales'.
Note that you can set the value of a tag to an empty string, but you can't set the\n value of a tag to null. Omitting the tag value is the same as using an empty\n string.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Adds metadata, in the form of a key:value pair, to the specified resource.
\nFor example, you could add the tag Department:Sales to a resource to\n indicate that it pertains to your organization's sales department. You can also use tags\n for tag-based access control.
To learn more about tagging, see Tagging resources.
" + "smithy.api#documentation": "Adds metadata, in the form of a key:value pair, to the specified resource.
\nFor example, you could add the tag Department:Sales to a resource to\n indicate that it pertains to your organization's sales department. You can also use tags\n for tag-based access control.
To learn more about tagging, see Tagging resources.
" } }, "com.amazonaws.transcribe#TagKey": { @@ -4599,7 +4611,7 @@ } ], "traits": { - "smithy.api#documentation": "Adds one or more custom tags, each in the form of a key:value pair, to the specified\n resource.
\nTo learn more about using tags with Amazon Transcribe, refer to Tagging\n resources.
", + "smithy.api#documentation": "Adds one or more custom tags, each in the form of a key:value pair, to the specified\n resource.
\nTo learn more about using tags with Amazon Transcribe, refer to Tagging\n resources.
", "smithy.api#http": { "method": "PUT", "uri": "/tags/{ResourceArn}", @@ -4613,7 +4625,7 @@ "ResourceArn": { "target": "com.amazonaws.transcribe#TranscribeArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource you want to tag. ARNs have the format\n arn:partition:service:region:account-id:resource-type/resource-id.
For example,\n arn:aws:transcribe:us-west-2:111122223333:transcription-job/transcription-job-name.
Valid values for resource-type are: transcription-job,\n medical-transcription-job, vocabulary,\n medical-vocabulary, vocabulary-filter, and\n language-model.
The Amazon Resource Name (ARN) of the resource you want to tag. ARNs have the format\n arn:partition:service:region:account-id:resource-type/resource-id.
For example,\n arn:aws:transcribe:us-west-2:111122223333:transcription-job/transcription-job-name.
Valid values for resource-type are: transcription-job,\n medical-transcription-job, vocabulary,\n medical-vocabulary, vocabulary-filter, and\n language-model.
Adds one or more custom tags, each in the form of a key:value pair, to the specified\n resource.
\nTo learn more about using tags with Amazon Transcribe, refer to Tagging\n resources.
", + "smithy.api#documentation": "Adds one or more custom tags, each in the form of a key:value pair, to the specified\n resource.
\nTo learn more about using tags with Amazon Transcribe, refer to Tagging\n resources.
", "smithy.api#required": {} } } @@ -4783,7 +4795,7 @@ "name": "transcribe" }, "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "Amazon Transcribe offers three main types of batch transcription: Standard, Medical, and\n Call Analytics.
\n\n Standard transcriptions are the most common\n option. Refer to for details.
\n\n Medical transcriptions are tailored to\n medical professionals and incorporate medical terms. A common use case for this\n service is transcribing doctor-patient dialogue into after-visit notes. Refer to\n for details.
\n\n Call Analytics transcriptions are designed\n for use with call center audio on two different channels; if you're looking for\n insight into customer service calls, use this option. Refer to for details.
\nAmazon Transcribe offers three main types of batch transcription: Standard, Medical, and\n Call Analytics.
\n\n Standard transcriptions are the most common\n option. Refer to for details.
\n\n Medical transcriptions are tailored to\n medical professionals and incorporate medical terms. A common use case for this\n service is transcribing doctor-patient dialogue into after-visit notes. Refer to\n for details.
\n\n Call Analytics transcriptions are designed\n for use with call center audio on two different channels; if you're looking for\n insight into customer service calls, use this option. Refer to for details.
\nThe Amazon S3 location of your transcript. You can use this URI to access or\n download your transcript.
\nIf you included OutputBucketName in your transcription job request, this\n is the URI of that bucket. If you also included OutputKey in your request,\n your output is located in the path you specified in your request.
If you didn't include OutputBucketName in your transcription job request,\n your transcript is stored in a service-managed bucket, and\n TranscriptFileUri provides you with a temporary URI you can use for\n secure access to your transcript.
Temporary URIs for service-managed Amazon S3 buckets are only valid for 15\n minutes. If you get an AccesDenied error, you can get a new temporary\n URI by running a GetTranscriptionJob or\n ListTranscriptionJob request.
The Amazon S3 location of your transcript. You can use this URI to access or\n download your transcript.
\nIf you included OutputBucketName in your transcription job request, this\n is the URI of that bucket. If you also included OutputKey in your request,\n your output is located in the path you specified in your request.
If you didn't include OutputBucketName in your transcription job request,\n your transcript is stored in a service-managed bucket, and\n TranscriptFileUri provides you with a temporary URI you can use for\n secure access to your transcript.
Temporary URIs for service-managed Amazon S3 buckets are only valid for 15\n minutes. If you get an AccesDenied error, you can get a new temporary\n URI by running a GetTranscriptionJob or\n ListTranscriptionJob request.
The Amazon S3 location of your redacted transcript. You can use this URI to\n access or download your transcript.
\nIf you included OutputBucketName in your transcription job request, this\n is the URI of that bucket. If you also included OutputKey in your request,\n your output is located in the path you specified in your request.
If you didn't include OutputBucketName in your transcription job request,\n your transcript is stored in a service-managed bucket, and\n RedactedTranscriptFileUri provides you with a temporary URI you can use\n for secure access to your transcript.
Temporary URIs for service-managed Amazon S3 buckets are only valid for 15\n minutes. If you get an AccesDenied error, you can get a new temporary\n URI by running a GetTranscriptionJob or\n ListTranscriptionJob request.
The Amazon S3 location of your redacted transcript. You can use this URI to\n access or download your transcript.
\nIf you included OutputBucketName in your transcription job request, this\n is the URI of that bucket. If you also included OutputKey in your request,\n your output is located in the path you specified in your request.
If you didn't include OutputBucketName in your transcription job request,\n your transcript is stored in a service-managed bucket, and\n RedactedTranscriptFileUri provides you with a temporary URI you can use\n for secure access to your transcript.
Temporary URIs for service-managed Amazon S3 buckets are only valid for 15\n minutes. If you get an AccesDenied error, you can get a new temporary\n URI by running a GetTranscriptionJob or\n ListTranscriptionJob request.
Flag the presence or absence of an exact match to the phrases that you specify. For\n example, if you specify the phrase \"speak to a manager\" as your Targets\n value, only that exact phrase is flagged.
Note that semantic matching is not supported. For example, if your customer says\n \"speak to the manager\", instead of \"speak to a\n manager\", your content is not flagged.
", + "smithy.api#documentation": "Flag the presence or absence of an exact match to the phrases that you specify. For\n example, if you specify the phrase \"speak to a manager\" as your Targets\n value, only that exact phrase is flagged.
Note that semantic matching is not supported. For example, if your customer says\n \"speak to the manager\", instead of \"speak to a\n manager\", your content is not flagged.
", "smithy.api#required": {} } }, @@ -6556,7 +6559,7 @@ } }, "traits": { - "smithy.api#documentation": "Flag the presence or absence of specific words or phrases detected in your Call\n Analytics transcription output.
\nRules using TranscriptFilter are designed to match:
Custom words or phrases spoken by the agent, the customer, or both
\nCustom words or phrases not spoken by the\n agent, the customer, or either
\nCustom words or phrases that occur at a specific time frame
\nSee Rule criteria for batch \n categories and Rule criteria for \n streaming categories for usage examples.
" + "smithy.api#documentation": "Flag the presence or absence of specific words or phrases detected in your Call\n Analytics transcription output.
\nRules using TranscriptFilter are designed to match:
Custom words or phrases spoken by the agent, the customer, or both
\nCustom words or phrases not spoken by the\n agent, the customer, or either
\nCustom words or phrases that occur at a specific time frame
\nSee Rule criteria for batch \n categories and Rule criteria for \n streaming categories for usage examples.
" } }, "com.amazonaws.transcribe#TranscriptFilterType": { @@ -6582,7 +6585,7 @@ "TranscriptionJobStatus": { "target": "com.amazonaws.transcribe#TranscriptionJobStatus", "traits": { - "smithy.api#documentation": "Provides the status of the specified transcription job.
\nIf the status is COMPLETED, the job is finished and you can find the\n results at the location specified in TranscriptFileUri (or\n RedactedTranscriptFileUri, if you requested transcript redaction). If\n the status is FAILED, FailureReason provides details on why\n your transcription job failed.
Provides the status of the specified transcription job.
\nIf the status is COMPLETED, the job is finished and you can find the\n results at the location specified in TranscriptFileUri (or\n RedactedTranscriptFileUri, if you requested transcript redaction). If\n the status is FAILED, FailureReason provides details on why\n your transcription job failed.
The date and time the specified transcription job began processing.
\nTimestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.789000-07:00 represents a transcription job\n that started processing at 12:32 PM UTC-7 on May 4, 2022.
The date and time the specified transcription job began processing.
\nTimestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.789000-07:00 represents a transcription job\n that started processing at 12:32 PM UTC-7 on May 4, 2022.
The date and time the specified transcription job request was made.
\nTimestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.761000-07:00 represents a transcription job\n that started processing at 12:32 PM UTC-7 on May 4, 2022.
The date and time the specified transcription job request was made.
\nTimestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.761000-07:00 represents a transcription job\n that started processing at 12:32 PM UTC-7 on May 4, 2022.
The date and time the specified transcription job finished processing.
\nTimestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:33:13.922000-07:00 represents a transcription job\n that started processing at 12:33 PM UTC-7 on May 4, 2022.
The date and time the specified transcription job finished processing.
\nTimestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:33:13.922000-07:00 represents a transcription job\n that started processing at 12:33 PM UTC-7 on May 4, 2022.
If TranscriptionJobStatus is FAILED,\n FailureReason contains information about why the transcription job\n request failed.
The FailureReason field contains one of the following values:
\n Unsupported media format.
The media format specified in MediaFormat isn't valid. Refer to\n MediaFormat for a list of supported\n formats.
\n The media format provided does not match the detected media\n format.
The media format specified in MediaFormat doesn't match the\n format of the input file. Check the media format of your media file and correct\n the specified value.
\n Invalid sample rate for audio file.
The sample rate specified in MediaSampleRateHertz isn't valid.\n The sample rate must be between 8,000 and 48,000 hertz.
\n The sample rate provided does not match the detected sample\n rate.
The sample rate specified in MediaSampleRateHertz doesn't match\n the sample rate detected in your input media file. Check the sample rate of your\n media file and correct the specified value.
\n Invalid file size: file size too large.
The size of your media file is larger than what Amazon Transcribe can\n process. For more information, refer to Guidelines and\n quotas.
\n\n Invalid number of channels: number of channels too large.
Your audio contains more channels than Amazon Transcribe is able to process.\n For more information, refer to Guidelines and\n quotas.
\nIf TranscriptionJobStatus is FAILED,\n FailureReason contains information about why the transcription job\n request failed.
The FailureReason field contains one of the following values:
\n Unsupported media format.
The media format specified in MediaFormat isn't valid. Refer to\n MediaFormat for a list of supported\n formats.
\n The media format provided does not match the detected media\n format.
The media format specified in MediaFormat doesn't match the\n format of the input file. Check the media format of your media file and correct\n the specified value.
\n Invalid sample rate for audio file.
The sample rate specified in MediaSampleRateHertz isn't valid.\n The sample rate must be between 8,000 and 48,000 hertz.
\n The sample rate provided does not match the detected sample\n rate.
The sample rate specified in MediaSampleRateHertz doesn't match\n the sample rate detected in your input media file. Check the sample rate of your\n media file and correct the specified value.
\n Invalid file size: file size too large.
The size of your media file is larger than what Amazon Transcribe can\n process. For more information, refer to Guidelines and\n quotas.
\n\n Invalid number of channels: number of channels too large.
Your audio contains more channels than Amazon Transcribe is able to process.\n For more information, refer to Guidelines and\n quotas.
\nThe confidence score associated with the language identified in your media\n file.
\nConfidence scores are values between 0 and 1; a larger value indicates a higher\n probability that the identified language correctly matches the language spoken in your\n media.
" + "smithy.api#documentation": "The confidence score associated with the language identified in your media\n file.
\nConfidence scores are values between 0 and 1; a larger value indicates a higher\n probability that the identified language correctly matches the language spoken in your\n media.
" } }, "LanguageCodes": { @@ -6713,7 +6716,7 @@ } }, "traits": { - "smithy.api#documentation": "Provides detailed information about a transcription job.
\nTo view the status of the specified transcription job, check the\n TranscriptionJobStatus field. If the status is COMPLETED,\n the job is finished and you can find the results at the location specified in\n TranscriptFileUri. If the status is FAILED,\n FailureReason provides details on why your transcription job\n failed.
If you enabled content redaction, the redacted transcript can be found at the location\n specified in RedactedTranscriptFileUri.
Provides detailed information about a transcription job.
\nTo view the status of the specified transcription job, check the\n TranscriptionJobStatus field. If the status is COMPLETED,\n the job is finished and you can find the results at the location specified in\n TranscriptFileUri. If the status is FAILED,\n FailureReason provides details on why your transcription job\n failed.
If you enabled content redaction, the redacted transcript can be found at the location\n specified in RedactedTranscriptFileUri.
The date and time the specified transcription job request was made.
\nTimestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.761000-07:00 represents a transcription job\n that started processing at 12:32 PM UTC-7 on May 4, 2022.
The date and time the specified transcription job request was made.
\nTimestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.761000-07:00 represents a transcription job\n that started processing at 12:32 PM UTC-7 on May 4, 2022.
The date and time your transcription job began processing.
\nTimestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.789000-07:00 represents a transcription job\n that started processing at 12:32 PM UTC-7 on May 4, 2022.
The date and time your transcription job began processing.
\nTimestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.789000-07:00 represents a transcription job\n that started processing at 12:32 PM UTC-7 on May 4, 2022.
The date and time the specified transcription job finished processing.
\nTimestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:33:13.922000-07:00 represents a transcription job\n that started processing at 12:33 PM UTC-7 on May 4, 2022.
The date and time the specified transcription job finished processing.
\nTimestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:33:13.922000-07:00 represents a transcription job\n that started processing at 12:33 PM UTC-7 on May 4, 2022.
Provides the status of your transcription job.
\nIf the status is COMPLETED, the job is finished and you can find the\n results at the location specified in TranscriptFileUri (or\n RedactedTranscriptFileUri, if you requested transcript redaction). If\n the status is FAILED, FailureReason provides details on why\n your transcription job failed.
Provides the status of your transcription job.
\nIf the status is COMPLETED, the job is finished and you can find the\n results at the location specified in TranscriptFileUri (or\n RedactedTranscriptFileUri, if you requested transcript redaction). If\n the status is FAILED, FailureReason provides details on why\n your transcription job failed.
Indicates where the specified transcription output is stored.
\nIf the value is CUSTOMER_BUCKET, the location is the Amazon S3\n bucket you specified using the OutputBucketName parameter in your request. If you also included\n OutputKey in your request, your output is located in the path you\n specified in your request.
If the value is SERVICE_BUCKET, the location is a service-managed Amazon S3 bucket. To access a transcript stored in a service-managed bucket, use the\n URI shown in the TranscriptFileUri or\n RedactedTranscriptFileUri field.
Indicates where the specified transcription output is stored.
\nIf the value is CUSTOMER_BUCKET, the location is the Amazon S3\n bucket you specified using the OutputBucketName parameter in your request. If you also included\n OutputKey in your request, your output is located in the path you\n specified in your request.
If the value is SERVICE_BUCKET, the location is a service-managed Amazon S3 bucket. To access a transcript stored in a service-managed bucket, use the\n URI shown in the TranscriptFileUri or\n RedactedTranscriptFileUri field.
The confidence score associated with the language identified in your media\n file.
\nConfidence scores are values between 0 and 1; a larger value indicates a higher\n probability that the identified language correctly matches the language spoken in your\n media.
" + "smithy.api#documentation": "The confidence score associated with the language identified in your media\n file.
\nConfidence scores are values between 0 and 1; a larger value indicates a higher\n probability that the identified language correctly matches the language spoken in your\n media.
" } }, "LanguageCodes": { @@ -6893,7 +6896,7 @@ } ], "traits": { - "smithy.api#documentation": "Removes the specified tags from the specified Amazon Transcribe resource.
\nIf you include UntagResource in your request, you must also include\n ResourceArn and TagKeys.
Removes the specified tags from the specified Amazon Transcribe resource.
\nIf you include UntagResource in your request, you must also include\n ResourceArn and TagKeys.
The Amazon Resource Name (ARN) of the Amazon Transcribe resource you want to remove\n tags from. ARNs have the format\n arn:partition:service:region:account-id:resource-type/resource-id.
For example,\n arn:aws:transcribe:us-west-2:111122223333:transcription-job/transcription-job-name.
Valid values for resource-type are: transcription-job,\n medical-transcription-job, vocabulary,\n medical-vocabulary, vocabulary-filter, and\n language-model.
The Amazon Resource Name (ARN) of the Amazon Transcribe resource you want to remove\n tags from. ARNs have the format\n arn:partition:service:region:account-id:resource-type/resource-id.
For example,\n arn:aws:transcribe:us-west-2:111122223333:transcription-job/transcription-job-name.
Valid values for resource-type are: transcription-job,\n medical-transcription-job, vocabulary,\n medical-vocabulary, vocabulary-filter, and\n language-model.
Updates the specified Call Analytics category with new rules. Note that the\n UpdateCallAnalyticsCategory operation overwrites all existing rules\n contained in the specified category. You cannot append additional rules onto an existing\n category.
To create a new category, see .
", + "smithy.api#documentation": "Updates the specified Call Analytics category with new rules. Note that the\n UpdateCallAnalyticsCategory operation overwrites all existing rules\n contained in the specified category. You cannot append additional rules onto an existing\n category.
To create a new category, see .
", "smithy.api#http": { "method": "PATCH", "uri": "/callanalyticscategories/{CategoryName}", @@ -7051,7 +7054,7 @@ "VocabularyFileUri": { "target": "com.amazonaws.transcribe#Uri", "traits": { - "smithy.api#documentation": "The Amazon S3 location of the text file that contains your custom medical\n vocabulary. The URI must be located in the same Amazon Web Services Region as the\n resource you're calling.
\nHere's an example URI path:\n s3://DOC-EXAMPLE-BUCKET/my-vocab-file.txt\n
The Amazon S3 location of the text file that contains your custom medical\n vocabulary. The URI must be located in the same Amazon Web Services Region as the\n resource you're calling.
\nHere's an example URI path:\n s3://DOC-EXAMPLE-BUCKET/my-vocab-file.txt\n
The date and time the specified custom medical vocabulary was last updated.
\nTimestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May\n 4, 2022.
The date and time the specified custom medical vocabulary was last updated.
\nTimestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May\n 4, 2022.
Use this parameter if you want to update your custom vocabulary filter by including\n all desired terms, as comma-separated values, within your request. The other option for\n updating your vocabulary filter is to save your entries in a text file and upload them\n to an Amazon S3 bucket, then specify the location of your file using the\n VocabularyFilterFileUri parameter.
Note that if you include Words in your request, you cannot use\n VocabularyFilterFileUri; you must choose one or the other.
Each language has a character set that contains all allowed characters for that\n specific language. If you use unsupported characters, your custom vocabulary filter\n request fails. Refer to Character Sets for Custom\n Vocabularies to get the character set for your language.
" + "smithy.api#documentation": "Use this parameter if you want to update your custom vocabulary filter by including\n all desired terms, as comma-separated values, within your request. The other option for\n updating your vocabulary filter is to save your entries in a text file and upload them\n to an Amazon S3 bucket, then specify the location of your file using the\n VocabularyFilterFileUri parameter.
Note that if you include Words in your request, you cannot use\n VocabularyFilterFileUri; you must choose one or the other.
Each language has a character set that contains all allowed characters for that\n specific language. If you use unsupported characters, your custom vocabulary filter\n request fails. Refer to Character Sets for Custom\n Vocabularies to get the character set for your language.
" } }, "VocabularyFilterFileUri": { "target": "com.amazonaws.transcribe#Uri", "traits": { - "smithy.api#documentation": "The Amazon S3 location of the text file that contains your custom vocabulary\n filter terms. The URI must be located in the same Amazon Web Services Region as the\n resource you're calling.
\nHere's an example URI path:\n s3://DOC-EXAMPLE-BUCKET/my-vocab-filter-file.txt\n
Note that if you include VocabularyFilterFileUri in your request, you\n cannot use Words; you must choose one or the other.
The Amazon S3 location of the text file that contains your custom vocabulary\n filter terms. The URI must be located in the same Amazon Web Services Region as the\n resource you're calling.
\nHere's an example URI path:\n s3://DOC-EXAMPLE-BUCKET/my-vocab-filter-file.txt\n
Note that if you include VocabularyFilterFileUri in your request, you\n cannot use Words; you must choose one or the other.
The date and time the specified custom vocabulary filter was last updated.
\nTimestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May\n 4, 2022.
The date and time the specified custom vocabulary filter was last updated.
\nTimestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May\n 4, 2022.
The language code that represents the language of the entries in the custom vocabulary\n you want to update. Each custom vocabulary must contain terms in only one\n language.
\nA custom vocabulary can only be used to transcribe files in the same language as the\n custom vocabulary. For example, if you create a custom vocabulary using US English\n (en-US), you can only apply this custom vocabulary to files that\n contain English audio.
For a list of supported languages and their associated language codes, refer to the\n Supported languages table.
", + "smithy.api#documentation": "The language code that represents the language of the entries in the custom vocabulary\n you want to update. Each custom vocabulary must contain terms in only one\n language.
\nA custom vocabulary can only be used to transcribe files in the same language as the\n custom vocabulary. For example, if you create a custom vocabulary using US English\n (en-US), you can only apply this custom vocabulary to files that\n contain English audio.
For a list of supported languages and their associated language codes, refer to the\n Supported languages table.
", "smithy.api#required": {} } }, "Phrases": { "target": "com.amazonaws.transcribe#Phrases", "traits": { - "smithy.api#documentation": "Use this parameter if you want to update your custom vocabulary by including all\n desired terms, as comma-separated values, within your request. The other option for\n updating your custom vocabulary is to save your entries in a text file and upload them\n to an Amazon S3 bucket, then specify the location of your file using the\n VocabularyFileUri parameter.
Note that if you include Phrases in your request, you cannot use\n VocabularyFileUri; you must choose one or the other.
Each language has a character set that contains all allowed characters for that\n specific language. If you use unsupported characters, your custom vocabulary filter\n request fails. Refer to Character Sets for Custom\n Vocabularies to get the character set for your language.
" + "smithy.api#documentation": "Use this parameter if you want to update your custom vocabulary by including all\n desired terms, as comma-separated values, within your request. The other option for\n updating your custom vocabulary is to save your entries in a text file and upload them\n to an Amazon S3 bucket, then specify the location of your file using the\n VocabularyFileUri parameter.
Note that if you include Phrases in your request, you cannot use\n VocabularyFileUri; you must choose one or the other.
Each language has a character set that contains all allowed characters for that\n specific language. If you use unsupported characters, your custom vocabulary filter\n request fails. Refer to Character Sets for Custom\n Vocabularies to get the character set for your language.
" } }, "VocabularyFileUri": { "target": "com.amazonaws.transcribe#Uri", "traits": { - "smithy.api#documentation": "The Amazon S3 location of the text file that contains your custom vocabulary.\n The URI must be located in the same Amazon Web Services Region as the resource you're\n calling.
\nHere's an example URI path:\n s3://DOC-EXAMPLE-BUCKET/my-vocab-file.txt\n
Note that if you include VocabularyFileUri in your request, you cannot\n use the Phrases flag; you must choose one or the other.
The Amazon S3 location of the text file that contains your custom vocabulary.\n The URI must be located in the same Amazon Web Services Region as the resource you're\n calling.
\nHere's an example URI path:\n s3://DOC-EXAMPLE-BUCKET/my-vocab-file.txt\n
Note that if you include VocabularyFileUri in your request, you cannot\n use the Phrases flag; you must choose one or the other.
The date and time the specified custom vocabulary was last updated.
\nTimestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May\n 4, 2022.
The date and time the specified custom vocabulary was last updated.
\nTimestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May\n 4, 2022.
The language code that represents the language of the entries in your vocabulary\n filter. Each custom vocabulary filter must contain terms in only one language.
\nA custom vocabulary filter can only be used to transcribe files in the same language\n as the filter. For example, if you create a custom vocabulary filter using US English\n (en-US), you can only apply this filter to files that contain English\n audio.
For a list of supported languages and their associated language codes, refer to the\n Supported languages table.
" + "smithy.api#documentation": "The language code that represents the language of the entries in your vocabulary\n filter. Each custom vocabulary filter must contain terms in only one language.
\nA custom vocabulary filter can only be used to transcribe files in the same language\n as the filter. For example, if you create a custom vocabulary filter using US English\n (en-US), you can only apply this filter to files that contain English\n audio.
For a list of supported languages and their associated language codes, refer to the\n Supported languages table.
" } }, "LastModifiedTime": { "target": "com.amazonaws.transcribe#DateTime", "traits": { - "smithy.api#documentation": "The date and time the specified custom vocabulary filter was last modified.
\nTimestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May\n 4, 2022.
The date and time the specified custom vocabulary filter was last modified.
\nTimestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May\n 4, 2022.
The language code used to create your custom vocabulary. Each custom vocabulary must\n contain terms in only one language.
\nA custom vocabulary can only be used to transcribe files in the same language as the\n custom vocabulary. For example, if you create a custom vocabulary using US English\n (en-US), you can only apply this custom vocabulary to files that\n contain English audio.
The language code used to create your custom vocabulary. Each custom vocabulary must\n contain terms in only one language.
\nA custom vocabulary can only be used to transcribe files in the same language as the\n custom vocabulary. For example, if you create a custom vocabulary using US English\n (en-US), you can only apply this custom vocabulary to files that\n contain English audio.
The date and time the specified custom vocabulary was last modified.
\nTimestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May\n 4, 2022.
The date and time the specified custom vocabulary was last modified.
\nTimestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May\n 4, 2022.