A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If not provided, the Amazon Web Services\n SDK populates this field. For more information about idempotency, see\n Making retries safe with idempotent APIs.
", + "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If not provided, the Amazon Web Services\n SDK populates this field. For more information about idempotency, see\n Making retries safe with idempotent APIs.
\nPattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$\n
Creates\n a traffic distribution group given an Amazon Connect instance that has been replicated.
\nFor more information about creating traffic distribution groups, see Set up traffic distribution groups in\n the Amazon Connect Administrator Guide.
", + "smithy.api#documentation": "Creates a traffic distribution group given an Amazon Connect instance that has been replicated.
\nFor more information about creating traffic distribution groups, see Set up traffic distribution groups in\n the Amazon Connect Administrator Guide.
", "smithy.api#http": { "method": "PUT", "uri": "/traffic-distribution-group", @@ -8686,6 +8686,24 @@ "traits": { "smithy.api#documentation": "The credentials to use for federation.
" } + }, + "SignInUrl": { + "target": "com.amazonaws.connect#Url", + "traits": { + "smithy.api#documentation": "The URL to sign into the user's instance.
" + } + }, + "UserArn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the user.
" + } + }, + "UserId": { + "target": "com.amazonaws.connect#AgentResourceId", + "traits": { + "smithy.api#documentation": "The identifier for the user.
" + } } } }, @@ -16391,7 +16409,7 @@ "InstanceId": { "target": "com.amazonaws.connect#InstanceIdOrArn", "traits": { - "smithy.api#documentation": "The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
", + "smithy.api#documentation": "The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance. You can provide the InstanceId, or the entire ARN.
Welcome to the Amazon Connect Cases API Reference. This guide provides information about the\n Amazon Connect Cases API, which you can use to create, update, get, and list Cases domains,\n fields, field options, layouts, templates, cases, related items, and tags.
\n\nFor more information about Amazon Connect Cases, see Amazon Connect Cases in the\n Amazon Connect Administrator Guide.
", - "smithy.api#title": "Amazon Connect Cases" + "smithy.api#title": "Amazon Connect Cases", + "smithy.rules#endpointRuleSet": { + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "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" + } + ] + }, + { + "fn": "parseURL", + "argv": [ + { + "ref": "Endpoint" + } + ], + "assign": "url" + } + ], + "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://cases-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": [], + "endpoint": { + "url": "https://cases-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://cases.{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://cases.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://cases-fips.us-gov-east-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "us-gov-east-1" + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://cases-fips.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "us-gov-east-1" + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://cases.us-gov-east-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "us-gov-east-1" + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://cases.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "us-gov-east-1" + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://cases-fips.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "cn-north-1" + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://cases-fips.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "cn-north-1" + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://cases.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "cn-north-1" + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://cases.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "cn-north-1" + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "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" + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://cases-fips.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "us-iso-east-1" + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "us-iso-east-1" + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://cases.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "us-iso-east-1" + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://cases-fips.us-east-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "us-east-1" + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://cases-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "us-east-1" + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://cases.us-east-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "us-east-1" + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://cases.us-east-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "us-east-1" + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "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" + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://cases-fips.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "us-isob-east-1" + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "us-isob-east-1" + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://cases.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "us-isob-east-1" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": 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": { + "UseDualStack": false, + "UseFIPS": true, + "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": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "us-east-1", + "Endpoint": "https://example.com" + } + } + ], + "version": "1.0" + } } }, "com.amazonaws.connectcases#Arn": { @@ -648,7 +1252,7 @@ "clientToken": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request.
", + "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If not provided, the Amazon Web Services\n SDK populates this field. For more information about idempotency, see\n Making retries safe with idempotent APIs.
", "smithy.api#idempotencyToken": {}, "smithy.api#length": { "max": 64 @@ -1051,7 +1655,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a template in the Cases domain. This template is used to define the case\n object model (that is, define what data can be captured on cases) in a Cases domain. A\n template must have a unique name within a domain, and it must reference existing field IDs and layout\n IDs. Additionally, multiple fields with same IDs are not allowed within the same Template.
", + "smithy.api#documentation": "Creates a template in the Cases domain. This template is used to define the case object\n model (that is, to define what data can be captured on cases) in a Cases domain. A template\n must have a unique name within a domain, and it must reference existing field IDs and layout\n IDs. Additionally, multiple fields with same IDs are not allowed within the same Template. A\n template can be either Active or Inactive, as indicated by its status. Inactive templates\n cannot be used to create cases.
", "smithy.api#http": { "uri": "/domains/{domainId}/templates", "method": "POST" @@ -1094,6 +1698,12 @@ "traits": { "smithy.api#documentation": "A list of fields that must contain a value for a case to be successfully created with this\n template.
" } + }, + "status": { + "target": "com.amazonaws.connectcases#TemplateStatus", + "traits": { + "smithy.api#documentation": "The status of the template.
" + } } } }, @@ -1419,7 +2029,7 @@ "traits": { "smithy.api#documentation": "Represents an ordered list containing field related information.
", "smithy.api#length": { - "max": 30 + "max": 100 }, "smithy.api#required": {} } @@ -2241,6 +2851,13 @@ "traits": { "smithy.api#documentation": "A map of of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this resource.
" } + }, + "status": { + "target": "com.amazonaws.connectcases#TemplateStatus", + "traits": { + "smithy.api#documentation": "The status of the template.
", + "smithy.api#required": {} + } } } }, @@ -2360,7 +2977,7 @@ } }, "traits": { - "smithy.api#documentation": "Ordered list containing different kinds of sections that can be added. A LayoutSections object can only contain one section.
" + "smithy.api#documentation": "Ordered list containing different kinds of sections that can be added. A LayoutSections\n object can only contain one section.
" } }, "com.amazonaws.connectcases#LayoutSummary": { @@ -2963,6 +3580,13 @@ "smithy.api#documentation": "The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.
", "smithy.api#httpQuery": "nextToken" } + }, + "status": { + "target": "com.amazonaws.connectcases#TemplateStatusFilters", + "traits": { + "smithy.api#documentation": "A list of status values to filter on.
", + "smithy.api#httpQuery": "status" + } } } }, @@ -3831,6 +4455,36 @@ "smithy.api#pattern": "^.*[\\S]$" } }, + "com.amazonaws.connectcases#TemplateStatus": { + "type": "string", + "traits": { + "smithy.api#documentation": "Status of a template", + "smithy.api#enum": [ + { + "value": "Active", + "name": "ACTIVE" + }, + { + "value": "Inactive", + "name": "INACTIVE" + } + ] + } + }, + "com.amazonaws.connectcases#TemplateStatusFilters": { + "type": "list", + "member": { + "target": "com.amazonaws.connectcases#TemplateStatus" + }, + "traits": { + "smithy.api#documentation": "List of filters used on the ListTemplates result set", + "smithy.api#length": { + "min": 1, + "max": 2 + }, + "smithy.api#uniqueItems": {} + } + }, "com.amazonaws.connectcases#TemplateSummary": { "type": "structure", "members": { @@ -3844,7 +4498,7 @@ "templateArn": { "target": "com.amazonaws.connectcases#TemplateArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the template.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the template.
", "smithy.api#required": {} } }, @@ -3854,6 +4508,13 @@ "smithy.api#documentation": "The template name.
", "smithy.api#required": {} } + }, + "status": { + "target": "com.amazonaws.connectcases#TemplateStatus", + "traits": { + "smithy.api#documentation": "The status of the template.
", + "smithy.api#required": {} + } } }, "traits": { @@ -3964,7 +4625,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates the values of fields on a case. Fields to be updated are\n received as an array of id/value pairs identical to the CreateCase input .
If the action is successful, the service sends back an HTTP 200 response with an empty\n HTTP body.
", + "smithy.api#documentation": "Updates the values of fields on a case. Fields to be updated are received as an array of\n id/value pairs identical to the CreateCase input .
If the action is successful, the service sends back an HTTP 200 response with an empty\n HTTP body.
", "smithy.api#http": { "uri": "/domains/{domainId}/cases/{caseId}", "method": "PUT" @@ -4101,6 +4762,9 @@ { "target": "com.amazonaws.connectcases#ResourceNotFoundException" }, + { + "target": "com.amazonaws.connectcases#ServiceQuotaExceededException" + }, { "target": "com.amazonaws.connectcases#ThrottlingException" }, @@ -4183,7 +4847,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates the attributes of an existing template. The template attributes that can be\n modified include name, description, layouts,\n and requiredFields. At least one of these\n attributes must not be null. If a null value is provided for a given attribute, that attribute\n is ignored and its current value is preserved.
Updates the attributes of an existing template. The template attributes that can be\n modified include name, description,\n layoutConfiguration, requiredFields, and status. At\n least one of these attributes must not be null. If a null value is provided for a given\n attribute, that attribute is ignored and its current value is preserved.
A list of fields that must contain a value for a case to be successfully created with this\n template.
" } + }, + "status": { + "target": "com.amazonaws.connectcases#TemplateStatus", + "traits": { + "smithy.api#documentation": "The status of the template.
" + } } } }, diff --git a/codegen/sdk-codegen/aws-models/ec2.json b/codegen/sdk-codegen/aws-models/ec2.json index a3be5255eaa..ab869e0f7e1 100644 --- a/codegen/sdk-codegen/aws-models/ec2.json +++ b/codegen/sdk-codegen/aws-models/ec2.json @@ -6345,6 +6345,12 @@ "traits": { "smithy.api#enumValue": "x86_64_mac" } + }, + "arm64_mac": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "arm64_mac" + } } } }, @@ -6398,6 +6404,12 @@ "traits": { "smithy.api#enumValue": "x86_64_mac" } + }, + "arm64_mac": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "arm64_mac" + } } } }, @@ -55611,6 +55623,30 @@ "traits": { "smithy.api#enumValue": "u-3tb1.56xlarge" } + }, + "u_18tb1_112xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "u-18tb1.112xlarge" + } + }, + "u_24tb1_112xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "u-24tb1.112xlarge" + } + }, + "trn1_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "trn1.2xlarge" + } + }, + "trn1_32xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "trn1.32xlarge" + } } } }, diff --git a/codegen/sdk-codegen/aws-models/groundstation.json b/codegen/sdk-codegen/aws-models/groundstation.json index 9fe4f04b6e2..615d64cd552 100644 --- a/codegen/sdk-codegen/aws-models/groundstation.json +++ b/codegen/sdk-codegen/aws-models/groundstation.json @@ -1,6 +1,16 @@ { - "smithy": "1.0", + "smithy": "2.0", "shapes": { + "com.amazonaws.groundstation#AWSRegion": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[\\w-]+$" + } + }, "com.amazonaws.groundstation#AngleUnits": { "type": "string", "traits": { @@ -102,6 +112,16 @@ "smithy.api#documentation": "Information about the uplink Config of an antenna.
Cancels a contact with a specified contact ID.
", "smithy.api#http": { "method": "DELETE", - "uri": "/contact/{contactId}", - "code": 200 + "uri": "/contact/{contactId}" }, "smithy.api#idempotent": {} } @@ -162,7 +181,7 @@ "type": "structure", "members": { "contactId": { - "target": "smithy.api#String", + "target": "com.amazonaws.groundstation#Uuid", "traits": { "smithy.api#documentation": "UUID of a contact.
", "smithy.api#httpLabel": {}, @@ -178,7 +197,7 @@ "type": "resource", "identifiers": { "configId": { - "target": "smithy.api#String" + "target": "com.amazonaws.groundstation#Uuid" }, "configType": { "target": "com.amazonaws.groundstation#ConfigCapabilityType" @@ -201,10 +220,7 @@ }, "traits": { "aws.api#arn": { - "template": "config/{configType}/{configId}", - "absolute": false, - "noAccount": false, - "noRegion": false + "template": "config/{configType}/{configId}" } } }, @@ -213,8 +229,8 @@ "traits": { "aws.api#arnReference": { "type": "AWS::GroundStation::Config", - "service": "com.amazonaws.groundstation#GroundStation", - "resource": "com.amazonaws.groundstation#Config" + "service": "GroundStation", + "resource": "Config" } } }, @@ -394,7 +410,7 @@ "type": "resource", "identifiers": { "contactId": { - "target": "smithy.api#String" + "target": "com.amazonaws.groundstation#Uuid" } }, "create": { @@ -411,10 +427,7 @@ }, "traits": { "aws.api#arn": { - "template": "contact/{contactId}", - "absolute": false, - "noAccount": false, - "noRegion": false + "template": "contact/{contactId}" } } }, @@ -422,7 +435,7 @@ "type": "structure", "members": { "contactId": { - "target": "smithy.api#String", + "target": "com.amazonaws.groundstation#Uuid", "traits": { "smithy.api#documentation": "UUID of a contact.
" } @@ -442,13 +455,13 @@ "startTime": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "Start time of a contact.
" + "smithy.api#documentation": "Start time of a contact in UTC.
" } }, "endTime": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "End time of a contact.
" + "smithy.api#documentation": "End time of a contact in UTC.
" } }, "prePassStartTime": { @@ -513,7 +526,7 @@ "type": "structure", "members": { "contactId": { - "target": "smithy.api#String", + "target": "com.amazonaws.groundstation#Uuid", "traits": { "smithy.api#documentation": "UUID of a contact.
" } @@ -614,8 +627,7 @@ "smithy.api#documentation": "Creates a Config with the specified configData parameters.
Only one type of configData can be specified.
Creates a DataflowEndpoint group containing the specified list of DataflowEndpoint objects.
The name field in each endpoint is used in your mission profile DataflowEndpointConfig \n to specify which endpoints to use during a contact.
When a contact uses multiple DataflowEndpointConfig objects, each Config \n must match a DataflowEndpoint in the same group.
Creates an Ephemeris with the specified EphemerisData.
AWS Ground Station satellite ID for this ephemeris.
", + "smithy.api#required": {} + } + }, + "enabled": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "Whether to set the ephemeris status to ENABLED after validation.
Setting this to false will set the ephemeris status to DISABLED after validation.
Customer-provided priority score to establish the order in which overlapping ephemerides should be used.
\nThe default for customer-provided ephemeris priority is 1, and higher numbers take precedence.
\nPriority must be 1 or greater
" + } + }, + "expirationTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "An overall expiration time for the ephemeris in UTC, after which it will become EXPIRED.
A name string associated with the ephemeris. Used as a human-readable identifier for the ephemeris.
", + "smithy.api#required": {} + } + }, + "kmsKeyArn": { + "target": "com.amazonaws.groundstation#KeyArn", + "traits": { + "smithy.api#documentation": "The ARN of a KMS key used to encrypt the ephemeris in Ground Station.
" + } + }, + "ephemeris": { + "target": "com.amazonaws.groundstation#EphemerisData", + "traits": { + "smithy.api#documentation": "Ephemeris data.
" + } + }, + "tags": { + "target": "com.amazonaws.groundstation#TagsMap", + "traits": { + "smithy.api#documentation": "Tags assigned to an ephemeris.
" + } + } + } + }, "com.amazonaws.groundstation#CreateMissionProfile": { "type": "operation", "input": { @@ -719,8 +813,7 @@ "smithy.api#documentation": "Creates a mission profile.
\n\n dataflowEdges is a list of lists of strings. Each lower level list of strings\n has two elements: a from ARN and a to ARN.
Smallest amount of time in seconds that you’d like to see for an available contact. AWS Ground Station will not present you with contacts shorter than this duration.
", "smithy.api#required": {} @@ -797,6 +890,15 @@ ] } }, + "com.amazonaws.groundstation#CustomerEphemerisPriority": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 99999 + } + } + }, "com.amazonaws.groundstation#DataflowDetail": { "type": "structure", "members": { @@ -833,6 +935,12 @@ "type": "list", "member": { "target": "com.amazonaws.groundstation#DataflowEdge" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 500 + } } }, "com.amazonaws.groundstation#DataflowEndpoint": { @@ -896,7 +1004,7 @@ "type": "resource", "identifiers": { "dataflowEndpointGroupId": { - "target": "smithy.api#String" + "target": "com.amazonaws.groundstation#Uuid" } }, "create": { @@ -913,10 +1021,7 @@ }, "traits": { "aws.api#arn": { - "template": "dataflow-endpoint-group/{dataflowEndpointGroupId}", - "absolute": false, - "noAccount": false, - "noRegion": false + "template": "dataflow-endpoint-group/{dataflowEndpointGroupId}" } } }, @@ -925,8 +1030,8 @@ "traits": { "aws.api#arnReference": { "type": "AWS::GroundStation::DataflowEndpointGroup", - "service": "com.amazonaws.groundstation#GroundStation", - "resource": "com.amazonaws.groundstation#DataflowEndpointGroup" + "service": "GroundStation", + "resource": "DataflowEndpointGroup" } } }, @@ -934,7 +1039,7 @@ "type": "structure", "members": { "dataflowEndpointGroupId": { - "target": "smithy.api#String", + "target": "com.amazonaws.groundstation#Uuid", "traits": { "smithy.api#documentation": "UUID of a dataflow endpoint group.
" } @@ -954,7 +1059,7 @@ "type": "structure", "members": { "dataflowEndpointGroupId": { - "target": "smithy.api#String", + "target": "com.amazonaws.groundstation#Uuid", "traits": { "smithy.api#documentation": "UUID of a dataflow endpoint group.
" } @@ -1014,8 +1119,7 @@ "smithy.api#documentation": "Deletes a Config.
UUID of a Config.
Deletes a dataflow endpoint group.
", "smithy.api#http": { "method": "DELETE", - "uri": "/dataflowEndpointGroup/{dataflowEndpointGroupId}", - "code": 200 + "uri": "/dataflowEndpointGroup/{dataflowEndpointGroupId}" }, "smithy.api#idempotent": {} } @@ -1077,7 +1180,7 @@ "type": "structure", "members": { "dataflowEndpointGroupId": { - "target": "smithy.api#String", + "target": "com.amazonaws.groundstation#Uuid", "traits": { "smithy.api#documentation": "UUID of a dataflow endpoint group.
", "smithy.api#httpLabel": {}, @@ -1089,6 +1192,47 @@ "smithy.api#documentation": "" } }, + "com.amazonaws.groundstation#DeleteEphemeris": { + "type": "operation", + "input": { + "target": "com.amazonaws.groundstation#DeleteEphemerisRequest" + }, + "output": { + "target": "com.amazonaws.groundstation#EphemerisIdResponse" + }, + "errors": [ + { + "target": "com.amazonaws.groundstation#DependencyException" + }, + { + "target": "com.amazonaws.groundstation#InvalidParameterException" + }, + { + "target": "com.amazonaws.groundstation#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes an ephemeris
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/ephemeris/{ephemerisId}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.groundstation#DeleteEphemerisRequest": { + "type": "structure", + "members": { + "ephemerisId": { + "target": "com.amazonaws.groundstation#Uuid", + "traits": { + "smithy.api#documentation": "The AWS Ground Station ephemeris ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, "com.amazonaws.groundstation#DeleteMissionProfile": { "type": "operation", "input": { @@ -1112,8 +1256,7 @@ "smithy.api#documentation": "Deletes a mission profile.
", "smithy.api#http": { "method": "DELETE", - "uri": "/missionprofile/{missionProfileId}", - "code": 200 + "uri": "/missionprofile/{missionProfileId}" }, "smithy.api#idempotent": {} } @@ -1122,7 +1265,7 @@ "type": "structure", "members": { "missionProfileId": { - "target": "smithy.api#String", + "target": "com.amazonaws.groundstation#Uuid", "traits": { "smithy.api#documentation": "UUID of a mission profile.
", "smithy.api#httpLabel": {}, @@ -1191,8 +1334,7 @@ "smithy.api#documentation": "Describes an existing contact.
", "smithy.api#http": { "method": "GET", - "uri": "/contact/{contactId}", - "code": 200 + "uri": "/contact/{contactId}" }, "smithy.api#readonly": {} } @@ -1201,7 +1343,7 @@ "type": "structure", "members": { "contactId": { - "target": "smithy.api#String", + "target": "com.amazonaws.groundstation#Uuid", "traits": { "smithy.api#documentation": "UUID of a contact.
", "smithy.api#httpLabel": {}, @@ -1217,7 +1359,7 @@ "type": "structure", "members": { "contactId": { - "target": "smithy.api#String", + "target": "com.amazonaws.groundstation#Uuid", "traits": { "smithy.api#documentation": "UUID of a contact.
" } @@ -1237,13 +1379,13 @@ "startTime": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "Start time of a contact.
" + "smithy.api#documentation": "Start time of a contact in UTC.
" } }, "endTime": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "End time of a contact.
" + "smithy.api#documentation": "End time of a contact in UTC.
" } }, "prePassStartTime": { @@ -1310,6 +1452,120 @@ ] } }, + "com.amazonaws.groundstation#DescribeEphemeris": { + "type": "operation", + "input": { + "target": "com.amazonaws.groundstation#DescribeEphemerisRequest" + }, + "output": { + "target": "com.amazonaws.groundstation#DescribeEphemerisResponse" + }, + "errors": [ + { + "target": "com.amazonaws.groundstation#DependencyException" + }, + { + "target": "com.amazonaws.groundstation#InvalidParameterException" + }, + { + "target": "com.amazonaws.groundstation#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Describes an existing ephemeris.
", + "smithy.api#http": { + "method": "GET", + "uri": "/ephemeris/{ephemerisId}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.groundstation#DescribeEphemerisRequest": { + "type": "structure", + "members": { + "ephemerisId": { + "target": "com.amazonaws.groundstation#Uuid", + "traits": { + "smithy.api#documentation": "The AWS Ground Station ephemeris ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.groundstation#DescribeEphemerisResponse": { + "type": "structure", + "members": { + "ephemerisId": { + "target": "com.amazonaws.groundstation#Uuid", + "traits": { + "smithy.api#documentation": "The AWS Ground Station ephemeris ID.
" + } + }, + "satelliteId": { + "target": "com.amazonaws.groundstation#Uuid", + "traits": { + "smithy.api#documentation": "The AWS Ground Station satellite ID associated with ephemeris.
" + } + }, + "status": { + "target": "com.amazonaws.groundstation#EphemerisStatus", + "traits": { + "smithy.api#documentation": "The status of the ephemeris.
" + } + }, + "priority": { + "target": "com.amazonaws.groundstation#EphemerisPriority", + "traits": { + "smithy.api#documentation": "Customer-provided priority score to establish the order in which overlapping ephemerides should be used.
\nThe default for customer-provided ephemeris priority is 1, and higher numbers take precedence.
\nPriority must be 1 or greater
" + } + }, + "creationTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time the ephemeris was uploaded in UTC.
" + } + }, + "enabled": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "Whether or not the ephemeris is enabled.
" + } + }, + "name": { + "target": "com.amazonaws.groundstation#SafeName", + "traits": { + "smithy.api#documentation": "A name string associated with the ephemeris. Used as a human-readable identifier for the ephemeris.
" + } + }, + "tags": { + "target": "com.amazonaws.groundstation#TagsMap", + "traits": { + "smithy.api#documentation": "Tags assigned to an ephemeris.
" + } + }, + "suppliedData": { + "target": "com.amazonaws.groundstation#EphemerisTypeDescription", + "traits": { + "smithy.api#documentation": "Supplied ephemeris data.
" + } + }, + "invalidReason": { + "target": "com.amazonaws.groundstation#EphemerisInvalidReason", + "traits": { + "smithy.api#documentation": "Reason that an ephemeris failed validation. Only provided for ephemerides with INVALID status.
UUID of a Config.
Endpoint security details.
" + "smithy.api#documentation": "Endpoint security details including a list of subnets, a list of security groups and a role to connect streams to instances.
" } }, "endpoint": { @@ -1431,6 +1686,12 @@ "type": "list", "member": { "target": "com.amazonaws.groundstation#EndpointDetails" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 500 + } } }, "com.amazonaws.groundstation#EndpointStatus": { @@ -1460,27 +1721,309 @@ ] } }, - "com.amazonaws.groundstation#Frequency": { - "type": "structure", - "members": { - "value": { - "target": "smithy.api#Double", - "traits": { - "smithy.api#documentation": "Frequency value. Valid values are between 2200 to 2300 MHz and 7750 to 8400 MHz for downlink and 2025 to 2120 MHz for uplink.
", - "smithy.api#required": {} - } - }, - "units": { - "target": "com.amazonaws.groundstation#FrequencyUnits", - "traits": { - "smithy.api#documentation": "Frequency units.
", - "smithy.api#required": {} - } - } + "com.amazonaws.groundstation#EphemeridesList": { + "type": "list", + "member": { + "target": "com.amazonaws.groundstation#EphemerisItem" }, "traits": { - "smithy.api#documentation": "Object that describes the frequency.
" - } + "smithy.api#length": { + "min": 1, + "max": 500 + } + } + }, + "com.amazonaws.groundstation#Ephemeris": { + "type": "resource", + "identifiers": { + "ephemerisId": { + "target": "com.amazonaws.groundstation#Uuid" + } + }, + "create": { + "target": "com.amazonaws.groundstation#CreateEphemeris" + }, + "read": { + "target": "com.amazonaws.groundstation#DescribeEphemeris" + }, + "update": { + "target": "com.amazonaws.groundstation#UpdateEphemeris" + }, + "delete": { + "target": "com.amazonaws.groundstation#DeleteEphemeris" + }, + "list": { + "target": "com.amazonaws.groundstation#ListEphemerides" + }, + "traits": { + "aws.api#arn": { + "template": "ephemeris/{ephemerisId}" + } + } + }, + "com.amazonaws.groundstation#EphemerisData": { + "type": "union", + "members": { + "tle": { + "target": "com.amazonaws.groundstation#TLEEphemeris" + }, + "oem": { + "target": "com.amazonaws.groundstation#OEMEphemeris" + } + }, + "traits": { + "smithy.api#documentation": "Ephemeris data.
" + } + }, + "com.amazonaws.groundstation#EphemerisDescription": { + "type": "structure", + "members": { + "sourceS3Object": { + "target": "com.amazonaws.groundstation#S3Object", + "traits": { + "smithy.api#documentation": "Source S3 object used for the ephemeris.
" + } + }, + "ephemerisData": { + "target": "com.amazonaws.groundstation#UnboundedString", + "traits": { + "smithy.api#documentation": "Supplied ephemeris data.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Description of ephemeris.
" + } + }, + "com.amazonaws.groundstation#EphemerisIdResponse": { + "type": "structure", + "members": { + "ephemerisId": { + "target": "com.amazonaws.groundstation#Uuid", + "traits": { + "smithy.api#documentation": "The AWS Ground Station ephemeris ID.
" + } + } + } + }, + "com.amazonaws.groundstation#EphemerisInvalidReason": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "METADATA_INVALID", + "name": "METADATA_INVALID", + "documentation": "Provided spacecraft identifiers such as spacecraft NORAD Id are invalid" + }, + { + "value": "TIME_RANGE_INVALID", + "name": "TIME_RANGE_INVALID", + "documentation": "Start, end, or expiration time(s) are invalid for the provided ephemeris" + }, + { + "value": "TRAJECTORY_INVALID", + "name": "TRAJECTORY_INVALID", + "documentation": "Provided ephemeris defines invalid spacecraft trajectory" + }, + { + "value": "KMS_KEY_INVALID", + "name": "KMS_KEY_INVALID", + "documentation": "Provided KMS key is invalid" + }, + { + "value": "VALIDATION_ERROR", + "name": "VALIDATION_ERROR", + "documentation": "Internal Service Error occurred while processing ephemeris" + } + ] + } + }, + "com.amazonaws.groundstation#EphemerisItem": { + "type": "structure", + "members": { + "ephemerisId": { + "target": "com.amazonaws.groundstation#Uuid", + "traits": { + "smithy.api#documentation": "The AWS Ground Station ephemeris ID.
" + } + }, + "status": { + "target": "com.amazonaws.groundstation#EphemerisStatus", + "traits": { + "smithy.api#documentation": "The status of the ephemeris.
" + } + }, + "priority": { + "target": "com.amazonaws.groundstation#EphemerisPriority", + "traits": { + "smithy.api#documentation": "Customer-provided priority score to establish the order in which overlapping ephemerides should be used.
\nThe default for customer-provided ephemeris priority is 1, and higher numbers take precedence.
\nPriority must be 1 or greater
" + } + }, + "enabled": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "Whether or not the ephemeris is enabled.
" + } + }, + "creationTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time the ephemeris was uploaded in UTC.
" + } + }, + "name": { + "target": "com.amazonaws.groundstation#SafeName", + "traits": { + "smithy.api#documentation": "A name string associated with the ephemeris. Used as a human-readable identifier for the ephemeris.
" + } + }, + "sourceS3Object": { + "target": "com.amazonaws.groundstation#S3Object", + "traits": { + "smithy.api#documentation": "Source S3 object used for the ephemeris.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Ephemeris item.
" + } + }, + "com.amazonaws.groundstation#EphemerisMetaData": { + "type": "structure", + "members": { + "source": { + "target": "com.amazonaws.groundstation#EphemerisSource", + "traits": { + "smithy.api#documentation": "The EphemerisSource that generated a given ephemeris.
UUID of a customer-provided ephemeris.
\nThis field is not populated for default ephemerides from Space Track.
" + } + }, + "epoch": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The epoch of a default, ephemeris from Space Track in UTC.
\nThis field is not populated for customer-provided ephemerides.
" + } + }, + "name": { + "target": "com.amazonaws.groundstation#SafeName", + "traits": { + "smithy.api#documentation": "A name string associated with the ephemeris. Used as a human-readable identifier for the ephemeris.
\nA name is only returned for customer-provider ephemerides that have a name associated.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Metadata describing a particular ephemeris.
" + } + }, + "com.amazonaws.groundstation#EphemerisPriority": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 99999 + } + } + }, + "com.amazonaws.groundstation#EphemerisSource": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "CUSTOMER_PROVIDED", + "name": "CUSTOMER_PROVIDED" + }, + { + "value": "SPACE_TRACK", + "name": "SPACE_TRACK" + } + ] + } + }, + "com.amazonaws.groundstation#EphemerisStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "VALIDATING", + "name": "VALIDATING" + }, + { + "value": "INVALID", + "name": "INVALID" + }, + { + "value": "ERROR", + "name": "ERROR" + }, + { + "value": "ENABLED", + "name": "ENABLED" + }, + { + "value": "DISABLED", + "name": "DISABLED" + }, + { + "value": "EXPIRED", + "name": "EXPIRED" + } + ] + } + }, + "com.amazonaws.groundstation#EphemerisStatusList": { + "type": "list", + "member": { + "target": "com.amazonaws.groundstation#EphemerisStatus" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 500 + } + } + }, + "com.amazonaws.groundstation#EphemerisTypeDescription": { + "type": "union", + "members": { + "tle": { + "target": "com.amazonaws.groundstation#EphemerisDescription" + }, + "oem": { + "target": "com.amazonaws.groundstation#EphemerisDescription" + } + }, + "traits": { + "smithy.api#documentation": "" + } + }, + "com.amazonaws.groundstation#Frequency": { + "type": "structure", + "members": { + "value": { + "target": "smithy.api#Double", + "traits": { + "smithy.api#documentation": "Frequency value. Valid values are between 2200 to 2300 MHz and 7750 to 8400 MHz for downlink and 2025 to 2120 MHz for uplink.
", + "smithy.api#required": {} + } + }, + "units": { + "target": "com.amazonaws.groundstation#FrequencyUnits", + "traits": { + "smithy.api#documentation": "Frequency units.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Object that describes the frequency.
" + } }, "com.amazonaws.groundstation#FrequencyBandwidth": { "type": "structure", @@ -1546,8 +2089,7 @@ "smithy.api#documentation": "Returns Config information.
Only one Config response can be returned.
UUID of a Config.
Returns the dataflow endpoint group.
", "smithy.api#http": { "method": "GET", - "uri": "/dataflowEndpointGroup/{dataflowEndpointGroupId}", - "code": 200 + "uri": "/dataflowEndpointGroup/{dataflowEndpointGroupId}" }, "smithy.api#readonly": {} } @@ -1657,7 +2198,7 @@ "type": "structure", "members": { "dataflowEndpointGroupId": { - "target": "smithy.api#String", + "target": "com.amazonaws.groundstation#Uuid", "traits": { "smithy.api#documentation": "UUID of a dataflow endpoint group.
", "smithy.api#httpLabel": {}, @@ -1673,7 +2214,7 @@ "type": "structure", "members": { "dataflowEndpointGroupId": { - "target": "smithy.api#String", + "target": "com.amazonaws.groundstation#Uuid", "traits": { "smithy.api#documentation": "UUID of a dataflow endpoint group.
" } @@ -1724,8 +2265,7 @@ "smithy.api#documentation": "Returns the number of minutes used by account.
", "smithy.api#http": { "method": "POST", - "uri": "/minute-usage", - "code": 200 + "uri": "/minute-usage" }, "smithy.api#readonly": {} } @@ -1734,14 +2274,14 @@ "type": "structure", "members": { "month": { - "target": "smithy.api#Integer", + "target": "com.amazonaws.groundstation#Month", "traits": { "smithy.api#documentation": "The month being requested, with a value of 1-12.
", "smithy.api#required": {} } }, "year": { - "target": "smithy.api#Integer", + "target": "com.amazonaws.groundstation#Year", "traits": { "smithy.api#documentation": "The year being requested, in the format of YYYY.
", "smithy.api#required": {} @@ -1813,8 +2353,7 @@ "smithy.api#documentation": "Returns a mission profile.
", "smithy.api#http": { "method": "GET", - "uri": "/missionprofile/{missionProfileId}", - "code": 200 + "uri": "/missionprofile/{missionProfileId}" }, "smithy.api#readonly": {} } @@ -1823,7 +2362,7 @@ "type": "structure", "members": { "missionProfileId": { - "target": "smithy.api#String", + "target": "com.amazonaws.groundstation#Uuid", "traits": { "smithy.api#documentation": "UUID of a mission profile.
", "smithy.api#httpLabel": {}, @@ -1839,7 +2378,7 @@ "type": "structure", "members": { "missionProfileId": { - "target": "smithy.api#String", + "target": "com.amazonaws.groundstation#Uuid", "traits": { "smithy.api#documentation": "UUID of a mission profile.
" } @@ -1851,13 +2390,13 @@ } }, "name": { - "target": "smithy.api#String", + "target": "com.amazonaws.groundstation#SafeName", "traits": { "smithy.api#documentation": "Name of a mission profile.
" } }, "region": { - "target": "smithy.api#String", + "target": "com.amazonaws.groundstation#AWSRegion", "traits": { "smithy.api#documentation": "Region of a mission profile.
" } @@ -1875,7 +2414,7 @@ } }, "minimumViableContactDurationSeconds": { - "target": "com.amazonaws.groundstation#DurationInSeconds", + "target": "com.amazonaws.groundstation#PositiveDurationInSeconds", "traits": { "smithy.api#documentation": "Smallest amount of time in seconds that you’d like to see for an available contact. AWS Ground Station will not present you with contacts shorter than this duration.
" } @@ -1931,8 +2470,7 @@ "smithy.api#documentation": "Returns a satellite.
", "smithy.api#http": { "method": "GET", - "uri": "/satellite/{satelliteId}", - "code": 200 + "uri": "/satellite/{satelliteId}" }, "smithy.api#readonly": {} } @@ -1941,7 +2479,7 @@ "type": "structure", "members": { "satelliteId": { - "target": "smithy.api#String", + "target": "com.amazonaws.groundstation#Uuid", "traits": { "smithy.api#documentation": "UUID of a satellite.
", "smithy.api#httpLabel": {}, @@ -1971,6 +2509,7 @@ "noradSatelliteID": { "target": "com.amazonaws.groundstation#noradSatelliteID", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "NORAD satellite ID number.
" } }, @@ -1979,6 +2518,12 @@ "traits": { "smithy.api#documentation": "A list of ground stations to which the satellite is on-boarded.
" } + }, + "currentEphemeris": { + "target": "com.amazonaws.groundstation#EphemerisMetaData", + "traits": { + "smithy.api#documentation": "The current ephemeris being used to compute the trajectory of the satellite.
" + } } }, "traits": { @@ -2017,6 +2562,9 @@ { "target": "com.amazonaws.groundstation#DataflowEndpointGroup" }, + { + "target": "com.amazonaws.groundstation#Ephemeris" + }, { "target": "com.amazonaws.groundstation#GroundStationResource" }, @@ -2030,36 +2578,1069 @@ "traits": { "aws.api#service": { "sdkId": "GroundStation", - "arnNamespace": "groundstation", "cloudFormationName": "AWSGroundStation", - "cloudTrailEventSource": "REPLACE_WITH_EVENT_SOURCE", - "endpointPrefix": "groundstation" + "arnNamespace": "groundstation", + "cloudTrailEventSource": "groundstation.amazonaws.com" }, "aws.auth#sigv4": { "name": "groundstation" }, "aws.protocols#restJson1": {}, "smithy.api#documentation": "Welcome to the AWS Ground Station API Reference. AWS Ground Station is a fully managed service that\n enables you to control satellite communications, downlink and process satellite data, and\n scale your satellite operations efficiently and cost-effectively without having\n to build or manage your own ground station infrastructure.
", - "smithy.api#title": "AWS Ground Station" + "smithy.api#title": "AWS Ground Station", + "smithy.rules#endpointRuleSet": { + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "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" + } + ] + }, + { + "fn": "parseURL", + "argv": [ + { + "ref": "Endpoint" + } + ], + "assign": "url" + } + ], + "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://groundstation-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://groundstation-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://groundstation.{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://groundstation.{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://groundstation-fips.ca-central-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "ca-central-1" + } + }, + { + "documentation": "For region ca-central-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://groundstation-fips.ca-central-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "ca-central-1" + } + }, + { + "documentation": "For region ca-central-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://groundstation.ca-central-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "ca-central-1" + } + }, + { + "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://groundstation.ca-central-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "ca-central-1" + } + }, + { + "documentation": "For region eu-central-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://groundstation-fips.eu-central-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "eu-central-1" + } + }, + { + "documentation": "For region eu-central-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://groundstation-fips.eu-central-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "eu-central-1" + } + }, + { + "documentation": "For region eu-central-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://groundstation.eu-central-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "eu-central-1" + } + }, + { + "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://groundstation.eu-central-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "eu-central-1" + } + }, + { + "documentation": "For region us-west-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://groundstation-fips.us-west-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "us-west-2" + } + }, + { + "documentation": "For region us-west-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://groundstation-fips.us-west-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "us-west-2" + } + }, + { + "documentation": "For region us-west-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://groundstation.us-west-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "us-west-2" + } + }, + { + "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://groundstation.us-west-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "us-west-2" + } + }, + { + "documentation": "For region af-south-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://groundstation-fips.af-south-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "af-south-1" + } + }, + { + "documentation": "For region af-south-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://groundstation-fips.af-south-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "af-south-1" + } + }, + { + "documentation": "For region af-south-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://groundstation.af-south-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "af-south-1" + } + }, + { + "documentation": "For region af-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://groundstation.af-south-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "af-south-1" + } + }, + { + "documentation": "For region eu-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://groundstation-fips.eu-north-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "eu-north-1" + } + }, + { + "documentation": "For region eu-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://groundstation-fips.eu-north-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "eu-north-1" + } + }, + { + "documentation": "For region eu-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://groundstation.eu-north-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "eu-north-1" + } + }, + { + "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://groundstation.eu-north-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "eu-north-1" + } + }, + { + "documentation": "For region eu-west-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://groundstation-fips.eu-west-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "eu-west-1" + } + }, + { + "documentation": "For region eu-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://groundstation-fips.eu-west-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "eu-west-1" + } + }, + { + "documentation": "For region eu-west-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://groundstation.eu-west-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "eu-west-1" + } + }, + { + "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://groundstation.eu-west-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "eu-west-1" + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://groundstation-fips.ap-northeast-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "ap-northeast-2" + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://groundstation-fips.ap-northeast-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "ap-northeast-2" + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://groundstation.ap-northeast-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "ap-northeast-2" + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://groundstation.ap-northeast-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "ap-northeast-2" + } + }, + { + "documentation": "For region me-south-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://groundstation-fips.me-south-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "me-south-1" + } + }, + { + "documentation": "For region me-south-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://groundstation-fips.me-south-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "me-south-1" + } + }, + { + "documentation": "For region me-south-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://groundstation.me-south-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "me-south-1" + } + }, + { + "documentation": "For region me-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://groundstation.me-south-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "me-south-1" + } + }, + { + "documentation": "For region sa-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://groundstation-fips.sa-east-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "sa-east-1" + } + }, + { + "documentation": "For region sa-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://groundstation-fips.sa-east-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "sa-east-1" + } + }, + { + "documentation": "For region sa-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://groundstation.sa-east-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "sa-east-1" + } + }, + { + "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://groundstation.sa-east-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "sa-east-1" + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://groundstation-fips.ap-southeast-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "ap-southeast-1" + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://groundstation-fips.ap-southeast-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "ap-southeast-1" + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://groundstation.ap-southeast-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "ap-southeast-1" + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://groundstation.ap-southeast-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "ap-southeast-1" + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://groundstation-fips.ap-southeast-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "ap-southeast-2" + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://groundstation-fips.ap-southeast-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "ap-southeast-2" + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://groundstation.ap-southeast-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "ap-southeast-2" + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://groundstation.ap-southeast-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "ap-southeast-2" + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://groundstation-fips.us-east-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "us-east-1" + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://groundstation-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "us-east-1" + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://groundstation.us-east-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "us-east-1" + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://groundstation.us-east-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "us-east-1" + } + }, + { + "documentation": "For region us-east-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://groundstation-fips.us-east-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "us-east-2" + } + }, + { + "documentation": "For region us-east-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://groundstation-fips.us-east-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "us-east-2" + } + }, + { + "documentation": "For region us-east-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://groundstation.us-east-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "us-east-2" + } + }, + { + "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://groundstation.us-east-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "us-east-2" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": 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": { + "UseDualStack": false, + "UseFIPS": true, + "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": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "us-east-1", + "Endpoint": "https://example.com" + } + } + ], + "version": "1.0" + } } }, "com.amazonaws.groundstation#GroundStationData": { "type": "structure", "members": { "groundStationId": { - "target": "smithy.api#String", + "target": "com.amazonaws.groundstation#GroundStationName", "traits": { "smithy.api#documentation": "UUID of a ground station.
" } }, "groundStationName": { - "target": "smithy.api#String", + "target": "com.amazonaws.groundstation#GroundStationName", "traits": { "smithy.api#documentation": "Name of a ground station.
" } }, "region": { - "target": "smithy.api#String", + "target": "com.amazonaws.groundstation#AWSRegion", "traits": { "smithy.api#documentation": "Ground station Region.
" } @@ -2072,7 +3653,13 @@ "com.amazonaws.groundstation#GroundStationIdList": { "type": "list", "member": { - "target": "smithy.api#String" + "target": "com.amazonaws.groundstation#GroundStationName" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 500 + } } }, "com.amazonaws.groundstation#GroundStationList": { @@ -2081,6 +3668,16 @@ "target": "com.amazonaws.groundstation#GroundStationData" } }, + "com.amazonaws.groundstation#GroundStationName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 4, + "max": 500 + }, + "smithy.api#pattern": "^[ a-zA-Z0-9-._:=]{4,256}$" + } + }, "com.amazonaws.groundstation#GroundStationResource": { "type": "resource", "identifiers": { @@ -2093,10 +3690,7 @@ }, "traits": { "aws.api#arn": { - "template": "groundstation:{groundStationId}", - "absolute": false, - "noAccount": false, - "noRegion": false + "template": "groundstation:{groundStationId}" } } }, @@ -2129,6 +3723,14 @@ "smithy.api#pattern": "^[{}\\[\\]:.,\"0-9A-z\\-_\\s]{2,8192}$" } }, + "com.amazonaws.groundstation#KeyArn": { + "type": "string", + "traits": { + "aws.api#arnReference": { + "type": "AWS::KMS::Key" + } + } + }, "com.amazonaws.groundstation#ListConfigs": { "type": "operation", "input": { @@ -2152,14 +3754,13 @@ "smithy.api#documentation": "Returns a list of Config objects.
Maximum number of Configs returned.
Next token returned in the request of a previous ListConfigs call. Used to get the next page of results.
Next token returned in the response of a previous ListConfigs call. Used to get the next page of results.
Returns a list of contacts.
\nIf statusList contains AVAILABLE, the request must include\n groundStation, missionprofileArn, and satelliteArn.\n
Maximum number of contacts returned.
" } }, "nextToken": { - "target": "smithy.api#String", + "target": "com.amazonaws.groundstation#PaginationToken", "traits": { "smithy.api#documentation": "Next token returned in the request of a previous ListContacts call. Used to get the next page of results.
Start time of a contact.
", + "smithy.api#documentation": "Start time of a contact in UTC.
", "smithy.api#required": {} } }, "endTime": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "End time of a contact.
", + "smithy.api#documentation": "End time of a contact in UTC.
", "smithy.api#required": {} } }, "groundStation": { - "target": "smithy.api#String", + "target": "com.amazonaws.groundstation#GroundStationName", "traits": { "smithy.api#documentation": "Name of a ground station.
" } @@ -2304,7 +3904,7 @@ "type": "structure", "members": { "nextToken": { - "target": "smithy.api#String", + "target": "com.amazonaws.groundstation#PaginationToken", "traits": { "smithy.api#documentation": "Next token returned in the response of a previous ListContacts call. Used to get the next page of results.
Returns a list of DataflowEndpoint groups.
Maximum number of dataflow endpoint groups returned.
", "smithy.api#httpQuery": "maxResults" } }, "nextToken": { - "target": "smithy.api#String", + "target": "com.amazonaws.groundstation#PaginationToken", "traits": { "smithy.api#documentation": "Next token returned in the request of a previous ListDataflowEndpointGroups call. Used to get the next page of results.
Next token returned in the response of a previous ListDataflowEndpointGroups call. Used to get the next page of results.
A list of dataflow endpoint groups.
" + } + } + }, + "traits": { + "smithy.api#documentation": "" + } + }, + "com.amazonaws.groundstation#ListEphemerides": { + "type": "operation", + "input": { + "target": "com.amazonaws.groundstation#ListEphemeridesRequest" + }, + "output": { + "target": "com.amazonaws.groundstation#ListEphemeridesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.groundstation#DependencyException" + }, + { + "target": "com.amazonaws.groundstation#InvalidParameterException" + }, + { + "target": "com.amazonaws.groundstation#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "List existing ephemerides.
", + "smithy.api#http": { + "method": "POST", + "uri": "/ephemerides" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "pageSize": "maxResults", + "outputToken": "nextToken", + "items": "ephemerides" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.groundstation#ListEphemeridesRequest": { + "type": "structure", + "members": { + "satelliteId": { + "target": "com.amazonaws.groundstation#Uuid", + "traits": { + "smithy.api#documentation": "The AWS Ground Station satellite ID to list ephemeris for.
", + "smithy.api#required": {} + } + }, + "startTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The start time to list in UTC. The operation will return an ephemeris if its expiration time is within the time range defined by the startTime and endTime.
The end time to list in UTC. The operation will return an ephemeris if its expiration time is within the time range defined by the startTime and endTime.
The list of ephemeris status to return.
" + } + }, + "maxResults": { + "target": "com.amazonaws.groundstation#PaginationMaxResults", + "traits": { + "smithy.api#documentation": "Maximum number of ephemerides to return.
", + "smithy.api#httpQuery": "maxResults" + } + }, + "nextToken": { + "target": "com.amazonaws.groundstation#PaginationToken", + "traits": { + "smithy.api#documentation": "Pagination token.
", + "smithy.api#httpQuery": "nextToken" + } + } + } + }, + "com.amazonaws.groundstation#ListEphemeridesResponse": { "type": "structure", "members": { "nextToken": { - "target": "smithy.api#String", + "target": "com.amazonaws.groundstation#PaginationToken", "traits": { - "smithy.api#documentation": "Next token returned in the response of a previous ListDataflowEndpointGroups call. Used to get the next page of results.
Pagination token.
" } }, - "dataflowEndpointGroupList": { - "target": "com.amazonaws.groundstation#DataflowEndpointGroupList", + "ephemerides": { + "target": "com.amazonaws.groundstation#EphemeridesList", "traits": { - "smithy.api#documentation": "A list of dataflow endpoint groups.
" + "smithy.api#documentation": "List of ephemerides.
" } } - }, - "traits": { - "smithy.api#documentation": "" } }, "com.amazonaws.groundstation#ListGroundStations": { @@ -2420,14 +4116,13 @@ "smithy.api#documentation": "Returns a list of ground stations.
", "smithy.api#http": { "method": "GET", - "uri": "/groundstation", - "code": 200 + "uri": "/groundstation" }, "smithy.api#paginated": { "inputToken": "nextToken", + "pageSize": "maxResults", "outputToken": "nextToken", - "items": "groundStationList", - "pageSize": "maxResults" + "items": "groundStationList" }, "smithy.api#readonly": {} } @@ -2436,21 +4131,21 @@ "type": "structure", "members": { "satelliteId": { - "target": "smithy.api#String", + "target": "com.amazonaws.groundstation#Uuid", "traits": { "smithy.api#documentation": "Satellite ID to retrieve on-boarded ground stations.
", "smithy.api#httpQuery": "satelliteId" } }, "maxResults": { - "target": "smithy.api#Integer", + "target": "com.amazonaws.groundstation#PaginationMaxResults", "traits": { "smithy.api#documentation": "Maximum number of ground stations returned.
", "smithy.api#httpQuery": "maxResults" } }, "nextToken": { - "target": "smithy.api#String", + "target": "com.amazonaws.groundstation#PaginationToken", "traits": { "smithy.api#documentation": "Next token that can be supplied in the next call to get the next page of ground stations.
", "smithy.api#httpQuery": "nextToken" @@ -2465,7 +4160,7 @@ "type": "structure", "members": { "nextToken": { - "target": "smithy.api#String", + "target": "com.amazonaws.groundstation#PaginationToken", "traits": { "smithy.api#documentation": "Next token that can be supplied in the next call to get the next page of ground stations.
" } @@ -2504,14 +4199,13 @@ "smithy.api#documentation": "Returns a list of mission profiles.
", "smithy.api#http": { "method": "GET", - "uri": "/missionprofile", - "code": 200 + "uri": "/missionprofile" }, "smithy.api#paginated": { "inputToken": "nextToken", + "pageSize": "maxResults", "outputToken": "nextToken", - "items": "missionProfileList", - "pageSize": "maxResults" + "items": "missionProfileList" }, "smithy.api#readonly": {} } @@ -2520,14 +4214,14 @@ "type": "structure", "members": { "maxResults": { - "target": "smithy.api#Integer", + "target": "com.amazonaws.groundstation#PaginationMaxResults", "traits": { "smithy.api#documentation": "Maximum number of mission profiles returned.
", "smithy.api#httpQuery": "maxResults" } }, "nextToken": { - "target": "smithy.api#String", + "target": "com.amazonaws.groundstation#PaginationToken", "traits": { "smithy.api#documentation": "Next token returned in the request of a previous ListMissionProfiles call. Used to get the next page of results.
Next token returned in the response of a previous ListMissionProfiles call. Used to get the next page of results.
Returns a list of satellites.
", "smithy.api#http": { "method": "GET", - "uri": "/satellite", - "code": 200 + "uri": "/satellite" }, "smithy.api#paginated": { "inputToken": "nextToken", + "pageSize": "maxResults", "outputToken": "nextToken", - "items": "satellites", - "pageSize": "maxResults" + "items": "satellites" }, "smithy.api#readonly": {} } @@ -2597,14 +4290,14 @@ "type": "structure", "members": { "maxResults": { - "target": "smithy.api#Integer", + "target": "com.amazonaws.groundstation#PaginationMaxResults", "traits": { "smithy.api#documentation": "Maximum number of satellites returned.
", "smithy.api#httpQuery": "maxResults" } }, "nextToken": { - "target": "smithy.api#String", + "target": "com.amazonaws.groundstation#PaginationToken", "traits": { "smithy.api#documentation": "Next token that can be supplied in the next call to get the next page of satellites.
", "smithy.api#httpQuery": "nextToken" @@ -2619,7 +4312,7 @@ "type": "structure", "members": { "nextToken": { - "target": "smithy.api#String", + "target": "com.amazonaws.groundstation#PaginationToken", "traits": { "smithy.api#documentation": "Next token that can be supplied in the next call to get the next page of satellites.
" } @@ -2658,8 +4351,7 @@ "smithy.api#documentation": "Returns a list of tags for a specified resource.
", "smithy.api#http": { "method": "GET", - "uri": "/tags/{resourceArn}", - "code": 200 + "uri": "/tags/{resourceArn}" }, "smithy.api#readonly": {} } @@ -2668,7 +4360,7 @@ "type": "structure", "members": { "resourceArn": { - "target": "smithy.api#String", + "target": "com.amazonaws.groundstation#AnyArn", "traits": { "smithy.api#documentation": "ARN of a resource.
", "smithy.api#httpLabel": {}, @@ -2698,7 +4390,7 @@ "type": "resource", "identifiers": { "missionProfileId": { - "target": "smithy.api#String" + "target": "com.amazonaws.groundstation#Uuid" } }, "create": { @@ -2718,10 +4410,7 @@ }, "traits": { "aws.api#arn": { - "template": "mission-profile/{missionProfileId}", - "absolute": false, - "noAccount": false, - "noRegion": false + "template": "mission-profile/{missionProfileId}" } } }, @@ -2730,8 +4419,8 @@ "traits": { "aws.api#arnReference": { "type": "AWS::GroundStation::MissionProfile", - "service": "com.amazonaws.groundstation#GroundStation", - "resource": "com.amazonaws.groundstation#MissionProfile" + "service": "GroundStation", + "resource": "MissionProfile" } } }, @@ -2739,7 +4428,7 @@ "type": "structure", "members": { "missionProfileId": { - "target": "smithy.api#String", + "target": "com.amazonaws.groundstation#Uuid", "traits": { "smithy.api#documentation": "UUID of a mission profile.
" } @@ -2759,7 +4448,7 @@ "type": "structure", "members": { "missionProfileId": { - "target": "smithy.api#String", + "target": "com.amazonaws.groundstation#Uuid", "traits": { "smithy.api#documentation": "UUID of a mission profile.
" } @@ -2771,13 +4460,13 @@ } }, "region": { - "target": "smithy.api#String", + "target": "com.amazonaws.groundstation#AWSRegion", "traits": { "smithy.api#documentation": "Region of a mission profile.
" } }, "name": { - "target": "smithy.api#String", + "target": "com.amazonaws.groundstation#SafeName", "traits": { "smithy.api#documentation": "Name of a mission profile.
" } @@ -2787,6 +4476,54 @@ "smithy.api#documentation": "Item in a list of mission profiles.
" } }, + "com.amazonaws.groundstation#Month": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 12 + } + } + }, + "com.amazonaws.groundstation#OEMEphemeris": { + "type": "structure", + "members": { + "s3Object": { + "target": "com.amazonaws.groundstation#S3Object", + "traits": { + "smithy.api#documentation": "Identifies the S3 object to be used as the ephemeris.
" + } + }, + "oemData": { + "target": "com.amazonaws.groundstation#UnboundedString", + "traits": { + "smithy.api#documentation": "The data for an OEM ephemeris, supplied directly in the request rather than through an S3 object.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Ephemeris data in Orbit Ephemeris Message (OEM) format.
" + } + }, + "com.amazonaws.groundstation#PaginationMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.groundstation#PaginationToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 1000 + }, + "smithy.api#pattern": "^[A-Za-z0-9-/+_.=]+$" + } + }, "com.amazonaws.groundstation#Polarization": { "type": "string", "traits": { @@ -2806,6 +4543,15 @@ ] } }, + "com.amazonaws.groundstation#PositiveDurationInSeconds": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 21600 + } + } + }, "com.amazonaws.groundstation#ReserveContact": { "type": "operation", "input": { @@ -2829,8 +4575,7 @@ "smithy.api#documentation": "Reserves a contact using specified parameters.
", "smithy.api#http": { "method": "POST", - "uri": "/contact", - "code": 200 + "uri": "/contact" } } }, @@ -2854,19 +4599,19 @@ "startTime": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "Start time of a contact.
", + "smithy.api#documentation": "Start time of a contact in UTC.
", "smithy.api#required": {} } }, "endTime": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "End time of a contact.
", + "smithy.api#documentation": "End time of a contact in UTC.
", "smithy.api#required": {} } }, "groundStation": { - "target": "smithy.api#String", + "target": "com.amazonaws.groundstation#GroundStationName", "traits": { "smithy.api#documentation": "Name of a ground station.
", "smithy.api#required": {} @@ -2918,6 +4663,16 @@ "com.amazonaws.groundstation#RoleArn": { "type": "string" }, + "com.amazonaws.groundstation#S3BucketName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 63 + }, + "smithy.api#pattern": "^[a-z0-9.-]{3,63}$" + } + }, "com.amazonaws.groundstation#S3KeyPrefix": { "type": "string", "traits": { @@ -2928,6 +4683,42 @@ "smithy.api#pattern": "^([a-zA-Z0-9_\\-=/]|\\{satellite_id\\}|\\{config\\-name}|\\{s3\\-config-id}|\\{year\\}|\\{month\\}|\\{day\\}){1,900}$" } }, + "com.amazonaws.groundstation#S3Object": { + "type": "structure", + "members": { + "bucket": { + "target": "com.amazonaws.groundstation#S3BucketName", + "traits": { + "smithy.api#documentation": "An Amazon S3 Bucket name.
" + } + }, + "key": { + "target": "com.amazonaws.groundstation#S3ObjectKey", + "traits": { + "smithy.api#documentation": "An Amazon S3 key for the ephemeris.
" + } + }, + "version": { + "target": "com.amazonaws.groundstation#S3VersionId", + "traits": { + "smithy.api#documentation": "For versioned S3 objects, the version to use for the ephemeris.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Object stored in S3 containing ephemeris data.
" + } + }, + "com.amazonaws.groundstation#S3ObjectKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^[a-zA-Z0-9!*'\\)\\(./_-]{1,1024}$" + } + }, "com.amazonaws.groundstation#S3RecordingConfig": { "type": "structure", "members": { @@ -2968,7 +4759,7 @@ "keyTemplate": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "Template of the S3 key used.
" + "smithy.api#documentation": "Key template used for the S3 Recording Configuration
" } } }, @@ -2976,6 +4767,16 @@ "smithy.api#documentation": "Details about an S3 recording Config used in a contact.
NORAD satellite ID number.
" } }, @@ -3040,6 +4839,12 @@ "traits": { "smithy.api#documentation": "A list of ground stations to which the satellite is on-boarded.
" } + }, + "currentEphemeris": { + "target": "com.amazonaws.groundstation#EphemerisMetaData", + "traits": { + "smithy.api#documentation": "The current ephemeris being used to compute the trajectory of the satellite.
" + } } }, "traits": { @@ -3121,7 +4926,7 @@ "configDetails": { "target": "com.amazonaws.groundstation#ConfigDetails", "traits": { - "smithy.api#documentation": "Additional details for a Config, if type is dataflow endpoint or antenna demod decode.
Additional details for a Config, if type is dataflow-endpoint or antenna-downlink-demod-decode \n
First line of two-line element set (TLE) data.
", + "smithy.api#required": {} + } + }, + "tleLine2": { + "target": "com.amazonaws.groundstation#TleLineTwo", + "traits": { + "smithy.api#documentation": "Second line of two-line element set (TLE) data.
", + "smithy.api#required": {} + } + }, + "validTimeRange": { + "target": "com.amazonaws.groundstation#TimeRange", + "traits": { + "smithy.api#documentation": "The valid time range for the TLE. Gaps or overlap are not permitted.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Two-line element set (TLE) data.
" + } + }, + "com.amazonaws.groundstation#TLEDataList": { + "type": "list", + "member": { + "target": "com.amazonaws.groundstation#TLEData" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 500 + } + } + }, + "com.amazonaws.groundstation#TLEEphemeris": { + "type": "structure", + "members": { + "s3Object": { + "target": "com.amazonaws.groundstation#S3Object", + "traits": { + "smithy.api#documentation": "Identifies the S3 object to be used as the ephemeris.
" + } + }, + "tleData": { + "target": "com.amazonaws.groundstation#TLEDataList", + "traits": { + "smithy.api#documentation": "The data for a TLE ephemeris, supplied directly in the request rather than through an S3 object.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Two-line element set (TLE) ephemeris.
" + } + }, "com.amazonaws.groundstation#TagKeys": { "type": "list", "member": { - "target": "smithy.api#String" + "target": "com.amazonaws.groundstation#UnboundedString" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 500 + } } }, "com.amazonaws.groundstation#TagResource": { @@ -3204,8 +5082,7 @@ "smithy.api#documentation": "Assigns a tag to a resource.
", "smithy.api#http": { "method": "POST", - "uri": "/tags/{resourceArn}", - "code": 200 + "uri": "/tags/{resourceArn}" } } }, @@ -3213,7 +5090,7 @@ "type": "structure", "members": { "resourceArn": { - "target": "smithy.api#String", + "target": "com.amazonaws.groundstation#AnyArn", "traits": { "smithy.api#documentation": "ARN of a resource tag.
", "smithy.api#httpLabel": {}, @@ -3248,6 +5125,48 @@ "target": "smithy.api#String" } }, + "com.amazonaws.groundstation#TimeRange": { + "type": "structure", + "members": { + "startTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "Time in UTC at which the time range starts.
", + "smithy.api#required": {} + } + }, + "endTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "Time in UTC at which the time range ends.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A time range with a start and end time.
" + } + }, + "com.amazonaws.groundstation#TleLineOne": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 69, + "max": 69 + }, + "smithy.api#pattern": "^1 [ 0-9]{5}[A-Z] [ 0-9]{5}[ A-Z]{3} [ 0-9]{5}[.][ 0-9]{8} (?:(?:[ 0+-][.][ 0-9]{8})|(?: [ +-][.][ 0-9]{7})) [ +-][ 0-9]{5}[+-][ 0-9] [ +-][ 0-9]{5}[+-][ 0-9] [ 0-9] [ 0-9]{4}[ 0-9]$" + } + }, + "com.amazonaws.groundstation#TleLineTwo": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 69, + "max": 69 + }, + "smithy.api#pattern": "^2 [ 0-9]{5} [ 0-9]{3}[.][ 0-9]{4} [ 0-9]{3}[.][ 0-9]{4} [ 0-9]{7} [ 0-9]{3}[.][ 0-9]{4} [ 0-9]{3}[.][ 0-9]{4} [ 0-9]{2}[.][ 0-9]{13}[ 0-9]$" + } + }, "com.amazonaws.groundstation#TrackingConfig": { "type": "structure", "members": { @@ -3263,6 +5182,15 @@ "smithy.api#documentation": "Object that determines whether tracking should be used during a contact\n executed with this Config in the mission profile.
Deassigns a resource tag.
", "smithy.api#http": { "method": "DELETE", - "uri": "/tags/{resourceArn}", - "code": 200 + "uri": "/tags/{resourceArn}" }, "smithy.api#idempotent": {} } @@ -3296,7 +5223,7 @@ "type": "structure", "members": { "resourceArn": { - "target": "smithy.api#String", + "target": "com.amazonaws.groundstation#AnyArn", "traits": { "smithy.api#documentation": "ARN of a resource.
", "smithy.api#httpLabel": {}, @@ -3346,8 +5273,7 @@ "smithy.api#documentation": "Updates the Config used when scheduling contacts.
Updating a Config will not update the execution parameters\n for existing future contacts scheduled with this Config.
UUID of a Config.
Updates an existing ephemeris
", + "smithy.api#http": { + "method": "PUT", + "uri": "/ephemeris/{ephemerisId}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.groundstation#UpdateEphemerisRequest": { + "type": "structure", + "members": { + "ephemerisId": { + "target": "com.amazonaws.groundstation#Uuid", + "traits": { + "smithy.api#documentation": "The AWS Ground Station ephemeris ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "enabled": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Whether the ephemeris is enabled or not. Changing this value will not require the ephemeris to be re-validated.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.groundstation#SafeName", + "traits": { + "smithy.api#documentation": "A name string associated with the ephemeris. Used as a human-readable identifier for the ephemeris.
" + } + }, + "priority": { + "target": "com.amazonaws.groundstation#EphemerisPriority", + "traits": { + "smithy.api#documentation": "Customer-provided priority score to establish the order in which overlapping ephemerides should be used.
\nThe default for customer-provided ephemeris priority is 1, and higher numbers take precedence.
\nPriority must be 1 or greater
" + } + } + } + }, "com.amazonaws.groundstation#UpdateMissionProfile": { "type": "operation", "input": { @@ -3413,8 +5399,7 @@ "smithy.api#documentation": "Updates a mission profile.
\nUpdating a mission profile will not update the execution parameters\n for existing future contacts.
", "smithy.api#http": { "method": "PUT", - "uri": "/missionprofile/{missionProfileId}", - "code": 200 + "uri": "/missionprofile/{missionProfileId}" }, "smithy.api#idempotent": {} } @@ -3423,7 +5408,7 @@ "type": "structure", "members": { "missionProfileId": { - "target": "smithy.api#String", + "target": "com.amazonaws.groundstation#Uuid", "traits": { "smithy.api#documentation": "UUID of a mission profile.
", "smithy.api#httpLabel": {}, @@ -3449,7 +5434,7 @@ } }, "minimumViableContactDurationSeconds": { - "target": "com.amazonaws.groundstation#DurationInSeconds", + "target": "com.amazonaws.groundstation#PositiveDurationInSeconds", "traits": { "smithy.api#documentation": "Smallest amount of time in seconds that you’d like to see for an available contact. AWS Ground Station will not present you with contacts shorter than this duration.
" } @@ -3521,14 +5506,24 @@ "min": 1, "max": 128 }, - "smithy.api#pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}" + "smithy.api#pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$" + } + }, + "com.amazonaws.groundstation#Year": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 2018, + "max": 3000 + } } }, "com.amazonaws.groundstation#noradSatelliteID": { "type": "integer", "traits": { + "smithy.api#default": 0, "smithy.api#range": { - "min": 1, + "min": 0, "max": 99999 } } diff --git a/codegen/sdk-codegen/aws-models/mediapackage-vod.json b/codegen/sdk-codegen/aws-models/mediapackage-vod.json index a9bea3992b7..8102d770880 100644 --- a/codegen/sdk-codegen/aws-models/mediapackage-vod.json +++ b/codegen/sdk-codegen/aws-models/mediapackage-vod.json @@ -811,6 +811,14 @@ "smithy.api#jsonName": "includeEncoderConfigurationInSegments" } }, + "IncludeIframeOnlyStream": { + "target": "com.amazonaws.mediapackagevod#__boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "When enabled, an I-Frame only stream will be included in the output.", + "smithy.api#jsonName": "includeIframeOnlyStream" + } + }, "PeriodTriggers": { "target": "com.amazonaws.mediapackagevod#__listOf__PeriodTriggersElement", "traits": { @@ -1959,7 +1967,1241 @@ }, "aws.protocols#restJson1": {}, "smithy.api#documentation": "AWS Elemental MediaPackage VOD", - "smithy.api#title": "AWS Elemental MediaPackage VOD" + "smithy.api#title": "AWS Elemental MediaPackage VOD", + "smithy.rules#endpointRuleSet": { + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "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" + } + ] + }, + { + "fn": "parseURL", + "argv": [ + { + "ref": "Endpoint" + } + ], + "assign": "url" + } + ], + "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://mediapackage-vod-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://mediapackage-vod-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://mediapackage-vod.{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://mediapackage-vod.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ + { + "documentation": "For region ap-south-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://mediapackage-vod-fips.ap-south-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "ap-south-1" + } + }, + { + "documentation": "For region ap-south-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://mediapackage-vod-fips.ap-south-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "ap-south-1" + } + }, + { + "documentation": "For region ap-south-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://mediapackage-vod.ap-south-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "ap-south-1" + } + }, + { + "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://mediapackage-vod.ap-south-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "ap-south-1" + } + }, + { + "documentation": "For region eu-central-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://mediapackage-vod-fips.eu-central-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "eu-central-1" + } + }, + { + "documentation": "For region eu-central-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://mediapackage-vod-fips.eu-central-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "eu-central-1" + } + }, + { + "documentation": "For region eu-central-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://mediapackage-vod.eu-central-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "eu-central-1" + } + }, + { + "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://mediapackage-vod.eu-central-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "eu-central-1" + } + }, + { + "documentation": "For region us-west-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://mediapackage-vod-fips.us-west-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "us-west-1" + } + }, + { + "documentation": "For region us-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://mediapackage-vod-fips.us-west-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "us-west-1" + } + }, + { + "documentation": "For region us-west-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://mediapackage-vod.us-west-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "us-west-1" + } + }, + { + "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://mediapackage-vod.us-west-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "us-west-1" + } + }, + { + "documentation": "For region us-west-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://mediapackage-vod-fips.us-west-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "us-west-2" + } + }, + { + "documentation": "For region us-west-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://mediapackage-vod-fips.us-west-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "us-west-2" + } + }, + { + "documentation": "For region us-west-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://mediapackage-vod.us-west-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "us-west-2" + } + }, + { + "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://mediapackage-vod.us-west-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "us-west-2" + } + }, + { + "documentation": "For region eu-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://mediapackage-vod-fips.eu-north-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "eu-north-1" + } + }, + { + "documentation": "For region eu-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://mediapackage-vod-fips.eu-north-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "eu-north-1" + } + }, + { + "documentation": "For region eu-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://mediapackage-vod.eu-north-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "eu-north-1" + } + }, + { + "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://mediapackage-vod.eu-north-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "eu-north-1" + } + }, + { + "documentation": "For region eu-west-3 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://mediapackage-vod-fips.eu-west-3.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "eu-west-3" + } + }, + { + "documentation": "For region eu-west-3 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://mediapackage-vod-fips.eu-west-3.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "eu-west-3" + } + }, + { + "documentation": "For region eu-west-3 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://mediapackage-vod.eu-west-3.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "eu-west-3" + } + }, + { + "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://mediapackage-vod.eu-west-3.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "eu-west-3" + } + }, + { + "documentation": "For region eu-west-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://mediapackage-vod-fips.eu-west-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "eu-west-2" + } + }, + { + "documentation": "For region eu-west-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://mediapackage-vod-fips.eu-west-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "eu-west-2" + } + }, + { + "documentation": "For region eu-west-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://mediapackage-vod.eu-west-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "eu-west-2" + } + }, + { + "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://mediapackage-vod.eu-west-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "eu-west-2" + } + }, + { + "documentation": "For region eu-west-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://mediapackage-vod-fips.eu-west-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "eu-west-1" + } + }, + { + "documentation": "For region eu-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://mediapackage-vod-fips.eu-west-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "eu-west-1" + } + }, + { + "documentation": "For region eu-west-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://mediapackage-vod.eu-west-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "eu-west-1" + } + }, + { + "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://mediapackage-vod.eu-west-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "eu-west-1" + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://mediapackage-vod-fips.ap-northeast-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "ap-northeast-2" + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://mediapackage-vod-fips.ap-northeast-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "ap-northeast-2" + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://mediapackage-vod.ap-northeast-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "ap-northeast-2" + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://mediapackage-vod.ap-northeast-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "ap-northeast-2" + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://mediapackage-vod-fips.ap-northeast-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "ap-northeast-1" + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://mediapackage-vod-fips.ap-northeast-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "ap-northeast-1" + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://mediapackage-vod.ap-northeast-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "ap-northeast-1" + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://mediapackage-vod.ap-northeast-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "ap-northeast-1" + } + }, + { + "documentation": "For region sa-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://mediapackage-vod-fips.sa-east-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "sa-east-1" + } + }, + { + "documentation": "For region sa-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://mediapackage-vod-fips.sa-east-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "sa-east-1" + } + }, + { + "documentation": "For region sa-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://mediapackage-vod.sa-east-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "sa-east-1" + } + }, + { + "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://mediapackage-vod.sa-east-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "sa-east-1" + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://mediapackage-vod-fips.ap-southeast-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "ap-southeast-1" + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://mediapackage-vod-fips.ap-southeast-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "ap-southeast-1" + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://mediapackage-vod.ap-southeast-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "ap-southeast-1" + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://mediapackage-vod.ap-southeast-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "ap-southeast-1" + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://mediapackage-vod-fips.ap-southeast-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "ap-southeast-2" + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://mediapackage-vod-fips.ap-southeast-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "ap-southeast-2" + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://mediapackage-vod.ap-southeast-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "ap-southeast-2" + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://mediapackage-vod.ap-southeast-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "ap-southeast-2" + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "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" + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://mediapackage-vod-fips.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "us-iso-east-1" + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "us-iso-east-1" + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://mediapackage-vod.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "us-iso-east-1" + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://mediapackage-vod-fips.us-east-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "us-east-1" + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://mediapackage-vod-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "us-east-1" + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://mediapackage-vod.us-east-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "us-east-1" + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://mediapackage-vod.us-east-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "us-east-1" + } + }, + { + "documentation": "For region us-east-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://mediapackage-vod-fips.us-east-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "us-east-2" + } + }, + { + "documentation": "For region us-east-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://mediapackage-vod-fips.us-east-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "us-east-2" + } + }, + { + "documentation": "For region us-east-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://mediapackage-vod.us-east-2.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "us-east-2" + } + }, + { + "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://mediapackage-vod.us-east-2.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "us-east-2" + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "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" + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://mediapackage-vod-fips.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "us-isob-east-1" + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "us-isob-east-1" + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://mediapackage-vod.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "us-isob-east-1" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": 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": { + "UseDualStack": false, + "UseFIPS": true, + "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": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "us-east-1", + "Endpoint": "https://example.com" + } + } + ], + "version": "1.0" + } } }, "com.amazonaws.mediapackagevod#MssEncryption": { diff --git a/codegen/sdk-codegen/aws-models/transcribe-streaming.json b/codegen/sdk-codegen/aws-models/transcribe-streaming.json index 0fc0c6da42d..f5137ddee40 100644 --- a/codegen/sdk-codegen/aws-models/transcribe-streaming.json +++ b/codegen/sdk-codegen/aws-models/transcribe-streaming.json @@ -1,5 +1,5 @@ { - "smithy": "1.0", + "smithy": "2.0", "metadata": { "suppressions": [ { @@ -35,24 +35,24 @@ "Transcript": { "target": "com.amazonaws.transcribestreaming#String", "traits": { - "smithy.api#documentation": "The text that was transcribed from the audio.
" + "smithy.api#documentation": "Contains transcribed text.
" } }, "Items": { "target": "com.amazonaws.transcribestreaming#ItemList", "traits": { - "smithy.api#documentation": "One or more alternative interpretations of the input audio.
" + "smithy.api#documentation": "Contains words, phrases, or punctuation marks in your transcription output.
" } }, "Entities": { "target": "com.amazonaws.transcribestreaming#EntityList", "traits": { - "smithy.api#documentation": "Contains the entities identified as personally identifiable information (PII) in the transcription output.
" + "smithy.api#documentation": "Contains entities identified as personally identifiable information (PII) in your transcription \n output.
" } } }, "traits": { - "smithy.api#documentation": "A list of possible transcriptions for the audio.
" + "smithy.api#documentation": "A list of possible alternative transcriptions for the input audio. Each alternative may contain\n one or more of Items, Entities, or Transcript.
Provides a wrapper for the audio chunks that you are sending.
\nFor information on audio encoding in Amazon Transcribe, see \n Speech input. For information\n on audio encoding formats in Amazon Transcribe Medical, see \n Speech input.
" + "smithy.api#documentation": "A wrapper for your audio chunks. Your audio stream consists of one or more audio\n events, which consist of one or more audio chunks.
\nFor more information, see Event stream encoding.
" } }, "com.amazonaws.transcribestreaming#AudioStream": { @@ -85,12 +85,12 @@ "AudioEvent": { "target": "com.amazonaws.transcribestreaming#AudioEvent", "traits": { - "smithy.api#documentation": "A blob of audio from your application. You audio stream consists of one or more audio\n events.
\nFor information on audio encoding formats in Amazon Transcribe, see Speech input. For\n information on audio encoding formats in Amazon Transcribe Medical, see Speech input.
\nFor more information on stream encoding in Amazon Transcribe, see Event stream encoding. For\n information on stream encoding in Amazon Transcribe Medical, see Event stream encoding.
" + "smithy.api#documentation": "A blob of audio from your application. Your audio stream consists of one or more audio\n events.
\nFor more information, see Event stream encoding.
" } } }, "traits": { - "smithy.api#documentation": "Represents the audio stream from your application to Amazon Transcribe.
", + "smithy.api#documentation": "An encoded stream of audio blobs. Audio streams are encoded as either HTTP/2 or WebSocket \n data frames.
\nFor more information, see Transcribing streaming audio.
", "smithy.api#streaming": {} } }, @@ -102,20 +102,20 @@ } }, "traits": { - "smithy.api#documentation": "One or more arguments to the StartStreamTranscription or\n StartMedicalStreamTranscription operation was invalid. For example,\n MediaEncoding was not set to a valid encoding, or LanguageCode was\n not set to a valid code. Check the parameters and try your request again.
One or more arguments to the StartStreamTranscription or\n StartMedicalStreamTranscription operation was not valid. For example,\n MediaEncoding or LanguageCode used not valid values. Check the\n specified parameters and try your request again.
A new stream started with the same session ID. The current stream has been\n terminated.
", + "smithy.api#documentation": "A new stream started with the same session ID. The current stream has been terminated.
", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.transcribestreaming#ContentIdentificationType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "PII", - "name": "PII" + "type": "enum", + "members": { + "PII": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PII" } - ] + } } }, "com.amazonaws.transcribestreaming#ContentRedactionType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "PII", - "name": "PII" + "type": "enum", + "members": { + "PII": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PII" } - ] + } } }, "com.amazonaws.transcribestreaming#Double": { - "type": "double" + "type": "double", + "traits": { + "smithy.api#default": 0 + } }, "com.amazonaws.transcribestreaming#Entity": { "type": "structure", @@ -160,42 +163,44 @@ "StartTime": { "target": "com.amazonaws.transcribestreaming#Double", "traits": { - "smithy.api#documentation": "The start time of speech that was identified as PII.
" + "smithy.api#default": 0, + "smithy.api#documentation": "The start time, in milliseconds, of the utterance that was identified as PII.
" } }, "EndTime": { "target": "com.amazonaws.transcribestreaming#Double", "traits": { - "smithy.api#documentation": "The end time of speech that was identified as PII.
" + "smithy.api#default": 0, + "smithy.api#documentation": "The end time, in milliseconds, of the utterance that was identified as PII.
" } }, "Category": { "target": "com.amazonaws.transcribestreaming#String", "traits": { - "smithy.api#documentation": "The category of information identified in this entity; for example, PII.
" + "smithy.api#documentation": "The category of information identified. The only category is PII.
The type of PII identified in this entity; for example, name or credit card number.
" + "smithy.api#documentation": "The type of PII identified. For example, NAME or \n CREDIT_DEBIT_NUMBER.
The words in the transcription output that have been identified as a PII entity.
" + "smithy.api#documentation": "The word or words identified as PII.
" } }, "Confidence": { "target": "com.amazonaws.transcribestreaming#Confidence", "traits": { - "smithy.api#documentation": "A value between zero and one that Amazon Transcribe assigns to PII identified in the source audio. Larger values indicate a higher confidence in PII identification.
" + "smithy.api#documentation": "The confidence score associated with the identified PII entity in your audio.
\nConfidence scores are values between 0 and 1. A larger value indicates a higher\n probability that the identified entity correctly matches the entity spoken in your\n media.
" } } }, "traits": { - "smithy.api#documentation": "The entity identified as personally identifiable information (PII).
" + "smithy.api#documentation": "Contains entities identified as personally identifiable information (PII) in your\n transcription output, along with various associated attributes. Examples include category,\n confidence score, type, stability score, and start and end times.
" } }, "com.amazonaws.transcribestreaming#EntityList": { @@ -212,7 +217,7 @@ } }, "traits": { - "smithy.api#documentation": "A problem occurred while processing the audio. Amazon Transcribe or Amazon Transcribe Medical terminated processing. Try\n your request again.
", + "smithy.api#documentation": "A problem occurred while processing the audio. Amazon Transcribe terminated \n processing.
", "smithy.api#error": "server", "smithy.api#httpError": 500 } @@ -223,54 +228,57 @@ "StartTime": { "target": "com.amazonaws.transcribestreaming#Double", "traits": { - "smithy.api#documentation": "The offset from the beginning of the audio stream to the beginning of the audio that\n resulted in the item.
" + "smithy.api#default": 0, + "smithy.api#documentation": "The start time, in milliseconds, of the transcribed item.
" } }, "EndTime": { "target": "com.amazonaws.transcribestreaming#Double", "traits": { - "smithy.api#documentation": "The offset from the beginning of the audio stream to the end of the audio that resulted in\n the item.
" + "smithy.api#default": 0, + "smithy.api#documentation": "The end time, in milliseconds, of the transcribed item.
" } }, "Type": { "target": "com.amazonaws.transcribestreaming#ItemType", "traits": { - "smithy.api#documentation": "The type of the item. PRONUNCIATION indicates that the item is a word\n that was recognized in the input audio. PUNCTUATION indicates that the item\n was interpreted as a pause in the input audio.
The type of item identified. Options are: PRONUNCIATION (spoken words) and\n PUNCTUATION.
The word or punctuation that was recognized in the input audio.
" + "smithy.api#documentation": "The word or punctuation that was transcribed.
" } }, "VocabularyFilterMatch": { "target": "com.amazonaws.transcribestreaming#Boolean", "traits": { - "smithy.api#documentation": "Indicates whether a word in the item matches a word in the vocabulary filter you've chosen\n for your media stream. If true then a word in the item matches your\n vocabulary filter.
Indicates whether the specified item matches a word in the vocabulary filter included in\n your request. If true, there is a vocabulary filter match.
If speaker identification is enabled, shows the speakers identified in the media\n stream.
" + "smithy.api#documentation": "If speaker partitioning is enabled, Speaker labels the speaker of the\n specified item.
A value between zero and one for an item that is a confidence score that Amazon Transcribe assigns to each\n word or phrase that it transcribes.
" + "smithy.api#documentation": "The confidence score associated with a word or phrase in your transcript.
\nConfidence scores are values between 0 and 1. A larger value indicates a higher\n probability that the identified item correctly matches the item spoken in your media.
" } }, "Stable": { "target": "com.amazonaws.transcribestreaming#Stable", "traits": { - "smithy.api#documentation": "If partial result stabilization has been enabled, indicates whether the word or phrase in\n the item is stable. If Stable is true, the result is stable.
If partial result stabilization is enabled, Stable indicates whether the specified \n item is stable (true) or if it may change when the segment is complete \n (false).
A word, phrase, or punctuation mark that is transcribed from the input audio.
" + "smithy.api#documentation": "A word, phrase, or punctuation mark in your transcription output, along with various associated\n attributes, such as confidence score, type, and start and end times.
" } }, "com.amazonaws.transcribestreaming#ItemList": { @@ -280,73 +288,109 @@ } }, "com.amazonaws.transcribestreaming#ItemType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "pronunciation", - "name": "PRONUNCIATION" - }, - { - "value": "punctuation", - "name": "PUNCTUATION" + "type": "enum", + "members": { + "PRONUNCIATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pronunciation" + } + }, + "PUNCTUATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "punctuation" } - ] + } } }, "com.amazonaws.transcribestreaming#LanguageCode": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "en-US", - "name": "EN_US" - }, - { - "value": "en-GB", - "name": "EN_GB" - }, - { - "value": "es-US", - "name": "ES_US" - }, - { - "value": "fr-CA", - "name": "FR_CA" - }, - { - "value": "fr-FR", - "name": "FR_FR" - }, - { - "value": "en-AU", - "name": "EN_AU" - }, - { - "value": "it-IT", - "name": "IT_IT" - }, - { - "value": "de-DE", - "name": "DE_DE" - }, - { - "value": "pt-BR", - "name": "PT_BR" - }, - { - "value": "ja-JP", - "name": "JA_JP" - }, - { - "value": "ko-KR", - "name": "KO_KR" - }, - { - "value": "zh-CN", - "name": "ZH_CN" + "type": "enum", + "members": { + "EN_US": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "en-US" + } + }, + "EN_GB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "en-GB" + } + }, + "ES_US": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "es-US" + } + }, + "FR_CA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "fr-CA" + } + }, + "FR_FR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "fr-FR" + } + }, + "EN_AU": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "en-AU" + } + }, + "IT_IT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "it-IT" + } + }, + "DE_DE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "de-DE" + } + }, + "PT_BR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pt-BR" } - ] + }, + "JA_JP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ja-JP" + } + }, + "KO_KR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ko-KR" + } + }, + "ZH_CN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "zh-CN" + } + }, + "HI_IN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "hi-IN" + } + }, + "TH_TH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "th-TH" + } + } } }, "com.amazonaws.transcribestreaming#LanguageIdentification": { @@ -371,18 +415,19 @@ "LanguageCode": { "target": "com.amazonaws.transcribestreaming#LanguageCode", "traits": { - "smithy.api#documentation": "The language code of the language identified by Amazon Transcribe.
" + "smithy.api#documentation": "The language code of the identified language.
" } }, "Score": { "target": "com.amazonaws.transcribestreaming#Double", "traits": { - "smithy.api#documentation": "The confidence score for the associated language code. Confidence scores are values\n between zero and one; larger values indicate a higher confidence in the identified language.\n
" + "smithy.api#default": 0, + "smithy.api#documentation": "The confidence score associated with the identified language code. Confidence scores are values\n between zero and one; larger values indicate a higher confidence in the identified language.
" } } }, "traits": { - "smithy.api#documentation": "The language codes of the identified languages and their associated confidence scores. \n The confidence score is a value between zero and one; a larger value indicates a higher \n confidence in the identified language.
" + "smithy.api#documentation": "The language code that represents the language identified in your audio, including the associated\n confidence score. If you enabled channel identification in your request and each channel contained a \n different language, you will have more than one LanguageWithScore result.
You have exceeded the maximum number of concurrent transcription streams, are starting\n transcription streams too quickly, or the maximum audio length of 4 hours. Wait until a stream\n has finished processing, or break your audio stream into smaller chunks and try your request\n again.
", + "smithy.api#documentation": "Your client has exceeded one of the Amazon Transcribe limits. This is typically the audio length\n limit. Break your audio stream into smaller chunks and try your request again.
", "smithy.api#error": "client", "smithy.api#httpError": 429 } }, "com.amazonaws.transcribestreaming#MediaEncoding": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "pcm", - "name": "PCM" - }, - { - "value": "ogg-opus", - "name": "OGG_OPUS" - }, - { - "value": "flac", - "name": "FLAC" + "type": "enum", + "members": { + "PCM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pcm" + } + }, + "OGG_OPUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ogg-opus" + } + }, + "FLAC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "flac" } - ] + } } }, "com.amazonaws.transcribestreaming#MediaSampleRateHertz": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 8000, "max": 48000 @@ -433,24 +481,24 @@ "Transcript": { "target": "com.amazonaws.transcribestreaming#String", "traits": { - "smithy.api#documentation": "The text that was transcribed from the audio.
" + "smithy.api#documentation": "Contains transcribed text.
" } }, "Items": { "target": "com.amazonaws.transcribestreaming#MedicalItemList", "traits": { - "smithy.api#documentation": "A list of objects that contains words and punctuation marks that represents one or\n more interpretations of the input audio.
" + "smithy.api#documentation": "Contains words, phrases, or punctuation marks in your transcription output.
" } }, "Entities": { "target": "com.amazonaws.transcribestreaming#MedicalEntityList", "traits": { - "smithy.api#documentation": "Contains the medical entities identified as personal health information in the transcription output.
" + "smithy.api#documentation": "Contains entities identified as personal health information (PHI) in your transcription \n output.
" } } }, "traits": { - "smithy.api#documentation": "A list of possible transcriptions for the audio.
" + "smithy.api#documentation": "A list of possible alternative transcriptions for the input audio. Each alternative may\n contain one or more of Items, Entities, or\n Transcript.
The start time of the speech that was identified as a medical entity.
" + "smithy.api#default": 0, + "smithy.api#documentation": "The start time, in milliseconds, of the utterance that was identified as PHI.
" } }, "EndTime": { "target": "com.amazonaws.transcribestreaming#Double", "traits": { - "smithy.api#documentation": "The end time of the speech that was identified as a medical entity.
" + "smithy.api#default": 0, + "smithy.api#documentation": "The end time, in milliseconds, of the utterance that was identified as PHI.
" } }, "Category": { "target": "com.amazonaws.transcribestreaming#String", "traits": { - "smithy.api#documentation": "The type of personal health information of the medical entity.
" + "smithy.api#documentation": "The category of information identified. The only category is PHI.
The word or words in the transcription output that have been identified as a\n medical entity.
" + "smithy.api#documentation": "The word or words identified as PHI.
" } }, "Confidence": { "target": "com.amazonaws.transcribestreaming#Confidence", "traits": { - "smithy.api#documentation": "A value between zero and one that Amazon Transcribe Medical assigned to the personal health information\n that it identified in the source audio. Larger values indicate that Amazon Transcribe Medical has higher\n confidence in the personal health information that it identified.
" + "smithy.api#documentation": "The confidence score associated with the identified PHI entity in your audio.
\nConfidence scores are values between 0 and 1. A larger value indicates a higher\n probability that the identified entity correctly matches the entity spoken in your\n media.
" } } }, "traits": { - "smithy.api#documentation": "The medical entity identified as personal health information.
" + "smithy.api#documentation": "Contains entities identified as personal health information (PHI) in your\n transcription output, along with various associated attributes. Examples include\n category, confidence score, type, stability score, and start and end times.
" } }, "com.amazonaws.transcribestreaming#MedicalEntityList": { @@ -520,42 +570,44 @@ "StartTime": { "target": "com.amazonaws.transcribestreaming#Double", "traits": { - "smithy.api#documentation": "The number of seconds into an audio stream that indicates the creation time of an\n item.
" + "smithy.api#default": 0, + "smithy.api#documentation": "The start time, in milliseconds, of the transcribed item.
" } }, "EndTime": { "target": "com.amazonaws.transcribestreaming#Double", "traits": { - "smithy.api#documentation": "The number of seconds into an audio stream that indicates the creation time of an\n item.
" + "smithy.api#default": 0, + "smithy.api#documentation": "The end time, in milliseconds, of the transcribed item.
" } }, "Type": { "target": "com.amazonaws.transcribestreaming#ItemType", "traits": { - "smithy.api#documentation": "The type of the item. PRONUNCIATION indicates that the item is a word\n that was recognized in the input audio. PUNCTUATION indicates that the item\n was interpreted as a pause in the input audio, such as a period to indicate the end of a\n sentence.
The type of item identified. Options are: PRONUNCIATION (spoken \n words) and PUNCTUATION.
The word or punctuation mark that was recognized in the input audio.
" + "smithy.api#documentation": "The word or punctuation that was transcribed.
" } }, "Confidence": { "target": "com.amazonaws.transcribestreaming#Confidence", "traits": { - "smithy.api#documentation": "A value between 0 and 1 for an item that is a confidence score that Amazon Transcribe Medical assigns to\n each word that it transcribes.
" + "smithy.api#documentation": "The confidence score associated with a word or phrase in your transcript.
\nConfidence scores are values between 0 and 1. A larger value indicates a higher\n probability that the identified item correctly matches the item spoken in your\n media.
" } }, "Speaker": { "target": "com.amazonaws.transcribestreaming#String", "traits": { - "smithy.api#documentation": "If speaker identification is enabled, shows the integer values that correspond to the\n different speakers identified in the stream. For example, if the value of\n Speaker in the stream is either a 0 or a 1,\n that indicates that Amazon Transcribe Medical has identified two speakers in the stream. The value of\n 0 corresponds to one speaker and the value of 1\n corresponds to the other speaker.
If speaker partitioning is enabled, Speaker labels the speaker of the\n specified item.
A word, phrase, or punctuation mark that is transcribed from the input audio.
" + "smithy.api#documentation": "A word, phrase, or punctuation mark in your transcription output, along with various \n associated attributes, such as confidence score, type, and start and end times.
" } }, "com.amazonaws.transcribestreaming#MedicalItemList": { @@ -570,42 +622,45 @@ "ResultId": { "target": "com.amazonaws.transcribestreaming#String", "traits": { - "smithy.api#documentation": "A unique identifier for the result.
" + "smithy.api#documentation": "Provides a unique identifier for the Result.
The time, in seconds, from the beginning of the audio stream to the beginning of the\n result.
" + "smithy.api#default": 0, + "smithy.api#documentation": "The start time, in milliseconds, of the Result.
The time, in seconds, from the beginning of the audio stream to the end of the\n result.
" + "smithy.api#default": 0, + "smithy.api#documentation": "The end time, in milliseconds, of the Result.
Amazon Transcribe Medical divides the incoming audio stream into segments at natural points in the audio.\n Transcription results are returned based on these segments.
\nThe IsPartial field is true to indicate that Amazon Transcribe Medical has\n additional transcription data to send. The IsPartial field is\n false to indicate that this is the last transcription result for the\n segment.
Indicates if the segment is complete.
\nIf IsPartial is true, the segment is not complete. If\n IsPartial is false, the segment is complete.
A list of possible transcriptions of the audio. Each alternative typically contains\n one Item that contains the result of the transcription.
A list of possible alternative transcriptions for the input audio. Each alternative may \n contain one or more of Items, Entities, or\n Transcript.
When channel identification is enabled, Amazon Transcribe Medical transcribes the speech from each audio\n channel separately.
\nYou can use ChannelId to retrieve the transcription results for a single\n channel in your audio stream.
Indicates the channel identified for the Result.
The results of transcribing a portion of the input audio stream.
" + "smithy.api#documentation": "The Result associated with a \n .
Contains a set of transcription results from one or more audio segments, along with\n additional information per your request parameters. This can include information relating to\n alternative transcriptions, channel identification, partial result stabilization, language \n identification, and other transcription-related data.
" } }, "com.amazonaws.transcribestreaming#MedicalResultList": { @@ -620,12 +675,12 @@ "Results": { "target": "com.amazonaws.transcribestreaming#MedicalResultList", "traits": { - "smithy.api#documentation": "\n MedicalResult objects that contain the results of transcribing a\n portion of the input audio stream. The array can be empty.
" + "smithy.api#documentation": "Contains a set of transcription results from one or more audio segments, along with \n additional information per your request parameters. This can include information relating to \n alternative transcriptions, channel identification, partial result stabilization, language \n identification, and other transcription-related data.
" } } }, "traits": { - "smithy.api#documentation": "The medical transcript in a MedicalTranscriptEvent.
" + "smithy.api#documentation": "The MedicalTranscript associated with a \n .
\n MedicalTranscript contains Results, which contains a set of \n transcription results from one or more audio segments, along with additional information per your \n request parameters.
The transcription of the audio stream. The transcription is composed of all of the\n items in the results list.
" + "smithy.api#documentation": "Contains Results, which contains a set of transcription results from one or \n more audio segments, along with additional information per your request parameters. This can\n include information relating to alternative transcriptions, channel identification, partial result \n stabilization, language identification, and other transcription-related data.
Represents a set of transcription results from the server to the client. It contains\n one or more segments of the transcription.
" + "smithy.api#documentation": "The MedicalTranscriptEvent associated with a \n MedicalTranscriptResultStream.
Contains a set of transcription results from one or more audio segments, along with additional \n information per your request parameters.
" } }, "com.amazonaws.transcribestreaming#MedicalTranscriptResultStream": { @@ -648,7 +703,7 @@ "TranscriptEvent": { "target": "com.amazonaws.transcribestreaming#MedicalTranscriptEvent", "traits": { - "smithy.api#documentation": "A portion of the transcription of the audio stream. Events are sent periodically from\n Amazon Transcribe Medical to your application. The event can be a partial transcription of a section of the\n audio stream, or it can be the entire transcription of that portion of the audio\n stream.
" + "smithy.api#documentation": "The MedicalTranscriptEvent associated with a \n MedicalTranscriptResultStream.
Contains a set of transcription results from one or more audio segments, along with \n additional information per your request parameters. This can include information relating to\n alternative transcriptions, channel identification, partial result stabilization, language \n identification, and other transcription-related data.
" } }, "BadRequestException": { @@ -668,7 +723,7 @@ } }, "traits": { - "smithy.api#documentation": "Represents the transcription result stream from Amazon Transcribe Medical to your application.
", + "smithy.api#documentation": "Contains detailed information about your streaming session.
", "smithy.api#streaming": {} } }, @@ -685,29 +740,32 @@ "com.amazonaws.transcribestreaming#NumberOfChannels": { "type": "integer", "traits": { - "smithy.api#box": {}, "smithy.api#range": { "min": 2 } } }, "com.amazonaws.transcribestreaming#PartialResultsStability": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "high", - "name": "HIGH" - }, - { - "value": "medium", - "name": "MEDIUM" - }, - { - "value": "low", - "name": "LOW" + "type": "enum", + "members": { + "HIGH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "high" + } + }, + "MEDIUM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "medium" + } + }, + "LOW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "low" } - ] + } } }, "com.amazonaws.transcribestreaming#PiiEntityTypes": { @@ -729,54 +787,57 @@ "ResultId": { "target": "com.amazonaws.transcribestreaming#String", "traits": { - "smithy.api#documentation": "A unique identifier for the result.
" + "smithy.api#documentation": "Provides a unique identifier for the Result.
The offset in seconds from the beginning of the audio stream to the beginning of the\n result.
" + "smithy.api#default": 0, + "smithy.api#documentation": "The start time, in milliseconds, of the Result.
The offset in seconds from the beginning of the audio stream to the end of the\n result.
" + "smithy.api#default": 0, + "smithy.api#documentation": "The end time, in milliseconds, of the Result.
Amazon Transcribe divides the incoming audio stream into segments at natural points in the audio.\n Transcription results are returned based on these segments.
\nThe IsPartial field is true to indicate that Amazon Transcribe has\n additional transcription data to send, false to indicate that this is the last\n transcription result for the segment.
Indicates if the segment is complete.
\nIf IsPartial is true, the segment is not complete. If\n IsPartial is false, the segment is complete.
A list of possible transcriptions for the audio. Each alternative typically contains one\n item that contains the result of the transcription.
A list of possible alternative transcriptions for the input audio. Each alternative may contain\n one or more of Items, Entities, or Transcript.
When channel identification is enabled, Amazon Transcribe transcribes the speech from each audio\n channel separately.
\nYou can use ChannelId to retrieve the transcription results for a single\n channel in your audio stream.
Indicates the channel identified for the Result.
The language code of the identified language in your media stream.
" + "smithy.api#documentation": "The language code that represents the language spoken in your audio stream.
" } }, "LanguageIdentification": { "target": "com.amazonaws.transcribestreaming#LanguageIdentification", "traits": { - "smithy.api#documentation": "The language code of the dominant language identified in your media.
" + "smithy.api#documentation": "The language code of the dominant language identified in your stream.
\nIf you enabled channel identification and each channel of your audio contains a different language,\n you may have more than one result.
" } } }, "traits": { - "smithy.api#documentation": "The result of transcribing a portion of the input audio stream.
" + "smithy.api#documentation": "The Result associated with a \n .
Contains a set of transcription results from one or more audio segments, along with additional \n information per your request parameters. This can include information relating to alternative\n transcriptions, channel identification, partial result stabilization, language identification, and other\n transcription-related data.
" } }, "com.amazonaws.transcribestreaming#ResultList": { @@ -793,7 +854,7 @@ } }, "traits": { - "smithy.api#documentation": "Service is currently unavailable. Try your request later.
", + "smithy.api#documentation": "The service is currently unavailable. Try your request later.
", "smithy.api#error": "server", "smithy.api#httpError": 503 } @@ -809,41 +870,48 @@ } }, "com.amazonaws.transcribestreaming#Specialty": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "PRIMARYCARE", - "name": "PRIMARYCARE" - }, - { - "value": "CARDIOLOGY", - "name": "CARDIOLOGY" - }, - { - "value": "NEUROLOGY", - "name": "NEUROLOGY" - }, - { - "value": "ONCOLOGY", - "name": "ONCOLOGY" - }, - { - "value": "RADIOLOGY", - "name": "RADIOLOGY" - }, - { - "value": "UROLOGY", - "name": "UROLOGY" + "type": "enum", + "members": { + "PRIMARYCARE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PRIMARYCARE" + } + }, + "CARDIOLOGY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CARDIOLOGY" + } + }, + "NEUROLOGY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NEUROLOGY" + } + }, + "ONCOLOGY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ONCOLOGY" + } + }, + "RADIOLOGY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RADIOLOGY" + } + }, + "UROLOGY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UROLOGY" } - ] + } } }, "com.amazonaws.transcribestreaming#Stable": { - "type": "boolean", - "traits": { - "smithy.api#box": {} - } + "type": "boolean" }, "com.amazonaws.transcribestreaming#StartMedicalStreamTranscription": { "type": "operation", @@ -871,7 +939,7 @@ } ], "traits": { - "smithy.api#documentation": "Starts a bidirectional HTTP/2 stream where audio is streamed to Amazon Transcribe Medical and the\n transcription results are streamed to your application.
", + "smithy.api#documentation": "Starts a bidirectional HTTP/2 or WebSocket stream where audio is streamed to \n Amazon Transcribe Medical and the transcription results are streamed to your\n application.
\nFor more information on streaming with Amazon Transcribe Medical, see \n Transcribing\n streaming audio.
", "smithy.api#http": { "method": "POST", "uri": "/medical-stream-transcription", @@ -885,7 +953,7 @@ "LanguageCode": { "target": "com.amazonaws.transcribestreaming#LanguageCode", "traits": { - "smithy.api#documentation": "Indicates the source language used in the input audio stream. For Amazon Transcribe Medical, this is US\n English (en-US).
", + "smithy.api#documentation": "Specify the language code that represents the language spoken in your audio.
\nAmazon Transcribe Medical only supports US English (en-US).
The sample rate of the input audio (in Hertz). Amazon Transcribe medical supports a range from \n 16,000 Hz to 48,000 Hz. Note that the sample rate you specify must match that of your\n audio.
", + "smithy.api#documentation": "The sample rate of the input audio (in hertz). Amazon Transcribe Medical supports a\n range from 16,000 Hz to 48,000 Hz. Note that the sample rate you specify must match that\n of your audio.
", "smithy.api#httpHeader": "x-amzn-transcribe-sample-rate", "smithy.api#required": {} } @@ -901,7 +969,7 @@ "MediaEncoding": { "target": "com.amazonaws.transcribestreaming#MediaEncoding", "traits": { - "smithy.api#documentation": "The encoding used for the input audio.
", + "smithy.api#documentation": "Specify the encoding used for the input audio. Supported formats are:
\nFLAC
\nOPUS-encoded audio in an Ogg container
\nPCM (only signed 16-bit little-endian audio formats, which does not include\n WAV)
\nFor more information, see Media formats.
", "smithy.api#httpHeader": "x-amzn-transcribe-media-encoding", "smithy.api#required": {} } @@ -909,14 +977,14 @@ "VocabularyName": { "target": "com.amazonaws.transcribestreaming#VocabularyName", "traits": { - "smithy.api#documentation": "The name of the medical custom vocabulary to use when processing the real-time\n stream.
", + "smithy.api#documentation": "Specify the name of the custom vocabulary that you want to use when processing your\n transcription. Note that vocabulary names are case sensitive.
", "smithy.api#httpHeader": "x-amzn-transcribe-vocabulary-name" } }, "Specialty": { "target": "com.amazonaws.transcribestreaming#Specialty", "traits": { - "smithy.api#documentation": "The medical specialty of the clinician or provider.
", + "smithy.api#documentation": "Specify the medical specialty contained in your audio.
", "smithy.api#httpHeader": "x-amzn-transcribe-specialty", "smithy.api#required": {} } @@ -924,7 +992,7 @@ "Type": { "target": "com.amazonaws.transcribestreaming#Type", "traits": { - "smithy.api#documentation": "The type of input audio. Choose DICTATION for a provider dictating\n patient notes. Choose CONVERSATION for a dialogue between a patient and one\n or more medical professionanls.
Specify the type of input audio. For example, choose DICTATION for a \n provider dictating patient notes and CONVERSATION for a dialogue between a\n patient and a medical professional.
When true, enables speaker identification in your real-time\n stream.
Enables speaker partitioning (diarization) in your transcription output. Speaker\n partitioning labels the speech from individual speakers in your media file.
\nFor more information, see Partitioning speakers (diarization).
", "smithy.api#httpHeader": "x-amzn-transcribe-show-speaker-label" } }, "SessionId": { "target": "com.amazonaws.transcribestreaming#SessionId", "traits": { - "smithy.api#documentation": "Optional. An identifier for the transcription session. If you don't provide a session\n ID, Amazon Transcribe generates one for you and returns it in the response.
", + "smithy.api#documentation": "Specify a name for your transcription session. If you don't include this parameter in \n your request, Amazon Transcribe Medical generates an ID and returns it in the\n response.
\nYou can use a session ID to retry a streaming session.
", "smithy.api#httpHeader": "x-amzn-transcribe-session-id" } }, @@ -953,21 +1022,22 @@ "EnableChannelIdentification": { "target": "com.amazonaws.transcribestreaming#Boolean", "traits": { - "smithy.api#documentation": "When true, instructs Amazon Transcribe Medical to process each audio channel separately and\n then merge the transcription output of each channel into a single transcription.
Amazon Transcribe Medical also produces a transcription of each item. An item includes the start time,\n end time, and any alternative transcriptions.
\nYou can't set both ShowSpeakerLabel and\n EnableChannelIdentification in the same request. If you set both, your\n request returns a BadRequestException.
Enables channel identification in multi-channel audio.
\nChannel identification transcribes the audio on each channel independently, then appends\n the output for each channel into one transcript.
\nIf you have multi-channel audio and do not enable channel identification, your audio is \n transcribed in a continuous manner and your transcript is not separated by channel.
\nFor more information, see Transcribing multi-channel audio.
", "smithy.api#httpHeader": "x-amzn-transcribe-enable-channel-identification" } }, "NumberOfChannels": { "target": "com.amazonaws.transcribestreaming#NumberOfChannels", "traits": { - "smithy.api#documentation": "The number of channels that are in your audio stream.
", + "smithy.api#documentation": "Specify the number of channels in your audio stream. Up to two channels are\n supported.
", "smithy.api#httpHeader": "x-amzn-transcribe-number-of-channels" } }, "ContentIdentificationType": { "target": "com.amazonaws.transcribestreaming#MedicalContentIdentificationType", "traits": { - "smithy.api#documentation": "Set this field to PHI to identify personal health information in the\n transcription output.
Labels all personal health information (PHI) identified in your transcript.
\nContent identification is performed at the segment level; PHI is flagged upon complete\n transcription of an audio segment.
\nFor more information, see Identifying personal health information (PHI) in a\n transcription.
", "smithy.api#httpHeader": "x-amzn-transcribe-content-identification-type" } } @@ -979,91 +1049,93 @@ "RequestId": { "target": "com.amazonaws.transcribestreaming#RequestId", "traits": { - "smithy.api#documentation": "An identifier for the streaming transcription.
", + "smithy.api#documentation": "Provides the identifier for your streaming request.
", "smithy.api#httpHeader": "x-amzn-request-id" } }, "LanguageCode": { "target": "com.amazonaws.transcribestreaming#LanguageCode", "traits": { - "smithy.api#documentation": "The language code for the response transcript. For Amazon Transcribe Medical, this is US English\n (en-US).
", + "smithy.api#documentation": "Provides the language code that you specified in your request. This must be\n en-US.
The sample rate of the input audio, in Hertz (Hz).
", + "smithy.api#documentation": "Provides the sample rate that you specified in your request.
", "smithy.api#httpHeader": "x-amzn-transcribe-sample-rate" } }, "MediaEncoding": { "target": "com.amazonaws.transcribestreaming#MediaEncoding", "traits": { - "smithy.api#documentation": "The encoding used for the input audio stream.
", + "smithy.api#documentation": "Provides the media encoding you specified in your request.
", "smithy.api#httpHeader": "x-amzn-transcribe-media-encoding" } }, "VocabularyName": { "target": "com.amazonaws.transcribestreaming#VocabularyName", "traits": { - "smithy.api#documentation": "The name of the vocabulary used when processing the stream.
", + "smithy.api#documentation": "Provides the name of the custom vocabulary that you specified in your request.
", "smithy.api#httpHeader": "x-amzn-transcribe-vocabulary-name" } }, "Specialty": { "target": "com.amazonaws.transcribestreaming#Specialty", "traits": { - "smithy.api#documentation": "The specialty in the medical domain.
", + "smithy.api#documentation": "Provides the medical specialty that you specified in your request.
", "smithy.api#httpHeader": "x-amzn-transcribe-specialty" } }, "Type": { "target": "com.amazonaws.transcribestreaming#Type", "traits": { - "smithy.api#documentation": "The type of audio that was transcribed.
", + "smithy.api#documentation": "Provides the type of audio you specified in your request.
", "smithy.api#httpHeader": "x-amzn-transcribe-type" } }, "ShowSpeakerLabel": { "target": "com.amazonaws.transcribestreaming#Boolean", "traits": { - "smithy.api#documentation": "Shows whether speaker identification was enabled in the stream.
", + "smithy.api#default": false, + "smithy.api#documentation": "Shows whether speaker partitioning was enabled for your transcription.
", "smithy.api#httpHeader": "x-amzn-transcribe-show-speaker-label" } }, "SessionId": { "target": "com.amazonaws.transcribestreaming#SessionId", "traits": { - "smithy.api#documentation": "Optional. An identifier for the transcription session. If you don't provide a session\n ID, Amazon Transcribe generates one for you and returns it in the response.
", + "smithy.api#documentation": "Provides the identifier for your transcription session.
", "smithy.api#httpHeader": "x-amzn-transcribe-session-id" } }, "TranscriptResultStream": { "target": "com.amazonaws.transcribestreaming#MedicalTranscriptResultStream", "traits": { - "smithy.api#documentation": "Represents the stream of transcription events from Amazon Transcribe Medical to your application.
", + "smithy.api#documentation": "Provides detailed information about your streaming session.
", "smithy.api#httpPayload": {} } }, "EnableChannelIdentification": { "target": "com.amazonaws.transcribestreaming#Boolean", "traits": { - "smithy.api#documentation": "Shows whether channel identification has been enabled in the stream.
", + "smithy.api#default": false, + "smithy.api#documentation": "Shows whether channel identification was enabled for your transcription.
", "smithy.api#httpHeader": "x-amzn-transcribe-enable-channel-identification" } }, "NumberOfChannels": { "target": "com.amazonaws.transcribestreaming#NumberOfChannels", "traits": { - "smithy.api#documentation": "The number of channels identified in the stream.
", + "smithy.api#documentation": "Provides the number of channels that you specified in your request.
", "smithy.api#httpHeader": "x-amzn-transcribe-number-of-channels" } }, "ContentIdentificationType": { "target": "com.amazonaws.transcribestreaming#MedicalContentIdentificationType", "traits": { - "smithy.api#documentation": "If the value is PHI, indicates that you've configured your stream to\n identify personal health information.
Shows whether content identification was enabled for your transcription.
", "smithy.api#httpHeader": "x-amzn-transcribe-content-identification-type" } } @@ -1095,7 +1167,7 @@ } ], "traits": { - "smithy.api#documentation": "Starts a bidirectional HTTP/2 stream where audio is streamed to Amazon Transcribe and the transcription\n results are streamed to your application.
\nThe following are encoded as HTTP/2 headers:
\nx-amzn-transcribe-language-code
\nx-amzn-transcribe-media-encoding
\nx-amzn-transcribe-sample-rate
\nx-amzn-transcribe-session-id
\nSee the SDK for Go API Reference for more detail.
", + "smithy.api#documentation": "Starts a bidirectional HTTP/2 or WebSocket stream where audio is streamed to \n Amazon Transcribe and the transcription results are streamed to your application.
\nThe following are encoded as headers:
\nlanguage-code
\nmedia-encoding
\nsample-rate
\nsession-id
\nFor more information on streaming with Amazon Transcribe, see Transcribing streaming audio.
", "smithy.api#http": { "method": "POST", "uri": "/stream-transcription", @@ -1109,14 +1181,14 @@ "LanguageCode": { "target": "com.amazonaws.transcribestreaming#LanguageCode", "traits": { - "smithy.api#documentation": "The language code of the input audio stream.
", + "smithy.api#documentation": "Specify the language code that represents the language spoken in your audio.
\nIf you're unsure of the language spoken in your audio, consider using \n IdentifyLanguage to enable automatic language identification.
For a list of languages supported with Amazon Transcribe streaming, refer to the \n Supported \n languages table.
", "smithy.api#httpHeader": "x-amzn-transcribe-language-code" } }, "MediaSampleRateHertz": { "target": "com.amazonaws.transcribestreaming#MediaSampleRateHertz", "traits": { - "smithy.api#documentation": "The sample rate of the input audio (in Hertz). Low-quality audio, such as telephone \n audio, is typically around 8,000 Hz. High-quality audio typically ranges from 16,000 Hz to \n 48,000 Hz. Note that the sample rate you specify must match that of your audio.
", + "smithy.api#documentation": "The sample rate of the input audio (in hertz). Low-quality audio, such as telephone audio,\n is typically around 8,000 Hz. High-quality audio typically ranges from 16,000 Hz to 48,000 Hz.\n Note that the sample rate you specify must match that of your audio.
", "smithy.api#httpHeader": "x-amzn-transcribe-sample-rate", "smithy.api#required": {} } @@ -1124,7 +1196,7 @@ "MediaEncoding": { "target": "com.amazonaws.transcribestreaming#MediaEncoding", "traits": { - "smithy.api#documentation": "The encoding used for the input audio.
", + "smithy.api#documentation": "Specify the encoding used for the input audio. Supported formats are:
\nFLAC
\nOPUS-encoded audio in an Ogg container
\nPCM (only signed 16-bit little-endian audio formats, which does not include WAV)
\nFor more information, see Media formats.
", "smithy.api#httpHeader": "x-amzn-transcribe-media-encoding", "smithy.api#required": {} } @@ -1132,21 +1204,21 @@ "VocabularyName": { "target": "com.amazonaws.transcribestreaming#VocabularyName", "traits": { - "smithy.api#documentation": "The name of the custom vocabulary you want to use with your transcription.
\nThis operation is not intended for use in conjunction with the \n IdentifyLanguage operation. If you're using IdentifyLanguage\n in your request and want to use one or more custom vocabularies with your transcription, use the \n VocabularyNames operation instead.
Specify the name of the custom vocabulary that you want to use when processing your\n transcription. Note that vocabulary names are case sensitive.
\nIf the language of the specified custom vocabulary doesn't match the language identified in\n your media, your job fails.
\nThis parameter is not intended for use with the\n IdentifyLanguage parameter. If you're including IdentifyLanguage\n in your request and want to use one or more custom vocabularies with your transcription, use\n the VocabularyNames parameter instead.
For more information, see Custom vocabularies.
", "smithy.api#httpHeader": "x-amzn-transcribe-vocabulary-name" } }, "SessionId": { "target": "com.amazonaws.transcribestreaming#SessionId", "traits": { - "smithy.api#documentation": "A identifier for the transcription session. Use this parameter when you want to retry a\n session. If you don't provide a session ID, Amazon Transcribe will generate one for you and return it in\n the response.
", + "smithy.api#documentation": "Specify a name for your transcription session. If you don't include this parameter in your request, \n Amazon Transcribe generates an ID and returns it in the response.
\nYou can use a session ID to retry a streaming session.
", "smithy.api#httpHeader": "x-amzn-transcribe-session-id" } }, "AudioStream": { "target": "com.amazonaws.transcribestreaming#AudioStream", "traits": { - "smithy.api#documentation": "PCM-encoded stream of audio blobs. The audio stream is encoded as an HTTP/2 data\n frame.
", + "smithy.api#documentation": "An encoded stream of audio blobs. Audio streams are encoded as either HTTP/2 or WebSocket \n data frames.
\nFor more information, see Transcribing streaming audio.
", "smithy.api#httpPayload": {}, "smithy.api#required": {} } @@ -1154,112 +1226,116 @@ "VocabularyFilterName": { "target": "com.amazonaws.transcribestreaming#VocabularyFilterName", "traits": { - "smithy.api#documentation": "The name of the vocabulary filter you want to use with your transcription.
\nThis operation is not intended for use in conjunction with the \n IdentifyLanguage operation. If you're using IdentifyLanguage\n in your request and want to use one or more vocabulary filters with your transcription, use the \n VocabularyFilterNames operation instead.
Specify the name of the custom vocabulary filter that you want to use when processing your\n transcription. Note that vocabulary filter names are case sensitive.
\nIf the language of the specified custom vocabulary filter doesn't match the language identified in\n your media, your job fails.
\nThis parameter is not intended for use with the\n IdentifyLanguage parameter. If you're including IdentifyLanguage\n in your request and want to use one or more vocabulary filters with your transcription, use\n the VocabularyFilterNames parameter instead.
For more information, see Using vocabulary filtering with unwanted \n words.
", "smithy.api#httpHeader": "x-amzn-transcribe-vocabulary-filter-name" } }, "VocabularyFilterMethod": { "target": "com.amazonaws.transcribestreaming#VocabularyFilterMethod", "traits": { - "smithy.api#documentation": "The manner in which you use your vocabulary filter to filter words in your transcript.\n Remove removes filtered words from your transcription results.\n Mask masks filtered words with a *** in your transcription\n results. Tag keeps the filtered words in your transcription results and tags \n them. The tag appears as VocabularyFilterMatch equal to \n True.
Specify how you want your 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.
When true, enables speaker identification in your media stream.
Enables speaker partitioning (diarization) in your transcription output. Speaker partitioning \n labels the speech from individual speakers in your media file.
\nFor more information, see Partitioning speakers (diarization).
", "smithy.api#httpHeader": "x-amzn-transcribe-show-speaker-label" } }, "EnableChannelIdentification": { "target": "com.amazonaws.transcribestreaming#Boolean", "traits": { - "smithy.api#documentation": "When true, instructs Amazon Transcribe to process each audio channel separately,\n then merges the transcription output of each channel into a single transcription.
Amazon Transcribe also produces a transcription of each item. An item includes the start time, end\n time, and any alternative transcriptions.
", + "smithy.api#default": false, + "smithy.api#documentation": "Enables channel identification in multi-channel audio.
\nChannel identification transcribes the audio on each channel independently, then appends the \n output for each channel into one transcript.
\nIf you have multi-channel audio and do not enable channel identification, your audio is \n transcribed in a continuous manner and your transcript is not separated by channel.
\nFor more information, see Transcribing multi-channel audio.
", "smithy.api#httpHeader": "x-amzn-transcribe-enable-channel-identification" } }, "NumberOfChannels": { "target": "com.amazonaws.transcribestreaming#NumberOfChannels", "traits": { - "smithy.api#documentation": "The number of channels that are in your audio stream.
", + "smithy.api#documentation": "Specify the number of channels in your audio stream. Up to two channels are\n supported.
", "smithy.api#httpHeader": "x-amzn-transcribe-number-of-channels" } }, "EnablePartialResultsStabilization": { "target": "com.amazonaws.transcribestreaming#Boolean", "traits": { - "smithy.api#documentation": "When true, instructs Amazon Transcribe to present transcription results that have the\n partial results stabilized. Normally, any word or phrase from one partial result can change in\n a subsequent partial result. With partial results stabilization enabled, only the last few\n words of one partial result can change in another partial result.
Enables partial result stabilization for your transcription. Partial result stabilization can reduce\n latency in your output, but may impact accuracy. For more information, see \n Partial-result \n stabilization.
", "smithy.api#httpHeader": "x-amzn-transcribe-enable-partial-results-stabilization" } }, "PartialResultsStability": { "target": "com.amazonaws.transcribestreaming#PartialResultsStability", "traits": { - "smithy.api#documentation": "You can use this field to set the stability level of the transcription results. A higher\n stability level means that the transcription results are less likely to change. Higher\n stability levels can come with lower overall transcription accuracy.
", + "smithy.api#documentation": "Specify the level of stability to use when you enable partial results stabilization \n (EnablePartialResultsStabilization).
Low stability provides the highest accuracy. High stability transcribes faster, but with slightly\n lower accuracy.
\nFor more information, see Partial-result \n stabilization.
", "smithy.api#httpHeader": "x-amzn-transcribe-partial-results-stability" } }, "ContentIdentificationType": { "target": "com.amazonaws.transcribestreaming#ContentIdentificationType", "traits": { - "smithy.api#documentation": "Set this field to PII to identify personally identifiable information (PII) in the transcription\n output. Content identification is performed only upon complete transcription of the audio\n segments.
\nYou can’t set both ContentIdentificationType and\n ContentRedactionType in the same request. If you set both, your request \n returns a BadRequestException.
Labels all personally identifiable information (PII) identified in your transcript.
\nContent identification is performed at the segment level; PII specified in \n PiiEntityTypes is flagged upon complete transcription of an audio segment.
You can’t set ContentIdentificationType and ContentRedactionType\n in the same request. If you set both, your request returns a\n BadRequestException.
For more information, see Redacting or identifying personally identifiable\n information.
", "smithy.api#httpHeader": "x-amzn-transcribe-content-identification-type" } }, "ContentRedactionType": { "target": "com.amazonaws.transcribestreaming#ContentRedactionType", "traits": { - "smithy.api#documentation": "Set this field to PII to redact personally identifiable information (PII) in the transcription\n output. Content redaction is performed only upon complete transcription of the audio\n segments.
\nYou can’t set both ContentRedactionType and\n ContentIdentificationType in the same request. If you set both, your request\n returns a BadRequestException.
Redacts all personally identifiable information (PII) identified in your transcript.
\nContent redaction is performed at the segment level; PII specified in \n PiiEntityTypes is redacted upon complete transcription of an audio segment.
You can’t set ContentRedactionType and ContentIdentificationType\n in the same request. If you set both, your request returns a\n BadRequestException.
For more information, see Redacting or identifying personally identifiable\n information.
", "smithy.api#httpHeader": "x-amzn-transcribe-content-redaction-type" } }, "PiiEntityTypes": { "target": "com.amazonaws.transcribestreaming#PiiEntityTypes", "traits": { - "smithy.api#documentation": "List the PII entity types you want to identify or redact. In order to specify entity types,\n you must have either ContentIdentificationType or\n ContentRedactionType enabled.
\n PIIEntityTypes must be comma-separated; the available values are:\n BANK_ACCOUNT_NUMBER, BANK_ROUTING,\n CREDIT_DEBIT_NUMBER, CREDIT_DEBIT_CVV, \n CREDIT_DEBIT_EXPIRY, PIN, EMAIL, \n ADDRESS, NAME, PHONE, \n SSN, and ALL.
\n PiiEntityTypes is an optional parameter with a default value of\n ALL.
Specify which types of personally identifiable information (PII) you want to redact in your \n transcript. You can include as many types as you'd like, or you can select \n ALL.
To include PiiEntityTypes in your request, you must also include either \n ContentIdentificationType or ContentRedactionType.
Values must be comma-separated and can include:\n BANK_ACCOUNT_NUMBER, BANK_ROUTING,\n CREDIT_DEBIT_NUMBER, CREDIT_DEBIT_CVV, \n CREDIT_DEBIT_EXPIRY, PIN, EMAIL, \n ADDRESS, NAME, PHONE, \n SSN, or ALL.
The name of the language model you want to use.
", + "smithy.api#documentation": "Specify the name of the custom language model that you want to use when processing your\n transcription. Note that language model names are case sensitive.
\nThe language of the specified language model must match the language code you specify\n in your transcription request. If the languages don't match, the language model isn't applied. There \n are no errors or warnings associated with a language mismatch.
\nFor more information, see Custom language \n models.
", "smithy.api#httpHeader": "x-amzn-transcribe-language-model-name" } }, "IdentifyLanguage": { "target": "com.amazonaws.transcribestreaming#Boolean", "traits": { - "smithy.api#documentation": "Optional. Set this value to true to enable language identification for \n your media stream.
Enables automatic language identification for your transcription.
\nIf you include IdentifyLanguage, you can optionally include a list of \n language codes, using LanguageOptions, that you think may be present in \n your audio stream. Including language options can improve transcription accuracy.
You can also include a preferred language using PreferredLanguage. Adding a \n preferred language can help Amazon Transcribe identify the language faster than if you omit this \n parameter.
If you have multi-channel audio that contains different languages on each channel, and you've \n enabled channel identification, automatic language identification identifies the dominant language on \n each audio channel.
\nNote that you must include either LanguageCode or \n IdentifyLanguage in your request. If you include both parameters, your request\n fails.
Streaming language identification can't be combined with custom language models or \n redaction.
", "smithy.api#httpHeader": "x-amzn-transcribe-identify-language" } }, "LanguageOptions": { "target": "com.amazonaws.transcribestreaming#LanguageOptions", "traits": { - "smithy.api#documentation": "An object containing a list of languages that might be present in your audio.
\nYou must provide two or more language codes to help Amazon Transcribe identify the correct \n language of your media stream with the highest possible accuracy. You can only select one\n variant per language; for example, you can't include both en-US and\n en-UK in the same request.
You can only use this parameter if you've set IdentifyLanguage to\n truein your request.
Specify two or more language codes that represent the languages you think may be present \n in your media; including more than five is not recommended. If you're unsure what languages are present, do\n not include this parameter.
\nIncluding language options can improve the accuracy of language identification.
\nIf you include LanguageOptions in your request, you must also include \n IdentifyLanguage.
For a list of languages supported with Amazon Transcribe streaming, refer to the \n Supported \n languages table.
\nYou can only include one language dialect per language per stream. For example, you\n cannot include en-US and en-AU in the same request.
Optional. From the subset of languages codes you provided for \n LanguageOptions, you can select one preferred language for your \n transcription.
You can only use this parameter if you've set IdentifyLanguage to\n truein your request.
Specify a preferred language from the subset of languages codes you specified in \n LanguageOptions.
You can only use this parameter if you've included IdentifyLanguage and\n LanguageOptions in your request.
The names of the custom vocabularies you want to use with your transcription.
\nNote that if the custom vocabularies you specify are in languages that don't match the \n language identified in your media, your job fails.
\nThis operation is only intended for use in conjunction with the \n IdentifyLanguage operation. If you're not using IdentifyLanguage\n in your request and want to use a custom vocabulary with your transcription, use the \n VocabularyName operation instead.
Specify the names of the custom vocabularies that you want to use when processing your\n transcription. Note that vocabulary names are case sensitive.
\nIf none of the languages of the specified custom vocabularies match the language identified in \n your media, your job fails.
\nThis parameter is only intended for use with the\n IdentifyLanguage parameter. If you're not\n including IdentifyLanguage in your request and want to use a custom vocabulary\n with your transcription, use the VocabularyName parameter instead.
For more information, see Custom vocabularies.
", "smithy.api#httpHeader": "x-amzn-transcribe-vocabulary-names" } }, "VocabularyFilterNames": { "target": "com.amazonaws.transcribestreaming#VocabularyFilterNames", "traits": { - "smithy.api#documentation": "The names of the vocabulary filters you want to use with your transcription.
\nNote that if the vocabulary filters you specify are in languages that don't match the \n language identified in your media, your job fails.
\nThis operation is only intended for use in conjunction with the \n IdentifyLanguage operation. If you're not using IdentifyLanguage\n in your request and want to use a vocabulary filter with your transcription, use the \n VocabularyFilterName operation instead.
Specify the names of the custom vocabulary filters that you want to use when processing\n your transcription. Note that vocabulary filter names are case sensitive.
\nIf none of the languages of the specified custom vocabulary filters match the language identified\n in your media, your job fails.
\nThis parameter is only intended for use with \n the IdentifyLanguage parameter. If you're not \n including IdentifyLanguage in your request and want to use a custom vocabulary filter \n with your transcription, use the VocabularyFilterName parameter instead.
For more information, see Using vocabulary filtering with unwanted \n words.
", "smithy.api#httpHeader": "x-amzn-transcribe-vocabulary-filter-names" } } @@ -1271,112 +1347,115 @@ "RequestId": { "target": "com.amazonaws.transcribestreaming#RequestId", "traits": { - "smithy.api#documentation": "An identifier for the transcription.
", + "smithy.api#documentation": "Provides the identifier for your streaming request.
", "smithy.api#httpHeader": "x-amzn-request-id" } }, "LanguageCode": { "target": "com.amazonaws.transcribestreaming#LanguageCode", "traits": { - "smithy.api#documentation": "The language code of the input audio stream.
", + "smithy.api#documentation": "Provides the language code that you specified in your request.
", "smithy.api#httpHeader": "x-amzn-transcribe-language-code" } }, "MediaSampleRateHertz": { "target": "com.amazonaws.transcribestreaming#MediaSampleRateHertz", "traits": { - "smithy.api#documentation": "The sample rate, in Hertz (Hz), for the input audio stream.
", + "smithy.api#documentation": "Provides the sample rate that you specified in your request.
", "smithy.api#httpHeader": "x-amzn-transcribe-sample-rate" } }, "MediaEncoding": { "target": "com.amazonaws.transcribestreaming#MediaEncoding", "traits": { - "smithy.api#documentation": "The encoding used for the input audio stream.
", + "smithy.api#documentation": "Provides the media encoding you specified in your request.
", "smithy.api#httpHeader": "x-amzn-transcribe-media-encoding" } }, "VocabularyName": { "target": "com.amazonaws.transcribestreaming#VocabularyName", "traits": { - "smithy.api#documentation": "The name of the custom vocabulary used when processing the stream.
", + "smithy.api#documentation": "Provides the name of the custom vocabulary that you specified in your request.
", "smithy.api#httpHeader": "x-amzn-transcribe-vocabulary-name" } }, "SessionId": { "target": "com.amazonaws.transcribestreaming#SessionId", "traits": { - "smithy.api#documentation": "An identifier for a specific transcription session.
", + "smithy.api#documentation": "Provides the identifier for your transcription session.
", "smithy.api#httpHeader": "x-amzn-transcribe-session-id" } }, "TranscriptResultStream": { "target": "com.amazonaws.transcribestreaming#TranscriptResultStream", "traits": { - "smithy.api#documentation": "Represents the stream of transcription events from Amazon Transcribe to your application.
", + "smithy.api#documentation": "Provides detailed information about your streaming session.
", "smithy.api#httpPayload": {} } }, "VocabularyFilterName": { "target": "com.amazonaws.transcribestreaming#VocabularyFilterName", "traits": { - "smithy.api#documentation": "The name of the vocabulary filter used when processing the stream.
", + "smithy.api#documentation": "Provides the name of the custom vocabulary filter that you specified in your\n request.
", "smithy.api#httpHeader": "x-amzn-transcribe-vocabulary-filter-name" } }, "VocabularyFilterMethod": { "target": "com.amazonaws.transcribestreaming#VocabularyFilterMethod", "traits": { - "smithy.api#documentation": "The vocabulary filtering method used when processing the stream.
", + "smithy.api#documentation": "Provides the vocabulary filtering method used in your transcription.
", "smithy.api#httpHeader": "x-amzn-transcribe-vocabulary-filter-method" } }, "ShowSpeakerLabel": { "target": "com.amazonaws.transcribestreaming#Boolean", "traits": { - "smithy.api#documentation": "Shows whether speaker identification was enabled in the transcription.
", + "smithy.api#default": false, + "smithy.api#documentation": "Shows whether speaker partitioning was enabled for your transcription.
", "smithy.api#httpHeader": "x-amzn-transcribe-show-speaker-label" } }, "EnableChannelIdentification": { "target": "com.amazonaws.transcribestreaming#Boolean", "traits": { - "smithy.api#documentation": "Shows whether channel identification was enabled in the stream.
", + "smithy.api#default": false, + "smithy.api#documentation": "Shows whether channel identification was enabled for your transcription.
", "smithy.api#httpHeader": "x-amzn-transcribe-enable-channel-identification" } }, "NumberOfChannels": { "target": "com.amazonaws.transcribestreaming#NumberOfChannels", "traits": { - "smithy.api#documentation": "The number of channels identified in the stream.
", + "smithy.api#documentation": "Provides the number of channels that you specified in your request.
", "smithy.api#httpHeader": "x-amzn-transcribe-number-of-channels" } }, "EnablePartialResultsStabilization": { "target": "com.amazonaws.transcribestreaming#Boolean", "traits": { - "smithy.api#documentation": "Shows whether partial results stabilization was enabled in the transcription.
", + "smithy.api#default": false, + "smithy.api#documentation": "Shows whether partial results stabilization was enabled for your transcription.
", "smithy.api#httpHeader": "x-amzn-transcribe-enable-partial-results-stabilization" } }, "PartialResultsStability": { "target": "com.amazonaws.transcribestreaming#PartialResultsStability", "traits": { - "smithy.api#documentation": "If partial results stabilization has been enabled in the stream, shows the stability\n level.
", + "smithy.api#documentation": "Provides the stabilization level used for your transcription.
", "smithy.api#httpHeader": "x-amzn-transcribe-partial-results-stability" } }, "ContentIdentificationType": { "target": "com.amazonaws.transcribestreaming#ContentIdentificationType", "traits": { - "smithy.api#documentation": "Shows whether content identification was enabled in this stream.
", + "smithy.api#documentation": "Shows whether content identification was enabled for your transcription.
", "smithy.api#httpHeader": "x-amzn-transcribe-content-identification-type" } }, "ContentRedactionType": { "target": "com.amazonaws.transcribestreaming#ContentRedactionType", "traits": { - "smithy.api#documentation": "Shows whether content redaction was enabled in this stream.
", + "smithy.api#documentation": "Shows whether content redaction was enabled for your transcription.
", "smithy.api#httpHeader": "x-amzn-transcribe-content-redaction-type" } }, @@ -1390,42 +1469,43 @@ "LanguageModelName": { "target": "com.amazonaws.transcribestreaming#ModelName", "traits": { - "smithy.api#documentation": "The name of the custom language model used in the transcription.
", + "smithy.api#documentation": "Provides the name of the custom language model that you specified in your request.
", "smithy.api#httpHeader": "x-amzn-transcribe-language-model-name" } }, "IdentifyLanguage": { "target": "com.amazonaws.transcribestreaming#Boolean", "traits": { - "smithy.api#documentation": "The language code of the language identified in your media stream.
", + "smithy.api#default": false, + "smithy.api#documentation": "Shows whether automatic language identification was enabled for your \n transcription.
", "smithy.api#httpHeader": "x-amzn-transcribe-identify-language" } }, "LanguageOptions": { "target": "com.amazonaws.transcribestreaming#LanguageOptions", "traits": { - "smithy.api#documentation": "The language codes used in the identification of your media stream's predominant \n language.
", + "smithy.api#documentation": "Provides the language codes that you specified in your request.
", "smithy.api#httpHeader": "x-amzn-transcribe-language-options" } }, "PreferredLanguage": { "target": "com.amazonaws.transcribestreaming#LanguageCode", "traits": { - "smithy.api#documentation": "The preferred language you specified in your request.
", + "smithy.api#documentation": "Provides the preferred language that you specified in your request.
", "smithy.api#httpHeader": "x-amzn-transcribe-preferred-language" } }, "VocabularyNames": { "target": "com.amazonaws.transcribestreaming#VocabularyNames", "traits": { - "smithy.api#documentation": "The name of the custom vocabulary used when processing the stream.
", + "smithy.api#documentation": "Provides the names of the custom vocabularies that you specified in your request.
", "smithy.api#httpHeader": "x-amzn-transcribe-vocabulary-names" } }, "VocabularyFilterNames": { "target": "com.amazonaws.transcribestreaming#VocabularyFilterNames", "traits": { - "smithy.api#documentation": "The name of the vocabulary filter used when processing the stream.
", + "smithy.api#documentation": "Provides the names of the custom vocabulary filters that you specified in your\n request.
", "smithy.api#httpHeader": "x-amzn-transcribe-vocabulary-filter-names" } } @@ -1436,6 +1516,15 @@ }, "com.amazonaws.transcribestreaming#Transcribe": { "type": "service", + "version": "2017-10-26", + "operations": [ + { + "target": "com.amazonaws.transcribestreaming#StartMedicalStreamTranscription" + }, + { + "target": "com.amazonaws.transcribestreaming#StartStreamTranscription" + } + ], "traits": { "aws.api#service": { "sdkId": "Transcribe Streaming", @@ -1448,21 +1537,1279 @@ "name": "transcribe" }, "aws.protocols#restJson1": { - "http": ["http/1.1", "h2"], - "eventStreamHttp": ["h2"] - }, - "smithy.api#documentation": "Operations and objects for transcribing streaming speech to text.
", - "smithy.api#title": "Amazon Transcribe Streaming Service" - }, - "version": "2017-10-26", - "operations": [ - { - "target": "com.amazonaws.transcribestreaming#StartMedicalStreamTranscription" - }, - { - "target": "com.amazonaws.transcribestreaming#StartStreamTranscription" + "http": [ + "http/1.1", + "h2" + ], + "eventStreamHttp": [ + "h2" + ] + }, + "smithy.api#documentation": "Amazon Transcribe streaming offers two types of real-time transcription: \n Standard and Medical.
\n\n Standard transcriptions are the most common option. Refer\n to for details.
\n\n Medical transcriptions are tailored to medical professionals \n and incorporate medical terms. A common use case for this service is transcribing doctor-patient \n dialogue in real time, so doctors can focus on their patient instead of taking notes. Refer to\n for details.
\n\n Result objects that contain the results of transcribing a portion of the\n input audio stream. The array can be empty.
" + "smithy.api#documentation": "Contains a set of transcription results from one or more audio segments, along with additional \n information per your request parameters. This can include information relating to alternative\n transcriptions, channel identification, partial result stabilization, language identification, and other\n transcription-related data.
" } } }, "traits": { - "smithy.api#documentation": "The transcription in a TranscriptEvent.
" + "smithy.api#documentation": "The Transcript associated with a \n .
\n Transcript contains Results, which contains a set of transcription\n results from one or more audio segments, along with additional information per your request \n parameters.
The transcription of the audio stream. The transcription is composed of all of the items\n in the results list.
" + "smithy.api#documentation": "Contains Results, which contains a set of transcription results from one or\n more audio segments, along with additional information per your request parameters. This can\n include information relating to alternative transcriptions, channel identification, partial\n result stabilization, language identification, and other transcription-related data.
Represents a set of transcription results from the server to the client. It contains one\n or more segments of the transcription.
" + "smithy.api#documentation": "The TranscriptEvent associated with a \n TranscriptResultStream.
Contains a set of transcription results from one or more audio segments, along with additional \n information per your request parameters.
" } }, "com.amazonaws.transcribestreaming#TranscriptResultStream": { @@ -1498,7 +2845,7 @@ "TranscriptEvent": { "target": "com.amazonaws.transcribestreaming#TranscriptEvent", "traits": { - "smithy.api#documentation": "A portion of the transcription of the audio stream. Events are sent periodically from\n Amazon Transcribe to your application. The event can be a partial transcription of a section of the audio\n stream, or it can be the entire transcription of that portion of the audio stream.
" + "smithy.api#documentation": "Contains Transcript, which contains Results. The \n object contains a set of transcription \n results from one or more audio segments, along with additional information per your request \n parameters.
Your client has exceeded one of the Amazon Transcribe limits, typically the limit on audio length.\n Break your audio stream into smaller chunks and try your request again.
" + "smithy.api#documentation": "Your client has exceeded one of the Amazon Transcribe limits. This is typically the audio length\n limit. Break your audio stream into smaller chunks and try your request again.
" } }, "InternalFailureException": { "target": "com.amazonaws.transcribestreaming#InternalFailureException", "traits": { - "smithy.api#documentation": "A problem occurred while processing the audio. Amazon Transcribe terminated processing.
" + "smithy.api#documentation": "A problem occurred while processing the audio. Amazon Transcribe terminated \n processing.
" } }, "ConflictException": { @@ -1528,47 +2875,53 @@ "ServiceUnavailableException": { "target": "com.amazonaws.transcribestreaming#ServiceUnavailableException", "traits": { - "smithy.api#documentation": "Service is currently unavailable. Try your request later.
" + "smithy.api#documentation": "The service is currently unavailable. Try your request later.
" } } }, "traits": { - "smithy.api#documentation": "Represents the transcription result stream from Amazon Transcribe to your application.
", + "smithy.api#documentation": "Contains detailed information about your streaming session.
", "smithy.api#streaming": {} } }, "com.amazonaws.transcribestreaming#Type": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "CONVERSATION", - "name": "CONVERSATION" - }, - { - "value": "DICTATION", - "name": "DICTATION" + "type": "enum", + "members": { + "CONVERSATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONVERSATION" } - ] + }, + "DICTATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DICTATION" + } + } } }, "com.amazonaws.transcribestreaming#VocabularyFilterMethod": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "remove", - "name": "REMOVE" - }, - { - "value": "mask", - "name": "MASK" - }, - { - "value": "tag", - "name": "TAG" + "type": "enum", + "members": { + "REMOVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "remove" } - ] + }, + "MASK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "mask" + } + }, + "TAG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "tag" + } + } } }, "com.amazonaws.transcribestreaming#VocabularyFilterName": {