The Amazon Resource Name (ARN) of the user account.
", "CreateVocabularyResponse$VocabularyArn": "The Amazon Resource Name (ARN) of the custom vocabulary.
", "DeleteVocabularyResponse$VocabularyArn": "The Amazon Resource Name (ARN) of the custom vocabulary.
", + "GetFederationTokenResponse$UserArn": "The Amazon Resource Name (ARN) of the user.
", "HierarchyGroup$Arn": "The Amazon Resource Name (ARN) of the hierarchy group.
", "HierarchyGroupSummary$Arn": "The Amazon Resource Name (ARN) of the hierarchy group.
", "HierarchyGroupSummaryReference$Arn": "The Amazon Resource Name (ARN) for the hierarchy group.
", @@ -293,6 +294,7 @@ "base": null, "refs": { "AgentInfo$Id": "The identifier of the agent who accepted the contact.
", + "GetFederationTokenResponse$UserId": "The identifier for the user.
", "TransferContactRequest$UserId": "The identifier for the user.
" } }, @@ -660,7 +662,7 @@ "ClientToken": { "base": null, "refs": { - "ClaimPhoneNumberRequest$ClientToken": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
", + "ClaimPhoneNumberRequest$ClientToken": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
Pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
", "CreateInstanceRequest$ClientToken": "The idempotency token.
", "CreateTaskTemplateRequest$ClientToken": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
", @@ -2180,7 +2182,7 @@ "refs": { "CreateTrafficDistributionGroupRequest$InstanceId": "The identifier of the Amazon Connect instance that has been replicated. You can find the instanceId in the ARN of the instance.
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
", - "ReplicateInstanceRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
" + "ReplicateInstanceRequest$InstanceId": "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.
The URL to sign into the user's instance.
" + } + }, "UrlReference": { "base": "The URL reference.
", "refs": { diff --git a/models/apis/connect/2017-08-08/endpoint-tests-1.json b/models/apis/connect/2017-08-08/endpoint-tests-1.json index c974fdf4f4e..947deffaa01 100644 --- a/models/apis/connect/2017-08-08/endpoint-tests-1.json +++ b/models/apis/connect/2017-08-08/endpoint-tests-1.json @@ -8,9 +8,9 @@ } }, "params": { + "UseDualStack": true, "UseFIPS": true, - "Region": "ap-south-1", - "UseDualStack": true + "Region": "ap-south-1" } }, { @@ -21,9 +21,9 @@ } }, "params": { + "UseDualStack": false, "UseFIPS": true, - "Region": "ap-south-1", - "UseDualStack": false + "Region": "ap-south-1" } }, { @@ -34,9 +34,9 @@ } }, "params": { + "UseDualStack": true, "UseFIPS": false, - "Region": "ap-south-1", - "UseDualStack": true + "Region": "ap-south-1" } }, { @@ -47,9 +47,9 @@ } }, "params": { + "UseDualStack": false, "UseFIPS": false, - "Region": "ap-south-1", - "UseDualStack": false + "Region": "ap-south-1" } }, { @@ -60,9 +60,9 @@ } }, "params": { + "UseDualStack": true, "UseFIPS": true, - "Region": "ca-central-1", - "UseDualStack": true + "Region": "ca-central-1" } }, { @@ -73,9 +73,9 @@ } }, "params": { + "UseDualStack": false, "UseFIPS": true, - "Region": "ca-central-1", - "UseDualStack": false + "Region": "ca-central-1" } }, { @@ -86,9 +86,9 @@ } }, "params": { + "UseDualStack": true, "UseFIPS": false, - "Region": "ca-central-1", - "UseDualStack": true + "Region": "ca-central-1" } }, { @@ -99,9 +99,9 @@ } }, "params": { + "UseDualStack": false, "UseFIPS": false, - "Region": "ca-central-1", - "UseDualStack": false + "Region": "ca-central-1" } }, { @@ -112,9 +112,9 @@ } }, "params": { + "UseDualStack": true, "UseFIPS": true, - "Region": "eu-central-1", - "UseDualStack": true + "Region": "eu-central-1" } }, { @@ -125,9 +125,9 @@ } }, "params": { + "UseDualStack": false, "UseFIPS": true, - "Region": "eu-central-1", - "UseDualStack": false + "Region": "eu-central-1" } }, { @@ -138,9 +138,9 @@ } }, "params": { + "UseDualStack": true, "UseFIPS": false, - "Region": "eu-central-1", - "UseDualStack": true + "Region": "eu-central-1" } }, { @@ -151,9 +151,9 @@ } }, "params": { + "UseDualStack": false, "UseFIPS": false, - "Region": "eu-central-1", - "UseDualStack": false + "Region": "eu-central-1" } }, { @@ -164,9 +164,9 @@ } }, "params": { + "UseDualStack": true, "UseFIPS": true, - "Region": "us-west-2", - "UseDualStack": true + "Region": "us-west-2" } }, { @@ -177,9 +177,9 @@ } }, "params": { + "UseDualStack": false, "UseFIPS": true, - "Region": "us-west-2", - "UseDualStack": false + "Region": "us-west-2" } }, { @@ -190,9 +190,9 @@ } }, "params": { + "UseDualStack": true, "UseFIPS": false, - "Region": "us-west-2", - "UseDualStack": true + "Region": "us-west-2" } }, { @@ -203,9 +203,9 @@ } }, "params": { + "UseDualStack": false, "UseFIPS": false, - "Region": "us-west-2", - "UseDualStack": false + "Region": "us-west-2" } }, { @@ -216,9 +216,9 @@ } }, "params": { + "UseDualStack": true, "UseFIPS": true, - "Region": "af-south-1", - "UseDualStack": true + "Region": "af-south-1" } }, { @@ -229,9 +229,9 @@ } }, "params": { + "UseDualStack": false, "UseFIPS": true, - "Region": "af-south-1", - "UseDualStack": false + "Region": "af-south-1" } }, { @@ -242,9 +242,9 @@ } }, "params": { + "UseDualStack": true, "UseFIPS": false, - "Region": "af-south-1", - "UseDualStack": true + "Region": "af-south-1" } }, { @@ -255,9 +255,9 @@ } }, "params": { + "UseDualStack": false, "UseFIPS": false, - "Region": "af-south-1", - "UseDualStack": false + "Region": "af-south-1" } }, { @@ -268,9 +268,9 @@ } }, "params": { + "UseDualStack": true, "UseFIPS": true, - "Region": "eu-west-2", - "UseDualStack": true + "Region": "eu-west-2" } }, { @@ -281,9 +281,9 @@ } }, "params": { + "UseDualStack": false, "UseFIPS": true, - "Region": "eu-west-2", - "UseDualStack": false + "Region": "eu-west-2" } }, { @@ -294,9 +294,9 @@ } }, "params": { + "UseDualStack": true, "UseFIPS": false, - "Region": "eu-west-2", - "UseDualStack": true + "Region": "eu-west-2" } }, { @@ -307,9 +307,9 @@ } }, "params": { + "UseDualStack": false, "UseFIPS": false, - "Region": "eu-west-2", - "UseDualStack": false + "Region": "eu-west-2" } }, { @@ -320,9 +320,9 @@ } }, "params": { + "UseDualStack": true, "UseFIPS": true, - "Region": "ap-northeast-2", - "UseDualStack": true + "Region": "ap-northeast-2" } }, { @@ -333,9 +333,9 @@ } }, "params": { + "UseDualStack": false, "UseFIPS": true, - "Region": "ap-northeast-2", - "UseDualStack": false + "Region": "ap-northeast-2" } }, { @@ -346,9 +346,9 @@ } }, "params": { + "UseDualStack": true, "UseFIPS": false, - "Region": "ap-northeast-2", - "UseDualStack": true + "Region": "ap-northeast-2" } }, { @@ -359,9 +359,9 @@ } }, "params": { + "UseDualStack": false, "UseFIPS": false, - "Region": "ap-northeast-2", - "UseDualStack": false + "Region": "ap-northeast-2" } }, { @@ -372,9 +372,9 @@ } }, "params": { + "UseDualStack": true, "UseFIPS": true, - "Region": "ap-northeast-1", - "UseDualStack": true + "Region": "ap-northeast-1" } }, { @@ -385,9 +385,9 @@ } }, "params": { + "UseDualStack": false, "UseFIPS": true, - "Region": "ap-northeast-1", - "UseDualStack": false + "Region": "ap-northeast-1" } }, { @@ -398,9 +398,9 @@ } }, "params": { + "UseDualStack": true, "UseFIPS": false, - "Region": "ap-northeast-1", - "UseDualStack": true + "Region": "ap-northeast-1" } }, { @@ -411,9 +411,9 @@ } }, "params": { + "UseDualStack": false, "UseFIPS": false, - "Region": "ap-northeast-1", - "UseDualStack": false + "Region": "ap-northeast-1" } }, { @@ -424,9 +424,9 @@ } }, "params": { + "UseDualStack": true, "UseFIPS": true, - "Region": "us-gov-west-1", - "UseDualStack": true + "Region": "us-gov-west-1" } }, { @@ -437,9 +437,9 @@ } }, "params": { + "UseDualStack": false, "UseFIPS": true, - "Region": "us-gov-west-1", - "UseDualStack": false + "Region": "us-gov-west-1" } }, { @@ -450,9 +450,9 @@ } }, "params": { + "UseDualStack": true, "UseFIPS": false, - "Region": "us-gov-west-1", - "UseDualStack": true + "Region": "us-gov-west-1" } }, { @@ -463,9 +463,9 @@ } }, "params": { + "UseDualStack": false, "UseFIPS": false, - "Region": "us-gov-west-1", - "UseDualStack": false + "Region": "us-gov-west-1" } }, { @@ -476,9 +476,9 @@ } }, "params": { + "UseDualStack": true, "UseFIPS": true, - "Region": "ap-southeast-1", - "UseDualStack": true + "Region": "ap-southeast-1" } }, { @@ -489,9 +489,9 @@ } }, "params": { + "UseDualStack": false, "UseFIPS": true, - "Region": "ap-southeast-1", - "UseDualStack": false + "Region": "ap-southeast-1" } }, { @@ -502,9 +502,9 @@ } }, "params": { + "UseDualStack": true, "UseFIPS": false, - "Region": "ap-southeast-1", - "UseDualStack": true + "Region": "ap-southeast-1" } }, { @@ -515,9 +515,9 @@ } }, "params": { + "UseDualStack": false, "UseFIPS": false, - "Region": "ap-southeast-1", - "UseDualStack": false + "Region": "ap-southeast-1" } }, { @@ -528,9 +528,9 @@ } }, "params": { + "UseDualStack": true, "UseFIPS": true, - "Region": "ap-southeast-2", - "UseDualStack": true + "Region": "ap-southeast-2" } }, { @@ -541,9 +541,9 @@ } }, "params": { + "UseDualStack": false, "UseFIPS": true, - "Region": "ap-southeast-2", - "UseDualStack": false + "Region": "ap-southeast-2" } }, { @@ -554,9 +554,9 @@ } }, "params": { + "UseDualStack": true, "UseFIPS": false, - "Region": "ap-southeast-2", - "UseDualStack": true + "Region": "ap-southeast-2" } }, { @@ -567,9 +567,9 @@ } }, "params": { + "UseDualStack": false, "UseFIPS": false, - "Region": "ap-southeast-2", - "UseDualStack": false + "Region": "ap-southeast-2" } }, { @@ -580,9 +580,9 @@ } }, "params": { + "UseDualStack": true, "UseFIPS": true, - "Region": "us-east-1", - "UseDualStack": true + "Region": "us-east-1" } }, { @@ -593,9 +593,9 @@ } }, "params": { + "UseDualStack": false, "UseFIPS": true, - "Region": "us-east-1", - "UseDualStack": false + "Region": "us-east-1" } }, { @@ -606,9 +606,9 @@ } }, "params": { + "UseDualStack": true, "UseFIPS": false, - "Region": "us-east-1", - "UseDualStack": true + "Region": "us-east-1" } }, { @@ -619,9 +619,9 @@ } }, "params": { + "UseDualStack": false, "UseFIPS": false, - "Region": "us-east-1", - "UseDualStack": false + "Region": "us-east-1" } }, { @@ -632,9 +632,9 @@ } }, "params": { + "UseDualStack": false, "UseFIPS": false, "Region": "us-east-1", - "UseDualStack": false, "Endpoint": "https://example.com" } }, @@ -644,9 +644,9 @@ "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { + "UseDualStack": false, "UseFIPS": true, "Region": "us-east-1", - "UseDualStack": false, "Endpoint": "https://example.com" } }, @@ -656,9 +656,9 @@ "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { + "UseDualStack": true, "UseFIPS": false, "Region": "us-east-1", - "UseDualStack": true, "Endpoint": "https://example.com" } } diff --git a/models/apis/connectcases/2022-10-03/api-2.json b/models/apis/connectcases/2022-10-03/api-2.json index 38fa12c592d..8d464a33f84 100644 --- a/models/apis/connectcases/2022-10-03/api-2.json +++ b/models/apis/connectcases/2022-10-03/api-2.json @@ -505,7 +505,8 @@ {"shape":"ValidationException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, - {"shape":"ConflictException"} + {"shape":"ConflictException"}, + {"shape":"ServiceQuotaExceededException"} ], "idempotent":true }, @@ -947,7 +948,8 @@ }, "layoutConfiguration":{"shape":"LayoutConfiguration"}, "name":{"shape":"TemplateName"}, - "requiredFields":{"shape":"RequiredFieldList"} + "requiredFields":{"shape":"RequiredFieldList"}, + "status":{"shape":"TemplateStatus"} } }, "CreateTemplateResponse":{ @@ -1070,7 +1072,7 @@ "FieldGroupFieldsList":{ "type":"list", "member":{"shape":"FieldItem"}, - "max":30, + "max":100, "min":0 }, "FieldGroupNameString":{ @@ -1375,6 +1377,7 @@ "type":"structure", "required":[ "name", + "status", "templateArn", "templateId" ], @@ -1383,6 +1386,7 @@ "layoutConfiguration":{"shape":"LayoutConfiguration"}, "name":{"shape":"TemplateName"}, "requiredFields":{"shape":"RequiredFieldList"}, + "status":{"shape":"TemplateStatus"}, "tags":{"shape":"Tags"}, "templateArn":{"shape":"TemplateArn"}, "templateId":{"shape":"TemplateId"} @@ -1667,6 +1671,11 @@ "shape":"NextToken", "location":"querystring", "locationName":"nextToken" + }, + "status":{ + "shape":"TemplateStatusFilters", + "location":"querystring", + "locationName":"status" } } }, @@ -2029,15 +2038,30 @@ "min":1, "pattern":"^.*[\\S]$" }, + "TemplateStatus":{ + "type":"string", + "enum":[ + "Active", + "Inactive" + ] + }, + "TemplateStatusFilters":{ + "type":"list", + "member":{"shape":"TemplateStatus"}, + "max":2, + "min":1 + }, "TemplateSummary":{ "type":"structure", "required":[ "name", + "status", "templateArn", "templateId" ], "members":{ "name":{"shape":"TemplateName"}, + "status":{"shape":"TemplateStatus"}, "templateArn":{"shape":"TemplateArn"}, "templateId":{"shape":"TemplateId"} } @@ -2174,6 +2198,7 @@ "layoutConfiguration":{"shape":"LayoutConfiguration"}, "name":{"shape":"TemplateName"}, "requiredFields":{"shape":"RequiredFieldList"}, + "status":{"shape":"TemplateStatus"}, "templateId":{ "shape":"TemplateId", "location":"uri", diff --git a/models/apis/connectcases/2022-10-03/docs-2.json b/models/apis/connectcases/2022-10-03/docs-2.json index 98fcb123abf..c57f740d7c9 100644 --- a/models/apis/connectcases/2022-10-03/docs-2.json +++ b/models/apis/connectcases/2022-10-03/docs-2.json @@ -9,7 +9,7 @@ "CreateField": "Creates a field in the Cases domain. This field is used to define the case object model (that is, defines what data can be captured on cases) in a Cases domain.
", "CreateLayout": "Creates a layout in the Cases domain. Layouts define the following configuration in the top section and More Info tab of the Cases user interface:
Fields to display to the users
Field ordering
Title and Status fields cannot be part of layouts since they are not configurable.
Creates a related item (comments, tasks, and contacts) and associates it with a case.
A Related Item is a resource that is associated with a case. It may or may not have an external identifier linking it to an external resource (for example, a contactArn). All Related Items have their own internal identifier, the relatedItemArn. Examples of related items include comments and contacts.
Creates a template in the Cases domain. This template is used to define the case object model (that is, define what data can be captured on cases) in a Cases domain. A template must have a unique name within a domain, and it must reference existing field IDs and layout IDs. Additionally, multiple fields with same IDs are not allowed within the same Template.
", + "CreateTemplate": "Creates a template in the Cases domain. This template is used to define the case object model (that is, to define what data can be captured on cases) in a Cases domain. A template must have a unique name within a domain, and it must reference existing field IDs and layout IDs. Additionally, multiple fields with same IDs are not allowed within the same Template. A template can be either Active or Inactive, as indicated by its status. Inactive templates cannot be used to create cases.
", "GetCase": "Returns information about a specific case if it exists.
", "GetCaseEventConfiguration": "Returns the case event publishing configuration.
", "GetDomain": "Returns information about a specific domain if it exists.
", @@ -30,7 +30,7 @@ "UpdateCase": "Updates the values of fields on a case. Fields to be updated are 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 HTTP body.
", "UpdateField": "Updates the properties of an existing field.
", "UpdateLayout": "Updates the attributes of an existing layout.
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
A ValidationException is returned when you add non-existent fieldIds to a layout.
Title and Status fields cannot be part of layouts because they are not configurable.
Updates the attributes of an existing template. The template attributes that can be modified include name, description, layouts, and requiredFields. At least one of these attributes must not be null. If a null value is provided for a given attribute, that attribute is ignored and its current value is preserved.
Updates the attributes of an existing template. The template attributes that can be modified include name, description, layoutConfiguration, requiredFields, and status. At least one of these attributes must not be null. If a null value is provided for a given attribute, that attribute is ignored and its current value is preserved.
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
" + "CreateCaseRequest$clientToken": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
" } }, "CreateCaseRequestFieldsList": { @@ -1126,6 +1126,22 @@ "UpdateTemplateRequest$name": "The name of the template. It must be unique per domain.
" } }, + "TemplateStatus": { + "base": "Status of a template
", + "refs": { + "CreateTemplateRequest$status": "The status of the template.
", + "GetTemplateResponse$status": "The status of the template.
", + "TemplateStatusFilters$member": null, + "TemplateSummary$status": "The status of the template.
", + "UpdateTemplateRequest$status": "The status of the template.
" + } + }, + "TemplateStatusFilters": { + "base": "List of filters used on the ListTemplates result set
", + "refs": { + "ListTemplatesRequest$status": "A list of status values to filter on.
" + } + }, "TemplateSummary": { "base": "Template summary information.
", "refs": { diff --git a/models/apis/connectcases/2022-10-03/endpoint-rule-set-1.json b/models/apis/connectcases/2022-10-03/endpoint-rule-set-1.json new file mode 100644 index 00000000000..da61afd0aca --- /dev/null +++ b/models/apis/connectcases/2022-10-03/endpoint-rule-set-1.json @@ -0,0 +1,309 @@ +{ + "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" + } + ] + } + ] +} \ No newline at end of file diff --git a/models/apis/connectcases/2022-10-03/endpoint-tests-1.json b/models/apis/connectcases/2022-10-03/endpoint-tests-1.json new file mode 100644 index 00000000000..9e508f597f5 --- /dev/null +++ b/models/apis/connectcases/2022-10-03/endpoint-tests-1.json @@ -0,0 +1,295 @@ +{ + "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" +} \ No newline at end of file diff --git a/models/apis/ec2/2016-11-15/api-2.json b/models/apis/ec2/2016-11-15/api-2.json index 14b43801ad9..b4ea19c4db8 100755 --- a/models/apis/ec2/2016-11-15/api-2.json +++ b/models/apis/ec2/2016-11-15/api-2.json @@ -6006,7 +6006,8 @@ "i386", "x86_64", "arm64", - "x86_64_mac" + "x86_64_mac", + "arm64_mac" ] }, "ArchitectureTypeList":{ @@ -6031,7 +6032,8 @@ "i386", "x86_64", "arm64", - "x86_64_mac" + "x86_64_mac", + "arm64_mac" ] }, "ArnList":{ @@ -25261,7 +25263,11 @@ "r6a.48xlarge", "r6a.metal", "p4de.24xlarge", - "u-3tb1.56xlarge" + "u-3tb1.56xlarge", + "u-18tb1.112xlarge", + "u-24tb1.112xlarge", + "trn1.2xlarge", + "trn1.32xlarge" ] }, "InstanceTypeHypervisor":{ diff --git a/models/apis/groundstation/2019-05-23/api-2.json b/models/apis/groundstation/2019-05-23/api-2.json index c7efe6dd73b..cff0f15903e 100644 --- a/models/apis/groundstation/2019-05-23/api-2.json +++ b/models/apis/groundstation/2019-05-23/api-2.json @@ -59,6 +59,21 @@ {"shape":"ResourceNotFoundException"} ] }, + "CreateEphemeris":{ + "name":"CreateEphemeris", + "http":{ + "method":"POST", + "requestUri":"/ephemeris", + "responseCode":200 + }, + "input":{"shape":"CreateEphemerisRequest"}, + "output":{"shape":"EphemerisIdResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"DependencyException"}, + {"shape":"ResourceNotFoundException"} + ] + }, "CreateMissionProfile":{ "name":"CreateMissionProfile", "http":{ @@ -106,6 +121,22 @@ ], "idempotent":true }, + "DeleteEphemeris":{ + "name":"DeleteEphemeris", + "http":{ + "method":"DELETE", + "requestUri":"/ephemeris/{ephemerisId}", + "responseCode":200 + }, + "input":{"shape":"DeleteEphemerisRequest"}, + "output":{"shape":"EphemerisIdResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"DependencyException"}, + {"shape":"ResourceNotFoundException"} + ], + "idempotent":true + }, "DeleteMissionProfile":{ "name":"DeleteMissionProfile", "http":{ @@ -137,6 +168,21 @@ {"shape":"ResourceNotFoundException"} ] }, + "DescribeEphemeris":{ + "name":"DescribeEphemeris", + "http":{ + "method":"GET", + "requestUri":"/ephemeris/{ephemerisId}", + "responseCode":200 + }, + "input":{"shape":"DescribeEphemerisRequest"}, + "output":{"shape":"DescribeEphemerisResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"DependencyException"}, + {"shape":"ResourceNotFoundException"} + ] + }, "GetConfig":{ "name":"GetConfig", "http":{ @@ -257,6 +303,21 @@ {"shape":"ResourceNotFoundException"} ] }, + "ListEphemerides":{ + "name":"ListEphemerides", + "http":{ + "method":"POST", + "requestUri":"/ephemerides", + "responseCode":200 + }, + "input":{"shape":"ListEphemeridesRequest"}, + "output":{"shape":"ListEphemeridesResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"DependencyException"}, + {"shape":"ResourceNotFoundException"} + ] + }, "ListGroundStations":{ "name":"ListGroundStations", "http":{ @@ -379,6 +440,22 @@ ], "idempotent":true }, + "UpdateEphemeris":{ + "name":"UpdateEphemeris", + "http":{ + "method":"PUT", + "requestUri":"/ephemeris/{ephemerisId}", + "responseCode":200 + }, + "input":{"shape":"UpdateEphemerisRequest"}, + "output":{"shape":"EphemerisIdResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"DependencyException"}, + {"shape":"ResourceNotFoundException"} + ], + "idempotent":true + }, "UpdateMissionProfile":{ "name":"UpdateMissionProfile", "http":{ @@ -397,6 +474,12 @@ } }, "shapes":{ + "AWSRegion":{ + "type":"string", + "max":128, + "min":1, + "pattern":"^[\\w-]+$" + }, "AngleUnits":{ "type":"string", "enum":[ @@ -442,6 +525,12 @@ "transmitDisabled":{"shape":"Boolean"} } }, + "AnyArn":{ + "type":"string", + "max":1024, + "min":5, + "pattern":"^(arn:aws:)[\\s\\S]{0,1024}$" + }, "BandwidthUnits":{ "type":"string", "enum":[ @@ -460,7 +549,7 @@ "required":["contactId"], "members":{ "contactId":{ - "shape":"String", + "shape":"Uuid", "location":"uri", "locationName":"contactId" } @@ -525,7 +614,7 @@ "ContactData":{ "type":"structure", "members":{ - "contactId":{"shape":"String"}, + "contactId":{"shape":"Uuid"}, "contactStatus":{"shape":"ContactStatus"}, "endTime":{"shape":"Timestamp"}, "errorMessage":{"shape":"String"}, @@ -543,7 +632,7 @@ "ContactIdResponse":{ "type":"structure", "members":{ - "contactId":{"shape":"String"} + "contactId":{"shape":"Uuid"} } }, "ContactList":{ @@ -588,6 +677,23 @@ "tags":{"shape":"TagsMap"} } }, + "CreateEphemerisRequest":{ + "type":"structure", + "required":[ + "name", + "satelliteId" + ], + "members":{ + "enabled":{"shape":"Boolean"}, + "ephemeris":{"shape":"EphemerisData"}, + "expirationTime":{"shape":"Timestamp"}, + "kmsKeyArn":{"shape":"KeyArn"}, + "name":{"shape":"SafeName"}, + "priority":{"shape":"CustomerEphemerisPriority"}, + "satelliteId":{"shape":"Uuid"}, + "tags":{"shape":"TagsMap"} + } + }, "CreateMissionProfileRequest":{ "type":"structure", "required":[ @@ -600,7 +706,7 @@ "contactPostPassDurationSeconds":{"shape":"DurationInSeconds"}, "contactPrePassDurationSeconds":{"shape":"DurationInSeconds"}, "dataflowEdges":{"shape":"DataflowEdgeList"}, - "minimumViableContactDurationSeconds":{"shape":"DurationInSeconds"}, + "minimumViableContactDurationSeconds":{"shape":"PositiveDurationInSeconds"}, "name":{"shape":"SafeName"}, "tags":{"shape":"TagsMap"}, "trackingConfigArn":{"shape":"ConfigArn"} @@ -614,6 +720,12 @@ "REQUIRED" ] }, + "CustomerEphemerisPriority":{ + "type":"integer", + "box":true, + "max":99999, + "min":1 + }, "DataflowDetail":{ "type":"structure", "members":{ @@ -630,7 +742,9 @@ }, "DataflowEdgeList":{ "type":"list", - "member":{"shape":"DataflowEdge"} + "member":{"shape":"DataflowEdge"}, + "max":500, + "min":0 }, "DataflowEndpoint":{ "type":"structure", @@ -653,7 +767,7 @@ "DataflowEndpointGroupIdResponse":{ "type":"structure", "members":{ - "dataflowEndpointGroupId":{"shape":"String"} + "dataflowEndpointGroupId":{"shape":"Uuid"} } }, "DataflowEndpointGroupList":{ @@ -664,7 +778,7 @@ "type":"structure", "members":{ "dataflowEndpointGroupArn":{"shape":"DataflowEndpointGroupArn"}, - "dataflowEndpointGroupId":{"shape":"String"} + "dataflowEndpointGroupId":{"shape":"Uuid"} } }, "DataflowEndpointMtuInteger":{ @@ -692,7 +806,7 @@ ], "members":{ "configId":{ - "shape":"String", + "shape":"Uuid", "location":"uri", "locationName":"configId" }, @@ -708,18 +822,29 @@ "required":["dataflowEndpointGroupId"], "members":{ "dataflowEndpointGroupId":{ - "shape":"String", + "shape":"Uuid", "location":"uri", "locationName":"dataflowEndpointGroupId" } } }, + "DeleteEphemerisRequest":{ + "type":"structure", + "required":["ephemerisId"], + "members":{ + "ephemerisId":{ + "shape":"Uuid", + "location":"uri", + "locationName":"ephemerisId" + } + } + }, "DeleteMissionProfileRequest":{ "type":"structure", "required":["missionProfileId"], "members":{ "missionProfileId":{ - "shape":"String", + "shape":"Uuid", "location":"uri", "locationName":"missionProfileId" } @@ -747,7 +872,7 @@ "required":["contactId"], "members":{ "contactId":{ - "shape":"String", + "shape":"Uuid", "location":"uri", "locationName":"contactId" } @@ -756,7 +881,7 @@ "DescribeContactResponse":{ "type":"structure", "members":{ - "contactId":{"shape":"String"}, + "contactId":{"shape":"Uuid"}, "contactStatus":{"shape":"ContactStatus"}, "dataflowList":{"shape":"DataflowList"}, "endTime":{"shape":"Timestamp"}, @@ -772,11 +897,37 @@ "tags":{"shape":"TagsMap"} } }, + "DescribeEphemerisRequest":{ + "type":"structure", + "required":["ephemerisId"], + "members":{ + "ephemerisId":{ + "shape":"Uuid", + "location":"uri", + "locationName":"ephemerisId" + } + } + }, + "DescribeEphemerisResponse":{ + "type":"structure", + "members":{ + "creationTime":{"shape":"Timestamp"}, + "enabled":{"shape":"Boolean"}, + "ephemerisId":{"shape":"Uuid"}, + "invalidReason":{"shape":"EphemerisInvalidReason"}, + "name":{"shape":"SafeName"}, + "priority":{"shape":"EphemerisPriority"}, + "satelliteId":{"shape":"Uuid"}, + "status":{"shape":"EphemerisStatus"}, + "suppliedData":{"shape":"EphemerisTypeDescription"}, + "tags":{"shape":"TagsMap"} + } + }, "Destination":{ "type":"structure", "members":{ "configDetails":{"shape":"ConfigDetails"}, - "configId":{"shape":"String"}, + "configId":{"shape":"Uuid"}, "configType":{"shape":"ConfigCapabilityType"}, "dataflowDestinationRegion":{"shape":"String"} } @@ -789,7 +940,7 @@ "type":"integer", "box":true, "max":21600, - "min":1 + "min":0 }, "Eirp":{ "type":"structure", @@ -826,7 +977,9 @@ }, "EndpointDetailsList":{ "type":"list", - "member":{"shape":"EndpointDetails"} + "member":{"shape":"EndpointDetails"}, + "max":500, + "min":0 }, "EndpointStatus":{ "type":"string", @@ -838,6 +991,103 @@ "failed" ] }, + "EphemeridesList":{ + "type":"list", + "member":{"shape":"EphemerisItem"}, + "max":500, + "min":1 + }, + "EphemerisData":{ + "type":"structure", + "members":{ + "oem":{"shape":"OEMEphemeris"}, + "tle":{"shape":"TLEEphemeris"} + }, + "union":true + }, + "EphemerisDescription":{ + "type":"structure", + "members":{ + "ephemerisData":{"shape":"UnboundedString"}, + "sourceS3Object":{"shape":"S3Object"} + } + }, + "EphemerisIdResponse":{ + "type":"structure", + "members":{ + "ephemerisId":{"shape":"Uuid"} + } + }, + "EphemerisInvalidReason":{ + "type":"string", + "enum":[ + "METADATA_INVALID", + "TIME_RANGE_INVALID", + "TRAJECTORY_INVALID", + "KMS_KEY_INVALID", + "VALIDATION_ERROR" + ] + }, + "EphemerisItem":{ + "type":"structure", + "members":{ + "creationTime":{"shape":"Timestamp"}, + "enabled":{"shape":"Boolean"}, + "ephemerisId":{"shape":"Uuid"}, + "name":{"shape":"SafeName"}, + "priority":{"shape":"EphemerisPriority"}, + "sourceS3Object":{"shape":"S3Object"}, + "status":{"shape":"EphemerisStatus"} + } + }, + "EphemerisMetaData":{ + "type":"structure", + "required":["source"], + "members":{ + "ephemerisId":{"shape":"Uuid"}, + "epoch":{"shape":"Timestamp"}, + "name":{"shape":"SafeName"}, + "source":{"shape":"EphemerisSource"} + } + }, + "EphemerisPriority":{ + "type":"integer", + "box":true, + "max":99999, + "min":0 + }, + "EphemerisSource":{ + "type":"string", + "enum":[ + "CUSTOMER_PROVIDED", + "SPACE_TRACK" + ] + }, + "EphemerisStatus":{ + "type":"string", + "enum":[ + "VALIDATING", + "INVALID", + "ERROR", + "ENABLED", + "DISABLED", + "EXPIRED" + ] + }, + "EphemerisStatusList":{ + "type":"list", + "member":{"shape":"EphemerisStatus"}, + "max":500, + "min":0 + }, + "EphemerisTypeDescription":{ + "type":"structure", + "members":{ + "oem":{"shape":"EphemerisDescription"}, + "tle":{"shape":"EphemerisDescription"} + }, + "union":true + }, "Frequency":{ "type":"structure", "required":[ @@ -876,7 +1126,7 @@ ], "members":{ "configId":{ - "shape":"String", + "shape":"Uuid", "location":"uri", "locationName":"configId" }, @@ -909,7 +1159,7 @@ "required":["dataflowEndpointGroupId"], "members":{ "dataflowEndpointGroupId":{ - "shape":"String", + "shape":"Uuid", "location":"uri", "locationName":"dataflowEndpointGroupId" } @@ -919,7 +1169,7 @@ "type":"structure", "members":{ "dataflowEndpointGroupArn":{"shape":"DataflowEndpointGroupArn"}, - "dataflowEndpointGroupId":{"shape":"String"}, + "dataflowEndpointGroupId":{"shape":"Uuid"}, "endpointsDetails":{"shape":"EndpointDetailsList"}, "tags":{"shape":"TagsMap"} } @@ -931,8 +1181,8 @@ "year" ], "members":{ - "month":{"shape":"Integer"}, - "year":{"shape":"Integer"} + "month":{"shape":"Month"}, + "year":{"shape":"Year"} } }, "GetMinuteUsageResponse":{ @@ -950,7 +1200,7 @@ "required":["missionProfileId"], "members":{ "missionProfileId":{ - "shape":"String", + "shape":"Uuid", "location":"uri", "locationName":"missionProfileId" } @@ -962,11 +1212,11 @@ "contactPostPassDurationSeconds":{"shape":"DurationInSeconds"}, "contactPrePassDurationSeconds":{"shape":"DurationInSeconds"}, "dataflowEdges":{"shape":"DataflowEdgeList"}, - "minimumViableContactDurationSeconds":{"shape":"DurationInSeconds"}, + "minimumViableContactDurationSeconds":{"shape":"PositiveDurationInSeconds"}, "missionProfileArn":{"shape":"MissionProfileArn"}, - "missionProfileId":{"shape":"String"}, - "name":{"shape":"String"}, - "region":{"shape":"String"}, + "missionProfileId":{"shape":"Uuid"}, + "name":{"shape":"SafeName"}, + "region":{"shape":"AWSRegion"}, "tags":{"shape":"TagsMap"}, "trackingConfigArn":{"shape":"ConfigArn"} } @@ -976,7 +1226,7 @@ "required":["satelliteId"], "members":{ "satelliteId":{ - "shape":"String", + "shape":"Uuid", "location":"uri", "locationName":"satelliteId" } @@ -985,6 +1235,7 @@ "GetSatelliteResponse":{ "type":"structure", "members":{ + "currentEphemeris":{"shape":"EphemerisMetaData"}, "groundStations":{"shape":"GroundStationIdList"}, "noradSatelliteID":{"shape":"noradSatelliteID"}, "satelliteArn":{"shape":"satelliteArn"}, @@ -994,19 +1245,27 @@ "GroundStationData":{ "type":"structure", "members":{ - "groundStationId":{"shape":"String"}, - "groundStationName":{"shape":"String"}, - "region":{"shape":"String"} + "groundStationId":{"shape":"GroundStationName"}, + "groundStationName":{"shape":"GroundStationName"}, + "region":{"shape":"AWSRegion"} } }, "GroundStationIdList":{ "type":"list", - "member":{"shape":"String"} + "member":{"shape":"GroundStationName"}, + "max":500, + "min":0 }, "GroundStationList":{ "type":"list", "member":{"shape":"GroundStationData"} }, + "GroundStationName":{ + "type":"string", + "max":500, + "min":4, + "pattern":"^[ a-zA-Z0-9-._:=]{4,256}$" + }, "Integer":{ "type":"integer", "box":true @@ -1029,16 +1288,17 @@ "min":2, "pattern":"^[{}\\[\\]:.,\"0-9A-z\\-_\\s]{2,8192}$" }, + "KeyArn":{"type":"string"}, "ListConfigsRequest":{ "type":"structure", "members":{ "maxResults":{ - "shape":"Integer", + "shape":"PaginationMaxResults", "location":"querystring", "locationName":"maxResults" }, "nextToken":{ - "shape":"String", + "shape":"PaginationToken", "location":"querystring", "locationName":"nextToken" } @@ -1048,7 +1308,7 @@ "type":"structure", "members":{ "configList":{"shape":"ConfigList"}, - "nextToken":{"shape":"String"} + "nextToken":{"shape":"PaginationToken"} } }, "ListContactsRequest":{ @@ -1060,10 +1320,10 @@ ], "members":{ "endTime":{"shape":"Timestamp"}, - "groundStation":{"shape":"String"}, - "maxResults":{"shape":"Integer"}, + "groundStation":{"shape":"GroundStationName"}, + "maxResults":{"shape":"PaginationMaxResults"}, "missionProfileArn":{"shape":"MissionProfileArn"}, - "nextToken":{"shape":"String"}, + "nextToken":{"shape":"PaginationToken"}, "satelliteArn":{"shape":"satelliteArn"}, "startTime":{"shape":"Timestamp"}, "statusList":{"shape":"StatusList"} @@ -1073,19 +1333,19 @@ "type":"structure", "members":{ "contactList":{"shape":"ContactList"}, - "nextToken":{"shape":"String"} + "nextToken":{"shape":"PaginationToken"} } }, "ListDataflowEndpointGroupsRequest":{ "type":"structure", "members":{ "maxResults":{ - "shape":"Integer", + "shape":"PaginationMaxResults", "location":"querystring", "locationName":"maxResults" }, "nextToken":{ - "shape":"String", + "shape":"PaginationToken", "location":"querystring", "locationName":"nextToken" } @@ -1095,24 +1355,55 @@ "type":"structure", "members":{ "dataflowEndpointGroupList":{"shape":"DataflowEndpointGroupList"}, - "nextToken":{"shape":"String"} + "nextToken":{"shape":"PaginationToken"} + } + }, + "ListEphemeridesRequest":{ + "type":"structure", + "required":[ + "endTime", + "satelliteId", + "startTime" + ], + "members":{ + "endTime":{"shape":"Timestamp"}, + "maxResults":{ + "shape":"PaginationMaxResults", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"PaginationToken", + "location":"querystring", + "locationName":"nextToken" + }, + "satelliteId":{"shape":"Uuid"}, + "startTime":{"shape":"Timestamp"}, + "statusList":{"shape":"EphemerisStatusList"} + } + }, + "ListEphemeridesResponse":{ + "type":"structure", + "members":{ + "ephemerides":{"shape":"EphemeridesList"}, + "nextToken":{"shape":"PaginationToken"} } }, "ListGroundStationsRequest":{ "type":"structure", "members":{ "maxResults":{ - "shape":"Integer", + "shape":"PaginationMaxResults", "location":"querystring", "locationName":"maxResults" }, "nextToken":{ - "shape":"String", + "shape":"PaginationToken", "location":"querystring", "locationName":"nextToken" }, "satelliteId":{ - "shape":"String", + "shape":"Uuid", "location":"querystring", "locationName":"satelliteId" } @@ -1122,19 +1413,19 @@ "type":"structure", "members":{ "groundStationList":{"shape":"GroundStationList"}, - "nextToken":{"shape":"String"} + "nextToken":{"shape":"PaginationToken"} } }, "ListMissionProfilesRequest":{ "type":"structure", "members":{ "maxResults":{ - "shape":"Integer", + "shape":"PaginationMaxResults", "location":"querystring", "locationName":"maxResults" }, "nextToken":{ - "shape":"String", + "shape":"PaginationToken", "location":"querystring", "locationName":"nextToken" } @@ -1144,19 +1435,19 @@ "type":"structure", "members":{ "missionProfileList":{"shape":"MissionProfileList"}, - "nextToken":{"shape":"String"} + "nextToken":{"shape":"PaginationToken"} } }, "ListSatellitesRequest":{ "type":"structure", "members":{ "maxResults":{ - "shape":"Integer", + "shape":"PaginationMaxResults", "location":"querystring", "locationName":"maxResults" }, "nextToken":{ - "shape":"String", + "shape":"PaginationToken", "location":"querystring", "locationName":"nextToken" } @@ -1165,7 +1456,7 @@ "ListSatellitesResponse":{ "type":"structure", "members":{ - "nextToken":{"shape":"String"}, + "nextToken":{"shape":"PaginationToken"}, "satellites":{"shape":"SatelliteList"} } }, @@ -1174,7 +1465,7 @@ "required":["resourceArn"], "members":{ "resourceArn":{ - "shape":"String", + "shape":"AnyArn", "location":"uri", "locationName":"resourceArn" } @@ -1190,7 +1481,7 @@ "MissionProfileIdResponse":{ "type":"structure", "members":{ - "missionProfileId":{"shape":"String"} + "missionProfileId":{"shape":"Uuid"} } }, "MissionProfileList":{ @@ -1201,11 +1492,36 @@ "type":"structure", "members":{ "missionProfileArn":{"shape":"MissionProfileArn"}, - "missionProfileId":{"shape":"String"}, - "name":{"shape":"String"}, - "region":{"shape":"String"} + "missionProfileId":{"shape":"Uuid"}, + "name":{"shape":"SafeName"}, + "region":{"shape":"AWSRegion"} } }, + "Month":{ + "type":"integer", + "box":true, + "max":12, + "min":1 + }, + "OEMEphemeris":{ + "type":"structure", + "members":{ + "oemData":{"shape":"UnboundedString"}, + "s3Object":{"shape":"S3Object"} + } + }, + "PaginationMaxResults":{ + "type":"integer", + "box":true, + "max":100, + "min":0 + }, + "PaginationToken":{ + "type":"string", + "max":1000, + "min":3, + "pattern":"^[A-Za-z0-9-/+_.=]+$" + }, "Polarization":{ "type":"string", "enum":[ @@ -1214,6 +1530,12 @@ "RIGHT_HAND" ] }, + "PositiveDurationInSeconds":{ + "type":"integer", + "box":true, + "max":21600, + "min":1 + }, "ReserveContactRequest":{ "type":"structure", "required":[ @@ -1225,7 +1547,7 @@ ], "members":{ "endTime":{"shape":"Timestamp"}, - "groundStation":{"shape":"String"}, + "groundStation":{"shape":"GroundStationName"}, "missionProfileArn":{"shape":"MissionProfileArn"}, "satelliteArn":{"shape":"satelliteArn"}, "startTime":{"shape":"Timestamp"}, @@ -1256,12 +1578,32 @@ "exception":true }, "RoleArn":{"type":"string"}, + "S3BucketName":{ + "type":"string", + "max":63, + "min":3, + "pattern":"^[a-z0-9.-]{3,63}$" + }, "S3KeyPrefix":{ "type":"string", "max":900, "min":1, "pattern":"^([a-zA-Z0-9_\\-=/]|\\{satellite_id\\}|\\{config\\-name}|\\{s3\\-config-id}|\\{year\\}|\\{month\\}|\\{day\\}){1,900}$" }, + "S3Object":{ + "type":"structure", + "members":{ + "bucket":{"shape":"S3BucketName"}, + "key":{"shape":"S3ObjectKey"}, + "version":{"shape":"S3VersionId"} + } + }, + "S3ObjectKey":{ + "type":"string", + "max":1024, + "min":1, + "pattern":"^[a-zA-Z0-9!*'\\)\\(./_-]{1,1024}$" + }, "S3RecordingConfig":{ "type":"structure", "required":[ @@ -1281,6 +1623,12 @@ "keyTemplate":{"shape":"String"} } }, + "S3VersionId":{ + "type":"string", + "max":1024, + "min":1, + "pattern":"^[\\s\\S]{1,1024}$" + }, "SafeName":{ "type":"string", "max":256, @@ -1294,6 +1642,7 @@ "SatelliteListItem":{ "type":"structure", "members":{ + "currentEphemeris":{"shape":"EphemerisMetaData"}, "groundStations":{"shape":"GroundStationIdList"}, "noradSatelliteID":{"shape":"noradSatelliteID"}, "satelliteArn":{"shape":"satelliteArn"}, @@ -1351,16 +1700,46 @@ }, "StatusList":{ "type":"list", - "member":{"shape":"ContactStatus"} + "member":{"shape":"ContactStatus"}, + "max":500, + "min":0 }, "String":{"type":"string"}, "SubnetList":{ "type":"list", "member":{"shape":"String"} }, + "TLEData":{ + "type":"structure", + "required":[ + "tleLine1", + "tleLine2", + "validTimeRange" + ], + "members":{ + "tleLine1":{"shape":"TleLineOne"}, + "tleLine2":{"shape":"TleLineTwo"}, + "validTimeRange":{"shape":"TimeRange"} + } + }, + "TLEDataList":{ + "type":"list", + "member":{"shape":"TLEData"}, + "max":500, + "min":1 + }, + "TLEEphemeris":{ + "type":"structure", + "members":{ + "s3Object":{"shape":"S3Object"}, + "tleData":{"shape":"TLEDataList"} + } + }, "TagKeys":{ "type":"list", - "member":{"shape":"String"} + "member":{"shape":"UnboundedString"}, + "max":500, + "min":0 }, "TagResourceRequest":{ "type":"structure", @@ -1370,7 +1749,7 @@ ], "members":{ "resourceArn":{ - "shape":"String", + "shape":"AnyArn", "location":"uri", "locationName":"resourceArn" }, @@ -1387,7 +1766,30 @@ "key":{"shape":"String"}, "value":{"shape":"String"} }, + "TimeRange":{ + "type":"structure", + "required":[ + "endTime", + "startTime" + ], + "members":{ + "endTime":{"shape":"Timestamp"}, + "startTime":{"shape":"Timestamp"} + } + }, "Timestamp":{"type":"timestamp"}, + "TleLineOne":{ + "type":"string", + "max":69, + "min":69, + "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]$" + }, + "TleLineTwo":{ + "type":"string", + "max":69, + "min":69, + "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]$" + }, "TrackingConfig":{ "type":"structure", "required":["autotrack"], @@ -1395,6 +1797,11 @@ "autotrack":{"shape":"Criticality"} } }, + "UnboundedString":{ + "type":"string", + "min":1, + "pattern":"^[\\s\\S]+$" + }, "UntagResourceRequest":{ "type":"structure", "required":[ @@ -1403,7 +1810,7 @@ ], "members":{ "resourceArn":{ - "shape":"String", + "shape":"AnyArn", "location":"uri", "locationName":"resourceArn" }, @@ -1430,7 +1837,7 @@ "members":{ "configData":{"shape":"ConfigTypeData"}, "configId":{ - "shape":"String", + "shape":"Uuid", "location":"uri", "locationName":"configId" }, @@ -1442,6 +1849,23 @@ "name":{"shape":"SafeName"} } }, + "UpdateEphemerisRequest":{ + "type":"structure", + "required":[ + "enabled", + "ephemerisId" + ], + "members":{ + "enabled":{"shape":"Boolean"}, + "ephemerisId":{ + "shape":"Uuid", + "location":"uri", + "locationName":"ephemerisId" + }, + "name":{"shape":"SafeName"}, + "priority":{"shape":"EphemerisPriority"} + } + }, "UpdateMissionProfileRequest":{ "type":"structure", "required":["missionProfileId"], @@ -1449,9 +1873,9 @@ "contactPostPassDurationSeconds":{"shape":"DurationInSeconds"}, "contactPrePassDurationSeconds":{"shape":"DurationInSeconds"}, "dataflowEdges":{"shape":"DataflowEdgeList"}, - "minimumViableContactDurationSeconds":{"shape":"DurationInSeconds"}, + "minimumViableContactDurationSeconds":{"shape":"PositiveDurationInSeconds"}, "missionProfileId":{ - "shape":"String", + "shape":"Uuid", "location":"uri", "locationName":"missionProfileId" }, @@ -1482,12 +1906,18 @@ "type":"string", "max":128, "min":1, - "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}" + "pattern":"^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$" + }, + "Year":{ + "type":"integer", + "box":true, + "max":3000, + "min":2018 }, "noradSatelliteID":{ "type":"integer", "max":99999, - "min":1 + "min":0 }, "satelliteArn":{"type":"string"} } diff --git a/models/apis/groundstation/2019-05-23/docs-2.json b/models/apis/groundstation/2019-05-23/docs-2.json index b9ace74e989..9c7642a9d50 100644 --- a/models/apis/groundstation/2019-05-23/docs-2.json +++ b/models/apis/groundstation/2019-05-23/docs-2.json @@ -5,11 +5,14 @@ "CancelContact": "Cancels a contact with a specified contact ID.
", "CreateConfig": "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 to specify which endpoints to use during a contact.
When a contact uses multiple DataflowEndpointConfig objects, each Config must match a DataflowEndpoint in the same group.
Creates an Ephemeris with the specified EphemerisData.
Creates a mission profile.
dataflowEdges is a list of lists of strings. Each lower level list of strings has two elements: a from ARN and a to ARN.
Deletes a Config.
Deletes a dataflow endpoint group.
", + "DeleteEphemeris": "Deletes an ephemeris
", "DeleteMissionProfile": "Deletes a mission profile.
", "DescribeContact": "Describes an existing contact.
", + "DescribeEphemeris": "Describes an existing ephemeris.
", "GetConfig": "Returns Config information.
Only one Config response can be returned.
Returns the dataflow endpoint group.
", "GetMinuteUsage": "Returns the number of minutes used by account.
", @@ -18,6 +21,7 @@ "ListConfigs": "Returns a list of Config objects.
Returns a list of contacts.
If statusList contains AVAILABLE, the request must include groundStation, missionprofileArn, and satelliteArn.
Returns a list of DataflowEndpoint groups.
List existing ephemerides.
", "ListGroundStations": "Returns a list of ground stations.
", "ListMissionProfiles": "Returns a list of mission profiles.
", "ListSatellites": "Returns a list of satellites.
", @@ -26,9 +30,18 @@ "TagResource": "Assigns a tag to a resource.
", "UntagResource": "Deassigns a resource tag.
", "UpdateConfig": "Updates the Config used when scheduling contacts.
Updating a Config will not update the execution parameters for existing future contacts scheduled with this Config.
Updates an existing ephemeris
", "UpdateMissionProfile": "Updates a mission profile.
Updating a mission profile will not update the execution parameters for existing future contacts.
" }, "shapes": { + "AWSRegion": { + "base": null, + "refs": { + "GetMissionProfileResponse$region": "Region of a mission profile.
", + "GroundStationData$region": "Ground station Region.
", + "MissionProfileListItem$region": "Region of a mission profile.
" + } + }, "AngleUnits": { "base": null, "refs": { @@ -59,6 +72,14 @@ "ConfigTypeData$antennaUplinkConfig": "Information about how AWS Ground Station should configure an antenna for uplink during a contact.
" } }, + "AnyArn": { + "base": null, + "refs": { + "ListTagsForResourceRequest$resourceArn": "ARN of a resource.
", + "TagResourceRequest$resourceArn": "ARN of a resource tag.
", + "UntagResourceRequest$resourceArn": "ARN of a resource.
" + } + }, "BandwidthUnits": { "base": null, "refs": { @@ -69,7 +90,11 @@ "base": null, "refs": { "AntennaUplinkConfig$transmitDisabled": "Whether or not uplink transmit is disabled.
", + "CreateEphemerisRequest$enabled": "Whether to set the ephemeris status to ENABLED after validation.
Setting this to false will set the ephemeris status to DISABLED after validation.
Whether or not the ephemeris is enabled.
", + "EphemerisItem$enabled": "Whether or not the ephemeris is enabled.
", "GetMinuteUsageResponse$isReservedMinutesCustomer": "Returns whether or not an account has signed up for the reserved minutes pricing plan, specific to the month being requested.
", + "UpdateEphemerisRequest$enabled": "Whether the ephemeris is enabled or not. Changing this value will not require the ephemeris to be re-validated.
", "UplinkEchoConfig$enabled": "Whether or not an uplink Config is enabled.
Details for certain Config object types in a contact.
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 demod decode.
Additional details for a Config, if type is dataflow-endpoint or antenna-downlink-demod-decode
Current setting for autotrack.
" } }, + "CustomerEphemerisPriority": { + "base": null, + "refs": { + "CreateEphemerisRequest$priority": "Customer-provided priority score to establish the order in which overlapping ephemerides should be used.
The default for customer-provided ephemeris priority is 1, and higher numbers take precedence.
Priority must be 1 or greater
" + } + }, "DataflowDetail": { "base": "Information about a dataflow edge used in a contact.
", "refs": { @@ -273,6 +309,11 @@ "refs": { } }, + "DeleteEphemerisRequest": { + "base": null, + "refs": { + } + }, "DeleteMissionProfileRequest": { "base": "", "refs": { @@ -299,6 +340,16 @@ "refs": { } }, + "DescribeEphemerisRequest": { + "base": null, + "refs": { + } + }, + "DescribeEphemerisResponse": { + "base": null, + "refs": { + } + }, "Destination": { "base": "Dataflow details for the destination side.
", "refs": { @@ -319,13 +370,10 @@ "refs": { "CreateMissionProfileRequest$contactPostPassDurationSeconds": "Amount of time after a contact ends that you’d like to receive a CloudWatch event indicating the pass has finished.
", "CreateMissionProfileRequest$contactPrePassDurationSeconds": "Amount of time prior to contact start you’d like to receive a CloudWatch event indicating an upcoming pass.
", - "CreateMissionProfileRequest$minimumViableContactDurationSeconds": "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.
", "GetMissionProfileResponse$contactPostPassDurationSeconds": "Amount of time after a contact ends that you’d like to receive a CloudWatch event indicating the pass has finished.
", "GetMissionProfileResponse$contactPrePassDurationSeconds": "Amount of time prior to contact start you’d like to receive a CloudWatch event indicating an upcoming pass.
", - "GetMissionProfileResponse$minimumViableContactDurationSeconds": "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.
", "UpdateMissionProfileRequest$contactPostPassDurationSeconds": "Amount of time after a contact ends that you’d like to receive a CloudWatch event indicating the pass has finished.
", - "UpdateMissionProfileRequest$contactPrePassDurationSeconds": "Amount of time after a contact ends that you’d like to receive a CloudWatch event indicating the pass has finished.
", - "UpdateMissionProfileRequest$minimumViableContactDurationSeconds": "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.
" + "UpdateMissionProfileRequest$contactPrePassDurationSeconds": "Amount of time after a contact ends that you’d like to receive a CloudWatch event indicating the pass has finished.
" } }, "Eirp": { @@ -367,6 +415,83 @@ "DataflowEndpoint$status": "Status of a dataflow endpoint.
" } }, + "EphemeridesList": { + "base": null, + "refs": { + "ListEphemeridesResponse$ephemerides": "List of ephemerides.
" + } + }, + "EphemerisData": { + "base": "Ephemeris data.
", + "refs": { + "CreateEphemerisRequest$ephemeris": "Ephemeris data.
" + } + }, + "EphemerisDescription": { + "base": "Description of ephemeris.
", + "refs": { + "EphemerisTypeDescription$oem": null, + "EphemerisTypeDescription$tle": null + } + }, + "EphemerisIdResponse": { + "base": null, + "refs": { + } + }, + "EphemerisInvalidReason": { + "base": null, + "refs": { + "DescribeEphemerisResponse$invalidReason": "Reason that an ephemeris failed validation. Only provided for ephemerides with INVALID status.
Ephemeris item.
", + "refs": { + "EphemeridesList$member": null + } + }, + "EphemerisMetaData": { + "base": "Metadata describing a particular ephemeris.
", + "refs": { + "GetSatelliteResponse$currentEphemeris": "The current ephemeris being used to compute the trajectory of the satellite.
", + "SatelliteListItem$currentEphemeris": "The current ephemeris being used to compute the trajectory of the satellite.
" + } + }, + "EphemerisPriority": { + "base": null, + "refs": { + "DescribeEphemerisResponse$priority": "Customer-provided priority score to establish the order in which overlapping ephemerides should be used.
The default for customer-provided ephemeris priority is 1, and higher numbers take precedence.
Priority must be 1 or greater
", + "EphemerisItem$priority": "Customer-provided priority score to establish the order in which overlapping ephemerides should be used.
The default for customer-provided ephemeris priority is 1, and higher numbers take precedence.
Priority must be 1 or greater
", + "UpdateEphemerisRequest$priority": "Customer-provided priority score to establish the order in which overlapping ephemerides should be used.
The default for customer-provided ephemeris priority is 1, and higher numbers take precedence.
Priority must be 1 or greater
" + } + }, + "EphemerisSource": { + "base": null, + "refs": { + "EphemerisMetaData$source": "The EphemerisSource that generated a given ephemeris.
The status of the ephemeris.
", + "EphemerisItem$status": "The status of the ephemeris.
", + "EphemerisStatusList$member": null + } + }, + "EphemerisStatusList": { + "base": null, + "refs": { + "ListEphemeridesRequest$statusList": "The list of ephemeris status to return.
" + } + }, + "EphemerisTypeDescription": { + "base": "", + "refs": { + "DescribeEphemerisResponse$suppliedData": "Supplied ephemeris data.
" + } + }, "Frequency": { "base": "Object that describes the frequency.
", "refs": { @@ -455,21 +580,23 @@ "ListGroundStationsResponse$groundStationList": "List of ground stations.
" } }, + "GroundStationName": { + "base": null, + "refs": { + "GroundStationData$groundStationId": "UUID of a ground station.
", + "GroundStationData$groundStationName": "Name of a ground station.
", + "GroundStationIdList$member": null, + "ListContactsRequest$groundStation": "Name of a ground station.
", + "ReserveContactRequest$groundStation": "Name of a ground station.
" + } + }, "Integer": { "base": null, "refs": { - "GetMinuteUsageRequest$month": "The month being requested, with a value of 1-12.
", - "GetMinuteUsageRequest$year": "The year being requested, in the format of YYYY.
", "GetMinuteUsageResponse$estimatedMinutesRemaining": "Estimated number of minutes remaining for an account, specific to the month being requested.
", "GetMinuteUsageResponse$totalReservedMinuteAllocation": "Total number of reserved minutes allocated, specific to the month being requested.
", "GetMinuteUsageResponse$totalScheduledMinutes": "Total scheduled minutes for an account, specific to the month being requested.
", "GetMinuteUsageResponse$upcomingMinutesScheduled": "Upcoming minutes scheduled for an account, specific to the month being requested.
", - "ListConfigsRequest$maxResults": "Maximum number of Configs returned.
Maximum number of contacts returned.
", - "ListDataflowEndpointGroupsRequest$maxResults": "Maximum number of dataflow endpoint groups returned.
", - "ListGroundStationsRequest$maxResults": "Maximum number of ground stations returned.
", - "ListMissionProfilesRequest$maxResults": "Maximum number of mission profiles returned.
", - "ListSatellitesRequest$maxResults": "Maximum number of satellites returned.
", "SocketAddress$port": "Port of a socket address.
" } }, @@ -485,6 +612,12 @@ "DemodulationConfig$unvalidatedJSON": "Unvalidated JSON of a demodulation Config.
The ARN of a KMS key used to encrypt the ephemeris in Ground Station.
" + } + }, "ListConfigsRequest": { "base": "", "refs": { @@ -515,6 +648,16 @@ "refs": { } }, + "ListEphemeridesRequest": { + "base": null, + "refs": { + } + }, + "ListEphemeridesResponse": { + "base": null, + "refs": { + } + }, "ListGroundStationsRequest": { "base": "", "refs": { @@ -583,6 +726,49 @@ "MissionProfileList$member": null } }, + "Month": { + "base": null, + "refs": { + "GetMinuteUsageRequest$month": "The month being requested, with a value of 1-12.
" + } + }, + "OEMEphemeris": { + "base": "Ephemeris data in Orbit Ephemeris Message (OEM) format.
", + "refs": { + "EphemerisData$oem": null + } + }, + "PaginationMaxResults": { + "base": null, + "refs": { + "ListConfigsRequest$maxResults": "Maximum number of Configs returned.
Maximum number of contacts returned.
", + "ListDataflowEndpointGroupsRequest$maxResults": "Maximum number of dataflow endpoint groups returned.
", + "ListEphemeridesRequest$maxResults": "Maximum number of ephemerides to return.
", + "ListGroundStationsRequest$maxResults": "Maximum number of ground stations returned.
", + "ListMissionProfilesRequest$maxResults": "Maximum number of mission profiles returned.
", + "ListSatellitesRequest$maxResults": "Maximum number of satellites returned.
" + } + }, + "PaginationToken": { + "base": null, + "refs": { + "ListConfigsRequest$nextToken": "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.
Next token returned in the request of a previous ListContacts call. Used to get the next page of results.
Next token returned in the response of a previous ListContacts call. Used to get the next page of results.
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.
Pagination token.
", + "ListEphemeridesResponse$nextToken": "Pagination token.
", + "ListGroundStationsRequest$nextToken": "Next token that can be supplied in the next call to get the next page of ground stations.
", + "ListGroundStationsResponse$nextToken": "Next token that can be supplied in the next call to get the next page of ground stations.
", + "ListMissionProfilesRequest$nextToken": "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.
Next token that can be supplied in the next call to get the next page of satellites.
", + "ListSatellitesResponse$nextToken": "Next token that can be supplied in the next call to get the next page of satellites.
" + } + }, "Polarization": { "base": null, "refs": { @@ -590,6 +776,14 @@ "UplinkSpectrumConfig$polarization": "Polarization of an uplink spectral Config. Capturing both \"RIGHT_HAND\" and \"LEFT_HAND\" polarization requires two separate configs.
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.
", + "GetMissionProfileResponse$minimumViableContactDurationSeconds": "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.
", + "UpdateMissionProfileRequest$minimumViableContactDurationSeconds": "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.
" + } + }, "ReserveContactRequest": { "base": "", "refs": { @@ -612,12 +806,33 @@ "SecurityDetails$roleArn": "ARN to a role needed for connecting streams to your instances.
" } }, + "S3BucketName": { + "base": null, + "refs": { + "S3Object$bucket": "An Amazon S3 Bucket name.
" + } + }, "S3KeyPrefix": { "base": null, "refs": { "S3RecordingConfig$prefix": "S3 Key prefix to prefice data files.
" } }, + "S3Object": { + "base": "Object stored in S3 containing ephemeris data.
", + "refs": { + "EphemerisDescription$sourceS3Object": "Source S3 object used for the ephemeris.
", + "EphemerisItem$sourceS3Object": "Source S3 object used for the ephemeris.
", + "OEMEphemeris$s3Object": "Identifies the S3 object to be used as the ephemeris.
", + "TLEEphemeris$s3Object": "Identifies the S3 object to be used as the ephemeris.
" + } + }, + "S3ObjectKey": { + "base": null, + "refs": { + "S3Object$key": "An Amazon S3 key for the ephemeris.
" + } + }, "S3RecordingConfig": { "base": "Information about an S3 recording Config.
Details for an S3 recording Config in a contact.
For versioned S3 objects, the version to use for the ephemeris.
" + } + }, "SafeName": { "base": null, "refs": { "CreateConfigRequest$name": "Name of a Config.
A name string associated with the ephemeris. Used as a human-readable identifier for the ephemeris.
", "CreateMissionProfileRequest$name": "Name of a mission profile.
", "DataflowEndpoint$name": "Name of a dataflow endpoint.
", + "DescribeEphemerisResponse$name": "A name string associated with the ephemeris. Used as a human-readable identifier for the ephemeris.
", + "EphemerisItem$name": "A name string associated with the ephemeris. Used as a human-readable identifier for the ephemeris.
", + "EphemerisMetaData$name": "A name string associated with the ephemeris. Used as a human-readable identifier for the ephemeris.
A name is only returned for customer-provider ephemerides that have a name associated.
", + "GetMissionProfileResponse$name": "Name of a mission profile.
", + "MissionProfileListItem$name": "Name of a mission profile.
", "UpdateConfigRequest$name": "Name of a Config.
A name string associated with the ephemeris. Used as a human-readable identifier for the ephemeris.
", "UpdateMissionProfileRequest$name": "Name of a mission profile.
" } }, @@ -655,7 +883,7 @@ "SecurityDetails": { "base": "Information about endpoints.
", "refs": { - "EndpointDetails$securityDetails": "Endpoint security details.
" + "EndpointDetails$securityDetails": "Endpoint security details including a list of subnets, a list of security groups and a role to connect streams to instances.
" } }, "SecurityGroupIdList": { @@ -693,84 +921,36 @@ "base": null, "refs": { "AntennaDemodDecodeDetails$outputNode": "Name of an antenna demod decode output node used in a contact.
", - "CancelContactRequest$contactId": "UUID of a contact.
", "ConfigIdResponse$configId": "UUID of a Config.
UUID of a Config.
Name of a Config.
UUID of a contact.
", "ContactData$errorMessage": "Error message of a contact.
", "ContactData$groundStation": "Name of a ground station.
", "ContactData$region": "Region of a contact.
", - "ContactIdResponse$contactId": "UUID of a contact.
", "DataflowDetail$errorMessage": "Error message for a dataflow.
", "DataflowEndpointConfig$dataflowEndpointName": "Name of a dataflow endpoint.
", "DataflowEndpointConfig$dataflowEndpointRegion": "Region of a dataflow endpoint.
", - "DataflowEndpointGroupIdResponse$dataflowEndpointGroupId": "UUID of a dataflow endpoint group.
", - "DataflowEndpointListItem$dataflowEndpointGroupId": "UUID of a dataflow endpoint group.
", - "DeleteConfigRequest$configId": "UUID of a Config.
UUID of a dataflow endpoint group.
", - "DeleteMissionProfileRequest$missionProfileId": "UUID of a mission profile.
", "DependencyException$message": null, "DependencyException$parameterName": "", - "DescribeContactRequest$contactId": "UUID of a contact.
", - "DescribeContactResponse$contactId": "UUID of a contact.
", "DescribeContactResponse$errorMessage": "Error message for a contact.
", "DescribeContactResponse$groundStation": "Ground station for a contact.
", "DescribeContactResponse$region": "Region of a contact.
", - "Destination$configId": "UUID of a Config.
Region of a dataflow destination.
", - "GetConfigRequest$configId": "UUID of a Config.
UUID of a Config.
Name of a Config.
UUID of a dataflow endpoint group.
", - "GetDataflowEndpointGroupResponse$dataflowEndpointGroupId": "UUID of a dataflow endpoint group.
", - "GetMissionProfileRequest$missionProfileId": "UUID of a mission profile.
", - "GetMissionProfileResponse$missionProfileId": "UUID of a mission profile.
", - "GetMissionProfileResponse$name": "Name of a mission profile.
", - "GetMissionProfileResponse$region": "Region of a mission profile.
", - "GetSatelliteRequest$satelliteId": "UUID of a satellite.
", - "GroundStationData$groundStationId": "UUID of a ground station.
", - "GroundStationData$groundStationName": "Name of a ground station.
", - "GroundStationData$region": "Ground station Region.
", - "GroundStationIdList$member": null, "InvalidParameterException$message": null, "InvalidParameterException$parameterName": "", - "ListConfigsRequest$nextToken": "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.
Name of a ground station.
", - "ListContactsRequest$nextToken": "Next token returned in the request of a previous ListContacts call. Used to get the next page of results.
Next token returned in the response of a previous ListContacts call. Used to get the next page of results.
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.
Next token that can be supplied in the next call to get the next page of ground stations.
", - "ListGroundStationsRequest$satelliteId": "Satellite ID to retrieve on-boarded ground stations.
", - "ListGroundStationsResponse$nextToken": "Next token that can be supplied in the next call to get the next page of ground stations.
", - "ListMissionProfilesRequest$nextToken": "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.
Next token that can be supplied in the next call to get the next page of satellites.
", - "ListSatellitesResponse$nextToken": "Next token that can be supplied in the next call to get the next page of satellites.
", - "ListTagsForResourceRequest$resourceArn": "ARN of a resource.
", - "MissionProfileIdResponse$missionProfileId": "UUID of a mission profile.
", - "MissionProfileListItem$missionProfileId": "UUID of a mission profile.
", - "MissionProfileListItem$name": "Name of a mission profile.
", - "MissionProfileListItem$region": "Region of a mission profile.
", - "ReserveContactRequest$groundStation": "Name of a ground station.
", "ResourceLimitExceededException$message": null, "ResourceLimitExceededException$parameterName": "", "ResourceNotFoundException$message": null, - "S3RecordingDetails$keyTemplate": "Template of the S3 key used.
", + "S3RecordingDetails$keyTemplate": "Key template used for the S3 Recording Configuration
", "SecurityGroupIdList$member": null, "SocketAddress$name": "Name of a socket address.
", "Source$configId": "UUID of a Config.
Region of a dataflow source.
", "SubnetList$member": null, - "TagKeys$member": null, - "TagResourceRequest$resourceArn": "ARN of a resource tag.
", "TagsMap$key": null, - "TagsMap$value": null, - "UntagResourceRequest$resourceArn": "ARN of a resource.
", - "UpdateConfigRequest$configId": "UUID of a Config.
UUID of a mission profile.
" + "TagsMap$value": null } }, "SubnetList": { @@ -779,6 +959,24 @@ "SecurityDetails$subnetIds": "A list of subnets where AWS Ground Station places elastic network interfaces to send streams to your instances.
" } }, + "TLEData": { + "base": "Two-line element set (TLE) data.
", + "refs": { + "TLEDataList$member": null + } + }, + "TLEDataList": { + "base": null, + "refs": { + "TLEEphemeris$tleData": "The data for a TLE ephemeris, supplied directly in the request rather than through an S3 object.
" + } + }, + "TLEEphemeris": { + "base": "Two-line element set (TLE) ephemeris.
", + "refs": { + "EphemerisData$tle": null + } + }, "TagKeys": { "base": null, "refs": { @@ -801,8 +999,10 @@ "ContactData$tags": "Tags assigned to a contact.
", "CreateConfigRequest$tags": "Tags assigned to a Config.
Tags of a dataflow endpoint group.
", + "CreateEphemerisRequest$tags": "Tags assigned to an ephemeris.
", "CreateMissionProfileRequest$tags": "Tags assigned to a mission profile.
", "DescribeContactResponse$tags": "Tags assigned to a contact.
", + "DescribeEphemerisResponse$tags": "Tags assigned to an ephemeris.
", "GetConfigResponse$tags": "Tags assigned to a Config.
Tags assigned to a dataflow endpoint group.
", "GetMissionProfileResponse$tags": "Tags assigned to a mission profile.
", @@ -811,21 +1011,47 @@ "TagResourceRequest$tags": "Tags assigned to a resource.
" } }, + "TimeRange": { + "base": "A time range with a start and end time.
", + "refs": { + "TLEData$validTimeRange": "The valid time range for the TLE. Gaps or overlap are not permitted.
" + } + }, "Timestamp": { "base": null, "refs": { - "ContactData$endTime": "End time of a contact.
", + "ContactData$endTime": "End time of a contact in UTC.
", "ContactData$postPassEndTime": "Amount of time after a contact ends that you’d like to receive a CloudWatch event indicating the pass has finished.
", "ContactData$prePassStartTime": "Amount of time prior to contact start you’d like to receive a CloudWatch event indicating an upcoming pass.
", - "ContactData$startTime": "Start time of a contact.
", - "DescribeContactResponse$endTime": "End time of a contact.
", + "ContactData$startTime": "Start time of a contact in UTC.
", + "CreateEphemerisRequest$expirationTime": "An overall expiration time for the ephemeris in UTC, after which it will become EXPIRED.
End time of a contact in UTC.
", "DescribeContactResponse$postPassEndTime": "Amount of time after a contact ends that you’d like to receive a CloudWatch event indicating the pass has finished.
", "DescribeContactResponse$prePassStartTime": "Amount of time prior to contact start you’d like to receive a CloudWatch event indicating an upcoming pass.
", - "DescribeContactResponse$startTime": "Start time of a contact.
", - "ListContactsRequest$endTime": "End time of a contact.
", - "ListContactsRequest$startTime": "Start time of a contact.
", - "ReserveContactRequest$endTime": "End time of a contact.
", - "ReserveContactRequest$startTime": "Start time of a contact.
" + "DescribeContactResponse$startTime": "Start time of a contact in UTC.
", + "DescribeEphemerisResponse$creationTime": "The time the ephemeris was uploaded in UTC.
", + "EphemerisItem$creationTime": "The time the ephemeris was uploaded in UTC.
", + "EphemerisMetaData$epoch": "The epoch of a default, ephemeris from Space Track in UTC.
This field is not populated for customer-provided ephemerides.
", + "ListContactsRequest$endTime": "End time of a contact in UTC.
", + "ListContactsRequest$startTime": "Start time of a contact in UTC.
", + "ListEphemeridesRequest$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 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.
End time of a contact in UTC.
", + "ReserveContactRequest$startTime": "Start time of a contact in UTC.
", + "TimeRange$endTime": "Time in UTC at which the time range ends.
", + "TimeRange$startTime": "Time in UTC at which the time range starts.
" + } + }, + "TleLineOne": { + "base": null, + "refs": { + "TLEData$tleLine1": "First line of two-line element set (TLE) data.
" + } + }, + "TleLineTwo": { + "base": null, + "refs": { + "TLEData$tleLine2": "Second line of two-line element set (TLE) data.
" } }, "TrackingConfig": { @@ -834,6 +1060,14 @@ "ConfigTypeData$trackingConfig": "Object that determines whether tracking should be used during a contact executed with this Config in the mission profile.
Supplied ephemeris data.
", + "OEMEphemeris$oemData": "The data for an OEM ephemeris, supplied directly in the request rather than through an S3 object.
", + "TagKeys$member": null + } + }, "UntagResourceRequest": { "base": "", "refs": { @@ -849,6 +1083,11 @@ "refs": { } }, + "UpdateEphemerisRequest": { + "base": null, + "refs": { + } + }, "UpdateMissionProfileRequest": { "base": "", "refs": { @@ -869,8 +1108,46 @@ "Uuid": { "base": null, "refs": { + "CancelContactRequest$contactId": "UUID of a contact.
", + "ContactData$contactId": "UUID of a contact.
", + "ContactIdResponse$contactId": "UUID of a contact.
", + "CreateEphemerisRequest$satelliteId": "AWS Ground Station satellite ID for this ephemeris.
", + "DataflowEndpointGroupIdResponse$dataflowEndpointGroupId": "UUID of a dataflow endpoint group.
", + "DataflowEndpointListItem$dataflowEndpointGroupId": "UUID of a dataflow endpoint group.
", + "DeleteConfigRequest$configId": "UUID of a Config.
UUID of a dataflow endpoint group.
", + "DeleteEphemerisRequest$ephemerisId": "The AWS Ground Station ephemeris ID.
", + "DeleteMissionProfileRequest$missionProfileId": "UUID of a mission profile.
", + "DescribeContactRequest$contactId": "UUID of a contact.
", + "DescribeContactResponse$contactId": "UUID of a contact.
", + "DescribeEphemerisRequest$ephemerisId": "The AWS Ground Station ephemeris ID.
", + "DescribeEphemerisResponse$ephemerisId": "The AWS Ground Station ephemeris ID.
", + "DescribeEphemerisResponse$satelliteId": "The AWS Ground Station satellite ID associated with ephemeris.
", + "Destination$configId": "UUID of a Config.
The AWS Ground Station ephemeris ID.
", + "EphemerisItem$ephemerisId": "The AWS Ground Station ephemeris ID.
", + "EphemerisMetaData$ephemerisId": "UUID of a customer-provided ephemeris.
This field is not populated for default ephemerides from Space Track.
", + "GetConfigRequest$configId": "UUID of a Config.
UUID of a dataflow endpoint group.
", + "GetDataflowEndpointGroupResponse$dataflowEndpointGroupId": "UUID of a dataflow endpoint group.
", + "GetMissionProfileRequest$missionProfileId": "UUID of a mission profile.
", + "GetMissionProfileResponse$missionProfileId": "UUID of a mission profile.
", + "GetSatelliteRequest$satelliteId": "UUID of a satellite.
", "GetSatelliteResponse$satelliteId": "UUID of a satellite.
", - "SatelliteListItem$satelliteId": "UUID of a satellite.
" + "ListEphemeridesRequest$satelliteId": "The AWS Ground Station satellite ID to list ephemeris for.
", + "ListGroundStationsRequest$satelliteId": "Satellite ID to retrieve on-boarded ground stations.
", + "MissionProfileIdResponse$missionProfileId": "UUID of a mission profile.
", + "MissionProfileListItem$missionProfileId": "UUID of a mission profile.
", + "SatelliteListItem$satelliteId": "UUID of a satellite.
", + "UpdateConfigRequest$configId": "UUID of a Config.
The AWS Ground Station ephemeris ID.
", + "UpdateMissionProfileRequest$missionProfileId": "UUID of a mission profile.
" + } + }, + "Year": { + "base": null, + "refs": { + "GetMinuteUsageRequest$year": "The year being requested, in the format of YYYY.
" } }, "noradSatelliteID": { diff --git a/models/apis/groundstation/2019-05-23/endpoint-rule-set-1.json b/models/apis/groundstation/2019-05-23/endpoint-rule-set-1.json new file mode 100644 index 00000000000..24b35d1da46 --- /dev/null +++ b/models/apis/groundstation/2019-05-23/endpoint-rule-set-1.json @@ -0,0 +1,315 @@ +{ + "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" + } + ] + } + ] +} \ No newline at end of file diff --git a/models/apis/groundstation/2019-05-23/endpoint-tests-1.json b/models/apis/groundstation/2019-05-23/endpoint-tests-1.json new file mode 100644 index 00000000000..86cc42b2d13 --- /dev/null +++ b/models/apis/groundstation/2019-05-23/endpoint-tests-1.json @@ -0,0 +1,719 @@ +{ + "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" +} \ No newline at end of file diff --git a/models/apis/groundstation/2019-05-23/paginators-1.json b/models/apis/groundstation/2019-05-23/paginators-1.json index 373acccef58..82920fa5799 100644 --- a/models/apis/groundstation/2019-05-23/paginators-1.json +++ b/models/apis/groundstation/2019-05-23/paginators-1.json @@ -18,6 +18,12 @@ "limit_key": "maxResults", "result_key": "dataflowEndpointGroupList" }, + "ListEphemerides": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "ephemerides" + }, "ListGroundStations": { "input_token": "nextToken", "output_token": "nextToken", diff --git a/models/apis/mediapackage-vod/2018-11-07/api-2.json b/models/apis/mediapackage-vod/2018-11-07/api-2.json index 6a17e8d536f..cdd5234194a 100644 --- a/models/apis/mediapackage-vod/2018-11-07/api-2.json +++ b/models/apis/mediapackage-vod/2018-11-07/api-2.json @@ -1033,6 +1033,10 @@ "locationName": "includeEncoderConfigurationInSegments", "shape": "__boolean" }, + "IncludeIframeOnlyStream": { + "locationName": "includeIframeOnlyStream", + "shape": "__boolean" + }, "PeriodTriggers": { "locationName": "periodTriggers", "shape": "__listOf__PeriodTriggersElement" diff --git a/models/apis/mediapackage-vod/2018-11-07/docs-2.json b/models/apis/mediapackage-vod/2018-11-07/docs-2.json index 2284292fc6f..f70e533c389 100644 --- a/models/apis/mediapackage-vod/2018-11-07/docs-2.json +++ b/models/apis/mediapackage-vod/2018-11-07/docs-2.json @@ -271,6 +271,7 @@ "refs" : { "CmafPackage$IncludeEncoderConfigurationInSegments" : "When includeEncoderConfigurationInSegments is set to true, MediaPackage places your encoder's Sequence Parameter Set (SPS), Picture Parameter Set (PPS), and Video Parameter Set (VPS) metadata in every video segment instead of in the init fragment. This lets you use different SPS/PPS/VPS settings for your assets during content playback.\n", "DashPackage$IncludeEncoderConfigurationInSegments" : "When includeEncoderConfigurationInSegments is set to true, MediaPackage places your encoder's Sequence Parameter Set (SPS), Picture Parameter Set (PPS), and Video Parameter Set (VPS) metadata in every video segment instead of in the init fragment. This lets you use different SPS/PPS/VPS settings for your assets during content playback.\n", + "DashPackage$IncludeIframeOnlyStream" : "When enabled, an I-Frame only stream will be included in the output.", "HlsManifest$IncludeIframeOnlyStream" : "When enabled, an I-Frame only stream will be included in the output.", "HlsManifest$RepeatExtXKey" : "When enabled, the EXT-X-KEY tag will be repeated in output manifests.", "HlsPackage$IncludeDvbSubtitles" : "When enabled, MediaPackage passes through digital video broadcasting (DVB) subtitles into the output.", diff --git a/models/apis/mediapackage-vod/2018-11-07/endpoint-rule-set-1.json b/models/apis/mediapackage-vod/2018-11-07/endpoint-rule-set-1.json new file mode 100644 index 00000000000..444cef943c2 --- /dev/null +++ b/models/apis/mediapackage-vod/2018-11-07/endpoint-rule-set-1.json @@ -0,0 +1,315 @@ +{ + "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" + } + ] + } + ] +} \ No newline at end of file diff --git a/models/apis/mediapackage-vod/2018-11-07/endpoint-tests-1.json b/models/apis/mediapackage-vod/2018-11-07/endpoint-tests-1.json new file mode 100644 index 00000000000..d2402a72cec --- /dev/null +++ b/models/apis/mediapackage-vod/2018-11-07/endpoint-tests-1.json @@ -0,0 +1,919 @@ +{ + "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" +} \ No newline at end of file diff --git a/models/apis/transcribe-streaming/2017-10-26/api-2.json b/models/apis/transcribe-streaming/2017-10-26/api-2.json index d8bb1e59ab4..3e32cbe2f1c 100755 --- a/models/apis/transcribe-streaming/2017-10-26/api-2.json +++ b/models/apis/transcribe-streaming/2017-10-26/api-2.json @@ -165,7 +165,9 @@ "pt-BR", "ja-JP", "ko-KR", - "zh-CN" + "zh-CN", + "hi-IN", + "th-TH" ] }, "LanguageIdentification":{ diff --git a/models/apis/transcribe-streaming/2017-10-26/docs-2.json b/models/apis/transcribe-streaming/2017-10-26/docs-2.json index ad7bcd54d06..270e34e3d26 100755 --- a/models/apis/transcribe-streaming/2017-10-26/docs-2.json +++ b/models/apis/transcribe-streaming/2017-10-26/docs-2.json @@ -1,13 +1,13 @@ { "version": "2.0", - "service": "Operations and objects for transcribing streaming speech to text.
", + "service": "Amazon Transcribe streaming offers two types of real-time transcription: Standard and Medical.
Standard transcriptions are the most common option. Refer to for details.
Medical transcriptions are tailored to medical professionals and incorporate medical terms. A common use case for this service is transcribing doctor-patient dialogue in real time, so doctors can focus on their patient instead of taking notes. Refer to for details.
Starts a bidirectional HTTP/2 stream where audio is streamed to Amazon Transcribe Medical and the transcription results are streamed to your application.
", - "StartStreamTranscription": "Starts a bidirectional HTTP/2 stream where audio is streamed to Amazon Transcribe and the transcription results are streamed to your application.
The following are encoded as HTTP/2 headers:
x-amzn-transcribe-language-code
x-amzn-transcribe-media-encoding
x-amzn-transcribe-sample-rate
x-amzn-transcribe-session-id
See the SDK for Go API Reference for more detail.
" + "StartMedicalStreamTranscription": "Starts a bidirectional HTTP/2 or WebSocket stream where audio is streamed to Amazon Transcribe Medical and the transcription results are streamed to your application.
For more information on streaming with Amazon Transcribe Medical, see Transcribing streaming audio.
", + "StartStreamTranscription": "Starts a bidirectional HTTP/2 or WebSocket stream where audio is streamed to Amazon Transcribe and the transcription results are streamed to your application.
The following are encoded as headers:
language-code
media-encoding
sample-rate
session-id
For more information on streaming with Amazon Transcribe, see Transcribing streaming audio.
" }, "shapes": { "Alternative": { - "base": "A list of possible transcriptions for the audio.
", + "base": "A list of possible alternative transcriptions for the input audio. Each alternative may contain one or more of Items, Entities, or Transcript.
A list of possible transcriptions for the audio. Each alternative typically contains one item that contains the result of the transcription.
A list of possible alternative transcriptions for the input audio. Each alternative may contain one or more of Items, Entities, or Transcript.
Provides a wrapper for the audio chunks that you are sending.
For information on audio encoding in Amazon Transcribe, see Speech input. For information on audio encoding formats in Amazon Transcribe Medical, see Speech input.
", + "base": "A wrapper for your audio chunks. Your audio stream consists of one or more audio events, which consist of one or more audio chunks.
For more information, see Event stream encoding.
", "refs": { - "AudioStream$AudioEvent": "A blob of audio from your application. You audio stream consists of one or more audio events.
For information on audio encoding formats in Amazon Transcribe, see Speech input. For information on audio encoding formats in Amazon Transcribe Medical, see Speech input.
For more information on stream encoding in Amazon Transcribe, see Event stream encoding. For information on stream encoding in Amazon Transcribe Medical, see Event stream encoding.
" + "AudioStream$AudioEvent": "A blob of audio from your application. Your audio stream consists of one or more audio events.
For more information, see Event stream encoding.
" } }, "AudioStream": { - "base": "Represents the audio stream from your application to Amazon Transcribe.
", + "base": "An encoded stream of audio blobs. Audio streams are encoded as either HTTP/2 or WebSocket data frames.
For more information, see Transcribing streaming audio.
", "refs": { "StartMedicalStreamTranscriptionRequest$AudioStream": null, - "StartStreamTranscriptionRequest$AudioStream": "PCM-encoded stream of audio blobs. The audio stream is encoded as an HTTP/2 data frame.
" + "StartStreamTranscriptionRequest$AudioStream": "An encoded stream of audio blobs. Audio streams are encoded as either HTTP/2 or WebSocket data frames.
For more information, see Transcribing streaming audio.
" } }, "BadRequestException": { - "base": "One or more arguments to the StartStreamTranscription or StartMedicalStreamTranscription operation was invalid. For example, MediaEncoding was not set to a valid encoding, or LanguageCode was not set to a valid code. Check the parameters and try your request again.
One or more arguments to the StartStreamTranscription or StartMedicalStreamTranscription operation was not valid. For example, MediaEncoding or LanguageCode used not valid values. Check the specified parameters and try your request again.
A client error occurred when the stream was created. Check the parameters of the request and try your request again.
" @@ -47,30 +47,30 @@ "Boolean": { "base": null, "refs": { - "Item$VocabularyFilterMatch": "Indicates whether a word in the item matches a word in the vocabulary filter you've chosen for your media stream. If true then a word in the item matches your vocabulary filter.
Amazon Transcribe Medical divides the incoming audio stream into segments at natural points in the audio. Transcription results are returned based on these segments.
The IsPartial field is true to indicate that Amazon Transcribe Medical has additional transcription data to send. The IsPartial field is false to indicate that this is the last transcription result for the segment.
Amazon Transcribe divides the incoming audio stream into segments at natural points in the audio. Transcription results are returned based on these segments.
The IsPartial field is true to indicate that Amazon Transcribe has additional transcription data to send, false to indicate that this is the last transcription result for the segment.
When true, enables speaker identification in your real-time stream.
When true, instructs Amazon Transcribe Medical to process each audio channel separately and 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, end time, and any alternative transcriptions.
You can't set both ShowSpeakerLabel and EnableChannelIdentification in the same request. If you set both, your request returns a BadRequestException.
Shows whether speaker identification was enabled in the stream.
", - "StartMedicalStreamTranscriptionResponse$EnableChannelIdentification": "Shows whether channel identification has been enabled in the stream.
", - "StartStreamTranscriptionRequest$ShowSpeakerLabel": "When true, enables speaker identification in your media stream.
When true, instructs Amazon Transcribe to process each audio channel separately, 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 time, and any alternative transcriptions.
", - "StartStreamTranscriptionRequest$EnablePartialResultsStabilization": "When true, instructs Amazon Transcribe to present transcription results that have the partial results stabilized. Normally, any word or phrase from one partial result can change in a subsequent partial result. With partial results stabilization enabled, only the last few words of one partial result can change in another partial result.
Optional. Set this value to true to enable language identification for your media stream.
Shows whether speaker identification was enabled in the transcription.
", - "StartStreamTranscriptionResponse$EnableChannelIdentification": "Shows whether channel identification was enabled in the stream.
", - "StartStreamTranscriptionResponse$EnablePartialResultsStabilization": "Shows whether partial results stabilization was enabled in the transcription.
", - "StartStreamTranscriptionResponse$IdentifyLanguage": "The language code of the language identified in your media stream.
" + "Item$VocabularyFilterMatch": "Indicates whether the specified item matches a word in the vocabulary filter included in your request. If true, there is a vocabulary filter match.
Indicates if the segment is complete.
If IsPartial is true, the segment is not complete. If IsPartial is false, the segment is complete.
Indicates if the segment is complete.
If IsPartial is true, the segment is not complete. If IsPartial is false, the segment is complete.
Enables speaker partitioning (diarization) in your transcription output. Speaker partitioning labels the speech from individual speakers in your media file.
For more information, see Partitioning speakers (diarization).
", + "StartMedicalStreamTranscriptionRequest$EnableChannelIdentification": "Enables channel identification in multi-channel audio.
Channel identification transcribes the audio on each channel independently, then appends the output for each channel into one transcript.
If you have multi-channel audio and do not enable channel identification, your audio is transcribed in a continuous manner and your transcript is not separated by channel.
For more information, see Transcribing multi-channel audio.
", + "StartMedicalStreamTranscriptionResponse$ShowSpeakerLabel": "Shows whether speaker partitioning was enabled for your transcription.
", + "StartMedicalStreamTranscriptionResponse$EnableChannelIdentification": "Shows whether channel identification was enabled for your transcription.
", + "StartStreamTranscriptionRequest$ShowSpeakerLabel": "Enables speaker partitioning (diarization) in your transcription output. Speaker partitioning labels the speech from individual speakers in your media file.
For more information, see Partitioning speakers (diarization).
", + "StartStreamTranscriptionRequest$EnableChannelIdentification": "Enables channel identification in multi-channel audio.
Channel identification transcribes the audio on each channel independently, then appends the output for each channel into one transcript.
If you have multi-channel audio and do not enable channel identification, your audio is transcribed in a continuous manner and your transcript is not separated by channel.
For more information, see Transcribing multi-channel audio.
", + "StartStreamTranscriptionRequest$EnablePartialResultsStabilization": "Enables partial result stabilization for your transcription. Partial result stabilization can reduce latency in your output, but may impact accuracy. For more information, see Partial-result stabilization.
", + "StartStreamTranscriptionRequest$IdentifyLanguage": "Enables automatic language identification for your transcription.
If you include IdentifyLanguage, you can optionally include a list of language codes, using LanguageOptions, that you think may be present in your audio stream. Including language options can improve transcription accuracy.
You can also include a preferred language using PreferredLanguage. Adding a preferred language can help Amazon Transcribe identify the language faster than if you omit this parameter.
If you have multi-channel audio that contains different languages on each channel, and you've enabled channel identification, automatic language identification identifies the dominant language on each audio channel.
Note that you must include either LanguageCode or IdentifyLanguage in your request. If you include both parameters, your request fails.
Streaming language identification can't be combined with custom language models or redaction.
", + "StartStreamTranscriptionResponse$ShowSpeakerLabel": "Shows whether speaker partitioning was enabled for your transcription.
", + "StartStreamTranscriptionResponse$EnableChannelIdentification": "Shows whether channel identification was enabled for your transcription.
", + "StartStreamTranscriptionResponse$EnablePartialResultsStabilization": "Shows whether partial results stabilization was enabled for your transcription.
", + "StartStreamTranscriptionResponse$IdentifyLanguage": "Shows whether automatic language identification was enabled for your transcription.
" } }, "Confidence": { "base": null, "refs": { - "Entity$Confidence": "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.
", - "Item$Confidence": "A value between zero and one for an item that is a confidence score that Amazon Transcribe assigns to each word or phrase that it transcribes.
", - "MedicalEntity$Confidence": "A value between zero and one that Amazon Transcribe Medical assigned to the personal health information that it identified in the source audio. Larger values indicate that Amazon Transcribe Medical has higher confidence in the personal health information that it identified.
", - "MedicalItem$Confidence": "A value between 0 and 1 for an item that is a confidence score that Amazon Transcribe Medical assigns to each word that it transcribes.
" + "Entity$Confidence": "The confidence score associated with the identified PII entity in your audio.
Confidence scores are values between 0 and 1. A larger value indicates a higher probability that the identified entity correctly matches the entity spoken in your media.
", + "Item$Confidence": "The confidence score associated with a word or phrase in your transcript.
Confidence scores are values between 0 and 1. A larger value indicates a higher probability that the identified item correctly matches the item spoken in your media.
", + "MedicalEntity$Confidence": "The confidence score associated with the identified PHI entity in your audio.
Confidence scores are values between 0 and 1. A larger value indicates a higher probability that the identified entity correctly matches the entity spoken in your media.
", + "MedicalItem$Confidence": "The confidence score associated with a word or phrase in your transcript.
Confidence scores are values between 0 and 1. A larger value indicates a higher probability that the identified item correctly matches the item spoken in your media.
" } }, "ConflictException": { @@ -83,37 +83,37 @@ "ContentIdentificationType": { "base": null, "refs": { - "StartStreamTranscriptionRequest$ContentIdentificationType": "Set this field to PII to identify personally identifiable information (PII) in the transcription output. Content identification is performed only upon complete transcription of the audio segments.
You can’t set both ContentIdentificationType and ContentRedactionType in the same request. If you set both, your request returns a BadRequestException.
Shows whether content identification was enabled in this stream.
" + "StartStreamTranscriptionRequest$ContentIdentificationType": "Labels all personally identifiable information (PII) identified in your transcript.
Content identification is performed at the segment level; PII specified in PiiEntityTypes is flagged upon complete transcription of an audio segment.
You can’t set ContentIdentificationType and ContentRedactionType in the same request. If you set both, your request returns a BadRequestException.
For more information, see Redacting or identifying personally identifiable information.
", + "StartStreamTranscriptionResponse$ContentIdentificationType": "Shows whether content identification was enabled for your transcription.
" } }, "ContentRedactionType": { "base": null, "refs": { - "StartStreamTranscriptionRequest$ContentRedactionType": "Set this field to PII to redact personally identifiable information (PII) in the transcription output. Content redaction is performed only upon complete transcription of the audio segments.
You can’t set both ContentRedactionType and ContentIdentificationType in the same request. If you set both, your request returns a BadRequestException.
Shows whether content redaction was enabled in this stream.
" + "StartStreamTranscriptionRequest$ContentRedactionType": "Redacts all personally identifiable information (PII) identified in your transcript.
Content redaction is performed at the segment level; PII specified in PiiEntityTypes is redacted upon complete transcription of an audio segment.
You can’t set ContentRedactionType and ContentIdentificationType in the same request. If you set both, your request returns a BadRequestException.
For more information, see Redacting or identifying personally identifiable information.
", + "StartStreamTranscriptionResponse$ContentRedactionType": "Shows whether content redaction was enabled for your transcription.
" } }, "Double": { "base": null, "refs": { - "Entity$StartTime": "The start time of speech that was identified as PII.
", - "Entity$EndTime": "The end time of speech that was identified as PII.
", - "Item$StartTime": "The offset from the beginning of the audio stream to the beginning of the audio that resulted in the item.
", - "Item$EndTime": "The offset from the beginning of the audio stream to the end of the audio that resulted in the item.
", - "LanguageWithScore$Score": "The confidence score for the associated language code. Confidence scores are values between zero and one; larger values indicate a higher confidence in the identified language.
", - "MedicalEntity$StartTime": "The start time of the speech that was identified as a medical entity.
", - "MedicalEntity$EndTime": "The end time of the speech that was identified as a medical entity.
", - "MedicalItem$StartTime": "The number of seconds into an audio stream that indicates the creation time of an item.
", - "MedicalItem$EndTime": "The number of seconds into an audio stream that indicates the creation time of an item.
", - "MedicalResult$StartTime": "The time, in seconds, from the beginning of the audio stream to the beginning of the result.
", - "MedicalResult$EndTime": "The time, in seconds, from the beginning of the audio stream to the end of the result.
", - "Result$StartTime": "The offset in seconds from the beginning of the audio stream to the beginning of the result.
", - "Result$EndTime": "The offset in seconds from the beginning of the audio stream to the end of the result.
" + "Entity$StartTime": "The start time, in milliseconds, of the utterance that was identified as PII.
", + "Entity$EndTime": "The end time, in milliseconds, of the utterance that was identified as PII.
", + "Item$StartTime": "The start time, in milliseconds, of the transcribed item.
", + "Item$EndTime": "The end time, in milliseconds, of the transcribed item.
", + "LanguageWithScore$Score": "The confidence score associated with the identified language code. Confidence scores are values between zero and one; larger values indicate a higher confidence in the identified language.
", + "MedicalEntity$StartTime": "The start time, in milliseconds, of the utterance that was identified as PHI.
", + "MedicalEntity$EndTime": "The end time, in milliseconds, of the utterance that was identified as PHI.
", + "MedicalItem$StartTime": "The start time, in milliseconds, of the transcribed item.
", + "MedicalItem$EndTime": "The end time, in milliseconds, of the transcribed item.
", + "MedicalResult$StartTime": "The start time, in milliseconds, of the Result.
The end time, in milliseconds, of the Result.
The start time, in milliseconds, of the Result.
The end time, in milliseconds, of the Result.
The entity identified as personally identifiable information (PII).
", + "base": "Contains entities identified as personally identifiable information (PII) in your transcription output, along with various associated attributes. Examples include category, confidence score, type, stability score, and start and end times.
", "refs": { "EntityList$member": null } @@ -121,18 +121,18 @@ "EntityList": { "base": null, "refs": { - "Alternative$Entities": "Contains the entities identified as personally identifiable information (PII) in the transcription output.
" + "Alternative$Entities": "Contains entities identified as personally identifiable information (PII) in your transcription output.
" } }, "InternalFailureException": { - "base": "A problem occurred while processing the audio. Amazon Transcribe or Amazon Transcribe Medical terminated processing. Try your request again.
", + "base": "A problem occurred while processing the audio. Amazon Transcribe terminated processing.
", "refs": { "MedicalTranscriptResultStream$InternalFailureException": null, "TranscriptResultStream$InternalFailureException": "A problem occurred while processing the audio. Amazon Transcribe terminated processing.
" } }, "Item": { - "base": "A word, phrase, or punctuation mark that is transcribed from the input audio.
", + "base": "A word, phrase, or punctuation mark in your transcription output, along with various associated attributes, such as confidence score, type, and start and end times.
", "refs": { "ItemList$member": null } @@ -140,75 +140,75 @@ "ItemList": { "base": null, "refs": { - "Alternative$Items": "One or more alternative interpretations of the input audio.
" + "Alternative$Items": "Contains words, phrases, or punctuation marks in your transcription output.
" } }, "ItemType": { "base": null, "refs": { - "Item$Type": "The type of the item. PRONUNCIATION indicates that the item is a word that was recognized in the input audio. PUNCTUATION indicates that the item was interpreted as a pause in the input audio.
The type of the item. PRONUNCIATION indicates that the item is a word that was recognized in the input audio. PUNCTUATION indicates that the item was interpreted as a pause in the input audio, such as a period to indicate the end of a sentence.
The type of item identified. Options are: PRONUNCIATION (spoken words) and PUNCTUATION.
The type of item identified. Options are: PRONUNCIATION (spoken words) and PUNCTUATION.
The language code of the language identified by Amazon Transcribe.
", - "Result$LanguageCode": "The language code of the identified language in your media stream.
", - "StartMedicalStreamTranscriptionRequest$LanguageCode": "Indicates the source language used in the input audio stream. For Amazon Transcribe Medical, this is US English (en-US).
", - "StartMedicalStreamTranscriptionResponse$LanguageCode": "The language code for the response transcript. For Amazon Transcribe Medical, this is US English (en-US).
", - "StartStreamTranscriptionRequest$LanguageCode": "The language code of the input audio stream.
", - "StartStreamTranscriptionRequest$PreferredLanguage": "Optional. From the subset of languages codes you provided for LanguageOptions, you can select one preferred language for your transcription.
You can only use this parameter if you've set IdentifyLanguage to truein your request.
The language code of the input audio stream.
", - "StartStreamTranscriptionResponse$PreferredLanguage": "The preferred language you specified in your request.
" + "LanguageWithScore$LanguageCode": "The language code of the identified language.
", + "Result$LanguageCode": "The language code that represents the language spoken in your audio stream.
", + "StartMedicalStreamTranscriptionRequest$LanguageCode": "Specify the language code that represents the language spoken in your audio.
Amazon Transcribe Medical only supports US English (en-US).
Provides the language code that you specified in your request. This must be en-US.
Specify the language code that represents the language spoken in your audio.
If you're unsure of the language spoken in your audio, consider using IdentifyLanguage to enable automatic language identification.
For a list of languages supported with Amazon Transcribe streaming, refer to the Supported languages table.
", + "StartStreamTranscriptionRequest$PreferredLanguage": "Specify a preferred language from the subset of languages codes you specified in LanguageOptions.
You can only use this parameter if you've included IdentifyLanguage and LanguageOptions in your request.
Provides the language code that you specified in your request.
", + "StartStreamTranscriptionResponse$PreferredLanguage": "Provides the preferred language that you specified in your request.
" } }, "LanguageIdentification": { "base": null, "refs": { - "Result$LanguageIdentification": "The language code of the dominant language identified in your media.
" + "Result$LanguageIdentification": "The language code of the dominant language identified in your stream.
If you enabled channel identification and each channel of your audio contains a different language, you may have more than one result.
" } }, "LanguageOptions": { "base": null, "refs": { - "StartStreamTranscriptionRequest$LanguageOptions": "An object containing a list of languages that might be present in your audio.
You must provide two or more language codes to help Amazon Transcribe identify the correct language of your media stream with the highest possible accuracy. You can only select one variant per language; for example, you can't include both en-US and en-UK in the same request.
You can only use this parameter if you've set IdentifyLanguage to truein your request.
The language codes used in the identification of your media stream's predominant language.
" + "StartStreamTranscriptionRequest$LanguageOptions": "Specify two or more language codes that represent the languages you think may be present in your media; including more than five is not recommended. If you're unsure what languages are present, do not include this parameter.
Including language options can improve the accuracy of language identification.
If you include LanguageOptions in your request, you must also include IdentifyLanguage.
For a list of languages supported with Amazon Transcribe streaming, refer to the Supported languages table.
You can only include one language dialect per language per stream. For example, you cannot include en-US and en-AU in the same request.
Provides the language codes that you specified in your request.
" } }, "LanguageWithScore": { - "base": "The language codes of the identified languages and their associated confidence scores. The confidence score is a value between zero and one; a larger value indicates a higher confidence in the identified language.
", + "base": "The language code that represents the language identified in your audio, including the associated confidence score. If you enabled channel identification in your request and each channel contained a different language, you will have more than one LanguageWithScore result.
You have exceeded the maximum number of concurrent transcription streams, are starting transcription streams too quickly, or the maximum audio length of 4 hours. Wait until a stream has finished processing, or break your audio stream into smaller chunks and try your request again.
", + "base": "Your client has exceeded one of the Amazon Transcribe limits. This is typically the audio length limit. Break your audio stream into smaller chunks and try your request again.
", "refs": { "MedicalTranscriptResultStream$LimitExceededException": null, - "TranscriptResultStream$LimitExceededException": "Your client has exceeded one of the Amazon Transcribe limits, typically the limit on audio length. Break your audio stream into smaller chunks and try your request again.
" + "TranscriptResultStream$LimitExceededException": "Your client has exceeded one of the Amazon Transcribe limits. This is typically the audio length limit. Break your audio stream into smaller chunks and try your request again.
" } }, "MediaEncoding": { "base": null, "refs": { - "StartMedicalStreamTranscriptionRequest$MediaEncoding": "The encoding used for the input audio.
", - "StartMedicalStreamTranscriptionResponse$MediaEncoding": "The encoding used for the input audio stream.
", - "StartStreamTranscriptionRequest$MediaEncoding": "The encoding used for the input audio.
", - "StartStreamTranscriptionResponse$MediaEncoding": "The encoding used for the input audio stream.
" + "StartMedicalStreamTranscriptionRequest$MediaEncoding": "Specify the encoding used for the input audio. Supported formats are:
FLAC
OPUS-encoded audio in an Ogg container
PCM (only signed 16-bit little-endian audio formats, which does not include WAV)
For more information, see Media formats.
", + "StartMedicalStreamTranscriptionResponse$MediaEncoding": "Provides the media encoding you specified in your request.
", + "StartStreamTranscriptionRequest$MediaEncoding": "Specify the encoding used for the input audio. Supported formats are:
FLAC
OPUS-encoded audio in an Ogg container
PCM (only signed 16-bit little-endian audio formats, which does not include WAV)
For more information, see Media formats.
", + "StartStreamTranscriptionResponse$MediaEncoding": "Provides the media encoding you specified in your request.
" } }, "MediaSampleRateHertz": { "base": null, "refs": { - "StartMedicalStreamTranscriptionRequest$MediaSampleRateHertz": "The sample rate of the input audio (in Hertz). Amazon Transcribe medical supports a range from 16,000 Hz to 48,000 Hz. Note that the sample rate you specify must match that of your audio.
", - "StartMedicalStreamTranscriptionResponse$MediaSampleRateHertz": "The sample rate of the input audio, in Hertz (Hz).
", - "StartStreamTranscriptionRequest$MediaSampleRateHertz": "The sample rate of the input audio (in Hertz). Low-quality audio, such as telephone audio, is typically around 8,000 Hz. High-quality audio typically ranges from 16,000 Hz to 48,000 Hz. Note that the sample rate you specify must match that of your audio.
", - "StartStreamTranscriptionResponse$MediaSampleRateHertz": "The sample rate, in Hertz (Hz), for the input audio stream.
" + "StartMedicalStreamTranscriptionRequest$MediaSampleRateHertz": "The sample rate of the input audio (in hertz). Amazon Transcribe Medical supports a range from 16,000 Hz to 48,000 Hz. Note that the sample rate you specify must match that of your audio.
", + "StartMedicalStreamTranscriptionResponse$MediaSampleRateHertz": "Provides the sample rate that you specified in your request.
", + "StartStreamTranscriptionRequest$MediaSampleRateHertz": "The sample rate of the input audio (in hertz). Low-quality audio, such as telephone audio, is typically around 8,000 Hz. High-quality audio typically ranges from 16,000 Hz to 48,000 Hz. Note that the sample rate you specify must match that of your audio.
", + "StartStreamTranscriptionResponse$MediaSampleRateHertz": "Provides the sample rate that you specified in your request.
" } }, "MedicalAlternative": { - "base": "A list of possible transcriptions for the audio.
", + "base": "A list of possible alternative transcriptions for the input audio. Each alternative may contain one or more of Items, Entities, or Transcript.
A list of possible transcriptions of the audio. Each alternative typically contains one Item that contains the result of the transcription.
A list of possible alternative transcriptions for the input audio. Each alternative may contain one or more of Items, Entities, or Transcript.
Set this field to PHI to identify personal health information in the transcription output.
If the value is PHI, indicates that you've configured your stream to identify personal health information.
Labels all personal health information (PHI) identified in your transcript.
Content identification is performed at the segment level; PHI is flagged upon complete transcription of an audio segment.
For more information, see Identifying personal health information (PHI) in a transcription.
", + "StartMedicalStreamTranscriptionResponse$ContentIdentificationType": "Shows whether content identification was enabled for your transcription.
" } }, "MedicalEntity": { - "base": "The medical entity identified as personal health information.
", + "base": "Contains entities identified as personal health information (PHI) in your transcription output, along with various associated attributes. Examples include category, confidence score, type, stability score, and start and end times.
", "refs": { "MedicalEntityList$member": null } @@ -235,11 +235,11 @@ "MedicalEntityList": { "base": null, "refs": { - "MedicalAlternative$Entities": "Contains the medical entities identified as personal health information in the transcription output.
" + "MedicalAlternative$Entities": "Contains entities identified as personal health information (PHI) in your transcription output.
" } }, "MedicalItem": { - "base": "A word, phrase, or punctuation mark that is transcribed from the input audio.
", + "base": "A word, phrase, or punctuation mark in your transcription output, along with various associated attributes, such as confidence score, type, and start and end times.
", "refs": { "MedicalItemList$member": null } @@ -247,11 +247,11 @@ "MedicalItemList": { "base": null, "refs": { - "MedicalAlternative$Items": "A list of objects that contains words and punctuation marks that represents one or more interpretations of the input audio.
" + "MedicalAlternative$Items": "Contains words, phrases, or punctuation marks in your transcription output.
" } }, "MedicalResult": { - "base": "The results of transcribing a portion of the input audio stream.
", + "base": "The Result associated with a .
Contains a set of transcription results from one or more audio segments, along with additional information per your request parameters. This can include information relating to alternative transcriptions, channel identification, partial result stabilization, language identification, and other transcription-related data.
", "refs": { "MedicalResultList$member": null } @@ -259,66 +259,66 @@ "MedicalResultList": { "base": null, "refs": { - "MedicalTranscript$Results": "MedicalResult objects that contain the results of transcribing a portion of the input audio stream. The array can be empty.
" + "MedicalTranscript$Results": "Contains a set of transcription results from one or more audio segments, along with additional information per your request parameters. This can include information relating to alternative transcriptions, channel identification, partial result stabilization, language identification, and other transcription-related data.
" } }, "MedicalTranscript": { - "base": "The medical transcript in a MedicalTranscriptEvent.
", + "base": "The MedicalTranscript associated with a .
MedicalTranscript contains Results, which contains a set of transcription results from one or more audio segments, along with additional information per your request parameters.
The transcription of the audio stream. The transcription is composed of all of the items in the results list.
" + "MedicalTranscriptEvent$Transcript": "Contains Results, which contains a set of transcription results from one or more audio segments, along with additional information per your request parameters. This can include information relating to alternative transcriptions, channel identification, partial result stabilization, language identification, and other transcription-related data.
Represents a set of transcription results from the server to the client. It contains one or more segments of the transcription.
", + "base": "The MedicalTranscriptEvent associated with a MedicalTranscriptResultStream.
Contains a set of transcription results from one or more audio segments, along with additional information per your request parameters.
", "refs": { - "MedicalTranscriptResultStream$TranscriptEvent": "A portion of the transcription of the audio stream. Events are sent periodically from Amazon Transcribe Medical to your application. The event can be a partial transcription of a section of the audio stream, or it can be the entire transcription of that portion of the audio stream.
" + "MedicalTranscriptResultStream$TranscriptEvent": "The MedicalTranscriptEvent associated with a MedicalTranscriptResultStream.
Contains a set of transcription results from one or more audio segments, along with additional information per your request parameters. This can include information relating to alternative transcriptions, channel identification, partial result stabilization, language identification, and other transcription-related data.
" } }, "MedicalTranscriptResultStream": { - "base": "Represents the transcription result stream from Amazon Transcribe Medical to your application.
", + "base": "Contains detailed information about your streaming session.
", "refs": { - "StartMedicalStreamTranscriptionResponse$TranscriptResultStream": "Represents the stream of transcription events from Amazon Transcribe Medical to your application.
" + "StartMedicalStreamTranscriptionResponse$TranscriptResultStream": "Provides detailed information about your streaming session.
" } }, "ModelName": { "base": null, "refs": { - "StartStreamTranscriptionRequest$LanguageModelName": "The name of the language model you want to use.
", - "StartStreamTranscriptionResponse$LanguageModelName": "The name of the custom language model used in the transcription.
" + "StartStreamTranscriptionRequest$LanguageModelName": "Specify the name of the custom language model that you want to use when processing your transcription. Note that language model names are case sensitive.
The language of the specified language model must match the language code you specify in your transcription request. If the languages don't match, the language model isn't applied. There are no errors or warnings associated with a language mismatch.
For more information, see Custom language models.
", + "StartStreamTranscriptionResponse$LanguageModelName": "Provides the name of the custom language model that you specified in your request.
" } }, "NumberOfChannels": { "base": null, "refs": { - "StartMedicalStreamTranscriptionRequest$NumberOfChannels": "The number of channels that are in your audio stream.
", - "StartMedicalStreamTranscriptionResponse$NumberOfChannels": "The number of channels identified in the stream.
", - "StartStreamTranscriptionRequest$NumberOfChannels": "The number of channels that are in your audio stream.
", - "StartStreamTranscriptionResponse$NumberOfChannels": "The number of channels identified in the stream.
" + "StartMedicalStreamTranscriptionRequest$NumberOfChannels": "Specify the number of channels in your audio stream. Up to two channels are supported.
", + "StartMedicalStreamTranscriptionResponse$NumberOfChannels": "Provides the number of channels that you specified in your request.
", + "StartStreamTranscriptionRequest$NumberOfChannels": "Specify the number of channels in your audio stream. Up to two channels are supported.
", + "StartStreamTranscriptionResponse$NumberOfChannels": "Provides the number of channels that you specified in your request.
" } }, "PartialResultsStability": { "base": null, "refs": { - "StartStreamTranscriptionRequest$PartialResultsStability": "You can use this field to set the stability level of the transcription results. A higher stability level means that the transcription results are less likely to change. Higher stability levels can come with lower overall transcription accuracy.
", - "StartStreamTranscriptionResponse$PartialResultsStability": "If partial results stabilization has been enabled in the stream, shows the stability level.
" + "StartStreamTranscriptionRequest$PartialResultsStability": "Specify the level of stability to use when you enable partial results stabilization (EnablePartialResultsStabilization).
Low stability provides the highest accuracy. High stability transcribes faster, but with slightly lower accuracy.
For more information, see Partial-result stabilization.
", + "StartStreamTranscriptionResponse$PartialResultsStability": "Provides the stabilization level used for your transcription.
" } }, "PiiEntityTypes": { "base": null, "refs": { - "StartStreamTranscriptionRequest$PiiEntityTypes": "List the PII entity types you want to identify or redact. In order to specify entity types, you must have either ContentIdentificationType or ContentRedactionType enabled.
PIIEntityTypes must be comma-separated; the available values are: BANK_ACCOUNT_NUMBER, BANK_ROUTING, CREDIT_DEBIT_NUMBER, CREDIT_DEBIT_CVV, CREDIT_DEBIT_EXPIRY, PIN, EMAIL, ADDRESS, NAME, PHONE, SSN, and ALL.
PiiEntityTypes is an optional parameter with a default value of ALL.
Specify which types of personally identifiable information (PII) you want to redact in your transcript. You can include as many types as you'd like, or you can select ALL.
To include PiiEntityTypes in your request, you must also include either ContentIdentificationType or ContentRedactionType.
Values must be comma-separated and can include: BANK_ACCOUNT_NUMBER, BANK_ROUTING, CREDIT_DEBIT_NUMBER, CREDIT_DEBIT_CVV, CREDIT_DEBIT_EXPIRY, PIN, EMAIL, ADDRESS, NAME, PHONE, SSN, or ALL.
Lists the PII entity types you specified in your request.
" } }, "RequestId": { "base": null, "refs": { - "StartMedicalStreamTranscriptionResponse$RequestId": "An identifier for the streaming transcription.
", - "StartStreamTranscriptionResponse$RequestId": "An identifier for the transcription.
" + "StartMedicalStreamTranscriptionResponse$RequestId": "Provides the identifier for your streaming request.
", + "StartStreamTranscriptionResponse$RequestId": "Provides the identifier for your streaming request.
" } }, "Result": { - "base": "The result of transcribing a portion of the input audio stream.
", + "base": "The Result associated with a .
Contains a set of transcription results from one or more audio segments, along with additional information per your request parameters. This can include information relating to alternative transcriptions, channel identification, partial result stabilization, language identification, and other transcription-related data.
", "refs": { "ResultList$member": null } @@ -326,36 +326,36 @@ "ResultList": { "base": null, "refs": { - "Transcript$Results": "Result objects that contain the results of transcribing a portion of the input audio stream. The array can be empty.
" + "Transcript$Results": "Contains a set of transcription results from one or more audio segments, along with additional information per your request parameters. This can include information relating to alternative transcriptions, channel identification, partial result stabilization, language identification, and other transcription-related data.
" } }, "ServiceUnavailableException": { - "base": "Service is currently unavailable. Try your request later.
", + "base": "The service is currently unavailable. Try your request later.
", "refs": { "MedicalTranscriptResultStream$ServiceUnavailableException": null, - "TranscriptResultStream$ServiceUnavailableException": "Service is currently unavailable. Try your request later.
" + "TranscriptResultStream$ServiceUnavailableException": "The service is currently unavailable. Try your request later.
" } }, "SessionId": { "base": null, "refs": { - "StartMedicalStreamTranscriptionRequest$SessionId": "Optional. An identifier for the transcription session. If you don't provide a session ID, Amazon Transcribe generates one for you and returns it in the response.
", - "StartMedicalStreamTranscriptionResponse$SessionId": "Optional. An identifier for the transcription session. If you don't provide a session ID, Amazon Transcribe generates one for you and returns it in the response.
", - "StartStreamTranscriptionRequest$SessionId": "A identifier for the transcription session. Use this parameter when you want to retry a session. If you don't provide a session ID, Amazon Transcribe will generate one for you and return it in the response.
", - "StartStreamTranscriptionResponse$SessionId": "An identifier for a specific transcription session.
" + "StartMedicalStreamTranscriptionRequest$SessionId": "Specify a name for your transcription session. If you don't include this parameter in your request, Amazon Transcribe Medical generates an ID and returns it in the response.
You can use a session ID to retry a streaming session.
", + "StartMedicalStreamTranscriptionResponse$SessionId": "Provides the identifier for your transcription session.
", + "StartStreamTranscriptionRequest$SessionId": "Specify a name for your transcription session. If you don't include this parameter in your request, Amazon Transcribe generates an ID and returns it in the response.
You can use a session ID to retry a streaming session.
", + "StartStreamTranscriptionResponse$SessionId": "Provides the identifier for your transcription session.
" } }, "Specialty": { "base": null, "refs": { - "StartMedicalStreamTranscriptionRequest$Specialty": "The medical specialty of the clinician or provider.
", - "StartMedicalStreamTranscriptionResponse$Specialty": "The specialty in the medical domain.
" + "StartMedicalStreamTranscriptionRequest$Specialty": "Specify the medical specialty contained in your audio.
", + "StartMedicalStreamTranscriptionResponse$Specialty": "Provides the medical specialty that you specified in your request.
" } }, "Stable": { "base": null, "refs": { - "Item$Stable": "If partial result stabilization has been enabled, indicates whether the word or phrase in the item is stable. If Stable is true, the result is stable.
If partial result stabilization is enabled, Stable indicates whether the specified item is stable (true) or if it may change when the segment is complete (false).
The text that was transcribed from the audio.
", + "Alternative$Transcript": "Contains transcribed text.
", "BadRequestException$Message": null, "ConflictException$Message": null, - "Entity$Category": "The category of information identified in this entity; for example, PII.
", - "Entity$Type": "The type of PII identified in this entity; for example, name or credit card number.
", - "Entity$Content": "The words in the transcription output that have been identified as a PII entity.
", + "Entity$Category": "The category of information identified. The only category is PII.
The type of PII identified. For example, NAME or CREDIT_DEBIT_NUMBER.
The word or words identified as PII.
", "InternalFailureException$Message": null, - "Item$Content": "The word or punctuation that was recognized in the input audio.
", - "Item$Speaker": "If speaker identification is enabled, shows the speakers identified in the media stream.
", + "Item$Content": "The word or punctuation that was transcribed.
", + "Item$Speaker": "If speaker partitioning is enabled, Speaker labels the speaker of the specified item.
The text that was transcribed from the audio.
", - "MedicalEntity$Category": "The type of personal health information of the medical entity.
", - "MedicalEntity$Content": "The word or words in the transcription output that have been identified as a medical entity.
", - "MedicalItem$Content": "The word or punctuation mark that was recognized in the input audio.
", - "MedicalItem$Speaker": "If speaker identification is enabled, shows the integer values that correspond to the different speakers identified in the stream. For example, if the value of Speaker in the stream is either a 0 or a 1, that indicates that Amazon Transcribe Medical has identified two speakers in the stream. The value of 0 corresponds to one speaker and the value of 1 corresponds to the other speaker.
A unique identifier for the result.
", - "MedicalResult$ChannelId": "When channel identification is enabled, Amazon Transcribe Medical transcribes the speech from each audio channel separately.
You can use ChannelId to retrieve the transcription results for a single channel in your audio stream.
A unique identifier for the result.
", - "Result$ChannelId": "When channel identification is enabled, Amazon Transcribe transcribes the speech from each audio channel separately.
You can use ChannelId to retrieve the transcription results for a single channel in your audio stream.
Contains transcribed text.
", + "MedicalEntity$Category": "The category of information identified. The only category is PHI.
The word or words identified as PHI.
", + "MedicalItem$Content": "The word or punctuation that was transcribed.
", + "MedicalItem$Speaker": "If speaker partitioning is enabled, Speaker labels the speaker of the specified item.
Provides a unique identifier for the Result.
Indicates the channel identified for the Result.
Provides a unique identifier for the Result.
Indicates the channel identified for the Result.
The transcription in a TranscriptEvent.
", + "base": "The Transcript associated with a .
Transcript contains Results, which contains a set of transcription results from one or more audio segments, along with additional information per your request parameters.
The transcription of the audio stream. The transcription is composed of all of the items in the results list.
" + "TranscriptEvent$Transcript": "Contains Results, which contains a set of transcription results from one or more audio segments, along with additional information per your request parameters. This can include information relating to alternative transcriptions, channel identification, partial result stabilization, language identification, and other transcription-related data.
Represents a set of transcription results from the server to the client. It contains one or more segments of the transcription.
", + "base": "The TranscriptEvent associated with a TranscriptResultStream.
Contains a set of transcription results from one or more audio segments, along with additional information per your request parameters.
", "refs": { - "TranscriptResultStream$TranscriptEvent": "A portion of the transcription of the audio stream. Events are sent periodically from Amazon Transcribe to your application. The event can be a partial transcription of a section of the audio stream, or it can be the entire transcription of that portion of the audio stream.
" + "TranscriptResultStream$TranscriptEvent": "Contains Transcript, which contains Results. The object contains a set of transcription results from one or more audio segments, along with additional information per your request parameters.
Represents the transcription result stream from Amazon Transcribe to your application.
", + "base": "Contains detailed information about your streaming session.
", "refs": { - "StartStreamTranscriptionResponse$TranscriptResultStream": "Represents the stream of transcription events from Amazon Transcribe to your application.
" + "StartStreamTranscriptionResponse$TranscriptResultStream": "Provides detailed information about your streaming session.
" } }, "Type": { "base": null, "refs": { - "StartMedicalStreamTranscriptionRequest$Type": "The type of input audio. Choose DICTATION for a provider dictating patient notes. Choose CONVERSATION for a dialogue between a patient and one or more medical professionanls.
The type of audio that was transcribed.
" + "StartMedicalStreamTranscriptionRequest$Type": "Specify the type of input audio. For example, choose DICTATION for a provider dictating patient notes and CONVERSATION for a dialogue between a patient and a medical professional.
Provides the type of audio you specified in your request.
" } }, "VocabularyFilterMethod": { "base": null, "refs": { - "StartStreamTranscriptionRequest$VocabularyFilterMethod": "The manner in which you use your vocabulary filter to filter words in your transcript. Remove removes filtered words from your transcription results. Mask masks filtered words with a *** in your transcription results. Tag keeps the filtered words in your transcription results and tags them. The tag appears as VocabularyFilterMatch equal to True.
The vocabulary filtering method used when processing the stream.
" + "StartStreamTranscriptionRequest$VocabularyFilterMethod": "Specify how you want your vocabulary filter applied to your transcript.
To replace words with ***, choose mask.
To delete words, choose remove.
To flag words without changing them, choose tag.
Provides the vocabulary filtering method used in your transcription.
" } }, "VocabularyFilterName": { "base": null, "refs": { - "StartStreamTranscriptionRequest$VocabularyFilterName": "The name of the vocabulary filter you want to use with your transcription.
This operation is not intended for use in conjunction with the IdentifyLanguage operation. If you're using IdentifyLanguage in your request and want to use one or more vocabulary filters with your transcription, use the VocabularyFilterNames operation instead.
The name of the vocabulary filter used when processing the stream.
" + "StartStreamTranscriptionRequest$VocabularyFilterName": "Specify the name of the custom vocabulary filter that you want to use when processing your transcription. Note that vocabulary filter names are case sensitive.
If the language of the specified custom vocabulary filter doesn't match the language identified in your media, your job fails.
This parameter is not intended for use with the IdentifyLanguage parameter. If you're including IdentifyLanguage in your request and want to use one or more vocabulary filters with your transcription, use the VocabularyFilterNames parameter instead.
For more information, see Using vocabulary filtering with unwanted words.
", + "StartStreamTranscriptionResponse$VocabularyFilterName": "Provides the name of the custom vocabulary filter that you specified in your request.
" } }, "VocabularyFilterNames": { "base": null, "refs": { - "StartStreamTranscriptionRequest$VocabularyFilterNames": "The names of the vocabulary filters you want to use with your transcription.
Note that if the vocabulary filters you specify are in languages that don't match the language identified in your media, your job fails.
This operation is only intended for use in conjunction with the IdentifyLanguage operation. If you're not using IdentifyLanguage in your request and want to use a vocabulary filter with your transcription, use the VocabularyFilterName operation instead.
The name of the vocabulary filter used when processing the stream.
" + "StartStreamTranscriptionRequest$VocabularyFilterNames": "Specify the names of the custom vocabulary filters that you want to use when processing your transcription. Note that vocabulary filter names are case sensitive.
If none of the languages of the specified custom vocabulary filters match the language identified in your media, your job fails.
This parameter is only intended for use with the IdentifyLanguage parameter. If you're not including IdentifyLanguage in your request and want to use a custom vocabulary filter with your transcription, use the VocabularyFilterName parameter instead.
For more information, see Using vocabulary filtering with unwanted words.
", + "StartStreamTranscriptionResponse$VocabularyFilterNames": "Provides the names of the custom vocabulary filters that you specified in your request.
" } }, "VocabularyName": { "base": null, "refs": { - "StartMedicalStreamTranscriptionRequest$VocabularyName": "The name of the medical custom vocabulary to use when processing the real-time stream.
", - "StartMedicalStreamTranscriptionResponse$VocabularyName": "The name of the vocabulary used when processing the stream.
", - "StartStreamTranscriptionRequest$VocabularyName": "The name of the custom vocabulary you want to use with your transcription.
This operation is not intended for use in conjunction with the IdentifyLanguage operation. If you're using IdentifyLanguage in your request and want to use one or more custom vocabularies with your transcription, use the VocabularyNames operation instead.
The name of the custom vocabulary used when processing the stream.
" + "StartMedicalStreamTranscriptionRequest$VocabularyName": "Specify the name of the custom vocabulary that you want to use when processing your transcription. Note that vocabulary names are case sensitive.
", + "StartMedicalStreamTranscriptionResponse$VocabularyName": "Provides the name of the custom vocabulary that you specified in your request.
", + "StartStreamTranscriptionRequest$VocabularyName": "Specify the name of the custom vocabulary that you want to use when processing your transcription. Note that vocabulary names are case sensitive.
If the language of the specified custom vocabulary doesn't match the language identified in your media, your job fails.
This parameter is not intended for use with the IdentifyLanguage parameter. If you're including IdentifyLanguage in your request and want to use one or more custom vocabularies with your transcription, use the VocabularyNames parameter instead.
For more information, see Custom vocabularies.
", + "StartStreamTranscriptionResponse$VocabularyName": "Provides the name of the custom vocabulary that you specified in your request.
" } }, "VocabularyNames": { "base": null, "refs": { - "StartStreamTranscriptionRequest$VocabularyNames": "The names of the custom vocabularies you want to use with your transcription.
Note that if the custom vocabularies you specify are in languages that don't match the language identified in your media, your job fails.
This operation is only intended for use in conjunction with the IdentifyLanguage operation. If you're not using IdentifyLanguage in your request and want to use a custom vocabulary with your transcription, use the VocabularyName operation instead.
The name of the custom vocabulary used when processing the stream.
" + "StartStreamTranscriptionRequest$VocabularyNames": "Specify the names of the custom vocabularies that you want to use when processing your transcription. Note that vocabulary names are case sensitive.
If none of the languages of the specified custom vocabularies match the language identified in your media, your job fails.
This parameter is only intended for use with the IdentifyLanguage parameter. If you're not including IdentifyLanguage in your request and want to use a custom vocabulary with your transcription, use the VocabularyName parameter instead.
For more information, see Custom vocabularies.
", + "StartStreamTranscriptionResponse$VocabularyNames": "Provides the names of the custom vocabularies that you specified in your request.
" } } } diff --git a/models/apis/transcribe-streaming/2017-10-26/endpoint-rule-set-1.json b/models/apis/transcribe-streaming/2017-10-26/endpoint-rule-set-1.json new file mode 100644 index 00000000000..900ac84fd89 --- /dev/null +++ b/models/apis/transcribe-streaming/2017-10-26/endpoint-rule-set-1.json @@ -0,0 +1,391 @@ +{ + "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://transcribestreaming-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": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "transcribestreaming-ca-central-1" + ] + } + ], + "endpoint": { + "url": "https://transcribestreaming-fips.ca-central-1.amazonaws.com", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "transcribestreaming-us-east-1" + ] + } + ], + "endpoint": { + "url": "https://transcribestreaming-fips.us-east-1.amazonaws.com", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "transcribestreaming-us-west-2" + ] + } + ], + "endpoint": { + "url": "https://transcribestreaming-fips.us-west-2.amazonaws.com", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "transcribestreaming-us-east-2" + ] + } + ], + "endpoint": { + "url": "https://transcribestreaming-fips.us-east-2.amazonaws.com", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://transcribestreaming-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://transcribestreaming.{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://transcribestreaming.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] +} \ No newline at end of file diff --git a/models/apis/transcribe-streaming/2017-10-26/endpoint-tests-1.json b/models/apis/transcribe-streaming/2017-10-26/endpoint-tests-1.json new file mode 100644 index 00000000000..023d2298512 --- /dev/null +++ b/models/apis/transcribe-streaming/2017-10-26/endpoint-tests-1.json @@ -0,0 +1,871 @@ +{ + "testCases": [ + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://transcribestreaming-fips.us-gov-east-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-gov-east-1", + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://transcribestreaming-fips.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-gov-east-1", + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://transcribestreaming.us-gov-east-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-gov-east-1", + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://transcribestreaming.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-gov-east-1", + "UseDualStack": false + } + }, + { + "documentation": "For region ca-central-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://transcribestreaming-fips.ca-central-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "ca-central-1", + "UseDualStack": true + } + }, + { + "documentation": "For region ca-central-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://transcribestreaming-fips.ca-central-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "ca-central-1", + "UseDualStack": false + } + }, + { + "documentation": "For region ca-central-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://transcribestreaming.ca-central-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "ca-central-1", + "UseDualStack": true + } + }, + { + "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://transcribestreaming.ca-central-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "ca-central-1", + "UseDualStack": false + } + }, + { + "documentation": "For region eu-central-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://transcribestreaming-fips.eu-central-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "eu-central-1", + "UseDualStack": true + } + }, + { + "documentation": "For region eu-central-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://transcribestreaming-fips.eu-central-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "eu-central-1", + "UseDualStack": false + } + }, + { + "documentation": "For region eu-central-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://transcribestreaming.eu-central-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "eu-central-1", + "UseDualStack": true + } + }, + { + "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://transcribestreaming.eu-central-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "eu-central-1", + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://transcribestreaming-fips.us-west-2.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-west-2", + "UseDualStack": true + } + }, + { + "documentation": "For region us-west-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://transcribestreaming-fips.us-west-2.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-west-2", + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://transcribestreaming.us-west-2.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-west-2", + "UseDualStack": true + } + }, + { + "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://transcribestreaming.us-west-2.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-west-2", + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://transcribestreaming-fips.eu-west-2.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "eu-west-2", + "UseDualStack": true + } + }, + { + "documentation": "For region eu-west-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://transcribestreaming-fips.eu-west-2.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "eu-west-2", + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://transcribestreaming.eu-west-2.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "eu-west-2", + "UseDualStack": true + } + }, + { + "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://transcribestreaming.eu-west-2.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "eu-west-2", + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://transcribestreaming-fips.eu-west-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "eu-west-1", + "UseDualStack": true + } + }, + { + "documentation": "For region eu-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://transcribestreaming-fips.eu-west-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "eu-west-1", + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://transcribestreaming.eu-west-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "eu-west-1", + "UseDualStack": true + } + }, + { + "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://transcribestreaming.eu-west-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "eu-west-1", + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://transcribestreaming-fips.ap-northeast-2.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "ap-northeast-2", + "UseDualStack": true + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://transcribestreaming-fips.ap-northeast-2.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "ap-northeast-2", + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://transcribestreaming.ap-northeast-2.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "ap-northeast-2", + "UseDualStack": true + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://transcribestreaming.ap-northeast-2.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "ap-northeast-2", + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://transcribestreaming-fips.ap-northeast-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "ap-northeast-1", + "UseDualStack": true + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://transcribestreaming-fips.ap-northeast-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "ap-northeast-1", + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://transcribestreaming.ap-northeast-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "ap-northeast-1", + "UseDualStack": true + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://transcribestreaming.ap-northeast-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "ap-northeast-1", + "UseDualStack": false + } + }, + { + "documentation": "For region sa-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://transcribestreaming-fips.sa-east-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "sa-east-1", + "UseDualStack": true + } + }, + { + "documentation": "For region sa-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://transcribestreaming-fips.sa-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "sa-east-1", + "UseDualStack": false + } + }, + { + "documentation": "For region sa-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://transcribestreaming.sa-east-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "sa-east-1", + "UseDualStack": true + } + }, + { + "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://transcribestreaming.sa-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "sa-east-1", + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://transcribestreaming-fips.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "UseFIPS": true, + "Region": "cn-north-1", + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://transcribestreaming-fips.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "UseFIPS": true, + "Region": "cn-north-1", + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://transcribestreaming.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "UseFIPS": false, + "Region": "cn-north-1", + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://transcribestreaming.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "UseFIPS": false, + "Region": "cn-north-1", + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://transcribestreaming-fips.us-gov-west-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-gov-west-1", + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://transcribestreaming-fips.us-gov-west-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-gov-west-1", + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://transcribestreaming.us-gov-west-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-gov-west-1", + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://transcribestreaming.us-gov-west-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-gov-west-1", + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://transcribestreaming-fips.ap-southeast-2.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "ap-southeast-2", + "UseDualStack": true + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://transcribestreaming-fips.ap-southeast-2.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "ap-southeast-2", + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://transcribestreaming.ap-southeast-2.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "ap-southeast-2", + "UseDualStack": true + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://transcribestreaming.ap-southeast-2.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "ap-southeast-2", + "UseDualStack": false + } + }, + { + "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": { + "UseFIPS": true, + "Region": "us-iso-east-1", + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://transcribestreaming-fips.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-iso-east-1", + "UseDualStack": false + } + }, + { + "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": { + "UseFIPS": false, + "Region": "us-iso-east-1", + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://transcribestreaming.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-iso-east-1", + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://transcribestreaming-fips.us-east-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-east-1", + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://transcribestreaming-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-east-1", + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://transcribestreaming.us-east-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-east-1", + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://transcribestreaming.us-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-east-1", + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://transcribestreaming-fips.us-east-2.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-east-2", + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://transcribestreaming-fips.us-east-2.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-east-2", + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://transcribestreaming.us-east-2.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-east-2", + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://transcribestreaming.us-east-2.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-east-2", + "UseDualStack": false + } + }, + { + "documentation": "For region cn-northwest-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://transcribestreaming-fips.cn-northwest-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "UseFIPS": true, + "Region": "cn-northwest-1", + "UseDualStack": true + } + }, + { + "documentation": "For region cn-northwest-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://transcribestreaming-fips.cn-northwest-1.amazonaws.com.cn" + } + }, + "params": { + "UseFIPS": true, + "Region": "cn-northwest-1", + "UseDualStack": false + } + }, + { + "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://transcribestreaming.cn-northwest-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "UseFIPS": false, + "Region": "cn-northwest-1", + "UseDualStack": true + } + }, + { + "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://transcribestreaming.cn-northwest-1.amazonaws.com.cn" + } + }, + "params": { + "UseFIPS": false, + "Region": "cn-northwest-1", + "UseDualStack": false + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-east-1", + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips enabled and dualstack disabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "UseFIPS": true, + "Region": "us-east-1", + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "params": { + "UseFIPS": false, + "Region": "us-east-1", + "UseDualStack": true, + "Endpoint": "https://example.com" + } + } + ], + "version": "1.0" +} \ No newline at end of file diff --git a/service/connect/api.go b/service/connect/api.go index fb0269a978e..462ef74b65a 100644 --- a/service/connect/api.go +++ b/service/connect/api.go @@ -19440,6 +19440,8 @@ type ClaimPhoneNumberInput struct { // of the request. If not provided, the Amazon Web Services SDK populates this // field. For more information about idempotency, see Making retries safe with // idempotent APIs (https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/). + // + // Pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ ClientToken *string `type:"string" idempotencyToken:"true"` // The phone number you want to claim. Phone numbers are formatted [+] [country @@ -28185,6 +28187,15 @@ type GetFederationTokenOutput struct { // The credentials to use for federation. Credentials *Credentials `type:"structure"` + + // The URL to sign into the user's instance. + SignInUrl *string `type:"string"` + + // The Amazon Resource Name (ARN) of the user. + UserArn *string `type:"string"` + + // The identifier for the user. + UserId *string `min:"1" type:"string"` } // String returns the string representation. @@ -28211,6 +28222,24 @@ func (s *GetFederationTokenOutput) SetCredentials(v *Credentials) *GetFederation return s } +// SetSignInUrl sets the SignInUrl field's value. +func (s *GetFederationTokenOutput) SetSignInUrl(v string) *GetFederationTokenOutput { + s.SignInUrl = &v + return s +} + +// SetUserArn sets the UserArn field's value. +func (s *GetFederationTokenOutput) SetUserArn(v string) *GetFederationTokenOutput { + s.UserArn = &v + return s +} + +// SetUserId sets the UserId field's value. +func (s *GetFederationTokenOutput) SetUserId(v string) *GetFederationTokenOutput { + s.UserId = &v + return s +} + type GetMetricDataInput struct { _ struct{} `type:"structure"` @@ -36707,7 +36736,8 @@ type ReplicateInstanceInput struct { ClientToken *string `type:"string" idempotencyToken:"true"` // The identifier of the Amazon Connect instance. You can find the instanceId - // in the ARN of the instance. + // in the ARN of the instance. You can provide the InstanceId, or the entire + // ARN. // // InstanceId is a required field InstanceId *string `location:"uri" locationName:"InstanceId" min:"1" type:"string" required:"true"` diff --git a/service/connectcases/api.go b/service/connectcases/api.go index 0d29ff2ff91..967483ce7f0 100644 --- a/service/connectcases/api.go +++ b/service/connectcases/api.go @@ -780,10 +780,12 @@ func (c *ConnectCases) CreateTemplateRequest(input *CreateTemplateInput) (req *r // CreateTemplate API operation for Amazon Connect Cases. // // Creates a template in the Cases domain. This template is used to define the -// case object model (that is, define what data can be captured on cases) in -// a Cases domain. A template must have a unique name within a domain, and it -// must reference existing field IDs and layout IDs. Additionally, multiple -// fields with same IDs are not allowed within the same Template. +// case object model (that is, to define what data can be captured on cases) +// in a Cases domain. A template must have a unique name within a domain, and +// it must reference existing field IDs and layout IDs. Additionally, multiple +// fields with same IDs are not allowed within the same Template. A template +// can be either Active or Inactive, as indicated by its status. Inactive templates +// cannot be used to create cases. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -3245,6 +3247,11 @@ func (c *ConnectCases) UpdateLayoutRequest(input *UpdateLayoutInput) (req *reque // a service resource associated with the request. Resolve the conflict before // retrying this request. See the accompanying error message for details. // +// - ServiceQuotaExceededException +// The service quota has been exceeded. For a list of service quotas, see Amazon +// Connect Service Quotas (https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html) +// in the Amazon Connect Administrator Guide. +// // See also, https://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/UpdateLayout func (c *ConnectCases) UpdateLayout(input *UpdateLayoutInput) (*UpdateLayoutOutput, error) { req, out := c.UpdateLayoutRequest(input) @@ -3312,10 +3319,10 @@ func (c *ConnectCases) UpdateTemplateRequest(input *UpdateTemplateInput) (req *r // UpdateTemplate API operation for Amazon Connect Cases. // // Updates the attributes of an existing template. The template attributes that -// can be modified include name, description, layouts, and requiredFields. At -// least one of these attributes must not be null. If a null value is provided -// for a given attribute, that attribute is ignored and its current value is -// preserved. +// can be modified include name, description, layoutConfiguration, requiredFields, +// and status. At least one of these attributes must not be null. If a null +// value is provided for a given attribute, that attribute is ignored and its +// current value is preserved. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -4228,7 +4235,9 @@ type CreateCaseInput struct { _ struct{} `type:"structure"` // A unique, case-sensitive identifier that you provide to ensure the idempotency - // of the request. + // of the request. If not provided, the Amazon Web Services SDK populates this + // field. For more information about idempotency, see Making retries safe with + // idempotent APIs (https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/). ClientToken *string `locationName:"clientToken" type:"string" idempotencyToken:"true"` // The unique identifier of the Cases domain. @@ -4903,6 +4912,9 @@ type CreateTemplateInput struct { // A list of fields that must contain a value for a case to be successfully // created with this template. RequiredFields []*RequiredField `locationName:"requiredFields" type:"list"` + + // The status of the template. + Status *string `locationName:"status" type:"string" enum:"TemplateStatus"` } // String returns the string representation. @@ -4990,6 +5002,12 @@ func (s *CreateTemplateInput) SetRequiredFields(v []*RequiredField) *CreateTempl return s } +// SetStatus sets the Status field's value. +func (s *CreateTemplateInput) SetStatus(v string) *CreateTemplateInput { + s.Status = &v + return s +} + type CreateTemplateOutput struct { _ struct{} `type:"structure"` @@ -6593,6 +6611,11 @@ type GetTemplateOutput struct { // created with this template. RequiredFields []*RequiredField `locationName:"requiredFields" type:"list"` + // The status of the template. + // + // Status is a required field + Status *string `locationName:"status" type:"string" required:"true" enum:"TemplateStatus"` + // 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. Tags map[string]*string `locationName:"tags" type:"map"` @@ -6650,6 +6673,12 @@ func (s *GetTemplateOutput) SetRequiredFields(v []*RequiredField) *GetTemplateOu return s } +// SetStatus sets the Status field's value. +func (s *GetTemplateOutput) SetStatus(v string) *GetTemplateOutput { + s.Status = &v + return s +} + // SetTags sets the Tags field's value. func (s *GetTemplateOutput) SetTags(v map[string]*string) *GetTemplateOutput { s.Tags = v @@ -7629,6 +7658,9 @@ type ListTemplatesInput struct { // The token for the next set of results. Use the value returned in the previous // response in the next request to retrieve the next set of results. NextToken *string `location:"querystring" locationName:"nextToken" type:"string"` + + // A list of status values to filter on. + Status []*string `location:"querystring" locationName:"status" min:"1" type:"list" enum:"TemplateStatus"` } // String returns the string representation. @@ -7661,6 +7693,9 @@ func (s *ListTemplatesInput) Validate() error { if s.MaxResults != nil && *s.MaxResults < 1 { invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) } + if s.Status != nil && len(s.Status) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Status", 1)) + } if invalidParams.Len() > 0 { return invalidParams @@ -7686,6 +7721,12 @@ func (s *ListTemplatesInput) SetNextToken(v string) *ListTemplatesInput { return s } +// SetStatus sets the Status field's value. +func (s *ListTemplatesInput) SetStatus(v []*string) *ListTemplatesInput { + s.Status = v + return s +} + type ListTemplatesOutput struct { _ struct{} `type:"structure"` @@ -8894,6 +8935,11 @@ type TemplateSummary struct { // Name is a required field Name *string `locationName:"name" min:"1" type:"string" required:"true"` + // The status of the template. + // + // Status is a required field + Status *string `locationName:"status" type:"string" required:"true" enum:"TemplateStatus"` + // The Amazon Resource Name (ARN) of the template. // // TemplateArn is a required field @@ -8929,6 +8975,12 @@ func (s *TemplateSummary) SetName(v string) *TemplateSummary { return s } +// SetStatus sets the Status field's value. +func (s *TemplateSummary) SetStatus(v string) *TemplateSummary { + s.Status = &v + return s +} + // SetTemplateArn sets the TemplateArn field's value. func (s *TemplateSummary) SetTemplateArn(v string) *TemplateSummary { s.TemplateArn = &v @@ -9448,6 +9500,9 @@ type UpdateTemplateInput struct { // created with this template. RequiredFields []*RequiredField `locationName:"requiredFields" type:"list"` + // The status of the template. + Status *string `locationName:"status" type:"string" enum:"TemplateStatus"` + // A unique identifier for the template. // // TemplateId is a required field @@ -9542,6 +9597,12 @@ func (s *UpdateTemplateInput) SetRequiredFields(v []*RequiredField) *UpdateTempl return s } +// SetStatus sets the Status field's value. +func (s *UpdateTemplateInput) SetStatus(v string) *UpdateTemplateInput { + s.Status = &v + return s +} + // SetTemplateId sets the TemplateId field's value. func (s *UpdateTemplateInput) SetTemplateId(v string) *UpdateTemplateInput { s.TemplateId = &v @@ -9741,3 +9802,20 @@ func RelatedItemType_Values() []string { RelatedItemTypeComment, } } + +// Status of a template +const ( + // TemplateStatusActive is a TemplateStatus enum value + TemplateStatusActive = "Active" + + // TemplateStatusInactive is a TemplateStatus enum value + TemplateStatusInactive = "Inactive" +) + +// TemplateStatus_Values returns all elements of the TemplateStatus enum +func TemplateStatus_Values() []string { + return []string{ + TemplateStatusActive, + TemplateStatusInactive, + } +} diff --git a/service/ec2/api.go b/service/ec2/api.go index ea6f41284fe..18a277bd516 100644 --- a/service/ec2/api.go +++ b/service/ec2/api.go @@ -167346,6 +167346,9 @@ const ( // ArchitectureTypeX8664Mac is a ArchitectureType enum value ArchitectureTypeX8664Mac = "x86_64_mac" + + // ArchitectureTypeArm64Mac is a ArchitectureType enum value + ArchitectureTypeArm64Mac = "arm64_mac" ) // ArchitectureType_Values returns all elements of the ArchitectureType enum @@ -167355,6 +167358,7 @@ func ArchitectureType_Values() []string { ArchitectureTypeX8664, ArchitectureTypeArm64, ArchitectureTypeX8664Mac, + ArchitectureTypeArm64Mac, } } @@ -167370,6 +167374,9 @@ const ( // ArchitectureValuesX8664Mac is a ArchitectureValues enum value ArchitectureValuesX8664Mac = "x86_64_mac" + + // ArchitectureValuesArm64Mac is a ArchitectureValues enum value + ArchitectureValuesArm64Mac = "arm64_mac" ) // ArchitectureValues_Values returns all elements of the ArchitectureValues enum @@ -167379,6 +167386,7 @@ func ArchitectureValues_Values() []string { ArchitectureValuesX8664, ArchitectureValuesArm64, ArchitectureValuesX8664Mac, + ArchitectureValuesArm64Mac, } } @@ -171449,6 +171457,18 @@ const ( // InstanceTypeU3tb156xlarge is a InstanceType enum value InstanceTypeU3tb156xlarge = "u-3tb1.56xlarge" + + // InstanceTypeU18tb1112xlarge is a InstanceType enum value + InstanceTypeU18tb1112xlarge = "u-18tb1.112xlarge" + + // InstanceTypeU24tb1112xlarge is a InstanceType enum value + InstanceTypeU24tb1112xlarge = "u-24tb1.112xlarge" + + // InstanceTypeTrn12xlarge is a InstanceType enum value + InstanceTypeTrn12xlarge = "trn1.2xlarge" + + // InstanceTypeTrn132xlarge is a InstanceType enum value + InstanceTypeTrn132xlarge = "trn1.32xlarge" ) // InstanceType_Values returns all elements of the InstanceType enum @@ -172023,6 +172043,10 @@ func InstanceType_Values() []string { InstanceTypeR6aMetal, InstanceTypeP4de24xlarge, InstanceTypeU3tb156xlarge, + InstanceTypeU18tb1112xlarge, + InstanceTypeU24tb1112xlarge, + InstanceTypeTrn12xlarge, + InstanceTypeTrn132xlarge, } } diff --git a/service/groundstation/api.go b/service/groundstation/api.go index c4f551606c6..fb06cce9b3a 100644 --- a/service/groundstation/api.go +++ b/service/groundstation/api.go @@ -280,6 +280,91 @@ func (c *GroundStation) CreateDataflowEndpointGroupWithContext(ctx aws.Context, return out, req.Send() } +const opCreateEphemeris = "CreateEphemeris" + +// CreateEphemerisRequest generates a "aws/request.Request" representing the +// client's request for the CreateEphemeris operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See CreateEphemeris for more information on using the CreateEphemeris +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// // Example sending a request using the CreateEphemerisRequest method. +// req, resp := client.CreateEphemerisRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/CreateEphemeris +func (c *GroundStation) CreateEphemerisRequest(input *CreateEphemerisInput) (req *request.Request, output *CreateEphemerisOutput) { + op := &request.Operation{ + Name: opCreateEphemeris, + HTTPMethod: "POST", + HTTPPath: "/ephemeris", + } + + if input == nil { + input = &CreateEphemerisInput{} + } + + output = &CreateEphemerisOutput{} + req = c.newRequest(op, input, output) + return +} + +// CreateEphemeris API operation for AWS Ground Station. +// +// Creates an Ephemeris with the specified EphemerisData. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Ground Station's +// API operation CreateEphemeris for usage and error information. +// +// Returned Error Types: +// +// - InvalidParameterException +// One or more parameters are not valid. +// +// - DependencyException +// Dependency encountered an error. +// +// - ResourceNotFoundException +// Resource was not found. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/CreateEphemeris +func (c *GroundStation) CreateEphemeris(input *CreateEphemerisInput) (*CreateEphemerisOutput, error) { + req, out := c.CreateEphemerisRequest(input) + return out, req.Send() +} + +// CreateEphemerisWithContext is the same as CreateEphemeris with the addition of +// the ability to pass a context and additional request options. +// +// See CreateEphemeris for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *GroundStation) CreateEphemerisWithContext(ctx aws.Context, input *CreateEphemerisInput, opts ...request.Option) (*CreateEphemerisOutput, error) { + req, out := c.CreateEphemerisRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opCreateMissionProfile = "CreateMissionProfile" // CreateMissionProfileRequest generates a "aws/request.Request" representing the @@ -538,6 +623,91 @@ func (c *GroundStation) DeleteDataflowEndpointGroupWithContext(ctx aws.Context, return out, req.Send() } +const opDeleteEphemeris = "DeleteEphemeris" + +// DeleteEphemerisRequest generates a "aws/request.Request" representing the +// client's request for the DeleteEphemeris operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See DeleteEphemeris for more information on using the DeleteEphemeris +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// // Example sending a request using the DeleteEphemerisRequest method. +// req, resp := client.DeleteEphemerisRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/DeleteEphemeris +func (c *GroundStation) DeleteEphemerisRequest(input *DeleteEphemerisInput) (req *request.Request, output *DeleteEphemerisOutput) { + op := &request.Operation{ + Name: opDeleteEphemeris, + HTTPMethod: "DELETE", + HTTPPath: "/ephemeris/{ephemerisId}", + } + + if input == nil { + input = &DeleteEphemerisInput{} + } + + output = &DeleteEphemerisOutput{} + req = c.newRequest(op, input, output) + return +} + +// DeleteEphemeris API operation for AWS Ground Station. +// +// # Deletes an ephemeris +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Ground Station's +// API operation DeleteEphemeris for usage and error information. +// +// Returned Error Types: +// +// - InvalidParameterException +// One or more parameters are not valid. +// +// - DependencyException +// Dependency encountered an error. +// +// - ResourceNotFoundException +// Resource was not found. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/DeleteEphemeris +func (c *GroundStation) DeleteEphemeris(input *DeleteEphemerisInput) (*DeleteEphemerisOutput, error) { + req, out := c.DeleteEphemerisRequest(input) + return out, req.Send() +} + +// DeleteEphemerisWithContext is the same as DeleteEphemeris with the addition of +// the ability to pass a context and additional request options. +// +// See DeleteEphemeris for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *GroundStation) DeleteEphemerisWithContext(ctx aws.Context, input *DeleteEphemerisInput, opts ...request.Option) (*DeleteEphemerisOutput, error) { + req, out := c.DeleteEphemerisRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opDeleteMissionProfile = "DeleteMissionProfile" // DeleteMissionProfileRequest generates a "aws/request.Request" representing the @@ -708,6 +878,91 @@ func (c *GroundStation) DescribeContactWithContext(ctx aws.Context, input *Descr return out, req.Send() } +const opDescribeEphemeris = "DescribeEphemeris" + +// DescribeEphemerisRequest generates a "aws/request.Request" representing the +// client's request for the DescribeEphemeris operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See DescribeEphemeris for more information on using the DescribeEphemeris +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// // Example sending a request using the DescribeEphemerisRequest method. +// req, resp := client.DescribeEphemerisRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/DescribeEphemeris +func (c *GroundStation) DescribeEphemerisRequest(input *DescribeEphemerisInput) (req *request.Request, output *DescribeEphemerisOutput) { + op := &request.Operation{ + Name: opDescribeEphemeris, + HTTPMethod: "GET", + HTTPPath: "/ephemeris/{ephemerisId}", + } + + if input == nil { + input = &DescribeEphemerisInput{} + } + + output = &DescribeEphemerisOutput{} + req = c.newRequest(op, input, output) + return +} + +// DescribeEphemeris API operation for AWS Ground Station. +// +// Describes an existing ephemeris. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Ground Station's +// API operation DescribeEphemeris for usage and error information. +// +// Returned Error Types: +// +// - InvalidParameterException +// One or more parameters are not valid. +// +// - DependencyException +// Dependency encountered an error. +// +// - ResourceNotFoundException +// Resource was not found. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/DescribeEphemeris +func (c *GroundStation) DescribeEphemeris(input *DescribeEphemerisInput) (*DescribeEphemerisOutput, error) { + req, out := c.DescribeEphemerisRequest(input) + return out, req.Send() +} + +// DescribeEphemerisWithContext is the same as DescribeEphemeris with the addition of +// the ability to pass a context and additional request options. +// +// See DescribeEphemeris for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *GroundStation) DescribeEphemerisWithContext(ctx aws.Context, input *DescribeEphemerisInput, opts ...request.Option) (*DescribeEphemerisOutput, error) { + req, out := c.DescribeEphemerisRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opGetConfig = "GetConfig" // GetConfigRequest generates a "aws/request.Request" representing the @@ -1564,36 +1819,36 @@ func (c *GroundStation) ListDataflowEndpointGroupsPagesWithContext(ctx aws.Conte return p.Err() } -const opListGroundStations = "ListGroundStations" +const opListEphemerides = "ListEphemerides" -// ListGroundStationsRequest generates a "aws/request.Request" representing the -// client's request for the ListGroundStations operation. The "output" return +// ListEphemeridesRequest generates a "aws/request.Request" representing the +// client's request for the ListEphemerides operation. The "output" return // value will be populated with the request's response once the request completes // successfully. // // Use "Send" method on the returned Request to send the API call to the service. // the "output" return value is not valid until after Send returns without error. // -// See ListGroundStations for more information on using the ListGroundStations +// See ListEphemerides for more information on using the ListEphemerides // API call, and error handling. // // This method is useful when you want to inject custom logic or configuration // into the SDK's request lifecycle. Such as custom headers, or retry logic. // -// // Example sending a request using the ListGroundStationsRequest method. -// req, resp := client.ListGroundStationsRequest(params) +// // Example sending a request using the ListEphemeridesRequest method. +// req, resp := client.ListEphemeridesRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/ListGroundStations -func (c *GroundStation) ListGroundStationsRequest(input *ListGroundStationsInput) (req *request.Request, output *ListGroundStationsOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/ListEphemerides +func (c *GroundStation) ListEphemeridesRequest(input *ListEphemeridesInput) (req *request.Request, output *ListEphemeridesOutput) { op := &request.Operation{ - Name: opListGroundStations, - HTTPMethod: "GET", - HTTPPath: "/groundstation", + Name: opListEphemerides, + HTTPMethod: "POST", + HTTPPath: "/ephemerides", Paginator: &request.Paginator{ InputTokens: []string{"nextToken"}, OutputTokens: []string{"nextToken"}, @@ -1603,24 +1858,24 @@ func (c *GroundStation) ListGroundStationsRequest(input *ListGroundStationsInput } if input == nil { - input = &ListGroundStationsInput{} + input = &ListEphemeridesInput{} } - output = &ListGroundStationsOutput{} + output = &ListEphemeridesOutput{} req = c.newRequest(op, input, output) return } -// ListGroundStations API operation for AWS Ground Station. +// ListEphemerides API operation for AWS Ground Station. // -// Returns a list of ground stations. +// List existing ephemerides. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. // // See the AWS API reference guide for AWS Ground Station's -// API operation ListGroundStations for usage and error information. +// API operation ListEphemerides for usage and error information. // // Returned Error Types: // @@ -1633,64 +1888,64 @@ func (c *GroundStation) ListGroundStationsRequest(input *ListGroundStationsInput // - ResourceNotFoundException // Resource was not found. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/ListGroundStations -func (c *GroundStation) ListGroundStations(input *ListGroundStationsInput) (*ListGroundStationsOutput, error) { - req, out := c.ListGroundStationsRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/ListEphemerides +func (c *GroundStation) ListEphemerides(input *ListEphemeridesInput) (*ListEphemeridesOutput, error) { + req, out := c.ListEphemeridesRequest(input) return out, req.Send() } -// ListGroundStationsWithContext is the same as ListGroundStations with the addition of +// ListEphemeridesWithContext is the same as ListEphemerides with the addition of // the ability to pass a context and additional request options. // -// See ListGroundStations for details on how to use this API operation. +// See ListEphemerides for details on how to use this API operation. // // The context must be non-nil and will be used for request cancellation. If // the context is nil a panic will occur. In the future the SDK may create // sub-contexts for http.Requests. See https://golang.org/pkg/context/ // for more information on using Contexts. -func (c *GroundStation) ListGroundStationsWithContext(ctx aws.Context, input *ListGroundStationsInput, opts ...request.Option) (*ListGroundStationsOutput, error) { - req, out := c.ListGroundStationsRequest(input) +func (c *GroundStation) ListEphemeridesWithContext(ctx aws.Context, input *ListEphemeridesInput, opts ...request.Option) (*ListEphemeridesOutput, error) { + req, out := c.ListEphemeridesRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -// ListGroundStationsPages iterates over the pages of a ListGroundStations operation, +// ListEphemeridesPages iterates over the pages of a ListEphemerides operation, // calling the "fn" function with the response data for each page. To stop // iterating, return false from the fn function. // -// See ListGroundStations method for more information on how to use this operation. +// See ListEphemerides method for more information on how to use this operation. // // Note: This operation can generate multiple requests to a service. // -// // Example iterating over at most 3 pages of a ListGroundStations operation. +// // Example iterating over at most 3 pages of a ListEphemerides operation. // pageNum := 0 -// err := client.ListGroundStationsPages(params, -// func(page *groundstation.ListGroundStationsOutput, lastPage bool) bool { +// err := client.ListEphemeridesPages(params, +// func(page *groundstation.ListEphemeridesOutput, lastPage bool) bool { // pageNum++ // fmt.Println(page) // return pageNum <= 3 // }) -func (c *GroundStation) ListGroundStationsPages(input *ListGroundStationsInput, fn func(*ListGroundStationsOutput, bool) bool) error { - return c.ListGroundStationsPagesWithContext(aws.BackgroundContext(), input, fn) +func (c *GroundStation) ListEphemeridesPages(input *ListEphemeridesInput, fn func(*ListEphemeridesOutput, bool) bool) error { + return c.ListEphemeridesPagesWithContext(aws.BackgroundContext(), input, fn) } -// ListGroundStationsPagesWithContext same as ListGroundStationsPages except +// ListEphemeridesPagesWithContext same as ListEphemeridesPages except // it takes a Context and allows setting request options on the pages. // // The context must be non-nil and will be used for request cancellation. If // the context is nil a panic will occur. In the future the SDK may create // sub-contexts for http.Requests. See https://golang.org/pkg/context/ // for more information on using Contexts. -func (c *GroundStation) ListGroundStationsPagesWithContext(ctx aws.Context, input *ListGroundStationsInput, fn func(*ListGroundStationsOutput, bool) bool, opts ...request.Option) error { +func (c *GroundStation) ListEphemeridesPagesWithContext(ctx aws.Context, input *ListEphemeridesInput, fn func(*ListEphemeridesOutput, bool) bool, opts ...request.Option) error { p := request.Pagination{ NewRequest: func() (*request.Request, error) { - var inCpy *ListGroundStationsInput + var inCpy *ListEphemeridesInput if input != nil { tmp := *input inCpy = &tmp } - req, _ := c.ListGroundStationsRequest(inCpy) + req, _ := c.ListEphemeridesRequest(inCpy) req.SetContext(ctx) req.ApplyOptions(opts...) return req, nil @@ -1698,7 +1953,7 @@ func (c *GroundStation) ListGroundStationsPagesWithContext(ctx aws.Context, inpu } for p.Next() { - if !fn(p.Page().(*ListGroundStationsOutput), !p.HasNextPage()) { + if !fn(p.Page().(*ListEphemeridesOutput), !p.HasNextPage()) { break } } @@ -1706,36 +1961,36 @@ func (c *GroundStation) ListGroundStationsPagesWithContext(ctx aws.Context, inpu return p.Err() } -const opListMissionProfiles = "ListMissionProfiles" +const opListGroundStations = "ListGroundStations" -// ListMissionProfilesRequest generates a "aws/request.Request" representing the -// client's request for the ListMissionProfiles operation. The "output" return +// ListGroundStationsRequest generates a "aws/request.Request" representing the +// client's request for the ListGroundStations operation. The "output" return // value will be populated with the request's response once the request completes // successfully. // // Use "Send" method on the returned Request to send the API call to the service. // the "output" return value is not valid until after Send returns without error. // -// See ListMissionProfiles for more information on using the ListMissionProfiles +// See ListGroundStations for more information on using the ListGroundStations // API call, and error handling. // // This method is useful when you want to inject custom logic or configuration // into the SDK's request lifecycle. Such as custom headers, or retry logic. // -// // Example sending a request using the ListMissionProfilesRequest method. -// req, resp := client.ListMissionProfilesRequest(params) +// // Example sending a request using the ListGroundStationsRequest method. +// req, resp := client.ListGroundStationsRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/ListMissionProfiles -func (c *GroundStation) ListMissionProfilesRequest(input *ListMissionProfilesInput) (req *request.Request, output *ListMissionProfilesOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/ListGroundStations +func (c *GroundStation) ListGroundStationsRequest(input *ListGroundStationsInput) (req *request.Request, output *ListGroundStationsOutput) { op := &request.Operation{ - Name: opListMissionProfiles, + Name: opListGroundStations, HTTPMethod: "GET", - HTTPPath: "/missionprofile", + HTTPPath: "/groundstation", Paginator: &request.Paginator{ InputTokens: []string{"nextToken"}, OutputTokens: []string{"nextToken"}, @@ -1745,24 +2000,24 @@ func (c *GroundStation) ListMissionProfilesRequest(input *ListMissionProfilesInp } if input == nil { - input = &ListMissionProfilesInput{} + input = &ListGroundStationsInput{} } - output = &ListMissionProfilesOutput{} + output = &ListGroundStationsOutput{} req = c.newRequest(op, input, output) return } -// ListMissionProfiles API operation for AWS Ground Station. +// ListGroundStations API operation for AWS Ground Station. // -// Returns a list of mission profiles. +// Returns a list of ground stations. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. // // See the AWS API reference guide for AWS Ground Station's -// API operation ListMissionProfiles for usage and error information. +// API operation ListGroundStations for usage and error information. // // Returned Error Types: // @@ -1775,7 +2030,149 @@ func (c *GroundStation) ListMissionProfilesRequest(input *ListMissionProfilesInp // - ResourceNotFoundException // Resource was not found. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/ListMissionProfiles +// See also, https://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/ListGroundStations +func (c *GroundStation) ListGroundStations(input *ListGroundStationsInput) (*ListGroundStationsOutput, error) { + req, out := c.ListGroundStationsRequest(input) + return out, req.Send() +} + +// ListGroundStationsWithContext is the same as ListGroundStations with the addition of +// the ability to pass a context and additional request options. +// +// See ListGroundStations for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *GroundStation) ListGroundStationsWithContext(ctx aws.Context, input *ListGroundStationsInput, opts ...request.Option) (*ListGroundStationsOutput, error) { + req, out := c.ListGroundStationsRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// ListGroundStationsPages iterates over the pages of a ListGroundStations operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See ListGroundStations method for more information on how to use this operation. +// +// Note: This operation can generate multiple requests to a service. +// +// // Example iterating over at most 3 pages of a ListGroundStations operation. +// pageNum := 0 +// err := client.ListGroundStationsPages(params, +// func(page *groundstation.ListGroundStationsOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +func (c *GroundStation) ListGroundStationsPages(input *ListGroundStationsInput, fn func(*ListGroundStationsOutput, bool) bool) error { + return c.ListGroundStationsPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// ListGroundStationsPagesWithContext same as ListGroundStationsPages except +// it takes a Context and allows setting request options on the pages. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *GroundStation) ListGroundStationsPagesWithContext(ctx aws.Context, input *ListGroundStationsInput, fn func(*ListGroundStationsOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *ListGroundStationsInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.ListGroundStationsRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*ListGroundStationsOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + +const opListMissionProfiles = "ListMissionProfiles" + +// ListMissionProfilesRequest generates a "aws/request.Request" representing the +// client's request for the ListMissionProfiles operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See ListMissionProfiles for more information on using the ListMissionProfiles +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// // Example sending a request using the ListMissionProfilesRequest method. +// req, resp := client.ListMissionProfilesRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/ListMissionProfiles +func (c *GroundStation) ListMissionProfilesRequest(input *ListMissionProfilesInput) (req *request.Request, output *ListMissionProfilesOutput) { + op := &request.Operation{ + Name: opListMissionProfiles, + HTTPMethod: "GET", + HTTPPath: "/missionprofile", + Paginator: &request.Paginator{ + InputTokens: []string{"nextToken"}, + OutputTokens: []string{"nextToken"}, + LimitToken: "maxResults", + TruncationToken: "", + }, + } + + if input == nil { + input = &ListMissionProfilesInput{} + } + + output = &ListMissionProfilesOutput{} + req = c.newRequest(op, input, output) + return +} + +// ListMissionProfiles API operation for AWS Ground Station. +// +// Returns a list of mission profiles. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Ground Station's +// API operation ListMissionProfiles for usage and error information. +// +// Returned Error Types: +// +// - InvalidParameterException +// One or more parameters are not valid. +// +// - DependencyException +// Dependency encountered an error. +// +// - ResourceNotFoundException +// Resource was not found. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/ListMissionProfiles func (c *GroundStation) ListMissionProfiles(input *ListMissionProfilesInput) (*ListMissionProfilesOutput, error) { req, out := c.ListMissionProfilesRequest(input) return out, req.Send() @@ -2420,6 +2817,91 @@ func (c *GroundStation) UpdateConfigWithContext(ctx aws.Context, input *UpdateCo return out, req.Send() } +const opUpdateEphemeris = "UpdateEphemeris" + +// UpdateEphemerisRequest generates a "aws/request.Request" representing the +// client's request for the UpdateEphemeris operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See UpdateEphemeris for more information on using the UpdateEphemeris +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// // Example sending a request using the UpdateEphemerisRequest method. +// req, resp := client.UpdateEphemerisRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/UpdateEphemeris +func (c *GroundStation) UpdateEphemerisRequest(input *UpdateEphemerisInput) (req *request.Request, output *UpdateEphemerisOutput) { + op := &request.Operation{ + Name: opUpdateEphemeris, + HTTPMethod: "PUT", + HTTPPath: "/ephemeris/{ephemerisId}", + } + + if input == nil { + input = &UpdateEphemerisInput{} + } + + output = &UpdateEphemerisOutput{} + req = c.newRequest(op, input, output) + return +} + +// UpdateEphemeris API operation for AWS Ground Station. +// +// # Updates an existing ephemeris +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Ground Station's +// API operation UpdateEphemeris for usage and error information. +// +// Returned Error Types: +// +// - InvalidParameterException +// One or more parameters are not valid. +// +// - DependencyException +// Dependency encountered an error. +// +// - ResourceNotFoundException +// Resource was not found. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/UpdateEphemeris +func (c *GroundStation) UpdateEphemeris(input *UpdateEphemerisInput) (*UpdateEphemerisOutput, error) { + req, out := c.UpdateEphemerisRequest(input) + return out, req.Send() +} + +// UpdateEphemerisWithContext is the same as UpdateEphemeris with the addition of +// the ability to pass a context and additional request options. +// +// See UpdateEphemeris for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *GroundStation) UpdateEphemerisWithContext(ctx aws.Context, input *UpdateEphemerisInput, opts ...request.Option) (*UpdateEphemerisOutput, error) { + req, out := c.UpdateEphemerisRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opUpdateMissionProfile = "UpdateMissionProfile" // UpdateMissionProfileRequest generates a "aws/request.Request" representing the @@ -2770,7 +3252,7 @@ type CancelContactInput struct { // UUID of a contact. // // ContactId is a required field - ContactId *string `location:"uri" locationName:"contactId" type:"string" required:"true"` + ContactId *string `location:"uri" locationName:"contactId" min:"1" type:"string" required:"true"` } // String returns the string representation. @@ -2817,7 +3299,7 @@ type CancelContactOutput struct { _ struct{} `type:"structure"` // UUID of a contact. - ContactId *string `locationName:"contactId" type:"string"` + ContactId *string `locationName:"contactId" min:"1" type:"string"` } // String returns the string representation. @@ -3098,12 +3580,12 @@ type ContactData struct { _ struct{} `type:"structure"` // UUID of a contact. - ContactId *string `locationName:"contactId" type:"string"` + ContactId *string `locationName:"contactId" min:"1" type:"string"` // Status of a contact. ContactStatus *string `locationName:"contactStatus" type:"string" enum:"ContactStatus"` - // End time of a contact. + // End time of a contact in UTC. EndTime *time.Time `locationName:"endTime" type:"timestamp"` // Error message of a contact. @@ -3132,7 +3614,7 @@ type ContactData struct { // ARN of a satellite. SatelliteArn *string `locationName:"satelliteArn" type:"string"` - // Start time of a contact. + // Start time of a contact in UTC. StartTime *time.Time `locationName:"startTime" type:"timestamp"` // Tags assigned to a contact. @@ -3430,7 +3912,7 @@ type CreateDataflowEndpointGroupOutput struct { _ struct{} `type:"structure"` // UUID of a dataflow endpoint group. - DataflowEndpointGroupId *string `locationName:"dataflowEndpointGroupId" type:"string"` + DataflowEndpointGroupId *string `locationName:"dataflowEndpointGroupId" min:"1" type:"string"` } // String returns the string representation. @@ -3457,42 +3939,46 @@ func (s *CreateDataflowEndpointGroupOutput) SetDataflowEndpointGroupId(v string) return s } -type CreateMissionProfileInput struct { +type CreateEphemerisInput struct { _ struct{} `type:"structure"` - // Amount of time after a contact ends that you’d like to receive a CloudWatch - // event indicating the pass has finished. - ContactPostPassDurationSeconds *int64 `locationName:"contactPostPassDurationSeconds" min:"1" type:"integer"` + // Whether to set the ephemeris status to ENABLED after validation. + // + // Setting this to false will set the ephemeris status to DISABLED after validation. + Enabled *bool `locationName:"enabled" type:"boolean"` - // Amount of time prior to contact start you’d like to receive a CloudWatch - // event indicating an upcoming pass. - ContactPrePassDurationSeconds *int64 `locationName:"contactPrePassDurationSeconds" min:"1" type:"integer"` + // Ephemeris data. + Ephemeris *EphemerisData `locationName:"ephemeris" type:"structure"` - // A list of lists of ARNs. Each list of ARNs is an edge, with a from Config - // and a to Config. - // - // DataflowEdges is a required field - DataflowEdges [][]*string `locationName:"dataflowEdges" type:"list" required:"true"` + // An overall expiration time for the ephemeris in UTC, after which it will + // become EXPIRED. + ExpirationTime *time.Time `locationName:"expirationTime" type:"timestamp"` - // 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. - // - // MinimumViableContactDurationSeconds is a required field - MinimumViableContactDurationSeconds *int64 `locationName:"minimumViableContactDurationSeconds" min:"1" type:"integer" required:"true"` + // The ARN of a KMS key used to encrypt the ephemeris in Ground Station. + KmsKeyArn *string `locationName:"kmsKeyArn" type:"string"` - // Name of a mission profile. + // A name string associated with the ephemeris. Used as a human-readable identifier + // for the ephemeris. // // Name is a required field Name *string `locationName:"name" min:"1" type:"string" required:"true"` - // Tags assigned to a mission profile. - Tags map[string]*string `locationName:"tags" type:"map"` + // Customer-provided priority score to establish the order in which overlapping + // ephemerides should be used. + // + // The default for customer-provided ephemeris priority is 1, and higher numbers + // take precedence. + // + // Priority must be 1 or greater + Priority *int64 `locationName:"priority" min:"1" type:"integer"` - // ARN of a tracking Config. + // AWS Ground Station satellite ID for this ephemeris. // - // TrackingConfigArn is a required field - TrackingConfigArn *string `locationName:"trackingConfigArn" type:"string" required:"true"` + // SatelliteId is a required field + SatelliteId *string `locationName:"satelliteId" min:"1" type:"string" required:"true"` + + // Tags assigned to an ephemeris. + Tags map[string]*string `locationName:"tags" type:"map"` } // String returns the string representation. @@ -3500,7 +3986,7 @@ type CreateMissionProfileInput struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s CreateMissionProfileInput) String() string { +func (s CreateEphemerisInput) String() string { return awsutil.Prettify(s) } @@ -3509,40 +3995,199 @@ func (s CreateMissionProfileInput) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s CreateMissionProfileInput) GoString() string { +func (s CreateEphemerisInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *CreateMissionProfileInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "CreateMissionProfileInput"} - if s.ContactPostPassDurationSeconds != nil && *s.ContactPostPassDurationSeconds < 1 { - invalidParams.Add(request.NewErrParamMinValue("ContactPostPassDurationSeconds", 1)) - } - if s.ContactPrePassDurationSeconds != nil && *s.ContactPrePassDurationSeconds < 1 { - invalidParams.Add(request.NewErrParamMinValue("ContactPrePassDurationSeconds", 1)) - } - if s.DataflowEdges == nil { - invalidParams.Add(request.NewErrParamRequired("DataflowEdges")) - } - if s.MinimumViableContactDurationSeconds == nil { - invalidParams.Add(request.NewErrParamRequired("MinimumViableContactDurationSeconds")) - } - if s.MinimumViableContactDurationSeconds != nil && *s.MinimumViableContactDurationSeconds < 1 { - invalidParams.Add(request.NewErrParamMinValue("MinimumViableContactDurationSeconds", 1)) - } +func (s *CreateEphemerisInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CreateEphemerisInput"} if s.Name == nil { invalidParams.Add(request.NewErrParamRequired("Name")) } if s.Name != nil && len(*s.Name) < 1 { invalidParams.Add(request.NewErrParamMinLen("Name", 1)) } - if s.TrackingConfigArn == nil { - invalidParams.Add(request.NewErrParamRequired("TrackingConfigArn")) + if s.Priority != nil && *s.Priority < 1 { + invalidParams.Add(request.NewErrParamMinValue("Priority", 1)) } - - if invalidParams.Len() > 0 { - return invalidParams + if s.SatelliteId == nil { + invalidParams.Add(request.NewErrParamRequired("SatelliteId")) + } + if s.SatelliteId != nil && len(*s.SatelliteId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("SatelliteId", 1)) + } + if s.Ephemeris != nil { + if err := s.Ephemeris.Validate(); err != nil { + invalidParams.AddNested("Ephemeris", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetEnabled sets the Enabled field's value. +func (s *CreateEphemerisInput) SetEnabled(v bool) *CreateEphemerisInput { + s.Enabled = &v + return s +} + +// SetEphemeris sets the Ephemeris field's value. +func (s *CreateEphemerisInput) SetEphemeris(v *EphemerisData) *CreateEphemerisInput { + s.Ephemeris = v + return s +} + +// SetExpirationTime sets the ExpirationTime field's value. +func (s *CreateEphemerisInput) SetExpirationTime(v time.Time) *CreateEphemerisInput { + s.ExpirationTime = &v + return s +} + +// SetKmsKeyArn sets the KmsKeyArn field's value. +func (s *CreateEphemerisInput) SetKmsKeyArn(v string) *CreateEphemerisInput { + s.KmsKeyArn = &v + return s +} + +// SetName sets the Name field's value. +func (s *CreateEphemerisInput) SetName(v string) *CreateEphemerisInput { + s.Name = &v + return s +} + +// SetPriority sets the Priority field's value. +func (s *CreateEphemerisInput) SetPriority(v int64) *CreateEphemerisInput { + s.Priority = &v + return s +} + +// SetSatelliteId sets the SatelliteId field's value. +func (s *CreateEphemerisInput) SetSatelliteId(v string) *CreateEphemerisInput { + s.SatelliteId = &v + return s +} + +// SetTags sets the Tags field's value. +func (s *CreateEphemerisInput) SetTags(v map[string]*string) *CreateEphemerisInput { + s.Tags = v + return s +} + +type CreateEphemerisOutput struct { + _ struct{} `type:"structure"` + + // The AWS Ground Station ephemeris ID. + EphemerisId *string `locationName:"ephemerisId" min:"1" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateEphemerisOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateEphemerisOutput) GoString() string { + return s.String() +} + +// SetEphemerisId sets the EphemerisId field's value. +func (s *CreateEphemerisOutput) SetEphemerisId(v string) *CreateEphemerisOutput { + s.EphemerisId = &v + return s +} + +type CreateMissionProfileInput struct { + _ struct{} `type:"structure"` + + // Amount of time after a contact ends that you’d like to receive a CloudWatch + // event indicating the pass has finished. + ContactPostPassDurationSeconds *int64 `locationName:"contactPostPassDurationSeconds" type:"integer"` + + // Amount of time prior to contact start you’d like to receive a CloudWatch + // event indicating an upcoming pass. + ContactPrePassDurationSeconds *int64 `locationName:"contactPrePassDurationSeconds" type:"integer"` + + // A list of lists of ARNs. Each list of ARNs is an edge, with a from Config + // and a to Config. + // + // DataflowEdges is a required field + DataflowEdges [][]*string `locationName:"dataflowEdges" type:"list" required:"true"` + + // 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. + // + // MinimumViableContactDurationSeconds is a required field + MinimumViableContactDurationSeconds *int64 `locationName:"minimumViableContactDurationSeconds" min:"1" type:"integer" required:"true"` + + // Name of a mission profile. + // + // Name is a required field + Name *string `locationName:"name" min:"1" type:"string" required:"true"` + + // Tags assigned to a mission profile. + Tags map[string]*string `locationName:"tags" type:"map"` + + // ARN of a tracking Config. + // + // TrackingConfigArn is a required field + TrackingConfigArn *string `locationName:"trackingConfigArn" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateMissionProfileInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateMissionProfileInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *CreateMissionProfileInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CreateMissionProfileInput"} + if s.DataflowEdges == nil { + invalidParams.Add(request.NewErrParamRequired("DataflowEdges")) + } + if s.MinimumViableContactDurationSeconds == nil { + invalidParams.Add(request.NewErrParamRequired("MinimumViableContactDurationSeconds")) + } + if s.MinimumViableContactDurationSeconds != nil && *s.MinimumViableContactDurationSeconds < 1 { + invalidParams.Add(request.NewErrParamMinValue("MinimumViableContactDurationSeconds", 1)) + } + if s.Name == nil { + invalidParams.Add(request.NewErrParamRequired("Name")) + } + if s.Name != nil && len(*s.Name) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Name", 1)) + } + if s.TrackingConfigArn == nil { + invalidParams.Add(request.NewErrParamRequired("TrackingConfigArn")) + } + + if invalidParams.Len() > 0 { + return invalidParams } return nil } @@ -3593,7 +4238,7 @@ type CreateMissionProfileOutput struct { _ struct{} `type:"structure"` // UUID of a mission profile. - MissionProfileId *string `locationName:"missionProfileId" type:"string"` + MissionProfileId *string `locationName:"missionProfileId" min:"1" type:"string"` } // String returns the string representation. @@ -3625,13 +4270,13 @@ type Data struct { _ struct{} `type:"structure"` // UUID of a ground station. - GroundStationId *string `locationName:"groundStationId" type:"string"` + GroundStationId *string `locationName:"groundStationId" min:"4" type:"string"` // Name of a ground station. - GroundStationName *string `locationName:"groundStationName" type:"string"` + GroundStationName *string `locationName:"groundStationName" min:"4" type:"string"` // Ground station Region. - Region *string `locationName:"region" type:"string"` + Region *string `locationName:"region" min:"1" type:"string"` } // String returns the string representation. @@ -3864,7 +4509,7 @@ type DataflowEndpointListItem struct { DataflowEndpointGroupArn *string `locationName:"dataflowEndpointGroupArn" type:"string"` // UUID of a dataflow endpoint group. - DataflowEndpointGroupId *string `locationName:"dataflowEndpointGroupId" type:"string"` + DataflowEndpointGroupId *string `locationName:"dataflowEndpointGroupId" min:"1" type:"string"` } // String returns the string representation. @@ -3953,7 +4598,7 @@ type DeleteConfigInput struct { // UUID of a Config. // // ConfigId is a required field - ConfigId *string `location:"uri" locationName:"configId" type:"string" required:"true"` + ConfigId *string `location:"uri" locationName:"configId" min:"1" type:"string" required:"true"` // Type of a Config. // @@ -4068,7 +4713,7 @@ type DeleteDataflowEndpointGroupInput struct { // UUID of a dataflow endpoint group. // // DataflowEndpointGroupId is a required field - DataflowEndpointGroupId *string `location:"uri" locationName:"dataflowEndpointGroupId" type:"string" required:"true"` + DataflowEndpointGroupId *string `location:"uri" locationName:"dataflowEndpointGroupId" min:"1" type:"string" required:"true"` } // String returns the string representation. @@ -4115,7 +4760,7 @@ type DeleteDataflowEndpointGroupOutput struct { _ struct{} `type:"structure"` // UUID of a dataflow endpoint group. - DataflowEndpointGroupId *string `locationName:"dataflowEndpointGroupId" type:"string"` + DataflowEndpointGroupId *string `locationName:"dataflowEndpointGroupId" min:"1" type:"string"` } // String returns the string representation. @@ -4142,13 +4787,93 @@ func (s *DeleteDataflowEndpointGroupOutput) SetDataflowEndpointGroupId(v string) return s } +type DeleteEphemerisInput struct { + _ struct{} `type:"structure" nopayload:"true"` + + // The AWS Ground Station ephemeris ID. + // + // EphemerisId is a required field + EphemerisId *string `location:"uri" locationName:"ephemerisId" min:"1" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteEphemerisInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteEphemerisInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DeleteEphemerisInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DeleteEphemerisInput"} + if s.EphemerisId == nil { + invalidParams.Add(request.NewErrParamRequired("EphemerisId")) + } + if s.EphemerisId != nil && len(*s.EphemerisId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("EphemerisId", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetEphemerisId sets the EphemerisId field's value. +func (s *DeleteEphemerisInput) SetEphemerisId(v string) *DeleteEphemerisInput { + s.EphemerisId = &v + return s +} + +type DeleteEphemerisOutput struct { + _ struct{} `type:"structure"` + + // The AWS Ground Station ephemeris ID. + EphemerisId *string `locationName:"ephemerisId" min:"1" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteEphemerisOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteEphemerisOutput) GoString() string { + return s.String() +} + +// SetEphemerisId sets the EphemerisId field's value. +func (s *DeleteEphemerisOutput) SetEphemerisId(v string) *DeleteEphemerisOutput { + s.EphemerisId = &v + return s +} + type DeleteMissionProfileInput struct { _ struct{} `type:"structure" nopayload:"true"` // UUID of a mission profile. // // MissionProfileId is a required field - MissionProfileId *string `location:"uri" locationName:"missionProfileId" type:"string" required:"true"` + MissionProfileId *string `location:"uri" locationName:"missionProfileId" min:"1" type:"string" required:"true"` } // String returns the string representation. @@ -4195,7 +4920,7 @@ type DeleteMissionProfileOutput struct { _ struct{} `type:"structure"` // UUID of a mission profile. - MissionProfileId *string `locationName:"missionProfileId" type:"string"` + MissionProfileId *string `locationName:"missionProfileId" min:"1" type:"string"` } // String returns the string representation. @@ -4344,7 +5069,7 @@ type DescribeContactInput struct { // UUID of a contact. // // ContactId is a required field - ContactId *string `location:"uri" locationName:"contactId" type:"string" required:"true"` + ContactId *string `location:"uri" locationName:"contactId" min:"1" type:"string" required:"true"` } // String returns the string representation. @@ -4391,7 +5116,7 @@ type DescribeContactOutput struct { _ struct{} `type:"structure"` // UUID of a contact. - ContactId *string `locationName:"contactId" type:"string"` + ContactId *string `locationName:"contactId" min:"1" type:"string"` // Status of a contact. ContactStatus *string `locationName:"contactStatus" type:"string" enum:"ContactStatus"` @@ -4399,7 +5124,7 @@ type DescribeContactOutput struct { // List describing source and destination details for each dataflow edge. DataflowList []*DataflowDetail `locationName:"dataflowList" type:"list"` - // End time of a contact. + // End time of a contact in UTC. EndTime *time.Time `locationName:"endTime" type:"timestamp"` // Error message for a contact. @@ -4428,7 +5153,7 @@ type DescribeContactOutput struct { // ARN of a satellite. SatelliteArn *string `locationName:"satelliteArn" type:"string"` - // Start time of a contact. + // Start time of a contact in UTC. StartTime *time.Time `locationName:"startTime" type:"timestamp"` // Tags assigned to a contact. @@ -4537,22 +5262,13 @@ func (s *DescribeContactOutput) SetTags(v map[string]*string) *DescribeContactOu return s } -// Dataflow details for the destination side. -type Destination struct { - _ struct{} `type:"structure"` - - // Additional details for a Config, if type is dataflow endpoint or antenna - // demod decode. - ConfigDetails *ConfigDetails `locationName:"configDetails" type:"structure"` - - // UUID of a Config. - ConfigId *string `locationName:"configId" type:"string"` - - // Type of a Config. - ConfigType *string `locationName:"configType" type:"string" enum:"ConfigCapabilityType"` +type DescribeEphemerisInput struct { + _ struct{} `type:"structure" nopayload:"true"` - // Region of a dataflow destination. - DataflowDestinationRegion *string `locationName:"dataflowDestinationRegion" type:"string"` + // The AWS Ground Station ephemeris ID. + // + // EphemerisId is a required field + EphemerisId *string `location:"uri" locationName:"ephemerisId" min:"1" type:"string" required:"true"` } // String returns the string representation. @@ -4560,7 +5276,7 @@ type Destination struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s Destination) String() string { +func (s DescribeEphemerisInput) String() string { return awsutil.Prettify(s) } @@ -4569,45 +5285,223 @@ func (s Destination) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s Destination) GoString() string { +func (s DescribeEphemerisInput) GoString() string { return s.String() } -// SetConfigDetails sets the ConfigDetails field's value. -func (s *Destination) SetConfigDetails(v *ConfigDetails) *Destination { - s.ConfigDetails = v - return s -} - -// SetConfigId sets the ConfigId field's value. -func (s *Destination) SetConfigId(v string) *Destination { - s.ConfigId = &v - return s -} +// Validate inspects the fields of the type to determine if they are valid. +func (s *DescribeEphemerisInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DescribeEphemerisInput"} + if s.EphemerisId == nil { + invalidParams.Add(request.NewErrParamRequired("EphemerisId")) + } + if s.EphemerisId != nil && len(*s.EphemerisId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("EphemerisId", 1)) + } -// SetConfigType sets the ConfigType field's value. -func (s *Destination) SetConfigType(v string) *Destination { - s.ConfigType = &v - return s + if invalidParams.Len() > 0 { + return invalidParams + } + return nil } -// SetDataflowDestinationRegion sets the DataflowDestinationRegion field's value. -func (s *Destination) SetDataflowDestinationRegion(v string) *Destination { - s.DataflowDestinationRegion = &v +// SetEphemerisId sets the EphemerisId field's value. +func (s *DescribeEphemerisInput) SetEphemerisId(v string) *DescribeEphemerisInput { + s.EphemerisId = &v return s } -// Object that represents EIRP. -type Eirp struct { +type DescribeEphemerisOutput struct { _ struct{} `type:"structure"` - // Units of an EIRP. - // - // Units is a required field - Units *string `locationName:"units" type:"string" required:"true" enum:"EirpUnits"` + // The time the ephemeris was uploaded in UTC. + CreationTime *time.Time `locationName:"creationTime" type:"timestamp"` - // Value of an EIRP. Valid values are between 20.0 to 50.0 dBW. - // + // Whether or not the ephemeris is enabled. + Enabled *bool `locationName:"enabled" type:"boolean"` + + // The AWS Ground Station ephemeris ID. + EphemerisId *string `locationName:"ephemerisId" min:"1" type:"string"` + + // Reason that an ephemeris failed validation. Only provided for ephemerides + // with INVALID status. + InvalidReason *string `locationName:"invalidReason" type:"string" enum:"EphemerisInvalidReason"` + + // A name string associated with the ephemeris. Used as a human-readable identifier + // for the ephemeris. + Name *string `locationName:"name" min:"1" type:"string"` + + // Customer-provided priority score to establish the order in which overlapping + // ephemerides should be used. + // + // The default for customer-provided ephemeris priority is 1, and higher numbers + // take precedence. + // + // Priority must be 1 or greater + Priority *int64 `locationName:"priority" type:"integer"` + + // The AWS Ground Station satellite ID associated with ephemeris. + SatelliteId *string `locationName:"satelliteId" min:"1" type:"string"` + + // The status of the ephemeris. + Status *string `locationName:"status" type:"string" enum:"EphemerisStatus"` + + // Supplied ephemeris data. + SuppliedData *EphemerisTypeDescription `locationName:"suppliedData" type:"structure"` + + // Tags assigned to an ephemeris. + Tags map[string]*string `locationName:"tags" type:"map"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeEphemerisOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeEphemerisOutput) GoString() string { + return s.String() +} + +// SetCreationTime sets the CreationTime field's value. +func (s *DescribeEphemerisOutput) SetCreationTime(v time.Time) *DescribeEphemerisOutput { + s.CreationTime = &v + return s +} + +// SetEnabled sets the Enabled field's value. +func (s *DescribeEphemerisOutput) SetEnabled(v bool) *DescribeEphemerisOutput { + s.Enabled = &v + return s +} + +// SetEphemerisId sets the EphemerisId field's value. +func (s *DescribeEphemerisOutput) SetEphemerisId(v string) *DescribeEphemerisOutput { + s.EphemerisId = &v + return s +} + +// SetInvalidReason sets the InvalidReason field's value. +func (s *DescribeEphemerisOutput) SetInvalidReason(v string) *DescribeEphemerisOutput { + s.InvalidReason = &v + return s +} + +// SetName sets the Name field's value. +func (s *DescribeEphemerisOutput) SetName(v string) *DescribeEphemerisOutput { + s.Name = &v + return s +} + +// SetPriority sets the Priority field's value. +func (s *DescribeEphemerisOutput) SetPriority(v int64) *DescribeEphemerisOutput { + s.Priority = &v + return s +} + +// SetSatelliteId sets the SatelliteId field's value. +func (s *DescribeEphemerisOutput) SetSatelliteId(v string) *DescribeEphemerisOutput { + s.SatelliteId = &v + return s +} + +// SetStatus sets the Status field's value. +func (s *DescribeEphemerisOutput) SetStatus(v string) *DescribeEphemerisOutput { + s.Status = &v + return s +} + +// SetSuppliedData sets the SuppliedData field's value. +func (s *DescribeEphemerisOutput) SetSuppliedData(v *EphemerisTypeDescription) *DescribeEphemerisOutput { + s.SuppliedData = v + return s +} + +// SetTags sets the Tags field's value. +func (s *DescribeEphemerisOutput) SetTags(v map[string]*string) *DescribeEphemerisOutput { + s.Tags = v + return s +} + +// Dataflow details for the destination side. +type Destination struct { + _ struct{} `type:"structure"` + + // Additional details for a Config, if type is dataflow endpoint or antenna + // demod decode. + ConfigDetails *ConfigDetails `locationName:"configDetails" type:"structure"` + + // UUID of a Config. + ConfigId *string `locationName:"configId" min:"1" type:"string"` + + // Type of a Config. + ConfigType *string `locationName:"configType" type:"string" enum:"ConfigCapabilityType"` + + // Region of a dataflow destination. + DataflowDestinationRegion *string `locationName:"dataflowDestinationRegion" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s Destination) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s Destination) GoString() string { + return s.String() +} + +// SetConfigDetails sets the ConfigDetails field's value. +func (s *Destination) SetConfigDetails(v *ConfigDetails) *Destination { + s.ConfigDetails = v + return s +} + +// SetConfigId sets the ConfigId field's value. +func (s *Destination) SetConfigId(v string) *Destination { + s.ConfigId = &v + return s +} + +// SetConfigType sets the ConfigType field's value. +func (s *Destination) SetConfigType(v string) *Destination { + s.ConfigType = &v + return s +} + +// SetDataflowDestinationRegion sets the DataflowDestinationRegion field's value. +func (s *Destination) SetDataflowDestinationRegion(v string) *Destination { + s.DataflowDestinationRegion = &v + return s +} + +// Object that represents EIRP. +type Eirp struct { + _ struct{} `type:"structure"` + + // Units of an EIRP. + // + // Units is a required field + Units *string `locationName:"units" type:"string" required:"true" enum:"EirpUnits"` + + // Value of an EIRP. Valid values are between 20.0 to 50.0 dBW. + // // Value is a required field Value *float64 `locationName:"value" type:"double" required:"true"` } @@ -4710,7 +5604,8 @@ type EndpointDetails struct { // A dataflow endpoint. Endpoint *DataflowEndpoint `locationName:"endpoint" type:"structure"` - // Endpoint security details. + // Endpoint security details including a list of subnets, a list of security + // groups and a role to connect streams to instances. SecurityDetails *SecurityDetails `locationName:"securityDetails" type:"structure"` } @@ -4764,6 +5659,310 @@ func (s *EndpointDetails) SetSecurityDetails(v *SecurityDetails) *EndpointDetail return s } +// Ephemeris data. +type EphemerisData struct { + _ struct{} `type:"structure"` + + // Ephemeris data in Orbit Ephemeris Message (OEM) format. + Oem *OEMEphemeris `locationName:"oem" type:"structure"` + + // Two-line element set (TLE) ephemeris. + Tle *TLEEphemeris `locationName:"tle" type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s EphemerisData) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s EphemerisData) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *EphemerisData) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "EphemerisData"} + if s.Oem != nil { + if err := s.Oem.Validate(); err != nil { + invalidParams.AddNested("Oem", err.(request.ErrInvalidParams)) + } + } + if s.Tle != nil { + if err := s.Tle.Validate(); err != nil { + invalidParams.AddNested("Tle", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetOem sets the Oem field's value. +func (s *EphemerisData) SetOem(v *OEMEphemeris) *EphemerisData { + s.Oem = v + return s +} + +// SetTle sets the Tle field's value. +func (s *EphemerisData) SetTle(v *TLEEphemeris) *EphemerisData { + s.Tle = v + return s +} + +// Description of ephemeris. +type EphemerisDescription struct { + _ struct{} `type:"structure"` + + // Supplied ephemeris data. + EphemerisData *string `locationName:"ephemerisData" min:"1" type:"string"` + + // Source S3 object used for the ephemeris. + SourceS3Object *S3Object `locationName:"sourceS3Object" type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s EphemerisDescription) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s EphemerisDescription) GoString() string { + return s.String() +} + +// SetEphemerisData sets the EphemerisData field's value. +func (s *EphemerisDescription) SetEphemerisData(v string) *EphemerisDescription { + s.EphemerisData = &v + return s +} + +// SetSourceS3Object sets the SourceS3Object field's value. +func (s *EphemerisDescription) SetSourceS3Object(v *S3Object) *EphemerisDescription { + s.SourceS3Object = v + return s +} + +// Ephemeris item. +type EphemerisItem struct { + _ struct{} `type:"structure"` + + // The time the ephemeris was uploaded in UTC. + CreationTime *time.Time `locationName:"creationTime" type:"timestamp"` + + // Whether or not the ephemeris is enabled. + Enabled *bool `locationName:"enabled" type:"boolean"` + + // The AWS Ground Station ephemeris ID. + EphemerisId *string `locationName:"ephemerisId" min:"1" type:"string"` + + // A name string associated with the ephemeris. Used as a human-readable identifier + // for the ephemeris. + Name *string `locationName:"name" min:"1" type:"string"` + + // Customer-provided priority score to establish the order in which overlapping + // ephemerides should be used. + // + // The default for customer-provided ephemeris priority is 1, and higher numbers + // take precedence. + // + // Priority must be 1 or greater + Priority *int64 `locationName:"priority" type:"integer"` + + // Source S3 object used for the ephemeris. + SourceS3Object *S3Object `locationName:"sourceS3Object" type:"structure"` + + // The status of the ephemeris. + Status *string `locationName:"status" type:"string" enum:"EphemerisStatus"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s EphemerisItem) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s EphemerisItem) GoString() string { + return s.String() +} + +// SetCreationTime sets the CreationTime field's value. +func (s *EphemerisItem) SetCreationTime(v time.Time) *EphemerisItem { + s.CreationTime = &v + return s +} + +// SetEnabled sets the Enabled field's value. +func (s *EphemerisItem) SetEnabled(v bool) *EphemerisItem { + s.Enabled = &v + return s +} + +// SetEphemerisId sets the EphemerisId field's value. +func (s *EphemerisItem) SetEphemerisId(v string) *EphemerisItem { + s.EphemerisId = &v + return s +} + +// SetName sets the Name field's value. +func (s *EphemerisItem) SetName(v string) *EphemerisItem { + s.Name = &v + return s +} + +// SetPriority sets the Priority field's value. +func (s *EphemerisItem) SetPriority(v int64) *EphemerisItem { + s.Priority = &v + return s +} + +// SetSourceS3Object sets the SourceS3Object field's value. +func (s *EphemerisItem) SetSourceS3Object(v *S3Object) *EphemerisItem { + s.SourceS3Object = v + return s +} + +// SetStatus sets the Status field's value. +func (s *EphemerisItem) SetStatus(v string) *EphemerisItem { + s.Status = &v + return s +} + +// Metadata describing a particular ephemeris. +type EphemerisMetaData struct { + _ struct{} `type:"structure"` + + // UUID of a customer-provided ephemeris. + // + // This field is not populated for default ephemerides from Space Track. + EphemerisId *string `locationName:"ephemerisId" min:"1" type:"string"` + + // The epoch of a default, ephemeris from Space Track in UTC. + // + // This field is not populated for customer-provided ephemerides. + Epoch *time.Time `locationName:"epoch" type:"timestamp"` + + // A name string associated with the ephemeris. Used as a human-readable identifier + // for the ephemeris. + // + // A name is only returned for customer-provider ephemerides that have a name + // associated. + Name *string `locationName:"name" min:"1" type:"string"` + + // The EphemerisSource that generated a given ephemeris. + // + // Source is a required field + Source *string `locationName:"source" type:"string" required:"true" enum:"EphemerisSource"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s EphemerisMetaData) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s EphemerisMetaData) GoString() string { + return s.String() +} + +// SetEphemerisId sets the EphemerisId field's value. +func (s *EphemerisMetaData) SetEphemerisId(v string) *EphemerisMetaData { + s.EphemerisId = &v + return s +} + +// SetEpoch sets the Epoch field's value. +func (s *EphemerisMetaData) SetEpoch(v time.Time) *EphemerisMetaData { + s.Epoch = &v + return s +} + +// SetName sets the Name field's value. +func (s *EphemerisMetaData) SetName(v string) *EphemerisMetaData { + s.Name = &v + return s +} + +// SetSource sets the Source field's value. +func (s *EphemerisMetaData) SetSource(v string) *EphemerisMetaData { + s.Source = &v + return s +} + +type EphemerisTypeDescription struct { + _ struct{} `type:"structure"` + + // Description of ephemeris. + Oem *EphemerisDescription `locationName:"oem" type:"structure"` + + // Description of ephemeris. + Tle *EphemerisDescription `locationName:"tle" type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s EphemerisTypeDescription) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s EphemerisTypeDescription) GoString() string { + return s.String() +} + +// SetOem sets the Oem field's value. +func (s *EphemerisTypeDescription) SetOem(v *EphemerisDescription) *EphemerisTypeDescription { + s.Oem = v + return s +} + +// SetTle sets the Tle field's value. +func (s *EphemerisTypeDescription) SetTle(v *EphemerisDescription) *EphemerisTypeDescription { + s.Tle = v + return s +} + // Object that describes the frequency. type Frequency struct { _ struct{} `type:"structure"` @@ -4901,7 +6100,7 @@ type GetConfigInput struct { // UUID of a Config. // // ConfigId is a required field - ConfigId *string `location:"uri" locationName:"configId" type:"string" required:"true"` + ConfigId *string `location:"uri" locationName:"configId" min:"1" type:"string" required:"true"` // Type of a Config. // @@ -5051,7 +6250,7 @@ type GetDataflowEndpointGroupInput struct { // UUID of a dataflow endpoint group. // // DataflowEndpointGroupId is a required field - DataflowEndpointGroupId *string `location:"uri" locationName:"dataflowEndpointGroupId" type:"string" required:"true"` + DataflowEndpointGroupId *string `location:"uri" locationName:"dataflowEndpointGroupId" min:"1" type:"string" required:"true"` } // String returns the string representation. @@ -5101,7 +6300,7 @@ type GetDataflowEndpointGroupOutput struct { DataflowEndpointGroupArn *string `locationName:"dataflowEndpointGroupArn" type:"string"` // UUID of a dataflow endpoint group. - DataflowEndpointGroupId *string `locationName:"dataflowEndpointGroupId" type:"string"` + DataflowEndpointGroupId *string `locationName:"dataflowEndpointGroupId" min:"1" type:"string"` // Details of a dataflow endpoint. EndpointsDetails []*EndpointDetails `locationName:"endpointsDetails" type:"list"` @@ -5158,12 +6357,12 @@ type GetMinuteUsageInput struct { // The month being requested, with a value of 1-12. // // Month is a required field - Month *int64 `locationName:"month" type:"integer" required:"true"` + Month *int64 `locationName:"month" min:"1" type:"integer" required:"true"` // The year being requested, in the format of YYYY. // // Year is a required field - Year *int64 `locationName:"year" type:"integer" required:"true"` + Year *int64 `locationName:"year" min:"2018" type:"integer" required:"true"` } // String returns the string representation. @@ -5190,9 +6389,15 @@ func (s *GetMinuteUsageInput) Validate() error { if s.Month == nil { invalidParams.Add(request.NewErrParamRequired("Month")) } + if s.Month != nil && *s.Month < 1 { + invalidParams.Add(request.NewErrParamMinValue("Month", 1)) + } if s.Year == nil { invalidParams.Add(request.NewErrParamRequired("Year")) } + if s.Year != nil && *s.Year < 2018 { + invalidParams.Add(request.NewErrParamMinValue("Year", 2018)) + } if invalidParams.Len() > 0 { return invalidParams @@ -5287,7 +6492,7 @@ type GetMissionProfileInput struct { // UUID of a mission profile. // // MissionProfileId is a required field - MissionProfileId *string `location:"uri" locationName:"missionProfileId" type:"string" required:"true"` + MissionProfileId *string `location:"uri" locationName:"missionProfileId" min:"1" type:"string" required:"true"` } // String returns the string representation. @@ -5335,11 +6540,11 @@ type GetMissionProfileOutput struct { // Amount of time after a contact ends that you’d like to receive a CloudWatch // event indicating the pass has finished. - ContactPostPassDurationSeconds *int64 `locationName:"contactPostPassDurationSeconds" min:"1" type:"integer"` + ContactPostPassDurationSeconds *int64 `locationName:"contactPostPassDurationSeconds" type:"integer"` // Amount of time prior to contact start you’d like to receive a CloudWatch // event indicating an upcoming pass. - ContactPrePassDurationSeconds *int64 `locationName:"contactPrePassDurationSeconds" min:"1" type:"integer"` + ContactPrePassDurationSeconds *int64 `locationName:"contactPrePassDurationSeconds" type:"integer"` // A list of lists of ARNs. Each list of ARNs is an edge, with a from Config // and a to Config. @@ -5354,13 +6559,13 @@ type GetMissionProfileOutput struct { MissionProfileArn *string `locationName:"missionProfileArn" type:"string"` // UUID of a mission profile. - MissionProfileId *string `locationName:"missionProfileId" type:"string"` + MissionProfileId *string `locationName:"missionProfileId" min:"1" type:"string"` // Name of a mission profile. - Name *string `locationName:"name" type:"string"` + Name *string `locationName:"name" min:"1" type:"string"` // Region of a mission profile. - Region *string `locationName:"region" type:"string"` + Region *string `locationName:"region" min:"1" type:"string"` // Tags assigned to a mission profile. Tags map[string]*string `locationName:"tags" type:"map"` @@ -5453,7 +6658,7 @@ type GetSatelliteInput struct { // UUID of a satellite. // // SatelliteId is a required field - SatelliteId *string `location:"uri" locationName:"satelliteId" type:"string" required:"true"` + SatelliteId *string `location:"uri" locationName:"satelliteId" min:"1" type:"string" required:"true"` } // String returns the string representation. @@ -5499,11 +6704,14 @@ func (s *GetSatelliteInput) SetSatelliteId(v string) *GetSatelliteInput { type GetSatelliteOutput struct { _ struct{} `type:"structure"` + // The current ephemeris being used to compute the trajectory of the satellite. + CurrentEphemeris *EphemerisMetaData `locationName:"currentEphemeris" type:"structure"` + // A list of ground stations to which the satellite is on-boarded. GroundStations []*string `locationName:"groundStations" type:"list"` // NORAD satellite ID number. - NoradSatelliteID *int64 `locationName:"noradSatelliteID" min:"1" type:"integer"` + NoradSatelliteID *int64 `locationName:"noradSatelliteID" type:"integer"` // ARN of a satellite. SatelliteArn *string `locationName:"satelliteArn" type:"string"` @@ -5530,6 +6738,12 @@ func (s GetSatelliteOutput) GoString() string { return s.String() } +// SetCurrentEphemeris sets the CurrentEphemeris field's value. +func (s *GetSatelliteOutput) SetCurrentEphemeris(v *EphemerisMetaData) *GetSatelliteOutput { + s.CurrentEphemeris = v + return s +} + // SetGroundStations sets the GroundStations field's value. func (s *GetSatelliteOutput) SetGroundStations(v []*string) *GetSatelliteOutput { s.GroundStations = v @@ -5628,7 +6842,7 @@ type ListConfigsInput struct { // Next token returned in the request of a previous ListConfigs call. Used to // get the next page of results. - NextToken *string `location:"querystring" locationName:"nextToken" type:"string"` + NextToken *string `location:"querystring" locationName:"nextToken" min:"3" type:"string"` } // String returns the string representation. @@ -5649,6 +6863,19 @@ func (s ListConfigsInput) GoString() string { return s.String() } +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListConfigsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListConfigsInput"} + if s.NextToken != nil && len(*s.NextToken) < 3 { + invalidParams.Add(request.NewErrParamMinLen("NextToken", 3)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + // SetMaxResults sets the MaxResults field's value. func (s *ListConfigsInput) SetMaxResults(v int64) *ListConfigsInput { s.MaxResults = &v @@ -5669,7 +6896,7 @@ type ListConfigsOutput struct { // Next token returned in the response of a previous ListConfigs call. Used // to get the next page of results. - NextToken *string `locationName:"nextToken" type:"string"` + NextToken *string `locationName:"nextToken" min:"3" type:"string"` } // String returns the string representation. @@ -5705,13 +6932,13 @@ func (s *ListConfigsOutput) SetNextToken(v string) *ListConfigsOutput { type ListContactsInput struct { _ struct{} `type:"structure"` - // End time of a contact. + // End time of a contact in UTC. // // EndTime is a required field EndTime *time.Time `locationName:"endTime" type:"timestamp" required:"true"` // Name of a ground station. - GroundStation *string `locationName:"groundStation" type:"string"` + GroundStation *string `locationName:"groundStation" min:"4" type:"string"` // Maximum number of contacts returned. MaxResults *int64 `locationName:"maxResults" type:"integer"` @@ -5721,12 +6948,12 @@ type ListContactsInput struct { // Next token returned in the request of a previous ListContacts call. Used // to get the next page of results. - NextToken *string `locationName:"nextToken" type:"string"` + NextToken *string `locationName:"nextToken" min:"3" type:"string"` // ARN of a satellite. SatelliteArn *string `locationName:"satelliteArn" type:"string"` - // Start time of a contact. + // Start time of a contact in UTC. // // StartTime is a required field StartTime *time.Time `locationName:"startTime" type:"timestamp" required:"true"` @@ -5761,6 +6988,12 @@ func (s *ListContactsInput) Validate() error { if s.EndTime == nil { invalidParams.Add(request.NewErrParamRequired("EndTime")) } + if s.GroundStation != nil && len(*s.GroundStation) < 4 { + invalidParams.Add(request.NewErrParamMinLen("GroundStation", 4)) + } + if s.NextToken != nil && len(*s.NextToken) < 3 { + invalidParams.Add(request.NewErrParamMinLen("NextToken", 3)) + } if s.StartTime == nil { invalidParams.Add(request.NewErrParamRequired("StartTime")) } @@ -5830,7 +7063,7 @@ type ListContactsOutput struct { // Next token returned in the response of a previous ListContacts call. Used // to get the next page of results. - NextToken *string `locationName:"nextToken" type:"string"` + NextToken *string `locationName:"nextToken" min:"3" type:"string"` } // String returns the string representation. @@ -5871,7 +7104,7 @@ type ListDataflowEndpointGroupsInput struct { // Next token returned in the request of a previous ListDataflowEndpointGroups // call. Used to get the next page of results. - NextToken *string `location:"querystring" locationName:"nextToken" type:"string"` + NextToken *string `location:"querystring" locationName:"nextToken" min:"3" type:"string"` } // String returns the string representation. @@ -5892,6 +7125,19 @@ func (s ListDataflowEndpointGroupsInput) GoString() string { return s.String() } +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListDataflowEndpointGroupsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListDataflowEndpointGroupsInput"} + if s.NextToken != nil && len(*s.NextToken) < 3 { + invalidParams.Add(request.NewErrParamMinLen("NextToken", 3)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + // SetMaxResults sets the MaxResults field's value. func (s *ListDataflowEndpointGroupsInput) SetMaxResults(v int64) *ListDataflowEndpointGroupsInput { s.MaxResults = &v @@ -5912,7 +7158,7 @@ type ListDataflowEndpointGroupsOutput struct { // Next token returned in the response of a previous ListDataflowEndpointGroups // call. Used to get the next page of results. - NextToken *string `locationName:"nextToken" type:"string"` + NextToken *string `locationName:"nextToken" min:"3" type:"string"` } // String returns the string representation. @@ -5945,6 +7191,156 @@ func (s *ListDataflowEndpointGroupsOutput) SetNextToken(v string) *ListDataflowE return s } +type ListEphemeridesInput struct { + _ struct{} `type:"structure"` + + // 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. + // + // EndTime is a required field + EndTime *time.Time `locationName:"endTime" type:"timestamp" required:"true"` + + // Maximum number of ephemerides to return. + MaxResults *int64 `location:"querystring" locationName:"maxResults" type:"integer"` + + // Pagination token. + NextToken *string `location:"querystring" locationName:"nextToken" min:"3" type:"string"` + + // The AWS Ground Station satellite ID to list ephemeris for. + // + // SatelliteId is a required field + SatelliteId *string `locationName:"satelliteId" min:"1" type:"string" required:"true"` + + // 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. + // + // StartTime is a required field + StartTime *time.Time `locationName:"startTime" type:"timestamp" required:"true"` + + // The list of ephemeris status to return. + StatusList []*string `locationName:"statusList" type:"list" enum:"EphemerisStatus"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListEphemeridesInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListEphemeridesInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListEphemeridesInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListEphemeridesInput"} + if s.EndTime == nil { + invalidParams.Add(request.NewErrParamRequired("EndTime")) + } + if s.NextToken != nil && len(*s.NextToken) < 3 { + invalidParams.Add(request.NewErrParamMinLen("NextToken", 3)) + } + if s.SatelliteId == nil { + invalidParams.Add(request.NewErrParamRequired("SatelliteId")) + } + if s.SatelliteId != nil && len(*s.SatelliteId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("SatelliteId", 1)) + } + if s.StartTime == nil { + invalidParams.Add(request.NewErrParamRequired("StartTime")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetEndTime sets the EndTime field's value. +func (s *ListEphemeridesInput) SetEndTime(v time.Time) *ListEphemeridesInput { + s.EndTime = &v + return s +} + +// SetMaxResults sets the MaxResults field's value. +func (s *ListEphemeridesInput) SetMaxResults(v int64) *ListEphemeridesInput { + s.MaxResults = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListEphemeridesInput) SetNextToken(v string) *ListEphemeridesInput { + s.NextToken = &v + return s +} + +// SetSatelliteId sets the SatelliteId field's value. +func (s *ListEphemeridesInput) SetSatelliteId(v string) *ListEphemeridesInput { + s.SatelliteId = &v + return s +} + +// SetStartTime sets the StartTime field's value. +func (s *ListEphemeridesInput) SetStartTime(v time.Time) *ListEphemeridesInput { + s.StartTime = &v + return s +} + +// SetStatusList sets the StatusList field's value. +func (s *ListEphemeridesInput) SetStatusList(v []*string) *ListEphemeridesInput { + s.StatusList = v + return s +} + +type ListEphemeridesOutput struct { + _ struct{} `type:"structure"` + + // List of ephemerides. + Ephemerides []*EphemerisItem `locationName:"ephemerides" min:"1" type:"list"` + + // Pagination token. + NextToken *string `locationName:"nextToken" min:"3" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListEphemeridesOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListEphemeridesOutput) GoString() string { + return s.String() +} + +// SetEphemerides sets the Ephemerides field's value. +func (s *ListEphemeridesOutput) SetEphemerides(v []*EphemerisItem) *ListEphemeridesOutput { + s.Ephemerides = v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListEphemeridesOutput) SetNextToken(v string) *ListEphemeridesOutput { + s.NextToken = &v + return s +} + type ListGroundStationsInput struct { _ struct{} `type:"structure" nopayload:"true"` @@ -5953,10 +7349,10 @@ type ListGroundStationsInput struct { // Next token that can be supplied in the next call to get the next page of // ground stations. - NextToken *string `location:"querystring" locationName:"nextToken" type:"string"` + NextToken *string `location:"querystring" locationName:"nextToken" min:"3" type:"string"` // Satellite ID to retrieve on-boarded ground stations. - SatelliteId *string `location:"querystring" locationName:"satelliteId" type:"string"` + SatelliteId *string `location:"querystring" locationName:"satelliteId" min:"1" type:"string"` } // String returns the string representation. @@ -5977,6 +7373,22 @@ func (s ListGroundStationsInput) GoString() string { return s.String() } +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListGroundStationsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListGroundStationsInput"} + if s.NextToken != nil && len(*s.NextToken) < 3 { + invalidParams.Add(request.NewErrParamMinLen("NextToken", 3)) + } + if s.SatelliteId != nil && len(*s.SatelliteId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("SatelliteId", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + // SetMaxResults sets the MaxResults field's value. func (s *ListGroundStationsInput) SetMaxResults(v int64) *ListGroundStationsInput { s.MaxResults = &v @@ -6003,7 +7415,7 @@ type ListGroundStationsOutput struct { // Next token that can be supplied in the next call to get the next page of // ground stations. - NextToken *string `locationName:"nextToken" type:"string"` + NextToken *string `locationName:"nextToken" min:"3" type:"string"` } // String returns the string representation. @@ -6044,7 +7456,7 @@ type ListMissionProfilesInput struct { // Next token returned in the request of a previous ListMissionProfiles call. // Used to get the next page of results. - NextToken *string `location:"querystring" locationName:"nextToken" type:"string"` + NextToken *string `location:"querystring" locationName:"nextToken" min:"3" type:"string"` } // String returns the string representation. @@ -6065,6 +7477,19 @@ func (s ListMissionProfilesInput) GoString() string { return s.String() } +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListMissionProfilesInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListMissionProfilesInput"} + if s.NextToken != nil && len(*s.NextToken) < 3 { + invalidParams.Add(request.NewErrParamMinLen("NextToken", 3)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + // SetMaxResults sets the MaxResults field's value. func (s *ListMissionProfilesInput) SetMaxResults(v int64) *ListMissionProfilesInput { s.MaxResults = &v @@ -6085,7 +7510,7 @@ type ListMissionProfilesOutput struct { // Next token returned in the response of a previous ListMissionProfiles call. // Used to get the next page of results. - NextToken *string `locationName:"nextToken" type:"string"` + NextToken *string `locationName:"nextToken" min:"3" type:"string"` } // String returns the string representation. @@ -6126,7 +7551,7 @@ type ListSatellitesInput struct { // Next token that can be supplied in the next call to get the next page of // satellites. - NextToken *string `location:"querystring" locationName:"nextToken" type:"string"` + NextToken *string `location:"querystring" locationName:"nextToken" min:"3" type:"string"` } // String returns the string representation. @@ -6147,6 +7572,19 @@ func (s ListSatellitesInput) GoString() string { return s.String() } +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListSatellitesInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListSatellitesInput"} + if s.NextToken != nil && len(*s.NextToken) < 3 { + invalidParams.Add(request.NewErrParamMinLen("NextToken", 3)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + // SetMaxResults sets the MaxResults field's value. func (s *ListSatellitesInput) SetMaxResults(v int64) *ListSatellitesInput { s.MaxResults = &v @@ -6164,7 +7602,7 @@ type ListSatellitesOutput struct { // Next token that can be supplied in the next call to get the next page of // satellites. - NextToken *string `locationName:"nextToken" type:"string"` + NextToken *string `locationName:"nextToken" min:"3" type:"string"` // List of satellites. Satellites []*SatelliteListItem `locationName:"satellites" type:"list"` @@ -6206,7 +7644,7 @@ type ListTagsForResourceInput struct { // ARN of a resource. // // ResourceArn is a required field - ResourceArn *string `location:"uri" locationName:"resourceArn" type:"string" required:"true"` + ResourceArn *string `location:"uri" locationName:"resourceArn" min:"5" type:"string" required:"true"` } // String returns the string representation. @@ -6233,8 +7671,8 @@ func (s *ListTagsForResourceInput) Validate() error { if s.ResourceArn == nil { invalidParams.Add(request.NewErrParamRequired("ResourceArn")) } - if s.ResourceArn != nil && len(*s.ResourceArn) < 1 { - invalidParams.Add(request.NewErrParamMinLen("ResourceArn", 1)) + if s.ResourceArn != nil && len(*s.ResourceArn) < 5 { + invalidParams.Add(request.NewErrParamMinLen("ResourceArn", 5)) } if invalidParams.Len() > 0 { @@ -6288,13 +7726,13 @@ type MissionProfileListItem struct { MissionProfileArn *string `locationName:"missionProfileArn" type:"string"` // UUID of a mission profile. - MissionProfileId *string `locationName:"missionProfileId" type:"string"` + MissionProfileId *string `locationName:"missionProfileId" min:"1" type:"string"` // Name of a mission profile. - Name *string `locationName:"name" type:"string"` + Name *string `locationName:"name" min:"1" type:"string"` // Region of a mission profile. - Region *string `locationName:"region" type:"string"` + Region *string `locationName:"region" min:"1" type:"string"` } // String returns the string representation. @@ -6339,10 +7777,70 @@ func (s *MissionProfileListItem) SetRegion(v string) *MissionProfileListItem { return s } +// Ephemeris data in Orbit Ephemeris Message (OEM) format. +type OEMEphemeris struct { + _ struct{} `type:"structure"` + + // The data for an OEM ephemeris, supplied directly in the request rather than + // through an S3 object. + OemData *string `locationName:"oemData" min:"1" type:"string"` + + // Identifies the S3 object to be used as the ephemeris. + S3Object *S3Object `locationName:"s3Object" type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s OEMEphemeris) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s OEMEphemeris) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *OEMEphemeris) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "OEMEphemeris"} + if s.OemData != nil && len(*s.OemData) < 1 { + invalidParams.Add(request.NewErrParamMinLen("OemData", 1)) + } + if s.S3Object != nil { + if err := s.S3Object.Validate(); err != nil { + invalidParams.AddNested("S3Object", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetOemData sets the OemData field's value. +func (s *OEMEphemeris) SetOemData(v string) *OEMEphemeris { + s.OemData = &v + return s +} + +// SetS3Object sets the S3Object field's value. +func (s *OEMEphemeris) SetS3Object(v *S3Object) *OEMEphemeris { + s.S3Object = v + return s +} + type ReserveContactInput struct { _ struct{} `type:"structure"` - // End time of a contact. + // End time of a contact in UTC. // // EndTime is a required field EndTime *time.Time `locationName:"endTime" type:"timestamp" required:"true"` @@ -6350,7 +7848,7 @@ type ReserveContactInput struct { // Name of a ground station. // // GroundStation is a required field - GroundStation *string `locationName:"groundStation" type:"string" required:"true"` + GroundStation *string `locationName:"groundStation" min:"4" type:"string" required:"true"` // ARN of a mission profile. // @@ -6362,7 +7860,7 @@ type ReserveContactInput struct { // SatelliteArn is a required field SatelliteArn *string `locationName:"satelliteArn" type:"string" required:"true"` - // Start time of a contact. + // Start time of a contact in UTC. // // StartTime is a required field StartTime *time.Time `locationName:"startTime" type:"timestamp" required:"true"` @@ -6398,6 +7896,9 @@ func (s *ReserveContactInput) Validate() error { if s.GroundStation == nil { invalidParams.Add(request.NewErrParamRequired("GroundStation")) } + if s.GroundStation != nil && len(*s.GroundStation) < 4 { + invalidParams.Add(request.NewErrParamMinLen("GroundStation", 4)) + } if s.MissionProfileArn == nil { invalidParams.Add(request.NewErrParamRequired("MissionProfileArn")) } @@ -6454,7 +7955,7 @@ type ReserveContactOutput struct { _ struct{} `type:"structure"` // UUID of a contact. - ContactId *string `locationName:"contactId" type:"string"` + ContactId *string `locationName:"contactId" min:"1" type:"string"` } // String returns the string representation. @@ -6611,6 +8112,75 @@ func (s *ResourceNotFoundException) RequestID() string { return s.RespMetadata.RequestID } +// Object stored in S3 containing ephemeris data. +type S3Object struct { + _ struct{} `type:"structure"` + + // An Amazon S3 Bucket name. + Bucket *string `locationName:"bucket" min:"3" type:"string"` + + // An Amazon S3 key for the ephemeris. + Key *string `locationName:"key" min:"1" type:"string"` + + // For versioned S3 objects, the version to use for the ephemeris. + Version *string `locationName:"version" min:"1" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s S3Object) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s S3Object) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *S3Object) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "S3Object"} + if s.Bucket != nil && len(*s.Bucket) < 3 { + invalidParams.Add(request.NewErrParamMinLen("Bucket", 3)) + } + if s.Key != nil && len(*s.Key) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Key", 1)) + } + if s.Version != nil && len(*s.Version) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Version", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetBucket sets the Bucket field's value. +func (s *S3Object) SetBucket(v string) *S3Object { + s.Bucket = &v + return s +} + +// SetKey sets the Key field's value. +func (s *S3Object) SetKey(v string) *S3Object { + s.Key = &v + return s +} + +// SetVersion sets the Version field's value. +func (s *S3Object) SetVersion(v string) *S3Object { + s.Version = &v + return s +} + // Information about an S3 recording Config. type S3RecordingConfig struct { _ struct{} `type:"structure"` @@ -6691,7 +8261,7 @@ type S3RecordingDetails struct { // ARN of the bucket used. BucketArn *string `locationName:"bucketArn" type:"string"` - // Template of the S3 key used. + // Key template used for the S3 Recording Configuration KeyTemplate *string `locationName:"keyTemplate" type:"string"` } @@ -6729,11 +8299,14 @@ func (s *S3RecordingDetails) SetKeyTemplate(v string) *S3RecordingDetails { type SatelliteListItem struct { _ struct{} `type:"structure"` + // The current ephemeris being used to compute the trajectory of the satellite. + CurrentEphemeris *EphemerisMetaData `locationName:"currentEphemeris" type:"structure"` + // A list of ground stations to which the satellite is on-boarded. GroundStations []*string `locationName:"groundStations" type:"list"` // NORAD satellite ID number. - NoradSatelliteID *int64 `locationName:"noradSatelliteID" min:"1" type:"integer"` + NoradSatelliteID *int64 `locationName:"noradSatelliteID" type:"integer"` // ARN of a satellite. SatelliteArn *string `locationName:"satelliteArn" type:"string"` @@ -6760,6 +8333,12 @@ func (s SatelliteListItem) GoString() string { return s.String() } +// SetCurrentEphemeris sets the CurrentEphemeris field's value. +func (s *SatelliteListItem) SetCurrentEphemeris(v *EphemerisMetaData) *SatelliteListItem { + s.CurrentEphemeris = v + return s +} + // SetGroundStations sets the GroundStations field's value. func (s *SatelliteListItem) SetGroundStations(v []*string) *SatelliteListItem { s.GroundStations = v @@ -6925,8 +8504,7 @@ func (s *SocketAddress) SetPort(v int64) *SocketAddress { type Source struct { _ struct{} `type:"structure"` - // 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 ConfigDetails *ConfigDetails `locationName:"configDetails" type:"structure"` // UUID of a Config. @@ -6935,8 +8513,160 @@ type Source struct { // Type of a Config. ConfigType *string `locationName:"configType" type:"string" enum:"ConfigCapabilityType"` - // Region of a dataflow source. - DataflowSourceRegion *string `locationName:"dataflowSourceRegion" type:"string"` + // Region of a dataflow source. + DataflowSourceRegion *string `locationName:"dataflowSourceRegion" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s Source) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s Source) GoString() string { + return s.String() +} + +// SetConfigDetails sets the ConfigDetails field's value. +func (s *Source) SetConfigDetails(v *ConfigDetails) *Source { + s.ConfigDetails = v + return s +} + +// SetConfigId sets the ConfigId field's value. +func (s *Source) SetConfigId(v string) *Source { + s.ConfigId = &v + return s +} + +// SetConfigType sets the ConfigType field's value. +func (s *Source) SetConfigType(v string) *Source { + s.ConfigType = &v + return s +} + +// SetDataflowSourceRegion sets the DataflowSourceRegion field's value. +func (s *Source) SetDataflowSourceRegion(v string) *Source { + s.DataflowSourceRegion = &v + return s +} + +// Object that describes a spectral Config. +type SpectrumConfig struct { + _ struct{} `type:"structure"` + + // Bandwidth of a spectral Config. AWS Ground Station currently has the following + // bandwidth limitations: + // + // * For AntennaDownlinkDemodDecodeconfig, valid values are between 125 kHz + // to 650 MHz. + // + // * For AntennaDownlinkconfig valid values are between 10 kHz to 54 MHz. + // + // * For AntennaUplinkConfig, valid values are between 10 kHz to 54 MHz. + // + // Bandwidth is a required field + Bandwidth *FrequencyBandwidth `locationName:"bandwidth" type:"structure" required:"true"` + + // Center frequency of a spectral Config. Valid values are between 2200 to 2300 + // MHz and 7750 to 8400 MHz for downlink and 2025 to 2120 MHz for uplink. + // + // CenterFrequency is a required field + CenterFrequency *Frequency `locationName:"centerFrequency" type:"structure" required:"true"` + + // Polarization of a spectral Config. Capturing both "RIGHT_HAND" and "LEFT_HAND" + // polarization requires two separate configs. + Polarization *string `locationName:"polarization" type:"string" enum:"Polarization"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s SpectrumConfig) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s SpectrumConfig) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *SpectrumConfig) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "SpectrumConfig"} + if s.Bandwidth == nil { + invalidParams.Add(request.NewErrParamRequired("Bandwidth")) + } + if s.CenterFrequency == nil { + invalidParams.Add(request.NewErrParamRequired("CenterFrequency")) + } + if s.Bandwidth != nil { + if err := s.Bandwidth.Validate(); err != nil { + invalidParams.AddNested("Bandwidth", err.(request.ErrInvalidParams)) + } + } + if s.CenterFrequency != nil { + if err := s.CenterFrequency.Validate(); err != nil { + invalidParams.AddNested("CenterFrequency", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetBandwidth sets the Bandwidth field's value. +func (s *SpectrumConfig) SetBandwidth(v *FrequencyBandwidth) *SpectrumConfig { + s.Bandwidth = v + return s +} + +// SetCenterFrequency sets the CenterFrequency field's value. +func (s *SpectrumConfig) SetCenterFrequency(v *Frequency) *SpectrumConfig { + s.CenterFrequency = v + return s +} + +// SetPolarization sets the Polarization field's value. +func (s *SpectrumConfig) SetPolarization(v string) *SpectrumConfig { + s.Polarization = &v + return s +} + +// Two-line element set (TLE) data. +type TLEData struct { + _ struct{} `type:"structure"` + + // First line of two-line element set (TLE) data. + // + // TleLine1 is a required field + TleLine1 *string `locationName:"tleLine1" min:"69" type:"string" required:"true"` + + // Second line of two-line element set (TLE) data. + // + // TleLine2 is a required field + TleLine2 *string `locationName:"tleLine2" min:"69" type:"string" required:"true"` + + // The valid time range for the TLE. Gaps or overlap are not permitted. + // + // ValidTimeRange is a required field + ValidTimeRange *TimeRange `locationName:"validTimeRange" type:"structure" required:"true"` } // String returns the string representation. @@ -6944,7 +8674,7 @@ type Source struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s Source) String() string { +func (s TLEData) String() string { return awsutil.Prettify(s) } @@ -6953,60 +8683,68 @@ func (s Source) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s Source) GoString() string { +func (s TLEData) GoString() string { return s.String() } -// SetConfigDetails sets the ConfigDetails field's value. -func (s *Source) SetConfigDetails(v *ConfigDetails) *Source { - s.ConfigDetails = v - return s +// Validate inspects the fields of the type to determine if they are valid. +func (s *TLEData) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "TLEData"} + if s.TleLine1 == nil { + invalidParams.Add(request.NewErrParamRequired("TleLine1")) + } + if s.TleLine1 != nil && len(*s.TleLine1) < 69 { + invalidParams.Add(request.NewErrParamMinLen("TleLine1", 69)) + } + if s.TleLine2 == nil { + invalidParams.Add(request.NewErrParamRequired("TleLine2")) + } + if s.TleLine2 != nil && len(*s.TleLine2) < 69 { + invalidParams.Add(request.NewErrParamMinLen("TleLine2", 69)) + } + if s.ValidTimeRange == nil { + invalidParams.Add(request.NewErrParamRequired("ValidTimeRange")) + } + if s.ValidTimeRange != nil { + if err := s.ValidTimeRange.Validate(); err != nil { + invalidParams.AddNested("ValidTimeRange", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil } -// SetConfigId sets the ConfigId field's value. -func (s *Source) SetConfigId(v string) *Source { - s.ConfigId = &v +// SetTleLine1 sets the TleLine1 field's value. +func (s *TLEData) SetTleLine1(v string) *TLEData { + s.TleLine1 = &v return s } -// SetConfigType sets the ConfigType field's value. -func (s *Source) SetConfigType(v string) *Source { - s.ConfigType = &v +// SetTleLine2 sets the TleLine2 field's value. +func (s *TLEData) SetTleLine2(v string) *TLEData { + s.TleLine2 = &v return s } -// SetDataflowSourceRegion sets the DataflowSourceRegion field's value. -func (s *Source) SetDataflowSourceRegion(v string) *Source { - s.DataflowSourceRegion = &v +// SetValidTimeRange sets the ValidTimeRange field's value. +func (s *TLEData) SetValidTimeRange(v *TimeRange) *TLEData { + s.ValidTimeRange = v return s } -// Object that describes a spectral Config. -type SpectrumConfig struct { +// Two-line element set (TLE) ephemeris. +type TLEEphemeris struct { _ struct{} `type:"structure"` - // Bandwidth of a spectral Config. AWS Ground Station currently has the following - // bandwidth limitations: - // - // * For AntennaDownlinkDemodDecodeconfig, valid values are between 125 kHz - // to 650 MHz. - // - // * For AntennaDownlinkconfig valid values are between 10 kHz to 54 MHz. - // - // * For AntennaUplinkConfig, valid values are between 10 kHz to 54 MHz. - // - // Bandwidth is a required field - Bandwidth *FrequencyBandwidth `locationName:"bandwidth" type:"structure" required:"true"` - - // Center frequency of a spectral Config. Valid values are between 2200 to 2300 - // MHz and 7750 to 8400 MHz for downlink and 2025 to 2120 MHz for uplink. - // - // CenterFrequency is a required field - CenterFrequency *Frequency `locationName:"centerFrequency" type:"structure" required:"true"` + // Identifies the S3 object to be used as the ephemeris. + S3Object *S3Object `locationName:"s3Object" type:"structure"` - // Polarization of a spectral Config. Capturing both "RIGHT_HAND" and "LEFT_HAND" - // polarization requires two separate configs. - Polarization *string `locationName:"polarization" type:"string" enum:"Polarization"` + // The data for a TLE ephemeris, supplied directly in the request rather than + // through an S3 object. + TleData []*TLEData `locationName:"tleData" min:"1" type:"list"` } // String returns the string representation. @@ -7014,7 +8752,7 @@ type SpectrumConfig struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s SpectrumConfig) String() string { +func (s TLEEphemeris) String() string { return awsutil.Prettify(s) } @@ -7023,27 +8761,29 @@ func (s SpectrumConfig) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s SpectrumConfig) GoString() string { +func (s TLEEphemeris) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *SpectrumConfig) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "SpectrumConfig"} - if s.Bandwidth == nil { - invalidParams.Add(request.NewErrParamRequired("Bandwidth")) - } - if s.CenterFrequency == nil { - invalidParams.Add(request.NewErrParamRequired("CenterFrequency")) - } - if s.Bandwidth != nil { - if err := s.Bandwidth.Validate(); err != nil { - invalidParams.AddNested("Bandwidth", err.(request.ErrInvalidParams)) +func (s *TLEEphemeris) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "TLEEphemeris"} + if s.TleData != nil && len(s.TleData) < 1 { + invalidParams.Add(request.NewErrParamMinLen("TleData", 1)) + } + if s.S3Object != nil { + if err := s.S3Object.Validate(); err != nil { + invalidParams.AddNested("S3Object", err.(request.ErrInvalidParams)) } } - if s.CenterFrequency != nil { - if err := s.CenterFrequency.Validate(); err != nil { - invalidParams.AddNested("CenterFrequency", err.(request.ErrInvalidParams)) + if s.TleData != nil { + for i, v := range s.TleData { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "TleData", i), err.(request.ErrInvalidParams)) + } } } @@ -7053,21 +8793,15 @@ func (s *SpectrumConfig) Validate() error { return nil } -// SetBandwidth sets the Bandwidth field's value. -func (s *SpectrumConfig) SetBandwidth(v *FrequencyBandwidth) *SpectrumConfig { - s.Bandwidth = v - return s -} - -// SetCenterFrequency sets the CenterFrequency field's value. -func (s *SpectrumConfig) SetCenterFrequency(v *Frequency) *SpectrumConfig { - s.CenterFrequency = v +// SetS3Object sets the S3Object field's value. +func (s *TLEEphemeris) SetS3Object(v *S3Object) *TLEEphemeris { + s.S3Object = v return s } -// SetPolarization sets the Polarization field's value. -func (s *SpectrumConfig) SetPolarization(v string) *SpectrumConfig { - s.Polarization = &v +// SetTleData sets the TleData field's value. +func (s *TLEEphemeris) SetTleData(v []*TLEData) *TLEEphemeris { + s.TleData = v return s } @@ -7077,7 +8811,7 @@ type TagResourceInput struct { // ARN of a resource tag. // // ResourceArn is a required field - ResourceArn *string `location:"uri" locationName:"resourceArn" type:"string" required:"true"` + ResourceArn *string `location:"uri" locationName:"resourceArn" min:"5" type:"string" required:"true"` // Tags assigned to a resource. // @@ -7109,8 +8843,8 @@ func (s *TagResourceInput) Validate() error { if s.ResourceArn == nil { invalidParams.Add(request.NewErrParamRequired("ResourceArn")) } - if s.ResourceArn != nil && len(*s.ResourceArn) < 1 { - invalidParams.Add(request.NewErrParamMinLen("ResourceArn", 1)) + if s.ResourceArn != nil && len(*s.ResourceArn) < 5 { + invalidParams.Add(request.NewErrParamMinLen("ResourceArn", 5)) } if s.Tags == nil { invalidParams.Add(request.NewErrParamRequired("Tags")) @@ -7156,6 +8890,67 @@ func (s TagResourceOutput) GoString() string { return s.String() } +// A time range with a start and end time. +type TimeRange struct { + _ struct{} `type:"structure"` + + // Time in UTC at which the time range ends. + // + // EndTime is a required field + EndTime *time.Time `locationName:"endTime" type:"timestamp" required:"true"` + + // Time in UTC at which the time range starts. + // + // StartTime is a required field + StartTime *time.Time `locationName:"startTime" type:"timestamp" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s TimeRange) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s TimeRange) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *TimeRange) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "TimeRange"} + if s.EndTime == nil { + invalidParams.Add(request.NewErrParamRequired("EndTime")) + } + if s.StartTime == nil { + invalidParams.Add(request.NewErrParamRequired("StartTime")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetEndTime sets the EndTime field's value. +func (s *TimeRange) SetEndTime(v time.Time) *TimeRange { + s.EndTime = &v + return s +} + +// SetStartTime sets the StartTime field's value. +func (s *TimeRange) SetStartTime(v time.Time) *TimeRange { + s.StartTime = &v + return s +} + // Object that determines whether tracking should be used during a contact executed // with this Config in the mission profile. type TrackingConfig struct { @@ -7210,7 +9005,7 @@ type UntagResourceInput struct { // ARN of a resource. // // ResourceArn is a required field - ResourceArn *string `location:"uri" locationName:"resourceArn" type:"string" required:"true"` + ResourceArn *string `location:"uri" locationName:"resourceArn" min:"5" type:"string" required:"true"` // Keys of a resource tag. // @@ -7242,8 +9037,8 @@ func (s *UntagResourceInput) Validate() error { if s.ResourceArn == nil { invalidParams.Add(request.NewErrParamRequired("ResourceArn")) } - if s.ResourceArn != nil && len(*s.ResourceArn) < 1 { - invalidParams.Add(request.NewErrParamMinLen("ResourceArn", 1)) + if s.ResourceArn != nil && len(*s.ResourceArn) < 5 { + invalidParams.Add(request.NewErrParamMinLen("ResourceArn", 5)) } if s.TagKeys == nil { invalidParams.Add(request.NewErrParamRequired("TagKeys")) @@ -7300,7 +9095,7 @@ type UpdateConfigInput struct { // UUID of a Config. // // ConfigId is a required field - ConfigId *string `location:"uri" locationName:"configId" type:"string" required:"true"` + ConfigId *string `location:"uri" locationName:"configId" min:"1" type:"string" required:"true"` // Type of a Config. // @@ -7440,16 +9235,139 @@ func (s *UpdateConfigOutput) SetConfigType(v string) *UpdateConfigOutput { return s } +type UpdateEphemerisInput struct { + _ struct{} `type:"structure"` + + // Whether the ephemeris is enabled or not. Changing this value will not require + // the ephemeris to be re-validated. + // + // Enabled is a required field + Enabled *bool `locationName:"enabled" type:"boolean" required:"true"` + + // The AWS Ground Station ephemeris ID. + // + // EphemerisId is a required field + EphemerisId *string `location:"uri" locationName:"ephemerisId" min:"1" type:"string" required:"true"` + + // A name string associated with the ephemeris. Used as a human-readable identifier + // for the ephemeris. + Name *string `locationName:"name" min:"1" type:"string"` + + // Customer-provided priority score to establish the order in which overlapping + // ephemerides should be used. + // + // The default for customer-provided ephemeris priority is 1, and higher numbers + // take precedence. + // + // Priority must be 1 or greater + Priority *int64 `locationName:"priority" type:"integer"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UpdateEphemerisInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UpdateEphemerisInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *UpdateEphemerisInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "UpdateEphemerisInput"} + if s.Enabled == nil { + invalidParams.Add(request.NewErrParamRequired("Enabled")) + } + if s.EphemerisId == nil { + invalidParams.Add(request.NewErrParamRequired("EphemerisId")) + } + if s.EphemerisId != nil && len(*s.EphemerisId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("EphemerisId", 1)) + } + if s.Name != nil && len(*s.Name) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Name", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetEnabled sets the Enabled field's value. +func (s *UpdateEphemerisInput) SetEnabled(v bool) *UpdateEphemerisInput { + s.Enabled = &v + return s +} + +// SetEphemerisId sets the EphemerisId field's value. +func (s *UpdateEphemerisInput) SetEphemerisId(v string) *UpdateEphemerisInput { + s.EphemerisId = &v + return s +} + +// SetName sets the Name field's value. +func (s *UpdateEphemerisInput) SetName(v string) *UpdateEphemerisInput { + s.Name = &v + return s +} + +// SetPriority sets the Priority field's value. +func (s *UpdateEphemerisInput) SetPriority(v int64) *UpdateEphemerisInput { + s.Priority = &v + return s +} + +type UpdateEphemerisOutput struct { + _ struct{} `type:"structure"` + + // The AWS Ground Station ephemeris ID. + EphemerisId *string `locationName:"ephemerisId" min:"1" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UpdateEphemerisOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UpdateEphemerisOutput) GoString() string { + return s.String() +} + +// SetEphemerisId sets the EphemerisId field's value. +func (s *UpdateEphemerisOutput) SetEphemerisId(v string) *UpdateEphemerisOutput { + s.EphemerisId = &v + return s +} + type UpdateMissionProfileInput struct { _ struct{} `type:"structure"` // Amount of time after a contact ends that you’d like to receive a CloudWatch // event indicating the pass has finished. - ContactPostPassDurationSeconds *int64 `locationName:"contactPostPassDurationSeconds" min:"1" type:"integer"` + ContactPostPassDurationSeconds *int64 `locationName:"contactPostPassDurationSeconds" type:"integer"` // Amount of time after a contact ends that you’d like to receive a CloudWatch // event indicating the pass has finished. - ContactPrePassDurationSeconds *int64 `locationName:"contactPrePassDurationSeconds" min:"1" type:"integer"` + ContactPrePassDurationSeconds *int64 `locationName:"contactPrePassDurationSeconds" type:"integer"` // A list of lists of ARNs. Each list of ARNs is an edge, with a from Config // and a to Config. @@ -7463,7 +9381,7 @@ type UpdateMissionProfileInput struct { // UUID of a mission profile. // // MissionProfileId is a required field - MissionProfileId *string `location:"uri" locationName:"missionProfileId" type:"string" required:"true"` + MissionProfileId *string `location:"uri" locationName:"missionProfileId" min:"1" type:"string" required:"true"` // Name of a mission profile. Name *string `locationName:"name" min:"1" type:"string"` @@ -7493,12 +9411,6 @@ func (s UpdateMissionProfileInput) GoString() string { // Validate inspects the fields of the type to determine if they are valid. func (s *UpdateMissionProfileInput) Validate() error { invalidParams := request.ErrInvalidParams{Context: "UpdateMissionProfileInput"} - if s.ContactPostPassDurationSeconds != nil && *s.ContactPostPassDurationSeconds < 1 { - invalidParams.Add(request.NewErrParamMinValue("ContactPostPassDurationSeconds", 1)) - } - if s.ContactPrePassDurationSeconds != nil && *s.ContactPrePassDurationSeconds < 1 { - invalidParams.Add(request.NewErrParamMinValue("ContactPrePassDurationSeconds", 1)) - } if s.MinimumViableContactDurationSeconds != nil && *s.MinimumViableContactDurationSeconds < 1 { invalidParams.Add(request.NewErrParamMinValue("MinimumViableContactDurationSeconds", 1)) } @@ -7564,7 +9476,7 @@ type UpdateMissionProfileOutput struct { _ struct{} `type:"structure"` // UUID of a mission profile. - MissionProfileId *string `locationName:"missionProfileId" type:"string"` + MissionProfileId *string `locationName:"missionProfileId" min:"1" type:"string"` } // String returns the string representation. @@ -7910,6 +9822,82 @@ func EndpointStatus_Values() []string { } } +const ( + // EphemerisInvalidReasonMetadataInvalid is a EphemerisInvalidReason enum value + EphemerisInvalidReasonMetadataInvalid = "METADATA_INVALID" + + // EphemerisInvalidReasonTimeRangeInvalid is a EphemerisInvalidReason enum value + EphemerisInvalidReasonTimeRangeInvalid = "TIME_RANGE_INVALID" + + // EphemerisInvalidReasonTrajectoryInvalid is a EphemerisInvalidReason enum value + EphemerisInvalidReasonTrajectoryInvalid = "TRAJECTORY_INVALID" + + // EphemerisInvalidReasonKmsKeyInvalid is a EphemerisInvalidReason enum value + EphemerisInvalidReasonKmsKeyInvalid = "KMS_KEY_INVALID" + + // EphemerisInvalidReasonValidationError is a EphemerisInvalidReason enum value + EphemerisInvalidReasonValidationError = "VALIDATION_ERROR" +) + +// EphemerisInvalidReason_Values returns all elements of the EphemerisInvalidReason enum +func EphemerisInvalidReason_Values() []string { + return []string{ + EphemerisInvalidReasonMetadataInvalid, + EphemerisInvalidReasonTimeRangeInvalid, + EphemerisInvalidReasonTrajectoryInvalid, + EphemerisInvalidReasonKmsKeyInvalid, + EphemerisInvalidReasonValidationError, + } +} + +const ( + // EphemerisSourceCustomerProvided is a EphemerisSource enum value + EphemerisSourceCustomerProvided = "CUSTOMER_PROVIDED" + + // EphemerisSourceSpaceTrack is a EphemerisSource enum value + EphemerisSourceSpaceTrack = "SPACE_TRACK" +) + +// EphemerisSource_Values returns all elements of the EphemerisSource enum +func EphemerisSource_Values() []string { + return []string{ + EphemerisSourceCustomerProvided, + EphemerisSourceSpaceTrack, + } +} + +const ( + // EphemerisStatusValidating is a EphemerisStatus enum value + EphemerisStatusValidating = "VALIDATING" + + // EphemerisStatusInvalid is a EphemerisStatus enum value + EphemerisStatusInvalid = "INVALID" + + // EphemerisStatusError is a EphemerisStatus enum value + EphemerisStatusError = "ERROR" + + // EphemerisStatusEnabled is a EphemerisStatus enum value + EphemerisStatusEnabled = "ENABLED" + + // EphemerisStatusDisabled is a EphemerisStatus enum value + EphemerisStatusDisabled = "DISABLED" + + // EphemerisStatusExpired is a EphemerisStatus enum value + EphemerisStatusExpired = "EXPIRED" +) + +// EphemerisStatus_Values returns all elements of the EphemerisStatus enum +func EphemerisStatus_Values() []string { + return []string{ + EphemerisStatusValidating, + EphemerisStatusInvalid, + EphemerisStatusError, + EphemerisStatusEnabled, + EphemerisStatusDisabled, + EphemerisStatusExpired, + } +} + const ( // FrequencyUnitsGhz is a FrequencyUnits enum value FrequencyUnitsGhz = "GHz" diff --git a/service/groundstation/groundstationiface/interface.go b/service/groundstation/groundstationiface/interface.go index dc3f7bbc955..08e1c657d96 100644 --- a/service/groundstation/groundstationiface/interface.go +++ b/service/groundstation/groundstationiface/interface.go @@ -72,6 +72,10 @@ type GroundStationAPI interface { CreateDataflowEndpointGroupWithContext(aws.Context, *groundstation.CreateDataflowEndpointGroupInput, ...request.Option) (*groundstation.CreateDataflowEndpointGroupOutput, error) CreateDataflowEndpointGroupRequest(*groundstation.CreateDataflowEndpointGroupInput) (*request.Request, *groundstation.CreateDataflowEndpointGroupOutput) + CreateEphemeris(*groundstation.CreateEphemerisInput) (*groundstation.CreateEphemerisOutput, error) + CreateEphemerisWithContext(aws.Context, *groundstation.CreateEphemerisInput, ...request.Option) (*groundstation.CreateEphemerisOutput, error) + CreateEphemerisRequest(*groundstation.CreateEphemerisInput) (*request.Request, *groundstation.CreateEphemerisOutput) + CreateMissionProfile(*groundstation.CreateMissionProfileInput) (*groundstation.CreateMissionProfileOutput, error) CreateMissionProfileWithContext(aws.Context, *groundstation.CreateMissionProfileInput, ...request.Option) (*groundstation.CreateMissionProfileOutput, error) CreateMissionProfileRequest(*groundstation.CreateMissionProfileInput) (*request.Request, *groundstation.CreateMissionProfileOutput) @@ -84,6 +88,10 @@ type GroundStationAPI interface { DeleteDataflowEndpointGroupWithContext(aws.Context, *groundstation.DeleteDataflowEndpointGroupInput, ...request.Option) (*groundstation.DeleteDataflowEndpointGroupOutput, error) DeleteDataflowEndpointGroupRequest(*groundstation.DeleteDataflowEndpointGroupInput) (*request.Request, *groundstation.DeleteDataflowEndpointGroupOutput) + DeleteEphemeris(*groundstation.DeleteEphemerisInput) (*groundstation.DeleteEphemerisOutput, error) + DeleteEphemerisWithContext(aws.Context, *groundstation.DeleteEphemerisInput, ...request.Option) (*groundstation.DeleteEphemerisOutput, error) + DeleteEphemerisRequest(*groundstation.DeleteEphemerisInput) (*request.Request, *groundstation.DeleteEphemerisOutput) + DeleteMissionProfile(*groundstation.DeleteMissionProfileInput) (*groundstation.DeleteMissionProfileOutput, error) DeleteMissionProfileWithContext(aws.Context, *groundstation.DeleteMissionProfileInput, ...request.Option) (*groundstation.DeleteMissionProfileOutput, error) DeleteMissionProfileRequest(*groundstation.DeleteMissionProfileInput) (*request.Request, *groundstation.DeleteMissionProfileOutput) @@ -92,6 +100,10 @@ type GroundStationAPI interface { DescribeContactWithContext(aws.Context, *groundstation.DescribeContactInput, ...request.Option) (*groundstation.DescribeContactOutput, error) DescribeContactRequest(*groundstation.DescribeContactInput) (*request.Request, *groundstation.DescribeContactOutput) + DescribeEphemeris(*groundstation.DescribeEphemerisInput) (*groundstation.DescribeEphemerisOutput, error) + DescribeEphemerisWithContext(aws.Context, *groundstation.DescribeEphemerisInput, ...request.Option) (*groundstation.DescribeEphemerisOutput, error) + DescribeEphemerisRequest(*groundstation.DescribeEphemerisInput) (*request.Request, *groundstation.DescribeEphemerisOutput) + GetConfig(*groundstation.GetConfigInput) (*groundstation.GetConfigOutput, error) GetConfigWithContext(aws.Context, *groundstation.GetConfigInput, ...request.Option) (*groundstation.GetConfigOutput, error) GetConfigRequest(*groundstation.GetConfigInput) (*request.Request, *groundstation.GetConfigOutput) @@ -133,6 +145,13 @@ type GroundStationAPI interface { ListDataflowEndpointGroupsPages(*groundstation.ListDataflowEndpointGroupsInput, func(*groundstation.ListDataflowEndpointGroupsOutput, bool) bool) error ListDataflowEndpointGroupsPagesWithContext(aws.Context, *groundstation.ListDataflowEndpointGroupsInput, func(*groundstation.ListDataflowEndpointGroupsOutput, bool) bool, ...request.Option) error + ListEphemerides(*groundstation.ListEphemeridesInput) (*groundstation.ListEphemeridesOutput, error) + ListEphemeridesWithContext(aws.Context, *groundstation.ListEphemeridesInput, ...request.Option) (*groundstation.ListEphemeridesOutput, error) + ListEphemeridesRequest(*groundstation.ListEphemeridesInput) (*request.Request, *groundstation.ListEphemeridesOutput) + + ListEphemeridesPages(*groundstation.ListEphemeridesInput, func(*groundstation.ListEphemeridesOutput, bool) bool) error + ListEphemeridesPagesWithContext(aws.Context, *groundstation.ListEphemeridesInput, func(*groundstation.ListEphemeridesOutput, bool) bool, ...request.Option) error + ListGroundStations(*groundstation.ListGroundStationsInput) (*groundstation.ListGroundStationsOutput, error) ListGroundStationsWithContext(aws.Context, *groundstation.ListGroundStationsInput, ...request.Option) (*groundstation.ListGroundStationsOutput, error) ListGroundStationsRequest(*groundstation.ListGroundStationsInput) (*request.Request, *groundstation.ListGroundStationsOutput) @@ -174,6 +193,10 @@ type GroundStationAPI interface { UpdateConfigWithContext(aws.Context, *groundstation.UpdateConfigInput, ...request.Option) (*groundstation.UpdateConfigOutput, error) UpdateConfigRequest(*groundstation.UpdateConfigInput) (*request.Request, *groundstation.UpdateConfigOutput) + UpdateEphemeris(*groundstation.UpdateEphemerisInput) (*groundstation.UpdateEphemerisOutput, error) + UpdateEphemerisWithContext(aws.Context, *groundstation.UpdateEphemerisInput, ...request.Option) (*groundstation.UpdateEphemerisOutput, error) + UpdateEphemerisRequest(*groundstation.UpdateEphemerisInput) (*request.Request, *groundstation.UpdateEphemerisOutput) + UpdateMissionProfile(*groundstation.UpdateMissionProfileInput) (*groundstation.UpdateMissionProfileOutput, error) UpdateMissionProfileWithContext(aws.Context, *groundstation.UpdateMissionProfileInput, ...request.Option) (*groundstation.UpdateMissionProfileOutput, error) UpdateMissionProfileRequest(*groundstation.UpdateMissionProfileInput) (*request.Request, *groundstation.UpdateMissionProfileOutput) diff --git a/service/mediapackagevod/api.go b/service/mediapackagevod/api.go index 9025a83a966..1e3fa3f4540 100644 --- a/service/mediapackagevod/api.go +++ b/service/mediapackagevod/api.go @@ -2786,6 +2786,9 @@ type DashPackage struct { // your assets during content playback. IncludeEncoderConfigurationInSegments *bool `locationName:"includeEncoderConfigurationInSegments" type:"boolean"` + // When enabled, an I-Frame only stream will be included in the output. + IncludeIframeOnlyStream *bool `locationName:"includeIframeOnlyStream" type:"boolean"` + // A list of triggers that controls when the outgoing Dynamic Adaptive Streaming // over HTTP (DASH)Media Presentation Description (MPD) will be partitioned // into multiple periods. If empty, the content will notbe partitioned into @@ -2860,6 +2863,12 @@ func (s *DashPackage) SetIncludeEncoderConfigurationInSegments(v bool) *DashPack return s } +// SetIncludeIframeOnlyStream sets the IncludeIframeOnlyStream field's value. +func (s *DashPackage) SetIncludeIframeOnlyStream(v bool) *DashPackage { + s.IncludeIframeOnlyStream = &v + return s +} + // SetPeriodTriggers sets the PeriodTriggers field's value. func (s *DashPackage) SetPeriodTriggers(v []*string) *DashPackage { s.PeriodTriggers = v diff --git a/service/transcribestreamingservice/api.go b/service/transcribestreamingservice/api.go index b9cd393311f..f3442b1ff6f 100644 --- a/service/transcribestreamingservice/api.go +++ b/service/transcribestreamingservice/api.go @@ -95,8 +95,12 @@ func (c *TranscribeStreamingService) StartMedicalStreamTranscriptionRequest(inpu // StartMedicalStreamTranscription API operation for Amazon Transcribe Streaming Service. // -// Starts a bidirectional HTTP/2 stream where audio is streamed to Amazon Transcribe -// Medical and the transcription results are streamed to your application. +// Starts a bidirectional HTTP/2 or WebSocket stream where audio is streamed +// to Amazon Transcribe Medical and the transcription results are streamed to +// your application. +// +// For more information on streaming with Amazon Transcribe Medical, see Transcribing +// streaming audio (https://docs.aws.amazon.com/transcribe/latest/dg/streaming.html). // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -109,26 +113,24 @@ func (c *TranscribeStreamingService) StartMedicalStreamTranscriptionRequest(inpu // // - BadRequestException // One or more arguments to the StartStreamTranscription or StartMedicalStreamTranscription -// operation was invalid. For example, MediaEncoding was not set to a valid -// encoding, or LanguageCode was not set to a valid code. Check the parameters -// and try your request again. +// operation was not valid. For example, MediaEncoding or LanguageCode used +// not valid values. Check the specified parameters and try your request again. // // - LimitExceededException -// You have exceeded the maximum number of concurrent transcription streams, -// are starting transcription streams too quickly, or the maximum audio length -// of 4 hours. Wait until a stream has finished processing, or break your audio -// stream into smaller chunks and try your request again. +// Your client has exceeded one of the Amazon Transcribe limits. This is typically +// the audio length limit. Break your audio stream into smaller chunks and try +// your request again. // // - InternalFailureException -// A problem occurred while processing the audio. Amazon Transcribe or Amazon -// Transcribe Medical terminated processing. Try your request again. +// A problem occurred while processing the audio. Amazon Transcribe terminated +// processing. // // - ConflictException // A new stream started with the same session ID. The current stream has been // terminated. // // - ServiceUnavailableException -// Service is currently unavailable. Try your request later. +// The service is currently unavailable. Try your request later. // // See also, https://docs.aws.amazon.com/goto/WebAPI/transcribe-streaming-2017-10-26/StartMedicalStreamTranscription func (c *TranscribeStreamingService) StartMedicalStreamTranscription(input *StartMedicalStreamTranscriptionInput) (*StartMedicalStreamTranscriptionOutput, error) { @@ -474,21 +476,21 @@ func (c *TranscribeStreamingService) StartStreamTranscriptionRequest(input *Star // StartStreamTranscription API operation for Amazon Transcribe Streaming Service. // -// Starts a bidirectional HTTP/2 stream where audio is streamed to Amazon Transcribe -// and the transcription results are streamed to your application. +// Starts a bidirectional HTTP/2 or WebSocket stream where audio is streamed +// to Amazon Transcribe and the transcription results are streamed to your application. // -// The following are encoded as HTTP/2 headers: +// The following are encoded as headers: // -// - x-amzn-transcribe-language-code +// - language-code // -// - x-amzn-transcribe-media-encoding +// - media-encoding // -// - x-amzn-transcribe-sample-rate +// - sample-rate // -// - x-amzn-transcribe-session-id +// - session-id // -// See the SDK for Go API Reference (https://docs.aws.amazon.com/sdk-for-go/api/service/transcribestreamingservice/#TranscribeStreamingService.StartStreamTranscription) -// for more detail. +// For more information on streaming with Amazon Transcribe, see Transcribing +// streaming audio (https://docs.aws.amazon.com/transcribe/latest/dg/streaming.html). // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -501,26 +503,24 @@ func (c *TranscribeStreamingService) StartStreamTranscriptionRequest(input *Star // // - BadRequestException // One or more arguments to the StartStreamTranscription or StartMedicalStreamTranscription -// operation was invalid. For example, MediaEncoding was not set to a valid -// encoding, or LanguageCode was not set to a valid code. Check the parameters -// and try your request again. +// operation was not valid. For example, MediaEncoding or LanguageCode used +// not valid values. Check the specified parameters and try your request again. // // - LimitExceededException -// You have exceeded the maximum number of concurrent transcription streams, -// are starting transcription streams too quickly, or the maximum audio length -// of 4 hours. Wait until a stream has finished processing, or break your audio -// stream into smaller chunks and try your request again. +// Your client has exceeded one of the Amazon Transcribe limits. This is typically +// the audio length limit. Break your audio stream into smaller chunks and try +// your request again. // // - InternalFailureException -// A problem occurred while processing the audio. Amazon Transcribe or Amazon -// Transcribe Medical terminated processing. Try your request again. +// A problem occurred while processing the audio. Amazon Transcribe terminated +// processing. // // - ConflictException // A new stream started with the same session ID. The current stream has been // terminated. // // - ServiceUnavailableException -// Service is currently unavailable. Try your request later. +// The service is currently unavailable. Try your request later. // // See also, https://docs.aws.amazon.com/goto/WebAPI/transcribe-streaming-2017-10-26/StartStreamTranscription func (c *TranscribeStreamingService) StartStreamTranscription(input *StartStreamTranscriptionInput) (*StartStreamTranscriptionOutput, error) { @@ -793,18 +793,19 @@ func (es *StartStreamTranscriptionEventStream) Err() error { return nil } -// A list of possible transcriptions for the audio. +// A list of possible alternative transcriptions for the input audio. Each alternative +// may contain one or more of Items, Entities, or Transcript. type Alternative struct { _ struct{} `type:"structure"` - // Contains the entities identified as personally identifiable information (PII) - // in the transcription output. + // Contains entities identified as personally identifiable information (PII) + // in your transcription output. Entities []*Entity `type:"list"` - // One or more alternative interpretations of the input audio. + // Contains words, phrases, or punctuation marks in your transcription output. Items []*Item `type:"list"` - // The text that was transcribed from the audio. + // Contains transcribed text. Transcript *string `type:"string"` } @@ -844,12 +845,10 @@ func (s *Alternative) SetTranscript(v string) *Alternative { return s } -// Provides a wrapper for the audio chunks that you are sending. +// A wrapper for your audio chunks. Your audio stream consists of one or more +// audio events, which consist of one or more audio chunks. // -// For information on audio encoding in Amazon Transcribe, see Speech input -// (https://docs.aws.amazon.com/transcribe/latest/dg/input.html). For information -// on audio encoding formats in Amazon Transcribe Medical, see Speech input -// (https://docs.aws.amazon.com/transcribe/latest/dg/input-med.html). +// For more information, see Event stream encoding (https://docs.aws.amazon.com/transcribe/latest/dg/event-stream.html). type AudioEvent struct { _ struct{} `type:"structure" payload:"AudioChunk"` @@ -960,9 +959,8 @@ func eventTypeForAudioStreamEvent(event eventstreamapi.Marshaler) (string, error } // One or more arguments to the StartStreamTranscription or StartMedicalStreamTranscription -// operation was invalid. For example, MediaEncoding was not set to a valid -// encoding, or LanguageCode was not set to a valid code. Check the parameters -// and try your request again. +// operation was not valid. For example, MediaEncoding or LanguageCode used +// not valid values. Check the specified parameters and try your request again. type BadRequestException struct { _ struct{} `type:"structure"` RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` @@ -1155,29 +1153,34 @@ func (s *ConflictException) RequestID() string { return s.RespMetadata.RequestID } -// The entity identified as personally identifiable information (PII). +// Contains entities identified as personally identifiable information (PII) +// in your transcription output, along with various associated attributes. Examples +// include category, confidence score, type, stability score, and start and +// end times. type Entity struct { _ struct{} `type:"structure"` - // The category of information identified in this entity; for example, PII. + // The category of information identified. The only category is PII. Category *string `type:"string"` - // 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. + // The confidence score associated with the identified PII entity in your audio. + // + // Confidence scores are values between 0 and 1. A larger value indicates a + // higher probability that the identified entity correctly matches the entity + // spoken in your media. Confidence *float64 `type:"double"` - // The words in the transcription output that have been identified as a PII - // entity. + // The word or words identified as PII. Content *string `type:"string"` - // The end time of speech that was identified as PII. + // The end time, in milliseconds, of the utterance that was identified as PII. EndTime *float64 `type:"double"` - // The start time of speech that was identified as PII. + // The start time, in milliseconds, of the utterance that was identified as + // PII. StartTime *float64 `type:"double"` - // The type of PII identified in this entity; for example, name or credit card - // number. + // The type of PII identified. For example, NAME or CREDIT_DEBIT_NUMBER. Type *string `type:"string"` } @@ -1235,8 +1238,8 @@ func (s *Entity) SetType(v string) *Entity { return s } -// A problem occurred while processing the audio. Amazon Transcribe or Amazon -// Transcribe Medical terminated processing. Try your request again. +// A problem occurred while processing the audio. Amazon Transcribe terminated +// processing. type InternalFailureException struct { _ struct{} `type:"structure"` RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` @@ -1332,41 +1335,43 @@ func (s *InternalFailureException) RequestID() string { return s.RespMetadata.RequestID } -// A word, phrase, or punctuation mark that is transcribed from the input audio. +// A word, phrase, or punctuation mark in your transcription output, along with +// various associated attributes, such as confidence score, type, and start +// and end times. type Item struct { _ struct{} `type:"structure"` - // A value between zero and one for an item that is a confidence score that - // Amazon Transcribe assigns to each word or phrase that it transcribes. + // The confidence score associated with a word or phrase in your transcript. + // + // Confidence scores are values between 0 and 1. A larger value indicates a + // higher probability that the identified item correctly matches the item spoken + // in your media. Confidence *float64 `type:"double"` - // The word or punctuation that was recognized in the input audio. + // The word or punctuation that was transcribed. Content *string `type:"string"` - // The offset from the beginning of the audio stream to the end of the audio - // that resulted in the item. + // The end time, in milliseconds, of the transcribed item. EndTime *float64 `type:"double"` - // If speaker identification is enabled, shows the speakers identified in the - // media stream. + // If speaker partitioning is enabled, Speaker labels the speaker of the specified + // item. Speaker *string `type:"string"` - // If partial result stabilization has been enabled, indicates whether the word - // or phrase in the item is stable. If Stable is true, the result is stable. + // If partial result stabilization is enabled, Stable indicates whether the + // specified item is stable (true) or if it may change when the segment is complete + // (false). Stable *bool `type:"boolean"` - // The offset from the beginning of the audio stream to the beginning of the - // audio that resulted in the item. + // The start time, in milliseconds, of the transcribed item. StartTime *float64 `type:"double"` - // The type of the item. PRONUNCIATION indicates that the item is a word that - // was recognized in the input audio. PUNCTUATION indicates that the item was - // interpreted as a pause in the input audio. + // The type of item identified. Options are: PRONUNCIATION (spoken words) and + // PUNCTUATION. Type *string `type:"string" enum:"ItemType"` - // Indicates whether a word in the item matches a word in the vocabulary filter - // you've chosen for your media stream. If true then a word in the item matches - // your vocabulary filter. + // Indicates whether the specified item matches a word in the vocabulary filter + // included in your request. If true, there is a vocabulary filter match. VocabularyFilterMatch *bool `type:"boolean"` } @@ -1436,17 +1441,18 @@ func (s *Item) SetVocabularyFilterMatch(v bool) *Item { return s } -// The language codes of the identified languages and their associated confidence -// scores. The confidence score is a value between zero and one; a larger value -// indicates a higher confidence in the identified language. +// The language code that represents the language identified in your audio, +// including the associated confidence score. If you enabled channel identification +// in your request and each channel contained a different language, you will +// have more than one LanguageWithScore result. type LanguageWithScore struct { _ struct{} `type:"structure"` - // The language code of the language identified by Amazon Transcribe. + // The language code of the identified language. LanguageCode *string `type:"string" enum:"LanguageCode"` - // The confidence score for the associated language code. Confidence scores - // are values between zero and one; larger values indicate a higher confidence + // The confidence score associated with the identified language code. Confidence + // scores are values between zero and one; larger values indicate a higher confidence // in the identified language. Score *float64 `type:"double"` } @@ -1481,10 +1487,9 @@ func (s *LanguageWithScore) SetScore(v float64) *LanguageWithScore { return s } -// You have exceeded the maximum number of concurrent transcription streams, -// are starting transcription streams too quickly, or the maximum audio length -// of 4 hours. Wait until a stream has finished processing, or break your audio -// stream into smaller chunks and try your request again. +// Your client has exceeded one of the Amazon Transcribe limits. This is typically +// the audio length limit. Break your audio stream into smaller chunks and try +// your request again. type LimitExceededException struct { _ struct{} `type:"structure"` RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` @@ -1580,19 +1585,19 @@ func (s *LimitExceededException) RequestID() string { return s.RespMetadata.RequestID } -// A list of possible transcriptions for the audio. +// A list of possible alternative transcriptions for the input audio. Each alternative +// may contain one or more of Items, Entities, or Transcript. type MedicalAlternative struct { _ struct{} `type:"structure"` - // Contains the medical entities identified as personal health information in - // the transcription output. + // Contains entities identified as personal health information (PHI) in your + // transcription output. Entities []*MedicalEntity `type:"list"` - // A list of objects that contains words and punctuation marks that represents - // one or more interpretations of the input audio. + // Contains words, phrases, or punctuation marks in your transcription output. Items []*MedicalItem `type:"list"` - // The text that was transcribed from the audio. + // Contains transcribed text. Transcript *string `type:"string"` } @@ -1632,27 +1637,31 @@ func (s *MedicalAlternative) SetTranscript(v string) *MedicalAlternative { return s } -// The medical entity identified as personal health information. +// Contains entities identified as personal health information (PHI) in your +// transcription output, along with various associated attributes. Examples +// include category, confidence score, type, stability score, and start and +// end times. type MedicalEntity struct { _ struct{} `type:"structure"` - // The type of personal health information of the medical entity. + // The category of information identified. The only category is PHI. Category *string `type:"string"` - // A value between zero and one that Amazon Transcribe Medical assigned to the - // personal health information that it identified in the source audio. Larger - // values indicate that Amazon Transcribe Medical has higher confidence in the - // personal health information that it identified. + // The confidence score associated with the identified PHI entity in your audio. + // + // Confidence scores are values between 0 and 1. A larger value indicates a + // higher probability that the identified entity correctly matches the entity + // spoken in your media. Confidence *float64 `type:"double"` - // The word or words in the transcription output that have been identified as - // a medical entity. + // The word or words identified as PHI. Content *string `type:"string"` - // The end time of the speech that was identified as a medical entity. + // The end time, in milliseconds, of the utterance that was identified as PHI. EndTime *float64 `type:"double"` - // The start time of the speech that was identified as a medical entity. + // The start time, in milliseconds, of the utterance that was identified as + // PHI. StartTime *float64 `type:"double"` } @@ -1704,37 +1713,34 @@ func (s *MedicalEntity) SetStartTime(v float64) *MedicalEntity { return s } -// A word, phrase, or punctuation mark that is transcribed from the input audio. +// A word, phrase, or punctuation mark in your transcription output, along with +// various associated attributes, such as confidence score, type, and start +// and end times. type MedicalItem struct { _ struct{} `type:"structure"` - // A value between 0 and 1 for an item that is a confidence score that Amazon - // Transcribe Medical assigns to each word that it transcribes. + // The confidence score associated with a word or phrase in your transcript. + // + // Confidence scores are values between 0 and 1. A larger value indicates a + // higher probability that the identified item correctly matches the item spoken + // in your media. Confidence *float64 `type:"double"` - // The word or punctuation mark that was recognized in the input audio. + // The word or punctuation that was transcribed. Content *string `type:"string"` - // The number of seconds into an audio stream that indicates the creation time - // of an item. + // The end time, in milliseconds, of the transcribed item. EndTime *float64 `type:"double"` - // If speaker identification is enabled, shows the integer values that correspond - // to the different speakers identified in the stream. For example, if the value - // of Speaker in the stream is either a 0 or a 1, that indicates that Amazon - // Transcribe Medical has identified two speakers in the stream. The value of - // 0 corresponds to one speaker and the value of 1 corresponds to the other - // speaker. + // If speaker partitioning is enabled, Speaker labels the speaker of the specified + // item. Speaker *string `type:"string"` - // The number of seconds into an audio stream that indicates the creation time - // of an item. + // The start time, in milliseconds, of the transcribed item. StartTime *float64 `type:"double"` - // The type of the item. PRONUNCIATION indicates that the item is a word that - // was recognized in the input audio. PUNCTUATION indicates that the item was - // interpreted as a pause in the input audio, such as a period to indicate the - // end of a sentence. + // The type of item identified. Options are: PRONUNCIATION (spoken words) and + // PUNCTUATION. Type *string `type:"string" enum:"ItemType"` } @@ -1792,39 +1798,36 @@ func (s *MedicalItem) SetType(v string) *MedicalItem { return s } -// The results of transcribing a portion of the input audio stream. +// The Result associated with a . +// +// Contains a set of transcription results from one or more audio segments, +// along with additional information per your request parameters. This can include +// information relating to alternative transcriptions, channel identification, +// partial result stabilization, language identification, and other transcription-related +// data. type MedicalResult struct { _ struct{} `type:"structure"` - // A list of possible transcriptions of the audio. Each alternative typically - // contains one Item that contains the result of the transcription. + // A list of possible alternative transcriptions for the input audio. Each alternative + // may contain one or more of Items, Entities, or Transcript. Alternatives []*MedicalAlternative `type:"list"` - // When channel identification is enabled, Amazon Transcribe Medical transcribes - // the speech from each audio channel separately. - // - // You can use ChannelId to retrieve the transcription results for a single - // channel in your audio stream. + // Indicates the channel identified for the Result. ChannelId *string `type:"string"` - // The time, in seconds, from the beginning of the audio stream to the end of - // the result. + // The end time, in milliseconds, of the Result. EndTime *float64 `type:"double"` - // Amazon Transcribe Medical divides the incoming audio stream into segments - // at natural points in the audio. Transcription results are returned based - // on these segments. + // Indicates if the segment is complete. // - // The IsPartial field is true to indicate that Amazon Transcribe Medical has - // additional transcription data to send. The IsPartial field is false to indicate - // that this is the last transcription result for the segment. + // If IsPartial is true, the segment is not complete. If IsPartial is false, + // the segment is complete. IsPartial *bool `type:"boolean"` - // A unique identifier for the result. + // Provides a unique identifier for the Result. ResultId *string `type:"string"` - // The time, in seconds, from the beginning of the audio stream to the beginning - // of the result. + // The start time, in milliseconds, of the Result. StartTime *float64 `type:"double"` } @@ -1882,12 +1885,19 @@ func (s *MedicalResult) SetStartTime(v float64) *MedicalResult { return s } -// The medical transcript in a MedicalTranscriptEvent. +// The MedicalTranscript associated with a . +// +// MedicalTranscript contains Results, which contains a set of transcription +// results from one or more audio segments, along with additional information +// per your request parameters. type MedicalTranscript struct { _ struct{} `type:"structure"` - // MedicalResult objects that contain the results of transcribing a portion - // of the input audio stream. The array can be empty. + // Contains a set of transcription results from one or more audio segments, + // along with additional information per your request parameters. This can include + // information relating to alternative transcriptions, channel identification, + // partial result stabilization, language identification, and other transcription-related + // data. Results []*MedicalResult `type:"list"` } @@ -1915,13 +1925,18 @@ func (s *MedicalTranscript) SetResults(v []*MedicalResult) *MedicalTranscript { return s } -// Represents a set of transcription results from the server to the client. -// It contains one or more segments of the transcription. +// The MedicalTranscriptEvent associated with a MedicalTranscriptResultStream. +// +// Contains a set of transcription results from one or more audio segments, +// along with additional information per your request parameters. type MedicalTranscriptEvent struct { _ struct{} `type:"structure"` - // The transcription of the audio stream. The transcription is composed of all - // of the items in the results list. + // Contains Results, which contains a set of transcription results from one + // or more audio segments, along with additional information per your request + // parameters. This can include information relating to alternative transcriptions, + // channel identification, partial result stabilization, language identification, + // and other transcription-related data. Transcript *MedicalTranscript `type:"structure"` } @@ -2140,44 +2155,45 @@ func (e *MedicalTranscriptResultStreamUnknownEvent) UnmarshalEvent( return nil } -// The result of transcribing a portion of the input audio stream. +// The Result associated with a . +// +// Contains a set of transcription results from one or more audio segments, +// along with additional information per your request parameters. This can include +// information relating to alternative transcriptions, channel identification, +// partial result stabilization, language identification, and other transcription-related +// data. type Result struct { _ struct{} `type:"structure"` - // A list of possible transcriptions for the audio. Each alternative typically - // contains one item that contains the result of the transcription. + // A list of possible alternative transcriptions for the input audio. Each alternative + // may contain one or more of Items, Entities, or Transcript. Alternatives []*Alternative `type:"list"` - // When channel identification is enabled, Amazon Transcribe transcribes the - // speech from each audio channel separately. - // - // You can use ChannelId to retrieve the transcription results for a single - // channel in your audio stream. + // Indicates the channel identified for the Result. ChannelId *string `type:"string"` - // The offset in seconds from the beginning of the audio stream to the end of - // the result. + // The end time, in milliseconds, of the Result. EndTime *float64 `type:"double"` - // Amazon Transcribe divides the incoming audio stream into segments at natural - // points in the audio. Transcription results are returned based on these segments. + // Indicates if the segment is complete. // - // The IsPartial field is true to indicate that Amazon Transcribe has additional - // transcription data to send, false to indicate that this is the last transcription - // result for the segment. + // If IsPartial is true, the segment is not complete. If IsPartial is false, + // the segment is complete. IsPartial *bool `type:"boolean"` - // The language code of the identified language in your media stream. + // The language code that represents the language spoken in your audio stream. LanguageCode *string `type:"string" enum:"LanguageCode"` - // The language code of the dominant language identified in your media. + // The language code of the dominant language identified in your stream. + // + // If you enabled channel identification and each channel of your audio contains + // a different language, you may have more than one result. LanguageIdentification []*LanguageWithScore `type:"list"` - // A unique identifier for the result. + // Provides a unique identifier for the Result. ResultId *string `type:"string"` - // The offset in seconds from the beginning of the audio stream to the beginning - // of the result. + // The start time, in milliseconds, of the Result. StartTime *float64 `type:"double"` } @@ -2247,7 +2263,7 @@ func (s *Result) SetStartTime(v float64) *Result { return s } -// Service is currently unavailable. Try your request later. +// The service is currently unavailable. Try your request later. type ServiceUnavailableException struct { _ struct{} `type:"structure"` RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` @@ -2346,64 +2362,87 @@ func (s *ServiceUnavailableException) RequestID() string { type StartMedicalStreamTranscriptionInput struct { _ struct{} `type:"structure" payload:"AudioStream"` - // Set this field to PHI to identify personal health information in the transcription - // output. + // Labels all personal health information (PHI) identified in your transcript. + // + // Content identification is performed at the segment level; PHI is flagged + // upon complete transcription of an audio segment. + // + // For more information, see Identifying personal health information (PHI) in + // a transcription (https://docs.aws.amazon.com/transcribe/latest/dg/phi-id.html). ContentIdentificationType *string `location:"header" locationName:"x-amzn-transcribe-content-identification-type" type:"string" enum:"MedicalContentIdentificationType"` - // When true, instructs Amazon Transcribe Medical to process each audio channel - // separately and then merge the transcription output of each channel into a - // single transcription. + // Enables channel identification in multi-channel audio. // - // Amazon Transcribe Medical also produces a transcription of each item. An - // item includes the start time, end time, and any alternative transcriptions. + // Channel identification transcribes the audio on each channel independently, + // then appends the output for each channel into one transcript. // - // You can't set both ShowSpeakerLabel and EnableChannelIdentification in the - // same request. If you set both, your request returns a BadRequestException. + // If you have multi-channel audio and do not enable channel identification, + // your audio is transcribed in a continuous manner and your transcript is not + // separated by channel. + // + // For more information, see Transcribing multi-channel audio (https://docs.aws.amazon.com/transcribe/latest/dg/channel-id.html). EnableChannelIdentification *bool `location:"header" locationName:"x-amzn-transcribe-enable-channel-identification" type:"boolean"` - // Indicates the source language used in the input audio stream. For Amazon - // Transcribe Medical, this is US English (en-US). + // Specify the language code that represents the language spoken in your audio. + // + // Amazon Transcribe Medical only supports US English (en-US). // // LanguageCode is a required field LanguageCode *string `location:"header" locationName:"x-amzn-transcribe-language-code" type:"string" required:"true" enum:"LanguageCode"` - // The encoding used for the input audio. + // Specify the encoding used for the input audio. Supported formats are: + // + // * FLAC + // + // * OPUS-encoded audio in an Ogg container + // + // * PCM (only signed 16-bit little-endian audio formats, which does not + // include WAV) + // + // For more information, see Media formats (https://docs.aws.amazon.com/transcribe/latest/dg/how-input.html#how-input-audio). // // MediaEncoding is a required field MediaEncoding *string `location:"header" locationName:"x-amzn-transcribe-media-encoding" type:"string" required:"true" enum:"MediaEncoding"` - // The sample rate of the input audio (in Hertz). Amazon Transcribe medical + // The sample rate of the input audio (in hertz). Amazon Transcribe Medical // supports a range from 16,000 Hz to 48,000 Hz. Note that the sample rate you // specify must match that of your audio. // // MediaSampleRateHertz is a required field MediaSampleRateHertz *int64 `location:"header" locationName:"x-amzn-transcribe-sample-rate" min:"8000" type:"integer" required:"true"` - // The number of channels that are in your audio stream. + // Specify the number of channels in your audio stream. Up to two channels are + // supported. NumberOfChannels *int64 `location:"header" locationName:"x-amzn-transcribe-number-of-channels" min:"2" type:"integer"` - // Optional. An identifier for the transcription session. If you don't provide - // a session ID, Amazon Transcribe generates one for you and returns it in the - // response. + // Specify a name for your transcription session. If you don't include this + // parameter in your request, Amazon Transcribe Medical generates an ID and + // returns it in the response. + // + // You can use a session ID to retry a streaming session. SessionId *string `location:"header" locationName:"x-amzn-transcribe-session-id" min:"36" type:"string"` - // When true, enables speaker identification in your real-time stream. + // Enables speaker partitioning (diarization) in your transcription output. + // Speaker partitioning labels the speech from individual speakers in your media + // file. + // + // For more information, see Partitioning speakers (diarization) (https://docs.aws.amazon.com/transcribe/latest/dg/diarization.html). ShowSpeakerLabel *bool `location:"header" locationName:"x-amzn-transcribe-show-speaker-label" type:"boolean"` - // The medical specialty of the clinician or provider. + // Specify the medical specialty contained in your audio. // // Specialty is a required field Specialty *string `location:"header" locationName:"x-amzn-transcribe-specialty" type:"string" required:"true" enum:"Specialty"` - // The type of input audio. Choose DICTATION for a provider dictating patient - // notes. Choose CONVERSATION for a dialogue between a patient and one or more - // medical professionanls. + // Specify the type of input audio. For example, choose DICTATION for a provider + // dictating patient notes and CONVERSATION for a dialogue between a patient + // and a medical professional. // // Type is a required field Type *string `location:"header" locationName:"x-amzn-transcribe-type" type:"string" required:"true" enum:"Type"` - // The name of the medical custom vocabulary to use when processing the real-time - // stream. + // Specify the name of the custom vocabulary that you want to use when processing + // your transcription. Note that vocabulary names are case sensitive. VocabularyName *string `location:"header" locationName:"x-amzn-transcribe-vocabulary-name" min:"1" type:"string"` } @@ -2533,44 +2572,41 @@ type StartMedicalStreamTranscriptionOutput struct { eventStream *StartMedicalStreamTranscriptionEventStream - // If the value is PHI, indicates that you've configured your stream to identify - // personal health information. + // Shows whether content identification was enabled for your transcription. ContentIdentificationType *string `location:"header" locationName:"x-amzn-transcribe-content-identification-type" type:"string" enum:"MedicalContentIdentificationType"` - // Shows whether channel identification has been enabled in the stream. + // Shows whether channel identification was enabled for your transcription. EnableChannelIdentification *bool `location:"header" locationName:"x-amzn-transcribe-enable-channel-identification" type:"boolean"` - // The language code for the response transcript. For Amazon Transcribe Medical, - // this is US English (en-US). + // Provides the language code that you specified in your request. This must + // be en-US. LanguageCode *string `location:"header" locationName:"x-amzn-transcribe-language-code" type:"string" enum:"LanguageCode"` - // The encoding used for the input audio stream. + // Provides the media encoding you specified in your request. MediaEncoding *string `location:"header" locationName:"x-amzn-transcribe-media-encoding" type:"string" enum:"MediaEncoding"` - // The sample rate of the input audio, in Hertz (Hz). + // Provides the sample rate that you specified in your request. MediaSampleRateHertz *int64 `location:"header" locationName:"x-amzn-transcribe-sample-rate" min:"8000" type:"integer"` - // The number of channels identified in the stream. + // Provides the number of channels that you specified in your request. NumberOfChannels *int64 `location:"header" locationName:"x-amzn-transcribe-number-of-channels" min:"2" type:"integer"` - // An identifier for the streaming transcription. + // Provides the identifier for your streaming request. RequestId *string `location:"header" locationName:"x-amzn-request-id" type:"string"` - // Optional. An identifier for the transcription session. If you don't provide - // a session ID, Amazon Transcribe generates one for you and returns it in the - // response. + // Provides the identifier for your transcription session. SessionId *string `location:"header" locationName:"x-amzn-transcribe-session-id" min:"36" type:"string"` - // Shows whether speaker identification was enabled in the stream. + // Shows whether speaker partitioning was enabled for your transcription. ShowSpeakerLabel *bool `location:"header" locationName:"x-amzn-transcribe-show-speaker-label" type:"boolean"` - // The specialty in the medical domain. + // Provides the medical specialty that you specified in your request. Specialty *string `location:"header" locationName:"x-amzn-transcribe-specialty" type:"string" enum:"Specialty"` - // The type of audio that was transcribed. + // Provides the type of audio you specified in your request. Type *string `location:"header" locationName:"x-amzn-transcribe-type" type:"string" enum:"Type"` - // The name of the vocabulary used when processing the stream. + // Provides the name of the custom vocabulary that you specified in your request. VocabularyName *string `location:"header" locationName:"x-amzn-transcribe-vocabulary-name" min:"1" type:"string"` } @@ -2672,63 +2708,121 @@ func (s *StartMedicalStreamTranscriptionOutput) GetStream() *StartMedicalStreamT type StartStreamTranscriptionInput struct { _ struct{} `type:"structure" payload:"AudioStream"` - // Set this field to PII to identify personally identifiable information (PII) - // in the transcription output. Content identification is performed only upon - // complete transcription of the audio segments. + // Labels all personally identifiable information (PII) identified in your transcript. + // + // Content identification is performed at the segment level; PII specified in + // PiiEntityTypes is flagged upon complete transcription of an audio segment. + // + // You can’t set ContentIdentificationType and ContentRedactionType in the + // same request. If you set both, your request returns a BadRequestException. // - // You can’t set both ContentIdentificationType and ContentRedactionType in - // the same request. If you set both, your request returns a BadRequestException. + // For more information, see Redacting or identifying personally identifiable + // information (https://docs.aws.amazon.com/transcribe/latest/dg/pii-redaction.html). ContentIdentificationType *string `location:"header" locationName:"x-amzn-transcribe-content-identification-type" type:"string" enum:"ContentIdentificationType"` - // Set this field to PII to redact personally identifiable information (PII) - // in the transcription output. Content redaction is performed only upon complete - // transcription of the audio segments. + // Redacts all personally identifiable information (PII) identified in your + // transcript. + // + // Content redaction is performed at the segment level; PII specified in PiiEntityTypes + // is redacted upon complete transcription of an audio segment. + // + // You can’t set ContentRedactionType and ContentIdentificationType in the + // same request. If you set both, your request returns a BadRequestException. // - // You can’t set both ContentRedactionType and ContentIdentificationType in - // the same request. If you set both, your request returns a BadRequestException. + // For more information, see Redacting or identifying personally identifiable + // information (https://docs.aws.amazon.com/transcribe/latest/dg/pii-redaction.html). ContentRedactionType *string `location:"header" locationName:"x-amzn-transcribe-content-redaction-type" type:"string" enum:"ContentRedactionType"` - // When true, instructs Amazon Transcribe to process each audio channel separately, - // then merges the transcription output of each channel into a single transcription. + // Enables channel identification in multi-channel audio. // - // Amazon Transcribe also produces a transcription of each item. An item includes - // the start time, end time, and any alternative transcriptions. + // Channel identification transcribes the audio on each channel independently, + // then appends the output for each channel into one transcript. + // + // If you have multi-channel audio and do not enable channel identification, + // your audio is transcribed in a continuous manner and your transcript is not + // separated by channel. + // + // For more information, see Transcribing multi-channel audio (https://docs.aws.amazon.com/transcribe/latest/dg/channel-id.html). EnableChannelIdentification *bool `location:"header" locationName:"x-amzn-transcribe-enable-channel-identification" type:"boolean"` - // When true, instructs Amazon Transcribe to present transcription results that - // have the partial results stabilized. Normally, any word or phrase from one - // partial result can change in a subsequent partial result. With partial results - // stabilization enabled, only the last few words of one partial result can - // change in another partial result. + // Enables partial result stabilization for your transcription. Partial result + // stabilization can reduce latency in your output, but may impact accuracy. + // For more information, see Partial-result stabilization (https://docs.aws.amazon.com/transcribe/latest/dg/streaming.html#streaming-partial-result-stabilization). EnablePartialResultsStabilization *bool `location:"header" locationName:"x-amzn-transcribe-enable-partial-results-stabilization" type:"boolean"` - // Optional. Set this value to true to enable language identification for your - // media stream. + // Enables automatic language identification for your transcription. + // + // If you include IdentifyLanguage, you can optionally include a list of language + // codes, using LanguageOptions, that you think may be present in your audio + // stream. Including language options can improve transcription accuracy. + // + // You can also include a preferred language using PreferredLanguage. Adding + // a preferred language can help Amazon Transcribe identify the language faster + // than if you omit this parameter. + // + // If you have multi-channel audio that contains different languages on each + // channel, and you've enabled channel identification, automatic language identification + // identifies the dominant language on each audio channel. + // + // Note that you must include either LanguageCode or IdentifyLanguage in your + // request. If you include both parameters, your request fails. + // + // Streaming language identification can't be combined with custom language + // models or redaction. IdentifyLanguage *bool `location:"header" locationName:"x-amzn-transcribe-identify-language" type:"boolean"` - // The language code of the input audio stream. + // Specify the language code that represents the language spoken in your audio. + // + // If you're unsure of the language spoken in your audio, consider using IdentifyLanguage + // to enable automatic language identification. + // + // For a list of languages supported with Amazon Transcribe streaming, refer + // to the Supported languages (https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html) + // table. LanguageCode *string `location:"header" locationName:"x-amzn-transcribe-language-code" type:"string" enum:"LanguageCode"` - // The name of the language model you want to use. + // Specify the name of the custom language model that you want to use when processing + // your transcription. Note that language model names are case sensitive. + // + // The language of the specified language model must match the language code + // you specify in your transcription request. If the languages don't match, + // the language model isn't applied. There are no errors or warnings associated + // with a language mismatch. + // + // For more information, see Custom language models (https://docs.aws.amazon.com/transcribe/latest/dg/custom-language-models.html). LanguageModelName *string `location:"header" locationName:"x-amzn-transcribe-language-model-name" min:"1" type:"string"` - // An object containing a list of languages that might be present in your audio. + // Specify two or more language codes that represent the languages you think + // may be present in your media; including more than five is not recommended. + // If you're unsure what languages are present, do not include this parameter. // - // You must provide two or more language codes to help Amazon Transcribe identify - // the correct language of your media stream with the highest possible accuracy. - // You can only select one variant per language; for example, you can't include - // both en-US and en-UK in the same request. + // Including language options can improve the accuracy of language identification. // - // You can only use this parameter if you've set IdentifyLanguage to truein - // your request. + // If you include LanguageOptions in your request, you must also include IdentifyLanguage. + // + // For a list of languages supported with Amazon Transcribe streaming, refer + // to the Supported languages (https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html) + // table. + // + // You can only include one language dialect per language per stream. For example, + // you cannot include en-US and en-AU in the same request. LanguageOptions *string `location:"header" locationName:"x-amzn-transcribe-language-options" min:"1" type:"string"` - // The encoding used for the input audio. + // Specify the encoding used for the input audio. Supported formats are: + // + // * FLAC + // + // * OPUS-encoded audio in an Ogg container + // + // * PCM (only signed 16-bit little-endian audio formats, which does not + // include WAV) + // + // For more information, see Media formats (https://docs.aws.amazon.com/transcribe/latest/dg/how-input.html#how-input-audio). // // MediaEncoding is a required field MediaEncoding *string `location:"header" locationName:"x-amzn-transcribe-media-encoding" type:"string" required:"true" enum:"MediaEncoding"` - // The sample rate of the input audio (in Hertz). Low-quality audio, such as + // The sample rate of the input audio (in hertz). Low-quality audio, such as // telephone audio, is typically around 8,000 Hz. High-quality audio typically // ranges from 16,000 Hz to 48,000 Hz. Note that the sample rate you specify // must match that of your audio. @@ -2736,84 +2830,119 @@ type StartStreamTranscriptionInput struct { // MediaSampleRateHertz is a required field MediaSampleRateHertz *int64 `location:"header" locationName:"x-amzn-transcribe-sample-rate" min:"8000" type:"integer" required:"true"` - // The number of channels that are in your audio stream. + // Specify the number of channels in your audio stream. Up to two channels are + // supported. NumberOfChannels *int64 `location:"header" locationName:"x-amzn-transcribe-number-of-channels" min:"2" type:"integer"` - // You can use this field to set the stability level of the transcription results. - // A higher stability level means that the transcription results are less likely - // to change. Higher stability levels can come with lower overall transcription - // accuracy. + // Specify the level of stability to use when you enable partial results stabilization + // (EnablePartialResultsStabilization). + // + // Low stability provides the highest accuracy. High stability transcribes faster, + // but with slightly lower accuracy. + // + // For more information, see Partial-result stabilization (https://docs.aws.amazon.com/transcribe/latest/dg/streaming.html#streaming-partial-result-stabilization). PartialResultsStability *string `location:"header" locationName:"x-amzn-transcribe-partial-results-stability" type:"string" enum:"PartialResultsStability"` - // List the PII entity types you want to identify or redact. In order to specify - // entity types, you must have either ContentIdentificationType or ContentRedactionType - // enabled. + // Specify which types of personally identifiable information (PII) you want + // to redact in your transcript. You can include as many types as you'd like, + // or you can select ALL. // - // PIIEntityTypes must be comma-separated; the available values are: BANK_ACCOUNT_NUMBER, - // BANK_ROUTING, CREDIT_DEBIT_NUMBER, CREDIT_DEBIT_CVV, CREDIT_DEBIT_EXPIRY, - // PIN, EMAIL, ADDRESS, NAME, PHONE, SSN, and ALL. + // To include PiiEntityTypes in your request, you must also include either ContentIdentificationType + // or ContentRedactionType. // - // PiiEntityTypes is an optional parameter with a default value of ALL. + // Values must be comma-separated and can include: BANK_ACCOUNT_NUMBER, BANK_ROUTING, + // CREDIT_DEBIT_NUMBER, CREDIT_DEBIT_CVV, CREDIT_DEBIT_EXPIRY, PIN, EMAIL, ADDRESS, + // NAME, PHONE, SSN, or ALL. PiiEntityTypes *string `location:"header" locationName:"x-amzn-transcribe-pii-entity-types" min:"1" type:"string"` - // Optional. From the subset of languages codes you provided for LanguageOptions, - // you can select one preferred language for your transcription. + // Specify a preferred language from the subset of languages codes you specified + // in LanguageOptions. // - // You can only use this parameter if you've set IdentifyLanguage to truein - // your request. + // You can only use this parameter if you've included IdentifyLanguage and LanguageOptions + // in your request. PreferredLanguage *string `location:"header" locationName:"x-amzn-transcribe-preferred-language" type:"string" enum:"LanguageCode"` - // A identifier for the transcription session. Use this parameter when you want - // to retry a session. If you don't provide a session ID, Amazon Transcribe - // will generate one for you and return it in the response. + // Specify a name for your transcription session. If you don't include this + // parameter in your request, Amazon Transcribe generates an ID and returns + // it in the response. + // + // You can use a session ID to retry a streaming session. SessionId *string `location:"header" locationName:"x-amzn-transcribe-session-id" min:"36" type:"string"` - // When true, enables speaker identification in your media stream. + // Enables speaker partitioning (diarization) in your transcription output. + // Speaker partitioning labels the speech from individual speakers in your media + // file. + // + // For more information, see Partitioning speakers (diarization) (https://docs.aws.amazon.com/transcribe/latest/dg/diarization.html). ShowSpeakerLabel *bool `location:"header" locationName:"x-amzn-transcribe-show-speaker-label" type:"boolean"` - // The manner in which you use your vocabulary filter to filter words in your - // transcript. Remove removes filtered words from your transcription results. - // Mask masks filtered words with a *** in your transcription results. Tag keeps - // the filtered words in your transcription results and tags them. The tag appears - // as VocabularyFilterMatch equal to True. + // Specify how you want your vocabulary filter applied to your transcript. + // + // To replace words with ***, choose mask. + // + // To delete words, choose remove. + // + // To flag words without changing them, choose tag. VocabularyFilterMethod *string `location:"header" locationName:"x-amzn-transcribe-vocabulary-filter-method" type:"string" enum:"VocabularyFilterMethod"` - // The name of the vocabulary filter you want to use with your transcription. + // Specify the name of the custom vocabulary filter that you want to use when + // processing your transcription. Note that vocabulary filter names are case + // sensitive. + // + // If the language of the specified custom vocabulary filter doesn't match the + // language identified in your media, your job fails. // - // This operation is not intended for use in conjunction with the IdentifyLanguage - // operation. If you're using IdentifyLanguage in your request and want to use - // one or more vocabulary filters with your transcription, use the VocabularyFilterNames - // operation instead. + // This parameter is not intended for use with the IdentifyLanguage parameter. + // If you're including IdentifyLanguage in your request and want to use one + // or more vocabulary filters with your transcription, use the VocabularyFilterNames + // parameter instead. + // + // For more information, see Using vocabulary filtering with unwanted words + // (https://docs.aws.amazon.com/transcribe/latest/dg/vocabulary-filtering.html). VocabularyFilterName *string `location:"header" locationName:"x-amzn-transcribe-vocabulary-filter-name" min:"1" type:"string"` - // The names of the vocabulary filters you want to use with your transcription. + // Specify the names of the custom vocabulary filters that you want to use when + // processing your transcription. Note that vocabulary filter names are case + // sensitive. + // + // If none of the languages of the specified custom vocabulary filters match + // the language identified in your media, your job fails. // - // Note that if the vocabulary filters you specify are in languages that don't - // match the language identified in your media, your job fails. + // This parameter is only intended for use with the IdentifyLanguage parameter. + // If you're not including IdentifyLanguage in your request and want to use + // a custom vocabulary filter with your transcription, use the VocabularyFilterName + // parameter instead. // - // This operation is only intended for use in conjunction with the IdentifyLanguage - // operation. If you're not using IdentifyLanguage in your request and want - // to use a vocabulary filter with your transcription, use the VocabularyFilterName - // operation instead. + // For more information, see Using vocabulary filtering with unwanted words + // (https://docs.aws.amazon.com/transcribe/latest/dg/vocabulary-filtering.html). VocabularyFilterNames *string `location:"header" locationName:"x-amzn-transcribe-vocabulary-filter-names" min:"1" type:"string"` - // The name of the custom vocabulary you want to use with your transcription. + // Specify the name of the custom vocabulary that you want to use when processing + // your transcription. Note that vocabulary names are case sensitive. // - // This operation is not intended for use in conjunction with the IdentifyLanguage - // operation. If you're using IdentifyLanguage in your request and want to use - // one or more custom vocabularies with your transcription, use the VocabularyNames - // operation instead. + // If the language of the specified custom vocabulary doesn't match the language + // identified in your media, your job fails. + // + // This parameter is not intended for use with the IdentifyLanguage parameter. + // If you're including IdentifyLanguage in your request and want to use one + // or more custom vocabularies with your transcription, use the VocabularyNames + // parameter instead. + // + // For more information, see Custom vocabularies (https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary.html). VocabularyName *string `location:"header" locationName:"x-amzn-transcribe-vocabulary-name" min:"1" type:"string"` - // The names of the custom vocabularies you want to use with your transcription. + // Specify the names of the custom vocabularies that you want to use when processing + // your transcription. Note that vocabulary names are case sensitive. // - // Note that if the custom vocabularies you specify are in languages that don't - // match the language identified in your media, your job fails. + // If none of the languages of the specified custom vocabularies match the language + // identified in your media, your job fails. // - // This operation is only intended for use in conjunction with the IdentifyLanguage - // operation. If you're not using IdentifyLanguage in your request and want - // to use a custom vocabulary with your transcription, use the VocabularyName - // operation instead. + // This parameter is only intended for use with the IdentifyLanguage parameter. + // If you're not including IdentifyLanguage in your request and want to use + // a custom vocabulary with your transcription, use the VocabularyName parameter + // instead. + // + // For more information, see Custom vocabularies (https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary.html). VocabularyNames *string `location:"header" locationName:"x-amzn-transcribe-vocabulary-names" min:"1" type:"string"` } @@ -3012,72 +3141,74 @@ type StartStreamTranscriptionOutput struct { eventStream *StartStreamTranscriptionEventStream - // Shows whether content identification was enabled in this stream. + // Shows whether content identification was enabled for your transcription. ContentIdentificationType *string `location:"header" locationName:"x-amzn-transcribe-content-identification-type" type:"string" enum:"ContentIdentificationType"` - // Shows whether content redaction was enabled in this stream. + // Shows whether content redaction was enabled for your transcription. ContentRedactionType *string `location:"header" locationName:"x-amzn-transcribe-content-redaction-type" type:"string" enum:"ContentRedactionType"` - // Shows whether channel identification was enabled in the stream. + // Shows whether channel identification was enabled for your transcription. EnableChannelIdentification *bool `location:"header" locationName:"x-amzn-transcribe-enable-channel-identification" type:"boolean"` - // Shows whether partial results stabilization was enabled in the transcription. + // Shows whether partial results stabilization was enabled for your transcription. EnablePartialResultsStabilization *bool `location:"header" locationName:"x-amzn-transcribe-enable-partial-results-stabilization" type:"boolean"` - // The language code of the language identified in your media stream. + // Shows whether automatic language identification was enabled for your transcription. IdentifyLanguage *bool `location:"header" locationName:"x-amzn-transcribe-identify-language" type:"boolean"` - // The language code of the input audio stream. + // Provides the language code that you specified in your request. LanguageCode *string `location:"header" locationName:"x-amzn-transcribe-language-code" type:"string" enum:"LanguageCode"` - // The name of the custom language model used in the transcription. + // Provides the name of the custom language model that you specified in your + // request. LanguageModelName *string `location:"header" locationName:"x-amzn-transcribe-language-model-name" min:"1" type:"string"` - // The language codes used in the identification of your media stream's predominant - // language. + // Provides the language codes that you specified in your request. LanguageOptions *string `location:"header" locationName:"x-amzn-transcribe-language-options" min:"1" type:"string"` - // The encoding used for the input audio stream. + // Provides the media encoding you specified in your request. MediaEncoding *string `location:"header" locationName:"x-amzn-transcribe-media-encoding" type:"string" enum:"MediaEncoding"` - // The sample rate, in Hertz (Hz), for the input audio stream. + // Provides the sample rate that you specified in your request. MediaSampleRateHertz *int64 `location:"header" locationName:"x-amzn-transcribe-sample-rate" min:"8000" type:"integer"` - // The number of channels identified in the stream. + // Provides the number of channels that you specified in your request. NumberOfChannels *int64 `location:"header" locationName:"x-amzn-transcribe-number-of-channels" min:"2" type:"integer"` - // If partial results stabilization has been enabled in the stream, shows the - // stability level. + // Provides the stabilization level used for your transcription. PartialResultsStability *string `location:"header" locationName:"x-amzn-transcribe-partial-results-stability" type:"string" enum:"PartialResultsStability"` // Lists the PII entity types you specified in your request. PiiEntityTypes *string `location:"header" locationName:"x-amzn-transcribe-pii-entity-types" min:"1" type:"string"` - // The preferred language you specified in your request. + // Provides the preferred language that you specified in your request. PreferredLanguage *string `location:"header" locationName:"x-amzn-transcribe-preferred-language" type:"string" enum:"LanguageCode"` - // An identifier for the transcription. + // Provides the identifier for your streaming request. RequestId *string `location:"header" locationName:"x-amzn-request-id" type:"string"` - // An identifier for a specific transcription session. + // Provides the identifier for your transcription session. SessionId *string `location:"header" locationName:"x-amzn-transcribe-session-id" min:"36" type:"string"` - // Shows whether speaker identification was enabled in the transcription. + // Shows whether speaker partitioning was enabled for your transcription. ShowSpeakerLabel *bool `location:"header" locationName:"x-amzn-transcribe-show-speaker-label" type:"boolean"` - // The vocabulary filtering method used when processing the stream. + // Provides the vocabulary filtering method used in your transcription. VocabularyFilterMethod *string `location:"header" locationName:"x-amzn-transcribe-vocabulary-filter-method" type:"string" enum:"VocabularyFilterMethod"` - // The name of the vocabulary filter used when processing the stream. + // Provides the name of the custom vocabulary filter that you specified in your + // request. VocabularyFilterName *string `location:"header" locationName:"x-amzn-transcribe-vocabulary-filter-name" min:"1" type:"string"` - // The name of the vocabulary filter used when processing the stream. + // Provides the names of the custom vocabulary filters that you specified in + // your request. VocabularyFilterNames *string `location:"header" locationName:"x-amzn-transcribe-vocabulary-filter-names" min:"1" type:"string"` - // The name of the custom vocabulary used when processing the stream. + // Provides the name of the custom vocabulary that you specified in your request. VocabularyName *string `location:"header" locationName:"x-amzn-transcribe-vocabulary-name" min:"1" type:"string"` - // The name of the custom vocabulary used when processing the stream. + // Provides the names of the custom vocabularies that you specified in your + // request. VocabularyNames *string `location:"header" locationName:"x-amzn-transcribe-vocabulary-names" min:"1" type:"string"` } @@ -3236,12 +3367,19 @@ func (s *StartStreamTranscriptionOutput) GetStream() *StartStreamTranscriptionEv return s.eventStream } -// The transcription in a TranscriptEvent. +// The Transcript associated with a . +// +// Transcript contains Results, which contains a set of transcription results +// from one or more audio segments, along with additional information per your +// request parameters. type Transcript struct { _ struct{} `type:"structure"` - // Result objects that contain the results of transcribing a portion of the - // input audio stream. The array can be empty. + // Contains a set of transcription results from one or more audio segments, + // along with additional information per your request parameters. This can include + // information relating to alternative transcriptions, channel identification, + // partial result stabilization, language identification, and other transcription-related + // data. Results []*Result `type:"list"` } @@ -3269,13 +3407,18 @@ func (s *Transcript) SetResults(v []*Result) *Transcript { return s } -// Represents a set of transcription results from the server to the client. -// It contains one or more segments of the transcription. +// The TranscriptEvent associated with a TranscriptResultStream. +// +// Contains a set of transcription results from one or more audio segments, +// along with additional information per your request parameters. type TranscriptEvent struct { _ struct{} `type:"structure"` - // The transcription of the audio stream. The transcription is composed of all - // of the items in the results list. + // Contains Results, which contains a set of transcription results from one + // or more audio segments, along with additional information per your request + // parameters. This can include information relating to alternative transcriptions, + // channel identification, partial result stabilization, language identification, + // and other transcription-related data. Transcript *Transcript `type:"structure"` } @@ -3570,6 +3713,12 @@ const ( // LanguageCodeZhCn is a LanguageCode enum value LanguageCodeZhCn = "zh-CN" + + // LanguageCodeHiIn is a LanguageCode enum value + LanguageCodeHiIn = "hi-IN" + + // LanguageCodeThTh is a LanguageCode enum value + LanguageCodeThTh = "th-TH" ) // LanguageCode_Values returns all elements of the LanguageCode enum @@ -3587,6 +3736,8 @@ func LanguageCode_Values() []string { LanguageCodeJaJp, LanguageCodeKoKr, LanguageCodeZhCn, + LanguageCodeHiIn, + LanguageCodeThTh, } } diff --git a/service/transcribestreamingservice/doc.go b/service/transcribestreamingservice/doc.go index 5725a254bfa..ea442432639 100644 --- a/service/transcribestreamingservice/doc.go +++ b/service/transcribestreamingservice/doc.go @@ -3,7 +3,15 @@ // Package transcribestreamingservice provides the client and types for making API // requests to Amazon Transcribe Streaming Service. // -// Operations and objects for transcribing streaming speech to text. +// Amazon Transcribe streaming offers two types of real-time transcription: +// Standard and Medical. +// +// - Standard transcriptions are the most common option. Refer to for details. +// +// - Medical transcriptions are tailored to medical professionals and incorporate +// medical terms. A common use case for this service is transcribing doctor-patient +// dialogue in real time, so doctors can focus on their patient instead of +// taking notes. Refer to for details. // // See https://docs.aws.amazon.com/goto/WebAPI/transcribe-streaming-2017-10-26 for more information on this service. // diff --git a/service/transcribestreamingservice/errors.go b/service/transcribestreamingservice/errors.go index 5ac62936fcd..2237cf5332f 100644 --- a/service/transcribestreamingservice/errors.go +++ b/service/transcribestreamingservice/errors.go @@ -12,9 +12,8 @@ const ( // "BadRequestException". // // One or more arguments to the StartStreamTranscription or StartMedicalStreamTranscription - // operation was invalid. For example, MediaEncoding was not set to a valid - // encoding, or LanguageCode was not set to a valid code. Check the parameters - // and try your request again. + // operation was not valid. For example, MediaEncoding or LanguageCode used + // not valid values. Check the specified parameters and try your request again. ErrCodeBadRequestException = "BadRequestException" // ErrCodeConflictException for service response error code @@ -27,23 +26,22 @@ const ( // ErrCodeInternalFailureException for service response error code // "InternalFailureException". // - // A problem occurred while processing the audio. Amazon Transcribe or Amazon - // Transcribe Medical terminated processing. Try your request again. + // A problem occurred while processing the audio. Amazon Transcribe terminated + // processing. ErrCodeInternalFailureException = "InternalFailureException" // ErrCodeLimitExceededException for service response error code // "LimitExceededException". // - // You have exceeded the maximum number of concurrent transcription streams, - // are starting transcription streams too quickly, or the maximum audio length - // of 4 hours. Wait until a stream has finished processing, or break your audio - // stream into smaller chunks and try your request again. + // Your client has exceeded one of the Amazon Transcribe limits. This is typically + // the audio length limit. Break your audio stream into smaller chunks and try + // your request again. ErrCodeLimitExceededException = "LimitExceededException" // ErrCodeServiceUnavailableException for service response error code // "ServiceUnavailableException". // - // Service is currently unavailable. Try your request later. + // The service is currently unavailable. Try your request later. ErrCodeServiceUnavailableException = "ServiceUnavailableException" )