diff --git a/gradle.properties b/gradle.properties index 394716d9..dd7f598e 100644 --- a/gradle.properties +++ b/gradle.properties @@ -24,7 +24,6 @@ model.applicationcostprofiler.version=1.0.1 model.apprunner.version=1.0.3 model.appstream.version=1.0.4 model.appsync.version=1.0.2 -model.apptest.version=1.0.2 model.arc-zonal-shift.version=1.0.3 model.artifact.version=1.0.1 model.athena.version=1.0.3 @@ -187,7 +186,6 @@ model.iot-managed-integrations.version=1.0.3 model.iot-wireless.version=1.0.4 model.iotanalytics.version=1.0.2 model.iotdeviceadvisor.version=1.0.2 -model.iotfleethub.version=1.0.1 model.iotfleetwise.version=1.0.3 model.iotsecuretunneling.version=1.0.2 model.iotsitewise.version=1.0.5 @@ -223,8 +221,6 @@ model.license-manager-user-subscriptions.version=1.0.4 model.lightsail.version=1.0.4 model.location.version=1.0.3 model.lookoutequipment.version=1.0.2 -model.lookoutmetrics.version=1.0.1 -model.lookoutvision.version=1.0.2 model.m2.version=1.0.2 model.machine-learning.version=1.0.2 model.macie2.version=1.0.2 @@ -297,8 +293,6 @@ model.proton.version=1.0.2 model.qapps.version=1.0.3 model.qbusiness.version=1.0.5 model.qconnect.version=1.0.3 -model.qldb.version=1.0.2 -model.qldb-session.version=1.0.2 model.quicksight.version=1.0.9 model.ram.version=1.0.1 model.rbin.version=1.0.2 @@ -313,7 +307,6 @@ model.resiliencehub.version=1.0.2 model.resource-explorer-2.version=1.0.2 model.resource-groups.version=1.0.1 model.resource-groups-tagging-api.version=1.0.1 -model.robomaker.version=1.0.2 model.rolesanywhere.version=1.0.2 model.route-53.version=1.0.5 model.route-53-domains.version=1.0.3 diff --git a/models/apptest/service/2022-12-06/apptest-2022-12-06.json b/models/apptest/service/2022-12-06/apptest-2022-12-06.json deleted file mode 100644 index 399cda28..00000000 --- a/models/apptest/service/2022-12-06/apptest-2022-12-06.json +++ /dev/null @@ -1,6244 +0,0 @@ -{ - "smithy": "2.0", - "shapes": { - "com.amazonaws.apptest#AccessDeniedException": { - "type": "structure", - "members": { - "message": { - "target": "smithy.api#String", - "traits": { - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The account or role doesn't have the right permissions to make the request.

", - "smithy.api#error": "client", - "smithy.api#httpError": 403 - } - }, - "com.amazonaws.apptest#Arn": { - "type": "string", - "traits": { - "smithy.api#pattern": "^arn:(aws|aws-cn|aws-iso|aws-iso-[a-z]{1}|aws-us-gov):[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:([a-z]{2}-((iso[a-z]{0,1}-)|(gov-)){0,1}[a-z]+-[0-9]):[0-9]{12}:[A-Za-z0-9/][A-Za-z0-9:_/+=,@.-]{0,1023}$" - } - }, - "com.amazonaws.apptest#AwsApptestControlPlaneService": { - "type": "service", - "version": "2022-12-06", - "operations": [ - { - "target": "com.amazonaws.apptest#ListTagsForResource" - }, - { - "target": "com.amazonaws.apptest#TagResource" - }, - { - "target": "com.amazonaws.apptest#UntagResource" - } - ], - "resources": [ - { - "target": "com.amazonaws.apptest#TestCase" - }, - { - "target": "com.amazonaws.apptest#TestConfiguration" - }, - { - "target": "com.amazonaws.apptest#TestRun" - }, - { - "target": "com.amazonaws.apptest#TestSuite" - } - ], - "traits": { - "aws.api#service": { - "sdkId": "AppTest", - "cloudFormationName": "AppTest", - "cloudTrailEventSource": "apptest.amazonaws.com", - "arnNamespace": "apptest", - "endpointPrefix": "apptest" - }, - "aws.auth#sigv4": { - "name": "apptest" - }, - "aws.iam#defineConditionKeys": { - "aws:ResourceTag/${TagKey}": { - "type": "String", - "documentation": "Filters access by a tag key and value pair of a resource", - "externalDocumentation": "${DocHomeURL}IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-resourcetag" - }, - "aws:RequestTag/${TagKey}": { - "type": "String", - "documentation": "Filters access by a tag key and value pair that is allowed in the request", - "externalDocumentation": "${DocHomeURL}IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-requesttag" - }, - "aws:TagKeys": { - "type": "ArrayOfString", - "documentation": "Filters access by a list of tag keys that are allowed in the request", - "externalDocumentation": "${DocHomeURL}IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-tagkeys" - } - }, - "aws.iam#supportedPrincipalTypes": [ - "Root", - "IAMUser", - "IAMRole", - "FederatedUser" - ], - "aws.protocols#restJson1": {}, - "smithy.api#cors": { - "additionalAllowedHeaders": [ - "*,authorization,date,x-amz-date,x-amz-security-token,x-amz-target,content-type,x-amz-content-sha256,x-amz-user-agent,x-amzn-platform-id,x-amzn-trace-id,amz-sdk-invocation-id,amz-sdk-request" - ] - }, - "smithy.api#documentation": "

AWS Mainframe Modernization Application Testing provides tools and resources for automated functional equivalence testing for your migration projects.

", - "smithy.api#title": "AWS Mainframe Modernization Application Testing", - "smithy.rules#endpointRuleSet": { - "version": "1.0", - "parameters": { - "Region": { - "builtIn": "AWS::Region", - "required": false, - "documentation": "The AWS region used to dispatch the request.", - "type": "string" - }, - "UseDualStack": { - "builtIn": "AWS::UseDualStack", - "required": true, - "default": false, - "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", - "type": "boolean" - }, - "UseFIPS": { - "builtIn": "AWS::UseFIPS", - "required": true, - "default": false, - "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", - "type": "boolean" - }, - "Endpoint": { - "builtIn": "SDK::Endpoint", - "required": false, - "documentation": "Override the endpoint used to send this request", - "type": "string" - } - }, - "rules": [ - { - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Endpoint" - } - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "error": "Invalid Configuration: FIPS and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [], - "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" - } - ], - "type": "tree" - } - ], - "type": "tree" - }, - { - "conditions": [], - "rules": [ - { - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Region" - } - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "aws.partition", - "argv": [ - { - "ref": "Region" - } - ], - "assign": "PartitionResult" - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - }, - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "rules": [ - { - "conditions": [], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://apptest-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - }, - true - ] - } - ], - "rules": [ - { - "conditions": [], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://apptest-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "rules": [ - { - "conditions": [], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://apptest.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://apptest.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - } - ], - "type": "tree" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" - } - ], - "type": "tree" - } - ] - }, - "smithy.rules#endpointTests": { - "testCases": [ - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://apptest-fips.us-east-1.api.aws" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://apptest-fips.us-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://apptest.us-east-1.api.aws" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://apptest.us-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://apptest-fips.cn-north-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://apptest-fips.cn-north-1.amazonaws.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://apptest.cn-north-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://apptest.cn-north-1.amazonaws.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://apptest-fips.us-gov-east-1.api.aws" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://apptest-fips.us-gov-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://apptest.us-gov-east-1.api.aws" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://apptest.us-gov-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://apptest-fips.us-iso-east-1.c2s.ic.gov" - } - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://apptest.us-iso-east-1.c2s.ic.gov" - } - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://apptest-fips.us-isob-east-1.sc2s.sgov.gov" - } - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://apptest.us-isob-east-1.sc2s.sgov.gov" - } - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", - "expect": { - "endpoint": { - "url": "https://example.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": false, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", - "expect": { - "endpoint": { - "url": "https://example.com" - } - }, - "params": { - "UseFIPS": false, - "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": { - "Region": "us-east-1", - "UseFIPS": true, - "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": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": true, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "Missing region", - "expect": { - "error": "Invalid Configuration: Missing Region" - } - } - ], - "version": "1.0" - } - } - }, - "com.amazonaws.apptest#Batch": { - "type": "structure", - "members": { - "batchJobName": { - "target": "com.amazonaws.apptest#Variable", - "traits": { - "smithy.api#documentation": "

The job name of the batch.

", - "smithy.api#required": {} - } - }, - "batchJobParameters": { - "target": "com.amazonaws.apptest#BatchJobParameters", - "traits": { - "smithy.api#documentation": "

The batch job parameters of the batch.

" - } - }, - "exportDataSetNames": { - "target": "com.amazonaws.apptest#ExportDataSetNames", - "traits": { - "smithy.api#documentation": "

The export data set names of the batch.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Defines a batch.

" - } - }, - "com.amazonaws.apptest#BatchJobParameters": { - "type": "map", - "key": { - "target": "smithy.api#String" - }, - "value": { - "target": "smithy.api#String" - } - }, - "com.amazonaws.apptest#BatchStepInput": { - "type": "structure", - "members": { - "resource": { - "target": "com.amazonaws.apptest#MainframeResourceSummary", - "traits": { - "smithy.api#documentation": "

The resource of the batch step input.

", - "smithy.api#required": {} - } - }, - "batchJobName": { - "target": "com.amazonaws.apptest#ResourceName", - "traits": { - "smithy.api#documentation": "

The batch job name of the batch step input.

", - "smithy.api#required": {} - } - }, - "batchJobParameters": { - "target": "com.amazonaws.apptest#BatchJobParameters", - "traits": { - "smithy.api#documentation": "

The batch job parameters of the batch step input.

" - } - }, - "exportDataSetNames": { - "target": "com.amazonaws.apptest#ExportDataSetNames", - "traits": { - "smithy.api#documentation": "

The export data set names of the batch step input.

" - } - }, - "properties": { - "target": "com.amazonaws.apptest#MainframeActionProperties", - "traits": { - "smithy.api#documentation": "

The properties of the batch step input.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Defines a batch step input.

" - } - }, - "com.amazonaws.apptest#BatchStepOutput": { - "type": "structure", - "members": { - "dataSetExportLocation": { - "target": "com.amazonaws.apptest#S3Uri", - "traits": { - "smithy.api#documentation": "

The data set export location of the batch step output.

" - } - }, - "dmsOutputLocation": { - "target": "com.amazonaws.apptest#S3Uri", - "traits": { - "smithy.api#documentation": "

The Database Migration Service (DMS) output location of the batch step output.

" - } - }, - "dataSetDetails": { - "target": "com.amazonaws.apptest#DataSetList", - "traits": { - "smithy.api#documentation": "

The data set details of the batch step output.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Defines a batch step output.

" - } - }, - "com.amazonaws.apptest#BatchSummary": { - "type": "structure", - "members": { - "stepInput": { - "target": "com.amazonaws.apptest#BatchStepInput", - "traits": { - "smithy.api#documentation": "

The step input of the batch summary.

", - "smithy.api#required": {} - } - }, - "stepOutput": { - "target": "com.amazonaws.apptest#BatchStepOutput", - "traits": { - "smithy.api#documentation": "

The step output of the batch summary.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Summarizes a batch job.

" - } - }, - "com.amazonaws.apptest#CaptureTool": { - "type": "enum", - "members": { - "PRECISELY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Precisely" - } - }, - "AWS_DMS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AWS DMS" - } - } - } - }, - "com.amazonaws.apptest#CloudFormation": { - "type": "structure", - "members": { - "templateLocation": { - "target": "com.amazonaws.apptest#S3Uri", - "traits": { - "smithy.api#documentation": "

The template location of the CloudFormation template.

", - "smithy.api#required": {} - } - }, - "parameters": { - "target": "com.amazonaws.apptest#Properties", - "traits": { - "smithy.api#documentation": "

The CloudFormation properties in the CloudFormation template.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Specifies the CloudFormation template and its parameters.

" - } - }, - "com.amazonaws.apptest#CloudFormationAction": { - "type": "structure", - "members": { - "resource": { - "target": "com.amazonaws.apptest#Variable", - "traits": { - "smithy.api#documentation": "

The resource of the CloudFormation action.

", - "smithy.api#required": {} - } - }, - "actionType": { - "target": "com.amazonaws.apptest#CloudFormationActionType", - "traits": { - "smithy.api#documentation": "

The action type of the CloudFormation action.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Specifies the CloudFormation action.

" - } - }, - "com.amazonaws.apptest#CloudFormationActionType": { - "type": "enum", - "members": { - "CREATE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Create" - } - }, - "DELETE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Delete" - } - } - } - }, - "com.amazonaws.apptest#CloudFormationStepSummary": { - "type": "union", - "members": { - "createCloudformation": { - "target": "com.amazonaws.apptest#CreateCloudFormationSummary", - "traits": { - "smithy.api#documentation": "

Creates the CloudFormation summary of the step.

" - } - }, - "deleteCloudformation": { - "target": "com.amazonaws.apptest#DeleteCloudFormationSummary", - "traits": { - "smithy.api#documentation": "

Deletes the CloudFormation summary of the CloudFormation step summary.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Specifies the CloudFormation step summary.

" - } - }, - "com.amazonaws.apptest#CompareAction": { - "type": "structure", - "members": { - "input": { - "target": "com.amazonaws.apptest#Input", - "traits": { - "smithy.api#documentation": "

The input of the compare action.

", - "smithy.api#required": {} - } - }, - "output": { - "target": "com.amazonaws.apptest#Output", - "traits": { - "smithy.api#documentation": "

The output of the compare action.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Compares the action.

" - } - }, - "com.amazonaws.apptest#CompareActionSummary": { - "type": "structure", - "members": { - "type": { - "target": "com.amazonaws.apptest#File", - "traits": { - "smithy.api#documentation": "

The type of the compare action summary.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Specifies the compare action summary.

" - } - }, - "com.amazonaws.apptest#CompareDataSetsStepInput": { - "type": "structure", - "members": { - "sourceLocation": { - "target": "com.amazonaws.apptest#S3Uri", - "traits": { - "smithy.api#documentation": "

The source location of the compare data sets step input location.

", - "smithy.api#required": {} - } - }, - "targetLocation": { - "target": "com.amazonaws.apptest#S3Uri", - "traits": { - "smithy.api#documentation": "

The target location of the compare data sets step input location.

", - "smithy.api#required": {} - } - }, - "sourceDataSets": { - "target": "com.amazonaws.apptest#DataSetList", - "traits": { - "smithy.api#documentation": "

The source data sets of the compare data sets step input location.

", - "smithy.api#required": {} - } - }, - "targetDataSets": { - "target": "com.amazonaws.apptest#DataSetList", - "traits": { - "smithy.api#documentation": "

The target data sets of the compare data sets step input location.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Specifies the compare data sets step input.

" - } - }, - "com.amazonaws.apptest#CompareDataSetsStepOutput": { - "type": "structure", - "members": { - "comparisonOutputLocation": { - "target": "com.amazonaws.apptest#S3Uri", - "traits": { - "smithy.api#documentation": "

The comparison output location of the compare data sets step output.

", - "smithy.api#required": {} - } - }, - "comparisonStatus": { - "target": "com.amazonaws.apptest#ComparisonStatusEnum", - "traits": { - "smithy.api#documentation": "

The comparison status of the compare data sets step output.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Specifies the compare data sets step output.

" - } - }, - "com.amazonaws.apptest#CompareDataSetsSummary": { - "type": "structure", - "members": { - "stepInput": { - "target": "com.amazonaws.apptest#CompareDataSetsStepInput", - "traits": { - "smithy.api#documentation": "

The step input of the compare data sets summary.

", - "smithy.api#required": {} - } - }, - "stepOutput": { - "target": "com.amazonaws.apptest#CompareDataSetsStepOutput", - "traits": { - "smithy.api#documentation": "

The step output of the compare data sets summary.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Compares data sets summary.

" - } - }, - "com.amazonaws.apptest#CompareDatabaseCDCStepInput": { - "type": "structure", - "members": { - "sourceLocation": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

The source location of the compare database CDC step input.

", - "smithy.api#required": {} - } - }, - "targetLocation": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

The target location of the compare database CDC step input.

", - "smithy.api#required": {} - } - }, - "outputLocation": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

The output location of the compare database CDC step input.

" - } - }, - "sourceMetadata": { - "target": "com.amazonaws.apptest#SourceDatabaseMetadata", - "traits": { - "smithy.api#documentation": "

The source metadata of the compare database CDC step input.

", - "smithy.api#required": {} - } - }, - "targetMetadata": { - "target": "com.amazonaws.apptest#TargetDatabaseMetadata", - "traits": { - "smithy.api#documentation": "

The target metadata location of the compare database CDC step input.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Compares the database Change Data Capture (CDC) step input.

" - } - }, - "com.amazonaws.apptest#CompareDatabaseCDCStepOutput": { - "type": "structure", - "members": { - "comparisonOutputLocation": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

The comparison output of the compare database CDC step output.

", - "smithy.api#required": {} - } - }, - "comparisonStatus": { - "target": "com.amazonaws.apptest#ComparisonStatusEnum", - "traits": { - "smithy.api#documentation": "

The comparison status of the compare database CDC step output.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Compares the database CDC step output.

" - } - }, - "com.amazonaws.apptest#CompareDatabaseCDCSummary": { - "type": "structure", - "members": { - "stepInput": { - "target": "com.amazonaws.apptest#CompareDatabaseCDCStepInput", - "traits": { - "smithy.api#documentation": "

The step input of the compare database CDC summary.

", - "smithy.api#required": {} - } - }, - "stepOutput": { - "target": "com.amazonaws.apptest#CompareDatabaseCDCStepOutput", - "traits": { - "smithy.api#documentation": "

The step output of the compare database CDC summary.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Compares the database CDC summary.

" - } - }, - "com.amazonaws.apptest#CompareFileType": { - "type": "union", - "members": { - "datasets": { - "target": "com.amazonaws.apptest#CompareDataSetsSummary", - "traits": { - "smithy.api#documentation": "

The data sets in the compare file type.

" - } - }, - "databaseCDC": { - "target": "com.amazonaws.apptest#CompareDatabaseCDCSummary", - "traits": { - "smithy.api#documentation": "

The database CDC of the compare file type.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Compares the file type.

" - } - }, - "com.amazonaws.apptest#ComparisonStatusEnum": { - "type": "enum", - "members": { - "DIFFERENT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Different" - } - }, - "EQUIVALENT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Equivalent" - } - }, - "EQUAL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Equal" - } - } - } - }, - "com.amazonaws.apptest#ConflictException": { - "type": "structure", - "members": { - "message": { - "target": "smithy.api#String", - "traits": { - "smithy.api#required": {} - } - }, - "resourceId": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

The resource ID of the conflicts with existing resources.

" - } - }, - "resourceType": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

The resource type of the conflicts with existing resources.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The parameters provided in the request conflict with existing resources.

", - "smithy.api#error": "client", - "smithy.api#httpError": 409 - } - }, - "com.amazonaws.apptest#CreateCloudFormationStepInput": { - "type": "structure", - "members": { - "templateLocation": { - "target": "com.amazonaws.apptest#S3Uri", - "traits": { - "smithy.api#documentation": "

The template location of the CloudFormation step input.

", - "smithy.api#required": {} - } - }, - "parameters": { - "target": "com.amazonaws.apptest#Properties", - "traits": { - "smithy.api#documentation": "

The CloudFormation properties of the CloudFormation step input.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Creates the CloudFormation step input.

" - } - }, - "com.amazonaws.apptest#CreateCloudFormationStepOutput": { - "type": "structure", - "members": { - "stackId": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

The stack ID of the CloudFormation step output.

", - "smithy.api#required": {} - } - }, - "exports": { - "target": "com.amazonaws.apptest#Properties", - "traits": { - "smithy.api#documentation": "

The exports of the CloudFormation step output.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Creates a CloudFormation step output.

" - } - }, - "com.amazonaws.apptest#CreateCloudFormationSummary": { - "type": "structure", - "members": { - "stepInput": { - "target": "com.amazonaws.apptest#CreateCloudFormationStepInput", - "traits": { - "smithy.api#documentation": "

The step input of the CloudFormation summary.

", - "smithy.api#required": {} - } - }, - "stepOutput": { - "target": "com.amazonaws.apptest#CreateCloudFormationStepOutput", - "traits": { - "smithy.api#documentation": "

The step output of the CloudFormation summary.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Creates a CloudFormation summary.

" - } - }, - "com.amazonaws.apptest#CreateTestCase": { - "type": "operation", - "input": { - "target": "com.amazonaws.apptest#CreateTestCaseRequest" - }, - "output": { - "target": "com.amazonaws.apptest#CreateTestCaseResponse" - }, - "errors": [ - { - "target": "com.amazonaws.apptest#AccessDeniedException" - }, - { - "target": "com.amazonaws.apptest#ConflictException" - }, - { - "target": "com.amazonaws.apptest#InternalServerException" - }, - { - "target": "com.amazonaws.apptest#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.apptest#ThrottlingException" - }, - { - "target": "com.amazonaws.apptest#ValidationException" - } - ], - "traits": { - "aws.iam#conditionKeys": [ - "aws:RequestTag/${TagKey}", - "aws:TagKeys" - ], - "aws.iam#iamAction": { - "name": "CreateTestCase", - "documentation": "Grants permission to create a test case", - "createsResources": [ - "TestCase" - ] - }, - "smithy.api#documentation": "

Creates a test case.

", - "smithy.api#http": { - "method": "POST", - "uri": "/testcase", - "code": 201 - }, - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.apptest#CreateTestCaseRequest": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.apptest#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the test case.

", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.apptest#ResourceDescription", - "traits": { - "smithy.api#documentation": "

The description of the test case.

" - } - }, - "steps": { - "target": "com.amazonaws.apptest#StepList", - "traits": { - "smithy.api#documentation": "

The steps in the test case.

", - "smithy.api#required": {} - } - }, - "clientToken": { - "target": "com.amazonaws.apptest#IdempotencyTokenString", - "traits": { - "aws.cloudformation#cfnExcludeProperty": {}, - "smithy.api#documentation": "

The client token of the test case.

", - "smithy.api#idempotencyToken": {} - } - }, - "tags": { - "target": "com.amazonaws.apptest#TagMap", - "traits": { - "smithy.api#documentation": "

The specified tags of the test case.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.apptest#CreateTestCaseResponse": { - "type": "structure", - "members": { - "testCaseId": { - "target": "com.amazonaws.apptest#Identifier", - "traits": { - "smithy.api#documentation": "

The test case ID of the test case.

", - "smithy.api#required": {} - } - }, - "testCaseVersion": { - "target": "com.amazonaws.apptest#Version", - "traits": { - "smithy.api#documentation": "

The test case version of the test case.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.apptest#CreateTestConfiguration": { - "type": "operation", - "input": { - "target": "com.amazonaws.apptest#CreateTestConfigurationRequest" - }, - "output": { - "target": "com.amazonaws.apptest#CreateTestConfigurationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.apptest#AccessDeniedException" - }, - { - "target": "com.amazonaws.apptest#ConflictException" - }, - { - "target": "com.amazonaws.apptest#InternalServerException" - }, - { - "target": "com.amazonaws.apptest#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.apptest#ThrottlingException" - }, - { - "target": "com.amazonaws.apptest#ValidationException" - } - ], - "traits": { - "aws.iam#conditionKeys": [ - "aws:RequestTag/${TagKey}", - "aws:TagKeys" - ], - "aws.iam#iamAction": { - "name": "CreateTestConfiguration", - "documentation": "Grants permission to create a test configuration", - "createsResources": [ - "TestConfiguration" - ] - }, - "smithy.api#documentation": "

Creates a test configuration.

", - "smithy.api#http": { - "method": "POST", - "uri": "/testconfiguration", - "code": 201 - }, - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.apptest#CreateTestConfigurationRequest": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.apptest#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the test configuration.

", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.apptest#ResourceDescription", - "traits": { - "smithy.api#documentation": "

The description of the test configuration.

" - } - }, - "resources": { - "target": "com.amazonaws.apptest#ResourceList", - "traits": { - "smithy.api#documentation": "

The defined resources of the test configuration.

", - "smithy.api#required": {} - } - }, - "properties": { - "target": "com.amazonaws.apptest#Properties", - "traits": { - "smithy.api#documentation": "

The properties of the test configuration.

" - } - }, - "clientToken": { - "target": "com.amazonaws.apptest#IdempotencyTokenString", - "traits": { - "aws.cloudformation#cfnExcludeProperty": {}, - "smithy.api#documentation": "

The client token of the test configuration.

", - "smithy.api#idempotencyToken": {} - } - }, - "tags": { - "target": "com.amazonaws.apptest#TagMap", - "traits": { - "smithy.api#documentation": "

The tags of the test configuration.

" - } - }, - "serviceSettings": { - "target": "com.amazonaws.apptest#ServiceSettings", - "traits": { - "smithy.api#documentation": "

The service settings of the test configuration.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.apptest#CreateTestConfigurationResponse": { - "type": "structure", - "members": { - "testConfigurationId": { - "target": "com.amazonaws.apptest#Identifier", - "traits": { - "smithy.api#documentation": "

The test configuration ID.

", - "smithy.api#required": {} - } - }, - "testConfigurationVersion": { - "target": "com.amazonaws.apptest#Version", - "traits": { - "smithy.api#documentation": "

The test configuration version.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.apptest#CreateTestSuite": { - "type": "operation", - "input": { - "target": "com.amazonaws.apptest#CreateTestSuiteRequest" - }, - "output": { - "target": "com.amazonaws.apptest#CreateTestSuiteResponse" - }, - "errors": [ - { - "target": "com.amazonaws.apptest#AccessDeniedException" - }, - { - "target": "com.amazonaws.apptest#ConflictException" - }, - { - "target": "com.amazonaws.apptest#InternalServerException" - }, - { - "target": "com.amazonaws.apptest#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.apptest#ThrottlingException" - }, - { - "target": "com.amazonaws.apptest#ValidationException" - } - ], - "traits": { - "aws.iam#conditionKeys": [ - "aws:RequestTag/${TagKey}", - "aws:TagKeys" - ], - "aws.iam#iamAction": { - "name": "CreateTestSuite", - "documentation": "Grants permission to create a test suite", - "createsResources": [ - "TestSuite" - ] - }, - "smithy.api#documentation": "

Creates a test suite.

", - "smithy.api#http": { - "method": "POST", - "uri": "/testsuite", - "code": 201 - }, - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.apptest#CreateTestSuiteRequest": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.apptest#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the test suite.

", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.apptest#ResourceDescription", - "traits": { - "smithy.api#documentation": "

The description of the test suite.

" - } - }, - "beforeSteps": { - "target": "com.amazonaws.apptest#StepList", - "traits": { - "smithy.api#documentation": "

The before steps of the test suite.

" - } - }, - "afterSteps": { - "target": "com.amazonaws.apptest#StepList", - "traits": { - "smithy.api#documentation": "

The after steps of the test suite.

" - } - }, - "testCases": { - "target": "com.amazonaws.apptest#TestCases", - "traits": { - "smithy.api#documentation": "

The test cases in the test suite.

", - "smithy.api#required": {} - } - }, - "clientToken": { - "target": "com.amazonaws.apptest#IdempotencyTokenString", - "traits": { - "aws.cloudformation#cfnExcludeProperty": {}, - "smithy.api#documentation": "

The client token of the test suite.

", - "smithy.api#idempotencyToken": {} - } - }, - "tags": { - "target": "com.amazonaws.apptest#TagMap", - "traits": { - "smithy.api#documentation": "

The tags of the test suite.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.apptest#CreateTestSuiteResponse": { - "type": "structure", - "members": { - "testSuiteId": { - "target": "com.amazonaws.apptest#Identifier", - "traits": { - "smithy.api#documentation": "

The suite ID of the test suite.

", - "smithy.api#required": {} - } - }, - "testSuiteVersion": { - "target": "com.amazonaws.apptest#Version", - "traits": { - "smithy.api#documentation": "

The suite version of the test suite.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.apptest#DataSet": { - "type": "structure", - "members": { - "type": { - "target": "com.amazonaws.apptest#DataSetType", - "traits": { - "smithy.api#documentation": "

The type of the data set.

", - "smithy.api#required": {} - } - }, - "name": { - "target": "com.amazonaws.apptest#String100", - "traits": { - "smithy.api#documentation": "

The name of the data set.

", - "smithy.api#required": {} - } - }, - "ccsid": { - "target": "com.amazonaws.apptest#String50", - "traits": { - "smithy.api#documentation": "

The CCSID of the data set.

", - "smithy.api#required": {} - } - }, - "format": { - "target": "com.amazonaws.apptest#Format", - "traits": { - "smithy.api#documentation": "

The format of the data set.

", - "smithy.api#required": {} - } - }, - "length": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#documentation": "

The length of the data set.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Defines a data set.

" - } - }, - "com.amazonaws.apptest#DataSetList": { - "type": "list", - "member": { - "target": "com.amazonaws.apptest#DataSet" - } - }, - "com.amazonaws.apptest#DataSetType": { - "type": "enum", - "members": { - "PS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PS" - } - } - } - }, - "com.amazonaws.apptest#DatabaseCDC": { - "type": "structure", - "members": { - "sourceMetadata": { - "target": "com.amazonaws.apptest#SourceDatabaseMetadata", - "traits": { - "smithy.api#documentation": "

The source metadata of the database CDC.

", - "smithy.api#required": {} - } - }, - "targetMetadata": { - "target": "com.amazonaws.apptest#TargetDatabaseMetadata", - "traits": { - "smithy.api#documentation": "

The target metadata of the database CDC.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Defines the Change Data Capture (CDC) of the database.

" - } - }, - "com.amazonaws.apptest#DeleteCloudFormationStepInput": { - "type": "structure", - "members": { - "stackId": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

The stack ID of the deleted CloudFormation step input.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Deletes the CloudFormation step input.

" - } - }, - "com.amazonaws.apptest#DeleteCloudFormationStepOutput": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#documentation": "

Deletes the CloudFormation summary step output.

" - } - }, - "com.amazonaws.apptest#DeleteCloudFormationSummary": { - "type": "structure", - "members": { - "stepInput": { - "target": "com.amazonaws.apptest#DeleteCloudFormationStepInput", - "traits": { - "smithy.api#documentation": "

The step input of the deleted CloudFormation summary.

", - "smithy.api#required": {} - } - }, - "stepOutput": { - "target": "com.amazonaws.apptest#DeleteCloudFormationStepOutput", - "traits": { - "smithy.api#documentation": "

The step output of the deleted CloudFormation summary.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Deletes the CloudFormation summary.

" - } - }, - "com.amazonaws.apptest#DeleteTestCase": { - "type": "operation", - "input": { - "target": "com.amazonaws.apptest#DeleteTestCaseRequest" - }, - "output": { - "target": "com.amazonaws.apptest#DeleteTestCaseResponse" - }, - "errors": [ - { - "target": "com.amazonaws.apptest#AccessDeniedException" - }, - { - "target": "com.amazonaws.apptest#ConflictException" - }, - { - "target": "com.amazonaws.apptest#InternalServerException" - }, - { - "target": "com.amazonaws.apptest#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.apptest#ThrottlingException" - }, - { - "target": "com.amazonaws.apptest#ValidationException" - } - ], - "traits": { - "aws.iam#iamAction": { - "name": "DeleteTestCase", - "documentation": "Grants permission to delete a test case" - }, - "smithy.api#documentation": "

Deletes a test case.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/testcases/{testCaseId}", - "code": 204 - }, - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.apptest#DeleteTestCaseRequest": { - "type": "structure", - "members": { - "testCaseId": { - "target": "com.amazonaws.apptest#Identifier", - "traits": { - "smithy.api#documentation": "

The test case ID of the test case.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.apptest#DeleteTestCaseResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.apptest#DeleteTestConfiguration": { - "type": "operation", - "input": { - "target": "com.amazonaws.apptest#DeleteTestConfigurationRequest" - }, - "output": { - "target": "com.amazonaws.apptest#DeleteTestConfigurationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.apptest#AccessDeniedException" - }, - { - "target": "com.amazonaws.apptest#ConflictException" - }, - { - "target": "com.amazonaws.apptest#InternalServerException" - }, - { - "target": "com.amazonaws.apptest#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.apptest#ThrottlingException" - }, - { - "target": "com.amazonaws.apptest#ValidationException" - } - ], - "traits": { - "aws.iam#iamAction": { - "name": "DeleteTestConfiguration", - "documentation": "Grants permission to delete a test configuration" - }, - "smithy.api#documentation": "

Deletes a test configuration.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/testconfigurations/{testConfigurationId}", - "code": 204 - }, - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.apptest#DeleteTestConfigurationRequest": { - "type": "structure", - "members": { - "testConfigurationId": { - "target": "com.amazonaws.apptest#Identifier", - "traits": { - "smithy.api#documentation": "

The test ID of the test configuration.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.apptest#DeleteTestConfigurationResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.apptest#DeleteTestRun": { - "type": "operation", - "input": { - "target": "com.amazonaws.apptest#DeleteTestRunRequest" - }, - "output": { - "target": "com.amazonaws.apptest#DeleteTestRunResponse" - }, - "errors": [ - { - "target": "com.amazonaws.apptest#AccessDeniedException" - }, - { - "target": "com.amazonaws.apptest#ConflictException" - }, - { - "target": "com.amazonaws.apptest#InternalServerException" - }, - { - "target": "com.amazonaws.apptest#ThrottlingException" - }, - { - "target": "com.amazonaws.apptest#ValidationException" - } - ], - "traits": { - "aws.iam#iamAction": { - "name": "DeleteTestRun", - "documentation": "Grants permission to delete a test run", - "requiredActions": [ - "s3:DeleteObjects", - "s3:ListObjectsV2" - ] - }, - "smithy.api#documentation": "

Deletes a test run.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/testruns/{testRunId}", - "code": 204 - }, - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.apptest#DeleteTestRunRequest": { - "type": "structure", - "members": { - "testRunId": { - "target": "com.amazonaws.apptest#Identifier", - "traits": { - "smithy.api#documentation": "

The run ID of the test run.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.apptest#DeleteTestRunResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.apptest#DeleteTestSuite": { - "type": "operation", - "input": { - "target": "com.amazonaws.apptest#DeleteTestSuiteRequest" - }, - "output": { - "target": "com.amazonaws.apptest#DeleteTestSuiteResponse" - }, - "errors": [ - { - "target": "com.amazonaws.apptest#AccessDeniedException" - }, - { - "target": "com.amazonaws.apptest#ConflictException" - }, - { - "target": "com.amazonaws.apptest#InternalServerException" - }, - { - "target": "com.amazonaws.apptest#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.apptest#ThrottlingException" - }, - { - "target": "com.amazonaws.apptest#ValidationException" - } - ], - "traits": { - "aws.iam#iamAction": { - "name": "DeleteTestSuite", - "documentation": "Grants permission to delete a test suite" - }, - "smithy.api#documentation": "

Deletes a test suite.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/testsuites/{testSuiteId}", - "code": 204 - }, - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.apptest#DeleteTestSuiteRequest": { - "type": "structure", - "members": { - "testSuiteId": { - "target": "com.amazonaws.apptest#Identifier", - "traits": { - "smithy.api#documentation": "

The test ID of the test suite.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.apptest#DeleteTestSuiteResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.apptest#ExportDataSetNames": { - "type": "list", - "member": { - "target": "com.amazonaws.apptest#String100" - } - }, - "com.amazonaws.apptest#File": { - "type": "union", - "members": { - "fileType": { - "target": "com.amazonaws.apptest#CompareFileType", - "traits": { - "smithy.api#documentation": "

The file type of the file.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Defines a file.

" - } - }, - "com.amazonaws.apptest#FileMetadata": { - "type": "union", - "members": { - "dataSets": { - "target": "com.amazonaws.apptest#DataSetList", - "traits": { - "smithy.api#documentation": "

The data sets of the file metadata.

" - } - }, - "databaseCDC": { - "target": "com.amazonaws.apptest#DatabaseCDC", - "traits": { - "smithy.api#documentation": "

The database CDC of the file metadata.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Specifies a file metadata.

" - } - }, - "com.amazonaws.apptest#Format": { - "type": "enum", - "members": { - "FIXED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FIXED" - } - }, - "VARIABLE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "VARIABLE" - } - }, - "LINE_SEQUENTIAL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LINE_SEQUENTIAL" - } - } - } - }, - "com.amazonaws.apptest#GetTestCase": { - "type": "operation", - "input": { - "target": "com.amazonaws.apptest#GetTestCaseRequest" - }, - "output": { - "target": "com.amazonaws.apptest#GetTestCaseResponse" - }, - "errors": [ - { - "target": "com.amazonaws.apptest#AccessDeniedException" - }, - { - "target": "com.amazonaws.apptest#InternalServerException" - }, - { - "target": "com.amazonaws.apptest#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.apptest#ThrottlingException" - }, - { - "target": "com.amazonaws.apptest#ValidationException" - } - ], - "traits": { - "aws.iam#iamAction": { - "name": "GetTestCase", - "documentation": "Grants permission to get a test case" - }, - "smithy.api#documentation": "

Gets a test case.

", - "smithy.api#http": { - "method": "GET", - "uri": "/testcases/{testCaseId}", - "code": 200 - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.apptest#GetTestCaseRequest": { - "type": "structure", - "members": { - "testCaseId": { - "target": "com.amazonaws.apptest#Identifier", - "traits": { - "smithy.api#documentation": "

The request test ID of the test case.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "testCaseVersion": { - "target": "com.amazonaws.apptest#Version", - "traits": { - "smithy.api#documentation": "

The test case version of the test case.

", - "smithy.api#httpQuery": "testCaseVersion" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.apptest#GetTestCaseResponse": { - "type": "structure", - "members": { - "testCaseId": { - "target": "com.amazonaws.apptest#Identifier", - "traits": { - "smithy.api#documentation": "

The response test ID of the test case.

", - "smithy.api#required": {} - } - }, - "testCaseArn": { - "target": "com.amazonaws.apptest#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the test case.

", - "smithy.api#required": {} - } - }, - "name": { - "target": "com.amazonaws.apptest#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the test case.

", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.apptest#ResourceDescription", - "traits": { - "smithy.api#documentation": "

The description of the test case.

" - } - }, - "latestVersion": { - "target": "com.amazonaws.apptest#TestCaseLatestVersion", - "traits": { - "smithy.api#documentation": "

The latest version of the test case.

", - "smithy.api#required": {} - } - }, - "testCaseVersion": { - "target": "com.amazonaws.apptest#Version", - "traits": { - "smithy.api#documentation": "

The case version of the test case.

", - "smithy.api#required": {} - } - }, - "status": { - "target": "com.amazonaws.apptest#TestCaseLifecycle", - "traits": { - "smithy.api#documentation": "

The status of the test case.

", - "smithy.api#required": {} - } - }, - "statusReason": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

The status reason of the test case.

" - } - }, - "creationTime": { - "target": "smithy.api#Timestamp", - "traits": { - "smithy.api#documentation": "

The creation time of the test case.

", - "smithy.api#required": {} - } - }, - "lastUpdateTime": { - "target": "smithy.api#Timestamp", - "traits": { - "smithy.api#documentation": "

The last update time of the test case.

", - "smithy.api#required": {} - } - }, - "steps": { - "target": "com.amazonaws.apptest#StepList", - "traits": { - "smithy.api#documentation": "

The steps of the test case.

", - "smithy.api#required": {} - } - }, - "tags": { - "target": "com.amazonaws.apptest#TagMap", - "traits": { - "smithy.api#documentation": "

The tags of the test case.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.apptest#GetTestConfiguration": { - "type": "operation", - "input": { - "target": "com.amazonaws.apptest#GetTestConfigurationRequest" - }, - "output": { - "target": "com.amazonaws.apptest#GetTestConfigurationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.apptest#AccessDeniedException" - }, - { - "target": "com.amazonaws.apptest#InternalServerException" - }, - { - "target": "com.amazonaws.apptest#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.apptest#ThrottlingException" - }, - { - "target": "com.amazonaws.apptest#ValidationException" - } - ], - "traits": { - "aws.iam#iamAction": { - "name": "GetTestConfiguration", - "documentation": "Grants permission to get a test configuration" - }, - "smithy.api#documentation": "

Gets a test configuration.

", - "smithy.api#http": { - "method": "GET", - "uri": "/testconfigurations/{testConfigurationId}", - "code": 200 - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.apptest#GetTestConfigurationRequest": { - "type": "structure", - "members": { - "testConfigurationId": { - "target": "com.amazonaws.apptest#Identifier", - "traits": { - "smithy.api#documentation": "

The request test configuration ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "testConfigurationVersion": { - "target": "com.amazonaws.apptest#Version", - "traits": { - "smithy.api#documentation": "

The test configuration version.

", - "smithy.api#httpQuery": "testConfigurationVersion" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.apptest#GetTestConfigurationResponse": { - "type": "structure", - "members": { - "testConfigurationId": { - "target": "com.amazonaws.apptest#Identifier", - "traits": { - "smithy.api#documentation": "

The response test configuration ID.

", - "smithy.api#required": {} - } - }, - "name": { - "target": "com.amazonaws.apptest#ResourceName", - "traits": { - "smithy.api#documentation": "

The test configuration name

", - "smithy.api#required": {} - } - }, - "testConfigurationArn": { - "target": "com.amazonaws.apptest#Arn", - "traits": { - "smithy.api#documentation": "

The test configuration Amazon Resource Name (ARN).

", - "smithy.api#required": {} - } - }, - "latestVersion": { - "target": "com.amazonaws.apptest#TestConfigurationLatestVersion", - "traits": { - "smithy.api#documentation": "

The latest version of the test configuration.

", - "smithy.api#required": {} - } - }, - "testConfigurationVersion": { - "target": "com.amazonaws.apptest#Version", - "traits": { - "smithy.api#documentation": "

The test configuration version.

", - "smithy.api#required": {} - } - }, - "status": { - "target": "com.amazonaws.apptest#TestConfigurationLifecycle", - "traits": { - "smithy.api#documentation": "

The status of the test configuration.

", - "smithy.api#required": {} - } - }, - "statusReason": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

The status reason of the test configuration.

" - } - }, - "creationTime": { - "target": "smithy.api#Timestamp", - "traits": { - "smithy.api#documentation": "

The creation time of the test configuration.

", - "smithy.api#required": {} - } - }, - "lastUpdateTime": { - "target": "smithy.api#Timestamp", - "traits": { - "smithy.api#documentation": "

The last update time of the test configuration.

", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.apptest#ResourceDescription", - "traits": { - "smithy.api#documentation": "

The description of the test configuration.

" - } - }, - "resources": { - "target": "com.amazonaws.apptest#ResourceList", - "traits": { - "smithy.api#documentation": "

The resources of the test configuration.

", - "smithy.api#required": {} - } - }, - "properties": { - "target": "com.amazonaws.apptest#Properties", - "traits": { - "smithy.api#documentation": "

The properties of the test configuration.

", - "smithy.api#required": {} - } - }, - "tags": { - "target": "com.amazonaws.apptest#TagMap", - "traits": { - "smithy.api#documentation": "

The tags of the test configuration.

" - } - }, - "serviceSettings": { - "target": "com.amazonaws.apptest#ServiceSettings", - "traits": { - "smithy.api#documentation": "

The service settings of the test configuration.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.apptest#GetTestRunStep": { - "type": "operation", - "input": { - "target": "com.amazonaws.apptest#GetTestRunStepRequest" - }, - "output": { - "target": "com.amazonaws.apptest#GetTestRunStepResponse" - }, - "errors": [ - { - "target": "com.amazonaws.apptest#AccessDeniedException" - }, - { - "target": "com.amazonaws.apptest#InternalServerException" - }, - { - "target": "com.amazonaws.apptest#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.apptest#ThrottlingException" - }, - { - "target": "com.amazonaws.apptest#ValidationException" - } - ], - "traits": { - "aws.iam#iamAction": { - "name": "GetTestRunStep", - "documentation": "Grants permission to get test run step" - }, - "smithy.api#documentation": "

Gets a test run step.

", - "smithy.api#http": { - "method": "GET", - "uri": "/testruns/{testRunId}/steps/{stepName}", - "code": 200 - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.apptest#GetTestRunStepRequest": { - "type": "structure", - "members": { - "testRunId": { - "target": "com.amazonaws.apptest#Identifier", - "traits": { - "smithy.api#documentation": "

The test run ID of the test run step.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "stepName": { - "target": "com.amazonaws.apptest#ResourceName", - "traits": { - "smithy.api#documentation": "

The step name of the test run step.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "testCaseId": { - "target": "com.amazonaws.apptest#Identifier", - "traits": { - "smithy.api#documentation": "

The test case ID of a test run step.

", - "smithy.api#httpQuery": "testCaseId" - } - }, - "testSuiteId": { - "target": "com.amazonaws.apptest#Identifier", - "traits": { - "smithy.api#documentation": "

The test suite ID of a test run step.

", - "smithy.api#httpQuery": "testSuiteId" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.apptest#GetTestRunStepResponse": { - "type": "structure", - "members": { - "stepName": { - "target": "com.amazonaws.apptest#ResourceName", - "traits": { - "smithy.api#documentation": "

The step name of the test run step.

", - "smithy.api#required": {} - } - }, - "testRunId": { - "target": "com.amazonaws.apptest#Identifier", - "traits": { - "smithy.api#documentation": "

The test run ID of the test run step.

", - "smithy.api#required": {} - } - }, - "testCaseId": { - "target": "com.amazonaws.apptest#Identifier", - "traits": { - "smithy.api#documentation": "

The test case ID of the test run step.

" - } - }, - "testCaseVersion": { - "target": "com.amazonaws.apptest#Version", - "traits": { - "smithy.api#documentation": "

The test case version of the test run step.

" - } - }, - "testSuiteId": { - "target": "com.amazonaws.apptest#Identifier", - "traits": { - "smithy.api#documentation": "

The test suite ID of the test run step.

" - } - }, - "testSuiteVersion": { - "target": "com.amazonaws.apptest#Version", - "traits": { - "smithy.api#documentation": "

The test suite version of the test run step.

" - } - }, - "beforeStep": { - "target": "smithy.api#Boolean", - "traits": { - "smithy.api#documentation": "

The before steps of the test run step.

" - } - }, - "afterStep": { - "target": "smithy.api#Boolean", - "traits": { - "smithy.api#documentation": "

The after steps of the test run step.

" - } - }, - "status": { - "target": "com.amazonaws.apptest#StepRunStatus", - "traits": { - "smithy.api#documentation": "

The status of the test run step.

", - "smithy.api#required": {} - } - }, - "statusReason": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

The status reason of the test run step.

" - } - }, - "runStartTime": { - "target": "smithy.api#Timestamp", - "traits": { - "smithy.api#documentation": "

The run start time of the test run step.

", - "smithy.api#required": {} - } - }, - "runEndTime": { - "target": "smithy.api#Timestamp", - "traits": { - "smithy.api#documentation": "

The run end time of the test run step.

" - } - }, - "stepRunSummary": { - "target": "com.amazonaws.apptest#StepRunSummary", - "traits": { - "smithy.api#documentation": "

The step run summary of the test run step.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.apptest#GetTestSuite": { - "type": "operation", - "input": { - "target": "com.amazonaws.apptest#GetTestSuiteRequest" - }, - "output": { - "target": "com.amazonaws.apptest#GetTestSuiteResponse" - }, - "errors": [ - { - "target": "com.amazonaws.apptest#AccessDeniedException" - }, - { - "target": "com.amazonaws.apptest#InternalServerException" - }, - { - "target": "com.amazonaws.apptest#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.apptest#ThrottlingException" - }, - { - "target": "com.amazonaws.apptest#ValidationException" - } - ], - "traits": { - "aws.iam#iamAction": { - "name": "GetTestSuite", - "documentation": "Grants permission to get a test suite" - }, - "smithy.api#documentation": "

Gets a test suite.

", - "smithy.api#http": { - "method": "GET", - "uri": "/testsuites/{testSuiteId}", - "code": 200 - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.apptest#GetTestSuiteRequest": { - "type": "structure", - "members": { - "testSuiteId": { - "target": "com.amazonaws.apptest#Identifier", - "traits": { - "smithy.api#documentation": "

The ID of the test suite.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "testSuiteVersion": { - "target": "com.amazonaws.apptest#Version", - "traits": { - "smithy.api#documentation": "

The version of the test suite.

", - "smithy.api#httpQuery": "testSuiteVersion" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.apptest#GetTestSuiteResponse": { - "type": "structure", - "members": { - "testSuiteId": { - "target": "com.amazonaws.apptest#Identifier", - "traits": { - "smithy.api#documentation": "

The response ID of the test suite.

", - "smithy.api#required": {} - } - }, - "name": { - "target": "com.amazonaws.apptest#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the test suite.

", - "smithy.api#required": {} - } - }, - "latestVersion": { - "target": "com.amazonaws.apptest#TestSuiteLatestVersion", - "traits": { - "smithy.api#documentation": "

The latest version of the test suite.

", - "smithy.api#required": {} - } - }, - "testSuiteVersion": { - "target": "com.amazonaws.apptest#Version", - "traits": { - "smithy.api#documentation": "

The version of the test suite.

", - "smithy.api#required": {} - } - }, - "status": { - "target": "com.amazonaws.apptest#TestSuiteLifecycle", - "traits": { - "smithy.api#documentation": "

The status of the test suite.

" - } - }, - "statusReason": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

The status reason of the test suite.

" - } - }, - "testSuiteArn": { - "target": "com.amazonaws.apptest#Arn", - "traits": { - "smithy.api#documentation": "

The test suite Amazon Resource Name (ARN).

", - "smithy.api#required": {} - } - }, - "creationTime": { - "target": "smithy.api#Timestamp", - "traits": { - "smithy.api#documentation": "

The creation time of the test suite.

", - "smithy.api#required": {} - } - }, - "lastUpdateTime": { - "target": "smithy.api#Timestamp", - "traits": { - "smithy.api#documentation": "

The last update time of the test suite.

", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.apptest#ResourceDescription", - "traits": { - "smithy.api#documentation": "

The description of the test suite.

" - } - }, - "beforeSteps": { - "target": "com.amazonaws.apptest#StepList", - "traits": { - "smithy.api#documentation": "

The before steps of the test suite.

", - "smithy.api#required": {} - } - }, - "afterSteps": { - "target": "com.amazonaws.apptest#StepList", - "traits": { - "smithy.api#documentation": "

The after steps of the test suite.

", - "smithy.api#required": {} - } - }, - "testCases": { - "target": "com.amazonaws.apptest#TestCases", - "traits": { - "smithy.api#documentation": "

The test cases of the test suite.

", - "smithy.api#required": {} - } - }, - "tags": { - "target": "com.amazonaws.apptest#TagMap", - "traits": { - "smithy.api#documentation": "

The tags of the test suite.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.apptest#IdempotencyTokenString": { - "type": "string", - "traits": { - "smithy.api#pattern": "^[A-Za-z0-9\\-]{1,64}$" - } - }, - "com.amazonaws.apptest#Identifier": { - "type": "string", - "traits": { - "smithy.api#pattern": "^[A-Za-z0-9:/\\-]{1,100}$" - } - }, - "com.amazonaws.apptest#Input": { - "type": "union", - "members": { - "file": { - "target": "com.amazonaws.apptest#InputFile", - "traits": { - "smithy.api#documentation": "

The file in the input.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Specifies the input.

" - } - }, - "com.amazonaws.apptest#InputFile": { - "type": "structure", - "members": { - "sourceLocation": { - "target": "com.amazonaws.apptest#Variable", - "traits": { - "smithy.api#documentation": "

The source location of the input file.

", - "smithy.api#required": {} - } - }, - "targetLocation": { - "target": "com.amazonaws.apptest#Variable", - "traits": { - "smithy.api#documentation": "

The target location of the input file.

", - "smithy.api#required": {} - } - }, - "fileMetadata": { - "target": "com.amazonaws.apptest#FileMetadata", - "traits": { - "smithy.api#documentation": "

The file metadata of the input file.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Specifies the input file.

" - } - }, - "com.amazonaws.apptest#InternalServerException": { - "type": "structure", - "members": { - "message": { - "target": "smithy.api#String", - "traits": { - "smithy.api#required": {} - } - }, - "retryAfterSeconds": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#documentation": "

The number of seconds to retry the query.

", - "smithy.api#httpHeader": "Retry-After" - } - } - }, - "traits": { - "smithy.api#documentation": "

An unexpected error occurred during the processing of the request.

", - "smithy.api#error": "server", - "smithy.api#httpError": 500, - "smithy.api#retryable": {} - } - }, - "com.amazonaws.apptest#ListTagsForResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.apptest#ListTagsForResourceRequest" - }, - "output": { - "target": "com.amazonaws.apptest#ListTagsForResourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.apptest#AccessDeniedException" - }, - { - "target": "com.amazonaws.apptest#InternalServerException" - }, - { - "target": "com.amazonaws.apptest#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.apptest#ThrottlingException" - }, - { - "target": "com.amazonaws.apptest#ValidationException" - } - ], - "traits": { - "aws.iam#iamAction": { - "documentation": "Grants permission to list tags for a resource" - }, - "smithy.api#documentation": "

Lists tags for a resource.

", - "smithy.api#http": { - "method": "GET", - "uri": "/tags/{resourceArn}", - "code": 200 - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.apptest#ListTagsForResourceRequest": { - "type": "structure", - "members": { - "resourceArn": { - "target": "com.amazonaws.apptest#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.apptest#ListTagsForResourceResponse": { - "type": "structure", - "members": { - "tags": { - "target": "com.amazonaws.apptest#TagMap", - "traits": { - "smithy.api#documentation": "

The tags of the resource.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.apptest#ListTestCases": { - "type": "operation", - "input": { - "target": "com.amazonaws.apptest#ListTestCasesRequest" - }, - "output": { - "target": "com.amazonaws.apptest#ListTestCasesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.apptest#AccessDeniedException" - }, - { - "target": "com.amazonaws.apptest#InternalServerException" - }, - { - "target": "com.amazonaws.apptest#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.apptest#ThrottlingException" - }, - { - "target": "com.amazonaws.apptest#ValidationException" - } - ], - "traits": { - "aws.iam#iamAction": { - "name": "ListTestCases", - "documentation": "Grants permission to list test cases" - }, - "smithy.api#documentation": "

Lists test cases.

", - "smithy.api#http": { - "method": "GET", - "uri": "/testcases", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "pageSize": "maxResults", - "items": "testCases" - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.apptest#ListTestCasesRequest": { - "type": "structure", - "members": { - "testCaseIds": { - "target": "com.amazonaws.apptest#TestCaseIdList", - "traits": { - "smithy.api#documentation": "

The IDs of the test cases.

", - "smithy.api#httpQuery": "testCaseIds" - } - }, - "nextToken": { - "target": "com.amazonaws.apptest#NextToken", - "traits": { - "smithy.api#documentation": "

The next token of the test cases.

", - "smithy.api#httpQuery": "nextToken" - } - }, - "maxResults": { - "target": "com.amazonaws.apptest#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum results of the test case.

", - "smithy.api#httpQuery": "maxResults" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.apptest#ListTestCasesResponse": { - "type": "structure", - "members": { - "testCases": { - "target": "com.amazonaws.apptest#TestCaseSummaryList", - "traits": { - "smithy.api#documentation": "

The test cases in an application.

", - "smithy.api#required": {} - } - }, - "nextToken": { - "target": "com.amazonaws.apptest#NextToken", - "traits": { - "smithy.api#documentation": "

The next token in test cases.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.apptest#ListTestConfigurations": { - "type": "operation", - "input": { - "target": "com.amazonaws.apptest#ListTestConfigurationsRequest" - }, - "output": { - "target": "com.amazonaws.apptest#ListTestConfigurationsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.apptest#AccessDeniedException" - }, - { - "target": "com.amazonaws.apptest#InternalServerException" - }, - { - "target": "com.amazonaws.apptest#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.apptest#ThrottlingException" - }, - { - "target": "com.amazonaws.apptest#ValidationException" - } - ], - "traits": { - "aws.iam#iamAction": { - "name": "ListTestConfigurations", - "documentation": "Grants permission to list test configurations" - }, - "smithy.api#documentation": "

Lists test configurations.

", - "smithy.api#http": { - "method": "GET", - "uri": "/testconfigurations", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "pageSize": "maxResults", - "items": "testConfigurations" - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.apptest#ListTestConfigurationsRequest": { - "type": "structure", - "members": { - "testConfigurationIds": { - "target": "com.amazonaws.apptest#TestConfigurationIdList", - "traits": { - "smithy.api#documentation": "

The configuration IDs of the test configurations.

", - "smithy.api#httpQuery": "testConfigurationIds" - } - }, - "nextToken": { - "target": "com.amazonaws.apptest#NextToken", - "traits": { - "smithy.api#documentation": "

The next token for the test configurations.

", - "smithy.api#httpQuery": "nextToken" - } - }, - "maxResults": { - "target": "com.amazonaws.apptest#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum results of the test configuration.

", - "smithy.api#httpQuery": "maxResults" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.apptest#ListTestConfigurationsResponse": { - "type": "structure", - "members": { - "testConfigurations": { - "target": "com.amazonaws.apptest#TestConfigurationList", - "traits": { - "smithy.api#documentation": "

The test configurations.

", - "smithy.api#required": {} - } - }, - "nextToken": { - "target": "com.amazonaws.apptest#NextToken", - "traits": { - "smithy.api#documentation": "

The next token in the test configurations.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.apptest#ListTestRunSteps": { - "type": "operation", - "input": { - "target": "com.amazonaws.apptest#ListTestRunStepsRequest" - }, - "output": { - "target": "com.amazonaws.apptest#ListTestRunStepsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.apptest#AccessDeniedException" - }, - { - "target": "com.amazonaws.apptest#InternalServerException" - }, - { - "target": "com.amazonaws.apptest#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.apptest#ThrottlingException" - }, - { - "target": "com.amazonaws.apptest#ValidationException" - } - ], - "traits": { - "aws.iam#iamAction": { - "name": "ListTestRunSteps", - "documentation": "Grants permission to list steps for a test run" - }, - "smithy.api#documentation": "

Lists test run steps.

", - "smithy.api#http": { - "method": "GET", - "uri": "/testruns/{testRunId}/steps", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "pageSize": "maxResults", - "items": "testRunSteps" - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.apptest#ListTestRunStepsRequest": { - "type": "structure", - "members": { - "testRunId": { - "target": "com.amazonaws.apptest#Identifier", - "traits": { - "smithy.api#documentation": "

The test run ID of the test run steps.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "testCaseId": { - "target": "com.amazonaws.apptest#Identifier", - "traits": { - "smithy.api#documentation": "

The test case ID of the test run steps.

", - "smithy.api#httpQuery": "testCaseId" - } - }, - "testSuiteId": { - "target": "com.amazonaws.apptest#Identifier", - "traits": { - "smithy.api#documentation": "

The test suite ID of the test run steps.

", - "smithy.api#httpQuery": "testSuiteId" - } - }, - "nextToken": { - "target": "com.amazonaws.apptest#NextToken", - "traits": { - "smithy.api#documentation": "

The token from a previous step to retrieve the next page of results.

", - "smithy.api#httpQuery": "nextToken" - } - }, - "maxResults": { - "target": "com.amazonaws.apptest#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of test run steps to return in one page of results.

", - "smithy.api#httpQuery": "maxResults" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.apptest#ListTestRunStepsResponse": { - "type": "structure", - "members": { - "testRunSteps": { - "target": "com.amazonaws.apptest#TestRunStepSummaryList", - "traits": { - "smithy.api#documentation": "

The test run steps of the response query.

", - "smithy.api#required": {} - } - }, - "nextToken": { - "target": "com.amazonaws.apptest#NextToken", - "traits": { - "smithy.api#documentation": "

The token from a previous request to retrieve the next page of results.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.apptest#ListTestRunTestCases": { - "type": "operation", - "input": { - "target": "com.amazonaws.apptest#ListTestRunTestCasesRequest" - }, - "output": { - "target": "com.amazonaws.apptest#ListTestRunTestCasesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.apptest#AccessDeniedException" - }, - { - "target": "com.amazonaws.apptest#InternalServerException" - }, - { - "target": "com.amazonaws.apptest#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.apptest#ThrottlingException" - }, - { - "target": "com.amazonaws.apptest#ValidationException" - } - ], - "traits": { - "aws.iam#iamAction": { - "name": "ListTestRunTestCases", - "documentation": "Grants permission to list test cases for a test run" - }, - "smithy.api#documentation": "

Lists test run test cases.

", - "smithy.api#http": { - "method": "GET", - "uri": "/testruns/{testRunId}/testcases", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "pageSize": "maxResults", - "items": "testRunTestCases" - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.apptest#ListTestRunTestCasesRequest": { - "type": "structure", - "members": { - "testRunId": { - "target": "com.amazonaws.apptest#Identifier", - "traits": { - "smithy.api#documentation": "

The test run ID of the test cases.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "nextToken": { - "target": "com.amazonaws.apptest#NextToken", - "traits": { - "smithy.api#documentation": "

The token from a previous request to retrieve the next page of results.

", - "smithy.api#httpQuery": "nextToken" - } - }, - "maxResults": { - "target": "com.amazonaws.apptest#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of test run test cases to return in one page of results.

", - "smithy.api#httpQuery": "maxResults" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.apptest#ListTestRunTestCasesResponse": { - "type": "structure", - "members": { - "testRunTestCases": { - "target": "com.amazonaws.apptest#TestCaseRunSummaryList", - "traits": { - "smithy.api#documentation": "

The test run of the test cases.

", - "smithy.api#required": {} - } - }, - "nextToken": { - "target": "com.amazonaws.apptest#NextToken", - "traits": { - "smithy.api#documentation": "

The token from a previous request to retrieve the next page of results.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.apptest#ListTestRuns": { - "type": "operation", - "input": { - "target": "com.amazonaws.apptest#ListTestRunsRequest" - }, - "output": { - "target": "com.amazonaws.apptest#ListTestRunsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.apptest#AccessDeniedException" - }, - { - "target": "com.amazonaws.apptest#InternalServerException" - }, - { - "target": "com.amazonaws.apptest#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.apptest#ThrottlingException" - }, - { - "target": "com.amazonaws.apptest#ValidationException" - } - ], - "traits": { - "aws.iam#iamAction": { - "name": "ListTestRuns", - "documentation": "Grants permission to list test runs" - }, - "smithy.api#documentation": "

Lists test runs.

", - "smithy.api#http": { - "method": "GET", - "uri": "/testruns", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "pageSize": "maxResults", - "items": "testRuns" - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.apptest#ListTestRunsRequest": { - "type": "structure", - "members": { - "testSuiteId": { - "target": "com.amazonaws.apptest#Identifier", - "traits": { - "smithy.api#documentation": "

The test suite ID of the test runs.

", - "smithy.api#httpQuery": "testSuiteId" - } - }, - "testRunIds": { - "target": "com.amazonaws.apptest#TestRunIdList", - "traits": { - "smithy.api#documentation": "

The test run IDs of the test runs.

", - "smithy.api#httpQuery": "testrunIds" - } - }, - "nextToken": { - "target": "com.amazonaws.apptest#NextToken", - "traits": { - "smithy.api#documentation": "

The token from the previous request to retrieve the next page of test run results.

", - "smithy.api#httpQuery": "nextToken" - } - }, - "maxResults": { - "target": "com.amazonaws.apptest#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of test runs to return in one page of results.

", - "smithy.api#httpQuery": "maxResults" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.apptest#ListTestRunsResponse": { - "type": "structure", - "members": { - "testRuns": { - "target": "com.amazonaws.apptest#TestRunSummaryList", - "traits": { - "smithy.api#documentation": "

The test runs of the response query.

", - "smithy.api#required": {} - } - }, - "nextToken": { - "target": "com.amazonaws.apptest#NextToken", - "traits": { - "smithy.api#documentation": "

The token from the previous request to retrieve the next page of results.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.apptest#ListTestSuites": { - "type": "operation", - "input": { - "target": "com.amazonaws.apptest#ListTestSuitesRequest" - }, - "output": { - "target": "com.amazonaws.apptest#ListTestSuitesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.apptest#AccessDeniedException" - }, - { - "target": "com.amazonaws.apptest#InternalServerException" - }, - { - "target": "com.amazonaws.apptest#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.apptest#ThrottlingException" - }, - { - "target": "com.amazonaws.apptest#ValidationException" - } - ], - "traits": { - "aws.iam#iamAction": { - "name": "ListTestSuites", - "documentation": "Grants permission to list test suites" - }, - "smithy.api#documentation": "

Lists test suites.

", - "smithy.api#http": { - "method": "GET", - "uri": "/testsuites", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "pageSize": "maxResults", - "items": "testSuites" - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.apptest#ListTestSuitesRequest": { - "type": "structure", - "members": { - "testSuiteIds": { - "target": "com.amazonaws.apptest#TestSuiteIdList", - "traits": { - "smithy.api#documentation": "

The suite ID of the test suites.

", - "smithy.api#httpQuery": "testSuiteIds" - } - }, - "nextToken": { - "target": "com.amazonaws.apptest#NextToken", - "traits": { - "smithy.api#documentation": "

The token from a previous request to retrieve the next page of results.

", - "smithy.api#httpQuery": "nextToken" - } - }, - "maxResults": { - "target": "com.amazonaws.apptest#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of test suites to return in one page of results.

", - "smithy.api#httpQuery": "maxResults" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.apptest#ListTestSuitesResponse": { - "type": "structure", - "members": { - "testSuites": { - "target": "com.amazonaws.apptest#TestSuiteList", - "traits": { - "smithy.api#documentation": "

The test suites returned with the response query.

", - "smithy.api#required": {} - } - }, - "nextToken": { - "target": "com.amazonaws.apptest#NextToken", - "traits": { - "smithy.api#documentation": "

The token from a previous request to retrieve the next page of test suites results.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.apptest#M2ManagedActionProperties": { - "type": "structure", - "members": { - "forceStop": { - "target": "smithy.api#Boolean", - "traits": { - "smithy.api#documentation": "

Force stops the AWS Mainframe Modernization managed action properties.

" - } - }, - "importDataSetLocation": { - "target": "com.amazonaws.apptest#Variable", - "traits": { - "smithy.api#documentation": "

The import data set location of the AWS Mainframe Modernization managed action properties.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Specifies the AWS Mainframe Modernization managed action properties.

" - } - }, - "com.amazonaws.apptest#M2ManagedActionType": { - "type": "enum", - "members": { - "CONFIGURE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Configure" - } - }, - "DECONFIGURE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Deconfigure" - } - } - } - }, - "com.amazonaws.apptest#M2ManagedApplication": { - "type": "structure", - "members": { - "applicationId": { - "target": "com.amazonaws.apptest#Variable", - "traits": { - "smithy.api#documentation": "

The application ID of the AWS Mainframe Modernization managed application.

", - "smithy.api#required": {} - } - }, - "runtime": { - "target": "com.amazonaws.apptest#M2ManagedRuntime", - "traits": { - "smithy.api#documentation": "

The runtime of the AWS Mainframe Modernization managed application.

", - "smithy.api#required": {} - } - }, - "vpcEndpointServiceName": { - "target": "com.amazonaws.apptest#Variable", - "traits": { - "smithy.api#documentation": "

The VPC endpoint service name of the AWS Mainframe Modernization managed application.

" - } - }, - "listenerPort": { - "target": "com.amazonaws.apptest#Variable", - "traits": { - "smithy.api#documentation": "

The listener port of the AWS Mainframe Modernization managed application.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Specifies the AWS Mainframe Modernization managed application.

" - } - }, - "com.amazonaws.apptest#M2ManagedApplicationAction": { - "type": "structure", - "members": { - "resource": { - "target": "com.amazonaws.apptest#Variable", - "traits": { - "smithy.api#documentation": "

The resource of the AWS Mainframe Modernization managed application action.

", - "smithy.api#required": {} - } - }, - "actionType": { - "target": "com.amazonaws.apptest#M2ManagedActionType", - "traits": { - "smithy.api#documentation": "

The action type of the AWS Mainframe Modernization managed application action.

", - "smithy.api#required": {} - } - }, - "properties": { - "target": "com.amazonaws.apptest#M2ManagedActionProperties", - "traits": { - "smithy.api#documentation": "

The properties of the AWS Mainframe Modernization managed application action.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Specifies the AWS Mainframe Modernization managed application action.

" - } - }, - "com.amazonaws.apptest#M2ManagedApplicationStepInput": { - "type": "structure", - "members": { - "applicationId": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

The application ID of the AWS Mainframe Modernization managed application step input.

", - "smithy.api#required": {} - } - }, - "runtime": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

The runtime of the AWS Mainframe Modernization managed application step input.

", - "smithy.api#required": {} - } - }, - "vpcEndpointServiceName": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

The VPC endpoint service name of the AWS Mainframe Modernization managed application step input.

" - } - }, - "listenerPort": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#documentation": "

The listener port of the AWS Mainframe Modernization managed application step input.

" - } - }, - "actionType": { - "target": "com.amazonaws.apptest#M2ManagedActionType", - "traits": { - "smithy.api#documentation": "

The action type of the AWS Mainframe Modernization managed application step input.

", - "smithy.api#required": {} - } - }, - "properties": { - "target": "com.amazonaws.apptest#M2ManagedActionProperties", - "traits": { - "smithy.api#documentation": "

The properties of the AWS Mainframe Modernization managed application step input.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Specifies the AWS Mainframe Modernization managed application step input.

" - } - }, - "com.amazonaws.apptest#M2ManagedApplicationStepOutput": { - "type": "structure", - "members": { - "importDataSetSummary": { - "target": "com.amazonaws.apptest#Properties", - "traits": { - "smithy.api#documentation": "

The import data set summary of the AWS Mainframe Modernization managed application step output.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Specifies the AWS Mainframe Modernization managed application step output.

" - } - }, - "com.amazonaws.apptest#M2ManagedApplicationStepSummary": { - "type": "structure", - "members": { - "stepInput": { - "target": "com.amazonaws.apptest#M2ManagedApplicationStepInput", - "traits": { - "smithy.api#documentation": "

The step input of the AWS Mainframe Modernization managed application step summary.

", - "smithy.api#required": {} - } - }, - "stepOutput": { - "target": "com.amazonaws.apptest#M2ManagedApplicationStepOutput", - "traits": { - "smithy.api#documentation": "

The step output of the AWS Mainframe Modernization managed application step summary.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Specifies the AWS Mainframe Modernization managed application step summary.

" - } - }, - "com.amazonaws.apptest#M2ManagedApplicationSummary": { - "type": "structure", - "members": { - "applicationId": { - "target": "com.amazonaws.apptest#Identifier", - "traits": { - "smithy.api#documentation": "

The application ID of the AWS Mainframe Modernization managed application summary.

", - "smithy.api#required": {} - } - }, - "runtime": { - "target": "com.amazonaws.apptest#M2ManagedRuntime", - "traits": { - "smithy.api#documentation": "

The runtime of the AWS Mainframe Modernization managed application summary.

", - "smithy.api#required": {} - } - }, - "listenerPort": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#documentation": "

The listener port of the AWS Mainframe Modernization managed application summary.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Specifies the AWS Mainframe Modernization managed application summary.

" - } - }, - "com.amazonaws.apptest#M2ManagedRuntime": { - "type": "enum", - "members": { - "MICROFOCUS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MicroFocus" - } - } - } - }, - "com.amazonaws.apptest#M2NonManagedActionType": { - "type": "enum", - "members": { - "CONFIGURE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Configure" - } - }, - "DECONFIGURE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Deconfigure" - } - } - } - }, - "com.amazonaws.apptest#M2NonManagedApplication": { - "type": "structure", - "members": { - "vpcEndpointServiceName": { - "target": "com.amazonaws.apptest#Variable", - "traits": { - "smithy.api#documentation": "

The VPC endpoint service name of the AWS Mainframe Modernization non-managed application.

", - "smithy.api#required": {} - } - }, - "listenerPort": { - "target": "com.amazonaws.apptest#Variable", - "traits": { - "smithy.api#documentation": "

The listener port of the AWS Mainframe Modernization non-managed application.

", - "smithy.api#required": {} - } - }, - "runtime": { - "target": "com.amazonaws.apptest#M2NonManagedRuntime", - "traits": { - "smithy.api#documentation": "

The runtime of the AWS Mainframe Modernization non-managed application.

", - "smithy.api#required": {} - } - }, - "webAppName": { - "target": "com.amazonaws.apptest#Variable", - "traits": { - "smithy.api#documentation": "

The web application name of the AWS Mainframe Modernization non-managed application.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Specifies the AWS Mainframe Modernization non-managed application.

" - } - }, - "com.amazonaws.apptest#M2NonManagedApplicationAction": { - "type": "structure", - "members": { - "resource": { - "target": "com.amazonaws.apptest#Variable", - "traits": { - "smithy.api#documentation": "

The resource of the AWS Mainframe Modernization non-managed application action.

", - "smithy.api#required": {} - } - }, - "actionType": { - "target": "com.amazonaws.apptest#M2NonManagedActionType", - "traits": { - "smithy.api#documentation": "

The action type of the AWS Mainframe Modernization non-managed application action.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Specifies the AWS Mainframe Modernization non-managed application action.

" - } - }, - "com.amazonaws.apptest#M2NonManagedApplicationStepInput": { - "type": "structure", - "members": { - "vpcEndpointServiceName": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

The VPC endpoint service name of the AWS Mainframe Modernization non-managed application step input.

", - "smithy.api#required": {} - } - }, - "listenerPort": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#documentation": "

The listener port of the AWS Mainframe Modernization non-managed application step input.

", - "smithy.api#required": {} - } - }, - "runtime": { - "target": "com.amazonaws.apptest#M2NonManagedRuntime", - "traits": { - "smithy.api#documentation": "

The runtime of the AWS Mainframe Modernization non-managed application step input.

", - "smithy.api#required": {} - } - }, - "webAppName": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

The web app name of the AWS Mainframe Modernization non-managed application step input.

" - } - }, - "actionType": { - "target": "com.amazonaws.apptest#M2NonManagedActionType", - "traits": { - "smithy.api#documentation": "

The action type of the AWS Mainframe Modernization non-managed application step input.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Specifies the AWS Mainframe Modernization non-managed application step input.

" - } - }, - "com.amazonaws.apptest#M2NonManagedApplicationStepOutput": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#documentation": "

Specifies the AWS Mainframe Modernization non-managed application step output.

" - } - }, - "com.amazonaws.apptest#M2NonManagedApplicationStepSummary": { - "type": "structure", - "members": { - "stepInput": { - "target": "com.amazonaws.apptest#M2NonManagedApplicationStepInput", - "traits": { - "smithy.api#documentation": "

The step input of the AWS Mainframe Modernization non-managed application step summary.

", - "smithy.api#required": {} - } - }, - "stepOutput": { - "target": "com.amazonaws.apptest#M2NonManagedApplicationStepOutput", - "traits": { - "smithy.api#documentation": "

The step output of the AWS Mainframe Modernization non-managed application step summary.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Specifies the AWS Mainframe Modernization non-managed application step summary.

" - } - }, - "com.amazonaws.apptest#M2NonManagedApplicationSummary": { - "type": "structure", - "members": { - "vpcEndpointServiceName": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

The VPC endpoint service name of the AWS Mainframe Modernization non-managed application summary.

", - "smithy.api#required": {} - } - }, - "listenerPort": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#documentation": "

The listener port of the AWS Mainframe Modernization non-managed application summary.

", - "smithy.api#required": {} - } - }, - "runtime": { - "target": "com.amazonaws.apptest#M2NonManagedRuntime", - "traits": { - "smithy.api#documentation": "

The runtime of the AWS Mainframe Modernization non-managed application summary.

", - "smithy.api#required": {} - } - }, - "webAppName": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

The web application name of the AWS Mainframe Modernization non-managed application summary.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Specifies the AWS Mainframe Modernization non-managed application summary.

" - } - }, - "com.amazonaws.apptest#M2NonManagedRuntime": { - "type": "enum", - "members": { - "BLUAGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BluAge" - } - } - } - }, - "com.amazonaws.apptest#MainframeAction": { - "type": "structure", - "members": { - "resource": { - "target": "com.amazonaws.apptest#Variable", - "traits": { - "smithy.api#documentation": "

The resource of the mainframe action.

", - "smithy.api#required": {} - } - }, - "actionType": { - "target": "com.amazonaws.apptest#MainframeActionType", - "traits": { - "smithy.api#documentation": "

The action type of the mainframe action.

", - "smithy.api#required": {} - } - }, - "properties": { - "target": "com.amazonaws.apptest#MainframeActionProperties", - "traits": { - "smithy.api#documentation": "

The properties of the mainframe action.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Specifies the mainframe action.

" - } - }, - "com.amazonaws.apptest#MainframeActionProperties": { - "type": "structure", - "members": { - "dmsTaskArn": { - "target": "com.amazonaws.apptest#Variable", - "traits": { - "smithy.api#documentation": "

The DMS task ARN of the mainframe action properties.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Specifies the mainframe action properties.

" - } - }, - "com.amazonaws.apptest#MainframeActionSummary": { - "type": "union", - "members": { - "batch": { - "target": "com.amazonaws.apptest#BatchSummary", - "traits": { - "smithy.api#documentation": "

The batch of the mainframe action summary.

" - } - }, - "tn3270": { - "target": "com.amazonaws.apptest#TN3270Summary", - "traits": { - "smithy.api#documentation": "

The tn3270 port of the mainframe action summary.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Specifies the mainframe action summary.

" - } - }, - "com.amazonaws.apptest#MainframeActionType": { - "type": "union", - "members": { - "batch": { - "target": "com.amazonaws.apptest#Batch", - "traits": { - "smithy.api#documentation": "

The batch of the mainframe action type.

" - } - }, - "tn3270": { - "target": "com.amazonaws.apptest#TN3270", - "traits": { - "smithy.api#documentation": "

The tn3270 port of the mainframe action type.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Specifies the mainframe action type.

" - } - }, - "com.amazonaws.apptest#MainframeResourceSummary": { - "type": "union", - "members": { - "m2ManagedApplication": { - "target": "com.amazonaws.apptest#M2ManagedApplicationSummary", - "traits": { - "smithy.api#documentation": "

The AWS Mainframe Modernization managed application in the mainframe resource summary.

" - } - }, - "m2NonManagedApplication": { - "target": "com.amazonaws.apptest#M2NonManagedApplicationSummary", - "traits": { - "smithy.api#documentation": "

The AWS Mainframe Modernization non-managed application in the mainframe resource summary.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Specifies the mainframe resource summary.

" - } - }, - "com.amazonaws.apptest#MaxResults": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 100 - } - } - }, - "com.amazonaws.apptest#NextToken": { - "type": "string", - "traits": { - "smithy.api#pattern": "^\\S{1,2000}$" - } - }, - "com.amazonaws.apptest#Output": { - "type": "union", - "members": { - "file": { - "target": "com.amazonaws.apptest#OutputFile", - "traits": { - "smithy.api#documentation": "

The file of the output.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Specifies an output.

" - } - }, - "com.amazonaws.apptest#OutputFile": { - "type": "structure", - "members": { - "fileLocation": { - "target": "com.amazonaws.apptest#S3Uri", - "traits": { - "smithy.api#documentation": "

The file location of the output file.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Specifies an output file.

" - } - }, - "com.amazonaws.apptest#Properties": { - "type": "map", - "key": { - "target": "smithy.api#String" - }, - "value": { - "target": "smithy.api#String" - } - }, - "com.amazonaws.apptest#Resource": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.apptest#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the resource.

", - "smithy.api#required": {} - } - }, - "type": { - "target": "com.amazonaws.apptest#ResourceType", - "traits": { - "smithy.api#documentation": "

The type of the resource.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Specifies a resource.

" - } - }, - "com.amazonaws.apptest#ResourceAction": { - "type": "union", - "members": { - "m2ManagedApplicationAction": { - "target": "com.amazonaws.apptest#M2ManagedApplicationAction", - "traits": { - "smithy.api#documentation": "

The AWS Mainframe Modernization managed application action of the resource action.

" - } - }, - "m2NonManagedApplicationAction": { - "target": "com.amazonaws.apptest#M2NonManagedApplicationAction", - "traits": { - "smithy.api#documentation": "

The AWS Mainframe Modernization non-managed application action of the resource action.

" - } - }, - "cloudFormationAction": { - "target": "com.amazonaws.apptest#CloudFormationAction", - "traits": { - "smithy.api#documentation": "

The CloudFormation action of the resource action.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Specifies a resource action.

" - } - }, - "com.amazonaws.apptest#ResourceActionSummary": { - "type": "union", - "members": { - "cloudFormation": { - "target": "com.amazonaws.apptest#CloudFormationStepSummary", - "traits": { - "smithy.api#documentation": "

The CloudFormation template of the resource action summary.

" - } - }, - "m2ManagedApplication": { - "target": "com.amazonaws.apptest#M2ManagedApplicationStepSummary", - "traits": { - "smithy.api#documentation": "

The AWS Mainframe Modernization managed application of the resource action summary.

" - } - }, - "m2NonManagedApplication": { - "target": "com.amazonaws.apptest#M2NonManagedApplicationStepSummary", - "traits": { - "smithy.api#documentation": "

The AWS Mainframe Modernization non-managed application of the resource action summary.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Specifies the resource action summary.

" - } - }, - "com.amazonaws.apptest#ResourceDescription": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1000 - } - } - }, - "com.amazonaws.apptest#ResourceList": { - "type": "list", - "member": { - "target": "com.amazonaws.apptest#Resource" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 20 - } - } - }, - "com.amazonaws.apptest#ResourceName": { - "type": "string", - "traits": { - "smithy.api#pattern": "^[A-Za-z][A-Za-z0-9_\\-]{1,59}$" - } - }, - "com.amazonaws.apptest#ResourceNotFoundException": { - "type": "structure", - "members": { - "message": { - "target": "smithy.api#String", - "traits": { - "smithy.api#required": {} - } - }, - "resourceId": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

The resource ID of the resource not found.

" - } - }, - "resourceType": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

The resource type of the resource not found.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The specified resource was not found.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.apptest#ResourceType": { - "type": "union", - "members": { - "cloudFormation": { - "target": "com.amazonaws.apptest#CloudFormation", - "traits": { - "smithy.api#documentation": "

The CloudFormation template of the resource type.

" - } - }, - "m2ManagedApplication": { - "target": "com.amazonaws.apptest#M2ManagedApplication", - "traits": { - "smithy.api#documentation": "

The AWS Mainframe Modernization managed application of the resource type.

" - } - }, - "m2NonManagedApplication": { - "target": "com.amazonaws.apptest#M2NonManagedApplication", - "traits": { - "smithy.api#documentation": "

The AWS Mainframe Modernization non-managed application of the resource type.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Specifies the resource type.

" - } - }, - "com.amazonaws.apptest#S3Uri": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1024 - } - } - }, - "com.amazonaws.apptest#Script": { - "type": "structure", - "members": { - "scriptLocation": { - "target": "com.amazonaws.apptest#S3Uri", - "traits": { - "smithy.api#documentation": "

The script location of the scripts.

", - "smithy.api#required": {} - } - }, - "type": { - "target": "com.amazonaws.apptest#ScriptType", - "traits": { - "smithy.api#documentation": "

The type of the scripts.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Specifies the script.

" - } - }, - "com.amazonaws.apptest#ScriptSummary": { - "type": "structure", - "members": { - "scriptLocation": { - "target": "com.amazonaws.apptest#S3Uri", - "traits": { - "smithy.api#documentation": "

The script location of the script summary.

", - "smithy.api#required": {} - } - }, - "type": { - "target": "com.amazonaws.apptest#ScriptType", - "traits": { - "smithy.api#documentation": "

The type of the script summary.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Specifies the scripts summary.

" - } - }, - "com.amazonaws.apptest#ScriptType": { - "type": "enum", - "members": { - "SELENIUM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Selenium" - } - } - } - }, - "com.amazonaws.apptest#ServiceQuotaExceededException": { - "type": "structure", - "members": { - "message": { - "target": "smithy.api#String", - "traits": { - "smithy.api#required": {} - } - }, - "resourceId": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

The resource ID of AWS Application Testing that exceeded the limit.

" - } - }, - "resourceType": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

The resource type of AWS Application Testing that exceeded the limit.

" - } - }, - "serviceCode": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

The service code of AWS Application Testing that exceeded the limit.

" - } - }, - "quotaCode": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

The quote codes of AWS Application Testing that exceeded the limit.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

One or more quotas for AWS Application Testing exceeds the limit.

", - "smithy.api#error": "client", - "smithy.api#httpError": 402 - } - }, - "com.amazonaws.apptest#ServiceSettings": { - "type": "structure", - "members": { - "kmsKeyId": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

The KMS key ID of the service settings.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Specifies the service settings.

" - } - }, - "com.amazonaws.apptest#SourceDatabase": { - "type": "enum", - "members": { - "Z_OS_DB2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "z/OS-DB2" - } - } - } - }, - "com.amazonaws.apptest#SourceDatabaseMetadata": { - "type": "structure", - "members": { - "type": { - "target": "com.amazonaws.apptest#SourceDatabase", - "traits": { - "smithy.api#documentation": "

The type of the source database metadata.

", - "smithy.api#required": {} - } - }, - "captureTool": { - "target": "com.amazonaws.apptest#CaptureTool", - "traits": { - "smithy.api#documentation": "

The capture tool of the source database metadata.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Specifies the source database metadata.

" - } - }, - "com.amazonaws.apptest#StartTestRun": { - "type": "operation", - "input": { - "target": "com.amazonaws.apptest#StartTestRunRequest" - }, - "output": { - "target": "com.amazonaws.apptest#StartTestRunResponse" - }, - "errors": [ - { - "target": "com.amazonaws.apptest#AccessDeniedException" - }, - { - "target": "com.amazonaws.apptest#ConflictException" - }, - { - "target": "com.amazonaws.apptest#InternalServerException" - }, - { - "target": "com.amazonaws.apptest#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.apptest#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.apptest#ThrottlingException" - }, - { - "target": "com.amazonaws.apptest#ValidationException" - } - ], - "traits": { - "aws.iam#conditionKeys": [ - "aws:RequestTag/${TagKey}", - "aws:TagKeys" - ], - "aws.iam#iamAction": { - "name": "StartTestRun", - "documentation": "Grants permission to start a test run", - "createsResources": [ - "TestRun" - ], - "requiredActions": [ - "cloudformation:CreateStack", - "cloudformation:DeleteStack", - "cloudformation:DescribeStacks", - "dms:DescribeReplicationTasks", - "dms:StartReplicationTask", - "dms:StopReplicationTask", - "ec2:DescribeAvailabilityZones", - "ec2:DescribeVpcEndpointServiceConfigurations", - "ec2:DescribeVpcEndpointServices", - "m2:CreateDataSetImportTask", - "m2:GetApplication", - "m2:GetBatchJobExecution", - "m2:GetDataSetDetails", - "m2:GetDataSetImportTask", - "m2:StartApplication", - "m2:StartBatchJob", - "m2:StopApplication", - "s3:DeleteObject", - "s3:DeleteObjects", - "s3:CopyObject", - "s3:HeadBucket", - "s3:CreateBucket", - "s3:UploadPart", - "s3:HeadObject", - "s3:CreateMultipartUpload", - "s3:CompleteMultipartUpload", - "s3:GetObject", - "s3:ListBucket", - "s3:PutObject", - "s3:ListObjectsV2" - ] - }, - "smithy.api#documentation": "

Starts a test run.

", - "smithy.api#http": { - "method": "POST", - "uri": "/testrun", - "code": 200 - } - } - }, - "com.amazonaws.apptest#StartTestRunRequest": { - "type": "structure", - "members": { - "testSuiteId": { - "target": "com.amazonaws.apptest#Identifier", - "traits": { - "smithy.api#documentation": "

The test suite ID of the test run.

", - "smithy.api#required": {} - } - }, - "testConfigurationId": { - "target": "com.amazonaws.apptest#Identifier", - "traits": { - "smithy.api#documentation": "

The configuration ID of the test run.

" - } - }, - "clientToken": { - "target": "com.amazonaws.apptest#IdempotencyTokenString", - "traits": { - "aws.cloudformation#cfnExcludeProperty": {}, - "smithy.api#documentation": "

The client token of the test run.

", - "smithy.api#idempotencyToken": {} - } - }, - "tags": { - "target": "com.amazonaws.apptest#TagMap", - "traits": { - "smithy.api#documentation": "

The tags of the test run.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.apptest#StartTestRunResponse": { - "type": "structure", - "members": { - "testRunId": { - "target": "com.amazonaws.apptest#Identifier", - "traits": { - "smithy.api#documentation": "

The test run ID of the test run.

", - "smithy.api#required": {} - } - }, - "testRunStatus": { - "target": "com.amazonaws.apptest#TestRunStatus", - "traits": { - "smithy.api#documentation": "

The test run status of the test run.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.apptest#Step": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.apptest#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the step.

", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.apptest#ResourceDescription", - "traits": { - "smithy.api#documentation": "

The description of the step.

" - } - }, - "action": { - "target": "com.amazonaws.apptest#StepAction", - "traits": { - "smithy.api#documentation": "

The action of the step.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Defines a step.

" - } - }, - "com.amazonaws.apptest#StepAction": { - "type": "union", - "members": { - "resourceAction": { - "target": "com.amazonaws.apptest#ResourceAction", - "traits": { - "smithy.api#documentation": "

The resource action of the step action.

" - } - }, - "mainframeAction": { - "target": "com.amazonaws.apptest#MainframeAction", - "traits": { - "smithy.api#documentation": "

The mainframe action of the step action.

" - } - }, - "compareAction": { - "target": "com.amazonaws.apptest#CompareAction", - "traits": { - "smithy.api#documentation": "

The compare action of the step action.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Specifies a step action.

" - } - }, - "com.amazonaws.apptest#StepList": { - "type": "list", - "member": { - "target": "com.amazonaws.apptest#Step" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 20 - } - } - }, - "com.amazonaws.apptest#StepRunStatus": { - "type": "enum", - "members": { - "SUCCESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Success" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Failed" - } - }, - "RUNNING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Running" - } - } - } - }, - "com.amazonaws.apptest#StepRunSummary": { - "type": "union", - "members": { - "mainframeAction": { - "target": "com.amazonaws.apptest#MainframeActionSummary", - "traits": { - "smithy.api#documentation": "

The mainframe action of the step run summary.

" - } - }, - "compareAction": { - "target": "com.amazonaws.apptest#CompareActionSummary", - "traits": { - "smithy.api#documentation": "

The compare action of the step run summary.

" - } - }, - "resourceAction": { - "target": "com.amazonaws.apptest#ResourceActionSummary", - "traits": { - "smithy.api#documentation": "

The resource action of the step run summary.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Defines the step run summary.

" - } - }, - "com.amazonaws.apptest#String100": { - "type": "string", - "traits": { - "smithy.api#pattern": "^\\S{1,100}$" - } - }, - "com.amazonaws.apptest#String50": { - "type": "string", - "traits": { - "smithy.api#pattern": "^\\S{1,50}$" - } - }, - "com.amazonaws.apptest#TN3270": { - "type": "structure", - "members": { - "script": { - "target": "com.amazonaws.apptest#Script", - "traits": { - "smithy.api#documentation": "

The script of the TN3270 protocol.

", - "smithy.api#required": {} - } - }, - "exportDataSetNames": { - "target": "com.amazonaws.apptest#ExportDataSetNames", - "traits": { - "smithy.api#documentation": "

The data set names of the TN3270 protocol.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Specifies the TN3270 protocol.

" - } - }, - "com.amazonaws.apptest#TN3270StepInput": { - "type": "structure", - "members": { - "resource": { - "target": "com.amazonaws.apptest#MainframeResourceSummary", - "traits": { - "smithy.api#documentation": "

The resource of the TN3270 step input.

", - "smithy.api#required": {} - } - }, - "script": { - "target": "com.amazonaws.apptest#ScriptSummary", - "traits": { - "smithy.api#documentation": "

The script of the TN3270 step input.

", - "smithy.api#required": {} - } - }, - "exportDataSetNames": { - "target": "com.amazonaws.apptest#ExportDataSetNames", - "traits": { - "smithy.api#documentation": "

The export data set names of the TN3270 step input.

" - } - }, - "properties": { - "target": "com.amazonaws.apptest#MainframeActionProperties", - "traits": { - "smithy.api#documentation": "

The properties of the TN3270 step input.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Specifies a TN3270 step input.

" - } - }, - "com.amazonaws.apptest#TN3270StepOutput": { - "type": "structure", - "members": { - "dataSetExportLocation": { - "target": "com.amazonaws.apptest#S3Uri", - "traits": { - "smithy.api#documentation": "

The data set export location of the TN3270 step output.

" - } - }, - "dmsOutputLocation": { - "target": "com.amazonaws.apptest#S3Uri", - "traits": { - "smithy.api#documentation": "

The output location of the TN3270 step output.

" - } - }, - "dataSetDetails": { - "target": "com.amazonaws.apptest#DataSetList", - "traits": { - "smithy.api#documentation": "

The data set details of the TN3270 step output.

" - } - }, - "scriptOutputLocation": { - "target": "com.amazonaws.apptest#S3Uri", - "traits": { - "smithy.api#documentation": "

The script output location of the TN3270 step output.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Specifies a TN3270 step output.

" - } - }, - "com.amazonaws.apptest#TN3270Summary": { - "type": "structure", - "members": { - "stepInput": { - "target": "com.amazonaws.apptest#TN3270StepInput", - "traits": { - "smithy.api#documentation": "

The step input of the TN3270 summary.

", - "smithy.api#required": {} - } - }, - "stepOutput": { - "target": "com.amazonaws.apptest#TN3270StepOutput", - "traits": { - "smithy.api#documentation": "

The step output of the TN3270 summary.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Specifies a TN3270 summary.

" - } - }, - "com.amazonaws.apptest#TagKey": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - }, - "smithy.api#pattern": "^(?!aws:).+$" - } - }, - "com.amazonaws.apptest#TagKeyList": { - "type": "list", - "member": { - "target": "com.amazonaws.apptest#TagKey" - } - }, - "com.amazonaws.apptest#TagMap": { - "type": "map", - "key": { - "target": "com.amazonaws.apptest#TagKey" - }, - "value": { - "target": "com.amazonaws.apptest#TagValue" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 200 - } - } - }, - "com.amazonaws.apptest#TagResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.apptest#TagResourceRequest" - }, - "output": { - "target": "com.amazonaws.apptest#TagResourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.apptest#AccessDeniedException" - }, - { - "target": "com.amazonaws.apptest#InternalServerException" - }, - { - "target": "com.amazonaws.apptest#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.apptest#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.apptest#ThrottlingException" - }, - { - "target": "com.amazonaws.apptest#ValidationException" - } - ], - "traits": { - "aws.iam#conditionKeys": [ - "aws:RequestTag/${TagKey}", - "aws:TagKeys" - ], - "aws.iam#iamAction": { - "name": "TagResource", - "documentation": "Grants permission to tag a resource", - "requiredActions": [], - "resources": { - "required": {}, - "optional": {} - } - }, - "smithy.api#documentation": "

Specifies tags of a resource.

", - "smithy.api#http": { - "method": "POST", - "uri": "/tags/{resourceArn}", - "code": 200 - } - } - }, - "com.amazonaws.apptest#TagResourceRequest": { - "type": "structure", - "members": { - "resourceArn": { - "target": "com.amazonaws.apptest#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the tag resource.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "tags": { - "target": "com.amazonaws.apptest#TagMap", - "traits": { - "smithy.api#documentation": "

The tags of the resource.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "aws.api#data": "tagging", - "smithy.api#input": {}, - "smithy.api#references": [ - { - "resource": "com.amazonaws.apptest#TestCase", - "ids": { - "testCaseId": "resourceArn" - } - }, - { - "resource": "com.amazonaws.apptest#TestSuite", - "ids": { - "testSuiteId": "resourceArn" - } - }, - { - "resource": "com.amazonaws.apptest#TestConfiguration", - "ids": { - "testConfigurationId": "resourceArn" - } - }, - { - "resource": "com.amazonaws.apptest#TestRun", - "ids": { - "testRunId": "resourceArn" - } - } - ] - } - }, - "com.amazonaws.apptest#TagResourceResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.apptest#TagValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - } - } - }, - "com.amazonaws.apptest#TargetDatabase": { - "type": "enum", - "members": { - "POSTGRESQL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PostgreSQL" - } - } - } - }, - "com.amazonaws.apptest#TargetDatabaseMetadata": { - "type": "structure", - "members": { - "type": { - "target": "com.amazonaws.apptest#TargetDatabase", - "traits": { - "smithy.api#documentation": "

The type of the target database metadata.

", - "smithy.api#required": {} - } - }, - "captureTool": { - "target": "com.amazonaws.apptest#CaptureTool", - "traits": { - "smithy.api#documentation": "

The capture tool of the target database metadata.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Specifies a target database metadata.

" - } - }, - "com.amazonaws.apptest#TestCase": { - "type": "resource", - "identifiers": { - "testCaseId": { - "target": "com.amazonaws.apptest#Identifier" - } - }, - "create": { - "target": "com.amazonaws.apptest#CreateTestCase" - }, - "read": { - "target": "com.amazonaws.apptest#GetTestCase" - }, - "update": { - "target": "com.amazonaws.apptest#UpdateTestCase" - }, - "delete": { - "target": "com.amazonaws.apptest#DeleteTestCase" - }, - "list": { - "target": "com.amazonaws.apptest#ListTestCases" - }, - "traits": { - "aws.api#arn": { - "template": "testcase/{testCaseId}" - }, - "aws.iam#conditionKeys": [ - "aws:ResourceTag/${TagKey}" - ], - "aws.iam#disableConditionKeyInference": {} - } - }, - "com.amazonaws.apptest#TestCaseIdList": { - "type": "list", - "member": { - "target": "com.amazonaws.apptest#Identifier" - } - }, - "com.amazonaws.apptest#TestCaseLatestVersion": { - "type": "structure", - "members": { - "version": { - "target": "com.amazonaws.apptest#Version", - "traits": { - "smithy.api#documentation": "

The version of the test case latest version.

", - "smithy.api#required": {} - } - }, - "status": { - "target": "com.amazonaws.apptest#TestCaseLifecycle", - "traits": { - "smithy.api#documentation": "

The status of the test case latest version.

", - "smithy.api#required": {} - } - }, - "statusReason": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

The status reason of the test case latest version.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Specifies the latest version of a test case.

" - } - }, - "com.amazonaws.apptest#TestCaseLifecycle": { - "type": "enum", - "members": { - "ACTIVE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Active" - } - }, - "DELETING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Deleting" - } - } - } - }, - "com.amazonaws.apptest#TestCaseList": { - "type": "list", - "member": { - "target": "com.amazonaws.apptest#Identifier" - } - }, - "com.amazonaws.apptest#TestCaseRunStatus": { - "type": "enum", - "members": { - "SUCCESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Success" - } - }, - "RUNNING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Running" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Failed" - } - } - } - }, - "com.amazonaws.apptest#TestCaseRunSummary": { - "type": "structure", - "members": { - "testCaseId": { - "target": "com.amazonaws.apptest#Identifier", - "traits": { - "smithy.api#documentation": "

The test case id of the test case run summary.

", - "smithy.api#required": {} - } - }, - "testCaseVersion": { - "target": "com.amazonaws.apptest#Version", - "traits": { - "smithy.api#documentation": "

The test case version of the test case run summary.

", - "smithy.api#required": {} - } - }, - "testRunId": { - "target": "com.amazonaws.apptest#Identifier", - "traits": { - "smithy.api#documentation": "

The test run id of the test case run summary.

", - "smithy.api#required": {} - } - }, - "status": { - "target": "com.amazonaws.apptest#TestCaseRunStatus", - "traits": { - "smithy.api#documentation": "

The status of the test case run summary.

", - "smithy.api#required": {} - } - }, - "statusReason": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

The status reason of the test case run summary.

" - } - }, - "runStartTime": { - "target": "smithy.api#Timestamp", - "traits": { - "smithy.api#documentation": "

The run start time of the test case run summary.

", - "smithy.api#required": {} - } - }, - "runEndTime": { - "target": "smithy.api#Timestamp", - "traits": { - "smithy.api#documentation": "

The run end time of the test case run summary.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Specifies the test case run summary.

" - } - }, - "com.amazonaws.apptest#TestCaseRunSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.apptest#TestCaseRunSummary" - } - }, - "com.amazonaws.apptest#TestCaseSummary": { - "type": "structure", - "members": { - "testCaseId": { - "target": "com.amazonaws.apptest#Identifier", - "traits": { - "smithy.api#documentation": "

The test case ID of the test case summary.

", - "smithy.api#required": {} - } - }, - "testCaseArn": { - "target": "com.amazonaws.apptest#Arn", - "traits": { - "smithy.api#documentation": "

The test case Amazon Resource Name (ARN) of the test case summary.

", - "smithy.api#required": {} - } - }, - "name": { - "target": "com.amazonaws.apptest#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the test case summary.

", - "smithy.api#required": {} - } - }, - "statusReason": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

The status reason of the test case summary.

" - } - }, - "latestVersion": { - "target": "com.amazonaws.apptest#Version", - "traits": { - "smithy.api#documentation": "

The latest version of the test case summary.

", - "smithy.api#required": {} - } - }, - "status": { - "target": "com.amazonaws.apptest#TestCaseLifecycle", - "traits": { - "smithy.api#documentation": "

The status of the test case summary.

", - "smithy.api#required": {} - } - }, - "creationTime": { - "target": "smithy.api#Timestamp", - "traits": { - "smithy.api#documentation": "

The creation time of the test case summary.

", - "smithy.api#required": {} - } - }, - "lastUpdateTime": { - "target": "smithy.api#Timestamp", - "traits": { - "smithy.api#documentation": "

The last update time of the test case summary.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Specifies a test case summary.

" - } - }, - "com.amazonaws.apptest#TestCaseSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.apptest#TestCaseSummary" - } - }, - "com.amazonaws.apptest#TestCases": { - "type": "union", - "members": { - "sequential": { - "target": "com.amazonaws.apptest#TestCaseList", - "traits": { - "smithy.api#documentation": "

The sequential of the test case.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Specifies test cases.

" - } - }, - "com.amazonaws.apptest#TestConfiguration": { - "type": "resource", - "identifiers": { - "testConfigurationId": { - "target": "com.amazonaws.apptest#Identifier" - } - }, - "create": { - "target": "com.amazonaws.apptest#CreateTestConfiguration" - }, - "read": { - "target": "com.amazonaws.apptest#GetTestConfiguration" - }, - "update": { - "target": "com.amazonaws.apptest#UpdateTestConfiguration" - }, - "delete": { - "target": "com.amazonaws.apptest#DeleteTestConfiguration" - }, - "list": { - "target": "com.amazonaws.apptest#ListTestConfigurations" - }, - "traits": { - "aws.api#arn": { - "template": "testconfiguration/{testConfigurationId}" - }, - "aws.iam#conditionKeys": [ - "aws:ResourceTag/${TagKey}" - ], - "aws.iam#disableConditionKeyInference": {} - } - }, - "com.amazonaws.apptest#TestConfigurationIdList": { - "type": "list", - "member": { - "target": "com.amazonaws.apptest#Identifier" - } - }, - "com.amazonaws.apptest#TestConfigurationLatestVersion": { - "type": "structure", - "members": { - "version": { - "target": "com.amazonaws.apptest#Version", - "traits": { - "smithy.api#documentation": "

The version of the test configuration latest version.

", - "smithy.api#required": {} - } - }, - "status": { - "target": "com.amazonaws.apptest#TestConfigurationLifecycle", - "traits": { - "smithy.api#documentation": "

The status of the test configuration latest version.

", - "smithy.api#required": {} - } - }, - "statusReason": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

The status reason of the test configuration latest version.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Specifies the latest version of the test configuration.

" - } - }, - "com.amazonaws.apptest#TestConfigurationLifecycle": { - "type": "enum", - "members": { - "ACTIVE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Active" - } - }, - "DELETING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Deleting" - } - } - } - }, - "com.amazonaws.apptest#TestConfigurationList": { - "type": "list", - "member": { - "target": "com.amazonaws.apptest#TestConfigurationSummary" - } - }, - "com.amazonaws.apptest#TestConfigurationSummary": { - "type": "structure", - "members": { - "testConfigurationId": { - "target": "com.amazonaws.apptest#Identifier", - "traits": { - "smithy.api#documentation": "

The test configuration ID of the test configuration summary.

", - "smithy.api#required": {} - } - }, - "name": { - "target": "com.amazonaws.apptest#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the test configuration summary.

", - "smithy.api#required": {} - } - }, - "statusReason": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

The status reason of the test configuration summary.

" - } - }, - "latestVersion": { - "target": "com.amazonaws.apptest#Version", - "traits": { - "smithy.api#documentation": "

The latest version of the test configuration summary.

", - "smithy.api#required": {} - } - }, - "testConfigurationArn": { - "target": "com.amazonaws.apptest#Arn", - "traits": { - "smithy.api#documentation": "

The test configuration ARN of the test configuration summary.

", - "smithy.api#required": {} - } - }, - "status": { - "target": "com.amazonaws.apptest#TestConfigurationLifecycle", - "traits": { - "smithy.api#documentation": "

The status of the test configuration summary.

", - "smithy.api#required": {} - } - }, - "creationTime": { - "target": "smithy.api#Timestamp", - "traits": { - "smithy.api#documentation": "

The creation time of the test configuration summary.

", - "smithy.api#required": {} - } - }, - "lastUpdateTime": { - "target": "smithy.api#Timestamp", - "traits": { - "smithy.api#documentation": "

The last update time of the test configuration summary.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Specifies a test configuration summary.

" - } - }, - "com.amazonaws.apptest#TestRun": { - "type": "resource", - "identifiers": { - "testRunId": { - "target": "com.amazonaws.apptest#Identifier" - } - }, - "create": { - "target": "com.amazonaws.apptest#StartTestRun" - }, - "delete": { - "target": "com.amazonaws.apptest#DeleteTestRun" - }, - "list": { - "target": "com.amazonaws.apptest#ListTestRuns" - }, - "operations": [ - { - "target": "com.amazonaws.apptest#GetTestRunStep" - }, - { - "target": "com.amazonaws.apptest#ListTestRunSteps" - }, - { - "target": "com.amazonaws.apptest#ListTestRunTestCases" - } - ], - "traits": { - "aws.api#arn": { - "template": "testrun/{testRunId}" - }, - "aws.iam#conditionKeys": [ - "aws:ResourceTag/${TagKey}" - ], - "aws.iam#disableConditionKeyInference": {} - } - }, - "com.amazonaws.apptest#TestRunIdList": { - "type": "list", - "member": { - "target": "com.amazonaws.apptest#Identifier" - } - }, - "com.amazonaws.apptest#TestRunStatus": { - "type": "enum", - "members": { - "SUCCESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Success" - } - }, - "RUNNING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Running" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Failed" - } - }, - "DELETING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Deleting" - } - } - } - }, - "com.amazonaws.apptest#TestRunStepSummary": { - "type": "structure", - "members": { - "stepName": { - "target": "com.amazonaws.apptest#ResourceName", - "traits": { - "smithy.api#documentation": "

The step name of the test run step summary.

", - "smithy.api#required": {} - } - }, - "testRunId": { - "target": "com.amazonaws.apptest#Identifier", - "traits": { - "smithy.api#documentation": "

The test run ID of the test run step summary.

", - "smithy.api#required": {} - } - }, - "testCaseId": { - "target": "com.amazonaws.apptest#Identifier", - "traits": { - "smithy.api#documentation": "

The test case ID of the test run step summary.

" - } - }, - "testCaseVersion": { - "target": "com.amazonaws.apptest#Version", - "traits": { - "smithy.api#documentation": "

The test case version of the test run step summary.

" - } - }, - "testSuiteId": { - "target": "com.amazonaws.apptest#Identifier", - "traits": { - "smithy.api#documentation": "

The test suite ID of the test run step summary.

" - } - }, - "testSuiteVersion": { - "target": "com.amazonaws.apptest#Version", - "traits": { - "smithy.api#documentation": "

The test suite version of the test run step summary.

" - } - }, - "beforeStep": { - "target": "smithy.api#Boolean", - "traits": { - "smithy.api#documentation": "

The before step of the test run step summary.

" - } - }, - "afterStep": { - "target": "smithy.api#Boolean", - "traits": { - "smithy.api#documentation": "

The after step of the test run step summary.

" - } - }, - "status": { - "target": "com.amazonaws.apptest#StepRunStatus", - "traits": { - "smithy.api#documentation": "

The status of the test run step summary.

", - "smithy.api#required": {} - } - }, - "statusReason": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

The status reason of the test run step summary.

" - } - }, - "runStartTime": { - "target": "smithy.api#Timestamp", - "traits": { - "smithy.api#documentation": "

The run start time of the test run step summary.

", - "smithy.api#required": {} - } - }, - "runEndTime": { - "target": "smithy.api#Timestamp", - "traits": { - "smithy.api#documentation": "

The run end time of the test run step summary.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Specifies a test run step summary.

" - } - }, - "com.amazonaws.apptest#TestRunStepSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.apptest#TestRunStepSummary" - } - }, - "com.amazonaws.apptest#TestRunSummary": { - "type": "structure", - "members": { - "testRunId": { - "target": "com.amazonaws.apptest#Identifier", - "traits": { - "smithy.api#documentation": "

The test run ID of the test run summary.

", - "smithy.api#required": {} - } - }, - "testRunArn": { - "target": "com.amazonaws.apptest#Arn", - "traits": { - "smithy.api#documentation": "

The test run ARN of the test run summary.

", - "smithy.api#required": {} - } - }, - "testSuiteId": { - "target": "com.amazonaws.apptest#Identifier", - "traits": { - "smithy.api#documentation": "

The test suite ID of the test run summary.

", - "smithy.api#required": {} - } - }, - "testSuiteVersion": { - "target": "com.amazonaws.apptest#Version", - "traits": { - "smithy.api#documentation": "

The test suite version of the test run summary.

", - "smithy.api#required": {} - } - }, - "testConfigurationId": { - "target": "com.amazonaws.apptest#Identifier", - "traits": { - "smithy.api#documentation": "

The test configuration ID of the test run summary.

" - } - }, - "testConfigurationVersion": { - "target": "com.amazonaws.apptest#Version", - "traits": { - "smithy.api#documentation": "

The test configuration version of the test run summary.

" - } - }, - "status": { - "target": "com.amazonaws.apptest#TestRunStatus", - "traits": { - "smithy.api#documentation": "

The status of the test run summary.

", - "smithy.api#required": {} - } - }, - "statusReason": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

The status reason of the test run summary.

" - } - }, - "runStartTime": { - "target": "smithy.api#Timestamp", - "traits": { - "smithy.api#documentation": "

The run start time of the test run summary.

", - "smithy.api#required": {} - } - }, - "runEndTime": { - "target": "smithy.api#Timestamp", - "traits": { - "smithy.api#documentation": "

The run end time of the test run summary.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Specifies a test run summary.

" - } - }, - "com.amazonaws.apptest#TestRunSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.apptest#TestRunSummary" - } - }, - "com.amazonaws.apptest#TestSuite": { - "type": "resource", - "identifiers": { - "testSuiteId": { - "target": "com.amazonaws.apptest#Identifier" - } - }, - "create": { - "target": "com.amazonaws.apptest#CreateTestSuite" - }, - "read": { - "target": "com.amazonaws.apptest#GetTestSuite" - }, - "update": { - "target": "com.amazonaws.apptest#UpdateTestSuite" - }, - "delete": { - "target": "com.amazonaws.apptest#DeleteTestSuite" - }, - "list": { - "target": "com.amazonaws.apptest#ListTestSuites" - }, - "traits": { - "aws.api#arn": { - "template": "testsuite/{testSuiteId}" - }, - "aws.iam#conditionKeys": [ - "aws:ResourceTag/${TagKey}" - ], - "aws.iam#disableConditionKeyInference": {} - } - }, - "com.amazonaws.apptest#TestSuiteIdList": { - "type": "list", - "member": { - "target": "com.amazonaws.apptest#Identifier" - } - }, - "com.amazonaws.apptest#TestSuiteLatestVersion": { - "type": "structure", - "members": { - "version": { - "target": "com.amazonaws.apptest#Version", - "traits": { - "smithy.api#documentation": "

The version of the test suite latest version.

", - "smithy.api#required": {} - } - }, - "status": { - "target": "com.amazonaws.apptest#TestSuiteLifecycle", - "traits": { - "smithy.api#documentation": "

The status of the test suite latest version.

", - "smithy.api#required": {} - } - }, - "statusReason": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

The status reason of the test suite latest version.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Specifies the latest version of a test suite.

" - } - }, - "com.amazonaws.apptest#TestSuiteLifecycle": { - "type": "enum", - "members": { - "CREATING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Creating" - } - }, - "UPDATING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Updating" - } - }, - "ACTIVE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Active" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Failed" - } - }, - "DELETING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Deleting" - } - } - } - }, - "com.amazonaws.apptest#TestSuiteList": { - "type": "list", - "member": { - "target": "com.amazonaws.apptest#TestSuiteSummary" - } - }, - "com.amazonaws.apptest#TestSuiteSummary": { - "type": "structure", - "members": { - "testSuiteId": { - "target": "com.amazonaws.apptest#Identifier", - "traits": { - "smithy.api#documentation": "

The test suite ID of the test suite summary.

", - "smithy.api#required": {} - } - }, - "name": { - "target": "com.amazonaws.apptest#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the test suite summary.

", - "smithy.api#required": {} - } - }, - "statusReason": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

The status reason of the test suite summary.

" - } - }, - "latestVersion": { - "target": "com.amazonaws.apptest#Version", - "traits": { - "smithy.api#documentation": "

The latest version of the test suite summary.

", - "smithy.api#required": {} - } - }, - "testSuiteArn": { - "target": "com.amazonaws.apptest#Arn", - "traits": { - "smithy.api#documentation": "

The test suite Amazon Resource Name (ARN) of the test suite summary.

", - "smithy.api#required": {} - } - }, - "status": { - "target": "com.amazonaws.apptest#TestSuiteLifecycle", - "traits": { - "smithy.api#documentation": "

The status of the test suite summary.

", - "smithy.api#required": {} - } - }, - "creationTime": { - "target": "smithy.api#Timestamp", - "traits": { - "smithy.api#documentation": "

The creation time of the test suite summary.

", - "smithy.api#required": {} - } - }, - "lastUpdateTime": { - "target": "smithy.api#Timestamp", - "traits": { - "smithy.api#documentation": "

The last update time of the test suite summary.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Specifies the test suite summary.

" - } - }, - "com.amazonaws.apptest#ThrottlingException": { - "type": "structure", - "members": { - "message": { - "target": "smithy.api#String", - "traits": { - "smithy.api#required": {} - } - }, - "serviceCode": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

The service code of requests that exceed the limit.

" - } - }, - "quotaCode": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

The quota code of requests that exceed the limit.

" - } - }, - "retryAfterSeconds": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#documentation": "

The number of seconds to retry after for requests that exceed the limit.

", - "smithy.api#httpHeader": "Retry-After" - } - } - }, - "traits": { - "smithy.api#documentation": "

The number of requests made exceeds the limit.

", - "smithy.api#error": "client", - "smithy.api#httpError": 429, - "smithy.api#retryable": { - "throttling": true - } - } - }, - "com.amazonaws.apptest#UntagResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.apptest#UntagResourceRequest" - }, - "output": { - "target": "com.amazonaws.apptest#UntagResourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.apptest#AccessDeniedException" - }, - { - "target": "com.amazonaws.apptest#InternalServerException" - }, - { - "target": "com.amazonaws.apptest#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.apptest#ThrottlingException" - }, - { - "target": "com.amazonaws.apptest#ValidationException" - } - ], - "traits": { - "aws.iam#conditionKeys": [ - "aws:TagKeys" - ], - "aws.iam#iamAction": { - "documentation": "Grants permission to untag a resource" - }, - "smithy.api#documentation": "

Untags a resource.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/tags/{resourceArn}", - "code": 200 - }, - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.apptest#UntagResourceRequest": { - "type": "structure", - "members": { - "resourceArn": { - "target": "com.amazonaws.apptest#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "tagKeys": { - "target": "com.amazonaws.apptest#TagKeyList", - "traits": { - "smithy.api#documentation": "

The tag keys of the resource.

", - "smithy.api#httpQuery": "tagKeys", - "smithy.api#required": {} - } - } - }, - "traits": { - "aws.api#data": "tagging", - "smithy.api#input": {}, - "smithy.api#references": [ - { - "resource": "com.amazonaws.apptest#TestCase", - "ids": { - "testCaseId": "resourceArn" - } - }, - { - "resource": "com.amazonaws.apptest#TestSuite", - "ids": { - "testSuiteId": "resourceArn" - } - }, - { - "resource": "com.amazonaws.apptest#TestConfiguration", - "ids": { - "testConfigurationId": "resourceArn" - } - }, - { - "resource": "com.amazonaws.apptest#TestRun", - "ids": { - "testRunId": "resourceArn" - } - } - ] - } - }, - "com.amazonaws.apptest#UntagResourceResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.apptest#UpdateTestCase": { - "type": "operation", - "input": { - "target": "com.amazonaws.apptest#UpdateTestCaseRequest" - }, - "output": { - "target": "com.amazonaws.apptest#UpdateTestCaseResponse" - }, - "errors": [ - { - "target": "com.amazonaws.apptest#AccessDeniedException" - }, - { - "target": "com.amazonaws.apptest#ConflictException" - }, - { - "target": "com.amazonaws.apptest#InternalServerException" - }, - { - "target": "com.amazonaws.apptest#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.apptest#ThrottlingException" - }, - { - "target": "com.amazonaws.apptest#ValidationException" - } - ], - "traits": { - "aws.iam#iamAction": { - "name": "UpdateTestCase", - "documentation": "Grants permission to update a test case" - }, - "smithy.api#documentation": "

Updates a test case.

", - "smithy.api#http": { - "method": "PATCH", - "uri": "/testcases/{testCaseId}", - "code": 200 - } - } - }, - "com.amazonaws.apptest#UpdateTestCaseRequest": { - "type": "structure", - "members": { - "testCaseId": { - "target": "com.amazonaws.apptest#Identifier", - "traits": { - "smithy.api#documentation": "

The test case ID of the test case.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.apptest#ResourceDescription", - "traits": { - "smithy.api#documentation": "

The description of the test case.

" - } - }, - "steps": { - "target": "com.amazonaws.apptest#StepList", - "traits": { - "smithy.api#documentation": "

The steps of the test case.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.apptest#UpdateTestCaseResponse": { - "type": "structure", - "members": { - "testCaseId": { - "target": "com.amazonaws.apptest#Identifier", - "traits": { - "smithy.api#documentation": "

The test case ID of the test case.

", - "smithy.api#required": {} - } - }, - "testCaseVersion": { - "target": "com.amazonaws.apptest#Version", - "traits": { - "smithy.api#documentation": "

The test case version of the test case.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.apptest#UpdateTestConfiguration": { - "type": "operation", - "input": { - "target": "com.amazonaws.apptest#UpdateTestConfigurationRequest" - }, - "output": { - "target": "com.amazonaws.apptest#UpdateTestConfigurationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.apptest#AccessDeniedException" - }, - { - "target": "com.amazonaws.apptest#ConflictException" - }, - { - "target": "com.amazonaws.apptest#InternalServerException" - }, - { - "target": "com.amazonaws.apptest#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.apptest#ThrottlingException" - }, - { - "target": "com.amazonaws.apptest#ValidationException" - } - ], - "traits": { - "aws.iam#iamAction": { - "name": "UpdateTestConfiguration", - "documentation": "Grants permission to update a test configuration" - }, - "smithy.api#documentation": "

Updates a test configuration.

", - "smithy.api#http": { - "method": "PATCH", - "uri": "/testconfigurations/{testConfigurationId}", - "code": 200 - } - } - }, - "com.amazonaws.apptest#UpdateTestConfigurationRequest": { - "type": "structure", - "members": { - "testConfigurationId": { - "target": "com.amazonaws.apptest#Identifier", - "traits": { - "smithy.api#documentation": "

The test configuration ID of the test configuration.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.apptest#ResourceDescription", - "traits": { - "smithy.api#documentation": "

The description of the test configuration.

" - } - }, - "resources": { - "target": "com.amazonaws.apptest#ResourceList", - "traits": { - "smithy.api#documentation": "

The resources of the test configuration.

" - } - }, - "properties": { - "target": "com.amazonaws.apptest#Properties", - "traits": { - "smithy.api#documentation": "

The properties of the test configuration.

" - } - }, - "serviceSettings": { - "target": "com.amazonaws.apptest#ServiceSettings", - "traits": { - "smithy.api#documentation": "

The service settings of the test configuration.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.apptest#UpdateTestConfigurationResponse": { - "type": "structure", - "members": { - "testConfigurationId": { - "target": "com.amazonaws.apptest#Identifier", - "traits": { - "smithy.api#documentation": "

The configuration ID of the test configuration.

", - "smithy.api#required": {} - } - }, - "testConfigurationVersion": { - "target": "com.amazonaws.apptest#Version", - "traits": { - "smithy.api#documentation": "

The configuration version of the test configuration.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.apptest#UpdateTestSuite": { - "type": "operation", - "input": { - "target": "com.amazonaws.apptest#UpdateTestSuiteRequest" - }, - "output": { - "target": "com.amazonaws.apptest#UpdateTestSuiteResponse" - }, - "errors": [ - { - "target": "com.amazonaws.apptest#AccessDeniedException" - }, - { - "target": "com.amazonaws.apptest#ConflictException" - }, - { - "target": "com.amazonaws.apptest#InternalServerException" - }, - { - "target": "com.amazonaws.apptest#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.apptest#ThrottlingException" - }, - { - "target": "com.amazonaws.apptest#ValidationException" - } - ], - "traits": { - "aws.iam#iamAction": { - "name": "UpdateTestSuite", - "documentation": "Grants permission to update a test suite" - }, - "smithy.api#documentation": "

Updates a test suite.

", - "smithy.api#http": { - "method": "PATCH", - "uri": "/testsuites/{testSuiteId}", - "code": 200 - } - } - }, - "com.amazonaws.apptest#UpdateTestSuiteRequest": { - "type": "structure", - "members": { - "testSuiteId": { - "target": "com.amazonaws.apptest#Identifier", - "traits": { - "smithy.api#documentation": "

The test suite ID of the test suite.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.apptest#ResourceDescription", - "traits": { - "smithy.api#documentation": "

The description of the test suite.

" - } - }, - "beforeSteps": { - "target": "com.amazonaws.apptest#StepList", - "traits": { - "smithy.api#documentation": "

The before steps for the test suite.

" - } - }, - "afterSteps": { - "target": "com.amazonaws.apptest#StepList", - "traits": { - "smithy.api#documentation": "

The after steps of the test suite.

" - } - }, - "testCases": { - "target": "com.amazonaws.apptest#TestCases", - "traits": { - "smithy.api#documentation": "

The test cases in the test suite.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.apptest#UpdateTestSuiteResponse": { - "type": "structure", - "members": { - "testSuiteId": { - "target": "com.amazonaws.apptest#Identifier", - "traits": { - "smithy.api#documentation": "

The test suite ID of the test suite.

", - "smithy.api#required": {} - } - }, - "testSuiteVersion": { - "target": "com.amazonaws.apptest#Version", - "traits": { - "smithy.api#documentation": "

The test suite version of the test suite.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.apptest#ValidationException": { - "type": "structure", - "members": { - "message": { - "target": "smithy.api#String", - "traits": { - "smithy.api#required": {} - } - }, - "reason": { - "target": "com.amazonaws.apptest#ValidationExceptionReason", - "traits": { - "smithy.api#documentation": "

The reason for the validation exception.

" - } - }, - "fieldList": { - "target": "com.amazonaws.apptest#ValidationExceptionFieldList", - "traits": { - "smithy.api#documentation": "

The field list of the validation exception.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

One or more parameter provided in the request is not valid.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.apptest#ValidationExceptionField": { - "type": "structure", - "members": { - "name": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

The name of the validation exception field.

", - "smithy.api#required": {} - } - }, - "message": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

The message stating reason for why service validation failed.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Specifies a validation exception field.

" - } - }, - "com.amazonaws.apptest#ValidationExceptionFieldList": { - "type": "list", - "member": { - "target": "com.amazonaws.apptest#ValidationExceptionField" - } - }, - "com.amazonaws.apptest#ValidationExceptionReason": { - "type": "enum", - "members": { - "UNKNOWN_OPERATION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "unknownOperation" - } - }, - "CANNOT_PARSE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "cannotParse" - } - }, - "FIELD_VALIDATION_FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "fieldValidationFailed" - } - }, - "OTHER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "other" - } - } - } - }, - "com.amazonaws.apptest#Variable": { - "type": "string", - "traits": { - "smithy.api#pattern": "^\\S{1,1000}$" - } - }, - "com.amazonaws.apptest#Version": { - "type": "integer" - } - } -} \ No newline at end of file diff --git a/models/iotfleethub/service/2020-11-03/iotfleethub-2020-11-03.json b/models/iotfleethub/service/2020-11-03/iotfleethub-2020-11-03.json deleted file mode 100644 index ff99f421..00000000 --- a/models/iotfleethub/service/2020-11-03/iotfleethub-2020-11-03.json +++ /dev/null @@ -1,1768 +0,0 @@ -{ - "smithy": "2.0", - "metadata": { - "suppressions": [ - { - "id": "HttpMethodSemantics", - "namespace": "*" - }, - { - "id": "HttpResponseCodeSemantics", - "namespace": "*" - }, - { - "id": "PaginatedTrait", - "namespace": "*" - }, - { - "id": "HttpHeaderTrait", - "namespace": "*" - }, - { - "id": "HttpUriConflict", - "namespace": "*" - }, - { - "id": "Service", - "namespace": "*" - } - ] - }, - "shapes": { - "com.amazonaws.iotfleethub#AWSIoTFleetHub": { - "type": "service", - "version": "2020-11-03", - "operations": [ - { - "target": "com.amazonaws.iotfleethub#CreateApplication" - }, - { - "target": "com.amazonaws.iotfleethub#DeleteApplication" - }, - { - "target": "com.amazonaws.iotfleethub#DescribeApplication" - }, - { - "target": "com.amazonaws.iotfleethub#ListApplications" - }, - { - "target": "com.amazonaws.iotfleethub#ListTagsForResource" - }, - { - "target": "com.amazonaws.iotfleethub#TagResource" - }, - { - "target": "com.amazonaws.iotfleethub#UntagResource" - }, - { - "target": "com.amazonaws.iotfleethub#UpdateApplication" - } - ], - "traits": { - "aws.api#service": { - "sdkId": "IoTFleetHub", - "arnNamespace": "iotfleethub", - "cloudFormationName": "IoTFleetHub", - "cloudTrailEventSource": "iotfleethub.amazonaws.com", - "endpointPrefix": "api.fleethub.iot" - }, - "aws.auth#sigv4": { - "name": "iotfleethub" - }, - "aws.protocols#restJson1": {}, - "smithy.api#documentation": "

With Fleet Hub for IoT Device Management you can build stand-alone web applications for monitoring the health of your device fleets.

", - "smithy.api#title": "AWS IoT Fleet Hub", - "smithy.rules#endpointRuleSet": { - "version": "1.0", - "parameters": { - "Region": { - "builtIn": "AWS::Region", - "required": false, - "documentation": "The AWS region used to dispatch the request.", - "type": "String" - }, - "UseDualStack": { - "builtIn": "AWS::UseDualStack", - "required": true, - "default": false, - "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", - "type": "Boolean" - }, - "UseFIPS": { - "builtIn": "AWS::UseFIPS", - "required": true, - "default": false, - "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", - "type": "Boolean" - }, - "Endpoint": { - "builtIn": "SDK::Endpoint", - "required": false, - "documentation": "Override the endpoint used to send this request", - "type": "String" - } - }, - "rules": [ - { - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Endpoint" - } - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "error": "Invalid Configuration: FIPS and custom endpoint are not supported", - "type": "error" - }, - { - "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" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Region" - } - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "aws.partition", - "argv": [ - { - "ref": "Region" - } - ], - "assign": "PartitionResult" - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - }, - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://api.fleethub.iot-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - }, - true - ] - } - ], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://api.fleethub.iot-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://api.fleethub.iot.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [], - "endpoint": { - "url": "https://api.fleethub.iot.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" - } - ] - }, - "smithy.rules#endpointTests": { - "testCases": [ - { - "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://api.fleethub.iot.ap-northeast-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-northeast-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://api.fleethub.iot.ap-northeast-2.amazonaws.com" - } - }, - "params": { - "Region": "ap-northeast-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://api.fleethub.iot.ap-south-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-south-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://api.fleethub.iot.ap-southeast-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-southeast-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://api.fleethub.iot.ap-southeast-2.amazonaws.com" - } - }, - "params": { - "Region": "ap-southeast-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://api.fleethub.iot.ca-central-1.amazonaws.com" - } - }, - "params": { - "Region": "ca-central-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ca-central-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://api.fleethub.iot-fips.ca-central-1.amazonaws.com" - } - }, - "params": { - "Region": "ca-central-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://api.fleethub.iot.eu-central-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-central-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://api.fleethub.iot.eu-north-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-north-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://api.fleethub.iot.eu-west-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-west-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://api.fleethub.iot.eu-west-2.amazonaws.com" - } - }, - "params": { - "Region": "eu-west-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://api.fleethub.iot.us-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://api.fleethub.iot-fips.us-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://api.fleethub.iot.us-east-2.amazonaws.com" - } - }, - "params": { - "Region": "us-east-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-2 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://api.fleethub.iot-fips.us-east-2.amazonaws.com" - } - }, - "params": { - "Region": "us-east-2", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://api.fleethub.iot.us-west-2.amazonaws.com" - } - }, - "params": { - "Region": "us-west-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-west-2 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://api.fleethub.iot-fips.us-west-2.amazonaws.com" - } - }, - "params": { - "Region": "us-west-2", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://api.fleethub.iot-fips.us-east-1.api.aws" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://api.fleethub.iot.us-east-1.api.aws" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://api.fleethub.iot-fips.cn-north-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://api.fleethub.iot-fips.cn-north-1.amazonaws.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://api.fleethub.iot.cn-north-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://api.fleethub.iot.cn-north-1.amazonaws.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://api.fleethub.iot-fips.us-gov-east-1.api.aws" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://api.fleethub.iot-fips.us-gov-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://api.fleethub.iot.us-gov-east-1.api.aws" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://api.fleethub.iot.us-gov-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://api.fleethub.iot-fips.us-iso-east-1.c2s.ic.gov" - } - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://api.fleethub.iot.us-iso-east-1.c2s.ic.gov" - } - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://api.fleethub.iot-fips.us-isob-east-1.sc2s.sgov.gov" - } - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://api.fleethub.iot.us-isob-east-1.sc2s.sgov.gov" - } - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", - "expect": { - "endpoint": { - "url": "https://example.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": false, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", - "expect": { - "endpoint": { - "url": "https://example.com" - } - }, - "params": { - "UseFIPS": false, - "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": { - "Region": "us-east-1", - "UseFIPS": true, - "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": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": true, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "Missing region", - "expect": { - "error": "Invalid Configuration: Missing Region" - } - } - ], - "version": "1.0" - } - } - }, - "com.amazonaws.iotfleethub#ApplicationState": { - "type": "enum", - "members": { - "CREATING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CREATING" - } - }, - "DELETING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETING" - } - }, - "ACTIVE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ACTIVE" - } - }, - "CREATE_FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CREATE_FAILED" - } - }, - "DELETE_FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETE_FAILED" - } - } - } - }, - "com.amazonaws.iotfleethub#ApplicationSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.iotfleethub#ApplicationSummary" - } - }, - "com.amazonaws.iotfleethub#ApplicationSummary": { - "type": "structure", - "members": { - "applicationId": { - "target": "com.amazonaws.iotfleethub#Id", - "traits": { - "smithy.api#documentation": "

The unique Id of the web application.

", - "smithy.api#required": {} - } - }, - "applicationName": { - "target": "com.amazonaws.iotfleethub#Name", - "traits": { - "smithy.api#documentation": "

The name of the web application.

", - "smithy.api#required": {} - } - }, - "applicationDescription": { - "target": "com.amazonaws.iotfleethub#Description", - "traits": { - "smithy.api#documentation": "

An optional description of the web application.

" - } - }, - "applicationUrl": { - "target": "com.amazonaws.iotfleethub#Url", - "traits": { - "smithy.api#documentation": "

The URL of the web application.

", - "smithy.api#required": {} - } - }, - "applicationCreationDate": { - "target": "com.amazonaws.iotfleethub#Timestamp", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The date (in Unix epoch time) when the web application was created.

" - } - }, - "applicationLastUpdateDate": { - "target": "com.amazonaws.iotfleethub#Timestamp", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The date (in Unix epoch time) when the web application was last updated.

" - } - }, - "applicationState": { - "target": "com.amazonaws.iotfleethub#ApplicationState", - "traits": { - "smithy.api#documentation": "

The current state of the web application.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A summary of information about a Fleet Hub for IoT Device Management web application.

" - } - }, - "com.amazonaws.iotfleethub#Arn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1600 - }, - "smithy.api#pattern": "^arn:[!-~]+$" - } - }, - "com.amazonaws.iotfleethub#ClientRequestToken": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - }, - "smithy.api#pattern": "^[a-zA-Z0-9-_]+$" - } - }, - "com.amazonaws.iotfleethub#ConflictException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.iotfleethub#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "

The request conflicts with the current state of the resource.

", - "smithy.api#error": "client", - "smithy.api#httpError": 409 - } - }, - "com.amazonaws.iotfleethub#CreateApplication": { - "type": "operation", - "input": { - "target": "com.amazonaws.iotfleethub#CreateApplicationRequest" - }, - "output": { - "target": "com.amazonaws.iotfleethub#CreateApplicationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.iotfleethub#InternalFailureException" - }, - { - "target": "com.amazonaws.iotfleethub#InvalidRequestException" - }, - { - "target": "com.amazonaws.iotfleethub#LimitExceededException" - }, - { - "target": "com.amazonaws.iotfleethub#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a Fleet Hub for IoT Device Management web application.

\n

When creating a Fleet Hub application, you must create an organization instance of\n IAM Identity Center if you don't already have one. The Fleet Hub application you create must also be in\n the same Amazon Web Services Region of the organization instance of IAM Identity Center. For more information see Enabling\n IAM Identity Center and Organization instances of IAM Identity Center.

", - "smithy.api#http": { - "method": "POST", - "uri": "/applications", - "code": 201 - } - } - }, - "com.amazonaws.iotfleethub#CreateApplicationRequest": { - "type": "structure", - "members": { - "applicationName": { - "target": "com.amazonaws.iotfleethub#Name", - "traits": { - "smithy.api#documentation": "

The name of the web application.

", - "smithy.api#required": {} - } - }, - "applicationDescription": { - "target": "com.amazonaws.iotfleethub#Description", - "traits": { - "smithy.api#documentation": "

An optional description of the web application.

" - } - }, - "clientToken": { - "target": "com.amazonaws.iotfleethub#ClientRequestToken", - "traits": { - "smithy.api#documentation": "

A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. \n Don't reuse this client token if a new idempotent request is required.

", - "smithy.api#idempotencyToken": {} - } - }, - "roleArn": { - "target": "com.amazonaws.iotfleethub#Arn", - "traits": { - "smithy.api#documentation": "

The ARN of the role that the web application assumes when it interacts with Amazon Web Services IoT Core.

\n \n

The name of the role must be in the form AWSIotFleetHub_random_string\n .

\n ", - "smithy.api#required": {} - } - }, - "tags": { - "target": "com.amazonaws.iotfleethub#TagMap", - "traits": { - "smithy.api#documentation": "

A set of key/value pairs that you can use to manage the web application resource.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.iotfleethub#CreateApplicationResponse": { - "type": "structure", - "members": { - "applicationId": { - "target": "com.amazonaws.iotfleethub#Id", - "traits": { - "smithy.api#documentation": "

The unique Id of the web application.

", - "smithy.api#required": {} - } - }, - "applicationArn": { - "target": "com.amazonaws.iotfleethub#Arn", - "traits": { - "smithy.api#documentation": "

The ARN of the web application.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.iotfleethub#DeleteApplication": { - "type": "operation", - "input": { - "target": "com.amazonaws.iotfleethub#DeleteApplicationRequest" - }, - "output": { - "target": "com.amazonaws.iotfleethub#DeleteApplicationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.iotfleethub#InternalFailureException" - }, - { - "target": "com.amazonaws.iotfleethub#InvalidRequestException" - }, - { - "target": "com.amazonaws.iotfleethub#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.iotfleethub#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes a Fleet Hub for IoT Device Management web application.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/applications/{applicationId}", - "code": 204 - } - } - }, - "com.amazonaws.iotfleethub#DeleteApplicationRequest": { - "type": "structure", - "members": { - "applicationId": { - "target": "com.amazonaws.iotfleethub#Id", - "traits": { - "smithy.api#documentation": "

The unique Id of the web application.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "clientToken": { - "target": "com.amazonaws.iotfleethub#ClientRequestToken", - "traits": { - "smithy.api#documentation": "

A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. \n Don't reuse this client token if a new idempotent request is required.

", - "smithy.api#httpQuery": "clientToken", - "smithy.api#idempotencyToken": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.iotfleethub#DeleteApplicationResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.iotfleethub#DescribeApplication": { - "type": "operation", - "input": { - "target": "com.amazonaws.iotfleethub#DescribeApplicationRequest" - }, - "output": { - "target": "com.amazonaws.iotfleethub#DescribeApplicationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.iotfleethub#InternalFailureException" - }, - { - "target": "com.amazonaws.iotfleethub#InvalidRequestException" - }, - { - "target": "com.amazonaws.iotfleethub#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.iotfleethub#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Gets information about a Fleet Hub for IoT Device Management web application.

", - "smithy.api#http": { - "method": "GET", - "uri": "/applications/{applicationId}", - "code": 200 - } - } - }, - "com.amazonaws.iotfleethub#DescribeApplicationRequest": { - "type": "structure", - "members": { - "applicationId": { - "target": "com.amazonaws.iotfleethub#Id", - "traits": { - "smithy.api#documentation": "

The unique Id of the web application.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.iotfleethub#DescribeApplicationResponse": { - "type": "structure", - "members": { - "applicationId": { - "target": "com.amazonaws.iotfleethub#Id", - "traits": { - "smithy.api#documentation": "

The unique Id of the web application.

", - "smithy.api#required": {} - } - }, - "applicationArn": { - "target": "com.amazonaws.iotfleethub#Arn", - "traits": { - "smithy.api#documentation": "

The ARN of the web application.

", - "smithy.api#required": {} - } - }, - "applicationName": { - "target": "com.amazonaws.iotfleethub#Name", - "traits": { - "smithy.api#documentation": "

The name of the web application.

", - "smithy.api#required": {} - } - }, - "applicationDescription": { - "target": "com.amazonaws.iotfleethub#Description", - "traits": { - "smithy.api#documentation": "

An optional description of the web application.

" - } - }, - "applicationUrl": { - "target": "com.amazonaws.iotfleethub#Url", - "traits": { - "smithy.api#documentation": "

The URL of the web application.

", - "smithy.api#required": {} - } - }, - "applicationState": { - "target": "com.amazonaws.iotfleethub#ApplicationState", - "traits": { - "smithy.api#documentation": "

The current state of the web application.

", - "smithy.api#required": {} - } - }, - "applicationCreationDate": { - "target": "com.amazonaws.iotfleethub#Timestamp", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The date (in Unix epoch time) when the application was created.

", - "smithy.api#required": {} - } - }, - "applicationLastUpdateDate": { - "target": "com.amazonaws.iotfleethub#Timestamp", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The date (in Unix epoch time) when the application was last updated.

", - "smithy.api#required": {} - } - }, - "roleArn": { - "target": "com.amazonaws.iotfleethub#Arn", - "traits": { - "smithy.api#documentation": "

The ARN of the role that the web application assumes when it interacts with Amazon Web Services IoT Core.

", - "smithy.api#required": {} - } - }, - "ssoClientId": { - "target": "com.amazonaws.iotfleethub#SsoClientId", - "traits": { - "smithy.api#documentation": "

The Id of the single sign-on client that you use to authenticate and authorize users on the web application.

" - } - }, - "errorMessage": { - "target": "com.amazonaws.iotfleethub#ErrorMessage", - "traits": { - "smithy.api#documentation": "

A message that explains any failures included in the applicationState response field. This message \n explains failures in the CreateApplication and DeleteApplication actions.

" - } - }, - "tags": { - "target": "com.amazonaws.iotfleethub#TagMap", - "traits": { - "smithy.api#documentation": "

A set of key/value pairs that you can use to manage the web application resource.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.iotfleethub#Description": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2048 - }, - "smithy.api#pattern": "^[ -~]*$" - } - }, - "com.amazonaws.iotfleethub#ErrorMessage": { - "type": "string" - }, - "com.amazonaws.iotfleethub#Id": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 36, - "max": 36 - }, - "smithy.api#pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" - } - }, - "com.amazonaws.iotfleethub#InternalFailureException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.iotfleethub#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "

An unexpected error has occurred.

", - "smithy.api#error": "server", - "smithy.api#httpError": 500 - } - }, - "com.amazonaws.iotfleethub#InvalidRequestException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.iotfleethub#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "

The request is not valid.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.iotfleethub#LimitExceededException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.iotfleethub#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "

A limit has been exceeded.

", - "smithy.api#error": "client", - "smithy.api#httpError": 410 - } - }, - "com.amazonaws.iotfleethub#ListApplications": { - "type": "operation", - "input": { - "target": "com.amazonaws.iotfleethub#ListApplicationsRequest" - }, - "output": { - "target": "com.amazonaws.iotfleethub#ListApplicationsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.iotfleethub#InternalFailureException" - }, - { - "target": "com.amazonaws.iotfleethub#InvalidRequestException" - }, - { - "target": "com.amazonaws.iotfleethub#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Gets a list of Fleet Hub for IoT Device Management web applications for the current account.

", - "smithy.api#http": { - "method": "GET", - "uri": "/applications", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "items": "applicationSummaries" - } - } - }, - "com.amazonaws.iotfleethub#ListApplicationsRequest": { - "type": "structure", - "members": { - "nextToken": { - "target": "com.amazonaws.iotfleethub#NextToken", - "traits": { - "smithy.api#documentation": "

A token used to get the next set of results.

", - "smithy.api#httpQuery": "nextToken" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.iotfleethub#ListApplicationsResponse": { - "type": "structure", - "members": { - "applicationSummaries": { - "target": "com.amazonaws.iotfleethub#ApplicationSummaries", - "traits": { - "smithy.api#documentation": "

An array of objects that provide summaries of information about the web applications in the list.

" - } - }, - "nextToken": { - "target": "com.amazonaws.iotfleethub#NextToken", - "traits": { - "smithy.api#documentation": "

A token used to get the next set of results.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.iotfleethub#ListTagsForResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.iotfleethub#ListTagsForResourceRequest" - }, - "output": { - "target": "com.amazonaws.iotfleethub#ListTagsForResourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.iotfleethub#InternalFailureException" - }, - { - "target": "com.amazonaws.iotfleethub#InvalidRequestException" - }, - { - "target": "com.amazonaws.iotfleethub#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists the tags for the specified resource.

", - "smithy.api#http": { - "method": "GET", - "uri": "/tags/{resourceArn}", - "code": 200 - } - } - }, - "com.amazonaws.iotfleethub#ListTagsForResourceRequest": { - "type": "structure", - "members": { - "resourceArn": { - "target": "com.amazonaws.iotfleethub#ResourceArn", - "traits": { - "smithy.api#documentation": "

The ARN of the resource.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.iotfleethub#ListTagsForResourceResponse": { - "type": "structure", - "members": { - "tags": { - "target": "com.amazonaws.iotfleethub#TagMap", - "traits": { - "smithy.api#documentation": "

The list of tags assigned to the resource.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.iotfleethub#Name": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 100 - }, - "smithy.api#pattern": "^[ -~]*$" - } - }, - "com.amazonaws.iotfleethub#NextToken": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2048 - }, - "smithy.api#pattern": "^[A-Za-z0-9+/=]+$" - } - }, - "com.amazonaws.iotfleethub#ResourceArn": { - "type": "string" - }, - "com.amazonaws.iotfleethub#ResourceNotFoundException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.iotfleethub#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "

The specified resource does not exist.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.iotfleethub#SsoClientId": { - "type": "string" - }, - "com.amazonaws.iotfleethub#TagKey": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - }, - "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" - } - }, - "com.amazonaws.iotfleethub#TagKeyList": { - "type": "list", - "member": { - "target": "com.amazonaws.iotfleethub#TagKey" - } - }, - "com.amazonaws.iotfleethub#TagMap": { - "type": "map", - "key": { - "target": "com.amazonaws.iotfleethub#TagKey" - }, - "value": { - "target": "com.amazonaws.iotfleethub#TagValue" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 50 - } - } - }, - "com.amazonaws.iotfleethub#TagResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.iotfleethub#TagResourceRequest" - }, - "output": { - "target": "com.amazonaws.iotfleethub#TagResourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.iotfleethub#InternalFailureException" - }, - { - "target": "com.amazonaws.iotfleethub#InvalidRequestException" - }, - { - "target": "com.amazonaws.iotfleethub#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "

Adds to or modifies the tags of the specified resource. Tags are metadata which can be used to manage a resource.

", - "smithy.api#http": { - "method": "POST", - "uri": "/tags/{resourceArn}", - "code": 200 - } - } - }, - "com.amazonaws.iotfleethub#TagResourceRequest": { - "type": "structure", - "members": { - "resourceArn": { - "target": "com.amazonaws.iotfleethub#ResourceArn", - "traits": { - "smithy.api#documentation": "

The ARN of the resource.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "tags": { - "target": "com.amazonaws.iotfleethub#TagMap", - "traits": { - "smithy.api#documentation": "

The new or modified tags for the resource.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.iotfleethub#TagResourceResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.iotfleethub#TagValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - } - } - }, - "com.amazonaws.iotfleethub#ThrottlingException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.iotfleethub#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "

The rate exceeds the limit.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.iotfleethub#Timestamp": { - "type": "long", - "traits": { - "smithy.api#default": 0 - } - }, - "com.amazonaws.iotfleethub#UntagResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.iotfleethub#UntagResourceRequest" - }, - "output": { - "target": "com.amazonaws.iotfleethub#UntagResourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.iotfleethub#InternalFailureException" - }, - { - "target": "com.amazonaws.iotfleethub#InvalidRequestException" - }, - { - "target": "com.amazonaws.iotfleethub#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "

Removes the specified tags (metadata) from the resource.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/tags/{resourceArn}", - "code": 200 - } - } - }, - "com.amazonaws.iotfleethub#UntagResourceRequest": { - "type": "structure", - "members": { - "resourceArn": { - "target": "com.amazonaws.iotfleethub#ResourceArn", - "traits": { - "smithy.api#documentation": "

The ARN of the resource.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "tagKeys": { - "target": "com.amazonaws.iotfleethub#TagKeyList", - "traits": { - "smithy.api#documentation": "

A list of the keys of the tags to be removed from the resource.

", - "smithy.api#httpQuery": "tagKeys", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.iotfleethub#UntagResourceResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.iotfleethub#UpdateApplication": { - "type": "operation", - "input": { - "target": "com.amazonaws.iotfleethub#UpdateApplicationRequest" - }, - "output": { - "target": "com.amazonaws.iotfleethub#UpdateApplicationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.iotfleethub#ConflictException" - }, - { - "target": "com.amazonaws.iotfleethub#InternalFailureException" - }, - { - "target": "com.amazonaws.iotfleethub#InvalidRequestException" - }, - { - "target": "com.amazonaws.iotfleethub#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.iotfleethub#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates information about a Fleet Hub for IoT Device Management web application.

", - "smithy.api#http": { - "method": "PATCH", - "uri": "/applications/{applicationId}", - "code": 202 - } - } - }, - "com.amazonaws.iotfleethub#UpdateApplicationRequest": { - "type": "structure", - "members": { - "applicationId": { - "target": "com.amazonaws.iotfleethub#Id", - "traits": { - "smithy.api#documentation": "

The unique Id of the web application.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "applicationName": { - "target": "com.amazonaws.iotfleethub#Name", - "traits": { - "smithy.api#documentation": "

The name of the web application.

" - } - }, - "applicationDescription": { - "target": "com.amazonaws.iotfleethub#Description", - "traits": { - "smithy.api#documentation": "

An optional description of the web application.

" - } - }, - "clientToken": { - "target": "com.amazonaws.iotfleethub#ClientRequestToken", - "traits": { - "smithy.api#documentation": "

A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. \n Don't reuse this client token if a new idempotent request is required.

", - "smithy.api#idempotencyToken": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.iotfleethub#UpdateApplicationResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.iotfleethub#Url": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - }, - "smithy.api#pattern": "^https\\://\\S+$" - } - } - } -} \ No newline at end of file diff --git a/models/lookoutmetrics/service/2017-07-25/lookoutmetrics-2017-07-25.json b/models/lookoutmetrics/service/2017-07-25/lookoutmetrics-2017-07-25.json deleted file mode 100644 index 6c696af4..00000000 --- a/models/lookoutmetrics/service/2017-07-25/lookoutmetrics-2017-07-25.json +++ /dev/null @@ -1,6373 +0,0 @@ -{ - "smithy": "2.0", - "metadata": { - "suppressions": [ - { - "id": "HttpMethodSemantics", - "namespace": "*" - }, - { - "id": "HttpResponseCodeSemantics", - "namespace": "*" - }, - { - "id": "PaginatedTrait", - "namespace": "*" - }, - { - "id": "HttpHeaderTrait", - "namespace": "*" - }, - { - "id": "HttpUriConflict", - "namespace": "*" - }, - { - "id": "Service", - "namespace": "*" - } - ] - }, - "shapes": { - "com.amazonaws.lookoutmetrics#AccessDeniedException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.lookoutmetrics#Message", - "traits": { - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

You do not have sufficient permissions to perform this action.

", - "smithy.api#error": "client", - "smithy.api#httpError": 403 - } - }, - "com.amazonaws.lookoutmetrics#Action": { - "type": "structure", - "members": { - "SNSConfiguration": { - "target": "com.amazonaws.lookoutmetrics#SNSConfiguration", - "traits": { - "smithy.api#documentation": "

A configuration for an Amazon SNS channel.

" - } - }, - "LambdaConfiguration": { - "target": "com.amazonaws.lookoutmetrics#LambdaConfiguration", - "traits": { - "smithy.api#documentation": "

A configuration for an AWS Lambda channel.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A configuration that specifies the action to perform when anomalies are detected.

" - } - }, - "com.amazonaws.lookoutmetrics#ActivateAnomalyDetector": { - "type": "operation", - "input": { - "target": "com.amazonaws.lookoutmetrics#ActivateAnomalyDetectorRequest" - }, - "output": { - "target": "com.amazonaws.lookoutmetrics#ActivateAnomalyDetectorResponse" - }, - "errors": [ - { - "target": "com.amazonaws.lookoutmetrics#AccessDeniedException" - }, - { - "target": "com.amazonaws.lookoutmetrics#ConflictException" - }, - { - "target": "com.amazonaws.lookoutmetrics#InternalServerException" - }, - { - "target": "com.amazonaws.lookoutmetrics#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.lookoutmetrics#TooManyRequestsException" - }, - { - "target": "com.amazonaws.lookoutmetrics#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Activates an anomaly detector.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ActivateAnomalyDetector", - "code": 200 - } - } - }, - "com.amazonaws.lookoutmetrics#ActivateAnomalyDetectorRequest": { - "type": "structure", - "members": { - "AnomalyDetectorArn": { - "target": "com.amazonaws.lookoutmetrics#Arn", - "traits": { - "smithy.api#documentation": "

The ARN of the anomaly detector.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lookoutmetrics#ActivateAnomalyDetectorResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.lookoutmetrics#AggregationFunction": { - "type": "enum", - "members": { - "AVG": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AVG" - } - }, - "SUM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SUM" - } - } - } - }, - "com.amazonaws.lookoutmetrics#Alert": { - "type": "structure", - "members": { - "Action": { - "target": "com.amazonaws.lookoutmetrics#Action", - "traits": { - "smithy.api#documentation": "

Action that will be triggered when there is an alert.

" - } - }, - "AlertDescription": { - "target": "com.amazonaws.lookoutmetrics#AlertDescription", - "traits": { - "smithy.api#documentation": "

A description of the alert.

" - } - }, - "AlertArn": { - "target": "com.amazonaws.lookoutmetrics#Arn", - "traits": { - "smithy.api#documentation": "

The ARN of the alert.

" - } - }, - "AnomalyDetectorArn": { - "target": "com.amazonaws.lookoutmetrics#Arn", - "traits": { - "smithy.api#documentation": "

The ARN of the detector to which the alert is attached.

" - } - }, - "AlertName": { - "target": "com.amazonaws.lookoutmetrics#AlertName", - "traits": { - "smithy.api#documentation": "

The name of the alert.

" - } - }, - "AlertSensitivityThreshold": { - "target": "com.amazonaws.lookoutmetrics#SensitivityThreshold", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The minimum severity for an anomaly to trigger the alert.

" - } - }, - "AlertType": { - "target": "com.amazonaws.lookoutmetrics#AlertType", - "traits": { - "smithy.api#documentation": "

The type of the alert.

" - } - }, - "AlertStatus": { - "target": "com.amazonaws.lookoutmetrics#AlertStatus", - "traits": { - "smithy.api#documentation": "

The status of the alert.

" - } - }, - "LastModificationTime": { - "target": "com.amazonaws.lookoutmetrics#Timestamp", - "traits": { - "smithy.api#documentation": "

The time at which the alert was last modified.

" - } - }, - "CreationTime": { - "target": "com.amazonaws.lookoutmetrics#Timestamp", - "traits": { - "smithy.api#documentation": "

The time at which the alert was created.

" - } - }, - "AlertFilters": { - "target": "com.amazonaws.lookoutmetrics#AlertFilters", - "traits": { - "smithy.api#documentation": "

The configuration of the alert filters, containing MetricList and DimensionFilter.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A configuration for Amazon SNS-integrated notifications.

" - } - }, - "com.amazonaws.lookoutmetrics#AlertDescription": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - }, - "smithy.api#pattern": "\\S" - } - }, - "com.amazonaws.lookoutmetrics#AlertFilters": { - "type": "structure", - "members": { - "MetricList": { - "target": "com.amazonaws.lookoutmetrics#MetricNameList", - "traits": { - "smithy.api#documentation": "

The list of measures that you want to get alerts for.

" - } - }, - "DimensionFilterList": { - "target": "com.amazonaws.lookoutmetrics#DimensionFilterList", - "traits": { - "smithy.api#documentation": "

The list of DimensionFilter objects that are used for dimension-based filtering.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The configuration of the alert filters.

" - } - }, - "com.amazonaws.lookoutmetrics#AlertName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 63 - }, - "smithy.api#pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]*$" - } - }, - "com.amazonaws.lookoutmetrics#AlertStatus": { - "type": "enum", - "members": { - "ACTIVE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ACTIVE" - } - }, - "INACTIVE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INACTIVE" - } - } - } - }, - "com.amazonaws.lookoutmetrics#AlertSummary": { - "type": "structure", - "members": { - "AlertArn": { - "target": "com.amazonaws.lookoutmetrics#Arn", - "traits": { - "smithy.api#documentation": "

The ARN of the alert.

" - } - }, - "AnomalyDetectorArn": { - "target": "com.amazonaws.lookoutmetrics#Arn", - "traits": { - "smithy.api#documentation": "

The ARN of the detector to which the alert is attached.

" - } - }, - "AlertName": { - "target": "com.amazonaws.lookoutmetrics#AlertName", - "traits": { - "smithy.api#documentation": "

The name of the alert.

" - } - }, - "AlertSensitivityThreshold": { - "target": "com.amazonaws.lookoutmetrics#SensitivityThreshold", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The minimum severity for an anomaly to trigger the alert.

" - } - }, - "AlertType": { - "target": "com.amazonaws.lookoutmetrics#AlertType", - "traits": { - "smithy.api#documentation": "

The type of the alert.

" - } - }, - "AlertStatus": { - "target": "com.amazonaws.lookoutmetrics#AlertStatus", - "traits": { - "smithy.api#documentation": "

The status of the alert.

" - } - }, - "LastModificationTime": { - "target": "com.amazonaws.lookoutmetrics#Timestamp", - "traits": { - "smithy.api#documentation": "

The time at which the alert was last modified.

" - } - }, - "CreationTime": { - "target": "com.amazonaws.lookoutmetrics#Timestamp", - "traits": { - "smithy.api#documentation": "

The time at which the alert was created.

" - } - }, - "Tags": { - "target": "com.amazonaws.lookoutmetrics#TagMap", - "traits": { - "smithy.api#documentation": "

The alert's tags.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Provides a summary of an alert's configuration.

" - } - }, - "com.amazonaws.lookoutmetrics#AlertSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.lookoutmetrics#AlertSummary" - } - }, - "com.amazonaws.lookoutmetrics#AlertType": { - "type": "enum", - "members": { - "SNS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SNS" - } - }, - "LAMBDA": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LAMBDA" - } - } - } - }, - "com.amazonaws.lookoutmetrics#AnomalyDetectionTaskStatus": { - "type": "enum", - "members": { - "PENDING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PENDING" - } - }, - "IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IN_PROGRESS" - } - }, - "COMPLETED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "COMPLETED" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED" - } - }, - "FAILED_TO_SCHEDULE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED_TO_SCHEDULE" - } - } - } - }, - "com.amazonaws.lookoutmetrics#AnomalyDetectionTaskStatusMessage": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - }, - "smithy.api#pattern": "\\S" - } - }, - "com.amazonaws.lookoutmetrics#AnomalyDetectorConfig": { - "type": "structure", - "members": { - "AnomalyDetectorFrequency": { - "target": "com.amazonaws.lookoutmetrics#Frequency", - "traits": { - "smithy.api#documentation": "

The frequency at which the detector analyzes its source data.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains information about a detector's configuration.

" - } - }, - "com.amazonaws.lookoutmetrics#AnomalyDetectorConfigSummary": { - "type": "structure", - "members": { - "AnomalyDetectorFrequency": { - "target": "com.amazonaws.lookoutmetrics#Frequency", - "traits": { - "smithy.api#documentation": "

The interval at which the detector analyzes its source data.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains information about a detector's configuration.

" - } - }, - "com.amazonaws.lookoutmetrics#AnomalyDetectorDataQualityMetric": { - "type": "structure", - "members": { - "StartTimestamp": { - "target": "com.amazonaws.lookoutmetrics#Timestamp", - "traits": { - "smithy.api#documentation": "

The start time for the data quality metrics collection.

" - } - }, - "MetricSetDataQualityMetricList": { - "target": "com.amazonaws.lookoutmetrics#MetricSetDataQualityMetricList", - "traits": { - "smithy.api#documentation": "

An array of DataQualityMetricList objects. Each object in the array contains information about a data quality metric.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Aggregated details about the data quality metrics collected for the AnomalyDetectorArn provided in the GetDataQualityMetrics object.

" - } - }, - "com.amazonaws.lookoutmetrics#AnomalyDetectorDataQualityMetricList": { - "type": "list", - "member": { - "target": "com.amazonaws.lookoutmetrics#AnomalyDetectorDataQualityMetric" - } - }, - "com.amazonaws.lookoutmetrics#AnomalyDetectorDescription": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - }, - "smithy.api#pattern": "\\S" - } - }, - "com.amazonaws.lookoutmetrics#AnomalyDetectorFailureType": { - "type": "enum", - "members": { - "ACTIVATION_FAILURE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ACTIVATION_FAILURE" - } - }, - "BACK_TEST_ACTIVATION_FAILURE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BACK_TEST_ACTIVATION_FAILURE" - } - }, - "DELETION_FAILURE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETION_FAILURE" - } - }, - "DEACTIVATION_FAILURE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DEACTIVATION_FAILURE" - } - } - } - }, - "com.amazonaws.lookoutmetrics#AnomalyDetectorName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 63 - }, - "smithy.api#pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]*$" - } - }, - "com.amazonaws.lookoutmetrics#AnomalyDetectorStatus": { - "type": "enum", - "members": { - "ACTIVE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ACTIVE" - } - }, - "ACTIVATING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ACTIVATING" - } - }, - "DELETING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETING" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED" - } - }, - "INACTIVE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INACTIVE" - } - }, - "LEARNING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LEARNING" - } - }, - "BACK_TEST_ACTIVATING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BACK_TEST_ACTIVATING" - } - }, - "BACK_TEST_ACTIVE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BACK_TEST_ACTIVE" - } - }, - "BACK_TEST_COMPLETE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BACK_TEST_COMPLETE" - } - }, - "DEACTIVATED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DEACTIVATED" - } - }, - "DEACTIVATING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DEACTIVATING" - } - } - } - }, - "com.amazonaws.lookoutmetrics#AnomalyDetectorSummary": { - "type": "structure", - "members": { - "AnomalyDetectorArn": { - "target": "com.amazonaws.lookoutmetrics#Arn", - "traits": { - "smithy.api#documentation": "

The ARN of the detector.

" - } - }, - "AnomalyDetectorName": { - "target": "com.amazonaws.lookoutmetrics#AnomalyDetectorName", - "traits": { - "smithy.api#documentation": "

The name of the detector.

" - } - }, - "AnomalyDetectorDescription": { - "target": "com.amazonaws.lookoutmetrics#AnomalyDetectorDescription", - "traits": { - "smithy.api#documentation": "

A description of the detector.

" - } - }, - "CreationTime": { - "target": "com.amazonaws.lookoutmetrics#Timestamp", - "traits": { - "smithy.api#documentation": "

The time at which the detector was created.

" - } - }, - "LastModificationTime": { - "target": "com.amazonaws.lookoutmetrics#Timestamp", - "traits": { - "smithy.api#documentation": "

The time at which the detector was last modified.

" - } - }, - "Status": { - "target": "com.amazonaws.lookoutmetrics#AnomalyDetectorStatus", - "traits": { - "smithy.api#documentation": "

The status of detector.

" - } - }, - "Tags": { - "target": "com.amazonaws.lookoutmetrics#TagMap", - "traits": { - "smithy.api#documentation": "

The detector's tags.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains information about an an anomaly detector.

" - } - }, - "com.amazonaws.lookoutmetrics#AnomalyDetectorSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.lookoutmetrics#AnomalyDetectorSummary" - } - }, - "com.amazonaws.lookoutmetrics#AnomalyGroup": { - "type": "structure", - "members": { - "StartTime": { - "target": "com.amazonaws.lookoutmetrics#TimestampString", - "traits": { - "smithy.api#documentation": "

The start time for the group.

" - } - }, - "EndTime": { - "target": "com.amazonaws.lookoutmetrics#TimestampString", - "traits": { - "smithy.api#documentation": "

The end time for the group.

" - } - }, - "AnomalyGroupId": { - "target": "com.amazonaws.lookoutmetrics#UUID", - "traits": { - "smithy.api#documentation": "

The ID of the anomaly group.

" - } - }, - "AnomalyGroupScore": { - "target": "com.amazonaws.lookoutmetrics#Score", - "traits": { - "smithy.api#documentation": "

The severity score of the group.

" - } - }, - "PrimaryMetricName": { - "target": "com.amazonaws.lookoutmetrics#MetricName", - "traits": { - "smithy.api#documentation": "

The name of the primary affected measure for the group.

" - } - }, - "MetricLevelImpactList": { - "target": "com.amazonaws.lookoutmetrics#MetricLevelImpactList", - "traits": { - "smithy.api#documentation": "

A list of measures affected by the anomaly.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A group of anomalous metrics

" - } - }, - "com.amazonaws.lookoutmetrics#AnomalyGroupStatistics": { - "type": "structure", - "members": { - "EvaluationStartDate": { - "target": "com.amazonaws.lookoutmetrics#TimestampString", - "traits": { - "smithy.api#documentation": "

The start of the time range that was searched.

" - } - }, - "TotalCount": { - "target": "com.amazonaws.lookoutmetrics#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of groups found.

" - } - }, - "ItemizedMetricStatsList": { - "target": "com.amazonaws.lookoutmetrics#ItemizedMetricStatsList", - "traits": { - "smithy.api#documentation": "

Statistics for individual metrics within the group.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Aggregated statistics for a group of anomalous metrics.

" - } - }, - "com.amazonaws.lookoutmetrics#AnomalyGroupSummary": { - "type": "structure", - "members": { - "StartTime": { - "target": "com.amazonaws.lookoutmetrics#TimestampString", - "traits": { - "smithy.api#documentation": "

The start time for the group.

" - } - }, - "EndTime": { - "target": "com.amazonaws.lookoutmetrics#TimestampString", - "traits": { - "smithy.api#documentation": "

The end time for the group.

" - } - }, - "AnomalyGroupId": { - "target": "com.amazonaws.lookoutmetrics#UUID", - "traits": { - "smithy.api#documentation": "

The ID of the anomaly group.

" - } - }, - "AnomalyGroupScore": { - "target": "com.amazonaws.lookoutmetrics#Score", - "traits": { - "smithy.api#documentation": "

The severity score of the group.

" - } - }, - "PrimaryMetricName": { - "target": "com.amazonaws.lookoutmetrics#MetricName", - "traits": { - "smithy.api#documentation": "

The name of the primary affected measure for the group.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Details about a group of anomalous metrics.

" - } - }, - "com.amazonaws.lookoutmetrics#AnomalyGroupSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.lookoutmetrics#AnomalyGroupSummary" - } - }, - "com.amazonaws.lookoutmetrics#AnomalyGroupTimeSeries": { - "type": "structure", - "members": { - "AnomalyGroupId": { - "target": "com.amazonaws.lookoutmetrics#UUID", - "traits": { - "smithy.api#documentation": "

The ID of the anomaly group.

", - "smithy.api#required": {} - } - }, - "TimeSeriesId": { - "target": "com.amazonaws.lookoutmetrics#TimeSeriesId", - "traits": { - "smithy.api#documentation": "

The ID of the metric.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

An anomalous metric in an anomaly group.

" - } - }, - "com.amazonaws.lookoutmetrics#AnomalyGroupTimeSeriesFeedback": { - "type": "structure", - "members": { - "AnomalyGroupId": { - "target": "com.amazonaws.lookoutmetrics#UUID", - "traits": { - "smithy.api#documentation": "

The ID of the anomaly group.

", - "smithy.api#required": {} - } - }, - "TimeSeriesId": { - "target": "com.amazonaws.lookoutmetrics#TimeSeriesId", - "traits": { - "smithy.api#documentation": "

The ID of the metric.

", - "smithy.api#required": {} - } - }, - "IsAnomaly": { - "target": "com.amazonaws.lookoutmetrics#Boolean", - "traits": { - "smithy.api#documentation": "

Feedback on whether the metric is a legitimate anomaly.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Feedback for an anomalous metric.

" - } - }, - "com.amazonaws.lookoutmetrics#AppFlowConfig": { - "type": "structure", - "members": { - "RoleArn": { - "target": "com.amazonaws.lookoutmetrics#Arn", - "traits": { - "smithy.api#documentation": "

An IAM role that gives Amazon Lookout for Metrics permission to access the flow.

" - } - }, - "FlowName": { - "target": "com.amazonaws.lookoutmetrics#FlowName", - "traits": { - "smithy.api#documentation": "

name of the flow.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Details about an Amazon AppFlow flow datasource.

" - } - }, - "com.amazonaws.lookoutmetrics#Arn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - }, - "smithy.api#pattern": "^arn:([a-z\\d-]+):.*:.*:.*:.+$" - } - }, - "com.amazonaws.lookoutmetrics#AthenaDataCatalog": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - }, - "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*$" - } - }, - "com.amazonaws.lookoutmetrics#AthenaDatabaseName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 255 - }, - "smithy.api#pattern": "^[a-zA-Z0-9_]+$" - } - }, - "com.amazonaws.lookoutmetrics#AthenaS3ResultsPath": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1024 - }, - "smithy.api#pattern": "^s3://[a-z0-9].+$" - } - }, - "com.amazonaws.lookoutmetrics#AthenaSourceConfig": { - "type": "structure", - "members": { - "RoleArn": { - "target": "com.amazonaws.lookoutmetrics#Arn", - "traits": { - "smithy.api#documentation": "

An IAM role that gives Amazon Lookout for Metrics permission to access the data.

" - } - }, - "DatabaseName": { - "target": "com.amazonaws.lookoutmetrics#AthenaDatabaseName", - "traits": { - "smithy.api#documentation": "

The database's name.

" - } - }, - "DataCatalog": { - "target": "com.amazonaws.lookoutmetrics#AthenaDataCatalog", - "traits": { - "smithy.api#documentation": "

The database's data catalog.

" - } - }, - "TableName": { - "target": "com.amazonaws.lookoutmetrics#AthenaTableName", - "traits": { - "smithy.api#documentation": "

The database's table name.

" - } - }, - "WorkGroupName": { - "target": "com.amazonaws.lookoutmetrics#AthenaWorkGroupName", - "traits": { - "smithy.api#documentation": "

The database's work group name.

" - } - }, - "S3ResultsPath": { - "target": "com.amazonaws.lookoutmetrics#AthenaS3ResultsPath", - "traits": { - "smithy.api#documentation": "

The database's results path.

" - } - }, - "BackTestConfiguration": { - "target": "com.amazonaws.lookoutmetrics#BackTestConfiguration", - "traits": { - "smithy.api#documentation": "

Settings for backtest mode.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Details about an Amazon Athena datasource.

" - } - }, - "com.amazonaws.lookoutmetrics#AthenaTableName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - }, - "smithy.api#pattern": "^[a-zA-Z0-9_]+$" - } - }, - "com.amazonaws.lookoutmetrics#AthenaWorkGroupName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - }, - "smithy.api#pattern": "^[a-zA-Z0-9._-]{1,128}$" - } - }, - "com.amazonaws.lookoutmetrics#AttributeValue": { - "type": "structure", - "members": { - "S": { - "target": "com.amazonaws.lookoutmetrics#StringAttributeValue", - "traits": { - "smithy.api#documentation": "

A string.

" - } - }, - "N": { - "target": "com.amazonaws.lookoutmetrics#NumberAttributeValue", - "traits": { - "smithy.api#documentation": "

A number.

" - } - }, - "B": { - "target": "com.amazonaws.lookoutmetrics#BinaryAttributeValue", - "traits": { - "smithy.api#documentation": "

A binary value.

" - } - }, - "SS": { - "target": "com.amazonaws.lookoutmetrics#StringListAttributeValue", - "traits": { - "smithy.api#documentation": "

A list of strings.

" - } - }, - "NS": { - "target": "com.amazonaws.lookoutmetrics#NumberListAttributeValue", - "traits": { - "smithy.api#documentation": "

A list of numbers.

" - } - }, - "BS": { - "target": "com.amazonaws.lookoutmetrics#BinaryListAttributeValue", - "traits": { - "smithy.api#documentation": "

A list of binary values.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

An attribute value.

" - } - }, - "com.amazonaws.lookoutmetrics#AutoDetectionMetricSource": { - "type": "structure", - "members": { - "S3SourceConfig": { - "target": "com.amazonaws.lookoutmetrics#AutoDetectionS3SourceConfig", - "traits": { - "smithy.api#documentation": "

The source's source config.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

An auto detection metric source.

" - } - }, - "com.amazonaws.lookoutmetrics#AutoDetectionS3SourceConfig": { - "type": "structure", - "members": { - "TemplatedPathList": { - "target": "com.amazonaws.lookoutmetrics#TemplatedPathList", - "traits": { - "smithy.api#documentation": "

The config's templated path list.

" - } - }, - "HistoricalDataPathList": { - "target": "com.amazonaws.lookoutmetrics#HistoricalDataPathList", - "traits": { - "smithy.api#documentation": "

The config's historical data path list.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

An auto detection source config.

" - } - }, - "com.amazonaws.lookoutmetrics#BackTestAnomalyDetector": { - "type": "operation", - "input": { - "target": "com.amazonaws.lookoutmetrics#BackTestAnomalyDetectorRequest" - }, - "output": { - "target": "com.amazonaws.lookoutmetrics#BackTestAnomalyDetectorResponse" - }, - "errors": [ - { - "target": "com.amazonaws.lookoutmetrics#AccessDeniedException" - }, - { - "target": "com.amazonaws.lookoutmetrics#InternalServerException" - }, - { - "target": "com.amazonaws.lookoutmetrics#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.lookoutmetrics#TooManyRequestsException" - }, - { - "target": "com.amazonaws.lookoutmetrics#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Runs a backtest for anomaly detection for the specified resource.

", - "smithy.api#http": { - "method": "POST", - "uri": "/BackTestAnomalyDetector", - "code": 200 - } - } - }, - "com.amazonaws.lookoutmetrics#BackTestAnomalyDetectorRequest": { - "type": "structure", - "members": { - "AnomalyDetectorArn": { - "target": "com.amazonaws.lookoutmetrics#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the anomaly detector.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lookoutmetrics#BackTestAnomalyDetectorResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.lookoutmetrics#BackTestConfiguration": { - "type": "structure", - "members": { - "RunBackTestMode": { - "target": "com.amazonaws.lookoutmetrics#Boolean", - "traits": { - "smithy.api#documentation": "

Run a backtest instead of monitoring new data.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Settings for backtest mode.

" - } - }, - "com.amazonaws.lookoutmetrics#BinaryAttributeValue": { - "type": "string" - }, - "com.amazonaws.lookoutmetrics#BinaryListAttributeValue": { - "type": "list", - "member": { - "target": "com.amazonaws.lookoutmetrics#BinaryAttributeValue" - } - }, - "com.amazonaws.lookoutmetrics#Boolean": { - "type": "boolean" - }, - "com.amazonaws.lookoutmetrics#CSVFileCompression": { - "type": "enum", - "members": { - "NONE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NONE" - } - }, - "GZIP": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "GZIP" - } - } - } - }, - "com.amazonaws.lookoutmetrics#Charset": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 63 - }, - "smithy.api#pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]*$" - } - }, - "com.amazonaws.lookoutmetrics#CloudWatchConfig": { - "type": "structure", - "members": { - "RoleArn": { - "target": "com.amazonaws.lookoutmetrics#Arn", - "traits": { - "smithy.api#documentation": "

An IAM role that gives Amazon Lookout for Metrics permission to access data in Amazon CloudWatch.

" - } - }, - "BackTestConfiguration": { - "target": "com.amazonaws.lookoutmetrics#BackTestConfiguration", - "traits": { - "smithy.api#documentation": "

Settings for backtest mode.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Details about an Amazon CloudWatch datasource.

" - } - }, - "com.amazonaws.lookoutmetrics#ColumnName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 63 - }, - "smithy.api#pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]*$" - } - }, - "com.amazonaws.lookoutmetrics#Confidence": { - "type": "enum", - "members": { - "HIGH": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HIGH" - } - }, - "LOW": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LOW" - } - }, - "NONE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NONE" - } - } - } - }, - "com.amazonaws.lookoutmetrics#ConflictException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.lookoutmetrics#Message", - "traits": { - "smithy.api#required": {} - } - }, - "ResourceId": { - "target": "com.amazonaws.lookoutmetrics#ResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the resource.

" - } - }, - "ResourceType": { - "target": "com.amazonaws.lookoutmetrics#ResourceType", - "traits": { - "smithy.api#documentation": "

The type of the resource.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

There was a conflict processing the request. Try your request again.

", - "smithy.api#error": "client", - "smithy.api#httpError": 409 - } - }, - "com.amazonaws.lookoutmetrics#ContributionMatrix": { - "type": "structure", - "members": { - "DimensionContributionList": { - "target": "com.amazonaws.lookoutmetrics#DimensionContributionList", - "traits": { - "smithy.api#documentation": "

A list of contributing dimensions.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Details about dimensions that contributed to an anomaly.

" - } - }, - "com.amazonaws.lookoutmetrics#CreateAlert": { - "type": "operation", - "input": { - "target": "com.amazonaws.lookoutmetrics#CreateAlertRequest" - }, - "output": { - "target": "com.amazonaws.lookoutmetrics#CreateAlertResponse" - }, - "errors": [ - { - "target": "com.amazonaws.lookoutmetrics#AccessDeniedException" - }, - { - "target": "com.amazonaws.lookoutmetrics#ConflictException" - }, - { - "target": "com.amazonaws.lookoutmetrics#InternalServerException" - }, - { - "target": "com.amazonaws.lookoutmetrics#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.lookoutmetrics#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.lookoutmetrics#TooManyRequestsException" - }, - { - "target": "com.amazonaws.lookoutmetrics#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates an alert for an anomaly detector.

", - "smithy.api#http": { - "method": "POST", - "uri": "/CreateAlert", - "code": 200 - } - } - }, - "com.amazonaws.lookoutmetrics#CreateAlertRequest": { - "type": "structure", - "members": { - "AlertName": { - "target": "com.amazonaws.lookoutmetrics#AlertName", - "traits": { - "smithy.api#documentation": "

The name of the alert.

", - "smithy.api#required": {} - } - }, - "AlertSensitivityThreshold": { - "target": "com.amazonaws.lookoutmetrics#SensitivityThreshold", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

An integer from 0 to 100 specifying the alert sensitivity threshold.

" - } - }, - "AlertDescription": { - "target": "com.amazonaws.lookoutmetrics#AlertDescription", - "traits": { - "smithy.api#documentation": "

A description of the alert.

" - } - }, - "AnomalyDetectorArn": { - "target": "com.amazonaws.lookoutmetrics#Arn", - "traits": { - "smithy.api#documentation": "

The ARN of the detector to which the alert is attached.

", - "smithy.api#required": {} - } - }, - "Action": { - "target": "com.amazonaws.lookoutmetrics#Action", - "traits": { - "smithy.api#documentation": "

Action that will be triggered when there is an alert.

", - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.lookoutmetrics#TagMap", - "traits": { - "smithy.api#documentation": "

A list of tags to apply to the alert.

" - } - }, - "AlertFilters": { - "target": "com.amazonaws.lookoutmetrics#AlertFilters", - "traits": { - "smithy.api#documentation": "

The configuration of the alert filters, containing MetricList and DimensionFilterList.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lookoutmetrics#CreateAlertResponse": { - "type": "structure", - "members": { - "AlertArn": { - "target": "com.amazonaws.lookoutmetrics#Arn", - "traits": { - "smithy.api#documentation": "

The ARN of the alert.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.lookoutmetrics#CreateAnomalyDetector": { - "type": "operation", - "input": { - "target": "com.amazonaws.lookoutmetrics#CreateAnomalyDetectorRequest" - }, - "output": { - "target": "com.amazonaws.lookoutmetrics#CreateAnomalyDetectorResponse" - }, - "errors": [ - { - "target": "com.amazonaws.lookoutmetrics#AccessDeniedException" - }, - { - "target": "com.amazonaws.lookoutmetrics#ConflictException" - }, - { - "target": "com.amazonaws.lookoutmetrics#InternalServerException" - }, - { - "target": "com.amazonaws.lookoutmetrics#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.lookoutmetrics#TooManyRequestsException" - }, - { - "target": "com.amazonaws.lookoutmetrics#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates an anomaly detector.

", - "smithy.api#http": { - "method": "POST", - "uri": "/CreateAnomalyDetector", - "code": 200 - } - } - }, - "com.amazonaws.lookoutmetrics#CreateAnomalyDetectorRequest": { - "type": "structure", - "members": { - "AnomalyDetectorName": { - "target": "com.amazonaws.lookoutmetrics#AnomalyDetectorName", - "traits": { - "smithy.api#documentation": "

The name of the detector.

", - "smithy.api#required": {} - } - }, - "AnomalyDetectorDescription": { - "target": "com.amazonaws.lookoutmetrics#AnomalyDetectorDescription", - "traits": { - "smithy.api#documentation": "

A description of the detector.

" - } - }, - "AnomalyDetectorConfig": { - "target": "com.amazonaws.lookoutmetrics#AnomalyDetectorConfig", - "traits": { - "smithy.api#documentation": "

Contains information about the configuration of the anomaly detector.

", - "smithy.api#required": {} - } - }, - "KmsKeyArn": { - "target": "com.amazonaws.lookoutmetrics#KmsKeyArn", - "traits": { - "smithy.api#documentation": "

The ARN of the KMS key to use to encrypt your data.

" - } - }, - "Tags": { - "target": "com.amazonaws.lookoutmetrics#TagMap", - "traits": { - "smithy.api#documentation": "

A list of tags to apply to the anomaly detector.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lookoutmetrics#CreateAnomalyDetectorResponse": { - "type": "structure", - "members": { - "AnomalyDetectorArn": { - "target": "com.amazonaws.lookoutmetrics#Arn", - "traits": { - "smithy.api#documentation": "

The ARN of the detector.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.lookoutmetrics#CreateMetricSet": { - "type": "operation", - "input": { - "target": "com.amazonaws.lookoutmetrics#CreateMetricSetRequest" - }, - "output": { - "target": "com.amazonaws.lookoutmetrics#CreateMetricSetResponse" - }, - "errors": [ - { - "target": "com.amazonaws.lookoutmetrics#AccessDeniedException" - }, - { - "target": "com.amazonaws.lookoutmetrics#ConflictException" - }, - { - "target": "com.amazonaws.lookoutmetrics#InternalServerException" - }, - { - "target": "com.amazonaws.lookoutmetrics#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.lookoutmetrics#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.lookoutmetrics#TooManyRequestsException" - }, - { - "target": "com.amazonaws.lookoutmetrics#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a dataset.

", - "smithy.api#http": { - "method": "POST", - "uri": "/CreateMetricSet", - "code": 200 - } - } - }, - "com.amazonaws.lookoutmetrics#CreateMetricSetRequest": { - "type": "structure", - "members": { - "AnomalyDetectorArn": { - "target": "com.amazonaws.lookoutmetrics#Arn", - "traits": { - "smithy.api#documentation": "

The ARN of the anomaly detector that will use the dataset.

", - "smithy.api#required": {} - } - }, - "MetricSetName": { - "target": "com.amazonaws.lookoutmetrics#MetricSetName", - "traits": { - "smithy.api#documentation": "

The name of the dataset.

", - "smithy.api#required": {} - } - }, - "MetricSetDescription": { - "target": "com.amazonaws.lookoutmetrics#MetricSetDescription", - "traits": { - "smithy.api#documentation": "

A description of the dataset you are creating.

" - } - }, - "MetricList": { - "target": "com.amazonaws.lookoutmetrics#MetricList", - "traits": { - "smithy.api#documentation": "

A list of metrics that the dataset will contain.

", - "smithy.api#required": {} - } - }, - "Offset": { - "target": "com.amazonaws.lookoutmetrics#Offset", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

After an interval ends, the amount of seconds that the detector waits before importing data. Offset is only supported for S3, Redshift, Athena and datasources.

" - } - }, - "TimestampColumn": { - "target": "com.amazonaws.lookoutmetrics#TimestampColumn", - "traits": { - "smithy.api#documentation": "

Contains information about the column used for tracking time in your source data.

" - } - }, - "DimensionList": { - "target": "com.amazonaws.lookoutmetrics#DimensionList", - "traits": { - "smithy.api#documentation": "

A list of the fields you want to treat as dimensions.

" - } - }, - "MetricSetFrequency": { - "target": "com.amazonaws.lookoutmetrics#Frequency", - "traits": { - "smithy.api#documentation": "

The frequency with which the source data will be analyzed for anomalies.

" - } - }, - "MetricSource": { - "target": "com.amazonaws.lookoutmetrics#MetricSource", - "traits": { - "smithy.api#documentation": "

Contains information about how the source data should be interpreted.

", - "smithy.api#required": {} - } - }, - "Timezone": { - "target": "com.amazonaws.lookoutmetrics#Timezone", - "traits": { - "smithy.api#documentation": "

The time zone in which your source data was recorded.

" - } - }, - "Tags": { - "target": "com.amazonaws.lookoutmetrics#TagMap", - "traits": { - "smithy.api#documentation": "

A list of tags to apply to the dataset.

" - } - }, - "DimensionFilterList": { - "target": "com.amazonaws.lookoutmetrics#MetricSetDimensionFilterList", - "traits": { - "smithy.api#documentation": "

A list of filters that specify which data is kept for anomaly detection.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lookoutmetrics#CreateMetricSetResponse": { - "type": "structure", - "members": { - "MetricSetArn": { - "target": "com.amazonaws.lookoutmetrics#Arn", - "traits": { - "smithy.api#documentation": "

The ARN of the dataset.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.lookoutmetrics#CsvFormatDescriptor": { - "type": "structure", - "members": { - "FileCompression": { - "target": "com.amazonaws.lookoutmetrics#CSVFileCompression", - "traits": { - "smithy.api#documentation": "

The level of compression of the source CSV file.

" - } - }, - "Charset": { - "target": "com.amazonaws.lookoutmetrics#Charset", - "traits": { - "smithy.api#documentation": "

The character set in which the source CSV file is written.

" - } - }, - "ContainsHeader": { - "target": "com.amazonaws.lookoutmetrics#Boolean", - "traits": { - "smithy.api#documentation": "

Whether or not the source CSV file contains a header.

" - } - }, - "Delimiter": { - "target": "com.amazonaws.lookoutmetrics#Delimiter", - "traits": { - "smithy.api#documentation": "

The character used to delimit the source CSV file.

" - } - }, - "HeaderList": { - "target": "com.amazonaws.lookoutmetrics#HeaderList", - "traits": { - "smithy.api#documentation": "

A list of the source CSV file's headers, if any.

" - } - }, - "QuoteSymbol": { - "target": "com.amazonaws.lookoutmetrics#QuoteSymbol", - "traits": { - "smithy.api#documentation": "

The character used as a quote character.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains information about how a source CSV data file should be analyzed.

" - } - }, - "com.amazonaws.lookoutmetrics#DataItem": { - "type": "string" - }, - "com.amazonaws.lookoutmetrics#DataQualityMetric": { - "type": "structure", - "members": { - "MetricType": { - "target": "com.amazonaws.lookoutmetrics#DataQualityMetricType", - "traits": { - "smithy.api#documentation": "

The name of the data quality metric.

" - } - }, - "MetricDescription": { - "target": "com.amazonaws.lookoutmetrics#DataQualityMetricDescription", - "traits": { - "smithy.api#documentation": "

A description of the data quality metric.

" - } - }, - "RelatedColumnName": { - "target": "com.amazonaws.lookoutmetrics#RelatedColumnName", - "traits": { - "smithy.api#documentation": "

The column that is being monitored.

" - } - }, - "MetricValue": { - "target": "com.amazonaws.lookoutmetrics#Double", - "traits": { - "smithy.api#documentation": "

The value of the data quality metric.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

An array that describes a data quality metric. Each DataQualityMetric object contains the data quality metric name, its value, a description of the metric, and the affected column.

" - } - }, - "com.amazonaws.lookoutmetrics#DataQualityMetricDescription": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - }, - "smithy.api#pattern": "\\S" - } - }, - "com.amazonaws.lookoutmetrics#DataQualityMetricList": { - "type": "list", - "member": { - "target": "com.amazonaws.lookoutmetrics#DataQualityMetric" - } - }, - "com.amazonaws.lookoutmetrics#DataQualityMetricType": { - "type": "enum", - "members": { - "COLUMN_COMPLETENESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "COLUMN_COMPLETENESS" - } - }, - "DIMENSION_UNIQUENESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DIMENSION_UNIQUENESS" - } - }, - "TIME_SERIES_COUNT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TIME_SERIES_COUNT" - } - }, - "ROWS_PROCESSED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ROWS_PROCESSED" - } - }, - "ROWS_PARTIAL_COMPLIANCE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ROWS_PARTIAL_COMPLIANCE" - } - }, - "INVALID_ROWS_COMPLIANCE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INVALID_ROWS_COMPLIANCE" - } - }, - "BACKTEST_TRAINING_DATA_START_TIME_STAMP": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BACKTEST_TRAINING_DATA_START_TIME_STAMP" - } - }, - "BACKTEST_TRAINING_DATA_END_TIME_STAMP": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BACKTEST_TRAINING_DATA_END_TIME_STAMP" - } - }, - "BACKTEST_INFERENCE_DATA_START_TIME_STAMP": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BACKTEST_INFERENCE_DATA_START_TIME_STAMP" - } - }, - "BACKTEST_INFERENCE_DATA_END_TIME_STAMP": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BACKTEST_INFERENCE_DATA_END_TIME_STAMP" - } - } - } - }, - "com.amazonaws.lookoutmetrics#DatabaseHost": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 253 - }, - "smithy.api#pattern": "\\S" - } - }, - "com.amazonaws.lookoutmetrics#DatabasePort": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 65535 - } - } - }, - "com.amazonaws.lookoutmetrics#DateTimeFormat": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 63 - }, - "smithy.api#pattern": "\\S" - } - }, - "com.amazonaws.lookoutmetrics#DeactivateAnomalyDetector": { - "type": "operation", - "input": { - "target": "com.amazonaws.lookoutmetrics#DeactivateAnomalyDetectorRequest" - }, - "output": { - "target": "com.amazonaws.lookoutmetrics#DeactivateAnomalyDetectorResponse" - }, - "errors": [ - { - "target": "com.amazonaws.lookoutmetrics#AccessDeniedException" - }, - { - "target": "com.amazonaws.lookoutmetrics#ConflictException" - }, - { - "target": "com.amazonaws.lookoutmetrics#InternalServerException" - }, - { - "target": "com.amazonaws.lookoutmetrics#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.lookoutmetrics#TooManyRequestsException" - }, - { - "target": "com.amazonaws.lookoutmetrics#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Deactivates an anomaly detector.

", - "smithy.api#http": { - "method": "POST", - "uri": "/DeactivateAnomalyDetector", - "code": 200 - } - } - }, - "com.amazonaws.lookoutmetrics#DeactivateAnomalyDetectorRequest": { - "type": "structure", - "members": { - "AnomalyDetectorArn": { - "target": "com.amazonaws.lookoutmetrics#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the anomaly detector.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lookoutmetrics#DeactivateAnomalyDetectorResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.lookoutmetrics#DeleteAlert": { - "type": "operation", - "input": { - "target": "com.amazonaws.lookoutmetrics#DeleteAlertRequest" - }, - "output": { - "target": "com.amazonaws.lookoutmetrics#DeleteAlertResponse" - }, - "errors": [ - { - "target": "com.amazonaws.lookoutmetrics#AccessDeniedException" - }, - { - "target": "com.amazonaws.lookoutmetrics#InternalServerException" - }, - { - "target": "com.amazonaws.lookoutmetrics#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.lookoutmetrics#TooManyRequestsException" - }, - { - "target": "com.amazonaws.lookoutmetrics#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes an alert.

", - "smithy.api#http": { - "method": "POST", - "uri": "/DeleteAlert", - "code": 200 - } - } - }, - "com.amazonaws.lookoutmetrics#DeleteAlertRequest": { - "type": "structure", - "members": { - "AlertArn": { - "target": "com.amazonaws.lookoutmetrics#Arn", - "traits": { - "smithy.api#documentation": "

The ARN of the alert to delete.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lookoutmetrics#DeleteAlertResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.lookoutmetrics#DeleteAnomalyDetector": { - "type": "operation", - "input": { - "target": "com.amazonaws.lookoutmetrics#DeleteAnomalyDetectorRequest" - }, - "output": { - "target": "com.amazonaws.lookoutmetrics#DeleteAnomalyDetectorResponse" - }, - "errors": [ - { - "target": "com.amazonaws.lookoutmetrics#AccessDeniedException" - }, - { - "target": "com.amazonaws.lookoutmetrics#ConflictException" - }, - { - "target": "com.amazonaws.lookoutmetrics#InternalServerException" - }, - { - "target": "com.amazonaws.lookoutmetrics#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.lookoutmetrics#TooManyRequestsException" - }, - { - "target": "com.amazonaws.lookoutmetrics#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes a detector. Deleting an anomaly detector will delete all of its corresponding resources including any\n configured datasets and alerts.

", - "smithy.api#http": { - "method": "POST", - "uri": "/DeleteAnomalyDetector", - "code": 200 - } - } - }, - "com.amazonaws.lookoutmetrics#DeleteAnomalyDetectorRequest": { - "type": "structure", - "members": { - "AnomalyDetectorArn": { - "target": "com.amazonaws.lookoutmetrics#Arn", - "traits": { - "smithy.api#documentation": "

The ARN of the detector to delete.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lookoutmetrics#DeleteAnomalyDetectorResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.lookoutmetrics#Delimiter": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1 - }, - "smithy.api#pattern": "^[^\\r\\n]$" - } - }, - "com.amazonaws.lookoutmetrics#DescribeAlert": { - "type": "operation", - "input": { - "target": "com.amazonaws.lookoutmetrics#DescribeAlertRequest" - }, - "output": { - "target": "com.amazonaws.lookoutmetrics#DescribeAlertResponse" - }, - "errors": [ - { - "target": "com.amazonaws.lookoutmetrics#AccessDeniedException" - }, - { - "target": "com.amazonaws.lookoutmetrics#InternalServerException" - }, - { - "target": "com.amazonaws.lookoutmetrics#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.lookoutmetrics#TooManyRequestsException" - }, - { - "target": "com.amazonaws.lookoutmetrics#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Describes an alert.

\n

Amazon Lookout for Metrics API actions are eventually consistent. If you do a read operation on a resource\n immediately after creating or modifying it, use retries to allow time for the write operation to complete.

", - "smithy.api#http": { - "method": "POST", - "uri": "/DescribeAlert", - "code": 200 - } - } - }, - "com.amazonaws.lookoutmetrics#DescribeAlertRequest": { - "type": "structure", - "members": { - "AlertArn": { - "target": "com.amazonaws.lookoutmetrics#Arn", - "traits": { - "smithy.api#documentation": "

The ARN of the alert to describe.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lookoutmetrics#DescribeAlertResponse": { - "type": "structure", - "members": { - "Alert": { - "target": "com.amazonaws.lookoutmetrics#Alert", - "traits": { - "smithy.api#documentation": "

Contains information about an alert.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.lookoutmetrics#DescribeAnomalyDetectionExecutions": { - "type": "operation", - "input": { - "target": "com.amazonaws.lookoutmetrics#DescribeAnomalyDetectionExecutionsRequest" - }, - "output": { - "target": "com.amazonaws.lookoutmetrics#DescribeAnomalyDetectionExecutionsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.lookoutmetrics#AccessDeniedException" - }, - { - "target": "com.amazonaws.lookoutmetrics#InternalServerException" - }, - { - "target": "com.amazonaws.lookoutmetrics#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.lookoutmetrics#TooManyRequestsException" - }, - { - "target": "com.amazonaws.lookoutmetrics#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns information about the status of the specified anomaly detection jobs.

", - "smithy.api#http": { - "method": "POST", - "uri": "/DescribeAnomalyDetectionExecutions", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.lookoutmetrics#DescribeAnomalyDetectionExecutionsRequest": { - "type": "structure", - "members": { - "AnomalyDetectorArn": { - "target": "com.amazonaws.lookoutmetrics#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the anomaly detector.

", - "smithy.api#required": {} - } - }, - "Timestamp": { - "target": "com.amazonaws.lookoutmetrics#TimestampString", - "traits": { - "smithy.api#documentation": "

The timestamp of the anomaly detection job.

" - } - }, - "MaxResults": { - "target": "com.amazonaws.lookoutmetrics#MaxResults", - "traits": { - "smithy.api#documentation": "

The number of items to return in the response.

" - } - }, - "NextToken": { - "target": "com.amazonaws.lookoutmetrics#NextToken", - "traits": { - "smithy.api#documentation": "

Specify the pagination token that's returned by a previous request to retrieve the next page of results.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lookoutmetrics#DescribeAnomalyDetectionExecutionsResponse": { - "type": "structure", - "members": { - "ExecutionList": { - "target": "com.amazonaws.lookoutmetrics#ExecutionList", - "traits": { - "smithy.api#documentation": "

A list of detection jobs.

" - } - }, - "NextToken": { - "target": "com.amazonaws.lookoutmetrics#NextToken", - "traits": { - "smithy.api#documentation": "

The pagination token that's included if more results are available.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.lookoutmetrics#DescribeAnomalyDetector": { - "type": "operation", - "input": { - "target": "com.amazonaws.lookoutmetrics#DescribeAnomalyDetectorRequest" - }, - "output": { - "target": "com.amazonaws.lookoutmetrics#DescribeAnomalyDetectorResponse" - }, - "errors": [ - { - "target": "com.amazonaws.lookoutmetrics#AccessDeniedException" - }, - { - "target": "com.amazonaws.lookoutmetrics#InternalServerException" - }, - { - "target": "com.amazonaws.lookoutmetrics#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.lookoutmetrics#TooManyRequestsException" - }, - { - "target": "com.amazonaws.lookoutmetrics#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Describes a detector.

\n

Amazon Lookout for Metrics API actions are eventually consistent. If you do a read operation on a resource\n immediately after creating or modifying it, use retries to allow time for the write operation to complete.

", - "smithy.api#http": { - "method": "POST", - "uri": "/DescribeAnomalyDetector", - "code": 200 - } - } - }, - "com.amazonaws.lookoutmetrics#DescribeAnomalyDetectorRequest": { - "type": "structure", - "members": { - "AnomalyDetectorArn": { - "target": "com.amazonaws.lookoutmetrics#Arn", - "traits": { - "smithy.api#documentation": "

The ARN of the detector to describe.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lookoutmetrics#DescribeAnomalyDetectorResponse": { - "type": "structure", - "members": { - "AnomalyDetectorArn": { - "target": "com.amazonaws.lookoutmetrics#Arn", - "traits": { - "smithy.api#documentation": "

The ARN of the detector.

" - } - }, - "AnomalyDetectorName": { - "target": "com.amazonaws.lookoutmetrics#AnomalyDetectorName", - "traits": { - "smithy.api#documentation": "

The name of the detector.

" - } - }, - "AnomalyDetectorDescription": { - "target": "com.amazonaws.lookoutmetrics#AnomalyDetectorDescription", - "traits": { - "smithy.api#documentation": "

A description of the detector.

" - } - }, - "AnomalyDetectorConfig": { - "target": "com.amazonaws.lookoutmetrics#AnomalyDetectorConfigSummary", - "traits": { - "smithy.api#documentation": "

Contains information about the detector's configuration.

" - } - }, - "CreationTime": { - "target": "com.amazonaws.lookoutmetrics#Timestamp", - "traits": { - "smithy.api#documentation": "

The time at which the detector was created.

" - } - }, - "LastModificationTime": { - "target": "com.amazonaws.lookoutmetrics#Timestamp", - "traits": { - "smithy.api#documentation": "

The time at which the detector was last modified.

" - } - }, - "Status": { - "target": "com.amazonaws.lookoutmetrics#AnomalyDetectorStatus", - "traits": { - "smithy.api#documentation": "

The status of the detector.

" - } - }, - "FailureReason": { - "target": "com.amazonaws.lookoutmetrics#ErrorMessage", - "traits": { - "smithy.api#documentation": "

The reason that the detector failed.

" - } - }, - "KmsKeyArn": { - "target": "com.amazonaws.lookoutmetrics#KmsKeyArn", - "traits": { - "smithy.api#documentation": "

The ARN of the KMS key to use to encrypt your data.

" - } - }, - "FailureType": { - "target": "com.amazonaws.lookoutmetrics#AnomalyDetectorFailureType", - "traits": { - "smithy.api#documentation": "

The process that caused the detector to fail.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.lookoutmetrics#DescribeMetricSet": { - "type": "operation", - "input": { - "target": "com.amazonaws.lookoutmetrics#DescribeMetricSetRequest" - }, - "output": { - "target": "com.amazonaws.lookoutmetrics#DescribeMetricSetResponse" - }, - "errors": [ - { - "target": "com.amazonaws.lookoutmetrics#AccessDeniedException" - }, - { - "target": "com.amazonaws.lookoutmetrics#InternalServerException" - }, - { - "target": "com.amazonaws.lookoutmetrics#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.lookoutmetrics#TooManyRequestsException" - }, - { - "target": "com.amazonaws.lookoutmetrics#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Describes a dataset.

\n

Amazon Lookout for Metrics API actions are eventually consistent. If you do a read operation on a resource\n immediately after creating or modifying it, use retries to allow time for the write operation to complete.

", - "smithy.api#http": { - "method": "POST", - "uri": "/DescribeMetricSet", - "code": 200 - } - } - }, - "com.amazonaws.lookoutmetrics#DescribeMetricSetRequest": { - "type": "structure", - "members": { - "MetricSetArn": { - "target": "com.amazonaws.lookoutmetrics#Arn", - "traits": { - "smithy.api#documentation": "

The ARN of the dataset.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lookoutmetrics#DescribeMetricSetResponse": { - "type": "structure", - "members": { - "MetricSetArn": { - "target": "com.amazonaws.lookoutmetrics#Arn", - "traits": { - "smithy.api#documentation": "

The ARN of the dataset.

" - } - }, - "AnomalyDetectorArn": { - "target": "com.amazonaws.lookoutmetrics#Arn", - "traits": { - "smithy.api#documentation": "

The ARN of the detector that contains the dataset.

" - } - }, - "MetricSetName": { - "target": "com.amazonaws.lookoutmetrics#MetricSetName", - "traits": { - "smithy.api#documentation": "

The name of the dataset.

" - } - }, - "MetricSetDescription": { - "target": "com.amazonaws.lookoutmetrics#MetricSetDescription", - "traits": { - "smithy.api#documentation": "

The dataset's description.

" - } - }, - "CreationTime": { - "target": "com.amazonaws.lookoutmetrics#Timestamp", - "traits": { - "smithy.api#documentation": "

The time at which the dataset was created.

" - } - }, - "LastModificationTime": { - "target": "com.amazonaws.lookoutmetrics#Timestamp", - "traits": { - "smithy.api#documentation": "

The time at which the dataset was last modified.

" - } - }, - "Offset": { - "target": "com.amazonaws.lookoutmetrics#Offset", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

After an interval ends, the amount of seconds that the detector waits before importing data. Offset is only supported for S3, Redshift, Athena and datasources.

" - } - }, - "MetricList": { - "target": "com.amazonaws.lookoutmetrics#MetricList", - "traits": { - "smithy.api#documentation": "

A list of the metrics defined by the dataset.

" - } - }, - "TimestampColumn": { - "target": "com.amazonaws.lookoutmetrics#TimestampColumn", - "traits": { - "smithy.api#documentation": "

Contains information about the column used for tracking time in your source data.

" - } - }, - "DimensionList": { - "target": "com.amazonaws.lookoutmetrics#DimensionList", - "traits": { - "smithy.api#documentation": "

A list of the dimensions chosen for analysis.

" - } - }, - "MetricSetFrequency": { - "target": "com.amazonaws.lookoutmetrics#Frequency", - "traits": { - "smithy.api#documentation": "

The interval at which the data will be analyzed for anomalies.

" - } - }, - "Timezone": { - "target": "com.amazonaws.lookoutmetrics#Timezone", - "traits": { - "smithy.api#documentation": "

The time zone in which the dataset's data was recorded.

" - } - }, - "MetricSource": { - "target": "com.amazonaws.lookoutmetrics#MetricSource", - "traits": { - "smithy.api#documentation": "

Contains information about the dataset's source data.

" - } - }, - "DimensionFilterList": { - "target": "com.amazonaws.lookoutmetrics#MetricSetDimensionFilterList", - "traits": { - "smithy.api#documentation": "

The dimensions and their values that were used to filter the dataset.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.lookoutmetrics#DetectMetricSetConfig": { - "type": "operation", - "input": { - "target": "com.amazonaws.lookoutmetrics#DetectMetricSetConfigRequest" - }, - "output": { - "target": "com.amazonaws.lookoutmetrics#DetectMetricSetConfigResponse" - }, - "errors": [ - { - "target": "com.amazonaws.lookoutmetrics#AccessDeniedException" - }, - { - "target": "com.amazonaws.lookoutmetrics#InternalServerException" - }, - { - "target": "com.amazonaws.lookoutmetrics#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.lookoutmetrics#TooManyRequestsException" - }, - { - "target": "com.amazonaws.lookoutmetrics#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Detects an Amazon S3 dataset's file format, interval, and offset.

", - "smithy.api#http": { - "method": "POST", - "uri": "/DetectMetricSetConfig", - "code": 200 - } - } - }, - "com.amazonaws.lookoutmetrics#DetectMetricSetConfigRequest": { - "type": "structure", - "members": { - "AnomalyDetectorArn": { - "target": "com.amazonaws.lookoutmetrics#Arn", - "traits": { - "smithy.api#documentation": "

An anomaly detector ARN.

", - "smithy.api#required": {} - } - }, - "AutoDetectionMetricSource": { - "target": "com.amazonaws.lookoutmetrics#AutoDetectionMetricSource", - "traits": { - "smithy.api#documentation": "

A data source.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lookoutmetrics#DetectMetricSetConfigResponse": { - "type": "structure", - "members": { - "DetectedMetricSetConfig": { - "target": "com.amazonaws.lookoutmetrics#DetectedMetricSetConfig", - "traits": { - "smithy.api#documentation": "

The inferred dataset configuration for the datasource.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.lookoutmetrics#DetectedCsvFormatDescriptor": { - "type": "structure", - "members": { - "FileCompression": { - "target": "com.amazonaws.lookoutmetrics#DetectedField", - "traits": { - "smithy.api#documentation": "

The format's file compression.

" - } - }, - "Charset": { - "target": "com.amazonaws.lookoutmetrics#DetectedField", - "traits": { - "smithy.api#documentation": "

The format's charset.

" - } - }, - "ContainsHeader": { - "target": "com.amazonaws.lookoutmetrics#DetectedField", - "traits": { - "smithy.api#documentation": "

Whether the format includes a header.

" - } - }, - "Delimiter": { - "target": "com.amazonaws.lookoutmetrics#DetectedField", - "traits": { - "smithy.api#documentation": "

The format's delimiter.

" - } - }, - "HeaderList": { - "target": "com.amazonaws.lookoutmetrics#DetectedField", - "traits": { - "smithy.api#documentation": "

The format's header list.

" - } - }, - "QuoteSymbol": { - "target": "com.amazonaws.lookoutmetrics#DetectedField", - "traits": { - "smithy.api#documentation": "

The format's quote symbol.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Properties of an inferred CSV format.

" - } - }, - "com.amazonaws.lookoutmetrics#DetectedField": { - "type": "structure", - "members": { - "Value": { - "target": "com.amazonaws.lookoutmetrics#AttributeValue", - "traits": { - "smithy.api#documentation": "

The field's value.

" - } - }, - "Confidence": { - "target": "com.amazonaws.lookoutmetrics#Confidence", - "traits": { - "smithy.api#documentation": "

The field's confidence.

" - } - }, - "Message": { - "target": "com.amazonaws.lookoutmetrics#Message", - "traits": { - "smithy.api#documentation": "

The field's message.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

An inferred field.

" - } - }, - "com.amazonaws.lookoutmetrics#DetectedFileFormatDescriptor": { - "type": "structure", - "members": { - "CsvFormatDescriptor": { - "target": "com.amazonaws.lookoutmetrics#DetectedCsvFormatDescriptor", - "traits": { - "smithy.api#documentation": "

Details about a CSV format.

" - } - }, - "JsonFormatDescriptor": { - "target": "com.amazonaws.lookoutmetrics#DetectedJsonFormatDescriptor", - "traits": { - "smithy.api#documentation": "

Details about a JSON format.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Properties of an inferred data format.

" - } - }, - "com.amazonaws.lookoutmetrics#DetectedJsonFormatDescriptor": { - "type": "structure", - "members": { - "FileCompression": { - "target": "com.amazonaws.lookoutmetrics#DetectedField", - "traits": { - "smithy.api#documentation": "

The format's file compression.

" - } - }, - "Charset": { - "target": "com.amazonaws.lookoutmetrics#DetectedField", - "traits": { - "smithy.api#documentation": "

The format's character set.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A detected JSON format descriptor.

" - } - }, - "com.amazonaws.lookoutmetrics#DetectedMetricSetConfig": { - "type": "structure", - "members": { - "Offset": { - "target": "com.amazonaws.lookoutmetrics#DetectedField", - "traits": { - "smithy.api#documentation": "

The dataset's offset.

" - } - }, - "MetricSetFrequency": { - "target": "com.amazonaws.lookoutmetrics#DetectedField", - "traits": { - "smithy.api#documentation": "

The dataset's interval.

" - } - }, - "MetricSource": { - "target": "com.amazonaws.lookoutmetrics#DetectedMetricSource", - "traits": { - "smithy.api#documentation": "

The dataset's data source.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

An inferred dataset configuration.

" - } - }, - "com.amazonaws.lookoutmetrics#DetectedMetricSource": { - "type": "structure", - "members": { - "S3SourceConfig": { - "target": "com.amazonaws.lookoutmetrics#DetectedS3SourceConfig", - "traits": { - "smithy.api#documentation": "

The data source's source configuration.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

An inferred data source.

" - } - }, - "com.amazonaws.lookoutmetrics#DetectedS3SourceConfig": { - "type": "structure", - "members": { - "FileFormatDescriptor": { - "target": "com.amazonaws.lookoutmetrics#DetectedFileFormatDescriptor", - "traits": { - "smithy.api#documentation": "

The source's file format descriptor.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

An inferred source configuration.

" - } - }, - "com.amazonaws.lookoutmetrics#DimensionContribution": { - "type": "structure", - "members": { - "DimensionName": { - "target": "com.amazonaws.lookoutmetrics#ColumnName", - "traits": { - "smithy.api#documentation": "

The name of the dimension.

" - } - }, - "DimensionValueContributionList": { - "target": "com.amazonaws.lookoutmetrics#DimensionValueContributionList", - "traits": { - "smithy.api#documentation": "

A list of dimension values that contributed to the anomaly.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Details about a dimension that contributed to an anomaly.

" - } - }, - "com.amazonaws.lookoutmetrics#DimensionContributionList": { - "type": "list", - "member": { - "target": "com.amazonaws.lookoutmetrics#DimensionContribution" - } - }, - "com.amazonaws.lookoutmetrics#DimensionFilter": { - "type": "structure", - "members": { - "DimensionName": { - "target": "com.amazonaws.lookoutmetrics#ColumnName", - "traits": { - "smithy.api#documentation": "

The name of the dimension to filter on.

" - } - }, - "DimensionValueList": { - "target": "com.amazonaws.lookoutmetrics#DimensionValueList", - "traits": { - "smithy.api#documentation": "

The list of values for the dimension specified in DimensionName that you want to filter on.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The dimension filter, containing DimensionName and DimensionValueList.

" - } - }, - "com.amazonaws.lookoutmetrics#DimensionFilterList": { - "type": "list", - "member": { - "target": "com.amazonaws.lookoutmetrics#DimensionFilter" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 5 - } - } - }, - "com.amazonaws.lookoutmetrics#DimensionList": { - "type": "list", - "member": { - "target": "com.amazonaws.lookoutmetrics#ColumnName" - }, - "traits": { - "smithy.api#length": { - "min": 1 - } - } - }, - "com.amazonaws.lookoutmetrics#DimensionNameValue": { - "type": "structure", - "members": { - "DimensionName": { - "target": "com.amazonaws.lookoutmetrics#ColumnName", - "traits": { - "smithy.api#documentation": "

The name of the dimension.

", - "smithy.api#required": {} - } - }, - "DimensionValue": { - "target": "com.amazonaws.lookoutmetrics#DimensionValue", - "traits": { - "smithy.api#documentation": "

The value of the dimension.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A dimension name and value.

" - } - }, - "com.amazonaws.lookoutmetrics#DimensionNameValueList": { - "type": "list", - "member": { - "target": "com.amazonaws.lookoutmetrics#DimensionNameValue" - } - }, - "com.amazonaws.lookoutmetrics#DimensionValue": { - "type": "string" - }, - "com.amazonaws.lookoutmetrics#DimensionValueContribution": { - "type": "structure", - "members": { - "DimensionValue": { - "target": "com.amazonaws.lookoutmetrics#DimensionValue", - "traits": { - "smithy.api#documentation": "

The value of the dimension.

" - } - }, - "ContributionScore": { - "target": "com.amazonaws.lookoutmetrics#Score", - "traits": { - "smithy.api#documentation": "

The severity score of the value.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The severity of a value of a dimension that contributed to an anomaly.

" - } - }, - "com.amazonaws.lookoutmetrics#DimensionValueContributionList": { - "type": "list", - "member": { - "target": "com.amazonaws.lookoutmetrics#DimensionValueContribution" - } - }, - "com.amazonaws.lookoutmetrics#DimensionValueList": { - "type": "list", - "member": { - "target": "com.amazonaws.lookoutmetrics#DimensionValue" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 10 - } - } - }, - "com.amazonaws.lookoutmetrics#Double": { - "type": "double" - }, - "com.amazonaws.lookoutmetrics#ErrorMessage": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - } - } - }, - "com.amazonaws.lookoutmetrics#ExecutionList": { - "type": "list", - "member": { - "target": "com.amazonaws.lookoutmetrics#ExecutionStatus" - } - }, - "com.amazonaws.lookoutmetrics#ExecutionStatus": { - "type": "structure", - "members": { - "Timestamp": { - "target": "com.amazonaws.lookoutmetrics#TimestampString", - "traits": { - "smithy.api#documentation": "

The run's timestamp.

" - } - }, - "Status": { - "target": "com.amazonaws.lookoutmetrics#AnomalyDetectionTaskStatus", - "traits": { - "smithy.api#documentation": "

The run's status.

" - } - }, - "FailureReason": { - "target": "com.amazonaws.lookoutmetrics#AnomalyDetectionTaskStatusMessage", - "traits": { - "smithy.api#documentation": "

The reason that the run failed, if applicable.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The status of an anomaly detector run.

" - } - }, - "com.amazonaws.lookoutmetrics#FieldName": { - "type": "string" - }, - "com.amazonaws.lookoutmetrics#FileFormatDescriptor": { - "type": "structure", - "members": { - "CsvFormatDescriptor": { - "target": "com.amazonaws.lookoutmetrics#CsvFormatDescriptor", - "traits": { - "smithy.api#documentation": "

Contains information about how a source CSV data file should be analyzed.

" - } - }, - "JsonFormatDescriptor": { - "target": "com.amazonaws.lookoutmetrics#JsonFormatDescriptor", - "traits": { - "smithy.api#documentation": "

Contains information about how a source JSON data file should be analyzed.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains information about a source file's formatting.

" - } - }, - "com.amazonaws.lookoutmetrics#Filter": { - "type": "structure", - "members": { - "DimensionValue": { - "target": "com.amazonaws.lookoutmetrics#DimensionValue", - "traits": { - "smithy.api#documentation": "

The value that you want to include in the filter.

" - } - }, - "FilterOperation": { - "target": "com.amazonaws.lookoutmetrics#FilterOperation", - "traits": { - "smithy.api#documentation": "

The condition to apply.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a filter for choosing a subset of dimension values. Each filter consists of the dimension that you want to include and the condition statement. The condition statement is specified in the FilterOperation object.

" - } - }, - "com.amazonaws.lookoutmetrics#FilterList": { - "type": "list", - "member": { - "target": "com.amazonaws.lookoutmetrics#Filter" - }, - "traits": { - "smithy.api#length": { - "min": 1 - } - } - }, - "com.amazonaws.lookoutmetrics#FilterOperation": { - "type": "enum", - "members": { - "EQUALS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EQUALS" - } - } - } - }, - "com.amazonaws.lookoutmetrics#FlowName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - }, - "smithy.api#pattern": "^[a-zA-Z0-9][\\w!@#.-]+$" - } - }, - "com.amazonaws.lookoutmetrics#Frequency": { - "type": "enum", - "members": { - "P1D": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "P1D" - } - }, - "PT1H": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PT1H" - } - }, - "PT10M": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PT10M" - } - }, - "PT5M": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PT5M" - } - } - } - }, - "com.amazonaws.lookoutmetrics#GetAnomalyGroup": { - "type": "operation", - "input": { - "target": "com.amazonaws.lookoutmetrics#GetAnomalyGroupRequest" - }, - "output": { - "target": "com.amazonaws.lookoutmetrics#GetAnomalyGroupResponse" - }, - "errors": [ - { - "target": "com.amazonaws.lookoutmetrics#AccessDeniedException" - }, - { - "target": "com.amazonaws.lookoutmetrics#InternalServerException" - }, - { - "target": "com.amazonaws.lookoutmetrics#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.lookoutmetrics#TooManyRequestsException" - }, - { - "target": "com.amazonaws.lookoutmetrics#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns details about a group of anomalous metrics.

", - "smithy.api#http": { - "method": "POST", - "uri": "/GetAnomalyGroup", - "code": 200 - } - } - }, - "com.amazonaws.lookoutmetrics#GetAnomalyGroupRequest": { - "type": "structure", - "members": { - "AnomalyGroupId": { - "target": "com.amazonaws.lookoutmetrics#UUID", - "traits": { - "smithy.api#documentation": "

The ID of the anomaly group.

", - "smithy.api#required": {} - } - }, - "AnomalyDetectorArn": { - "target": "com.amazonaws.lookoutmetrics#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the anomaly detector.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lookoutmetrics#GetAnomalyGroupResponse": { - "type": "structure", - "members": { - "AnomalyGroup": { - "target": "com.amazonaws.lookoutmetrics#AnomalyGroup", - "traits": { - "smithy.api#documentation": "

Details about the anomaly group.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.lookoutmetrics#GetDataQualityMetrics": { - "type": "operation", - "input": { - "target": "com.amazonaws.lookoutmetrics#GetDataQualityMetricsRequest" - }, - "output": { - "target": "com.amazonaws.lookoutmetrics#GetDataQualityMetricsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.lookoutmetrics#AccessDeniedException" - }, - { - "target": "com.amazonaws.lookoutmetrics#InternalServerException" - }, - { - "target": "com.amazonaws.lookoutmetrics#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.lookoutmetrics#TooManyRequestsException" - }, - { - "target": "com.amazonaws.lookoutmetrics#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns details about the requested data quality metrics.

", - "smithy.api#http": { - "method": "POST", - "uri": "/GetDataQualityMetrics", - "code": 200 - } - } - }, - "com.amazonaws.lookoutmetrics#GetDataQualityMetricsRequest": { - "type": "structure", - "members": { - "AnomalyDetectorArn": { - "target": "com.amazonaws.lookoutmetrics#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the anomaly detector that you want to investigate.

", - "smithy.api#required": {} - } - }, - "MetricSetArn": { - "target": "com.amazonaws.lookoutmetrics#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a specific data quality metric set.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lookoutmetrics#GetDataQualityMetricsResponse": { - "type": "structure", - "members": { - "AnomalyDetectorDataQualityMetricList": { - "target": "com.amazonaws.lookoutmetrics#AnomalyDetectorDataQualityMetricList", - "traits": { - "smithy.api#documentation": "

A list of the data quality metrics for the AnomalyDetectorArn that you requested.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.lookoutmetrics#GetFeedback": { - "type": "operation", - "input": { - "target": "com.amazonaws.lookoutmetrics#GetFeedbackRequest" - }, - "output": { - "target": "com.amazonaws.lookoutmetrics#GetFeedbackResponse" - }, - "errors": [ - { - "target": "com.amazonaws.lookoutmetrics#AccessDeniedException" - }, - { - "target": "com.amazonaws.lookoutmetrics#InternalServerException" - }, - { - "target": "com.amazonaws.lookoutmetrics#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.lookoutmetrics#TooManyRequestsException" - }, - { - "target": "com.amazonaws.lookoutmetrics#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Get feedback for an anomaly group.

", - "smithy.api#http": { - "method": "POST", - "uri": "/GetFeedback", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.lookoutmetrics#GetFeedbackRequest": { - "type": "structure", - "members": { - "AnomalyDetectorArn": { - "target": "com.amazonaws.lookoutmetrics#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the anomaly detector.

", - "smithy.api#required": {} - } - }, - "AnomalyGroupTimeSeriesFeedback": { - "target": "com.amazonaws.lookoutmetrics#AnomalyGroupTimeSeries", - "traits": { - "smithy.api#documentation": "

The anomalous metric and group ID.

", - "smithy.api#required": {} - } - }, - "MaxResults": { - "target": "com.amazonaws.lookoutmetrics#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to return.

" - } - }, - "NextToken": { - "target": "com.amazonaws.lookoutmetrics#NextToken", - "traits": { - "smithy.api#documentation": "

Specify the pagination token that's returned by a previous request to retrieve the next page of results.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lookoutmetrics#GetFeedbackResponse": { - "type": "structure", - "members": { - "AnomalyGroupTimeSeriesFeedback": { - "target": "com.amazonaws.lookoutmetrics#TimeSeriesFeedbackList", - "traits": { - "smithy.api#documentation": "

Feedback for an anomalous metric.

" - } - }, - "NextToken": { - "target": "com.amazonaws.lookoutmetrics#NextToken", - "traits": { - "smithy.api#documentation": "

The pagination token that's included if more results are available.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.lookoutmetrics#GetSampleData": { - "type": "operation", - "input": { - "target": "com.amazonaws.lookoutmetrics#GetSampleDataRequest" - }, - "output": { - "target": "com.amazonaws.lookoutmetrics#GetSampleDataResponse" - }, - "errors": [ - { - "target": "com.amazonaws.lookoutmetrics#AccessDeniedException" - }, - { - "target": "com.amazonaws.lookoutmetrics#InternalServerException" - }, - { - "target": "com.amazonaws.lookoutmetrics#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.lookoutmetrics#TooManyRequestsException" - }, - { - "target": "com.amazonaws.lookoutmetrics#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns a selection of sample records from an Amazon S3 datasource.

", - "smithy.api#http": { - "method": "POST", - "uri": "/GetSampleData", - "code": 200 - } - } - }, - "com.amazonaws.lookoutmetrics#GetSampleDataRequest": { - "type": "structure", - "members": { - "S3SourceConfig": { - "target": "com.amazonaws.lookoutmetrics#SampleDataS3SourceConfig", - "traits": { - "smithy.api#documentation": "

A datasource bucket in Amazon S3.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lookoutmetrics#GetSampleDataResponse": { - "type": "structure", - "members": { - "HeaderValues": { - "target": "com.amazonaws.lookoutmetrics#HeaderValueList", - "traits": { - "smithy.api#documentation": "

A list of header labels for the records.

" - } - }, - "SampleRows": { - "target": "com.amazonaws.lookoutmetrics#SampleRows", - "traits": { - "smithy.api#documentation": "

A list of records.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.lookoutmetrics#HeaderList": { - "type": "list", - "member": { - "target": "com.amazonaws.lookoutmetrics#ColumnName" - } - }, - "com.amazonaws.lookoutmetrics#HeaderValue": { - "type": "string" - }, - "com.amazonaws.lookoutmetrics#HeaderValueList": { - "type": "list", - "member": { - "target": "com.amazonaws.lookoutmetrics#HeaderValue" - } - }, - "com.amazonaws.lookoutmetrics#HistoricalDataPath": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1024 - }, - "smithy.api#pattern": "^s3://[a-z0-9].+$" - } - }, - "com.amazonaws.lookoutmetrics#HistoricalDataPathList": { - "type": "list", - "member": { - "target": "com.amazonaws.lookoutmetrics#HistoricalDataPath" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1 - } - } - }, - "com.amazonaws.lookoutmetrics#Integer": { - "type": "integer", - "traits": { - "smithy.api#default": 0 - } - }, - "com.amazonaws.lookoutmetrics#InterMetricImpactDetails": { - "type": "structure", - "members": { - "MetricName": { - "target": "com.amazonaws.lookoutmetrics#MetricName", - "traits": { - "smithy.api#documentation": "

The name of the measure.

" - } - }, - "AnomalyGroupId": { - "target": "com.amazonaws.lookoutmetrics#UUID", - "traits": { - "smithy.api#documentation": "

The ID of the anomaly group.

" - } - }, - "RelationshipType": { - "target": "com.amazonaws.lookoutmetrics#RelationshipType", - "traits": { - "smithy.api#documentation": "

Whether a measure is a potential cause of the anomaly group\n (CAUSE_OF_INPUT_ANOMALY_GROUP), or whether the measure is impacted by the\n anomaly group (EFFECT_OF_INPUT_ANOMALY_GROUP).

" - } - }, - "ContributionPercentage": { - "target": "com.amazonaws.lookoutmetrics#MetricChangePercentage", - "traits": { - "smithy.api#documentation": "

For potential causes (CAUSE_OF_INPUT_ANOMALY_GROUP), the percentage\n contribution the measure has in causing the anomalies.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Aggregated details about the measures contributing to the anomaly group, and the measures\n potentially impacted by the anomaly group.

\n

" - } - }, - "com.amazonaws.lookoutmetrics#InterMetricImpactList": { - "type": "list", - "member": { - "target": "com.amazonaws.lookoutmetrics#InterMetricImpactDetails" - } - }, - "com.amazonaws.lookoutmetrics#InternalServerException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.lookoutmetrics#Message", - "traits": { - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The request processing has failed because of an unknown error, exception, or failure.

", - "smithy.api#error": "server", - "smithy.api#httpError": 500 - } - }, - "com.amazonaws.lookoutmetrics#ItemizedMetricStats": { - "type": "structure", - "members": { - "MetricName": { - "target": "com.amazonaws.lookoutmetrics#ColumnName", - "traits": { - "smithy.api#documentation": "

The name of the measure.

" - } - }, - "OccurrenceCount": { - "target": "com.amazonaws.lookoutmetrics#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of times that the measure appears.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Aggregated statistics about a measure affected by an anomaly.

" - } - }, - "com.amazonaws.lookoutmetrics#ItemizedMetricStatsList": { - "type": "list", - "member": { - "target": "com.amazonaws.lookoutmetrics#ItemizedMetricStats" - } - }, - "com.amazonaws.lookoutmetrics#JsonFileCompression": { - "type": "enum", - "members": { - "NONE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NONE" - } - }, - "GZIP": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "GZIP" - } - } - } - }, - "com.amazonaws.lookoutmetrics#JsonFormatDescriptor": { - "type": "structure", - "members": { - "FileCompression": { - "target": "com.amazonaws.lookoutmetrics#JsonFileCompression", - "traits": { - "smithy.api#documentation": "

The level of compression of the source CSV file.

" - } - }, - "Charset": { - "target": "com.amazonaws.lookoutmetrics#Charset", - "traits": { - "smithy.api#documentation": "

The character set in which the source JSON file is written.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains information about how a source JSON data file should be analyzed.

" - } - }, - "com.amazonaws.lookoutmetrics#KmsKeyArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 20, - "max": 2048 - }, - "smithy.api#pattern": "^arn:aws.*:kms:.*:[0-9]{12}:key/[a-z0-9]{8}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{12}$" - } - }, - "com.amazonaws.lookoutmetrics#LambdaConfiguration": { - "type": "structure", - "members": { - "RoleArn": { - "target": "com.amazonaws.lookoutmetrics#Arn", - "traits": { - "smithy.api#documentation": "

The ARN of an IAM role that has permission to invoke the Lambda function.

", - "smithy.api#required": {} - } - }, - "LambdaArn": { - "target": "com.amazonaws.lookoutmetrics#Arn", - "traits": { - "smithy.api#documentation": "

The ARN of the Lambda function.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains information about a Lambda configuration.

" - } - }, - "com.amazonaws.lookoutmetrics#ListAlerts": { - "type": "operation", - "input": { - "target": "com.amazonaws.lookoutmetrics#ListAlertsRequest" - }, - "output": { - "target": "com.amazonaws.lookoutmetrics#ListAlertsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.lookoutmetrics#AccessDeniedException" - }, - { - "target": "com.amazonaws.lookoutmetrics#InternalServerException" - }, - { - "target": "com.amazonaws.lookoutmetrics#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.lookoutmetrics#TooManyRequestsException" - }, - { - "target": "com.amazonaws.lookoutmetrics#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists the alerts attached to a detector.

\n

Amazon Lookout for Metrics API actions are eventually consistent. If you do a read operation on a resource\n immediately after creating or modifying it, use retries to allow time for the write operation to complete.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ListAlerts", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.lookoutmetrics#ListAlertsRequest": { - "type": "structure", - "members": { - "AnomalyDetectorArn": { - "target": "com.amazonaws.lookoutmetrics#Arn", - "traits": { - "smithy.api#documentation": "

The ARN of the alert's detector.

" - } - }, - "NextToken": { - "target": "com.amazonaws.lookoutmetrics#NextToken", - "traits": { - "smithy.api#documentation": "

If the result of the previous request is truncated, the response includes a NextToken. To\n retrieve the next set of results, use the token in the next request. Tokens expire after 24 hours.

" - } - }, - "MaxResults": { - "target": "com.amazonaws.lookoutmetrics#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results that will be displayed by the request.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lookoutmetrics#ListAlertsResponse": { - "type": "structure", - "members": { - "AlertSummaryList": { - "target": "com.amazonaws.lookoutmetrics#AlertSummaryList", - "traits": { - "smithy.api#documentation": "

Contains information about an alert.

" - } - }, - "NextToken": { - "target": "com.amazonaws.lookoutmetrics#NextToken", - "traits": { - "smithy.api#documentation": "

If the response is truncated, the service returns this token. To retrieve the next set of results, use this\n token in the next request.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.lookoutmetrics#ListAnomalyDetectors": { - "type": "operation", - "input": { - "target": "com.amazonaws.lookoutmetrics#ListAnomalyDetectorsRequest" - }, - "output": { - "target": "com.amazonaws.lookoutmetrics#ListAnomalyDetectorsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.lookoutmetrics#AccessDeniedException" - }, - { - "target": "com.amazonaws.lookoutmetrics#InternalServerException" - }, - { - "target": "com.amazonaws.lookoutmetrics#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.lookoutmetrics#TooManyRequestsException" - }, - { - "target": "com.amazonaws.lookoutmetrics#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists the detectors in the current AWS Region.

\n

Amazon Lookout for Metrics API actions are eventually consistent. If you do a read operation on a resource\n immediately after creating or modifying it, use retries to allow time for the write operation to complete.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ListAnomalyDetectors", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.lookoutmetrics#ListAnomalyDetectorsRequest": { - "type": "structure", - "members": { - "MaxResults": { - "target": "com.amazonaws.lookoutmetrics#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to return.

" - } - }, - "NextToken": { - "target": "com.amazonaws.lookoutmetrics#NextToken", - "traits": { - "smithy.api#documentation": "

If the result of the previous request was truncated, the response includes a NextToken. To\n retrieve the next set of results, use the token in the next request. Tokens expire after 24 hours.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lookoutmetrics#ListAnomalyDetectorsResponse": { - "type": "structure", - "members": { - "AnomalyDetectorSummaryList": { - "target": "com.amazonaws.lookoutmetrics#AnomalyDetectorSummaryList", - "traits": { - "smithy.api#documentation": "

A list of anomaly detectors in the account in the current region.

" - } - }, - "NextToken": { - "target": "com.amazonaws.lookoutmetrics#NextToken", - "traits": { - "smithy.api#documentation": "

If the response is truncated, the service returns this token. To retrieve the next set of results, use the\n token in the next request.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.lookoutmetrics#ListAnomalyGroupRelatedMetrics": { - "type": "operation", - "input": { - "target": "com.amazonaws.lookoutmetrics#ListAnomalyGroupRelatedMetricsRequest" - }, - "output": { - "target": "com.amazonaws.lookoutmetrics#ListAnomalyGroupRelatedMetricsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.lookoutmetrics#AccessDeniedException" - }, - { - "target": "com.amazonaws.lookoutmetrics#InternalServerException" - }, - { - "target": "com.amazonaws.lookoutmetrics#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.lookoutmetrics#TooManyRequestsException" - }, - { - "target": "com.amazonaws.lookoutmetrics#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns a list of measures that are potential causes or effects of an\n anomaly group.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ListAnomalyGroupRelatedMetrics", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.lookoutmetrics#ListAnomalyGroupRelatedMetricsRequest": { - "type": "structure", - "members": { - "AnomalyDetectorArn": { - "target": "com.amazonaws.lookoutmetrics#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the anomaly detector.

", - "smithy.api#required": {} - } - }, - "AnomalyGroupId": { - "target": "com.amazonaws.lookoutmetrics#UUID", - "traits": { - "smithy.api#documentation": "

The ID of the anomaly group.

", - "smithy.api#required": {} - } - }, - "RelationshipTypeFilter": { - "target": "com.amazonaws.lookoutmetrics#RelationshipType", - "traits": { - "smithy.api#documentation": "

Filter for potential causes (CAUSE_OF_INPUT_ANOMALY_GROUP) or\n downstream effects (EFFECT_OF_INPUT_ANOMALY_GROUP) of the anomaly group.

" - } - }, - "MaxResults": { - "target": "com.amazonaws.lookoutmetrics#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to return.

" - } - }, - "NextToken": { - "target": "com.amazonaws.lookoutmetrics#NextToken", - "traits": { - "smithy.api#documentation": "

Specify the pagination token that's returned by a previous request to retrieve the next\n page of results.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lookoutmetrics#ListAnomalyGroupRelatedMetricsResponse": { - "type": "structure", - "members": { - "InterMetricImpactList": { - "target": "com.amazonaws.lookoutmetrics#InterMetricImpactList", - "traits": { - "smithy.api#documentation": "

Aggregated details about the measures contributing to the anomaly group, and the measures\n potentially impacted by the anomaly group.

" - } - }, - "NextToken": { - "target": "com.amazonaws.lookoutmetrics#NextToken", - "traits": { - "smithy.api#documentation": "

The pagination token that's included if more results are available.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.lookoutmetrics#ListAnomalyGroupSummaries": { - "type": "operation", - "input": { - "target": "com.amazonaws.lookoutmetrics#ListAnomalyGroupSummariesRequest" - }, - "output": { - "target": "com.amazonaws.lookoutmetrics#ListAnomalyGroupSummariesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.lookoutmetrics#AccessDeniedException" - }, - { - "target": "com.amazonaws.lookoutmetrics#InternalServerException" - }, - { - "target": "com.amazonaws.lookoutmetrics#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.lookoutmetrics#TooManyRequestsException" - }, - { - "target": "com.amazonaws.lookoutmetrics#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns a list of anomaly groups.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ListAnomalyGroupSummaries", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.lookoutmetrics#ListAnomalyGroupSummariesRequest": { - "type": "structure", - "members": { - "AnomalyDetectorArn": { - "target": "com.amazonaws.lookoutmetrics#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the anomaly detector.

", - "smithy.api#required": {} - } - }, - "SensitivityThreshold": { - "target": "com.amazonaws.lookoutmetrics#SensitivityThreshold", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The minimum severity score for inclusion in the output.

", - "smithy.api#required": {} - } - }, - "MaxResults": { - "target": "com.amazonaws.lookoutmetrics#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to return.

" - } - }, - "NextToken": { - "target": "com.amazonaws.lookoutmetrics#NextToken", - "traits": { - "smithy.api#documentation": "

Specify the pagination token that's returned by a previous request to retrieve the next page of results.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lookoutmetrics#ListAnomalyGroupSummariesResponse": { - "type": "structure", - "members": { - "AnomalyGroupSummaryList": { - "target": "com.amazonaws.lookoutmetrics#AnomalyGroupSummaryList", - "traits": { - "smithy.api#documentation": "

A list of anomaly group summaries.

" - } - }, - "AnomalyGroupStatistics": { - "target": "com.amazonaws.lookoutmetrics#AnomalyGroupStatistics", - "traits": { - "smithy.api#documentation": "

Aggregated details about the anomaly groups.

" - } - }, - "NextToken": { - "target": "com.amazonaws.lookoutmetrics#NextToken", - "traits": { - "smithy.api#documentation": "

The pagination token that's included if more results are available.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.lookoutmetrics#ListAnomalyGroupTimeSeries": { - "type": "operation", - "input": { - "target": "com.amazonaws.lookoutmetrics#ListAnomalyGroupTimeSeriesRequest" - }, - "output": { - "target": "com.amazonaws.lookoutmetrics#ListAnomalyGroupTimeSeriesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.lookoutmetrics#AccessDeniedException" - }, - { - "target": "com.amazonaws.lookoutmetrics#InternalServerException" - }, - { - "target": "com.amazonaws.lookoutmetrics#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.lookoutmetrics#TooManyRequestsException" - }, - { - "target": "com.amazonaws.lookoutmetrics#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Gets a list of anomalous metrics for a measure in an anomaly group.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ListAnomalyGroupTimeSeries", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.lookoutmetrics#ListAnomalyGroupTimeSeriesRequest": { - "type": "structure", - "members": { - "AnomalyDetectorArn": { - "target": "com.amazonaws.lookoutmetrics#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the anomaly detector.

", - "smithy.api#required": {} - } - }, - "AnomalyGroupId": { - "target": "com.amazonaws.lookoutmetrics#UUID", - "traits": { - "smithy.api#documentation": "

The ID of the anomaly group.

", - "smithy.api#required": {} - } - }, - "MetricName": { - "target": "com.amazonaws.lookoutmetrics#MetricName", - "traits": { - "smithy.api#documentation": "

The name of the measure field.

", - "smithy.api#required": {} - } - }, - "MaxResults": { - "target": "com.amazonaws.lookoutmetrics#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to return.

" - } - }, - "NextToken": { - "target": "com.amazonaws.lookoutmetrics#NextToken", - "traits": { - "smithy.api#documentation": "

Specify the pagination token that's returned by a previous request to retrieve the next page of results.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lookoutmetrics#ListAnomalyGroupTimeSeriesResponse": { - "type": "structure", - "members": { - "AnomalyGroupId": { - "target": "com.amazonaws.lookoutmetrics#UUID", - "traits": { - "smithy.api#documentation": "

The ID of the anomaly group.

" - } - }, - "MetricName": { - "target": "com.amazonaws.lookoutmetrics#MetricName", - "traits": { - "smithy.api#documentation": "

The name of the measure field.

" - } - }, - "TimestampList": { - "target": "com.amazonaws.lookoutmetrics#TimestampList", - "traits": { - "smithy.api#documentation": "

Timestamps for the anomalous metrics.

" - } - }, - "NextToken": { - "target": "com.amazonaws.lookoutmetrics#NextToken", - "traits": { - "smithy.api#documentation": "

The pagination token that's included if more results are available.

" - } - }, - "TimeSeriesList": { - "target": "com.amazonaws.lookoutmetrics#TimeSeriesList", - "traits": { - "smithy.api#documentation": "

A list of anomalous metrics.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.lookoutmetrics#ListMetricSets": { - "type": "operation", - "input": { - "target": "com.amazonaws.lookoutmetrics#ListMetricSetsRequest" - }, - "output": { - "target": "com.amazonaws.lookoutmetrics#ListMetricSetsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.lookoutmetrics#AccessDeniedException" - }, - { - "target": "com.amazonaws.lookoutmetrics#InternalServerException" - }, - { - "target": "com.amazonaws.lookoutmetrics#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.lookoutmetrics#TooManyRequestsException" - }, - { - "target": "com.amazonaws.lookoutmetrics#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists the datasets in the current AWS Region.

\n

Amazon Lookout for Metrics API actions are eventually consistent. If you do a read operation on a resource\n immediately after creating or modifying it, use retries to allow time for the write operation to complete.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ListMetricSets", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.lookoutmetrics#ListMetricSetsRequest": { - "type": "structure", - "members": { - "AnomalyDetectorArn": { - "target": "com.amazonaws.lookoutmetrics#Arn", - "traits": { - "smithy.api#documentation": "

The ARN of the anomaly detector containing the metrics sets to list.

" - } - }, - "MaxResults": { - "target": "com.amazonaws.lookoutmetrics#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to return.

" - } - }, - "NextToken": { - "target": "com.amazonaws.lookoutmetrics#NextToken", - "traits": { - "smithy.api#documentation": "

If the result of the previous request was truncated, the response includes a\n NextToken. To retrieve the next set of results, use the token in the next\n request. Tokens expire after 24 hours.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lookoutmetrics#ListMetricSetsResponse": { - "type": "structure", - "members": { - "MetricSetSummaryList": { - "target": "com.amazonaws.lookoutmetrics#MetricSetSummaryList", - "traits": { - "smithy.api#documentation": "

A list of the datasets in the AWS Region, with configuration details for each.

" - } - }, - "NextToken": { - "target": "com.amazonaws.lookoutmetrics#NextToken", - "traits": { - "smithy.api#documentation": "

If the response is truncated, the list call returns this token. To retrieve the next set\n of results, use the token in the next list request.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.lookoutmetrics#ListTagsForResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.lookoutmetrics#ListTagsForResourceRequest" - }, - "output": { - "target": "com.amazonaws.lookoutmetrics#ListTagsForResourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.lookoutmetrics#InternalServerException" - }, - { - "target": "com.amazonaws.lookoutmetrics#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.lookoutmetrics#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Gets a list of tags for a detector, dataset, or alert.

", - "smithy.api#http": { - "method": "GET", - "uri": "/tags/{ResourceArn}", - "code": 200 - } - } - }, - "com.amazonaws.lookoutmetrics#ListTagsForResourceRequest": { - "type": "structure", - "members": { - "ResourceArn": { - "target": "com.amazonaws.lookoutmetrics#Arn", - "traits": { - "smithy.api#documentation": "

The resource's Amazon Resource Name (ARN).

", - "smithy.api#httpLabel": {}, - "smithy.api#jsonName": "resourceArn", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lookoutmetrics#ListTagsForResourceResponse": { - "type": "structure", - "members": { - "Tags": { - "target": "com.amazonaws.lookoutmetrics#TagMap", - "traits": { - "smithy.api#documentation": "

The resource's tags.

", - "smithy.api#jsonName": "Tags" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.lookoutmetrics#LookoutMetrics": { - "type": "service", - "version": "2017-07-25", - "operations": [ - { - "target": "com.amazonaws.lookoutmetrics#ActivateAnomalyDetector" - }, - { - "target": "com.amazonaws.lookoutmetrics#BackTestAnomalyDetector" - }, - { - "target": "com.amazonaws.lookoutmetrics#CreateAlert" - }, - { - "target": "com.amazonaws.lookoutmetrics#CreateAnomalyDetector" - }, - { - "target": "com.amazonaws.lookoutmetrics#CreateMetricSet" - }, - { - "target": "com.amazonaws.lookoutmetrics#DeactivateAnomalyDetector" - }, - { - "target": "com.amazonaws.lookoutmetrics#DeleteAlert" - }, - { - "target": "com.amazonaws.lookoutmetrics#DeleteAnomalyDetector" - }, - { - "target": "com.amazonaws.lookoutmetrics#DescribeAlert" - }, - { - "target": "com.amazonaws.lookoutmetrics#DescribeAnomalyDetectionExecutions" - }, - { - "target": "com.amazonaws.lookoutmetrics#DescribeAnomalyDetector" - }, - { - "target": "com.amazonaws.lookoutmetrics#DescribeMetricSet" - }, - { - "target": "com.amazonaws.lookoutmetrics#DetectMetricSetConfig" - }, - { - "target": "com.amazonaws.lookoutmetrics#GetAnomalyGroup" - }, - { - "target": "com.amazonaws.lookoutmetrics#GetDataQualityMetrics" - }, - { - "target": "com.amazonaws.lookoutmetrics#GetFeedback" - }, - { - "target": "com.amazonaws.lookoutmetrics#GetSampleData" - }, - { - "target": "com.amazonaws.lookoutmetrics#ListAlerts" - }, - { - "target": "com.amazonaws.lookoutmetrics#ListAnomalyDetectors" - }, - { - "target": "com.amazonaws.lookoutmetrics#ListAnomalyGroupRelatedMetrics" - }, - { - "target": "com.amazonaws.lookoutmetrics#ListAnomalyGroupSummaries" - }, - { - "target": "com.amazonaws.lookoutmetrics#ListAnomalyGroupTimeSeries" - }, - { - "target": "com.amazonaws.lookoutmetrics#ListMetricSets" - }, - { - "target": "com.amazonaws.lookoutmetrics#ListTagsForResource" - }, - { - "target": "com.amazonaws.lookoutmetrics#PutFeedback" - }, - { - "target": "com.amazonaws.lookoutmetrics#TagResource" - }, - { - "target": "com.amazonaws.lookoutmetrics#UntagResource" - }, - { - "target": "com.amazonaws.lookoutmetrics#UpdateAlert" - }, - { - "target": "com.amazonaws.lookoutmetrics#UpdateAnomalyDetector" - }, - { - "target": "com.amazonaws.lookoutmetrics#UpdateMetricSet" - } - ], - "traits": { - "aws.api#service": { - "sdkId": "LookoutMetrics", - "arnNamespace": "lookoutmetrics", - "cloudFormationName": "LookoutMetrics", - "cloudTrailEventSource": "lookoutmetrics.amazonaws.com", - "endpointPrefix": "lookoutmetrics" - }, - "aws.auth#sigv4": { - "name": "lookoutmetrics" - }, - "aws.protocols#restJson1": {}, - "smithy.api#documentation": "

This is the Amazon Lookout for Metrics API Reference. For an introduction to the service\n with tutorials for getting started, visit Amazon\n Lookout for Metrics Developer Guide.

", - "smithy.api#title": "Amazon Lookout for Metrics", - "smithy.rules#endpointRuleSet": { - "version": "1.0", - "parameters": { - "Region": { - "builtIn": "AWS::Region", - "required": false, - "documentation": "The AWS region used to dispatch the request.", - "type": "String" - }, - "UseDualStack": { - "builtIn": "AWS::UseDualStack", - "required": true, - "default": false, - "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", - "type": "Boolean" - }, - "UseFIPS": { - "builtIn": "AWS::UseFIPS", - "required": true, - "default": false, - "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", - "type": "Boolean" - }, - "Endpoint": { - "builtIn": "SDK::Endpoint", - "required": false, - "documentation": "Override the endpoint used to send this request", - "type": "String" - } - }, - "rules": [ - { - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Endpoint" - } - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "error": "Invalid Configuration: FIPS and custom endpoint are not supported", - "type": "error" - }, - { - "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" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Region" - } - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "aws.partition", - "argv": [ - { - "ref": "Region" - } - ], - "assign": "PartitionResult" - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - }, - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://lookoutmetrics-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - }, - true - ] - } - ], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://lookoutmetrics-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://lookoutmetrics.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [], - "endpoint": { - "url": "https://lookoutmetrics.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" - } - ] - }, - "smithy.rules#endpointTests": { - "testCases": [ - { - "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://lookoutmetrics.ap-northeast-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-northeast-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://lookoutmetrics.ap-southeast-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-southeast-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://lookoutmetrics.ap-southeast-2.amazonaws.com" - } - }, - "params": { - "Region": "ap-southeast-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://lookoutmetrics.eu-central-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-central-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://lookoutmetrics.eu-north-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-north-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://lookoutmetrics.eu-west-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-west-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://lookoutmetrics.us-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://lookoutmetrics.us-east-2.amazonaws.com" - } - }, - "params": { - "Region": "us-east-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://lookoutmetrics.us-west-2.amazonaws.com" - } - }, - "params": { - "Region": "us-west-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://lookoutmetrics-fips.us-east-1.api.aws" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://lookoutmetrics-fips.us-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://lookoutmetrics.us-east-1.api.aws" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://lookoutmetrics-fips.cn-north-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://lookoutmetrics-fips.cn-north-1.amazonaws.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://lookoutmetrics.cn-north-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://lookoutmetrics.cn-north-1.amazonaws.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://lookoutmetrics-fips.us-gov-east-1.api.aws" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://lookoutmetrics-fips.us-gov-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://lookoutmetrics.us-gov-east-1.api.aws" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://lookoutmetrics.us-gov-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://lookoutmetrics-fips.us-iso-east-1.c2s.ic.gov" - } - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://lookoutmetrics.us-iso-east-1.c2s.ic.gov" - } - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://lookoutmetrics-fips.us-isob-east-1.sc2s.sgov.gov" - } - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://lookoutmetrics.us-isob-east-1.sc2s.sgov.gov" - } - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", - "expect": { - "endpoint": { - "url": "https://example.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": false, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", - "expect": { - "endpoint": { - "url": "https://example.com" - } - }, - "params": { - "UseFIPS": false, - "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": { - "Region": "us-east-1", - "UseFIPS": true, - "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": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": true, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "Missing region", - "expect": { - "error": "Invalid Configuration: Missing Region" - } - } - ], - "version": "1.0" - } - } - }, - "com.amazonaws.lookoutmetrics#MaxResults": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 100 - } - } - }, - "com.amazonaws.lookoutmetrics#Message": { - "type": "string" - }, - "com.amazonaws.lookoutmetrics#Metric": { - "type": "structure", - "members": { - "MetricName": { - "target": "com.amazonaws.lookoutmetrics#ColumnName", - "traits": { - "smithy.api#documentation": "

The name of the metric.

", - "smithy.api#required": {} - } - }, - "AggregationFunction": { - "target": "com.amazonaws.lookoutmetrics#AggregationFunction", - "traits": { - "smithy.api#documentation": "

The function with which the metric is calculated.

", - "smithy.api#required": {} - } - }, - "Namespace": { - "target": "com.amazonaws.lookoutmetrics#Namespace", - "traits": { - "smithy.api#documentation": "

The namespace for the metric.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A calculation made by contrasting a measure and a dimension from your source data.

" - } - }, - "com.amazonaws.lookoutmetrics#MetricChangePercentage": { - "type": "double", - "traits": { - "smithy.api#range": { - "min": 0.0, - "max": 100.0 - } - } - }, - "com.amazonaws.lookoutmetrics#MetricLevelImpact": { - "type": "structure", - "members": { - "MetricName": { - "target": "com.amazonaws.lookoutmetrics#MetricName", - "traits": { - "smithy.api#documentation": "

The name of the measure.

" - } - }, - "NumTimeSeries": { - "target": "com.amazonaws.lookoutmetrics#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of anomalous metrics for the measure.

" - } - }, - "ContributionMatrix": { - "target": "com.amazonaws.lookoutmetrics#ContributionMatrix", - "traits": { - "smithy.api#documentation": "

Details about the dimensions that contributed to the anomaly.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Details about a measure affected by an anomaly.

" - } - }, - "com.amazonaws.lookoutmetrics#MetricLevelImpactList": { - "type": "list", - "member": { - "target": "com.amazonaws.lookoutmetrics#MetricLevelImpact" - } - }, - "com.amazonaws.lookoutmetrics#MetricList": { - "type": "list", - "member": { - "target": "com.amazonaws.lookoutmetrics#Metric" - }, - "traits": { - "smithy.api#length": { - "min": 1 - } - } - }, - "com.amazonaws.lookoutmetrics#MetricName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - }, - "smithy.api#pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]*$" - } - }, - "com.amazonaws.lookoutmetrics#MetricNameList": { - "type": "list", - "member": { - "target": "com.amazonaws.lookoutmetrics#MetricName" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 5 - } - } - }, - "com.amazonaws.lookoutmetrics#MetricSetDataQualityMetric": { - "type": "structure", - "members": { - "MetricSetArn": { - "target": "com.amazonaws.lookoutmetrics#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the data quality metric array.

" - } - }, - "DataQualityMetricList": { - "target": "com.amazonaws.lookoutmetrics#DataQualityMetricList", - "traits": { - "smithy.api#documentation": "

The array of data quality metrics contained in the data quality metric set.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

An array of DataQualityMetric objects that describes one or more data quality metrics.

" - } - }, - "com.amazonaws.lookoutmetrics#MetricSetDataQualityMetricList": { - "type": "list", - "member": { - "target": "com.amazonaws.lookoutmetrics#MetricSetDataQualityMetric" - } - }, - "com.amazonaws.lookoutmetrics#MetricSetDescription": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - }, - "smithy.api#pattern": "\\S" - } - }, - "com.amazonaws.lookoutmetrics#MetricSetDimensionFilter": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.lookoutmetrics#ColumnName", - "traits": { - "smithy.api#documentation": "

The dimension that you want to filter on.

" - } - }, - "FilterList": { - "target": "com.amazonaws.lookoutmetrics#FilterList", - "traits": { - "smithy.api#documentation": "

The list of filters that you are applying.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a list of filters for choosing a subset of dimension values. Each filter consists of the dimension and one of its values that you want to include. When multiple dimensions or values are specified, the dimensions are joined with an AND operation and the values are joined with an OR operation.

" - } - }, - "com.amazonaws.lookoutmetrics#MetricSetDimensionFilterList": { - "type": "list", - "member": { - "target": "com.amazonaws.lookoutmetrics#MetricSetDimensionFilter" - } - }, - "com.amazonaws.lookoutmetrics#MetricSetName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 63 - }, - "smithy.api#pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]*$" - } - }, - "com.amazonaws.lookoutmetrics#MetricSetSummary": { - "type": "structure", - "members": { - "MetricSetArn": { - "target": "com.amazonaws.lookoutmetrics#Arn", - "traits": { - "smithy.api#documentation": "

The ARN of the dataset.

" - } - }, - "AnomalyDetectorArn": { - "target": "com.amazonaws.lookoutmetrics#Arn", - "traits": { - "smithy.api#documentation": "

The ARN of the detector to which the dataset belongs.

" - } - }, - "MetricSetDescription": { - "target": "com.amazonaws.lookoutmetrics#MetricSetDescription", - "traits": { - "smithy.api#documentation": "

The description of the dataset.

" - } - }, - "MetricSetName": { - "target": "com.amazonaws.lookoutmetrics#MetricSetName", - "traits": { - "smithy.api#documentation": "

The name of the dataset.

" - } - }, - "CreationTime": { - "target": "com.amazonaws.lookoutmetrics#Timestamp", - "traits": { - "smithy.api#documentation": "

The time at which the dataset was created.

" - } - }, - "LastModificationTime": { - "target": "com.amazonaws.lookoutmetrics#Timestamp", - "traits": { - "smithy.api#documentation": "

The time at which the dataset was last modified.

" - } - }, - "Tags": { - "target": "com.amazonaws.lookoutmetrics#TagMap", - "traits": { - "smithy.api#documentation": "

The dataset's tags.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains information about a dataset.

" - } - }, - "com.amazonaws.lookoutmetrics#MetricSetSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.lookoutmetrics#MetricSetSummary" - } - }, - "com.amazonaws.lookoutmetrics#MetricSource": { - "type": "structure", - "members": { - "S3SourceConfig": { - "target": "com.amazonaws.lookoutmetrics#S3SourceConfig" - }, - "AppFlowConfig": { - "target": "com.amazonaws.lookoutmetrics#AppFlowConfig", - "traits": { - "smithy.api#documentation": "

Details about an AppFlow datasource.

" - } - }, - "CloudWatchConfig": { - "target": "com.amazonaws.lookoutmetrics#CloudWatchConfig", - "traits": { - "smithy.api#documentation": "

Details about an Amazon CloudWatch monitoring datasource.

" - } - }, - "RDSSourceConfig": { - "target": "com.amazonaws.lookoutmetrics#RDSSourceConfig", - "traits": { - "smithy.api#documentation": "

Details about an Amazon Relational Database Service (RDS) datasource.

" - } - }, - "RedshiftSourceConfig": { - "target": "com.amazonaws.lookoutmetrics#RedshiftSourceConfig", - "traits": { - "smithy.api#documentation": "

Details about an Amazon Redshift database datasource.

" - } - }, - "AthenaSourceConfig": { - "target": "com.amazonaws.lookoutmetrics#AthenaSourceConfig", - "traits": { - "smithy.api#documentation": "

Details about an Amazon Athena datasource.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains information about source data used to generate metrics.

" - } - }, - "com.amazonaws.lookoutmetrics#MetricValue": { - "type": "double" - }, - "com.amazonaws.lookoutmetrics#MetricValueList": { - "type": "list", - "member": { - "target": "com.amazonaws.lookoutmetrics#MetricValue" - } - }, - "com.amazonaws.lookoutmetrics#Namespace": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 255 - }, - "smithy.api#pattern": "^[^:]" - } - }, - "com.amazonaws.lookoutmetrics#NextToken": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 3000 - }, - "smithy.api#pattern": "\\S" - } - }, - "com.amazonaws.lookoutmetrics#NumberAttributeValue": { - "type": "string" - }, - "com.amazonaws.lookoutmetrics#NumberListAttributeValue": { - "type": "list", - "member": { - "target": "com.amazonaws.lookoutmetrics#NumberAttributeValue" - } - }, - "com.amazonaws.lookoutmetrics#Offset": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 0, - "max": 432000 - } - } - }, - "com.amazonaws.lookoutmetrics#PoirotSecretManagerArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - }, - "smithy.api#pattern": "^arn:([a-z\\d-]+):.*:.*:secret:AmazonLookoutMetrics-.+$" - } - }, - "com.amazonaws.lookoutmetrics#PutFeedback": { - "type": "operation", - "input": { - "target": "com.amazonaws.lookoutmetrics#PutFeedbackRequest" - }, - "output": { - "target": "com.amazonaws.lookoutmetrics#PutFeedbackResponse" - }, - "errors": [ - { - "target": "com.amazonaws.lookoutmetrics#AccessDeniedException" - }, - { - "target": "com.amazonaws.lookoutmetrics#InternalServerException" - }, - { - "target": "com.amazonaws.lookoutmetrics#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.lookoutmetrics#TooManyRequestsException" - }, - { - "target": "com.amazonaws.lookoutmetrics#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Add feedback for an anomalous metric.

", - "smithy.api#http": { - "method": "POST", - "uri": "/PutFeedback", - "code": 200 - } - } - }, - "com.amazonaws.lookoutmetrics#PutFeedbackRequest": { - "type": "structure", - "members": { - "AnomalyDetectorArn": { - "target": "com.amazonaws.lookoutmetrics#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the anomaly detector.

", - "smithy.api#required": {} - } - }, - "AnomalyGroupTimeSeriesFeedback": { - "target": "com.amazonaws.lookoutmetrics#AnomalyGroupTimeSeriesFeedback", - "traits": { - "smithy.api#documentation": "

Feedback for an anomalous metric.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lookoutmetrics#PutFeedbackResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.lookoutmetrics#QuotaCode": { - "type": "string" - }, - "com.amazonaws.lookoutmetrics#QuoteSymbol": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1 - }, - "smithy.api#pattern": "^[^\\r\\n]|^$" - } - }, - "com.amazonaws.lookoutmetrics#RDSDatabaseIdentifier": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 63 - }, - "smithy.api#pattern": "^[a-zA-Z](?!.*--)(?!.*-$)[0-9a-zA-Z\\-]*$" - } - }, - "com.amazonaws.lookoutmetrics#RDSDatabaseName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - }, - "smithy.api#pattern": "^[a-zA-Z0-9_.]+$" - } - }, - "com.amazonaws.lookoutmetrics#RDSSourceConfig": { - "type": "structure", - "members": { - "DBInstanceIdentifier": { - "target": "com.amazonaws.lookoutmetrics#RDSDatabaseIdentifier", - "traits": { - "smithy.api#documentation": "

A string identifying the database instance.

" - } - }, - "DatabaseHost": { - "target": "com.amazonaws.lookoutmetrics#DatabaseHost", - "traits": { - "smithy.api#documentation": "

The host name of the database.

" - } - }, - "DatabasePort": { - "target": "com.amazonaws.lookoutmetrics#DatabasePort", - "traits": { - "smithy.api#documentation": "

The port number where the database can be accessed.

" - } - }, - "SecretManagerArn": { - "target": "com.amazonaws.lookoutmetrics#PoirotSecretManagerArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS Secrets Manager role.

" - } - }, - "DatabaseName": { - "target": "com.amazonaws.lookoutmetrics#RDSDatabaseName", - "traits": { - "smithy.api#documentation": "

The name of the RDS database.

" - } - }, - "TableName": { - "target": "com.amazonaws.lookoutmetrics#TableName", - "traits": { - "smithy.api#documentation": "

The name of the table in the database.

" - } - }, - "RoleArn": { - "target": "com.amazonaws.lookoutmetrics#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the role.

" - } - }, - "VpcConfiguration": { - "target": "com.amazonaws.lookoutmetrics#VpcConfiguration", - "traits": { - "smithy.api#documentation": "

An object containing information about the Amazon Virtual Private Cloud (VPC) configuration.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains information about the Amazon Relational Database Service (RDS) configuration.

" - } - }, - "com.amazonaws.lookoutmetrics#RedshiftClusterIdentifier": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 63 - }, - "smithy.api#pattern": "^[a-z](?!.*--)(?!.*-$)[0-9a-z\\-]*$" - } - }, - "com.amazonaws.lookoutmetrics#RedshiftDatabaseName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 100 - }, - "smithy.api#pattern": "^[a-zA-Z0-9_.]+$" - } - }, - "com.amazonaws.lookoutmetrics#RedshiftSourceConfig": { - "type": "structure", - "members": { - "ClusterIdentifier": { - "target": "com.amazonaws.lookoutmetrics#RedshiftClusterIdentifier", - "traits": { - "smithy.api#documentation": "

A string identifying the Redshift cluster.

" - } - }, - "DatabaseHost": { - "target": "com.amazonaws.lookoutmetrics#DatabaseHost", - "traits": { - "smithy.api#documentation": "

The name of the database host.

" - } - }, - "DatabasePort": { - "target": "com.amazonaws.lookoutmetrics#DatabasePort", - "traits": { - "smithy.api#documentation": "

The port number where the database can be accessed.

" - } - }, - "SecretManagerArn": { - "target": "com.amazonaws.lookoutmetrics#PoirotSecretManagerArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS Secrets Manager role.

" - } - }, - "DatabaseName": { - "target": "com.amazonaws.lookoutmetrics#RedshiftDatabaseName", - "traits": { - "smithy.api#documentation": "

The Redshift database name.

" - } - }, - "TableName": { - "target": "com.amazonaws.lookoutmetrics#TableName", - "traits": { - "smithy.api#documentation": "

The table name of the Redshift database.

" - } - }, - "RoleArn": { - "target": "com.amazonaws.lookoutmetrics#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the role providing access to the database.

" - } - }, - "VpcConfiguration": { - "target": "com.amazonaws.lookoutmetrics#VpcConfiguration", - "traits": { - "smithy.api#documentation": "

Contains information about the Amazon Virtual Private Cloud (VPC) configuration.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Provides information about the Amazon Redshift database configuration.

" - } - }, - "com.amazonaws.lookoutmetrics#RelatedColumnName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - }, - "smithy.api#pattern": "\\S" - } - }, - "com.amazonaws.lookoutmetrics#RelationshipType": { - "type": "enum", - "members": { - "CAUSE_OF_INPUT_ANOMALY_GROUP": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CAUSE_OF_INPUT_ANOMALY_GROUP" - } - }, - "EFFECT_OF_INPUT_ANOMALY_GROUP": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EFFECT_OF_INPUT_ANOMALY_GROUP" - } - } - } - }, - "com.amazonaws.lookoutmetrics#ResourceId": { - "type": "string" - }, - "com.amazonaws.lookoutmetrics#ResourceNotFoundException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.lookoutmetrics#Message", - "traits": { - "smithy.api#required": {} - } - }, - "ResourceId": { - "target": "com.amazonaws.lookoutmetrics#ResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the resource.

" - } - }, - "ResourceType": { - "target": "com.amazonaws.lookoutmetrics#ResourceType", - "traits": { - "smithy.api#documentation": "

The type of the resource.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The specified resource cannot be found. Check the ARN of the resource and try again.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.lookoutmetrics#ResourceType": { - "type": "string" - }, - "com.amazonaws.lookoutmetrics#S3SourceConfig": { - "type": "structure", - "members": { - "RoleArn": { - "target": "com.amazonaws.lookoutmetrics#Arn", - "traits": { - "smithy.api#documentation": "

The ARN of an IAM role that has read and write access permissions to the source S3 bucket.

" - } - }, - "TemplatedPathList": { - "target": "com.amazonaws.lookoutmetrics#TemplatedPathList", - "traits": { - "smithy.api#documentation": "

A list of templated paths to the source files.

" - } - }, - "HistoricalDataPathList": { - "target": "com.amazonaws.lookoutmetrics#HistoricalDataPathList", - "traits": { - "smithy.api#documentation": "

A list of paths to the historical data files.

" - } - }, - "FileFormatDescriptor": { - "target": "com.amazonaws.lookoutmetrics#FileFormatDescriptor", - "traits": { - "smithy.api#documentation": "

Contains information about a source file's formatting.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains information about the configuration of the S3 bucket that contains source files.

" - } - }, - "com.amazonaws.lookoutmetrics#SNSConfiguration": { - "type": "structure", - "members": { - "RoleArn": { - "target": "com.amazonaws.lookoutmetrics#Arn", - "traits": { - "smithy.api#documentation": "

The ARN of the IAM role that has access to the target SNS topic.

", - "smithy.api#required": {} - } - }, - "SnsTopicArn": { - "target": "com.amazonaws.lookoutmetrics#Arn", - "traits": { - "smithy.api#documentation": "

The ARN of the target SNS topic.

", - "smithy.api#required": {} - } - }, - "SnsFormat": { - "target": "com.amazonaws.lookoutmetrics#SnsFormat", - "traits": { - "smithy.api#documentation": "

The format of the SNS topic.

\n " - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains information about the SNS topic to which you want to send your alerts and the IAM role that has\n access to that topic.

" - } - }, - "com.amazonaws.lookoutmetrics#SampleDataS3SourceConfig": { - "type": "structure", - "members": { - "RoleArn": { - "target": "com.amazonaws.lookoutmetrics#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the role.

", - "smithy.api#required": {} - } - }, - "TemplatedPathList": { - "target": "com.amazonaws.lookoutmetrics#TemplatedPathList", - "traits": { - "smithy.api#documentation": "

An array of strings containing the list of templated paths.

" - } - }, - "HistoricalDataPathList": { - "target": "com.amazonaws.lookoutmetrics#HistoricalDataPathList", - "traits": { - "smithy.api#documentation": "

An array of strings containing the historical set of data paths.

" - } - }, - "FileFormatDescriptor": { - "target": "com.amazonaws.lookoutmetrics#FileFormatDescriptor", - "traits": { - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains information about the source configuration in Amazon S3.

" - } - }, - "com.amazonaws.lookoutmetrics#SampleRow": { - "type": "list", - "member": { - "target": "com.amazonaws.lookoutmetrics#DataItem" - } - }, - "com.amazonaws.lookoutmetrics#SampleRows": { - "type": "list", - "member": { - "target": "com.amazonaws.lookoutmetrics#SampleRow" - } - }, - "com.amazonaws.lookoutmetrics#Score": { - "type": "double", - "traits": { - "smithy.api#range": { - "min": 0.0, - "max": 100.0 - } - } - }, - "com.amazonaws.lookoutmetrics#SecurityGroupId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 255 - }, - "smithy.api#pattern": "^[-0-9a-zA-Z]+$" - } - }, - "com.amazonaws.lookoutmetrics#SecurityGroupIdList": { - "type": "list", - "member": { - "target": "com.amazonaws.lookoutmetrics#SecurityGroupId" - } - }, - "com.amazonaws.lookoutmetrics#SensitivityThreshold": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.lookoutmetrics#ServiceCode": { - "type": "string" - }, - "com.amazonaws.lookoutmetrics#ServiceQuotaExceededException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.lookoutmetrics#Message", - "traits": { - "smithy.api#required": {} - } - }, - "ResourceId": { - "target": "com.amazonaws.lookoutmetrics#ResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the resource.

" - } - }, - "ResourceType": { - "target": "com.amazonaws.lookoutmetrics#ResourceType", - "traits": { - "smithy.api#documentation": "

The type of the resource.

" - } - }, - "QuotaCode": { - "target": "com.amazonaws.lookoutmetrics#QuotaCode", - "traits": { - "smithy.api#documentation": "

The quota code.

" - } - }, - "ServiceCode": { - "target": "com.amazonaws.lookoutmetrics#ServiceCode", - "traits": { - "smithy.api#documentation": "

The service code.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The request exceeded the service's quotas. Check the service quotas and try again.

", - "smithy.api#error": "client", - "smithy.api#httpError": 402 - } - }, - "com.amazonaws.lookoutmetrics#SnsFormat": { - "type": "enum", - "members": { - "LONG_TEXT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LONG_TEXT" - } - }, - "SHORT_TEXT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SHORT_TEXT" - } - }, - "JSON": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "JSON" - } - } - } - }, - "com.amazonaws.lookoutmetrics#StringAttributeValue": { - "type": "string" - }, - "com.amazonaws.lookoutmetrics#StringListAttributeValue": { - "type": "list", - "member": { - "target": "com.amazonaws.lookoutmetrics#StringAttributeValue" - } - }, - "com.amazonaws.lookoutmetrics#SubnetId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 255 - }, - "smithy.api#pattern": "^[\\-0-9a-zA-Z]+$" - } - }, - "com.amazonaws.lookoutmetrics#SubnetIdList": { - "type": "list", - "member": { - "target": "com.amazonaws.lookoutmetrics#SubnetId" - } - }, - "com.amazonaws.lookoutmetrics#TableName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 100 - }, - "smithy.api#pattern": "^[a-zA-Z][a-zA-Z0-9_.]*$" - } - }, - "com.amazonaws.lookoutmetrics#TagKey": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - } - } - }, - "com.amazonaws.lookoutmetrics#TagKeyList": { - "type": "list", - "member": { - "target": "com.amazonaws.lookoutmetrics#TagKey" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 50 - } - } - }, - "com.amazonaws.lookoutmetrics#TagMap": { - "type": "map", - "key": { - "target": "com.amazonaws.lookoutmetrics#TagKey" - }, - "value": { - "target": "com.amazonaws.lookoutmetrics#TagValue" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 50 - } - } - }, - "com.amazonaws.lookoutmetrics#TagResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.lookoutmetrics#TagResourceRequest" - }, - "output": { - "target": "com.amazonaws.lookoutmetrics#TagResourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.lookoutmetrics#InternalServerException" - }, - { - "target": "com.amazonaws.lookoutmetrics#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.lookoutmetrics#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Adds tags to a detector, dataset, or alert.

", - "smithy.api#http": { - "method": "POST", - "uri": "/tags/{ResourceArn}", - "code": 204 - } - } - }, - "com.amazonaws.lookoutmetrics#TagResourceRequest": { - "type": "structure", - "members": { - "ResourceArn": { - "target": "com.amazonaws.lookoutmetrics#Arn", - "traits": { - "smithy.api#documentation": "

The resource's Amazon Resource Name (ARN).

", - "smithy.api#httpLabel": {}, - "smithy.api#jsonName": "resourceArn", - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.lookoutmetrics#TagMap", - "traits": { - "smithy.api#documentation": "

Tags to apply to the resource. Tag keys and values can contain letters, numbers, spaces, and the following\n symbols: _.:/=+@-\n

", - "smithy.api#jsonName": "tags", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lookoutmetrics#TagResourceResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.lookoutmetrics#TagValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - } - } - }, - "com.amazonaws.lookoutmetrics#TemplatedPath": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1024 - }, - "smithy.api#pattern": "^s3://[a-zA-Z0-9_\\-\\/ {}=]+$" - } - }, - "com.amazonaws.lookoutmetrics#TemplatedPathList": { - "type": "list", - "member": { - "target": "com.amazonaws.lookoutmetrics#TemplatedPath" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1 - } - } - }, - "com.amazonaws.lookoutmetrics#TimeSeries": { - "type": "structure", - "members": { - "TimeSeriesId": { - "target": "com.amazonaws.lookoutmetrics#TimeSeriesId", - "traits": { - "smithy.api#documentation": "

The ID of the metric.

", - "smithy.api#required": {} - } - }, - "DimensionList": { - "target": "com.amazonaws.lookoutmetrics#DimensionNameValueList", - "traits": { - "smithy.api#documentation": "

The dimensions of the metric.

", - "smithy.api#required": {} - } - }, - "MetricValueList": { - "target": "com.amazonaws.lookoutmetrics#MetricValueList", - "traits": { - "smithy.api#documentation": "

The values for the metric.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Details about a metric. A metric is an aggregation of the values of a measure for a dimension value, such as\n availability in the us-east-1 Region.

" - } - }, - "com.amazonaws.lookoutmetrics#TimeSeriesFeedback": { - "type": "structure", - "members": { - "TimeSeriesId": { - "target": "com.amazonaws.lookoutmetrics#TimeSeriesId", - "traits": { - "smithy.api#documentation": "

The ID of the metric.

" - } - }, - "IsAnomaly": { - "target": "com.amazonaws.lookoutmetrics#Boolean", - "traits": { - "smithy.api#documentation": "

Feedback on whether the metric is a legitimate anomaly.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Details about feedback submitted for an anomalous metric.

" - } - }, - "com.amazonaws.lookoutmetrics#TimeSeriesFeedbackList": { - "type": "list", - "member": { - "target": "com.amazonaws.lookoutmetrics#TimeSeriesFeedback" - } - }, - "com.amazonaws.lookoutmetrics#TimeSeriesId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 520 - }, - "smithy.api#pattern": "\\S" - } - }, - "com.amazonaws.lookoutmetrics#TimeSeriesList": { - "type": "list", - "member": { - "target": "com.amazonaws.lookoutmetrics#TimeSeries" - } - }, - "com.amazonaws.lookoutmetrics#Timestamp": { - "type": "timestamp" - }, - "com.amazonaws.lookoutmetrics#TimestampColumn": { - "type": "structure", - "members": { - "ColumnName": { - "target": "com.amazonaws.lookoutmetrics#ColumnName", - "traits": { - "smithy.api#documentation": "

The name of the timestamp column.

" - } - }, - "ColumnFormat": { - "target": "com.amazonaws.lookoutmetrics#DateTimeFormat", - "traits": { - "smithy.api#documentation": "

The format of the timestamp column.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains information about the column used to track time in a source data file.

" - } - }, - "com.amazonaws.lookoutmetrics#TimestampList": { - "type": "list", - "member": { - "target": "com.amazonaws.lookoutmetrics#TimestampString" - } - }, - "com.amazonaws.lookoutmetrics#TimestampString": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 60 - }, - "smithy.api#pattern": "^([12]\\d{3})-(1[0-2]|0[1-9])-(0[1-9]|[12]\\d|3[01])T([01]\\d|2[0-3]):([0-5]\\d):([0-5]\\d)(Z|(\\+|\\-)(0\\d|1[0-2]):([0-5]\\d)(\\[[[:alnum:]\\/\\_]+\\])?)$" - } - }, - "com.amazonaws.lookoutmetrics#Timezone": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 60 - }, - "smithy.api#pattern": "\\S" - } - }, - "com.amazonaws.lookoutmetrics#TooManyRequestsException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.lookoutmetrics#Message", - "traits": { - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The request was denied due to too many requests being submitted at the same time.

", - "smithy.api#error": "client", - "smithy.api#httpError": 429 - } - }, - "com.amazonaws.lookoutmetrics#UUID": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 63 - }, - "smithy.api#pattern": "^[a-z0-9]{8}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{12}$" - } - }, - "com.amazonaws.lookoutmetrics#UntagResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.lookoutmetrics#UntagResourceRequest" - }, - "output": { - "target": "com.amazonaws.lookoutmetrics#UntagResourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.lookoutmetrics#InternalServerException" - }, - { - "target": "com.amazonaws.lookoutmetrics#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.lookoutmetrics#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Removes tags from a detector, dataset, or alert.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/tags/{ResourceArn}", - "code": 204 - } - } - }, - "com.amazonaws.lookoutmetrics#UntagResourceRequest": { - "type": "structure", - "members": { - "ResourceArn": { - "target": "com.amazonaws.lookoutmetrics#Arn", - "traits": { - "smithy.api#documentation": "

The resource's Amazon Resource Name (ARN).

", - "smithy.api#httpLabel": {}, - "smithy.api#jsonName": "resourceArn", - "smithy.api#required": {} - } - }, - "TagKeys": { - "target": "com.amazonaws.lookoutmetrics#TagKeyList", - "traits": { - "smithy.api#documentation": "

Keys to remove from the resource's tags.

", - "smithy.api#httpQuery": "tagKeys", - "smithy.api#jsonName": "tagKeys", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lookoutmetrics#UntagResourceResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.lookoutmetrics#UpdateAlert": { - "type": "operation", - "input": { - "target": "com.amazonaws.lookoutmetrics#UpdateAlertRequest" - }, - "output": { - "target": "com.amazonaws.lookoutmetrics#UpdateAlertResponse" - }, - "errors": [ - { - "target": "com.amazonaws.lookoutmetrics#AccessDeniedException" - }, - { - "target": "com.amazonaws.lookoutmetrics#InternalServerException" - }, - { - "target": "com.amazonaws.lookoutmetrics#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.lookoutmetrics#TooManyRequestsException" - }, - { - "target": "com.amazonaws.lookoutmetrics#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Make changes to an existing alert.

", - "smithy.api#http": { - "method": "POST", - "uri": "/UpdateAlert", - "code": 200 - } - } - }, - "com.amazonaws.lookoutmetrics#UpdateAlertRequest": { - "type": "structure", - "members": { - "AlertArn": { - "target": "com.amazonaws.lookoutmetrics#Arn", - "traits": { - "smithy.api#documentation": "

The ARN of the alert to update.

", - "smithy.api#required": {} - } - }, - "AlertDescription": { - "target": "com.amazonaws.lookoutmetrics#AlertDescription", - "traits": { - "smithy.api#documentation": "

A description of the alert.

" - } - }, - "AlertSensitivityThreshold": { - "target": "com.amazonaws.lookoutmetrics#SensitivityThreshold", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

An integer from 0 to 100 specifying the alert sensitivity threshold.

" - } - }, - "Action": { - "target": "com.amazonaws.lookoutmetrics#Action", - "traits": { - "smithy.api#documentation": "

Action that will be triggered when there is an alert.

" - } - }, - "AlertFilters": { - "target": "com.amazonaws.lookoutmetrics#AlertFilters", - "traits": { - "smithy.api#documentation": "

The configuration of the alert filters, containing MetricList and DimensionFilterList.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lookoutmetrics#UpdateAlertResponse": { - "type": "structure", - "members": { - "AlertArn": { - "target": "com.amazonaws.lookoutmetrics#Arn", - "traits": { - "smithy.api#documentation": "

The ARN of the updated alert.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.lookoutmetrics#UpdateAnomalyDetector": { - "type": "operation", - "input": { - "target": "com.amazonaws.lookoutmetrics#UpdateAnomalyDetectorRequest" - }, - "output": { - "target": "com.amazonaws.lookoutmetrics#UpdateAnomalyDetectorResponse" - }, - "errors": [ - { - "target": "com.amazonaws.lookoutmetrics#AccessDeniedException" - }, - { - "target": "com.amazonaws.lookoutmetrics#InternalServerException" - }, - { - "target": "com.amazonaws.lookoutmetrics#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.lookoutmetrics#TooManyRequestsException" - }, - { - "target": "com.amazonaws.lookoutmetrics#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates a detector. After activation, you can only change a detector's ingestion delay and description.

", - "smithy.api#http": { - "method": "POST", - "uri": "/UpdateAnomalyDetector", - "code": 200 - } - } - }, - "com.amazonaws.lookoutmetrics#UpdateAnomalyDetectorRequest": { - "type": "structure", - "members": { - "AnomalyDetectorArn": { - "target": "com.amazonaws.lookoutmetrics#Arn", - "traits": { - "smithy.api#documentation": "

The ARN of the detector to update.

", - "smithy.api#required": {} - } - }, - "KmsKeyArn": { - "target": "com.amazonaws.lookoutmetrics#KmsKeyArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an AWS KMS encryption key.

" - } - }, - "AnomalyDetectorDescription": { - "target": "com.amazonaws.lookoutmetrics#AnomalyDetectorDescription", - "traits": { - "smithy.api#documentation": "

The updated detector description.

" - } - }, - "AnomalyDetectorConfig": { - "target": "com.amazonaws.lookoutmetrics#AnomalyDetectorConfig", - "traits": { - "smithy.api#documentation": "

Contains information about the configuration to which the detector will be updated.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lookoutmetrics#UpdateAnomalyDetectorResponse": { - "type": "structure", - "members": { - "AnomalyDetectorArn": { - "target": "com.amazonaws.lookoutmetrics#Arn", - "traits": { - "smithy.api#documentation": "

The ARN of the updated detector.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.lookoutmetrics#UpdateMetricSet": { - "type": "operation", - "input": { - "target": "com.amazonaws.lookoutmetrics#UpdateMetricSetRequest" - }, - "output": { - "target": "com.amazonaws.lookoutmetrics#UpdateMetricSetResponse" - }, - "errors": [ - { - "target": "com.amazonaws.lookoutmetrics#AccessDeniedException" - }, - { - "target": "com.amazonaws.lookoutmetrics#InternalServerException" - }, - { - "target": "com.amazonaws.lookoutmetrics#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.lookoutmetrics#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.lookoutmetrics#TooManyRequestsException" - }, - { - "target": "com.amazonaws.lookoutmetrics#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates a dataset.

", - "smithy.api#http": { - "method": "POST", - "uri": "/UpdateMetricSet", - "code": 200 - } - } - }, - "com.amazonaws.lookoutmetrics#UpdateMetricSetRequest": { - "type": "structure", - "members": { - "MetricSetArn": { - "target": "com.amazonaws.lookoutmetrics#Arn", - "traits": { - "smithy.api#documentation": "

The ARN of the dataset to update.

", - "smithy.api#required": {} - } - }, - "MetricSetDescription": { - "target": "com.amazonaws.lookoutmetrics#MetricSetDescription", - "traits": { - "smithy.api#documentation": "

The dataset's description.

" - } - }, - "MetricList": { - "target": "com.amazonaws.lookoutmetrics#MetricList", - "traits": { - "smithy.api#documentation": "

The metric list.

" - } - }, - "Offset": { - "target": "com.amazonaws.lookoutmetrics#Offset", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

After an interval ends, the amount of seconds that the detector waits before importing data. Offset is only supported for S3, Redshift, Athena and datasources.

" - } - }, - "TimestampColumn": { - "target": "com.amazonaws.lookoutmetrics#TimestampColumn", - "traits": { - "smithy.api#documentation": "

The timestamp column.

" - } - }, - "DimensionList": { - "target": "com.amazonaws.lookoutmetrics#DimensionList", - "traits": { - "smithy.api#documentation": "

The dimension list.

" - } - }, - "MetricSetFrequency": { - "target": "com.amazonaws.lookoutmetrics#Frequency", - "traits": { - "smithy.api#documentation": "

The dataset's interval.

" - } - }, - "MetricSource": { - "target": "com.amazonaws.lookoutmetrics#MetricSource" - }, - "DimensionFilterList": { - "target": "com.amazonaws.lookoutmetrics#MetricSetDimensionFilterList", - "traits": { - "smithy.api#documentation": "

Describes a list of filters for choosing specific dimensions and specific values. Each\n filter consists of the dimension and one of its values that you want to include. When\n multiple dimensions or values are specified, the dimensions are joined with an AND operation\n and the values are joined with an OR operation.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lookoutmetrics#UpdateMetricSetResponse": { - "type": "structure", - "members": { - "MetricSetArn": { - "target": "com.amazonaws.lookoutmetrics#Arn", - "traits": { - "smithy.api#documentation": "

The ARN of the dataset.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.lookoutmetrics#ValidationException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.lookoutmetrics#Message", - "traits": { - "smithy.api#required": {} - } - }, - "Reason": { - "target": "com.amazonaws.lookoutmetrics#ValidationExceptionReason", - "traits": { - "smithy.api#documentation": "

The reason that validation failed.

" - } - }, - "Fields": { - "target": "com.amazonaws.lookoutmetrics#ValidationExceptionFieldList", - "traits": { - "smithy.api#documentation": "

Fields that failed validation.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The input fails to satisfy the constraints specified by the AWS service. Check your input values and try\n again.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.lookoutmetrics#ValidationExceptionField": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.lookoutmetrics#FieldName", - "traits": { - "smithy.api#documentation": "

The name of the field.

", - "smithy.api#required": {} - } - }, - "Message": { - "target": "com.amazonaws.lookoutmetrics#Message", - "traits": { - "smithy.api#documentation": "

The message with more information about the validation exception.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains information about a a field in a validation exception.

" - } - }, - "com.amazonaws.lookoutmetrics#ValidationExceptionFieldList": { - "type": "list", - "member": { - "target": "com.amazonaws.lookoutmetrics#ValidationExceptionField" - } - }, - "com.amazonaws.lookoutmetrics#ValidationExceptionReason": { - "type": "enum", - "members": { - "UNKNOWN_OPERATION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UNKNOWN_OPERATION" - } - }, - "CANNOT_PARSE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CANNOT_PARSE" - } - }, - "FIELD_VALIDATION_FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FIELD_VALIDATION_FAILED" - } - }, - "OTHER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "OTHER" - } - } - } - }, - "com.amazonaws.lookoutmetrics#VpcConfiguration": { - "type": "structure", - "members": { - "SubnetIdList": { - "target": "com.amazonaws.lookoutmetrics#SubnetIdList", - "traits": { - "smithy.api#documentation": "

An array of strings containing the Amazon VPC subnet IDs (e.g., subnet-0bb1c79de3EXAMPLE.

", - "smithy.api#required": {} - } - }, - "SecurityGroupIdList": { - "target": "com.amazonaws.lookoutmetrics#SecurityGroupIdList", - "traits": { - "smithy.api#documentation": "

An array of strings containing the list of security groups.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains configuration information about the Amazon Virtual Private Cloud (VPC).

" - } - } - } -} \ No newline at end of file diff --git a/models/lookoutvision/service/2020-11-20/lookoutvision-2020-11-20.json b/models/lookoutvision/service/2020-11-20/lookoutvision-2020-11-20.json deleted file mode 100644 index 9c27f416..00000000 --- a/models/lookoutvision/service/2020-11-20/lookoutvision-2020-11-20.json +++ /dev/null @@ -1,4428 +0,0 @@ -{ - "smithy": "2.0", - "metadata": { - "suppressions": [ - { - "id": "HttpMethodSemantics", - "namespace": "*" - }, - { - "id": "HttpResponseCodeSemantics", - "namespace": "*" - }, - { - "id": "PaginatedTrait", - "namespace": "*" - }, - { - "id": "HttpHeaderTrait", - "namespace": "*" - }, - { - "id": "HttpUriConflict", - "namespace": "*" - }, - { - "id": "Service", - "namespace": "*" - } - ] - }, - "shapes": { - "com.amazonaws.lookoutvision#AccessDeniedException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.lookoutvision#ExceptionString", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

You are not authorized to perform the action.

", - "smithy.api#error": "client", - "smithy.api#httpError": 403 - } - }, - "com.amazonaws.lookoutvision#Anomaly": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.lookoutvision#AnomalyName", - "traits": { - "smithy.api#documentation": "

The name of an anomaly type found in an image. \n Name maps to an anomaly type in the training dataset, apart from the anomaly type background.\n The service automatically inserts the background anomaly type into the response from DetectAnomalies.

" - } - }, - "PixelAnomaly": { - "target": "com.amazonaws.lookoutvision#PixelAnomaly", - "traits": { - "smithy.api#documentation": "

Information about the pixel mask that covers an anomaly type.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about an anomaly type found on an image by an image segmentation model. \n For more information, see DetectAnomalies.

" - } - }, - "com.amazonaws.lookoutvision#AnomalyClassFilter": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 10 - }, - "smithy.api#pattern": "^(normal|anomaly)$" - } - }, - "com.amazonaws.lookoutvision#AnomalyList": { - "type": "list", - "member": { - "target": "com.amazonaws.lookoutvision#Anomaly" - } - }, - "com.amazonaws.lookoutvision#AnomalyMask": { - "type": "blob", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 5242880 - } - } - }, - "com.amazonaws.lookoutvision#AnomalyName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - }, - "smithy.api#pattern": "^[a-zA-Z0-9]*$" - } - }, - "com.amazonaws.lookoutvision#Boolean": { - "type": "boolean" - }, - "com.amazonaws.lookoutvision#ClientToken": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - }, - "smithy.api#pattern": "^[a-zA-Z0-9-]+$" - } - }, - "com.amazonaws.lookoutvision#Color": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 7, - "max": 7 - }, - "smithy.api#pattern": "^\\#[a-zA-Z0-9]{6}$" - } - }, - "com.amazonaws.lookoutvision#CompilerOptions": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 3, - "max": 1024 - }, - "smithy.api#pattern": ".*" - } - }, - "com.amazonaws.lookoutvision#ComponentDescription": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - }, - "smithy.api#pattern": "^[a-zA-Z0-9-_. ()':,;?]+$" - } - }, - "com.amazonaws.lookoutvision#ComponentName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - }, - "smithy.api#pattern": "^[a-zA-Z0-9-_.]+$" - } - }, - "com.amazonaws.lookoutvision#ComponentVersion": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - }, - "smithy.api#pattern": "^([0-9]{1,6})\\.([0-9]{1,6})\\.([0-9]{1,6})$" - } - }, - "com.amazonaws.lookoutvision#ComponentVersionArn": { - "type": "string", - "traits": { - "smithy.api#pattern": "^arn:[^:]*:greengrass:[^:]*:aws:components:[^:]+$" - } - }, - "com.amazonaws.lookoutvision#ConflictException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.lookoutvision#ExceptionString", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#required": {} - } - }, - "ResourceId": { - "target": "com.amazonaws.lookoutvision#ExceptionString", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the resource.

", - "smithy.api#required": {} - } - }, - "ResourceType": { - "target": "com.amazonaws.lookoutvision#ResourceType", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The type of the resource.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The update or deletion of a resource caused an inconsistent state.

", - "smithy.api#error": "client", - "smithy.api#httpError": 409 - } - }, - "com.amazonaws.lookoutvision#ContentType": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 255 - }, - "smithy.api#pattern": ".*" - } - }, - "com.amazonaws.lookoutvision#CreateDataset": { - "type": "operation", - "input": { - "target": "com.amazonaws.lookoutvision#CreateDatasetRequest" - }, - "output": { - "target": "com.amazonaws.lookoutvision#CreateDatasetResponse" - }, - "errors": [ - { - "target": "com.amazonaws.lookoutvision#AccessDeniedException" - }, - { - "target": "com.amazonaws.lookoutvision#ConflictException" - }, - { - "target": "com.amazonaws.lookoutvision#InternalServerException" - }, - { - "target": "com.amazonaws.lookoutvision#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.lookoutvision#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.lookoutvision#ThrottlingException" - }, - { - "target": "com.amazonaws.lookoutvision#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a new dataset in an Amazon Lookout for Vision project. CreateDataset can create a \n training or a test dataset from a valid dataset source (DatasetSource).

\n

If you want a single dataset project, specify train for the value of \n DatasetType.

\n

To have a project with separate training and test datasets, call CreateDataset twice.\n On the first call, specify train for the value of \n DatasetType. On the second call, specify test for the value of \n DatasetType.

\n

This operation requires permissions to perform the\n lookoutvision:CreateDataset operation.

", - "smithy.api#http": { - "method": "POST", - "uri": "/2020-11-20/projects/{ProjectName}/datasets", - "code": 202 - } - } - }, - "com.amazonaws.lookoutvision#CreateDatasetRequest": { - "type": "structure", - "members": { - "ProjectName": { - "target": "com.amazonaws.lookoutvision#ProjectName", - "traits": { - "smithy.api#documentation": "

The name of the project in which you want to create a dataset.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "DatasetType": { - "target": "com.amazonaws.lookoutvision#DatasetType", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The type of the dataset. Specify train for a training dataset.\n Specify test for a test dataset.

", - "smithy.api#required": {} - } - }, - "DatasetSource": { - "target": "com.amazonaws.lookoutvision#DatasetSource", - "traits": { - "smithy.api#documentation": "

The location of the manifest file that Amazon Lookout for Vision uses to create the dataset.

\n

If you don't specify DatasetSource, an empty dataset is created and the operation \n synchronously returns. Later, you can add JSON Lines by calling UpdateDatasetEntries.\n

\n

If you specify a value for DataSource, the manifest at the S3 location\n is validated and used to create the dataset. The call to CreateDataset is asynchronous\n and might take a while to complete. To find out the current status, Check the value of Status\n returned in a call to DescribeDataset.

" - } - }, - "ClientToken": { - "target": "com.amazonaws.lookoutvision#ClientToken", - "traits": { - "smithy.api#documentation": "

ClientToken is an idempotency token that ensures a call to CreateDataset\n completes only once. You choose the value to pass. For example, An issue might prevent you\n from getting a response from CreateDataset.\n In this case, safely retry your call\n to CreateDataset by using the same ClientToken parameter value.

\n

If you don't supply a value for ClientToken, the AWS SDK you are using inserts a value for you. \n This prevents retries after a network error from making multiple dataset creation requests. You'll need to\n provide your own value for other use cases.

\n

An error occurs if the other input parameters are not the same as in the first request. Using a different \n value for ClientToken is considered a new call to CreateDataset. An idempotency\n token is active for 8 hours.\n

", - "smithy.api#httpHeader": "X-Amzn-Client-Token", - "smithy.api#idempotencyToken": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lookoutvision#CreateDatasetResponse": { - "type": "structure", - "members": { - "DatasetMetadata": { - "target": "com.amazonaws.lookoutvision#DatasetMetadata", - "traits": { - "smithy.api#documentation": "

Information about the dataset.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.lookoutvision#CreateModel": { - "type": "operation", - "input": { - "target": "com.amazonaws.lookoutvision#CreateModelRequest" - }, - "output": { - "target": "com.amazonaws.lookoutvision#CreateModelResponse" - }, - "errors": [ - { - "target": "com.amazonaws.lookoutvision#AccessDeniedException" - }, - { - "target": "com.amazonaws.lookoutvision#ConflictException" - }, - { - "target": "com.amazonaws.lookoutvision#InternalServerException" - }, - { - "target": "com.amazonaws.lookoutvision#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.lookoutvision#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.lookoutvision#ThrottlingException" - }, - { - "target": "com.amazonaws.lookoutvision#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a new version of a model within an an Amazon Lookout for Vision project. \n CreateModel is an asynchronous operation in which Amazon Lookout for Vision trains, tests,\n and evaluates a new version of a model.

\n

To get the current status, check the Status field returned\n in the response from DescribeModel.

\n

If the project has a single dataset, Amazon Lookout for Vision internally splits the dataset\n to create a training and a test dataset. \n If the project has a training and a test dataset, Lookout for Vision uses the respective datasets to train and test \n the model.

\n

After training completes, the evaluation metrics are stored at the location specified in\n OutputConfig.

\n

This operation requires permissions to perform the\n lookoutvision:CreateModel operation. If you want to tag your model, you also require\n permission to the lookoutvision:TagResource operation.

", - "smithy.api#http": { - "method": "POST", - "uri": "/2020-11-20/projects/{ProjectName}/models", - "code": 202 - } - } - }, - "com.amazonaws.lookoutvision#CreateModelRequest": { - "type": "structure", - "members": { - "ProjectName": { - "target": "com.amazonaws.lookoutvision#ProjectName", - "traits": { - "smithy.api#documentation": "

The name of the project in which you want to create a model version.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Description": { - "target": "com.amazonaws.lookoutvision#ModelDescriptionMessage", - "traits": { - "smithy.api#documentation": "

A description for the version of the model.

" - } - }, - "ClientToken": { - "target": "com.amazonaws.lookoutvision#ClientToken", - "traits": { - "smithy.api#documentation": "

ClientToken is an idempotency token that ensures a call to CreateModel\n completes only once. You choose the value to pass. For example, An issue\n might prevent you from getting a response from CreateModel.\n In this case, safely retry your call\n to CreateModel by using the same ClientToken parameter value.

\n

If you don't supply a value for ClientToken, the AWS SDK you are using inserts a value for you. \n This prevents retries after a network error from starting multiple training jobs. You'll need to\n provide your own value for other use cases.

\n

An error occurs if the other input parameters are not the same as in the first request. Using a different \n value for ClientToken is considered a new call to CreateModel. An idempotency\n token is active for 8 hours.

", - "smithy.api#httpHeader": "X-Amzn-Client-Token", - "smithy.api#idempotencyToken": {} - } - }, - "OutputConfig": { - "target": "com.amazonaws.lookoutvision#OutputConfig", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The location where Amazon Lookout for Vision saves the training results.

", - "smithy.api#required": {} - } - }, - "KmsKeyId": { - "target": "com.amazonaws.lookoutvision#KmsKeyId", - "traits": { - "smithy.api#documentation": "

The identifier for your AWS KMS key.\n The key is used to encrypt training and test images copied into the service for model training. Your \n source images are unaffected.\n If this parameter is not specified, the copied images are encrypted by a key that AWS owns and manages.

" - } - }, - "Tags": { - "target": "com.amazonaws.lookoutvision#TagList", - "traits": { - "smithy.api#documentation": "

A set of tags (key-value pairs) that you want to attach to the model.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lookoutvision#CreateModelResponse": { - "type": "structure", - "members": { - "ModelMetadata": { - "target": "com.amazonaws.lookoutvision#ModelMetadata", - "traits": { - "smithy.api#documentation": "

The response from a call to CreateModel.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.lookoutvision#CreateProject": { - "type": "operation", - "input": { - "target": "com.amazonaws.lookoutvision#CreateProjectRequest" - }, - "output": { - "target": "com.amazonaws.lookoutvision#CreateProjectResponse" - }, - "errors": [ - { - "target": "com.amazonaws.lookoutvision#AccessDeniedException" - }, - { - "target": "com.amazonaws.lookoutvision#ConflictException" - }, - { - "target": "com.amazonaws.lookoutvision#InternalServerException" - }, - { - "target": "com.amazonaws.lookoutvision#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.lookoutvision#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.lookoutvision#ThrottlingException" - }, - { - "target": "com.amazonaws.lookoutvision#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates an empty Amazon Lookout for Vision project. After you create the project, add a dataset by calling\n CreateDataset.

\n

This operation requires permissions to perform the\n lookoutvision:CreateProject operation.

", - "smithy.api#http": { - "method": "POST", - "uri": "/2020-11-20/projects", - "code": 200 - } - } - }, - "com.amazonaws.lookoutvision#CreateProjectRequest": { - "type": "structure", - "members": { - "ProjectName": { - "target": "com.amazonaws.lookoutvision#ProjectName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The name for the project.

", - "smithy.api#required": {} - } - }, - "ClientToken": { - "target": "com.amazonaws.lookoutvision#ClientToken", - "traits": { - "smithy.api#documentation": "

ClientToken is an idempotency token that ensures a call to CreateProject\n completes only once. You choose the value to pass. For example, An issue might prevent you from \n getting a response from CreateProject.\n In this case, safely retry your call\n to CreateProject by using the same ClientToken parameter value.

\n

If you don't supply a value for ClientToken, the AWS SDK you are using inserts a value for you. \n This prevents retries after a network error from making multiple project creation requests. You'll need to\n provide your own value for other use cases.

\n

An error occurs\n if the other input parameters are not the same as in the first request. Using a different \n value for ClientToken is considered a new call to CreateProject. An idempotency\n token is active for 8 hours.

", - "smithy.api#httpHeader": "X-Amzn-Client-Token", - "smithy.api#idempotencyToken": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lookoutvision#CreateProjectResponse": { - "type": "structure", - "members": { - "ProjectMetadata": { - "target": "com.amazonaws.lookoutvision#ProjectMetadata", - "traits": { - "smithy.api#documentation": "

Information about the project.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.lookoutvision#DatasetChanges": { - "type": "blob", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 10485760 - } - } - }, - "com.amazonaws.lookoutvision#DatasetDescription": { - "type": "structure", - "members": { - "ProjectName": { - "target": "com.amazonaws.lookoutvision#ProjectName", - "traits": { - "smithy.api#documentation": "

The name of the project that contains the dataset.

" - } - }, - "DatasetType": { - "target": "com.amazonaws.lookoutvision#DatasetType", - "traits": { - "smithy.api#documentation": "

The type of the dataset. The value train represents a training dataset or single dataset project.\n The value test represents a test dataset.

" - } - }, - "CreationTimestamp": { - "target": "com.amazonaws.lookoutvision#DateTime", - "traits": { - "smithy.api#documentation": "

The Unix timestamp for the time and date that the dataset was created.

" - } - }, - "LastUpdatedTimestamp": { - "target": "com.amazonaws.lookoutvision#DateTime", - "traits": { - "smithy.api#documentation": "

The Unix timestamp for the date and time that the dataset was last updated.

" - } - }, - "Status": { - "target": "com.amazonaws.lookoutvision#DatasetStatus", - "traits": { - "smithy.api#documentation": "

The status of the dataset.

" - } - }, - "StatusMessage": { - "target": "com.amazonaws.lookoutvision#DatasetStatusMessage", - "traits": { - "smithy.api#documentation": "

The status message for the dataset.

" - } - }, - "ImageStats": { - "target": "com.amazonaws.lookoutvision#DatasetImageStats", - "traits": { - "smithy.api#documentation": "

Statistics about the images in a dataset.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The description for a dataset. For more information, see DescribeDataset.

" - } - }, - "com.amazonaws.lookoutvision#DatasetEntry": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 2, - "max": 8192 - }, - "smithy.api#pattern": "^\\{.*\\}$" - } - }, - "com.amazonaws.lookoutvision#DatasetEntryList": { - "type": "list", - "member": { - "target": "com.amazonaws.lookoutvision#DatasetEntry" - } - }, - "com.amazonaws.lookoutvision#DatasetGroundTruthManifest": { - "type": "structure", - "members": { - "S3Object": { - "target": "com.amazonaws.lookoutvision#InputS3Object", - "traits": { - "smithy.api#documentation": "

The S3 bucket location for the manifest file.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Location information about a manifest file. You can use a manifest file to\n create a dataset.

" - } - }, - "com.amazonaws.lookoutvision#DatasetImageStats": { - "type": "structure", - "members": { - "Total": { - "target": "com.amazonaws.lookoutvision#Integer", - "traits": { - "smithy.api#documentation": "

The total number of images in the dataset.

" - } - }, - "Labeled": { - "target": "com.amazonaws.lookoutvision#Integer", - "traits": { - "smithy.api#documentation": "

The total number of labeled images.

" - } - }, - "Normal": { - "target": "com.amazonaws.lookoutvision#Integer", - "traits": { - "smithy.api#documentation": "

The total number of images labeled as normal.

" - } - }, - "Anomaly": { - "target": "com.amazonaws.lookoutvision#Integer", - "traits": { - "smithy.api#documentation": "

the total number of images labeled as an anomaly.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Statistics about the images in a dataset.

" - } - }, - "com.amazonaws.lookoutvision#DatasetMetadata": { - "type": "structure", - "members": { - "DatasetType": { - "target": "com.amazonaws.lookoutvision#DatasetType", - "traits": { - "smithy.api#documentation": "

The type of the dataset.

" - } - }, - "CreationTimestamp": { - "target": "com.amazonaws.lookoutvision#DateTime", - "traits": { - "smithy.api#documentation": "

The Unix timestamp for the date and time that the dataset was created.

" - } - }, - "Status": { - "target": "com.amazonaws.lookoutvision#DatasetStatus", - "traits": { - "smithy.api#documentation": "

The status for the dataset.

" - } - }, - "StatusMessage": { - "target": "com.amazonaws.lookoutvision#DatasetStatusMessage", - "traits": { - "smithy.api#documentation": "

The status message for the dataset.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Summary information for an Amazon Lookout for Vision dataset. For more information,\n see DescribeDataset and ProjectDescription.

" - } - }, - "com.amazonaws.lookoutvision#DatasetMetadataList": { - "type": "list", - "member": { - "target": "com.amazonaws.lookoutvision#DatasetMetadata" - } - }, - "com.amazonaws.lookoutvision#DatasetSource": { - "type": "structure", - "members": { - "GroundTruthManifest": { - "target": "com.amazonaws.lookoutvision#DatasetGroundTruthManifest", - "traits": { - "smithy.api#documentation": "

Location information for the manifest file.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about the location of a manifest file that Amazon Lookout for Vision uses to to create a dataset.

" - } - }, - "com.amazonaws.lookoutvision#DatasetStatus": { - "type": "enum", - "members": { - "CREATE_IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CREATE_IN_PROGRESS" - } - }, - "CREATE_COMPLETE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CREATE_COMPLETE" - } - }, - "CREATE_FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CREATE_FAILED" - } - }, - "UPDATE_IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UPDATE_IN_PROGRESS" - } - }, - "UPDATE_COMPLETE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UPDATE_COMPLETE" - } - }, - "UPDATE_FAILED_ROLLBACK_IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UPDATE_FAILED_ROLLBACK_IN_PROGRESS" - } - }, - "UPDATE_FAILED_ROLLBACK_COMPLETE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UPDATE_FAILED_ROLLBACK_COMPLETE" - } - }, - "DELETE_IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETE_IN_PROGRESS" - } - }, - "DELETE_COMPLETE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETE_COMPLETE" - } - }, - "DELETE_FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETE_FAILED" - } - } - } - }, - "com.amazonaws.lookoutvision#DatasetStatusMessage": { - "type": "string" - }, - "com.amazonaws.lookoutvision#DatasetType": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 10 - }, - "smithy.api#pattern": "^train|test$" - } - }, - "com.amazonaws.lookoutvision#DateTime": { - "type": "timestamp" - }, - "com.amazonaws.lookoutvision#DeleteDataset": { - "type": "operation", - "input": { - "target": "com.amazonaws.lookoutvision#DeleteDatasetRequest" - }, - "output": { - "target": "com.amazonaws.lookoutvision#DeleteDatasetResponse" - }, - "errors": [ - { - "target": "com.amazonaws.lookoutvision#AccessDeniedException" - }, - { - "target": "com.amazonaws.lookoutvision#ConflictException" - }, - { - "target": "com.amazonaws.lookoutvision#InternalServerException" - }, - { - "target": "com.amazonaws.lookoutvision#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.lookoutvision#ThrottlingException" - }, - { - "target": "com.amazonaws.lookoutvision#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes an existing Amazon Lookout for Vision dataset.

\n

If your the project has a single\n dataset, you must create a new dataset before you can create a model.

\n

If you project has a training dataset and a test dataset consider the following.

\n \n

This operation requires permissions to perform the\n lookoutvision:DeleteDataset operation.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/2020-11-20/projects/{ProjectName}/datasets/{DatasetType}", - "code": 202 - } - } - }, - "com.amazonaws.lookoutvision#DeleteDatasetRequest": { - "type": "structure", - "members": { - "ProjectName": { - "target": "com.amazonaws.lookoutvision#ProjectName", - "traits": { - "smithy.api#documentation": "

The name of the project that contains the dataset that you want to delete.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "DatasetType": { - "target": "com.amazonaws.lookoutvision#DatasetType", - "traits": { - "smithy.api#documentation": "

The type of the dataset to delete. Specify train to delete the training dataset.\n Specify test to delete the test dataset. To delete the dataset in a single dataset project, \n specify train.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ClientToken": { - "target": "com.amazonaws.lookoutvision#ClientToken", - "traits": { - "smithy.api#documentation": "

ClientToken is an idempotency token that ensures a call to DeleteDataset\n completes only once. You choose the value to pass. For example, An issue might prevent you from getting a response from DeleteDataset.\n In this case, safely retry your call\n to DeleteDataset by using the same ClientToken parameter value.

\n

If you don't supply a value for ClientToken, the AWS SDK you are using inserts a value for you. \n This prevents retries after a network error from making multiple deletetion requests. You'll need to\n provide your own value for other use cases.

\n

An error occurs if the other input parameters are not the same as in the first request. Using a different \n value for ClientToken is considered a new call to DeleteDataset. An idempotency\n token is active for 8 hours.

", - "smithy.api#httpHeader": "X-Amzn-Client-Token", - "smithy.api#idempotencyToken": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lookoutvision#DeleteDatasetResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.lookoutvision#DeleteModel": { - "type": "operation", - "input": { - "target": "com.amazonaws.lookoutvision#DeleteModelRequest" - }, - "output": { - "target": "com.amazonaws.lookoutvision#DeleteModelResponse" - }, - "errors": [ - { - "target": "com.amazonaws.lookoutvision#AccessDeniedException" - }, - { - "target": "com.amazonaws.lookoutvision#ConflictException" - }, - { - "target": "com.amazonaws.lookoutvision#InternalServerException" - }, - { - "target": "com.amazonaws.lookoutvision#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.lookoutvision#ThrottlingException" - }, - { - "target": "com.amazonaws.lookoutvision#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes an Amazon Lookout for Vision model. You can't delete a running model. To stop a running model,\n use the StopModel operation.

\n

It might take a few seconds to delete a model. To determine if a model has been deleted, call\n ListModels and check if the version of the model (ModelVersion) is in the\n Models array.

\n

\n

This operation requires permissions to perform the\n lookoutvision:DeleteModel operation.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/2020-11-20/projects/{ProjectName}/models/{ModelVersion}", - "code": 202 - } - } - }, - "com.amazonaws.lookoutvision#DeleteModelRequest": { - "type": "structure", - "members": { - "ProjectName": { - "target": "com.amazonaws.lookoutvision#ProjectName", - "traits": { - "smithy.api#documentation": "

The name of the project that contains the model that you want to delete.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ModelVersion": { - "target": "com.amazonaws.lookoutvision#ModelVersionNoLatest", - "traits": { - "smithy.api#documentation": "

The version of the model that you want to delete.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ClientToken": { - "target": "com.amazonaws.lookoutvision#ClientToken", - "traits": { - "smithy.api#documentation": "

ClientToken is an idempotency token that ensures a call to DeleteModel\n completes only once. You choose the value to pass. For example, an issue might prevent\n you from getting a response from DeleteModel.\n In this case, safely retry your call\n to DeleteModel by using the same ClientToken parameter value.

\n

If you don't supply a value for ClientToken, the AWS SDK you are using inserts a value for you. \n This prevents retries after a network error from making multiple model deletion requests. You'll need to\n provide your own value for other use cases.

\n

An error occurs if the other input parameters are not the same as in the first request. Using a different \n value for ClientToken is considered a new call to DeleteModel. An idempotency\n token is active for 8 hours.

", - "smithy.api#httpHeader": "X-Amzn-Client-Token", - "smithy.api#idempotencyToken": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lookoutvision#DeleteModelResponse": { - "type": "structure", - "members": { - "ModelArn": { - "target": "com.amazonaws.lookoutvision#ModelArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the model that was deleted.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.lookoutvision#DeleteProject": { - "type": "operation", - "input": { - "target": "com.amazonaws.lookoutvision#DeleteProjectRequest" - }, - "output": { - "target": "com.amazonaws.lookoutvision#DeleteProjectResponse" - }, - "errors": [ - { - "target": "com.amazonaws.lookoutvision#AccessDeniedException" - }, - { - "target": "com.amazonaws.lookoutvision#ConflictException" - }, - { - "target": "com.amazonaws.lookoutvision#InternalServerException" - }, - { - "target": "com.amazonaws.lookoutvision#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.lookoutvision#ThrottlingException" - }, - { - "target": "com.amazonaws.lookoutvision#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes an Amazon Lookout for Vision project.

\n

To delete a project, you must first delete each version of the model associated with \n the project. To delete a model use the DeleteModel operation.

\n

You also have to delete the dataset(s) associated with the model. For more information, see \n DeleteDataset. The images referenced by the training and test datasets aren't deleted. \n

\n

This operation requires permissions to perform the\n lookoutvision:DeleteProject operation.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/2020-11-20/projects/{ProjectName}", - "code": 200 - } - } - }, - "com.amazonaws.lookoutvision#DeleteProjectRequest": { - "type": "structure", - "members": { - "ProjectName": { - "target": "com.amazonaws.lookoutvision#ProjectName", - "traits": { - "smithy.api#documentation": "

The name of the project to delete.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ClientToken": { - "target": "com.amazonaws.lookoutvision#ClientToken", - "traits": { - "smithy.api#documentation": "

ClientToken is an idempotency token that ensures a call to DeleteProject\n completes only once. You choose the value to pass. For example, An issue\n might prevent you from getting a response from DeleteProject.\n In this case, safely retry your call\n to DeleteProject by using the same ClientToken parameter value.

\n

If you don't supply a value for ClientToken, the AWS SDK you are using inserts a value for you. \n This prevents retries after a network error from making multiple project deletion requests. You'll need to\n provide your own value for other use cases.

\n

An error occurs if the other input parameters are not the same as in the first request. Using a different \n value for ClientToken is considered a new call to DeleteProject. An idempotency\n token is active for 8 hours.

", - "smithy.api#httpHeader": "X-Amzn-Client-Token", - "smithy.api#idempotencyToken": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lookoutvision#DeleteProjectResponse": { - "type": "structure", - "members": { - "ProjectArn": { - "target": "com.amazonaws.lookoutvision#ProjectArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the project that was deleted.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.lookoutvision#DescribeDataset": { - "type": "operation", - "input": { - "target": "com.amazonaws.lookoutvision#DescribeDatasetRequest" - }, - "output": { - "target": "com.amazonaws.lookoutvision#DescribeDatasetResponse" - }, - "errors": [ - { - "target": "com.amazonaws.lookoutvision#AccessDeniedException" - }, - { - "target": "com.amazonaws.lookoutvision#ConflictException" - }, - { - "target": "com.amazonaws.lookoutvision#InternalServerException" - }, - { - "target": "com.amazonaws.lookoutvision#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.lookoutvision#ThrottlingException" - }, - { - "target": "com.amazonaws.lookoutvision#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Describe an Amazon Lookout for Vision dataset.

\n

This operation requires permissions to perform the\n lookoutvision:DescribeDataset operation.

", - "smithy.api#http": { - "method": "GET", - "uri": "/2020-11-20/projects/{ProjectName}/datasets/{DatasetType}", - "code": 200 - } - } - }, - "com.amazonaws.lookoutvision#DescribeDatasetRequest": { - "type": "structure", - "members": { - "ProjectName": { - "target": "com.amazonaws.lookoutvision#ProjectName", - "traits": { - "smithy.api#documentation": "

The name of the project that contains the dataset that you want to describe.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "DatasetType": { - "target": "com.amazonaws.lookoutvision#DatasetType", - "traits": { - "smithy.api#documentation": "

The type of the dataset to describe. Specify train to describe the \n training dataset. Specify test to describe the test dataset.\n If you have a single dataset project, specify train\n

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lookoutvision#DescribeDatasetResponse": { - "type": "structure", - "members": { - "DatasetDescription": { - "target": "com.amazonaws.lookoutvision#DatasetDescription", - "traits": { - "smithy.api#documentation": "

The description of the requested dataset.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.lookoutvision#DescribeModel": { - "type": "operation", - "input": { - "target": "com.amazonaws.lookoutvision#DescribeModelRequest" - }, - "output": { - "target": "com.amazonaws.lookoutvision#DescribeModelResponse" - }, - "errors": [ - { - "target": "com.amazonaws.lookoutvision#AccessDeniedException" - }, - { - "target": "com.amazonaws.lookoutvision#ConflictException" - }, - { - "target": "com.amazonaws.lookoutvision#InternalServerException" - }, - { - "target": "com.amazonaws.lookoutvision#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.lookoutvision#ThrottlingException" - }, - { - "target": "com.amazonaws.lookoutvision#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Describes a version of an Amazon Lookout for Vision model.

\n

This operation requires permissions to perform the\n lookoutvision:DescribeModel operation.

", - "smithy.api#http": { - "method": "GET", - "uri": "/2020-11-20/projects/{ProjectName}/models/{ModelVersion}", - "code": 200 - } - } - }, - "com.amazonaws.lookoutvision#DescribeModelPackagingJob": { - "type": "operation", - "input": { - "target": "com.amazonaws.lookoutvision#DescribeModelPackagingJobRequest" - }, - "output": { - "target": "com.amazonaws.lookoutvision#DescribeModelPackagingJobResponse" - }, - "errors": [ - { - "target": "com.amazonaws.lookoutvision#AccessDeniedException" - }, - { - "target": "com.amazonaws.lookoutvision#InternalServerException" - }, - { - "target": "com.amazonaws.lookoutvision#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.lookoutvision#ThrottlingException" - }, - { - "target": "com.amazonaws.lookoutvision#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Describes an Amazon Lookout for Vision model packaging job.\n

\n

This operation requires permissions to perform the\n lookoutvision:DescribeModelPackagingJob operation.

\n

For more information, see \n Using your Amazon Lookout for Vision model on an edge device in the Amazon Lookout for Vision Developer Guide.

", - "smithy.api#http": { - "method": "GET", - "uri": "/2020-11-20/projects/{ProjectName}/modelpackagingjobs/{JobName}", - "code": 200 - } - } - }, - "com.amazonaws.lookoutvision#DescribeModelPackagingJobRequest": { - "type": "structure", - "members": { - "ProjectName": { - "target": "com.amazonaws.lookoutvision#ProjectName", - "traits": { - "smithy.api#documentation": "

The name of the project that contains the model packaging job that you want to describe. \n

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "JobName": { - "target": "com.amazonaws.lookoutvision#ModelPackagingJobName", - "traits": { - "smithy.api#documentation": "

The job name for the model packaging job. \n\n

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lookoutvision#DescribeModelPackagingJobResponse": { - "type": "structure", - "members": { - "ModelPackagingDescription": { - "target": "com.amazonaws.lookoutvision#ModelPackagingDescription", - "traits": { - "smithy.api#documentation": "

The description of the model packaging job.\n

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.lookoutvision#DescribeModelRequest": { - "type": "structure", - "members": { - "ProjectName": { - "target": "com.amazonaws.lookoutvision#ProjectName", - "traits": { - "smithy.api#documentation": "

The project that contains the version of a model that you want to describe.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ModelVersion": { - "target": "com.amazonaws.lookoutvision#ModelVersion", - "traits": { - "smithy.api#documentation": "

The version of the model that you want to describe.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lookoutvision#DescribeModelResponse": { - "type": "structure", - "members": { - "ModelDescription": { - "target": "com.amazonaws.lookoutvision#ModelDescription", - "traits": { - "smithy.api#documentation": "

Contains the description of the model.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.lookoutvision#DescribeProject": { - "type": "operation", - "input": { - "target": "com.amazonaws.lookoutvision#DescribeProjectRequest" - }, - "output": { - "target": "com.amazonaws.lookoutvision#DescribeProjectResponse" - }, - "errors": [ - { - "target": "com.amazonaws.lookoutvision#AccessDeniedException" - }, - { - "target": "com.amazonaws.lookoutvision#ConflictException" - }, - { - "target": "com.amazonaws.lookoutvision#InternalServerException" - }, - { - "target": "com.amazonaws.lookoutvision#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.lookoutvision#ThrottlingException" - }, - { - "target": "com.amazonaws.lookoutvision#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Describes an Amazon Lookout for Vision project.

\n

This operation requires permissions to perform the\n lookoutvision:DescribeProject operation.

", - "smithy.api#http": { - "method": "GET", - "uri": "/2020-11-20/projects/{ProjectName}", - "code": 200 - } - } - }, - "com.amazonaws.lookoutvision#DescribeProjectRequest": { - "type": "structure", - "members": { - "ProjectName": { - "target": "com.amazonaws.lookoutvision#ProjectName", - "traits": { - "smithy.api#documentation": "

The name of the project that you want to describe.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lookoutvision#DescribeProjectResponse": { - "type": "structure", - "members": { - "ProjectDescription": { - "target": "com.amazonaws.lookoutvision#ProjectDescription", - "traits": { - "smithy.api#documentation": "

The description of the project.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.lookoutvision#DetectAnomalies": { - "type": "operation", - "input": { - "target": "com.amazonaws.lookoutvision#DetectAnomaliesRequest" - }, - "output": { - "target": "com.amazonaws.lookoutvision#DetectAnomaliesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.lookoutvision#AccessDeniedException" - }, - { - "target": "com.amazonaws.lookoutvision#ConflictException" - }, - { - "target": "com.amazonaws.lookoutvision#InternalServerException" - }, - { - "target": "com.amazonaws.lookoutvision#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.lookoutvision#ThrottlingException" - }, - { - "target": "com.amazonaws.lookoutvision#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Detects anomalies in an image that you supply.

\n

The response from DetectAnomalies includes a boolean prediction\n that the image contains one or more anomalies and a confidence value for the prediction.\n If the model is an image segmentation model, the response also includes segmentation\n information for each type of anomaly found in the image.

\n \n

Before calling DetectAnomalies, you must first start your model with the StartModel operation.\n You are charged for the amount of time, in minutes, that a model runs and for the number of anomaly detection units that your\n model uses. If you are not using a model, use the StopModel operation to stop your model.

\n \n

For more information, see Detecting anomalies in an image in the Amazon Lookout for Vision developer guide.

\n

This operation requires permissions to perform the\n lookoutvision:DetectAnomalies operation.

", - "smithy.api#http": { - "method": "POST", - "uri": "/2020-11-20/projects/{ProjectName}/models/{ModelVersion}/detect", - "code": 200 - } - } - }, - "com.amazonaws.lookoutvision#DetectAnomaliesRequest": { - "type": "structure", - "members": { - "ProjectName": { - "target": "com.amazonaws.lookoutvision#ProjectName", - "traits": { - "smithy.api#documentation": "

The name of the project that contains the model version that you want to use.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ModelVersion": { - "target": "com.amazonaws.lookoutvision#ModelVersion", - "traits": { - "smithy.api#documentation": "

The version of the model that you want to use.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Body": { - "target": "com.amazonaws.lookoutvision#Stream", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The unencrypted image bytes that you want to analyze.

", - "smithy.api#httpPayload": {}, - "smithy.api#required": {} - } - }, - "ContentType": { - "target": "com.amazonaws.lookoutvision#ContentType", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The type of the image passed in Body.\n Valid values are image/png (PNG format images) and image/jpeg (JPG format images).

", - "smithy.api#httpHeader": "Content-Type", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lookoutvision#DetectAnomaliesResponse": { - "type": "structure", - "members": { - "DetectAnomalyResult": { - "target": "com.amazonaws.lookoutvision#DetectAnomalyResult", - "traits": { - "smithy.api#documentation": "

The results of the DetectAnomalies operation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.lookoutvision#DetectAnomalyResult": { - "type": "structure", - "members": { - "Source": { - "target": "com.amazonaws.lookoutvision#ImageSource", - "traits": { - "smithy.api#documentation": "

The source of the image that was analyzed. direct means that the\n images was supplied from the local computer. No other values are supported.

" - } - }, - "IsAnomalous": { - "target": "com.amazonaws.lookoutvision#Boolean", - "traits": { - "smithy.api#documentation": "

True if Amazon Lookout for Vision classifies the image as containing an anomaly, otherwise false.

" - } - }, - "Confidence": { - "target": "com.amazonaws.lookoutvision#Float", - "traits": { - "smithy.api#documentation": "

The confidence that Lookout for Vision has in the accuracy of the classification in IsAnomalous.

" - } - }, - "Anomalies": { - "target": "com.amazonaws.lookoutvision#AnomalyList", - "traits": { - "smithy.api#documentation": "

If the model is an image segmentation model, Anomalies contains a list of\n anomaly types found in the image. There is one entry for each type of anomaly found (even\n if multiple instances of an anomaly type exist on the image). The first element in the list\n is always an anomaly type representing the image background ('background') and shouldn't be\n considered an anomaly. Amazon Lookout for Vision automatically add the background anomaly type to the\n response, and you don't need to declare a background anomaly type in your dataset.

\n

If the list has one entry ('background'), no anomalies were found on the image.

\n

\n

An image classification model doesn't return an Anomalies list.

" - } - }, - "AnomalyMask": { - "target": "com.amazonaws.lookoutvision#AnomalyMask", - "traits": { - "smithy.api#documentation": "

If the model is an image segmentation model, AnomalyMask contains pixel masks that covers all anomaly types found on the image.\n \n Each anomaly type has a different mask color. To map a color to an anomaly type, see the color field\n of the PixelAnomaly object.

\n

An image classification model doesn't return an Anomalies list.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The prediction results from a call to DetectAnomalies.\n DetectAnomalyResult includes classification information for the prediction (IsAnomalous and Confidence).\n If the model you use is an image segementation model, DetectAnomalyResult also includes segmentation information (Anomalies\n and AnomalyMask). Classification information is calculated separately from segmentation information\n and you shouldn't assume a relationship between them.

" - } - }, - "com.amazonaws.lookoutvision#ExceptionString": { - "type": "string" - }, - "com.amazonaws.lookoutvision#Float": { - "type": "float" - }, - "com.amazonaws.lookoutvision#GreengrassConfiguration": { - "type": "structure", - "members": { - "CompilerOptions": { - "target": "com.amazonaws.lookoutvision#CompilerOptions", - "traits": { - "smithy.api#documentation": "

Additional compiler options for the Greengrass component. Currently, \n only NVIDIA Graphics Processing Units (GPU) and CPU accelerators are supported. \n If you specify TargetDevice, don't specify CompilerOptions.

\n

For more information, see \n Compiler options in the Amazon Lookout for Vision Developer Guide.

" - } - }, - "TargetDevice": { - "target": "com.amazonaws.lookoutvision#TargetDevice", - "traits": { - "smithy.api#documentation": "

The target device for the model. Currently the only supported value is jetson_xavier.\n If you specify TargetDevice, you can't specify\n TargetPlatform.\n\n

" - } - }, - "TargetPlatform": { - "target": "com.amazonaws.lookoutvision#TargetPlatform", - "traits": { - "smithy.api#documentation": "

The target platform for the model. If you specify TargetPlatform, you can't specify\n TargetDevice. \n

" - } - }, - "S3OutputLocation": { - "target": "com.amazonaws.lookoutvision#S3Location", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

\n An S3 location in which Lookout for Vision stores the component artifacts. \n

", - "smithy.api#required": {} - } - }, - "ComponentName": { - "target": "com.amazonaws.lookoutvision#ComponentName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

\n A name for the AWS IoT Greengrass component. \n

", - "smithy.api#required": {} - } - }, - "ComponentVersion": { - "target": "com.amazonaws.lookoutvision#ComponentVersion", - "traits": { - "smithy.api#documentation": "

A Version for the AWS IoT Greengrass component. If you don't provide a\n value, a default value of \n Model Version.0.0 is used.\n

" - } - }, - "ComponentDescription": { - "target": "com.amazonaws.lookoutvision#ComponentDescription", - "traits": { - "smithy.api#documentation": "

\n A description for the AWS IoT Greengrass component.\n

" - } - }, - "Tags": { - "target": "com.amazonaws.lookoutvision#TagList", - "traits": { - "smithy.api#documentation": "

\n A set of tags (key-value pairs) that you want to attach to the AWS IoT Greengrass component.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Configuration information for the AWS IoT Greengrass component created in a model packaging job. \n For more information, see StartModelPackagingJob.\n

\n \n

You can't specify a component with the same ComponentName and Componentversion as\n an existing component with the same component name and component version.

\n " - } - }, - "com.amazonaws.lookoutvision#GreengrassOutputDetails": { - "type": "structure", - "members": { - "ComponentVersionArn": { - "target": "com.amazonaws.lookoutvision#ComponentVersionArn", - "traits": { - "smithy.api#documentation": "

\nThe Amazon Resource Name (ARN) of the component.\n

" - } - }, - "ComponentName": { - "target": "com.amazonaws.lookoutvision#ComponentName", - "traits": { - "smithy.api#documentation": "

\nThe name of the component.\n

" - } - }, - "ComponentVersion": { - "target": "com.amazonaws.lookoutvision#ComponentVersion", - "traits": { - "smithy.api#documentation": "

\nThe version of the component.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about the AWS IoT Greengrass component created by a model packaging job.\n\n

" - } - }, - "com.amazonaws.lookoutvision#ImageSource": { - "type": "structure", - "members": { - "Type": { - "target": "com.amazonaws.lookoutvision#ImageSourceType", - "traits": { - "smithy.api#documentation": "

The type of the image.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The source for an image.

" - } - }, - "com.amazonaws.lookoutvision#ImageSourceType": { - "type": "string", - "traits": { - "smithy.api#pattern": "^direct$" - } - }, - "com.amazonaws.lookoutvision#InferenceUnits": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1 - } - } - }, - "com.amazonaws.lookoutvision#InputS3Object": { - "type": "structure", - "members": { - "Bucket": { - "target": "com.amazonaws.lookoutvision#S3BucketName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The Amazon S3 bucket that contains the manifest.

", - "smithy.api#required": {} - } - }, - "Key": { - "target": "com.amazonaws.lookoutvision#S3ObjectKey", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The name and location of the manifest file withiin the bucket.

", - "smithy.api#required": {} - } - }, - "VersionId": { - "target": "com.amazonaws.lookoutvision#S3ObjectVersion", - "traits": { - "smithy.api#documentation": "

The version ID of the bucket.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Amazon S3 Location information for an input manifest file.

" - } - }, - "com.amazonaws.lookoutvision#Integer": { - "type": "integer" - }, - "com.amazonaws.lookoutvision#InternalServerException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.lookoutvision#ExceptionString", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#required": {} - } - }, - "RetryAfterSeconds": { - "target": "com.amazonaws.lookoutvision#RetryAfterSeconds", - "traits": { - "smithy.api#documentation": "

The period of time, in seconds, before the operation can be retried.

", - "smithy.api#httpHeader": "Retry-After" - } - } - }, - "traits": { - "smithy.api#documentation": "

Amazon Lookout for Vision experienced a service issue. Try your call again.

", - "smithy.api#error": "server", - "smithy.api#httpError": 500 - } - }, - "com.amazonaws.lookoutvision#IsLabeled": { - "type": "boolean" - }, - "com.amazonaws.lookoutvision#KmsKeyId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2048 - }, - "smithy.api#pattern": "^[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,2048}$" - } - }, - "com.amazonaws.lookoutvision#ListDatasetEntries": { - "type": "operation", - "input": { - "target": "com.amazonaws.lookoutvision#ListDatasetEntriesRequest" - }, - "output": { - "target": "com.amazonaws.lookoutvision#ListDatasetEntriesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.lookoutvision#AccessDeniedException" - }, - { - "target": "com.amazonaws.lookoutvision#ConflictException" - }, - { - "target": "com.amazonaws.lookoutvision#InternalServerException" - }, - { - "target": "com.amazonaws.lookoutvision#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.lookoutvision#ThrottlingException" - }, - { - "target": "com.amazonaws.lookoutvision#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists the JSON Lines within a dataset. An Amazon Lookout for Vision JSON Line contains the anomaly\n information for a single image, including the image location and the assigned label.

\n

This operation requires permissions to perform the\n lookoutvision:ListDatasetEntries operation.

", - "smithy.api#http": { - "method": "GET", - "uri": "/2020-11-20/projects/{ProjectName}/datasets/{DatasetType}/entries", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "DatasetEntries", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.lookoutvision#ListDatasetEntriesRequest": { - "type": "structure", - "members": { - "ProjectName": { - "target": "com.amazonaws.lookoutvision#ProjectName", - "traits": { - "smithy.api#documentation": "

The name of the project that contains the dataset that you want to list.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "DatasetType": { - "target": "com.amazonaws.lookoutvision#DatasetType", - "traits": { - "smithy.api#documentation": "

The type of the dataset that you want to list. Specify train to list \n the training dataset. Specify test to list the test dataset. If you have a single dataset\n project, specify train.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Labeled": { - "target": "com.amazonaws.lookoutvision#IsLabeled", - "traits": { - "smithy.api#documentation": "

Specify true to include labeled entries, otherwise specify false. If you\n don't specify a value, Lookout for Vision returns all entries.

", - "smithy.api#httpQuery": "labeled" - } - }, - "AnomalyClass": { - "target": "com.amazonaws.lookoutvision#AnomalyClassFilter", - "traits": { - "smithy.api#documentation": "

Specify normal to include only normal images. Specify anomaly to only include\n anomalous entries. If you don't specify a value, Amazon Lookout for Vision returns normal and anomalous images.

", - "smithy.api#httpQuery": "anomalyClass" - } - }, - "BeforeCreationDate": { - "target": "com.amazonaws.lookoutvision#DateTime", - "traits": { - "smithy.api#documentation": "

Only includes entries before the specified date in the response. For example, 2020-06-23T00:00:00.

", - "smithy.api#httpQuery": "createdBefore" - } - }, - "AfterCreationDate": { - "target": "com.amazonaws.lookoutvision#DateTime", - "traits": { - "smithy.api#documentation": "

Only includes entries after the specified date in the response. For example, 2020-06-23T00:00:00.

", - "smithy.api#httpQuery": "createdAfter" - } - }, - "NextToken": { - "target": "com.amazonaws.lookoutvision#PaginationToken", - "traits": { - "smithy.api#documentation": "

If the previous response was incomplete (because there is more data to retrieve),\n Amazon Lookout for Vision returns a pagination token in the response. You can use this pagination token to\n retrieve the next set of dataset entries.

", - "smithy.api#httpQuery": "nextToken" - } - }, - "MaxResults": { - "target": "com.amazonaws.lookoutvision#PageSize", - "traits": { - "smithy.api#documentation": "

The maximum number of results to return per paginated call. The largest value you can specify is 100. \n If you specify a value greater than 100, a ValidationException\n error occurs. The default value is 100.

", - "smithy.api#httpQuery": "maxResults" - } - }, - "SourceRefContains": { - "target": "com.amazonaws.lookoutvision#QueryString", - "traits": { - "smithy.api#documentation": "

Perform a \"contains\" search on the values of the source-ref key within the dataset. \n For example a value of \"IMG_17\" returns all JSON Lines where the source-ref key value matches *IMG_17*.

", - "smithy.api#httpQuery": "sourceRefContains" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lookoutvision#ListDatasetEntriesResponse": { - "type": "structure", - "members": { - "DatasetEntries": { - "target": "com.amazonaws.lookoutvision#DatasetEntryList", - "traits": { - "smithy.api#documentation": "

A list of the entries (JSON Lines) within the dataset.

" - } - }, - "NextToken": { - "target": "com.amazonaws.lookoutvision#PaginationToken", - "traits": { - "smithy.api#documentation": "

If the response is truncated, Amazon Lookout for Vision returns this token\n that you can use in the subsequent request to retrieve the next set ofdataset entries.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.lookoutvision#ListModelPackagingJobs": { - "type": "operation", - "input": { - "target": "com.amazonaws.lookoutvision#ListModelPackagingJobsRequest" - }, - "output": { - "target": "com.amazonaws.lookoutvision#ListModelPackagingJobsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.lookoutvision#AccessDeniedException" - }, - { - "target": "com.amazonaws.lookoutvision#InternalServerException" - }, - { - "target": "com.amazonaws.lookoutvision#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.lookoutvision#ThrottlingException" - }, - { - "target": "com.amazonaws.lookoutvision#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

\nLists the model packaging jobs created for an Amazon Lookout for Vision project.\n

\n

This operation requires permissions to perform the\n lookoutvision:ListModelPackagingJobs operation.\n

\n

For more information, see \n Using your Amazon Lookout for Vision model on an edge device in the Amazon Lookout for Vision Developer Guide.

", - "smithy.api#http": { - "method": "GET", - "uri": "/2020-11-20/projects/{ProjectName}/modelpackagingjobs", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "ModelPackagingJobs", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.lookoutvision#ListModelPackagingJobsRequest": { - "type": "structure", - "members": { - "ProjectName": { - "target": "com.amazonaws.lookoutvision#ProjectName", - "traits": { - "smithy.api#documentation": "

\nThe name of the project for which you want to list the model packaging jobs.\n

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.lookoutvision#PaginationToken", - "traits": { - "smithy.api#documentation": "

If the previous response was incomplete (because there is more\n results to retrieve), Amazon Lookout for Vision returns a pagination token in the response. You can use this pagination \n token to retrieve the next set of results.

", - "smithy.api#httpQuery": "nextToken" - } - }, - "MaxResults": { - "target": "com.amazonaws.lookoutvision#PageSize", - "traits": { - "smithy.api#documentation": "

The maximum number of results to return per paginated call. The largest value you can specify is 100. \n If you specify a value greater than 100, a ValidationException\n error occurs. The default value is 100.

", - "smithy.api#httpQuery": "maxResults" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lookoutvision#ListModelPackagingJobsResponse": { - "type": "structure", - "members": { - "ModelPackagingJobs": { - "target": "com.amazonaws.lookoutvision#ModelPackagingJobsList", - "traits": { - "smithy.api#documentation": "

\nA list of the model packaging jobs created for the specified Amazon Lookout for Vision project.\n

" - } - }, - "NextToken": { - "target": "com.amazonaws.lookoutvision#PaginationToken", - "traits": { - "smithy.api#documentation": "

If the previous response was incomplete (because there is more\n results to retrieve), Amazon Lookout for Vision returns a pagination token in the response. You can use this pagination \n token to retrieve the next set of results.\n

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.lookoutvision#ListModels": { - "type": "operation", - "input": { - "target": "com.amazonaws.lookoutvision#ListModelsRequest" - }, - "output": { - "target": "com.amazonaws.lookoutvision#ListModelsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.lookoutvision#AccessDeniedException" - }, - { - "target": "com.amazonaws.lookoutvision#ConflictException" - }, - { - "target": "com.amazonaws.lookoutvision#InternalServerException" - }, - { - "target": "com.amazonaws.lookoutvision#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.lookoutvision#ThrottlingException" - }, - { - "target": "com.amazonaws.lookoutvision#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists the versions of a model in an Amazon Lookout for Vision project.

\n

The ListModels operation is eventually consistent. \n Recent calls to CreateModel might\n take a while to appear in the response from ListProjects.

\n

This operation requires permissions to perform the\n lookoutvision:ListModels operation.

", - "smithy.api#http": { - "method": "GET", - "uri": "/2020-11-20/projects/{ProjectName}/models", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "Models", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.lookoutvision#ListModelsRequest": { - "type": "structure", - "members": { - "ProjectName": { - "target": "com.amazonaws.lookoutvision#ProjectName", - "traits": { - "smithy.api#documentation": "

The name of the project that contains the model versions that you want to list.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.lookoutvision#PaginationToken", - "traits": { - "smithy.api#documentation": "

If the previous response was incomplete (because there is more data to retrieve),\n Amazon Lookout for Vision returns a pagination token in the response. You can use this pagination token to\n retrieve the next set of models.

", - "smithy.api#httpQuery": "nextToken" - } - }, - "MaxResults": { - "target": "com.amazonaws.lookoutvision#PageSize", - "traits": { - "smithy.api#documentation": "

The maximum number of results to return per paginated call. The largest value you can specify is 100. \n If you specify a value greater than 100, a ValidationException\n error occurs. The default value is 100.

", - "smithy.api#httpQuery": "maxResults" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lookoutvision#ListModelsResponse": { - "type": "structure", - "members": { - "Models": { - "target": "com.amazonaws.lookoutvision#ModelMetadataList", - "traits": { - "smithy.api#documentation": "

A list of model versions in the specified project.

" - } - }, - "NextToken": { - "target": "com.amazonaws.lookoutvision#PaginationToken", - "traits": { - "smithy.api#documentation": "

If the response is truncated, Amazon Lookout for Vision returns this token\n that you can use in the subsequent request to retrieve the next set of models.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.lookoutvision#ListProjects": { - "type": "operation", - "input": { - "target": "com.amazonaws.lookoutvision#ListProjectsRequest" - }, - "output": { - "target": "com.amazonaws.lookoutvision#ListProjectsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.lookoutvision#AccessDeniedException" - }, - { - "target": "com.amazonaws.lookoutvision#ConflictException" - }, - { - "target": "com.amazonaws.lookoutvision#InternalServerException" - }, - { - "target": "com.amazonaws.lookoutvision#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.lookoutvision#ThrottlingException" - }, - { - "target": "com.amazonaws.lookoutvision#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists the Amazon Lookout for Vision projects in your AWS account that are in the AWS Region in \n which you call ListProjects.

\n

The ListProjects operation is eventually consistent. \n Recent calls to CreateProject and DeleteProject might\n take a while to appear in the response from ListProjects.

\n

This operation requires permissions to perform the\n lookoutvision:ListProjects operation.

", - "smithy.api#http": { - "method": "GET", - "uri": "/2020-11-20/projects", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "Projects", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.lookoutvision#ListProjectsRequest": { - "type": "structure", - "members": { - "NextToken": { - "target": "com.amazonaws.lookoutvision#PaginationToken", - "traits": { - "smithy.api#documentation": "

If the previous response was incomplete (because there is more data to retrieve),\n Amazon Lookout for Vision returns a pagination token in the response. You can use this pagination token to\n retrieve the next set of projects.

", - "smithy.api#httpQuery": "nextToken" - } - }, - "MaxResults": { - "target": "com.amazonaws.lookoutvision#PageSize", - "traits": { - "smithy.api#documentation": "

The maximum number of results to return per paginated call. The largest value you can specify is 100. \n If you specify a value greater than 100, a ValidationException\n error occurs. The default value is 100.

", - "smithy.api#httpQuery": "maxResults" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lookoutvision#ListProjectsResponse": { - "type": "structure", - "members": { - "Projects": { - "target": "com.amazonaws.lookoutvision#ProjectMetadataList", - "traits": { - "smithy.api#documentation": "

A list of projects in your AWS account.

" - } - }, - "NextToken": { - "target": "com.amazonaws.lookoutvision#PaginationToken", - "traits": { - "smithy.api#documentation": "

If the response is truncated, Amazon Lookout for Vision returns this token\n that you can use in the subsequent request to retrieve the next set of projects.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.lookoutvision#ListTagsForResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.lookoutvision#ListTagsForResourceRequest" - }, - "output": { - "target": "com.amazonaws.lookoutvision#ListTagsForResourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.lookoutvision#AccessDeniedException" - }, - { - "target": "com.amazonaws.lookoutvision#ConflictException" - }, - { - "target": "com.amazonaws.lookoutvision#InternalServerException" - }, - { - "target": "com.amazonaws.lookoutvision#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.lookoutvision#ThrottlingException" - }, - { - "target": "com.amazonaws.lookoutvision#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns a list of tags attached to the specified Amazon Lookout for Vision model.

\n

This operation requires permissions to perform the\n lookoutvision:ListTagsForResource operation.

", - "smithy.api#http": { - "method": "GET", - "uri": "/2020-11-20/tags/{ResourceArn}", - "code": 200 - } - } - }, - "com.amazonaws.lookoutvision#ListTagsForResourceRequest": { - "type": "structure", - "members": { - "ResourceArn": { - "target": "com.amazonaws.lookoutvision#TagArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the model for which you want to list tags.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lookoutvision#ListTagsForResourceResponse": { - "type": "structure", - "members": { - "Tags": { - "target": "com.amazonaws.lookoutvision#TagList", - "traits": { - "smithy.api#documentation": "

A map of tag keys and values attached to the specified model.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.lookoutvision#LookoutVisionService": { - "type": "service", - "version": "2020-11-20", - "operations": [ - { - "target": "com.amazonaws.lookoutvision#CreateDataset" - }, - { - "target": "com.amazonaws.lookoutvision#CreateModel" - }, - { - "target": "com.amazonaws.lookoutvision#CreateProject" - }, - { - "target": "com.amazonaws.lookoutvision#DeleteDataset" - }, - { - "target": "com.amazonaws.lookoutvision#DeleteModel" - }, - { - "target": "com.amazonaws.lookoutvision#DeleteProject" - }, - { - "target": "com.amazonaws.lookoutvision#DescribeDataset" - }, - { - "target": "com.amazonaws.lookoutvision#DescribeModel" - }, - { - "target": "com.amazonaws.lookoutvision#DescribeModelPackagingJob" - }, - { - "target": "com.amazonaws.lookoutvision#DescribeProject" - }, - { - "target": "com.amazonaws.lookoutvision#DetectAnomalies" - }, - { - "target": "com.amazonaws.lookoutvision#ListDatasetEntries" - }, - { - "target": "com.amazonaws.lookoutvision#ListModelPackagingJobs" - }, - { - "target": "com.amazonaws.lookoutvision#ListModels" - }, - { - "target": "com.amazonaws.lookoutvision#ListProjects" - }, - { - "target": "com.amazonaws.lookoutvision#ListTagsForResource" - }, - { - "target": "com.amazonaws.lookoutvision#StartModel" - }, - { - "target": "com.amazonaws.lookoutvision#StartModelPackagingJob" - }, - { - "target": "com.amazonaws.lookoutvision#StopModel" - }, - { - "target": "com.amazonaws.lookoutvision#TagResource" - }, - { - "target": "com.amazonaws.lookoutvision#UntagResource" - }, - { - "target": "com.amazonaws.lookoutvision#UpdateDatasetEntries" - } - ], - "traits": { - "aws.api#service": { - "sdkId": "LookoutVision", - "arnNamespace": "lookoutvision", - "cloudFormationName": "LookoutVision", - "cloudTrailEventSource": "lookoutvision.amazonaws.com", - "endpointPrefix": "lookoutvision" - }, - "aws.auth#sigv4": { - "name": "lookoutvision" - }, - "aws.protocols#restJson1": {}, - "smithy.api#documentation": "

This is the Amazon Lookout for Vision API Reference. It provides descriptions of actions, \n data types, common parameters, and common errors.

\n

Amazon Lookout for Vision enables you to find visual defects in industrial products,\n accurately and at scale. It uses computer vision to identify missing components in an industrial product,\n damage to vehicles or structures, irregularities in production lines, and even minuscule defects in\n silicon wafers \u2014 or any other physical item where quality is important such as a missing capacitor\n on printed circuit boards.

", - "smithy.api#title": "Amazon Lookout for Vision", - "smithy.rules#endpointRuleSet": { - "version": "1.0", - "parameters": { - "Region": { - "builtIn": "AWS::Region", - "required": false, - "documentation": "The AWS region used to dispatch the request.", - "type": "string" - }, - "UseDualStack": { - "builtIn": "AWS::UseDualStack", - "required": true, - "default": false, - "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", - "type": "boolean" - }, - "UseFIPS": { - "builtIn": "AWS::UseFIPS", - "required": true, - "default": false, - "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", - "type": "boolean" - }, - "Endpoint": { - "builtIn": "SDK::Endpoint", - "required": false, - "documentation": "Override the endpoint used to send this request", - "type": "string" - } - }, - "rules": [ - { - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Endpoint" - } - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "error": "Invalid Configuration: FIPS and custom endpoint are not supported", - "type": "error" - }, - { - "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" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Region" - } - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "aws.partition", - "argv": [ - { - "ref": "Region" - } - ], - "assign": "PartitionResult" - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - }, - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://lookoutvision-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - }, - true - ] - } - ], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://lookoutvision-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://lookoutvision.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [], - "endpoint": { - "url": "https://lookoutvision.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" - } - ] - }, - "smithy.rules#endpointTests": { - "testCases": [ - { - "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://lookoutvision.ap-northeast-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-northeast-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://lookoutvision.ap-northeast-2.amazonaws.com" - } - }, - "params": { - "Region": "ap-northeast-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://lookoutvision.eu-central-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-central-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://lookoutvision.eu-west-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-west-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://lookoutvision.us-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://lookoutvision.us-east-2.amazonaws.com" - } - }, - "params": { - "Region": "us-east-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://lookoutvision.us-west-2.amazonaws.com" - } - }, - "params": { - "Region": "us-west-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://lookoutvision-fips.us-east-1.api.aws" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://lookoutvision-fips.us-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://lookoutvision.us-east-1.api.aws" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://lookoutvision-fips.cn-north-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://lookoutvision-fips.cn-north-1.amazonaws.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://lookoutvision.cn-north-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://lookoutvision.cn-north-1.amazonaws.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://lookoutvision-fips.us-gov-east-1.api.aws" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://lookoutvision-fips.us-gov-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://lookoutvision.us-gov-east-1.api.aws" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://lookoutvision.us-gov-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://lookoutvision-fips.us-iso-east-1.c2s.ic.gov" - } - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://lookoutvision.us-iso-east-1.c2s.ic.gov" - } - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://lookoutvision-fips.us-isob-east-1.sc2s.sgov.gov" - } - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://lookoutvision.us-isob-east-1.sc2s.sgov.gov" - } - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", - "expect": { - "endpoint": { - "url": "https://example.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": false, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", - "expect": { - "endpoint": { - "url": "https://example.com" - } - }, - "params": { - "UseFIPS": false, - "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": { - "Region": "us-east-1", - "UseFIPS": true, - "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": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": true, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "Missing region", - "expect": { - "error": "Invalid Configuration: Missing Region" - } - } - ], - "version": "1.0" - } - } - }, - "com.amazonaws.lookoutvision#ModelArn": { - "type": "string" - }, - "com.amazonaws.lookoutvision#ModelDescription": { - "type": "structure", - "members": { - "ModelVersion": { - "target": "com.amazonaws.lookoutvision#ModelVersion", - "traits": { - "smithy.api#documentation": "

The version of the model

" - } - }, - "ModelArn": { - "target": "com.amazonaws.lookoutvision#ModelArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the model.

" - } - }, - "CreationTimestamp": { - "target": "com.amazonaws.lookoutvision#DateTime", - "traits": { - "smithy.api#documentation": "

The unix timestamp for the date and time that the model was created.

" - } - }, - "Description": { - "target": "com.amazonaws.lookoutvision#ModelDescriptionMessage", - "traits": { - "smithy.api#documentation": "

The description for the model.

" - } - }, - "Status": { - "target": "com.amazonaws.lookoutvision#ModelStatus", - "traits": { - "smithy.api#documentation": "

The status of the model.

" - } - }, - "StatusMessage": { - "target": "com.amazonaws.lookoutvision#ModelStatusMessage", - "traits": { - "smithy.api#documentation": "

The status message for the model.

" - } - }, - "Performance": { - "target": "com.amazonaws.lookoutvision#ModelPerformance", - "traits": { - "smithy.api#documentation": "

Performance metrics for the model. Created during training.

" - } - }, - "OutputConfig": { - "target": "com.amazonaws.lookoutvision#OutputConfig", - "traits": { - "smithy.api#documentation": "

The S3 location where Amazon Lookout for Vision saves model training files.

" - } - }, - "EvaluationManifest": { - "target": "com.amazonaws.lookoutvision#OutputS3Object", - "traits": { - "smithy.api#documentation": "

The S3 location where Amazon Lookout for Vision saves the manifest file\n that was used to test the trained model and generate the performance scores.

" - } - }, - "EvaluationResult": { - "target": "com.amazonaws.lookoutvision#OutputS3Object", - "traits": { - "smithy.api#documentation": "

The S3 location where Amazon Lookout for Vision saves the performance metrics.

" - } - }, - "EvaluationEndTimestamp": { - "target": "com.amazonaws.lookoutvision#DateTime", - "traits": { - "smithy.api#documentation": "

The unix timestamp for the date and time that the evaluation ended.

" - } - }, - "KmsKeyId": { - "target": "com.amazonaws.lookoutvision#KmsKeyId", - "traits": { - "smithy.api#documentation": "

The identifer for the AWS Key Management Service (AWS KMS) key that was used to encrypt the model\n during training.

" - } - }, - "MinInferenceUnits": { - "target": "com.amazonaws.lookoutvision#InferenceUnits", - "traits": { - "smithy.api#documentation": "

The minimum number of inference units used by the model. For more information,\n see StartModel\n

" - } - }, - "MaxInferenceUnits": { - "target": "com.amazonaws.lookoutvision#InferenceUnits", - "traits": { - "smithy.api#documentation": "

The maximum number of inference units Amazon Lookout for Vision uses to auto-scale the model.\n For more information, see StartModel.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an Amazon Lookout for Vision model.

" - } - }, - "com.amazonaws.lookoutvision#ModelDescriptionMessage": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 500 - }, - "smithy.api#pattern": "^[0-9A-Za-z\\.\\-_]*$" - } - }, - "com.amazonaws.lookoutvision#ModelHostingStatus": { - "type": "enum", - "members": { - "STARTING_HOSTING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STARTING_HOSTING" - } - }, - "HOSTED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HOSTED" - } - }, - "HOSTING_FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HOSTING_FAILED" - } - }, - "STOPPING_HOSTING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STOPPING_HOSTING" - } - }, - "SYSTEM_UPDATING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SYSTEM_UPDATING" - } - } - } - }, - "com.amazonaws.lookoutvision#ModelMetadata": { - "type": "structure", - "members": { - "CreationTimestamp": { - "target": "com.amazonaws.lookoutvision#DateTime", - "traits": { - "smithy.api#documentation": "

The unix timestamp for the date and time that the model was created.

" - } - }, - "ModelVersion": { - "target": "com.amazonaws.lookoutvision#ModelVersion", - "traits": { - "smithy.api#documentation": "

The version of the model.

" - } - }, - "ModelArn": { - "target": "com.amazonaws.lookoutvision#ModelArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the model.

" - } - }, - "Description": { - "target": "com.amazonaws.lookoutvision#ModelDescriptionMessage", - "traits": { - "smithy.api#documentation": "

The description for the model.

" - } - }, - "Status": { - "target": "com.amazonaws.lookoutvision#ModelStatus", - "traits": { - "smithy.api#documentation": "

The status of the model.

" - } - }, - "StatusMessage": { - "target": "com.amazonaws.lookoutvision#ModelStatusMessage", - "traits": { - "smithy.api#documentation": "

The status message for the model.

" - } - }, - "Performance": { - "target": "com.amazonaws.lookoutvision#ModelPerformance", - "traits": { - "smithy.api#documentation": "

Performance metrics for the model. Not available until training has successfully completed.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an Amazon Lookout for Vision model.

" - } - }, - "com.amazonaws.lookoutvision#ModelMetadataList": { - "type": "list", - "member": { - "target": "com.amazonaws.lookoutvision#ModelMetadata" - } - }, - "com.amazonaws.lookoutvision#ModelPackagingConfiguration": { - "type": "structure", - "members": { - "Greengrass": { - "target": "com.amazonaws.lookoutvision#GreengrassConfiguration", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

\nConfiguration information for the AWS IoT Greengrass component in a model packaging job.\n

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

\nConfiguration information for a Amazon Lookout for Vision model packaging job. For more information,\nsee StartModelPackagingJob.\n

" - } - }, - "com.amazonaws.lookoutvision#ModelPackagingDescription": { - "type": "structure", - "members": { - "JobName": { - "target": "com.amazonaws.lookoutvision#ModelPackagingJobName", - "traits": { - "smithy.api#documentation": "

\nThe name of the model packaging job.\n

" - } - }, - "ProjectName": { - "target": "com.amazonaws.lookoutvision#ProjectName", - "traits": { - "smithy.api#documentation": "

The name of the project that's associated with a model that's in the model package.\n\n

" - } - }, - "ModelVersion": { - "target": "com.amazonaws.lookoutvision#ModelVersion", - "traits": { - "smithy.api#documentation": "

The version of the model used in the model packaging job.\n\n

" - } - }, - "ModelPackagingConfiguration": { - "target": "com.amazonaws.lookoutvision#ModelPackagingConfiguration", - "traits": { - "smithy.api#documentation": "

\nThe configuration information used in the model packaging job.\n

" - } - }, - "ModelPackagingJobDescription": { - "target": "com.amazonaws.lookoutvision#ModelPackagingJobDescription", - "traits": { - "smithy.api#documentation": "

The description for the model packaging job.\n\n

" - } - }, - "ModelPackagingMethod": { - "target": "com.amazonaws.lookoutvision#ModelPackagingMethod", - "traits": { - "smithy.api#documentation": "

The AWS service used to package the job. Currently Lookout for Vision can package\njobs with AWS IoT Greengrass.\n

" - } - }, - "ModelPackagingOutputDetails": { - "target": "com.amazonaws.lookoutvision#ModelPackagingOutputDetails", - "traits": { - "smithy.api#documentation": "

Information about the output of the model packaging job. For more information,\n see DescribeModelPackagingJob.\n

" - } - }, - "Status": { - "target": "com.amazonaws.lookoutvision#ModelPackagingJobStatus", - "traits": { - "smithy.api#documentation": "

\nThe status of the model packaging job.\n

" - } - }, - "StatusMessage": { - "target": "com.amazonaws.lookoutvision#ModelPackagingStatusMessage", - "traits": { - "smithy.api#documentation": "

\nThe status message for the model packaging job.\n

" - } - }, - "CreationTimestamp": { - "target": "com.amazonaws.lookoutvision#DateTime", - "traits": { - "smithy.api#documentation": "

\n The Unix timestamp for the time and date that the model packaging job was created.\n

" - } - }, - "LastUpdatedTimestamp": { - "target": "com.amazonaws.lookoutvision#DateTime", - "traits": { - "smithy.api#documentation": "

\n The Unix timestamp for the time and date that the model packaging job was last updated.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

\nInformation about a model packaging job. For more information, see \nDescribeModelPackagingJob.\n

" - } - }, - "com.amazonaws.lookoutvision#ModelPackagingJobDescription": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - }, - "smithy.api#pattern": "^[a-zA-Z0-9-_. ()':,;?]+$" - } - }, - "com.amazonaws.lookoutvision#ModelPackagingJobMetadata": { - "type": "structure", - "members": { - "JobName": { - "target": "com.amazonaws.lookoutvision#ModelPackagingJobName", - "traits": { - "smithy.api#documentation": "

\nThe name of the model packaging job.\n

" - } - }, - "ProjectName": { - "target": "com.amazonaws.lookoutvision#ProjectName", - "traits": { - "smithy.api#documentation": "

\nThe project that contains the model that is in the model package.\n

" - } - }, - "ModelVersion": { - "target": "com.amazonaws.lookoutvision#ModelVersion", - "traits": { - "smithy.api#documentation": "

\nThe version of the model that is in the model package.\n

" - } - }, - "ModelPackagingJobDescription": { - "target": "com.amazonaws.lookoutvision#ModelPackagingJobDescription", - "traits": { - "smithy.api#documentation": "

\nThe description for the model packaging job.\n

" - } - }, - "ModelPackagingMethod": { - "target": "com.amazonaws.lookoutvision#ModelPackagingMethod", - "traits": { - "smithy.api#documentation": "

\nThe AWS service used to package the job. Currently Lookout for Vision can package\n jobs with AWS IoT Greengrass.\n

" - } - }, - "Status": { - "target": "com.amazonaws.lookoutvision#ModelPackagingJobStatus", - "traits": { - "smithy.api#documentation": "

The status of the model packaging job.\n

" - } - }, - "StatusMessage": { - "target": "com.amazonaws.lookoutvision#ModelPackagingStatusMessage", - "traits": { - "smithy.api#documentation": "

The status message for the model packaging job.\n

" - } - }, - "CreationTimestamp": { - "target": "com.amazonaws.lookoutvision#DateTime", - "traits": { - "smithy.api#documentation": "

The Unix timestamp for the time and date that the model packaging job was created.

" - } - }, - "LastUpdatedTimestamp": { - "target": "com.amazonaws.lookoutvision#DateTime", - "traits": { - "smithy.api#documentation": "

The Unix timestamp for the time and date that the model packaging job was last updated.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

\n Metadata for a model packaging job. For more information, see ListModelPackagingJobs.\n

" - } - }, - "com.amazonaws.lookoutvision#ModelPackagingJobName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - }, - "smithy.api#pattern": "^[a-zA-Z0-9-]+$" - } - }, - "com.amazonaws.lookoutvision#ModelPackagingJobStatus": { - "type": "enum", - "members": { - "CREATED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CREATED" - } - }, - "RUNNING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RUNNING" - } - }, - "SUCCEEDED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SUCCEEDED" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED" - } - } - } - }, - "com.amazonaws.lookoutvision#ModelPackagingJobsList": { - "type": "list", - "member": { - "target": "com.amazonaws.lookoutvision#ModelPackagingJobMetadata" - } - }, - "com.amazonaws.lookoutvision#ModelPackagingMethod": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 32 - }, - "smithy.api#pattern": "^[a-zA-Z0-9]+$" - } - }, - "com.amazonaws.lookoutvision#ModelPackagingOutputDetails": { - "type": "structure", - "members": { - "Greengrass": { - "target": "com.amazonaws.lookoutvision#GreengrassOutputDetails", - "traits": { - "smithy.api#documentation": "

\nInformation about the AWS IoT Greengrass component in a model packaging job.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

\nInformation about the output from a model packaging job.\n

" - } - }, - "com.amazonaws.lookoutvision#ModelPackagingStatusMessage": { - "type": "string" - }, - "com.amazonaws.lookoutvision#ModelPerformance": { - "type": "structure", - "members": { - "F1Score": { - "target": "com.amazonaws.lookoutvision#Float", - "traits": { - "smithy.api#documentation": "

The overall F1 score metric for the trained model.

" - } - }, - "Recall": { - "target": "com.amazonaws.lookoutvision#Float", - "traits": { - "smithy.api#documentation": "

The overall recall metric value for the trained model.

" - } - }, - "Precision": { - "target": "com.amazonaws.lookoutvision#Float", - "traits": { - "smithy.api#documentation": "

The overall precision metric value for the trained model.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about the evaluation performance of a trained model.

" - } - }, - "com.amazonaws.lookoutvision#ModelStatus": { - "type": "enum", - "members": { - "TRAINING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TRAINING" - } - }, - "TRAINED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TRAINED" - } - }, - "TRAINING_FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TRAINING_FAILED" - } - }, - "STARTING_HOSTING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STARTING_HOSTING" - } - }, - "HOSTED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HOSTED" - } - }, - "HOSTING_FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HOSTING_FAILED" - } - }, - "STOPPING_HOSTING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STOPPING_HOSTING" - } - }, - "SYSTEM_UPDATING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SYSTEM_UPDATING" - } - }, - "DELETING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETING" - } - } - } - }, - "com.amazonaws.lookoutvision#ModelStatusMessage": { - "type": "string" - }, - "com.amazonaws.lookoutvision#ModelVersion": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 10 - }, - "smithy.api#pattern": "^([1-9][0-9]*|latest)$" - } - }, - "com.amazonaws.lookoutvision#ModelVersionNoLatest": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 10 - }, - "smithy.api#pattern": "^([1-9][0-9]*)$" - } - }, - "com.amazonaws.lookoutvision#OutputConfig": { - "type": "structure", - "members": { - "S3Location": { - "target": "com.amazonaws.lookoutvision#S3Location", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The S3 location for the output.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The S3 location where Amazon Lookout for Vision saves model training files.

" - } - }, - "com.amazonaws.lookoutvision#OutputS3Object": { - "type": "structure", - "members": { - "Bucket": { - "target": "com.amazonaws.lookoutvision#S3BucketName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The bucket that contains the training output.

", - "smithy.api#required": {} - } - }, - "Key": { - "target": "com.amazonaws.lookoutvision#S3ObjectKey", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The location of the training output in the bucket.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The S3 location where Amazon Lookout for Vision saves training output.

" - } - }, - "com.amazonaws.lookoutvision#PageSize": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 100 - } - } - }, - "com.amazonaws.lookoutvision#PaginationToken": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 2048 - }, - "smithy.api#pattern": "^[a-zA-Z0-9\\/\\+\\=]{0,2048}$" - } - }, - "com.amazonaws.lookoutvision#PixelAnomaly": { - "type": "structure", - "members": { - "TotalPercentageArea": { - "target": "com.amazonaws.lookoutvision#Float", - "traits": { - "smithy.api#documentation": "

The percentage area of the image that the anomaly type covers.

" - } - }, - "Color": { - "target": "com.amazonaws.lookoutvision#Color", - "traits": { - "smithy.api#documentation": "

A hex color value for the mask that covers an anomaly type. Each anomaly type has\n a different mask color. The color maps to the color of the anomaly type used in the\n training dataset.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about the pixels in an anomaly mask. For more information, see Anomaly.\n PixelAnomaly is only returned by image segmentation models.

" - } - }, - "com.amazonaws.lookoutvision#ProjectArn": { - "type": "string" - }, - "com.amazonaws.lookoutvision#ProjectDescription": { - "type": "structure", - "members": { - "ProjectArn": { - "target": "com.amazonaws.lookoutvision#ProjectArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the project.

" - } - }, - "ProjectName": { - "target": "com.amazonaws.lookoutvision#ProjectName", - "traits": { - "smithy.api#documentation": "

The name of the project.

" - } - }, - "CreationTimestamp": { - "target": "com.amazonaws.lookoutvision#DateTime", - "traits": { - "smithy.api#documentation": "

The unix timestamp for the date and time that the project was created.

" - } - }, - "Datasets": { - "target": "com.amazonaws.lookoutvision#DatasetMetadataList", - "traits": { - "smithy.api#documentation": "

A list of datasets in the project.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describe an Amazon Lookout for Vision project. For more information, see DescribeProject.

" - } - }, - "com.amazonaws.lookoutvision#ProjectMetadata": { - "type": "structure", - "members": { - "ProjectArn": { - "target": "com.amazonaws.lookoutvision#ProjectArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the project.

" - } - }, - "ProjectName": { - "target": "com.amazonaws.lookoutvision#ProjectName", - "traits": { - "smithy.api#documentation": "

The name of the project.

" - } - }, - "CreationTimestamp": { - "target": "com.amazonaws.lookoutvision#DateTime", - "traits": { - "smithy.api#documentation": "

The unix timestamp for the date and time that the project was created.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Metadata about an Amazon Lookout for Vision project.

" - } - }, - "com.amazonaws.lookoutvision#ProjectMetadataList": { - "type": "list", - "member": { - "target": "com.amazonaws.lookoutvision#ProjectMetadata" - } - }, - "com.amazonaws.lookoutvision#ProjectName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 255 - }, - "smithy.api#pattern": "^[a-zA-Z0-9][a-zA-Z0-9_\\-]*$" - } - }, - "com.amazonaws.lookoutvision#QueryString": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2048 - }, - "smithy.api#pattern": "\\S" - } - }, - "com.amazonaws.lookoutvision#ResourceNotFoundException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.lookoutvision#ExceptionString", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#required": {} - } - }, - "ResourceId": { - "target": "com.amazonaws.lookoutvision#ExceptionString", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the resource.

", - "smithy.api#required": {} - } - }, - "ResourceType": { - "target": "com.amazonaws.lookoutvision#ResourceType", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The type of the resource.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The resource could not be found.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.lookoutvision#ResourceType": { - "type": "enum", - "members": { - "PROJECT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PROJECT" - } - }, - "DATASET": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DATASET" - } - }, - "MODEL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MODEL" - } - }, - "TRIAL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TRIAL" - } - }, - "MODEL_PACKAGE_JOB": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MODEL_PACKAGE_JOB" - } - } - } - }, - "com.amazonaws.lookoutvision#RetryAfterSeconds": { - "type": "integer" - }, - "com.amazonaws.lookoutvision#S3BucketName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 3, - "max": 63 - }, - "smithy.api#pattern": "^[0-9A-Za-z\\.\\-_]*$" - } - }, - "com.amazonaws.lookoutvision#S3KeyPrefix": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1024 - }, - "smithy.api#pattern": "^([a-zA-Z0-9!_.*'()-][/a-zA-Z0-9!_.*'()-]*)?$" - } - }, - "com.amazonaws.lookoutvision#S3Location": { - "type": "structure", - "members": { - "Bucket": { - "target": "com.amazonaws.lookoutvision#S3BucketName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The S3 bucket that contains the training or model packaging job output. If you are training a model,\n the bucket must in your AWS account. If you use an S3 bucket for a model packaging job,\n the S3 bucket must be in the same AWS Region and AWS account in which you use AWS IoT Greengrass.

", - "smithy.api#required": {} - } - }, - "Prefix": { - "target": "com.amazonaws.lookoutvision#S3KeyPrefix", - "traits": { - "smithy.api#documentation": "

The path of the folder, within the S3 bucket, that contains the output.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about the location of training output or the output of a model packaging job.

" - } - }, - "com.amazonaws.lookoutvision#S3ObjectKey": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1024 - }, - "smithy.api#pattern": "^([a-zA-Z0-9!_.*'()-][/a-zA-Z0-9!_.*'()-]*)?$" - } - }, - "com.amazonaws.lookoutvision#S3ObjectVersion": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1024 - }, - "smithy.api#pattern": ".*" - } - }, - "com.amazonaws.lookoutvision#ServiceQuotaExceededException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.lookoutvision#ExceptionString", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#required": {} - } - }, - "ResourceId": { - "target": "com.amazonaws.lookoutvision#ExceptionString", - "traits": { - "smithy.api#documentation": "

The ID of the resource.

" - } - }, - "ResourceType": { - "target": "com.amazonaws.lookoutvision#ResourceType", - "traits": { - "smithy.api#documentation": "

The type of the resource.

" - } - }, - "QuotaCode": { - "target": "com.amazonaws.lookoutvision#ExceptionString", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The quota code.

", - "smithy.api#required": {} - } - }, - "ServiceCode": { - "target": "com.amazonaws.lookoutvision#ExceptionString", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The service code.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A service quota was exceeded the allowed limit. For more information, see\n Limits in Amazon Lookout for Vision in the Amazon Lookout for Vision Developer Guide.

", - "smithy.api#error": "client", - "smithy.api#httpError": 402 - } - }, - "com.amazonaws.lookoutvision#StartModel": { - "type": "operation", - "input": { - "target": "com.amazonaws.lookoutvision#StartModelRequest" - }, - "output": { - "target": "com.amazonaws.lookoutvision#StartModelResponse" - }, - "errors": [ - { - "target": "com.amazonaws.lookoutvision#AccessDeniedException" - }, - { - "target": "com.amazonaws.lookoutvision#ConflictException" - }, - { - "target": "com.amazonaws.lookoutvision#InternalServerException" - }, - { - "target": "com.amazonaws.lookoutvision#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.lookoutvision#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.lookoutvision#ThrottlingException" - }, - { - "target": "com.amazonaws.lookoutvision#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Starts the running of the version of an Amazon Lookout for Vision model. Starting a model takes a while\n to complete. To check the current state of the model, use DescribeModel.

\n

A model is ready to use when its status is HOSTED.

\n

Once the model is running, you can detect custom labels in new images by calling \n DetectAnomalies.

\n \n

You are charged for the amount of time that the model is running. To stop a running\n model, call StopModel.

\n \n

This operation requires permissions to perform the\n lookoutvision:StartModel operation.

", - "smithy.api#http": { - "method": "POST", - "uri": "/2020-11-20/projects/{ProjectName}/models/{ModelVersion}/start", - "code": 202 - } - } - }, - "com.amazonaws.lookoutvision#StartModelPackagingJob": { - "type": "operation", - "input": { - "target": "com.amazonaws.lookoutvision#StartModelPackagingJobRequest" - }, - "output": { - "target": "com.amazonaws.lookoutvision#StartModelPackagingJobResponse" - }, - "errors": [ - { - "target": "com.amazonaws.lookoutvision#AccessDeniedException" - }, - { - "target": "com.amazonaws.lookoutvision#ConflictException" - }, - { - "target": "com.amazonaws.lookoutvision#InternalServerException" - }, - { - "target": "com.amazonaws.lookoutvision#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.lookoutvision#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.lookoutvision#ThrottlingException" - }, - { - "target": "com.amazonaws.lookoutvision#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Starts an Amazon Lookout for Vision model packaging job. A model packaging job creates an AWS IoT Greengrass component for\n a Lookout for Vision model. You can use the component to deploy your model to an edge device managed by Greengrass.\n

\n

Use the DescribeModelPackagingJob API to determine the current status of the job.\n \n The model packaging job is complete if the value of Status is SUCCEEDED.

\n

To deploy the component\n to the target device, use the component name and component version\n with the AWS IoT Greengrass CreateDeployment API.

\n

This operation requires the following permissions:

\n \n

For more information, see \n Using your Amazon Lookout for Vision model on an edge device in the Amazon Lookout for Vision Developer Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/2020-11-20/projects/{ProjectName}/modelpackagingjobs", - "code": 200 - } - } - }, - "com.amazonaws.lookoutvision#StartModelPackagingJobRequest": { - "type": "structure", - "members": { - "ProjectName": { - "target": "com.amazonaws.lookoutvision#ProjectName", - "traits": { - "smithy.api#documentation": "

\nThe name of the project which contains the version of the model that you want to package.\n

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ModelVersion": { - "target": "com.amazonaws.lookoutvision#ModelVersion", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

\nThe version of the model within the project that you want to package.\n

", - "smithy.api#required": {} - } - }, - "JobName": { - "target": "com.amazonaws.lookoutvision#ModelPackagingJobName", - "traits": { - "smithy.api#documentation": "

A name for the model packaging job. If you don't supply a value, the service creates\n a job name for you.\n

" - } - }, - "Configuration": { - "target": "com.amazonaws.lookoutvision#ModelPackagingConfiguration", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The configuration for the model packaging job.\n

", - "smithy.api#required": {} - } - }, - "Description": { - "target": "com.amazonaws.lookoutvision#ModelPackagingJobDescription", - "traits": { - "smithy.api#documentation": "

A description for the model packaging job.\n

" - } - }, - "ClientToken": { - "target": "com.amazonaws.lookoutvision#ClientToken", - "traits": { - "smithy.api#documentation": "

ClientToken is an idempotency token that ensures a call to StartModelPackagingJob\n completes only once. You choose the value to pass. For example, An issue might prevent you\n from getting a response from StartModelPackagingJob.\n In this case, safely retry your call\n to StartModelPackagingJob by using the same ClientToken parameter value.

\n

If you don't supply a value for ClientToken, the AWS SDK you are using inserts a value for you. \n This prevents retries after a network error from making multiple dataset creation requests. You'll need to\n provide your own value for other use cases.

\n

An error occurs if the other input parameters are not the same as in the first request. Using a different \n value for ClientToken is considered a new call to StartModelPackagingJob. An idempotency\n token is active for 8 hours.\n

", - "smithy.api#httpHeader": "X-Amzn-Client-Token", - "smithy.api#idempotencyToken": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lookoutvision#StartModelPackagingJobResponse": { - "type": "structure", - "members": { - "JobName": { - "target": "com.amazonaws.lookoutvision#ModelPackagingJobName", - "traits": { - "smithy.api#documentation": "

The job name for the model packaging job. If you don't supply a job name in the JobName input parameter,\n the service creates a job name for you.\n\n

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.lookoutvision#StartModelRequest": { - "type": "structure", - "members": { - "ProjectName": { - "target": "com.amazonaws.lookoutvision#ProjectName", - "traits": { - "smithy.api#documentation": "

The name of the project that contains the model that you want to start.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ModelVersion": { - "target": "com.amazonaws.lookoutvision#ModelVersion", - "traits": { - "smithy.api#documentation": "

The version of the model that you want to start.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "MinInferenceUnits": { - "target": "com.amazonaws.lookoutvision#InferenceUnits", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The minimum number of inference units to use. A single\n inference unit represents 1 hour of processing. \n Use a higher number to increase the TPS throughput of your model. You are charged for the number\n of inference units that you use.\n

", - "smithy.api#required": {} - } - }, - "ClientToken": { - "target": "com.amazonaws.lookoutvision#ClientToken", - "traits": { - "smithy.api#documentation": "

ClientToken is an idempotency token that ensures a call to StartModel\n completes only once. You choose the value to pass. For example, An issue might prevent \n you from getting a response from StartModel.\n In this case, safely retry your call\n to StartModel by using the same ClientToken parameter value.

\n

If you don't supply a value for ClientToken, the AWS SDK you are using inserts a value for you. \n This prevents retries after a network error from making multiple start requests. You'll need to\n provide your own value for other use cases.

\n

An error occurs if the other input parameters are not the same as in the first request. Using a different \n value for ClientToken is considered a new call to StartModel. An idempotency\n token is active for 8 hours.\n

", - "smithy.api#httpHeader": "X-Amzn-Client-Token", - "smithy.api#idempotencyToken": {} - } - }, - "MaxInferenceUnits": { - "target": "com.amazonaws.lookoutvision#InferenceUnits", - "traits": { - "smithy.api#documentation": "

The maximum number of inference units to use for auto-scaling the model. If you don't\n specify a value, Amazon Lookout for Vision doesn't auto-scale the model.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lookoutvision#StartModelResponse": { - "type": "structure", - "members": { - "Status": { - "target": "com.amazonaws.lookoutvision#ModelHostingStatus", - "traits": { - "smithy.api#documentation": "

The current running status of the model.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.lookoutvision#StopModel": { - "type": "operation", - "input": { - "target": "com.amazonaws.lookoutvision#StopModelRequest" - }, - "output": { - "target": "com.amazonaws.lookoutvision#StopModelResponse" - }, - "errors": [ - { - "target": "com.amazonaws.lookoutvision#AccessDeniedException" - }, - { - "target": "com.amazonaws.lookoutvision#ConflictException" - }, - { - "target": "com.amazonaws.lookoutvision#InternalServerException" - }, - { - "target": "com.amazonaws.lookoutvision#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.lookoutvision#ThrottlingException" - }, - { - "target": "com.amazonaws.lookoutvision#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Stops the hosting of a running model. The operation might take a while to complete. To\n check the current status, call DescribeModel.

\n

After the model hosting stops, the Status of the model is TRAINED.

\n

This operation requires permissions to perform the\n lookoutvision:StopModel operation.

", - "smithy.api#http": { - "method": "POST", - "uri": "/2020-11-20/projects/{ProjectName}/models/{ModelVersion}/stop", - "code": 202 - } - } - }, - "com.amazonaws.lookoutvision#StopModelRequest": { - "type": "structure", - "members": { - "ProjectName": { - "target": "com.amazonaws.lookoutvision#ProjectName", - "traits": { - "smithy.api#documentation": "

The name of the project that contains the model that you want to stop.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ModelVersion": { - "target": "com.amazonaws.lookoutvision#ModelVersion", - "traits": { - "smithy.api#documentation": "

The version of the model that you want to stop.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ClientToken": { - "target": "com.amazonaws.lookoutvision#ClientToken", - "traits": { - "smithy.api#documentation": "

ClientToken is an idempotency token that ensures a call to StopModel\n completes only once. You choose the value to pass. For example, An issue \n might prevent you from getting a response from StopModel.\n In this case, safely retry your call\n to StopModel by using the same ClientToken parameter value.

\n

If you don't supply a value for ClientToken, the AWS SDK you are using inserts a value for you. \n This prevents retries after a network error from making multiple stop requests. You'll need to\n provide your own value for other use cases.

\n

An error occurs if the other input parameters are not the same as in the first request. Using a different \n value for ClientToken is considered a new call to StopModel. An idempotency\n token is active for 8 hours.\n \n \n

", - "smithy.api#httpHeader": "X-Amzn-Client-Token", - "smithy.api#idempotencyToken": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lookoutvision#StopModelResponse": { - "type": "structure", - "members": { - "Status": { - "target": "com.amazonaws.lookoutvision#ModelHostingStatus", - "traits": { - "smithy.api#documentation": "

The status of the model.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.lookoutvision#Stream": { - "type": "blob", - "traits": { - "smithy.api#requiresLength": {}, - "smithy.api#streaming": {} - } - }, - "com.amazonaws.lookoutvision#Tag": { - "type": "structure", - "members": { - "Key": { - "target": "com.amazonaws.lookoutvision#TagKey", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The key of the tag that is attached to the specified model.

", - "smithy.api#required": {} - } - }, - "Value": { - "target": "com.amazonaws.lookoutvision#TagValue", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The value of the tag that is attached to the specified model.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A key and value pair that is attached to the specified Amazon Lookout for Vision model.

" - } - }, - "com.amazonaws.lookoutvision#TagArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1011 - } - } - }, - "com.amazonaws.lookoutvision#TagKey": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - }, - "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" - } - }, - "com.amazonaws.lookoutvision#TagKeyList": { - "type": "list", - "member": { - "target": "com.amazonaws.lookoutvision#TagKey" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 200 - } - } - }, - "com.amazonaws.lookoutvision#TagList": { - "type": "list", - "member": { - "target": "com.amazonaws.lookoutvision#Tag" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 200 - } - } - }, - "com.amazonaws.lookoutvision#TagResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.lookoutvision#TagResourceRequest" - }, - "output": { - "target": "com.amazonaws.lookoutvision#TagResourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.lookoutvision#AccessDeniedException" - }, - { - "target": "com.amazonaws.lookoutvision#ConflictException" - }, - { - "target": "com.amazonaws.lookoutvision#InternalServerException" - }, - { - "target": "com.amazonaws.lookoutvision#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.lookoutvision#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.lookoutvision#ThrottlingException" - }, - { - "target": "com.amazonaws.lookoutvision#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Adds one or more key-value tags to an Amazon Lookout for Vision model. \n For more information, see Tagging a model in the Amazon Lookout for Vision Developer Guide.

\n

This operation requires permissions to perform the\n lookoutvision:TagResource operation.

", - "smithy.api#http": { - "method": "POST", - "uri": "/2020-11-20/tags/{ResourceArn}", - "code": 200 - } - } - }, - "com.amazonaws.lookoutvision#TagResourceRequest": { - "type": "structure", - "members": { - "ResourceArn": { - "target": "com.amazonaws.lookoutvision#TagArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the model to assign the tags.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.lookoutvision#TagList", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The key-value tags to assign to the model.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lookoutvision#TagResourceResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.lookoutvision#TagValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - }, - "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" - } - }, - "com.amazonaws.lookoutvision#TargetDevice": { - "type": "enum", - "members": { - "JETSON_XAVIER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "jetson_xavier" - } - } - } - }, - "com.amazonaws.lookoutvision#TargetPlatform": { - "type": "structure", - "members": { - "Os": { - "target": "com.amazonaws.lookoutvision#TargetPlatformOs", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The target operating system for the model. Linux is the only operating system\n that is currently supported.\n

", - "smithy.api#required": {} - } - }, - "Arch": { - "target": "com.amazonaws.lookoutvision#TargetPlatformArch", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The target architecture for the model. The currently supported architectures are\n X86_64 (64-bit version of the x86 instruction set) and ARM_64 (ARMv8 64-bit CPU).\n

", - "smithy.api#required": {} - } - }, - "Accelerator": { - "target": "com.amazonaws.lookoutvision#TargetPlatformAccelerator", - "traits": { - "smithy.api#documentation": "

The target accelerator for the model. Currently, Amazon Lookout for Vision only supports NVIDIA (Nvidia graphics processing unit) \n and CPU accelerators. If you specify NVIDIA as an accelerator, you must also specify the gpu-code, trt-ver,\n and cuda-ver compiler options. If you don't specify an accelerator, Lookout for Vision uses the CPU for compilation and we highly recommend that you use the\n GreengrassConfiguration$CompilerOptions field. For example, you can use the following compiler options for CPU:

\n " - } - } - }, - "traits": { - "smithy.api#documentation": "

The platform on which a model runs on an AWS IoT Greengrass core device.

" - } - }, - "com.amazonaws.lookoutvision#TargetPlatformAccelerator": { - "type": "enum", - "members": { - "NVIDIA": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NVIDIA" - } - } - } - }, - "com.amazonaws.lookoutvision#TargetPlatformArch": { - "type": "enum", - "members": { - "ARM64": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ARM64" - } - }, - "X86_64": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "X86_64" - } - } - } - }, - "com.amazonaws.lookoutvision#TargetPlatformOs": { - "type": "enum", - "members": { - "LINUX": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LINUX" - } - } - } - }, - "com.amazonaws.lookoutvision#ThrottlingException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.lookoutvision#ExceptionString", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#required": {} - } - }, - "QuotaCode": { - "target": "com.amazonaws.lookoutvision#ExceptionString", - "traits": { - "smithy.api#documentation": "

The quota code.

" - } - }, - "ServiceCode": { - "target": "com.amazonaws.lookoutvision#ExceptionString", - "traits": { - "smithy.api#documentation": "

The service code.

" - } - }, - "RetryAfterSeconds": { - "target": "com.amazonaws.lookoutvision#RetryAfterSeconds", - "traits": { - "smithy.api#documentation": "

The period of time, in seconds, before the operation can be retried.

", - "smithy.api#httpHeader": "Retry-After" - } - } - }, - "traits": { - "smithy.api#documentation": "

Amazon Lookout for Vision is temporarily unable to process the request. Try your call again.

", - "smithy.api#error": "client", - "smithy.api#httpError": 429 - } - }, - "com.amazonaws.lookoutvision#UntagResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.lookoutvision#UntagResourceRequest" - }, - "output": { - "target": "com.amazonaws.lookoutvision#UntagResourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.lookoutvision#AccessDeniedException" - }, - { - "target": "com.amazonaws.lookoutvision#ConflictException" - }, - { - "target": "com.amazonaws.lookoutvision#InternalServerException" - }, - { - "target": "com.amazonaws.lookoutvision#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.lookoutvision#ThrottlingException" - }, - { - "target": "com.amazonaws.lookoutvision#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Removes one or more tags from an Amazon Lookout for Vision model. For more information, see \n Tagging a model in the Amazon Lookout for Vision Developer Guide.

\n

This operation requires permissions to perform the\n lookoutvision:UntagResource operation.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/2020-11-20/tags/{ResourceArn}", - "code": 200 - } - } - }, - "com.amazonaws.lookoutvision#UntagResourceRequest": { - "type": "structure", - "members": { - "ResourceArn": { - "target": "com.amazonaws.lookoutvision#TagArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the model from which you want to remove tags.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "TagKeys": { - "target": "com.amazonaws.lookoutvision#TagKeyList", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

A list of the keys of the tags that you want to remove.

", - "smithy.api#httpQuery": "tagKeys", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lookoutvision#UntagResourceResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.lookoutvision#UpdateDatasetEntries": { - "type": "operation", - "input": { - "target": "com.amazonaws.lookoutvision#UpdateDatasetEntriesRequest" - }, - "output": { - "target": "com.amazonaws.lookoutvision#UpdateDatasetEntriesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.lookoutvision#AccessDeniedException" - }, - { - "target": "com.amazonaws.lookoutvision#ConflictException" - }, - { - "target": "com.amazonaws.lookoutvision#InternalServerException" - }, - { - "target": "com.amazonaws.lookoutvision#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.lookoutvision#ThrottlingException" - }, - { - "target": "com.amazonaws.lookoutvision#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Adds or updates one or more JSON Line entries in a dataset. A JSON Line includes information about an image\n used for training or testing an Amazon Lookout for Vision model.

\n

To update an existing JSON Line, use the source-ref field to identify the JSON Line. The JSON line\n that you supply replaces the existing JSON line. Any existing annotations that are not in the new JSON line are removed from the dataset.\n

\n

For more information, see \n Defining JSON lines for anomaly classification in the Amazon Lookout for Vision Developer Guide.

\n \n

The images you reference in the source-ref field of a JSON line, must be \n in the same S3 bucket as the existing images in the dataset.

\n \n

Updating a dataset might take a while to complete. To check the current status, call DescribeDataset and\n check the Status field in the response.

\n

This operation requires permissions to perform the\n lookoutvision:UpdateDatasetEntries operation.

", - "smithy.api#http": { - "method": "PATCH", - "uri": "/2020-11-20/projects/{ProjectName}/datasets/{DatasetType}/entries", - "code": 202 - } - } - }, - "com.amazonaws.lookoutvision#UpdateDatasetEntriesRequest": { - "type": "structure", - "members": { - "ProjectName": { - "target": "com.amazonaws.lookoutvision#ProjectName", - "traits": { - "smithy.api#documentation": "

The name of the project that contains the dataset that you want to update.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "DatasetType": { - "target": "com.amazonaws.lookoutvision#DatasetType", - "traits": { - "smithy.api#documentation": "

The type of the dataset that you want to update. Specify train to update\n the training dataset. Specify test to update the test dataset. If you\n have a single dataset project, specify train.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Changes": { - "target": "com.amazonaws.lookoutvision#DatasetChanges", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The entries to add to the dataset.

", - "smithy.api#required": {} - } - }, - "ClientToken": { - "target": "com.amazonaws.lookoutvision#ClientToken", - "traits": { - "smithy.api#documentation": "

ClientToken is an idempotency token that ensures a call to UpdateDatasetEntries\n completes only once. You choose the value to pass. For example, An issue \n might prevent you from getting a response from UpdateDatasetEntries.\n In this case, safely retry your call\n to UpdateDatasetEntries by using the same ClientToken parameter value.

\n

If you don't supply a value for ClientToken, the AWS SDK you are using inserts a value for you. \n This prevents retries after a network error from making multiple updates with the same dataset entries. You'll need to\n provide your own value for other use cases.

\n

An error occurs\n if the other input parameters are not the same as in the first request. Using a different \n value for ClientToken is considered a new call to UpdateDatasetEntries. An idempotency\n token is active for 8 hours.\n

", - "smithy.api#httpHeader": "X-Amzn-Client-Token", - "smithy.api#idempotencyToken": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lookoutvision#UpdateDatasetEntriesResponse": { - "type": "structure", - "members": { - "Status": { - "target": "com.amazonaws.lookoutvision#DatasetStatus", - "traits": { - "smithy.api#documentation": "

The status of the dataset update.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.lookoutvision#ValidationException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.lookoutvision#ExceptionString", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

An input validation error occured. For example, invalid characters in a project name,\n or if a pagination token is invalid.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - } - } -} \ No newline at end of file diff --git a/models/qldb-session/service/2019-07-11/qldb-session-2019-07-11.json b/models/qldb-session/service/2019-07-11/qldb-session-2019-07-11.json deleted file mode 100644 index bf31e89f..00000000 --- a/models/qldb-session/service/2019-07-11/qldb-session-2019-07-11.json +++ /dev/null @@ -1,1457 +0,0 @@ -{ - "smithy": "2.0", - "metadata": { - "suppressions": [ - { - "id": "HttpMethodSemantics", - "namespace": "*" - }, - { - "id": "HttpResponseCodeSemantics", - "namespace": "*" - }, - { - "id": "PaginatedTrait", - "namespace": "*" - }, - { - "id": "HttpHeaderTrait", - "namespace": "*" - }, - { - "id": "HttpUriConflict", - "namespace": "*" - }, - { - "id": "Service", - "namespace": "*" - } - ] - }, - "shapes": { - "com.amazonaws.qldbsession#AbortTransactionRequest": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#documentation": "

Contains the details of the transaction to abort.

" - } - }, - "com.amazonaws.qldbsession#AbortTransactionResult": { - "type": "structure", - "members": { - "TimingInformation": { - "target": "com.amazonaws.qldbsession#TimingInformation", - "traits": { - "smithy.api#documentation": "

Contains server-side performance information for the command.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the details of the aborted transaction.

" - } - }, - "com.amazonaws.qldbsession#BadRequestException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.qldbsession#ErrorMessage" - }, - "Code": { - "target": "com.amazonaws.qldbsession#ErrorCode" - } - }, - "traits": { - "smithy.api#documentation": "

Returned if the request is malformed or contains an error such as an invalid parameter\n value or a missing required parameter.

", - "smithy.api#error": "client" - } - }, - "com.amazonaws.qldbsession#CapacityExceededException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.qldbsession#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "

Returned when the request exceeds the processing capacity of the ledger.

", - "smithy.api#error": "server", - "smithy.api#httpError": 503 - } - }, - "com.amazonaws.qldbsession#CommitDigest": { - "type": "blob" - }, - "com.amazonaws.qldbsession#CommitTransactionRequest": { - "type": "structure", - "members": { - "TransactionId": { - "target": "com.amazonaws.qldbsession#TransactionId", - "traits": { - "smithy.api#documentation": "

Specifies the transaction ID of the transaction to commit.

", - "smithy.api#required": {} - } - }, - "CommitDigest": { - "target": "com.amazonaws.qldbsession#CommitDigest", - "traits": { - "smithy.api#documentation": "

Specifies the commit digest for the transaction to commit. For every active transaction,\n the commit digest must be passed. QLDB validates CommitDigest and rejects\n the commit with an error if the digest computed on the client does not match the digest\n computed by QLDB.

\n

The purpose of the CommitDigest parameter is to ensure that QLDB commits\n a transaction if and only if the server has processed the exact set of statements sent by\n the client, in the same order that client sent them, and with no duplicates.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the details of the transaction to commit.

" - } - }, - "com.amazonaws.qldbsession#CommitTransactionResult": { - "type": "structure", - "members": { - "TransactionId": { - "target": "com.amazonaws.qldbsession#TransactionId", - "traits": { - "smithy.api#documentation": "

The transaction ID of the committed transaction.

" - } - }, - "CommitDigest": { - "target": "com.amazonaws.qldbsession#CommitDigest", - "traits": { - "smithy.api#documentation": "

The commit digest of the committed transaction.

" - } - }, - "TimingInformation": { - "target": "com.amazonaws.qldbsession#TimingInformation", - "traits": { - "smithy.api#documentation": "

Contains server-side performance information for the command.

" - } - }, - "ConsumedIOs": { - "target": "com.amazonaws.qldbsession#IOUsage", - "traits": { - "smithy.api#documentation": "

Contains metrics about the number of I/O requests that were consumed.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the details of the committed transaction.

" - } - }, - "com.amazonaws.qldbsession#EndSessionRequest": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#documentation": "

Specifies a request to end the session.

" - } - }, - "com.amazonaws.qldbsession#EndSessionResult": { - "type": "structure", - "members": { - "TimingInformation": { - "target": "com.amazonaws.qldbsession#TimingInformation", - "traits": { - "smithy.api#documentation": "

Contains server-side performance information for the command.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the details of the ended session.

" - } - }, - "com.amazonaws.qldbsession#ErrorCode": { - "type": "string" - }, - "com.amazonaws.qldbsession#ErrorMessage": { - "type": "string" - }, - "com.amazonaws.qldbsession#ExecuteStatementRequest": { - "type": "structure", - "members": { - "TransactionId": { - "target": "com.amazonaws.qldbsession#TransactionId", - "traits": { - "smithy.api#documentation": "

Specifies the transaction ID of the request.

", - "smithy.api#required": {} - } - }, - "Statement": { - "target": "com.amazonaws.qldbsession#Statement", - "traits": { - "smithy.api#documentation": "

Specifies the statement of the request.

", - "smithy.api#required": {} - } - }, - "Parameters": { - "target": "com.amazonaws.qldbsession#StatementParameters", - "traits": { - "smithy.api#documentation": "

Specifies the parameters for the parameterized statement in the request.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Specifies a request to execute a statement.

" - } - }, - "com.amazonaws.qldbsession#ExecuteStatementResult": { - "type": "structure", - "members": { - "FirstPage": { - "target": "com.amazonaws.qldbsession#Page", - "traits": { - "smithy.api#documentation": "

Contains the details of the first fetched page.

" - } - }, - "TimingInformation": { - "target": "com.amazonaws.qldbsession#TimingInformation", - "traits": { - "smithy.api#documentation": "

Contains server-side performance information for the command.

" - } - }, - "ConsumedIOs": { - "target": "com.amazonaws.qldbsession#IOUsage", - "traits": { - "smithy.api#documentation": "

Contains metrics about the number of I/O requests that were consumed.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the details of the executed statement.

" - } - }, - "com.amazonaws.qldbsession#FetchPageRequest": { - "type": "structure", - "members": { - "TransactionId": { - "target": "com.amazonaws.qldbsession#TransactionId", - "traits": { - "smithy.api#documentation": "

Specifies the transaction ID of the page to be fetched.

", - "smithy.api#required": {} - } - }, - "NextPageToken": { - "target": "com.amazonaws.qldbsession#PageToken", - "traits": { - "smithy.api#documentation": "

Specifies the next page token of the page to be fetched.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Specifies the details of the page to be fetched.

" - } - }, - "com.amazonaws.qldbsession#FetchPageResult": { - "type": "structure", - "members": { - "Page": { - "target": "com.amazonaws.qldbsession#Page", - "traits": { - "smithy.api#documentation": "

Contains details of the fetched page.

" - } - }, - "TimingInformation": { - "target": "com.amazonaws.qldbsession#TimingInformation", - "traits": { - "smithy.api#documentation": "

Contains server-side performance information for the command.

" - } - }, - "ConsumedIOs": { - "target": "com.amazonaws.qldbsession#IOUsage", - "traits": { - "smithy.api#documentation": "

Contains metrics about the number of I/O requests that were consumed.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the page that was fetched.

" - } - }, - "com.amazonaws.qldbsession#IOUsage": { - "type": "structure", - "members": { - "ReadIOs": { - "target": "com.amazonaws.qldbsession#ReadIOs", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of read I/O requests that the command made.

" - } - }, - "WriteIOs": { - "target": "com.amazonaws.qldbsession#WriteIOs", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of write I/O requests that the command made.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains I/O usage metrics for a command that was invoked.

" - } - }, - "com.amazonaws.qldbsession#InvalidSessionException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.qldbsession#ErrorMessage" - }, - "Code": { - "target": "com.amazonaws.qldbsession#ErrorCode" - } - }, - "traits": { - "smithy.api#documentation": "

Returned if the session doesn't exist anymore because it timed out or expired.

", - "smithy.api#error": "client" - } - }, - "com.amazonaws.qldbsession#IonBinary": { - "type": "blob", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 131072 - } - } - }, - "com.amazonaws.qldbsession#IonText": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1048576 - } - } - }, - "com.amazonaws.qldbsession#LedgerName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 32 - }, - "smithy.api#pattern": "^(?!^.*--)(?!^[0-9]+$)(?!^-)(?!.*-$)^[A-Za-z0-9-]+$" - } - }, - "com.amazonaws.qldbsession#LimitExceededException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.qldbsession#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "

Returned if a resource limit such as number of active sessions is exceeded.

", - "smithy.api#error": "client" - } - }, - "com.amazonaws.qldbsession#OccConflictException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.qldbsession#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "

Returned when a transaction cannot be written to the journal due to a failure in the\n verification phase of optimistic concurrency control (OCC).

", - "smithy.api#error": "client" - } - }, - "com.amazonaws.qldbsession#Page": { - "type": "structure", - "members": { - "Values": { - "target": "com.amazonaws.qldbsession#ValueHolders", - "traits": { - "smithy.api#documentation": "

A structure that contains values in multiple encoding formats.

" - } - }, - "NextPageToken": { - "target": "com.amazonaws.qldbsession#PageToken", - "traits": { - "smithy.api#documentation": "

The token of the next page.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains details of the fetched page.

" - } - }, - "com.amazonaws.qldbsession#PageToken": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 4, - "max": 1024 - }, - "smithy.api#pattern": "^[A-Za-z-0-9+/=]+$" - } - }, - "com.amazonaws.qldbsession#ProcessingTimeMilliseconds": { - "type": "long", - "traits": { - "smithy.api#default": 0 - } - }, - "com.amazonaws.qldbsession#QLDBSession": { - "type": "service", - "version": "2019-07-11", - "operations": [ - { - "target": "com.amazonaws.qldbsession#SendCommand" - } - ], - "traits": { - "aws.api#service": { - "sdkId": "QLDB Session", - "arnNamespace": "qldb", - "cloudFormationName": "QLDBSession", - "cloudTrailEventSource": "qldbsession.amazonaws.com", - "endpointPrefix": "session.qldb" - }, - "aws.auth#sigv4": { - "name": "qldb" - }, - "aws.protocols#awsJson1_0": {}, - "smithy.api#documentation": "

The transactional data APIs for Amazon QLDB

\n \n

Instead of interacting directly with this API, we recommend using the QLDB driver\n or the QLDB shell to execute data transactions on a ledger.

\n \n ", - "smithy.api#title": "Amazon QLDB Session", - "smithy.rules#endpointRuleSet": { - "version": "1.0", - "parameters": { - "Region": { - "builtIn": "AWS::Region", - "required": false, - "documentation": "The AWS region used to dispatch the request.", - "type": "string" - }, - "UseDualStack": { - "builtIn": "AWS::UseDualStack", - "required": true, - "default": false, - "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", - "type": "boolean" - }, - "UseFIPS": { - "builtIn": "AWS::UseFIPS", - "required": true, - "default": false, - "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", - "type": "boolean" - }, - "Endpoint": { - "builtIn": "SDK::Endpoint", - "required": false, - "documentation": "Override the endpoint used to send this request", - "type": "string" - } - }, - "rules": [ - { - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Endpoint" - } - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "error": "Invalid Configuration: FIPS and custom endpoint are not supported", - "type": "error" - }, - { - "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" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Region" - } - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "aws.partition", - "argv": [ - { - "ref": "Region" - } - ], - "assign": "PartitionResult" - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - }, - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://session.qldb-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - }, - true - ] - } - ], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://session.qldb-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://session.qldb.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [], - "endpoint": { - "url": "https://session.qldb.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" - } - ] - }, - "smithy.rules#endpointTests": { - "testCases": [ - { - "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://session.qldb.ap-northeast-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-northeast-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://session.qldb.ap-northeast-2.amazonaws.com" - } - }, - "params": { - "Region": "ap-northeast-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://session.qldb.ap-southeast-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-southeast-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://session.qldb.ap-southeast-2.amazonaws.com" - } - }, - "params": { - "Region": "ap-southeast-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://session.qldb.ca-central-1.amazonaws.com" - } - }, - "params": { - "Region": "ca-central-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://session.qldb.eu-central-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-central-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://session.qldb.eu-west-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-west-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://session.qldb.eu-west-2.amazonaws.com" - } - }, - "params": { - "Region": "eu-west-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://session.qldb.us-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://session.qldb-fips.us-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://session.qldb.us-east-2.amazonaws.com" - } - }, - "params": { - "Region": "us-east-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-2 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://session.qldb-fips.us-east-2.amazonaws.com" - } - }, - "params": { - "Region": "us-east-2", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://session.qldb.us-west-2.amazonaws.com" - } - }, - "params": { - "Region": "us-west-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-west-2 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://session.qldb-fips.us-west-2.amazonaws.com" - } - }, - "params": { - "Region": "us-west-2", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://session.qldb-fips.us-east-1.api.aws" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://session.qldb.us-east-1.api.aws" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://session.qldb-fips.cn-north-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://session.qldb-fips.cn-north-1.amazonaws.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://session.qldb.cn-north-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://session.qldb.cn-north-1.amazonaws.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://session.qldb-fips.us-gov-east-1.api.aws" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://session.qldb-fips.us-gov-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://session.qldb.us-gov-east-1.api.aws" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://session.qldb.us-gov-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://session.qldb-fips.us-iso-east-1.c2s.ic.gov" - } - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://session.qldb.us-iso-east-1.c2s.ic.gov" - } - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://session.qldb-fips.us-isob-east-1.sc2s.sgov.gov" - } - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://session.qldb.us-isob-east-1.sc2s.sgov.gov" - } - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", - "expect": { - "endpoint": { - "url": "https://example.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": false, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", - "expect": { - "endpoint": { - "url": "https://example.com" - } - }, - "params": { - "UseFIPS": false, - "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": { - "Region": "us-east-1", - "UseFIPS": true, - "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": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": true, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "Missing region", - "expect": { - "error": "Invalid Configuration: Missing Region" - } - } - ], - "version": "1.0" - } - } - }, - "com.amazonaws.qldbsession#RateExceededException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.qldbsession#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "

Returned when the rate of requests exceeds the allowed throughput.

", - "smithy.api#error": "client" - } - }, - "com.amazonaws.qldbsession#ReadIOs": { - "type": "long", - "traits": { - "smithy.api#default": 0 - } - }, - "com.amazonaws.qldbsession#SendCommand": { - "type": "operation", - "input": { - "target": "com.amazonaws.qldbsession#SendCommandRequest" - }, - "output": { - "target": "com.amazonaws.qldbsession#SendCommandResult" - }, - "errors": [ - { - "target": "com.amazonaws.qldbsession#BadRequestException" - }, - { - "target": "com.amazonaws.qldbsession#CapacityExceededException" - }, - { - "target": "com.amazonaws.qldbsession#InvalidSessionException" - }, - { - "target": "com.amazonaws.qldbsession#LimitExceededException" - }, - { - "target": "com.amazonaws.qldbsession#OccConflictException" - }, - { - "target": "com.amazonaws.qldbsession#RateExceededException" - } - ], - "traits": { - "smithy.api#documentation": "

Sends a command to an Amazon QLDB ledger.

\n \n

Instead of interacting directly with this API, we recommend using the QLDB driver\n or the QLDB shell to execute data transactions on a ledger.

\n \n " - } - }, - "com.amazonaws.qldbsession#SendCommandRequest": { - "type": "structure", - "members": { - "SessionToken": { - "target": "com.amazonaws.qldbsession#SessionToken", - "traits": { - "smithy.api#documentation": "

Specifies the session token for the current command. A session token is constant\n throughout the life of the session.

\n

To obtain a session token, run the StartSession command. This\n SessionToken is required for every subsequent command that is issued during\n the current session.

" - } - }, - "StartSession": { - "target": "com.amazonaws.qldbsession#StartSessionRequest", - "traits": { - "smithy.api#documentation": "

Command to start a new session. A session token is obtained as part of the\n response.

" - } - }, - "StartTransaction": { - "target": "com.amazonaws.qldbsession#StartTransactionRequest", - "traits": { - "smithy.api#documentation": "

Command to start a new transaction.

" - } - }, - "EndSession": { - "target": "com.amazonaws.qldbsession#EndSessionRequest", - "traits": { - "smithy.api#documentation": "

Command to end the current session.

" - } - }, - "CommitTransaction": { - "target": "com.amazonaws.qldbsession#CommitTransactionRequest", - "traits": { - "smithy.api#documentation": "

Command to commit the specified transaction.

" - } - }, - "AbortTransaction": { - "target": "com.amazonaws.qldbsession#AbortTransactionRequest", - "traits": { - "smithy.api#documentation": "

Command to abort the current transaction.

" - } - }, - "ExecuteStatement": { - "target": "com.amazonaws.qldbsession#ExecuteStatementRequest", - "traits": { - "smithy.api#documentation": "

Command to execute a statement in the specified transaction.

" - } - }, - "FetchPage": { - "target": "com.amazonaws.qldbsession#FetchPageRequest", - "traits": { - "smithy.api#documentation": "

Command to fetch a page.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.qldbsession#SendCommandResult": { - "type": "structure", - "members": { - "StartSession": { - "target": "com.amazonaws.qldbsession#StartSessionResult", - "traits": { - "smithy.api#documentation": "

Contains the details of the started session that includes a session token. This\n SessionToken is required for every subsequent command that is issued during\n the current session.

" - } - }, - "StartTransaction": { - "target": "com.amazonaws.qldbsession#StartTransactionResult", - "traits": { - "smithy.api#documentation": "

Contains the details of the started transaction.

" - } - }, - "EndSession": { - "target": "com.amazonaws.qldbsession#EndSessionResult", - "traits": { - "smithy.api#documentation": "

Contains the details of the ended session.

" - } - }, - "CommitTransaction": { - "target": "com.amazonaws.qldbsession#CommitTransactionResult", - "traits": { - "smithy.api#documentation": "

Contains the details of the committed transaction.

" - } - }, - "AbortTransaction": { - "target": "com.amazonaws.qldbsession#AbortTransactionResult", - "traits": { - "smithy.api#documentation": "

Contains the details of the aborted transaction.

" - } - }, - "ExecuteStatement": { - "target": "com.amazonaws.qldbsession#ExecuteStatementResult", - "traits": { - "smithy.api#documentation": "

Contains the details of the executed statement.

" - } - }, - "FetchPage": { - "target": "com.amazonaws.qldbsession#FetchPageResult", - "traits": { - "smithy.api#documentation": "

Contains the details of the fetched page.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.qldbsession#SessionToken": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 4, - "max": 1024 - }, - "smithy.api#pattern": "^[A-Za-z-0-9+/=]+$" - } - }, - "com.amazonaws.qldbsession#StartSessionRequest": { - "type": "structure", - "members": { - "LedgerName": { - "target": "com.amazonaws.qldbsession#LedgerName", - "traits": { - "smithy.api#documentation": "

The name of the ledger to start a new session against.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Specifies a request to start a new session.

" - } - }, - "com.amazonaws.qldbsession#StartSessionResult": { - "type": "structure", - "members": { - "SessionToken": { - "target": "com.amazonaws.qldbsession#SessionToken", - "traits": { - "smithy.api#documentation": "

Session token of the started session. This SessionToken is required for\n every subsequent command that is issued during the current session.

" - } - }, - "TimingInformation": { - "target": "com.amazonaws.qldbsession#TimingInformation", - "traits": { - "smithy.api#documentation": "

Contains server-side performance information for the command.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the details of the started session.

" - } - }, - "com.amazonaws.qldbsession#StartTransactionRequest": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#documentation": "

Specifies a request to start a transaction.

" - } - }, - "com.amazonaws.qldbsession#StartTransactionResult": { - "type": "structure", - "members": { - "TransactionId": { - "target": "com.amazonaws.qldbsession#TransactionId", - "traits": { - "smithy.api#documentation": "

The transaction ID of the started transaction.

" - } - }, - "TimingInformation": { - "target": "com.amazonaws.qldbsession#TimingInformation", - "traits": { - "smithy.api#documentation": "

Contains server-side performance information for the command.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the details of the started transaction.

" - } - }, - "com.amazonaws.qldbsession#Statement": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 100000 - } - } - }, - "com.amazonaws.qldbsession#StatementParameters": { - "type": "list", - "member": { - "target": "com.amazonaws.qldbsession#ValueHolder" - } - }, - "com.amazonaws.qldbsession#TimingInformation": { - "type": "structure", - "members": { - "ProcessingTimeMilliseconds": { - "target": "com.amazonaws.qldbsession#ProcessingTimeMilliseconds", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The amount of time that QLDB spent on processing the command, measured in\n milliseconds.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains server-side performance information for a command. Amazon QLDB captures timing\n information between the times when it receives the request and when it sends the\n corresponding response.

" - } - }, - "com.amazonaws.qldbsession#TransactionId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 22, - "max": 22 - }, - "smithy.api#pattern": "^[A-Za-z-0-9]+$" - } - }, - "com.amazonaws.qldbsession#ValueHolder": { - "type": "structure", - "members": { - "IonBinary": { - "target": "com.amazonaws.qldbsession#IonBinary", - "traits": { - "smithy.api#documentation": "

An Amazon Ion binary value contained in a ValueHolder structure.

" - } - }, - "IonText": { - "target": "com.amazonaws.qldbsession#IonText", - "traits": { - "smithy.api#documentation": "

An Amazon Ion plaintext value contained in a ValueHolder structure.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A structure that can contain a value in multiple encoding formats.

" - } - }, - "com.amazonaws.qldbsession#ValueHolders": { - "type": "list", - "member": { - "target": "com.amazonaws.qldbsession#ValueHolder" - } - }, - "com.amazonaws.qldbsession#WriteIOs": { - "type": "long", - "traits": { - "smithy.api#default": 0 - } - } - } -} \ No newline at end of file diff --git a/models/qldb/service/2019-01-02/qldb-2019-01-02.json b/models/qldb/service/2019-01-02/qldb-2019-01-02.json deleted file mode 100644 index 3a522651..00000000 --- a/models/qldb/service/2019-01-02/qldb-2019-01-02.json +++ /dev/null @@ -1,3166 +0,0 @@ -{ - "smithy": "2.0", - "metadata": { - "suppressions": [ - { - "id": "HttpMethodSemantics", - "namespace": "*" - }, - { - "id": "HttpResponseCodeSemantics", - "namespace": "*" - }, - { - "id": "PaginatedTrait", - "namespace": "*" - }, - { - "id": "HttpHeaderTrait", - "namespace": "*" - }, - { - "id": "HttpUriConflict", - "namespace": "*" - }, - { - "id": "Service", - "namespace": "*" - } - ] - }, - "shapes": { - "com.amazonaws.qldb#AmazonQLDB": { - "type": "service", - "version": "2019-01-02", - "operations": [ - { - "target": "com.amazonaws.qldb#CancelJournalKinesisStream" - }, - { - "target": "com.amazonaws.qldb#CreateLedger" - }, - { - "target": "com.amazonaws.qldb#DeleteLedger" - }, - { - "target": "com.amazonaws.qldb#DescribeJournalKinesisStream" - }, - { - "target": "com.amazonaws.qldb#DescribeJournalS3Export" - }, - { - "target": "com.amazonaws.qldb#DescribeLedger" - }, - { - "target": "com.amazonaws.qldb#ExportJournalToS3" - }, - { - "target": "com.amazonaws.qldb#GetBlock" - }, - { - "target": "com.amazonaws.qldb#GetDigest" - }, - { - "target": "com.amazonaws.qldb#GetRevision" - }, - { - "target": "com.amazonaws.qldb#ListJournalKinesisStreamsForLedger" - }, - { - "target": "com.amazonaws.qldb#ListJournalS3Exports" - }, - { - "target": "com.amazonaws.qldb#ListJournalS3ExportsForLedger" - }, - { - "target": "com.amazonaws.qldb#ListLedgers" - }, - { - "target": "com.amazonaws.qldb#ListTagsForResource" - }, - { - "target": "com.amazonaws.qldb#StreamJournalToKinesis" - }, - { - "target": "com.amazonaws.qldb#TagResource" - }, - { - "target": "com.amazonaws.qldb#UntagResource" - }, - { - "target": "com.amazonaws.qldb#UpdateLedger" - }, - { - "target": "com.amazonaws.qldb#UpdateLedgerPermissionsMode" - } - ], - "traits": { - "aws.api#service": { - "sdkId": "QLDB", - "arnNamespace": "qldb", - "cloudFormationName": "QLDB", - "cloudTrailEventSource": "qldb.amazonaws.com", - "endpointPrefix": "qldb" - }, - "aws.auth#sigv4": { - "name": "qldb" - }, - "aws.protocols#restJson1": {}, - "smithy.api#documentation": "

The resource management API for Amazon QLDB

", - "smithy.api#title": "Amazon QLDB", - "smithy.api#xmlNamespace": { - "uri": "http://ledger.amazonaws.com/doc/2019-01-02/" - }, - "smithy.rules#endpointRuleSet": { - "version": "1.0", - "parameters": { - "Region": { - "builtIn": "AWS::Region", - "required": false, - "documentation": "The AWS region used to dispatch the request.", - "type": "string" - }, - "UseDualStack": { - "builtIn": "AWS::UseDualStack", - "required": true, - "default": false, - "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", - "type": "boolean" - }, - "UseFIPS": { - "builtIn": "AWS::UseFIPS", - "required": true, - "default": false, - "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", - "type": "boolean" - }, - "Endpoint": { - "builtIn": "SDK::Endpoint", - "required": false, - "documentation": "Override the endpoint used to send this request", - "type": "string" - } - }, - "rules": [ - { - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Endpoint" - } - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "error": "Invalid Configuration: FIPS and custom endpoint are not supported", - "type": "error" - }, - { - "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" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Region" - } - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "aws.partition", - "argv": [ - { - "ref": "Region" - } - ], - "assign": "PartitionResult" - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - }, - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://qldb-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - }, - true - ] - } - ], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://qldb-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://qldb.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [], - "endpoint": { - "url": "https://qldb.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" - } - ] - }, - "smithy.rules#endpointTests": { - "testCases": [ - { - "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://qldb.ap-northeast-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-northeast-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://qldb.ap-northeast-2.amazonaws.com" - } - }, - "params": { - "Region": "ap-northeast-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://qldb.ap-southeast-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-southeast-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://qldb.ap-southeast-2.amazonaws.com" - } - }, - "params": { - "Region": "ap-southeast-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://qldb.ca-central-1.amazonaws.com" - } - }, - "params": { - "Region": "ca-central-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ca-central-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://qldb-fips.ca-central-1.amazonaws.com" - } - }, - "params": { - "Region": "ca-central-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://qldb.eu-central-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-central-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://qldb.eu-west-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-west-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://qldb.eu-west-2.amazonaws.com" - } - }, - "params": { - "Region": "eu-west-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://qldb.us-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://qldb-fips.us-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://qldb.us-east-2.amazonaws.com" - } - }, - "params": { - "Region": "us-east-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-2 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://qldb-fips.us-east-2.amazonaws.com" - } - }, - "params": { - "Region": "us-east-2", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://qldb.us-west-2.amazonaws.com" - } - }, - "params": { - "Region": "us-west-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-west-2 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://qldb-fips.us-west-2.amazonaws.com" - } - }, - "params": { - "Region": "us-west-2", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://qldb-fips.us-east-1.api.aws" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://qldb.us-east-1.api.aws" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://qldb-fips.cn-north-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://qldb-fips.cn-north-1.amazonaws.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://qldb.cn-north-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://qldb.cn-north-1.amazonaws.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://qldb-fips.us-gov-east-1.api.aws" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://qldb-fips.us-gov-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://qldb.us-gov-east-1.api.aws" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://qldb.us-gov-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://qldb-fips.us-iso-east-1.c2s.ic.gov" - } - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://qldb.us-iso-east-1.c2s.ic.gov" - } - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://qldb-fips.us-isob-east-1.sc2s.sgov.gov" - } - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://qldb.us-isob-east-1.sc2s.sgov.gov" - } - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", - "expect": { - "endpoint": { - "url": "https://example.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": false, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", - "expect": { - "endpoint": { - "url": "https://example.com" - } - }, - "params": { - "UseFIPS": false, - "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": { - "Region": "us-east-1", - "UseFIPS": true, - "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": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": true, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "Missing region", - "expect": { - "error": "Invalid Configuration: Missing Region" - } - } - ], - "version": "1.0" - } - } - }, - "com.amazonaws.qldb#Arn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 20, - "max": 1600 - } - } - }, - "com.amazonaws.qldb#Boolean": { - "type": "boolean" - }, - "com.amazonaws.qldb#CancelJournalKinesisStream": { - "type": "operation", - "input": { - "target": "com.amazonaws.qldb#CancelJournalKinesisStreamRequest" - }, - "output": { - "target": "com.amazonaws.qldb#CancelJournalKinesisStreamResponse" - }, - "errors": [ - { - "target": "com.amazonaws.qldb#InvalidParameterException" - }, - { - "target": "com.amazonaws.qldb#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.qldb#ResourcePreconditionNotMetException" - } - ], - "traits": { - "smithy.api#documentation": "

Ends a given Amazon QLDB journal stream. Before a stream can be canceled, its current\n status must be ACTIVE.

\n

You can't restart a stream after you cancel it. Canceled QLDB stream resources are\n subject to a 7-day retention period, so they are automatically deleted after this limit\n expires.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/ledgers/{LedgerName}/journal-kinesis-streams/{StreamId}", - "code": 200 - } - } - }, - "com.amazonaws.qldb#CancelJournalKinesisStreamRequest": { - "type": "structure", - "members": { - "LedgerName": { - "target": "com.amazonaws.qldb#LedgerName", - "traits": { - "smithy.api#documentation": "

The name of the ledger.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "StreamId": { - "target": "com.amazonaws.qldb#UniqueId", - "traits": { - "smithy.api#documentation": "

The UUID (represented in Base62-encoded text) of the QLDB journal stream to be\n canceled.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.qldb#CancelJournalKinesisStreamResponse": { - "type": "structure", - "members": { - "StreamId": { - "target": "com.amazonaws.qldb#UniqueId", - "traits": { - "smithy.api#documentation": "

The UUID (Base62-encoded text) of the canceled QLDB journal stream.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.qldb#CreateLedger": { - "type": "operation", - "input": { - "target": "com.amazonaws.qldb#CreateLedgerRequest" - }, - "output": { - "target": "com.amazonaws.qldb#CreateLedgerResponse" - }, - "errors": [ - { - "target": "com.amazonaws.qldb#InvalidParameterException" - }, - { - "target": "com.amazonaws.qldb#LimitExceededException" - }, - { - "target": "com.amazonaws.qldb#ResourceAlreadyExistsException" - }, - { - "target": "com.amazonaws.qldb#ResourceInUseException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a new ledger in your Amazon Web Services account in the current Region.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ledgers", - "code": 200 - } - } - }, - "com.amazonaws.qldb#CreateLedgerRequest": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.qldb#LedgerName", - "traits": { - "smithy.api#documentation": "

The name of the ledger that you want to create. The name must be unique among all of the\n ledgers in your Amazon Web Services account in the current Region.

\n

Naming constraints for ledger names are defined in Quotas in Amazon QLDB\n in the Amazon QLDB Developer Guide.

", - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.qldb#Tags", - "traits": { - "smithy.api#documentation": "

The key-value pairs to add as tags to the ledger that you want to create. Tag keys are\n case sensitive. Tag values are case sensitive and can be null.

" - } - }, - "PermissionsMode": { - "target": "com.amazonaws.qldb#PermissionsMode", - "traits": { - "smithy.api#documentation": "

The permissions mode to assign to the ledger that you want to create. This parameter can\n have one of the following values:

\n \n \n

We strongly recommend using the STANDARD permissions mode to maximize\n the security of your ledger data.

\n ", - "smithy.api#required": {} - } - }, - "DeletionProtection": { - "target": "com.amazonaws.qldb#DeletionProtection", - "traits": { - "smithy.api#documentation": "

Specifies whether the ledger is protected from being deleted by any user. If not defined during\n ledger creation, this feature is enabled (true) by default.

\n

If deletion protection is enabled, you must first disable it before you can delete the\n ledger. You can disable it by calling the UpdateLedger operation to set this parameter to false.

" - } - }, - "KmsKey": { - "target": "com.amazonaws.qldb#KmsKey", - "traits": { - "smithy.api#documentation": "

The key in Key Management Service (KMS) to use for encryption of data at rest in the ledger. For\n more information, see Encryption at rest in\n the Amazon QLDB Developer Guide.

\n

Use one of the following options to specify this parameter:

\n \n

To specify a customer managed KMS key, you can use its key ID, Amazon Resource Name\n (ARN), alias name, or alias ARN. When using an alias name, prefix it with\n \"alias/\". To specify a key in a different Amazon Web Services account, you must use the key\n ARN or alias ARN.

\n

For example:

\n \n

For more information, see Key identifiers (KeyId) in\n the Key Management Service Developer Guide.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.qldb#CreateLedgerResponse": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.qldb#LedgerName", - "traits": { - "smithy.api#documentation": "

The name of the ledger.

" - } - }, - "Arn": { - "target": "com.amazonaws.qldb#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the ledger.

" - } - }, - "State": { - "target": "com.amazonaws.qldb#LedgerState", - "traits": { - "smithy.api#documentation": "

The current status of the ledger.

" - } - }, - "CreationDateTime": { - "target": "com.amazonaws.qldb#Timestamp", - "traits": { - "smithy.api#documentation": "

The date and time, in epoch time format, when the ledger was created. (Epoch time format\n is the number of seconds elapsed since 12:00:00 AM January 1, 1970 UTC.)

" - } - }, - "PermissionsMode": { - "target": "com.amazonaws.qldb#PermissionsMode", - "traits": { - "smithy.api#documentation": "

The permissions mode of the ledger that you created.

" - } - }, - "DeletionProtection": { - "target": "com.amazonaws.qldb#DeletionProtection", - "traits": { - "smithy.api#documentation": "

Specifies whether the ledger is protected from being deleted by any user. If not defined during\n ledger creation, this feature is enabled (true) by default.

\n

If deletion protection is enabled, you must first disable it before you can delete the\n ledger. You can disable it by calling the UpdateLedger operation to set this parameter to false.

" - } - }, - "KmsKeyArn": { - "target": "com.amazonaws.qldb#Arn", - "traits": { - "smithy.api#documentation": "

The ARN of the customer managed KMS key that the ledger uses for encryption at rest. If\n this parameter is undefined, the ledger uses an Amazon Web Services owned KMS key for encryption.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.qldb#DeleteLedger": { - "type": "operation", - "input": { - "target": "com.amazonaws.qldb#DeleteLedgerRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.qldb#InvalidParameterException" - }, - { - "target": "com.amazonaws.qldb#ResourceInUseException" - }, - { - "target": "com.amazonaws.qldb#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.qldb#ResourcePreconditionNotMetException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes a ledger and all of its contents. This action is irreversible.

\n

If deletion protection is enabled, you must first disable it before you can delete the\n ledger. You can disable it by calling the UpdateLedger operation to set this parameter to false.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/ledgers/{Name}", - "code": 200 - } - } - }, - "com.amazonaws.qldb#DeleteLedgerRequest": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.qldb#LedgerName", - "traits": { - "smithy.api#documentation": "

The name of the ledger that you want to delete.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.qldb#DeletionProtection": { - "type": "boolean" - }, - "com.amazonaws.qldb#DescribeJournalKinesisStream": { - "type": "operation", - "input": { - "target": "com.amazonaws.qldb#DescribeJournalKinesisStreamRequest" - }, - "output": { - "target": "com.amazonaws.qldb#DescribeJournalKinesisStreamResponse" - }, - "errors": [ - { - "target": "com.amazonaws.qldb#InvalidParameterException" - }, - { - "target": "com.amazonaws.qldb#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.qldb#ResourcePreconditionNotMetException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns detailed information about a given Amazon QLDB journal stream. The output\n includes the Amazon Resource Name (ARN), stream name, current status, creation time, and\n the parameters of the original stream creation request.

\n

This action does not return any expired journal streams. For more information, see\n Expiration for terminal streams in the Amazon QLDB Developer\n Guide.

", - "smithy.api#http": { - "method": "GET", - "uri": "/ledgers/{LedgerName}/journal-kinesis-streams/{StreamId}", - "code": 200 - } - } - }, - "com.amazonaws.qldb#DescribeJournalKinesisStreamRequest": { - "type": "structure", - "members": { - "LedgerName": { - "target": "com.amazonaws.qldb#LedgerName", - "traits": { - "smithy.api#documentation": "

The name of the ledger.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "StreamId": { - "target": "com.amazonaws.qldb#UniqueId", - "traits": { - "smithy.api#documentation": "

The UUID (represented in Base62-encoded text) of the QLDB journal stream to\n describe.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.qldb#DescribeJournalKinesisStreamResponse": { - "type": "structure", - "members": { - "Stream": { - "target": "com.amazonaws.qldb#JournalKinesisStreamDescription", - "traits": { - "smithy.api#documentation": "

Information about the QLDB journal stream returned by a\n DescribeJournalS3Export request.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.qldb#DescribeJournalS3Export": { - "type": "operation", - "input": { - "target": "com.amazonaws.qldb#DescribeJournalS3ExportRequest" - }, - "output": { - "target": "com.amazonaws.qldb#DescribeJournalS3ExportResponse" - }, - "errors": [ - { - "target": "com.amazonaws.qldb#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns information about a journal export job, including the ledger name, export ID,\n creation time, current status, and the parameters of the original export creation\n request.

\n

This action does not return any expired export jobs. For more information, see Export job expiration in the Amazon QLDB Developer\n Guide.

\n

If the export job with the given ExportId doesn't exist, then throws\n ResourceNotFoundException.

\n

If the ledger with the given Name doesn't exist, then throws\n ResourceNotFoundException.

", - "smithy.api#http": { - "method": "GET", - "uri": "/ledgers/{Name}/journal-s3-exports/{ExportId}", - "code": 200 - } - } - }, - "com.amazonaws.qldb#DescribeJournalS3ExportRequest": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.qldb#LedgerName", - "traits": { - "smithy.api#documentation": "

The name of the ledger.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ExportId": { - "target": "com.amazonaws.qldb#UniqueId", - "traits": { - "smithy.api#documentation": "

The UUID (represented in Base62-encoded text) of the journal export job to\n describe.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.qldb#DescribeJournalS3ExportResponse": { - "type": "structure", - "members": { - "ExportDescription": { - "target": "com.amazonaws.qldb#JournalS3ExportDescription", - "traits": { - "smithy.api#documentation": "

Information about the journal export job returned by a\n DescribeJournalS3Export request.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.qldb#DescribeLedger": { - "type": "operation", - "input": { - "target": "com.amazonaws.qldb#DescribeLedgerRequest" - }, - "output": { - "target": "com.amazonaws.qldb#DescribeLedgerResponse" - }, - "errors": [ - { - "target": "com.amazonaws.qldb#InvalidParameterException" - }, - { - "target": "com.amazonaws.qldb#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns information about a ledger, including its state, permissions mode, encryption at\n rest settings, and when it was created.

", - "smithy.api#http": { - "method": "GET", - "uri": "/ledgers/{Name}", - "code": 200 - } - } - }, - "com.amazonaws.qldb#DescribeLedgerRequest": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.qldb#LedgerName", - "traits": { - "smithy.api#documentation": "

The name of the ledger that you want to describe.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.qldb#DescribeLedgerResponse": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.qldb#LedgerName", - "traits": { - "smithy.api#documentation": "

The name of the ledger.

" - } - }, - "Arn": { - "target": "com.amazonaws.qldb#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the ledger.

" - } - }, - "State": { - "target": "com.amazonaws.qldb#LedgerState", - "traits": { - "smithy.api#documentation": "

The current status of the ledger.

" - } - }, - "CreationDateTime": { - "target": "com.amazonaws.qldb#Timestamp", - "traits": { - "smithy.api#documentation": "

The date and time, in epoch time format, when the ledger was created. (Epoch time format\n is the number of seconds elapsed since 12:00:00 AM January 1, 1970 UTC.)

" - } - }, - "PermissionsMode": { - "target": "com.amazonaws.qldb#PermissionsMode", - "traits": { - "smithy.api#documentation": "

The permissions mode of the ledger.

" - } - }, - "DeletionProtection": { - "target": "com.amazonaws.qldb#DeletionProtection", - "traits": { - "smithy.api#documentation": "

Specifies whether the ledger is protected from being deleted by any user. If not defined during\n ledger creation, this feature is enabled (true) by default.

\n

If deletion protection is enabled, you must first disable it before you can delete the\n ledger. You can disable it by calling the UpdateLedger operation to set this parameter to false.

" - } - }, - "EncryptionDescription": { - "target": "com.amazonaws.qldb#LedgerEncryptionDescription", - "traits": { - "smithy.api#documentation": "

Information about the encryption of data at rest in the ledger. This includes the\n current status, the KMS key, and when the key became inaccessible (in the case of an\n error). If this parameter is undefined, the ledger uses an Amazon Web Services owned KMS key for encryption.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.qldb#Digest": { - "type": "blob", - "traits": { - "smithy.api#length": { - "min": 32, - "max": 32 - } - } - }, - "com.amazonaws.qldb#EncryptionStatus": { - "type": "enum", - "members": { - "ENABLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ENABLED" - } - }, - "UPDATING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UPDATING" - } - }, - "KMS_KEY_INACCESSIBLE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "KMS_KEY_INACCESSIBLE" - } - } - } - }, - "com.amazonaws.qldb#ErrorCause": { - "type": "enum", - "members": { - "KINESIS_STREAM_NOT_FOUND": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "KINESIS_STREAM_NOT_FOUND" - } - }, - "IAM_PERMISSION_REVOKED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IAM_PERMISSION_REVOKED" - } - } - } - }, - "com.amazonaws.qldb#ErrorMessage": { - "type": "string" - }, - "com.amazonaws.qldb#ExportJournalToS3": { - "type": "operation", - "input": { - "target": "com.amazonaws.qldb#ExportJournalToS3Request" - }, - "output": { - "target": "com.amazonaws.qldb#ExportJournalToS3Response" - }, - "errors": [ - { - "target": "com.amazonaws.qldb#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.qldb#ResourcePreconditionNotMetException" - } - ], - "traits": { - "smithy.api#documentation": "

Exports journal contents within a date and time range from a ledger into a specified\n Amazon Simple Storage Service (Amazon S3) bucket. A journal export job can write the data objects in either the text\n or binary representation of Amazon Ion format, or in JSON Lines text\n format.

\n

If the ledger with the given Name doesn't exist, then throws\n ResourceNotFoundException.

\n

If the ledger with the given Name is in CREATING status, then\n throws ResourcePreconditionNotMetException.

\n

You can initiate up to two concurrent journal export requests for each ledger. Beyond\n this limit, journal export requests throw LimitExceededException.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ledgers/{Name}/journal-s3-exports", - "code": 200 - } - } - }, - "com.amazonaws.qldb#ExportJournalToS3Request": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.qldb#LedgerName", - "traits": { - "smithy.api#documentation": "

The name of the ledger.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "InclusiveStartTime": { - "target": "com.amazonaws.qldb#Timestamp", - "traits": { - "smithy.api#documentation": "

The inclusive start date and time for the range of journal contents to export.

\n

The InclusiveStartTime must be in ISO 8601 date and time\n format and in Universal Coordinated Time (UTC). For example:\n 2019-06-13T21:36:34Z.

\n

The InclusiveStartTime must be before ExclusiveEndTime.

\n

If you provide an InclusiveStartTime that is before the ledger's\n CreationDateTime, Amazon QLDB defaults it to the ledger's\n CreationDateTime.

", - "smithy.api#required": {} - } - }, - "ExclusiveEndTime": { - "target": "com.amazonaws.qldb#Timestamp", - "traits": { - "smithy.api#documentation": "

The exclusive end date and time for the range of journal contents to export.

\n

The ExclusiveEndTime must be in ISO 8601 date and time format\n and in Universal Coordinated Time (UTC). For example:\n 2019-06-13T21:36:34Z.

\n

The ExclusiveEndTime must be less than or equal to the current UTC date and\n time.

", - "smithy.api#required": {} - } - }, - "S3ExportConfiguration": { - "target": "com.amazonaws.qldb#S3ExportConfiguration", - "traits": { - "smithy.api#documentation": "

The configuration settings of the Amazon S3 bucket destination for your export\n request.

", - "smithy.api#required": {} - } - }, - "RoleArn": { - "target": "com.amazonaws.qldb#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that grants QLDB permissions for a\n journal export job to do the following:

\n \n

To pass a role to QLDB when requesting a journal export, you must have permissions to\n perform the iam:PassRole action on the IAM role resource. This is required for\n all journal export requests.

", - "smithy.api#required": {} - } - }, - "OutputFormat": { - "target": "com.amazonaws.qldb#OutputFormat", - "traits": { - "smithy.api#documentation": "

The output format of your exported journal data. A journal export job can write the data\n objects in either the text or binary representation of Amazon Ion format, or in JSON Lines text format.

\n

Default: ION_TEXT\n

\n

In JSON Lines format, each journal block in an exported data object is a valid JSON\n object that is delimited by a newline. You can use this format to directly integrate JSON\n exports with analytics tools such as Amazon Athena and Glue\n because these services can parse newline-delimited JSON automatically.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.qldb#ExportJournalToS3Response": { - "type": "structure", - "members": { - "ExportId": { - "target": "com.amazonaws.qldb#UniqueId", - "traits": { - "smithy.api#documentation": "

The UUID (represented in Base62-encoded text) that QLDB assigns to each journal export\n job.

\n

To describe your export request and check the status of the job, you can use\n ExportId to call DescribeJournalS3Export.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.qldb#ExportStatus": { - "type": "enum", - "members": { - "IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IN_PROGRESS" - } - }, - "COMPLETED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "COMPLETED" - } - }, - "CANCELLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CANCELLED" - } - } - } - }, - "com.amazonaws.qldb#GetBlock": { - "type": "operation", - "input": { - "target": "com.amazonaws.qldb#GetBlockRequest" - }, - "output": { - "target": "com.amazonaws.qldb#GetBlockResponse" - }, - "errors": [ - { - "target": "com.amazonaws.qldb#InvalidParameterException" - }, - { - "target": "com.amazonaws.qldb#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.qldb#ResourcePreconditionNotMetException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns a block object at a specified address in a journal. Also returns a proof of the\n specified block for verification if DigestTipAddress is provided.

\n

For information about the data contents in a block, see Journal contents in the\n Amazon QLDB Developer Guide.

\n

If the specified ledger doesn't exist or is in DELETING status, then throws\n ResourceNotFoundException.

\n

If the specified ledger is in CREATING status, then throws\n ResourcePreconditionNotMetException.

\n

If no block exists with the specified address, then throws\n InvalidParameterException.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ledgers/{Name}/block", - "code": 200 - } - } - }, - "com.amazonaws.qldb#GetBlockRequest": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.qldb#LedgerName", - "traits": { - "smithy.api#documentation": "

The name of the ledger.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "BlockAddress": { - "target": "com.amazonaws.qldb#ValueHolder", - "traits": { - "smithy.api#documentation": "

The location of the block that you want to request. An address is an Amazon Ion\n structure that has two fields: strandId and sequenceNo.

\n

For example: {strandId:\"BlFTjlSXze9BIh1KOszcE3\",sequenceNo:14}.

", - "smithy.api#required": {} - } - }, - "DigestTipAddress": { - "target": "com.amazonaws.qldb#ValueHolder", - "traits": { - "smithy.api#documentation": "

The latest block location covered by the digest for which to request a proof. An address\n is an Amazon Ion structure that has two fields: strandId and\n sequenceNo.

\n

For example: {strandId:\"BlFTjlSXze9BIh1KOszcE3\",sequenceNo:49}.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.qldb#GetBlockResponse": { - "type": "structure", - "members": { - "Block": { - "target": "com.amazonaws.qldb#ValueHolder", - "traits": { - "smithy.api#documentation": "

The block data object in Amazon Ion format.

", - "smithy.api#required": {} - } - }, - "Proof": { - "target": "com.amazonaws.qldb#ValueHolder", - "traits": { - "smithy.api#documentation": "

The proof object in Amazon Ion format returned by a GetBlock request. A\n proof contains the list of hash values required to recalculate the specified digest using a\n Merkle tree, starting with the specified block.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.qldb#GetDigest": { - "type": "operation", - "input": { - "target": "com.amazonaws.qldb#GetDigestRequest" - }, - "output": { - "target": "com.amazonaws.qldb#GetDigestResponse" - }, - "errors": [ - { - "target": "com.amazonaws.qldb#InvalidParameterException" - }, - { - "target": "com.amazonaws.qldb#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.qldb#ResourcePreconditionNotMetException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns the digest of a ledger at the latest committed block in the journal. The\n response includes a 256-bit hash value and a block address.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ledgers/{Name}/digest", - "code": 200 - } - } - }, - "com.amazonaws.qldb#GetDigestRequest": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.qldb#LedgerName", - "traits": { - "smithy.api#documentation": "

The name of the ledger.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.qldb#GetDigestResponse": { - "type": "structure", - "members": { - "Digest": { - "target": "com.amazonaws.qldb#Digest", - "traits": { - "smithy.api#documentation": "

The 256-bit hash value representing the digest returned by a GetDigest\n request.

", - "smithy.api#required": {} - } - }, - "DigestTipAddress": { - "target": "com.amazonaws.qldb#ValueHolder", - "traits": { - "smithy.api#documentation": "

The latest block location covered by the digest that you requested. An address is an\n Amazon Ion structure that has two fields: strandId and\n sequenceNo.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.qldb#GetRevision": { - "type": "operation", - "input": { - "target": "com.amazonaws.qldb#GetRevisionRequest" - }, - "output": { - "target": "com.amazonaws.qldb#GetRevisionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.qldb#InvalidParameterException" - }, - { - "target": "com.amazonaws.qldb#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.qldb#ResourcePreconditionNotMetException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns a revision data object for a specified document ID and block address. Also\n returns a proof of the specified revision for verification if DigestTipAddress\n is provided.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ledgers/{Name}/revision", - "code": 200 - } - } - }, - "com.amazonaws.qldb#GetRevisionRequest": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.qldb#LedgerName", - "traits": { - "smithy.api#documentation": "

The name of the ledger.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "BlockAddress": { - "target": "com.amazonaws.qldb#ValueHolder", - "traits": { - "smithy.api#documentation": "

The block location of the document revision to be verified. An address is an Amazon Ion\n structure that has two fields: strandId and sequenceNo.

\n

For example: {strandId:\"BlFTjlSXze9BIh1KOszcE3\",sequenceNo:14}.

", - "smithy.api#required": {} - } - }, - "DocumentId": { - "target": "com.amazonaws.qldb#UniqueId", - "traits": { - "smithy.api#documentation": "

The UUID (represented in Base62-encoded text) of the document to be verified.

", - "smithy.api#required": {} - } - }, - "DigestTipAddress": { - "target": "com.amazonaws.qldb#ValueHolder", - "traits": { - "smithy.api#documentation": "

The latest block location covered by the digest for which to request a proof. An address\n is an Amazon Ion structure that has two fields: strandId and\n sequenceNo.

\n

For example: {strandId:\"BlFTjlSXze9BIh1KOszcE3\",sequenceNo:49}.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.qldb#GetRevisionResponse": { - "type": "structure", - "members": { - "Proof": { - "target": "com.amazonaws.qldb#ValueHolder", - "traits": { - "smithy.api#documentation": "

The proof object in Amazon Ion format returned by a GetRevision request. A\n proof contains the list of hash values that are required to recalculate the specified\n digest using a Merkle tree, starting with the specified document revision.

" - } - }, - "Revision": { - "target": "com.amazonaws.qldb#ValueHolder", - "traits": { - "smithy.api#documentation": "

The document revision data object in Amazon Ion format.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.qldb#InvalidParameterException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.qldb#ErrorMessage" - }, - "ParameterName": { - "target": "com.amazonaws.qldb#ParameterName", - "traits": { - "smithy.api#documentation": "

The name of the invalid parameter.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

One or more parameters in the request aren't valid.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.qldb#IonText": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1048576 - }, - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.qldb#JournalKinesisStreamDescription": { - "type": "structure", - "members": { - "LedgerName": { - "target": "com.amazonaws.qldb#LedgerName", - "traits": { - "smithy.api#documentation": "

The name of the ledger.

", - "smithy.api#required": {} - } - }, - "CreationTime": { - "target": "com.amazonaws.qldb#Timestamp", - "traits": { - "smithy.api#documentation": "

The date and time, in epoch time format, when the QLDB journal stream was created.\n (Epoch time format is the number of seconds elapsed since 12:00:00 AM January 1, 1970\n UTC.)

" - } - }, - "InclusiveStartTime": { - "target": "com.amazonaws.qldb#Timestamp", - "traits": { - "smithy.api#documentation": "

The inclusive start date and time from which to start streaming journal data.

" - } - }, - "ExclusiveEndTime": { - "target": "com.amazonaws.qldb#Timestamp", - "traits": { - "smithy.api#documentation": "

The exclusive date and time that specifies when the stream ends. If this parameter is\n undefined, the stream runs indefinitely until you cancel it.

" - } - }, - "RoleArn": { - "target": "com.amazonaws.qldb#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that grants QLDB permissions for a\n journal stream to write data records to a Kinesis Data Streams resource.

", - "smithy.api#required": {} - } - }, - "StreamId": { - "target": "com.amazonaws.qldb#UniqueId", - "traits": { - "smithy.api#documentation": "

The UUID (represented in Base62-encoded text) of the QLDB journal stream.

", - "smithy.api#required": {} - } - }, - "Arn": { - "target": "com.amazonaws.qldb#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the QLDB journal stream.

" - } - }, - "Status": { - "target": "com.amazonaws.qldb#StreamStatus", - "traits": { - "smithy.api#documentation": "

The current state of the QLDB journal stream.

", - "smithy.api#required": {} - } - }, - "KinesisConfiguration": { - "target": "com.amazonaws.qldb#KinesisConfiguration", - "traits": { - "smithy.api#documentation": "

The configuration settings of the Amazon Kinesis Data Streams destination for a QLDB journal\n stream.

", - "smithy.api#required": {} - } - }, - "ErrorCause": { - "target": "com.amazonaws.qldb#ErrorCause", - "traits": { - "smithy.api#documentation": "

The error message that describes the reason that a stream has a status of\n IMPAIRED or FAILED. This is not applicable to streams that\n have other status values.

" - } - }, - "StreamName": { - "target": "com.amazonaws.qldb#StreamName", - "traits": { - "smithy.api#documentation": "

The user-defined name of the QLDB journal stream.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about an Amazon QLDB journal stream, including the Amazon Resource Name\n (ARN), stream name, creation time, current status, and the parameters of the original\n stream creation request.

" - } - }, - "com.amazonaws.qldb#JournalKinesisStreamDescriptionList": { - "type": "list", - "member": { - "target": "com.amazonaws.qldb#JournalKinesisStreamDescription" - } - }, - "com.amazonaws.qldb#JournalS3ExportDescription": { - "type": "structure", - "members": { - "LedgerName": { - "target": "com.amazonaws.qldb#LedgerName", - "traits": { - "smithy.api#documentation": "

The name of the ledger.

", - "smithy.api#required": {} - } - }, - "ExportId": { - "target": "com.amazonaws.qldb#UniqueId", - "traits": { - "smithy.api#documentation": "

The UUID (represented in Base62-encoded text) of the journal export job.

", - "smithy.api#required": {} - } - }, - "ExportCreationTime": { - "target": "com.amazonaws.qldb#Timestamp", - "traits": { - "smithy.api#documentation": "

The date and time, in epoch time format, when the export job was created. (Epoch time\n format is the number of seconds elapsed since 12:00:00 AM January 1, 1970 UTC.)

", - "smithy.api#required": {} - } - }, - "Status": { - "target": "com.amazonaws.qldb#ExportStatus", - "traits": { - "smithy.api#documentation": "

The current state of the journal export job.

", - "smithy.api#required": {} - } - }, - "InclusiveStartTime": { - "target": "com.amazonaws.qldb#Timestamp", - "traits": { - "smithy.api#documentation": "

The inclusive start date and time for the range of journal contents that was specified\n in the original export request.

", - "smithy.api#required": {} - } - }, - "ExclusiveEndTime": { - "target": "com.amazonaws.qldb#Timestamp", - "traits": { - "smithy.api#documentation": "

The exclusive end date and time for the range of journal contents that was specified in\n the original export request.

", - "smithy.api#required": {} - } - }, - "S3ExportConfiguration": { - "target": "com.amazonaws.qldb#S3ExportConfiguration", - "traits": { - "smithy.api#required": {} - } - }, - "RoleArn": { - "target": "com.amazonaws.qldb#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that grants QLDB permissions for a\n journal export job to do the following:

\n ", - "smithy.api#required": {} - } - }, - "OutputFormat": { - "target": "com.amazonaws.qldb#OutputFormat", - "traits": { - "smithy.api#documentation": "

The output format of the exported journal data.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about a journal export job, including the ledger name, export ID, creation\n time, current status, and the parameters of the original export creation request.

" - } - }, - "com.amazonaws.qldb#JournalS3ExportList": { - "type": "list", - "member": { - "target": "com.amazonaws.qldb#JournalS3ExportDescription" - } - }, - "com.amazonaws.qldb#KinesisConfiguration": { - "type": "structure", - "members": { - "StreamArn": { - "target": "com.amazonaws.qldb#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Kinesis Data Streams resource.

", - "smithy.api#required": {} - } - }, - "AggregationEnabled": { - "target": "com.amazonaws.qldb#Boolean", - "traits": { - "smithy.api#documentation": "

Enables QLDB to publish multiple data records in a single Kinesis Data Streams record, increasing the\n number of records sent per API call.

\n

Default: True\n

\n \n

Record aggregation has important implications for processing records and requires\n de-aggregation in your stream consumer. To learn more, see KPL Key Concepts and\n Consumer\n De-aggregation in the Amazon Kinesis Data Streams Developer Guide.

\n " - } - } - }, - "traits": { - "smithy.api#documentation": "

The configuration settings of the Amazon Kinesis Data Streams destination for an Amazon QLDB journal\n stream.

" - } - }, - "com.amazonaws.qldb#KmsKey": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1600 - } - } - }, - "com.amazonaws.qldb#LedgerEncryptionDescription": { - "type": "structure", - "members": { - "KmsKeyArn": { - "target": "com.amazonaws.qldb#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the customer managed KMS key that the ledger uses for\n encryption at rest. If this parameter is undefined, the ledger uses an Amazon Web Services owned KMS key\n for encryption. It will display AWS_OWNED_KMS_KEY when updating the ledger's encryption configuration to the Amazon Web Services owned KMS key.

", - "smithy.api#required": {} - } - }, - "EncryptionStatus": { - "target": "com.amazonaws.qldb#EncryptionStatus", - "traits": { - "smithy.api#documentation": "

The current state of encryption at rest for the ledger. This can be one of the following\n values:

\n ", - "smithy.api#required": {} - } - }, - "InaccessibleKmsKeyDateTime": { - "target": "com.amazonaws.qldb#Timestamp", - "traits": { - "smithy.api#documentation": "

The date and time, in epoch time format, when the KMS key first became inaccessible,\n in the case of an error. (Epoch time format is the number of seconds that have elapsed\n since 12:00:00 AM January 1, 1970 UTC.)

\n

This parameter is undefined if the KMS key is accessible.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about the encryption of data at rest in an Amazon QLDB ledger. This includes\n the current status, the key in Key Management Service (KMS), and when the key became inaccessible (in\n the case of an error).

\n

For more information, see Encryption at rest in\n the Amazon QLDB Developer Guide.

" - } - }, - "com.amazonaws.qldb#LedgerList": { - "type": "list", - "member": { - "target": "com.amazonaws.qldb#LedgerSummary" - } - }, - "com.amazonaws.qldb#LedgerName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 32 - }, - "smithy.api#pattern": "^(?!^.*--)(?!^[0-9]+$)(?!^-)(?!.*-$)^[A-Za-z0-9-]+$" - } - }, - "com.amazonaws.qldb#LedgerState": { - "type": "enum", - "members": { - "CREATING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CREATING" - } - }, - "ACTIVE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ACTIVE" - } - }, - "DELETING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETING" - } - }, - "DELETED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETED" - } - } - } - }, - "com.amazonaws.qldb#LedgerSummary": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.qldb#LedgerName", - "traits": { - "smithy.api#documentation": "

The name of the ledger.

" - } - }, - "State": { - "target": "com.amazonaws.qldb#LedgerState", - "traits": { - "smithy.api#documentation": "

The current status of the ledger.

" - } - }, - "CreationDateTime": { - "target": "com.amazonaws.qldb#Timestamp", - "traits": { - "smithy.api#documentation": "

The date and time, in epoch time format, when the ledger was created. (Epoch time format\n is the number of seconds elapsed since 12:00:00 AM January 1, 1970 UTC.)

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about a ledger, including its name, state, and when it was created.

" - } - }, - "com.amazonaws.qldb#LimitExceededException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.qldb#ErrorMessage" - }, - "ResourceType": { - "target": "com.amazonaws.qldb#ResourceType", - "traits": { - "smithy.api#documentation": "

The type of resource.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

You have reached the limit on the maximum number of resources allowed.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.qldb#ListJournalKinesisStreamsForLedger": { - "type": "operation", - "input": { - "target": "com.amazonaws.qldb#ListJournalKinesisStreamsForLedgerRequest" - }, - "output": { - "target": "com.amazonaws.qldb#ListJournalKinesisStreamsForLedgerResponse" - }, - "errors": [ - { - "target": "com.amazonaws.qldb#InvalidParameterException" - }, - { - "target": "com.amazonaws.qldb#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.qldb#ResourcePreconditionNotMetException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns all Amazon QLDB journal streams for a given ledger.

\n

This action does not return any expired journal streams. For more information, see\n Expiration for terminal streams in the Amazon QLDB Developer\n Guide.

\n

This action returns a maximum of MaxResults items. It is paginated so that\n you can retrieve all the items by calling ListJournalKinesisStreamsForLedger\n multiple times.

", - "smithy.api#http": { - "method": "GET", - "uri": "/ledgers/{LedgerName}/journal-kinesis-streams", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.qldb#ListJournalKinesisStreamsForLedgerRequest": { - "type": "structure", - "members": { - "LedgerName": { - "target": "com.amazonaws.qldb#LedgerName", - "traits": { - "smithy.api#documentation": "

The name of the ledger.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "MaxResults": { - "target": "com.amazonaws.qldb#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to return in a single\n ListJournalKinesisStreamsForLedger request. (The actual number of results\n returned might be fewer.)

", - "smithy.api#httpQuery": "max_results" - } - }, - "NextToken": { - "target": "com.amazonaws.qldb#NextToken", - "traits": { - "smithy.api#documentation": "

A pagination token, indicating that you want to retrieve the next page of results. If\n you received a value for NextToken in the response from a previous\n ListJournalKinesisStreamsForLedger call, you should use that value as input\n here.

", - "smithy.api#httpQuery": "next_token" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.qldb#ListJournalKinesisStreamsForLedgerResponse": { - "type": "structure", - "members": { - "Streams": { - "target": "com.amazonaws.qldb#JournalKinesisStreamDescriptionList", - "traits": { - "smithy.api#documentation": "

The QLDB journal streams that are currently associated with the given ledger.

" - } - }, - "NextToken": { - "target": "com.amazonaws.qldb#NextToken", - "traits": { - "smithy.api#documentation": "" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.qldb#ListJournalS3Exports": { - "type": "operation", - "input": { - "target": "com.amazonaws.qldb#ListJournalS3ExportsRequest" - }, - "output": { - "target": "com.amazonaws.qldb#ListJournalS3ExportsResponse" - }, - "traits": { - "smithy.api#documentation": "

Returns all journal export jobs for all ledgers that are associated with the current\n Amazon Web Services account and Region.

\n

This action returns a maximum of MaxResults items, and is paginated so that\n you can retrieve all the items by calling ListJournalS3Exports multiple\n times.

\n

This action does not return any expired export jobs. For more information, see Export job expiration in the Amazon QLDB Developer\n Guide.

", - "smithy.api#http": { - "method": "GET", - "uri": "/journal-s3-exports", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.qldb#ListJournalS3ExportsForLedger": { - "type": "operation", - "input": { - "target": "com.amazonaws.qldb#ListJournalS3ExportsForLedgerRequest" - }, - "output": { - "target": "com.amazonaws.qldb#ListJournalS3ExportsForLedgerResponse" - }, - "traits": { - "smithy.api#documentation": "

Returns all journal export jobs for a specified ledger.

\n

This action returns a maximum of MaxResults items, and is paginated so that\n you can retrieve all the items by calling ListJournalS3ExportsForLedger\n multiple times.

\n

This action does not return any expired export jobs. For more information, see Export job expiration in the Amazon QLDB Developer\n Guide.

", - "smithy.api#http": { - "method": "GET", - "uri": "/ledgers/{Name}/journal-s3-exports", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.qldb#ListJournalS3ExportsForLedgerRequest": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.qldb#LedgerName", - "traits": { - "smithy.api#documentation": "

The name of the ledger.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "MaxResults": { - "target": "com.amazonaws.qldb#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to return in a single\n ListJournalS3ExportsForLedger request. (The actual number of results\n returned might be fewer.)

", - "smithy.api#httpQuery": "max_results" - } - }, - "NextToken": { - "target": "com.amazonaws.qldb#NextToken", - "traits": { - "smithy.api#documentation": "

A pagination token, indicating that you want to retrieve the next page of results. If\n you received a value for NextToken in the response from a previous\n ListJournalS3ExportsForLedger call, then you should use that value as input\n here.

", - "smithy.api#httpQuery": "next_token" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.qldb#ListJournalS3ExportsForLedgerResponse": { - "type": "structure", - "members": { - "JournalS3Exports": { - "target": "com.amazonaws.qldb#JournalS3ExportList", - "traits": { - "smithy.api#documentation": "

The journal export jobs that are currently associated with the specified ledger.

" - } - }, - "NextToken": { - "target": "com.amazonaws.qldb#NextToken", - "traits": { - "smithy.api#documentation": "" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.qldb#ListJournalS3ExportsRequest": { - "type": "structure", - "members": { - "MaxResults": { - "target": "com.amazonaws.qldb#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to return in a single ListJournalS3Exports\n request. (The actual number of results returned might be fewer.)

", - "smithy.api#httpQuery": "max_results" - } - }, - "NextToken": { - "target": "com.amazonaws.qldb#NextToken", - "traits": { - "smithy.api#documentation": "

A pagination token, indicating that you want to retrieve the next page of results. If\n you received a value for NextToken in the response from a previous\n ListJournalS3Exports call, then you should use that value as input\n here.

", - "smithy.api#httpQuery": "next_token" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.qldb#ListJournalS3ExportsResponse": { - "type": "structure", - "members": { - "JournalS3Exports": { - "target": "com.amazonaws.qldb#JournalS3ExportList", - "traits": { - "smithy.api#documentation": "

The journal export jobs for all ledgers that are associated with the current\n Amazon Web Services account and Region.

" - } - }, - "NextToken": { - "target": "com.amazonaws.qldb#NextToken", - "traits": { - "smithy.api#documentation": "" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.qldb#ListLedgers": { - "type": "operation", - "input": { - "target": "com.amazonaws.qldb#ListLedgersRequest" - }, - "output": { - "target": "com.amazonaws.qldb#ListLedgersResponse" - }, - "traits": { - "smithy.api#documentation": "

Returns all ledgers that are associated with the current Amazon Web Services account and\n Region.

\n

This action returns a maximum of MaxResults items and is paginated so that\n you can retrieve all the items by calling ListLedgers multiple times.

", - "smithy.api#http": { - "method": "GET", - "uri": "/ledgers", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.qldb#ListLedgersRequest": { - "type": "structure", - "members": { - "MaxResults": { - "target": "com.amazonaws.qldb#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to return in a single ListLedgers request.\n (The actual number of results returned might be fewer.)

", - "smithy.api#httpQuery": "max_results" - } - }, - "NextToken": { - "target": "com.amazonaws.qldb#NextToken", - "traits": { - "smithy.api#documentation": "

A pagination token, indicating that you want to retrieve the next page of results. If\n you received a value for NextToken in the response from a previous\n ListLedgers call, then you should use that value as input here.

", - "smithy.api#httpQuery": "next_token" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.qldb#ListLedgersResponse": { - "type": "structure", - "members": { - "Ledgers": { - "target": "com.amazonaws.qldb#LedgerList", - "traits": { - "smithy.api#documentation": "

The ledgers that are associated with the current Amazon Web Services account and Region.

" - } - }, - "NextToken": { - "target": "com.amazonaws.qldb#NextToken", - "traits": { - "smithy.api#documentation": "

A pagination token, indicating whether there are more results available:

\n " - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.qldb#ListTagsForResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.qldb#ListTagsForResourceRequest" - }, - "output": { - "target": "com.amazonaws.qldb#ListTagsForResourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.qldb#InvalidParameterException" - }, - { - "target": "com.amazonaws.qldb#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns all tags for a specified Amazon QLDB resource.

", - "smithy.api#http": { - "method": "GET", - "uri": "/tags/{ResourceArn}", - "code": 200 - } - } - }, - "com.amazonaws.qldb#ListTagsForResourceRequest": { - "type": "structure", - "members": { - "ResourceArn": { - "target": "com.amazonaws.qldb#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for which to list the tags. For example:

\n

\n arn:aws:qldb:us-east-1:123456789012:ledger/exampleLedger\n

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.qldb#ListTagsForResourceResponse": { - "type": "structure", - "members": { - "Tags": { - "target": "com.amazonaws.qldb#Tags", - "traits": { - "smithy.api#documentation": "

The tags that are currently associated with the specified Amazon QLDB resource.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.qldb#MaxResults": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 100 - } - } - }, - "com.amazonaws.qldb#NextToken": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 4, - "max": 1024 - }, - "smithy.api#pattern": "^[A-Za-z-0-9+/=]+$" - } - }, - "com.amazonaws.qldb#OutputFormat": { - "type": "enum", - "members": { - "ION_BINARY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ION_BINARY" - } - }, - "ION_TEXT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ION_TEXT" - } - }, - "JSON": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "JSON" - } - } - } - }, - "com.amazonaws.qldb#ParameterName": { - "type": "string" - }, - "com.amazonaws.qldb#PermissionsMode": { - "type": "enum", - "members": { - "ALLOW_ALL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ALLOW_ALL" - } - }, - "STANDARD": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STANDARD" - } - } - } - }, - "com.amazonaws.qldb#ResourceAlreadyExistsException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.qldb#ErrorMessage" - }, - "ResourceType": { - "target": "com.amazonaws.qldb#ResourceType", - "traits": { - "smithy.api#documentation": "

The type of resource.

" - } - }, - "ResourceName": { - "target": "com.amazonaws.qldb#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the resource.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The specified resource already exists.

", - "smithy.api#error": "client", - "smithy.api#httpError": 409 - } - }, - "com.amazonaws.qldb#ResourceInUseException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.qldb#ErrorMessage" - }, - "ResourceType": { - "target": "com.amazonaws.qldb#ResourceType", - "traits": { - "smithy.api#documentation": "

The type of resource.

" - } - }, - "ResourceName": { - "target": "com.amazonaws.qldb#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the resource.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The specified resource can't be modified at this time.

", - "smithy.api#error": "client", - "smithy.api#httpError": 409 - } - }, - "com.amazonaws.qldb#ResourceName": { - "type": "string" - }, - "com.amazonaws.qldb#ResourceNotFoundException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.qldb#ErrorMessage" - }, - "ResourceType": { - "target": "com.amazonaws.qldb#ResourceType", - "traits": { - "smithy.api#documentation": "

The type of resource.

" - } - }, - "ResourceName": { - "target": "com.amazonaws.qldb#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the resource.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The specified resource doesn't exist.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.qldb#ResourcePreconditionNotMetException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.qldb#ErrorMessage" - }, - "ResourceType": { - "target": "com.amazonaws.qldb#ResourceType", - "traits": { - "smithy.api#documentation": "

The type of resource.

" - } - }, - "ResourceName": { - "target": "com.amazonaws.qldb#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the resource.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The operation failed because a condition wasn't satisfied in advance.

", - "smithy.api#error": "client", - "smithy.api#httpError": 412 - } - }, - "com.amazonaws.qldb#ResourceType": { - "type": "string" - }, - "com.amazonaws.qldb#S3Bucket": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 3, - "max": 255 - }, - "smithy.api#pattern": "^[A-Za-z-0-9-_.]+$" - } - }, - "com.amazonaws.qldb#S3EncryptionConfiguration": { - "type": "structure", - "members": { - "ObjectEncryptionType": { - "target": "com.amazonaws.qldb#S3ObjectEncryptionType", - "traits": { - "smithy.api#documentation": "

The Amazon S3 object encryption type.

\n

To learn more about server-side encryption options in Amazon S3, see Protecting Data\n Using Server-Side Encryption in the Amazon S3 Developer\n Guide.

", - "smithy.api#required": {} - } - }, - "KmsKeyArn": { - "target": "com.amazonaws.qldb#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a symmetric encryption key in Key Management Service (KMS). Amazon S3\n does not support asymmetric KMS keys.

\n

You must provide a KmsKeyArn if you specify SSE_KMS as the\n ObjectEncryptionType.

\n

\n KmsKeyArn is not required if you specify SSE_S3 as the\n ObjectEncryptionType.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The encryption settings that are used by a journal export job to write data in an\n Amazon Simple Storage Service (Amazon S3) bucket.

" - } - }, - "com.amazonaws.qldb#S3ExportConfiguration": { - "type": "structure", - "members": { - "Bucket": { - "target": "com.amazonaws.qldb#S3Bucket", - "traits": { - "smithy.api#documentation": "

The Amazon S3 bucket name in which a journal export job writes the journal contents.

\n

The bucket name must comply with the Amazon S3 bucket naming conventions. For more\n information, see Bucket Restrictions and\n Limitations in the Amazon S3 Developer Guide.

", - "smithy.api#required": {} - } - }, - "Prefix": { - "target": "com.amazonaws.qldb#S3Prefix", - "traits": { - "smithy.api#documentation": "

The prefix for the Amazon S3 bucket in which a journal export job writes the journal\n contents.

\n

The prefix must comply with Amazon S3 key naming rules and restrictions. For more\n information, see Object Key and Metadata in the Amazon S3 Developer\n Guide.

\n

The following are examples of valid Prefix values:

\n ", - "smithy.api#required": {} - } - }, - "EncryptionConfiguration": { - "target": "com.amazonaws.qldb#S3EncryptionConfiguration", - "traits": { - "smithy.api#documentation": "

The encryption settings that are used by a journal export job to write data in an Amazon S3\n bucket.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The Amazon Simple Storage Service (Amazon S3) bucket location in which a journal export job writes the journal\n contents.

" - } - }, - "com.amazonaws.qldb#S3ObjectEncryptionType": { - "type": "enum", - "members": { - "SSE_KMS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SSE_KMS" - } - }, - "SSE_S3": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SSE_S3" - } - }, - "NO_ENCRYPTION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NO_ENCRYPTION" - } - } - } - }, - "com.amazonaws.qldb#S3Prefix": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 128 - } - } - }, - "com.amazonaws.qldb#StreamJournalToKinesis": { - "type": "operation", - "input": { - "target": "com.amazonaws.qldb#StreamJournalToKinesisRequest" - }, - "output": { - "target": "com.amazonaws.qldb#StreamJournalToKinesisResponse" - }, - "errors": [ - { - "target": "com.amazonaws.qldb#InvalidParameterException" - }, - { - "target": "com.amazonaws.qldb#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.qldb#ResourcePreconditionNotMetException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a journal stream for a given Amazon QLDB ledger. The stream captures every\n document revision that is committed to the ledger's journal and delivers the data to a\n specified Amazon Kinesis Data Streams resource.

", - "smithy.api#http": { - "method": "POST", - "uri": "/ledgers/{LedgerName}/journal-kinesis-streams", - "code": 200 - } - } - }, - "com.amazonaws.qldb#StreamJournalToKinesisRequest": { - "type": "structure", - "members": { - "LedgerName": { - "target": "com.amazonaws.qldb#LedgerName", - "traits": { - "smithy.api#documentation": "

The name of the ledger.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "RoleArn": { - "target": "com.amazonaws.qldb#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that grants QLDB permissions for a\n journal stream to write data records to a Kinesis Data Streams resource.

\n

To pass a role to QLDB when requesting a journal stream, you must have permissions to\n perform the iam:PassRole action on the IAM role resource. This is required for\n all journal stream requests.

", - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.qldb#Tags", - "traits": { - "smithy.api#documentation": "

The key-value pairs to add as tags to the stream that you want to create. Tag keys are\n case sensitive. Tag values are case sensitive and can be null.

" - } - }, - "InclusiveStartTime": { - "target": "com.amazonaws.qldb#Timestamp", - "traits": { - "smithy.api#documentation": "

The inclusive start date and time from which to start streaming journal data. This\n parameter must be in ISO 8601 date and time format and in Universal\n Coordinated Time (UTC). For example: 2019-06-13T21:36:34Z.

\n

The InclusiveStartTime cannot be in the future and must be before\n ExclusiveEndTime.

\n

If you provide an InclusiveStartTime that is before the ledger's\n CreationDateTime, QLDB effectively defaults it to the ledger's\n CreationDateTime.

", - "smithy.api#required": {} - } - }, - "ExclusiveEndTime": { - "target": "com.amazonaws.qldb#Timestamp", - "traits": { - "smithy.api#documentation": "

The exclusive date and time that specifies when the stream ends. If you don't define\n this parameter, the stream runs indefinitely until you cancel it.

\n

The ExclusiveEndTime must be in ISO 8601 date and time format\n and in Universal Coordinated Time (UTC). For example:\n 2019-06-13T21:36:34Z.

" - } - }, - "KinesisConfiguration": { - "target": "com.amazonaws.qldb#KinesisConfiguration", - "traits": { - "smithy.api#documentation": "

The configuration settings of the Kinesis Data Streams destination for your stream request.

", - "smithy.api#required": {} - } - }, - "StreamName": { - "target": "com.amazonaws.qldb#StreamName", - "traits": { - "smithy.api#documentation": "

The name that you want to assign to the QLDB journal stream. User-defined names can\n help identify and indicate the purpose of a stream.

\n

Your stream name must be unique among other active streams for a\n given ledger. Stream names have the same naming constraints as ledger names, as defined in\n Quotas in Amazon QLDB in the Amazon QLDB Developer\n Guide.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.qldb#StreamJournalToKinesisResponse": { - "type": "structure", - "members": { - "StreamId": { - "target": "com.amazonaws.qldb#UniqueId", - "traits": { - "smithy.api#documentation": "

The UUID (represented in Base62-encoded text) that QLDB assigns to each QLDB journal\n stream.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.qldb#StreamName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 32 - }, - "smithy.api#pattern": "^(?!^.*--)(?!^[0-9]+$)(?!^-)(?!.*-$)^[A-Za-z0-9-]+$" - } - }, - "com.amazonaws.qldb#StreamStatus": { - "type": "enum", - "members": { - "ACTIVE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ACTIVE" - } - }, - "COMPLETED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "COMPLETED" - } - }, - "CANCELED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CANCELED" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED" - } - }, - "IMPAIRED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IMPAIRED" - } - } - } - }, - "com.amazonaws.qldb#TagKey": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - } - } - }, - "com.amazonaws.qldb#TagKeyList": { - "type": "list", - "member": { - "target": "com.amazonaws.qldb#TagKey" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 200 - } - } - }, - "com.amazonaws.qldb#TagResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.qldb#TagResourceRequest" - }, - "output": { - "target": "com.amazonaws.qldb#TagResourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.qldb#InvalidParameterException" - }, - { - "target": "com.amazonaws.qldb#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "

Adds one or more tags to a specified Amazon QLDB resource.

\n

A resource can have up to 50 tags. If you try to create more than 50 tags for a\n resource, your request fails and returns an error.

", - "smithy.api#http": { - "method": "POST", - "uri": "/tags/{ResourceArn}", - "code": 200 - } - } - }, - "com.amazonaws.qldb#TagResourceRequest": { - "type": "structure", - "members": { - "ResourceArn": { - "target": "com.amazonaws.qldb#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) to which you want to add the tags. For example:

\n

\n arn:aws:qldb:us-east-1:123456789012:ledger/exampleLedger\n

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.qldb#Tags", - "traits": { - "smithy.api#documentation": "

The key-value pairs to add as tags to the specified QLDB resource. Tag keys are case\n sensitive. If you specify a key that already exists for the resource, your request fails\n and returns an error. Tag values are case sensitive and can be null.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.qldb#TagResourceResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.qldb#TagValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - } - } - }, - "com.amazonaws.qldb#Tags": { - "type": "map", - "key": { - "target": "com.amazonaws.qldb#TagKey" - }, - "value": { - "target": "com.amazonaws.qldb#TagValue" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 200 - }, - "smithy.api#sparse": {} - } - }, - "com.amazonaws.qldb#Timestamp": { - "type": "timestamp" - }, - "com.amazonaws.qldb#UniqueId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 22, - "max": 22 - }, - "smithy.api#pattern": "^[A-Za-z-0-9]+$" - } - }, - "com.amazonaws.qldb#UntagResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.qldb#UntagResourceRequest" - }, - "output": { - "target": "com.amazonaws.qldb#UntagResourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.qldb#InvalidParameterException" - }, - { - "target": "com.amazonaws.qldb#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "

Removes one or more tags from a specified Amazon QLDB resource. You can specify up to 50\n tag keys to remove.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/tags/{ResourceArn}", - "code": 200 - } - } - }, - "com.amazonaws.qldb#UntagResourceRequest": { - "type": "structure", - "members": { - "ResourceArn": { - "target": "com.amazonaws.qldb#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) from which to remove the tags. For example:

\n

\n arn:aws:qldb:us-east-1:123456789012:ledger/exampleLedger\n

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "TagKeys": { - "target": "com.amazonaws.qldb#TagKeyList", - "traits": { - "smithy.api#documentation": "

The list of tag keys to remove.

", - "smithy.api#httpQuery": "tagKeys", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.qldb#UntagResourceResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.qldb#UpdateLedger": { - "type": "operation", - "input": { - "target": "com.amazonaws.qldb#UpdateLedgerRequest" - }, - "output": { - "target": "com.amazonaws.qldb#UpdateLedgerResponse" - }, - "errors": [ - { - "target": "com.amazonaws.qldb#InvalidParameterException" - }, - { - "target": "com.amazonaws.qldb#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates properties on a ledger.

", - "smithy.api#http": { - "method": "PATCH", - "uri": "/ledgers/{Name}", - "code": 200 - } - } - }, - "com.amazonaws.qldb#UpdateLedgerPermissionsMode": { - "type": "operation", - "input": { - "target": "com.amazonaws.qldb#UpdateLedgerPermissionsModeRequest" - }, - "output": { - "target": "com.amazonaws.qldb#UpdateLedgerPermissionsModeResponse" - }, - "errors": [ - { - "target": "com.amazonaws.qldb#InvalidParameterException" - }, - { - "target": "com.amazonaws.qldb#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates the permissions mode of a ledger.

\n \n

Before you switch to the STANDARD permissions mode, you must first\n create all required IAM policies and table tags to avoid disruption to your users. To\n learn more, see Migrating to the standard permissions mode in the Amazon QLDB\n Developer Guide.

\n ", - "smithy.api#http": { - "method": "PATCH", - "uri": "/ledgers/{Name}/permissions-mode", - "code": 200 - } - } - }, - "com.amazonaws.qldb#UpdateLedgerPermissionsModeRequest": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.qldb#LedgerName", - "traits": { - "smithy.api#documentation": "

The name of the ledger.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "PermissionsMode": { - "target": "com.amazonaws.qldb#PermissionsMode", - "traits": { - "smithy.api#documentation": "

The permissions mode to assign to the ledger. This parameter can have one of the\n following values:

\n \n \n

We strongly recommend using the STANDARD permissions mode to maximize\n the security of your ledger data.

\n ", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.qldb#UpdateLedgerPermissionsModeResponse": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.qldb#LedgerName", - "traits": { - "smithy.api#documentation": "

The name of the ledger.

" - } - }, - "Arn": { - "target": "com.amazonaws.qldb#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the ledger.

" - } - }, - "PermissionsMode": { - "target": "com.amazonaws.qldb#PermissionsMode", - "traits": { - "smithy.api#documentation": "

The current permissions mode of the ledger.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.qldb#UpdateLedgerRequest": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.qldb#LedgerName", - "traits": { - "smithy.api#documentation": "

The name of the ledger.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "DeletionProtection": { - "target": "com.amazonaws.qldb#DeletionProtection", - "traits": { - "smithy.api#documentation": "

Specifies whether the ledger is protected from being deleted by any user. If not defined during\n ledger creation, this feature is enabled (true) by default.

\n

If deletion protection is enabled, you must first disable it before you can delete the\n ledger. You can disable it by calling the UpdateLedger operation to set this parameter to false.

" - } - }, - "KmsKey": { - "target": "com.amazonaws.qldb#KmsKey", - "traits": { - "smithy.api#documentation": "

The key in Key Management Service (KMS) to use for encryption of data at rest in the ledger. For\n more information, see Encryption at rest in\n the Amazon QLDB Developer Guide.

\n

Use one of the following options to specify this parameter:

\n \n

To specify a customer managed KMS key, you can use its key ID, Amazon Resource Name\n (ARN), alias name, or alias ARN. When using an alias name, prefix it with\n \"alias/\". To specify a key in a different Amazon Web Services account, you must use the key\n ARN or alias ARN.

\n

For example:

\n \n

For more information, see Key identifiers (KeyId) in\n the Key Management Service Developer Guide.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.qldb#UpdateLedgerResponse": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.qldb#LedgerName", - "traits": { - "smithy.api#documentation": "

The name of the ledger.

" - } - }, - "Arn": { - "target": "com.amazonaws.qldb#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the ledger.

" - } - }, - "State": { - "target": "com.amazonaws.qldb#LedgerState", - "traits": { - "smithy.api#documentation": "

The current status of the ledger.

" - } - }, - "CreationDateTime": { - "target": "com.amazonaws.qldb#Timestamp", - "traits": { - "smithy.api#documentation": "

The date and time, in epoch time format, when the ledger was created. (Epoch time format\n is the number of seconds elapsed since 12:00:00 AM January 1, 1970 UTC.)

" - } - }, - "DeletionProtection": { - "target": "com.amazonaws.qldb#DeletionProtection", - "traits": { - "smithy.api#documentation": "

Specifies whether the ledger is protected from being deleted by any user. If not defined during\n ledger creation, this feature is enabled (true) by default.

\n

If deletion protection is enabled, you must first disable it before you can delete the\n ledger. You can disable it by calling the UpdateLedger operation to set this parameter to false.

" - } - }, - "EncryptionDescription": { - "target": "com.amazonaws.qldb#LedgerEncryptionDescription", - "traits": { - "smithy.api#documentation": "

Information about the encryption of data at rest in the ledger. This includes the\n current status, the KMS key, and when the key became inaccessible (in the case of an\n error).

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.qldb#ValueHolder": { - "type": "structure", - "members": { - "IonText": { - "target": "com.amazonaws.qldb#IonText", - "traits": { - "smithy.api#documentation": "

An Amazon Ion plaintext value contained in a ValueHolder structure.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A structure that can contain a value in multiple encoding formats.

", - "smithy.api#sensitive": {} - } - } - } -} \ No newline at end of file diff --git a/models/robomaker/service/2018-06-29/robomaker-2018-06-29.json b/models/robomaker/service/2018-06-29/robomaker-2018-06-29.json deleted file mode 100644 index 2fd05739..00000000 --- a/models/robomaker/service/2018-06-29/robomaker-2018-06-29.json +++ /dev/null @@ -1,10244 +0,0 @@ -{ - "smithy": "2.0", - "metadata": { - "suppressions": [ - { - "id": "HttpMethodSemantics", - "namespace": "*" - }, - { - "id": "HttpResponseCodeSemantics", - "namespace": "*" - }, - { - "id": "PaginatedTrait", - "namespace": "*" - }, - { - "id": "HttpHeaderTrait", - "namespace": "*" - }, - { - "id": "HttpUriConflict", - "namespace": "*" - }, - { - "id": "Service", - "namespace": "*" - } - ] - }, - "shapes": { - "com.amazonaws.robomaker#Architecture": { - "type": "enum", - "members": { - "X86_64": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "X86_64" - } - }, - "ARM64": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ARM64" - } - }, - "ARMHF": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ARMHF" - } - } - } - }, - "com.amazonaws.robomaker#Arn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1224 - }, - "smithy.api#pattern": "^arn:" - } - }, - "com.amazonaws.robomaker#Arns": { - "type": "list", - "member": { - "target": "com.amazonaws.robomaker#Arn" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 100 - } - } - }, - "com.amazonaws.robomaker#BatchDeleteWorlds": { - "type": "operation", - "input": { - "target": "com.amazonaws.robomaker#BatchDeleteWorldsRequest" - }, - "output": { - "target": "com.amazonaws.robomaker#BatchDeleteWorldsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.robomaker#InternalServerException" - }, - { - "target": "com.amazonaws.robomaker#InvalidParameterException" - }, - { - "target": "com.amazonaws.robomaker#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "\n

End of support notice: On September 10, 2025, Amazon Web Services\n will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will\n no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. \n For more information on transitioning to Batch to help run containerized\n simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.\n

\n \n

Deletes one or more worlds in a batch operation.

", - "smithy.api#http": { - "method": "POST", - "uri": "/batchDeleteWorlds", - "code": 200 - } - } - }, - "com.amazonaws.robomaker#BatchDeleteWorldsRequest": { - "type": "structure", - "members": { - "worlds": { - "target": "com.amazonaws.robomaker#Arns", - "traits": { - "smithy.api#documentation": "

A list of Amazon Resource Names (arns) that correspond to worlds to delete.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.robomaker#BatchDeleteWorldsResponse": { - "type": "structure", - "members": { - "unprocessedWorlds": { - "target": "com.amazonaws.robomaker#Arns", - "traits": { - "smithy.api#documentation": "

A list of unprocessed worlds associated with the call. These worlds were not\n deleted.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.robomaker#BatchDescribeSimulationJob": { - "type": "operation", - "input": { - "target": "com.amazonaws.robomaker#BatchDescribeSimulationJobRequest" - }, - "output": { - "target": "com.amazonaws.robomaker#BatchDescribeSimulationJobResponse" - }, - "errors": [ - { - "target": "com.amazonaws.robomaker#InternalServerException" - }, - { - "target": "com.amazonaws.robomaker#InvalidParameterException" - }, - { - "target": "com.amazonaws.robomaker#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.robomaker#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "\n

End of support notice: On September 10, 2025, Amazon Web Services\n will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will\n no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. \n For more information on transitioning to Batch to help run containerized\n simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.\n

\n \n

Describes one or more simulation jobs.

", - "smithy.api#http": { - "method": "POST", - "uri": "/batchDescribeSimulationJob", - "code": 200 - } - } - }, - "com.amazonaws.robomaker#BatchDescribeSimulationJobRequest": { - "type": "structure", - "members": { - "jobs": { - "target": "com.amazonaws.robomaker#Arns", - "traits": { - "smithy.api#documentation": "

A list of Amazon Resource Names (ARNs) of simulation jobs to describe.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.robomaker#BatchDescribeSimulationJobResponse": { - "type": "structure", - "members": { - "jobs": { - "target": "com.amazonaws.robomaker#SimulationJobs", - "traits": { - "smithy.api#documentation": "

A list of simulation jobs.

" - } - }, - "unprocessedJobs": { - "target": "com.amazonaws.robomaker#Arns", - "traits": { - "smithy.api#documentation": "

A list of unprocessed simulation job Amazon Resource Names (ARNs).

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.robomaker#BatchPolicy": { - "type": "structure", - "members": { - "timeoutInSeconds": { - "target": "com.amazonaws.robomaker#BatchTimeoutInSeconds", - "traits": { - "smithy.api#documentation": "

The amount of time, in seconds, to wait for the batch to complete.\n \n

\n

If a batch times out, and there are pending requests that were failing due to an\n internal failure (like InternalServiceError), they will be moved to the failed\n list and the batch status will be Failed. If the pending requests were failing\n for any other reason, the failed pending requests will be moved to the failed list and the\n batch status will be TimedOut.

" - } - }, - "maxConcurrency": { - "target": "com.amazonaws.robomaker#MaxConcurrency", - "traits": { - "smithy.api#documentation": "

The number of active simulation jobs create as part of the batch that can be in an\n active state at the same time.

\n

Active states include: Pending,Preparing,\n Running, Restarting, RunningFailed and\n Terminating. All other states are terminal states.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about the batch policy.

" - } - }, - "com.amazonaws.robomaker#BatchTimeoutInSeconds": { - "type": "long" - }, - "com.amazonaws.robomaker#Boolean": { - "type": "boolean", - "traits": { - "smithy.api#default": false - } - }, - "com.amazonaws.robomaker#BoxedBoolean": { - "type": "boolean" - }, - "com.amazonaws.robomaker#CancelDeploymentJob": { - "type": "operation", - "input": { - "target": "com.amazonaws.robomaker#CancelDeploymentJobRequest" - }, - "output": { - "target": "com.amazonaws.robomaker#CancelDeploymentJobResponse" - }, - "errors": [ - { - "target": "com.amazonaws.robomaker#InternalServerException" - }, - { - "target": "com.amazonaws.robomaker#InvalidParameterException" - }, - { - "target": "com.amazonaws.robomaker#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.robomaker#ThrottlingException" - } - ], - "traits": { - "smithy.api#deprecated": { - "message": "Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." - }, - "smithy.api#documentation": "\n

This API is no longer supported. For more information, see the May 2, 2022 update in the Support policy page.

\n \n

Cancels the specified deployment job.

", - "smithy.api#http": { - "method": "POST", - "uri": "/cancelDeploymentJob", - "code": 200 - } - } - }, - "com.amazonaws.robomaker#CancelDeploymentJobRequest": { - "type": "structure", - "members": { - "job": { - "target": "com.amazonaws.robomaker#Arn", - "traits": { - "smithy.api#documentation": "

The deployment job ARN to cancel.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#deprecated": { - "message": "Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." - }, - "smithy.api#input": {} - } - }, - "com.amazonaws.robomaker#CancelDeploymentJobResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#deprecated": { - "message": "Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." - }, - "smithy.api#output": {} - } - }, - "com.amazonaws.robomaker#CancelSimulationJob": { - "type": "operation", - "input": { - "target": "com.amazonaws.robomaker#CancelSimulationJobRequest" - }, - "output": { - "target": "com.amazonaws.robomaker#CancelSimulationJobResponse" - }, - "errors": [ - { - "target": "com.amazonaws.robomaker#InternalServerException" - }, - { - "target": "com.amazonaws.robomaker#InvalidParameterException" - }, - { - "target": "com.amazonaws.robomaker#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.robomaker#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "\n

End of support notice: On September 10, 2025, Amazon Web Services\n will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will\n no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. \n For more information on transitioning to Batch to help run containerized\n simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.\n

\n \n

Cancels the specified simulation job.

", - "smithy.api#http": { - "method": "POST", - "uri": "/cancelSimulationJob", - "code": 200 - } - } - }, - "com.amazonaws.robomaker#CancelSimulationJobBatch": { - "type": "operation", - "input": { - "target": "com.amazonaws.robomaker#CancelSimulationJobBatchRequest" - }, - "output": { - "target": "com.amazonaws.robomaker#CancelSimulationJobBatchResponse" - }, - "errors": [ - { - "target": "com.amazonaws.robomaker#InternalServerException" - }, - { - "target": "com.amazonaws.robomaker#InvalidParameterException" - }, - { - "target": "com.amazonaws.robomaker#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.robomaker#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "\n

End of support notice: On September 10, 2025, Amazon Web Services\n will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will\n no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. \n For more information on transitioning to Batch to help run containerized\n simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.\n

\n \n

Cancels a simulation job batch. When you cancel a simulation job batch, you are also\n cancelling all of the active simulation jobs created as part of the batch.

", - "smithy.api#http": { - "method": "POST", - "uri": "/cancelSimulationJobBatch", - "code": 200 - } - } - }, - "com.amazonaws.robomaker#CancelSimulationJobBatchRequest": { - "type": "structure", - "members": { - "batch": { - "target": "com.amazonaws.robomaker#Arn", - "traits": { - "smithy.api#documentation": "

The id of the batch to cancel.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.robomaker#CancelSimulationJobBatchResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.robomaker#CancelSimulationJobRequest": { - "type": "structure", - "members": { - "job": { - "target": "com.amazonaws.robomaker#Arn", - "traits": { - "smithy.api#documentation": "

The simulation job ARN to cancel.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.robomaker#CancelSimulationJobResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.robomaker#CancelWorldExportJob": { - "type": "operation", - "input": { - "target": "com.amazonaws.robomaker#CancelWorldExportJobRequest" - }, - "output": { - "target": "com.amazonaws.robomaker#CancelWorldExportJobResponse" - }, - "errors": [ - { - "target": "com.amazonaws.robomaker#InternalServerException" - }, - { - "target": "com.amazonaws.robomaker#InvalidParameterException" - }, - { - "target": "com.amazonaws.robomaker#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.robomaker#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "\n

End of support notice: On September 10, 2025, Amazon Web Services\n will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will\n no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. \n For more information on transitioning to Batch to help run containerized\n simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.\n

\n \n

Cancels the specified export job.

", - "smithy.api#http": { - "method": "POST", - "uri": "/cancelWorldExportJob", - "code": 200 - } - } - }, - "com.amazonaws.robomaker#CancelWorldExportJobRequest": { - "type": "structure", - "members": { - "job": { - "target": "com.amazonaws.robomaker#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (arn) of the world export job to cancel.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.robomaker#CancelWorldExportJobResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.robomaker#CancelWorldGenerationJob": { - "type": "operation", - "input": { - "target": "com.amazonaws.robomaker#CancelWorldGenerationJobRequest" - }, - "output": { - "target": "com.amazonaws.robomaker#CancelWorldGenerationJobResponse" - }, - "errors": [ - { - "target": "com.amazonaws.robomaker#InternalServerException" - }, - { - "target": "com.amazonaws.robomaker#InvalidParameterException" - }, - { - "target": "com.amazonaws.robomaker#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.robomaker#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "\n

End of support notice: On September 10, 2025, Amazon Web Services\n will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will\n no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. \n For more information on transitioning to Batch to help run containerized\n simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.\n

\n \n

Cancels the specified world generator job.

", - "smithy.api#http": { - "method": "POST", - "uri": "/cancelWorldGenerationJob", - "code": 200 - } - } - }, - "com.amazonaws.robomaker#CancelWorldGenerationJobRequest": { - "type": "structure", - "members": { - "job": { - "target": "com.amazonaws.robomaker#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (arn) of the world generator job to cancel.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.robomaker#CancelWorldGenerationJobResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.robomaker#ClientRequestToken": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - }, - "smithy.api#pattern": "^[a-zA-Z0-9_\\-=]*$" - } - }, - "com.amazonaws.robomaker#Command": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1024 - }, - "smithy.api#pattern": "^[a-zA-Z0-9_.\\-]*$" - } - }, - "com.amazonaws.robomaker#CommandList": { - "type": "list", - "member": { - "target": "com.amazonaws.robomaker#NonEmptyString" - } - }, - "com.amazonaws.robomaker#Compute": { - "type": "structure", - "members": { - "simulationUnitLimit": { - "target": "com.amazonaws.robomaker#SimulationUnit", - "traits": { - "smithy.api#documentation": "

The simulation unit limit. Your simulation is allocated CPU and memory proportional to\n the supplied simulation unit limit. A simulation unit is 1 vcpu and 2GB of memory. You are\n only billed for the SU utilization you consume up to the maximum value provided. The\n default is 15.

" - } - }, - "computeType": { - "target": "com.amazonaws.robomaker#ComputeType", - "traits": { - "smithy.api#documentation": "

Compute type information for the simulation job.

" - } - }, - "gpuUnitLimit": { - "target": "com.amazonaws.robomaker#GPUUnit", - "traits": { - "smithy.api#documentation": "

Compute GPU unit limit for the simulation job. It is the same as the number of GPUs\n allocated to the SimulationJob.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Compute information for the simulation job.

" - } - }, - "com.amazonaws.robomaker#ComputeResponse": { - "type": "structure", - "members": { - "simulationUnitLimit": { - "target": "com.amazonaws.robomaker#SimulationUnit", - "traits": { - "smithy.api#documentation": "

The simulation unit limit. Your simulation is allocated CPU and memory proportional to\n the supplied simulation unit limit. A simulation unit is 1 vcpu and 2GB of memory. You are\n only billed for the SU utilization you consume up to the maximum value provided. The\n default is 15.

" - } - }, - "computeType": { - "target": "com.amazonaws.robomaker#ComputeType", - "traits": { - "smithy.api#documentation": "

Compute type response information for the simulation job.

" - } - }, - "gpuUnitLimit": { - "target": "com.amazonaws.robomaker#GPUUnit", - "traits": { - "smithy.api#documentation": "

Compute GPU unit limit for the simulation job. It is the same as the number of GPUs\n allocated to the SimulationJob.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Compute information for the simulation job

" - } - }, - "com.amazonaws.robomaker#ComputeType": { - "type": "enum", - "members": { - "CPU": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CPU" - } - }, - "GPU_AND_CPU": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "GPU_AND_CPU" - } - } - } - }, - "com.amazonaws.robomaker#ConcurrentDeploymentException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.robomaker#errorMessage" - } - }, - "traits": { - "smithy.api#documentation": "

The failure percentage threshold percentage was met.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.robomaker#CreateDeploymentJob": { - "type": "operation", - "input": { - "target": "com.amazonaws.robomaker#CreateDeploymentJobRequest" - }, - "output": { - "target": "com.amazonaws.robomaker#CreateDeploymentJobResponse" - }, - "errors": [ - { - "target": "com.amazonaws.robomaker#ConcurrentDeploymentException" - }, - { - "target": "com.amazonaws.robomaker#IdempotentParameterMismatchException" - }, - { - "target": "com.amazonaws.robomaker#InternalServerException" - }, - { - "target": "com.amazonaws.robomaker#InvalidParameterException" - }, - { - "target": "com.amazonaws.robomaker#LimitExceededException" - }, - { - "target": "com.amazonaws.robomaker#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.robomaker#ThrottlingException" - } - ], - "traits": { - "smithy.api#deprecated": { - "message": "AWS RoboMaker is unable to process this request as the support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." - }, - "smithy.api#documentation": "\n

End of support notice: On September 10, 2025, Amazon Web Services\n will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will\n no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. \n For more information on transitioning to Batch to help run containerized\n simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.\n

\n \n \n

This API is no longer supported and will throw an error if used. For more information, see the January 31, 2022 update in the Support policy page.

\n \n

Deploys a specific version of a robot application to robots in a fleet.

\n

The robot application must have a numbered applicationVersion for\n consistency reasons. To create a new version, use CreateRobotApplicationVersion or see \n Creating a Robot Application Version.\n

\n \n

After 90 days, deployment jobs expire and will be deleted. They will no longer be\n accessible.

\n ", - "smithy.api#http": { - "method": "POST", - "uri": "/createDeploymentJob", - "code": 200 - } - } - }, - "com.amazonaws.robomaker#CreateDeploymentJobRequest": { - "type": "structure", - "members": { - "deploymentConfig": { - "target": "com.amazonaws.robomaker#DeploymentConfig", - "traits": { - "smithy.api#documentation": "

The requested deployment configuration.

" - } - }, - "clientRequestToken": { - "target": "com.amazonaws.robomaker#ClientRequestToken", - "traits": { - "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request.

", - "smithy.api#idempotencyToken": {}, - "smithy.api#required": {} - } - }, - "fleet": { - "target": "com.amazonaws.robomaker#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the fleet to deploy.

", - "smithy.api#required": {} - } - }, - "deploymentApplicationConfigs": { - "target": "com.amazonaws.robomaker#DeploymentApplicationConfigs", - "traits": { - "smithy.api#documentation": "

The deployment application configuration.

", - "smithy.api#required": {} - } - }, - "tags": { - "target": "com.amazonaws.robomaker#TagMap", - "traits": { - "smithy.api#documentation": "

A map that contains tag keys and tag values that are attached to the deployment\n job.

" - } - } - }, - "traits": { - "smithy.api#deprecated": { - "message": "AWS RoboMaker is unable to process this request as the support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." - }, - "smithy.api#input": {} - } - }, - "com.amazonaws.robomaker#CreateDeploymentJobResponse": { - "type": "structure", - "members": { - "arn": { - "target": "com.amazonaws.robomaker#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the deployment job.

" - } - }, - "fleet": { - "target": "com.amazonaws.robomaker#Arn", - "traits": { - "smithy.api#documentation": "

The target fleet for the deployment job.

" - } - }, - "status": { - "target": "com.amazonaws.robomaker#DeploymentStatus", - "traits": { - "smithy.api#documentation": "

The status of the deployment job.

" - } - }, - "deploymentApplicationConfigs": { - "target": "com.amazonaws.robomaker#DeploymentApplicationConfigs", - "traits": { - "smithy.api#documentation": "

The deployment application configuration.

" - } - }, - "failureReason": { - "target": "com.amazonaws.robomaker#GenericString", - "traits": { - "smithy.api#documentation": "

The failure reason of the deployment job if it failed.

" - } - }, - "failureCode": { - "target": "com.amazonaws.robomaker#DeploymentJobErrorCode", - "traits": { - "smithy.api#documentation": "

The failure code of the simulation job if it failed:

\n
\n
BadPermissionError
\n
\n

AWS Greengrass requires a service-level role permission to access other\n services. The role must include the \n AWSGreengrassResourceAccessRolePolicy managed policy.\n

\n
\n
ExtractingBundleFailure
\n
\n

The robot application could not be extracted from the bundle.

\n
\n
FailureThresholdBreached
\n
\n

The percentage of robots that could not be updated exceeded the percentage set\n for the deployment.

\n
\n
GreengrassDeploymentFailed
\n
\n

The robot application could not be deployed to the robot.

\n
\n
GreengrassGroupVersionDoesNotExist
\n
\n

The AWS Greengrass group or version associated with a robot is missing.

\n
\n
InternalServerError
\n
\n

An internal error has occurred. Retry your request, but if the problem\n persists, contact us with details.

\n
\n
MissingRobotApplicationArchitecture
\n
\n

The robot application does not have a source that matches the architecture of\n the robot.

\n
\n
MissingRobotDeploymentResource
\n
\n

One or more of the resources specified for the robot application are missing.\n For example, does the robot application have the correct launch package and launch\n file?

\n
\n
PostLaunchFileFailure
\n
\n

The post-launch script failed.

\n
\n
PreLaunchFileFailure
\n
\n

The pre-launch script failed.

\n
\n
ResourceNotFound
\n
\n

One or more deployment resources are missing. For example, do robot application\n source bundles still exist?

\n
\n
RobotDeploymentNoResponse
\n
\n

There is no response from the robot. It might not be powered on or connected to\n the internet.

\n
\n
" - } - }, - "createdAt": { - "target": "com.amazonaws.robomaker#CreatedAt", - "traits": { - "smithy.api#documentation": "

The time, in milliseconds since the epoch, when the fleet was created.

" - } - }, - "deploymentConfig": { - "target": "com.amazonaws.robomaker#DeploymentConfig", - "traits": { - "smithy.api#documentation": "

The deployment configuration.

" - } - }, - "tags": { - "target": "com.amazonaws.robomaker#TagMap", - "traits": { - "smithy.api#documentation": "

The list of all tags added to the deployment job.

" - } - } - }, - "traits": { - "smithy.api#deprecated": { - "message": "AWS RoboMaker is unable to process this request as the support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." - }, - "smithy.api#output": {} - } - }, - "com.amazonaws.robomaker#CreateFleet": { - "type": "operation", - "input": { - "target": "com.amazonaws.robomaker#CreateFleetRequest" - }, - "output": { - "target": "com.amazonaws.robomaker#CreateFleetResponse" - }, - "errors": [ - { - "target": "com.amazonaws.robomaker#InternalServerException" - }, - { - "target": "com.amazonaws.robomaker#InvalidParameterException" - }, - { - "target": "com.amazonaws.robomaker#LimitExceededException" - }, - { - "target": "com.amazonaws.robomaker#ThrottlingException" - } - ], - "traits": { - "smithy.api#deprecated": { - "message": "AWS RoboMaker is unable to process this request as the support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." - }, - "smithy.api#documentation": "\n

End of support notice: On September 10, 2025, Amazon Web Services\n will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will\n no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. \n For more information on transitioning to Batch to help run containerized\n simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.\n

\n \n \n

This API is no longer supported and will throw an error if used. For more information, see the January 31, 2022 update in the Support policy page.

\n \n

Creates a fleet, a logical group of robots running the same robot application.

", - "smithy.api#http": { - "method": "POST", - "uri": "/createFleet", - "code": 200 - } - } - }, - "com.amazonaws.robomaker#CreateFleetRequest": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.robomaker#Name", - "traits": { - "smithy.api#documentation": "

The name of the fleet.

", - "smithy.api#required": {} - } - }, - "tags": { - "target": "com.amazonaws.robomaker#TagMap", - "traits": { - "smithy.api#documentation": "

A map that contains tag keys and tag values that are attached to the fleet.

" - } - } - }, - "traits": { - "smithy.api#deprecated": { - "message": "AWS RoboMaker is unable to process this request as the support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." - }, - "smithy.api#input": {} - } - }, - "com.amazonaws.robomaker#CreateFleetResponse": { - "type": "structure", - "members": { - "arn": { - "target": "com.amazonaws.robomaker#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the fleet.

" - } - }, - "name": { - "target": "com.amazonaws.robomaker#Name", - "traits": { - "smithy.api#documentation": "

The name of the fleet.

" - } - }, - "createdAt": { - "target": "com.amazonaws.robomaker#CreatedAt", - "traits": { - "smithy.api#documentation": "

The time, in milliseconds since the epoch, when the fleet was created.

" - } - }, - "tags": { - "target": "com.amazonaws.robomaker#TagMap", - "traits": { - "smithy.api#documentation": "

The list of all tags added to the fleet.

" - } - } - }, - "traits": { - "smithy.api#deprecated": { - "message": "AWS RoboMaker is unable to process this request as the support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." - }, - "smithy.api#output": {} - } - }, - "com.amazonaws.robomaker#CreateRobot": { - "type": "operation", - "input": { - "target": "com.amazonaws.robomaker#CreateRobotRequest" - }, - "output": { - "target": "com.amazonaws.robomaker#CreateRobotResponse" - }, - "errors": [ - { - "target": "com.amazonaws.robomaker#InternalServerException" - }, - { - "target": "com.amazonaws.robomaker#InvalidParameterException" - }, - { - "target": "com.amazonaws.robomaker#LimitExceededException" - }, - { - "target": "com.amazonaws.robomaker#ResourceAlreadyExistsException" - }, - { - "target": "com.amazonaws.robomaker#ThrottlingException" - } - ], - "traits": { - "smithy.api#deprecated": { - "message": "AWS RoboMaker is unable to process this request as the support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." - }, - "smithy.api#documentation": "\n

End of support notice: On September 10, 2025, Amazon Web Services\n will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will\n no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. \n For more information on transitioning to Batch to help run containerized\n simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.\n

\n \n \n

This API is no longer supported and will throw an error if used. For more information, see the January 31, 2022 update in the Support policy page.

\n \n

Creates a robot.

", - "smithy.api#http": { - "method": "POST", - "uri": "/createRobot", - "code": 200 - } - } - }, - "com.amazonaws.robomaker#CreateRobotApplication": { - "type": "operation", - "input": { - "target": "com.amazonaws.robomaker#CreateRobotApplicationRequest" - }, - "output": { - "target": "com.amazonaws.robomaker#CreateRobotApplicationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.robomaker#IdempotentParameterMismatchException" - }, - { - "target": "com.amazonaws.robomaker#InternalServerException" - }, - { - "target": "com.amazonaws.robomaker#InvalidParameterException" - }, - { - "target": "com.amazonaws.robomaker#LimitExceededException" - }, - { - "target": "com.amazonaws.robomaker#ResourceAlreadyExistsException" - }, - { - "target": "com.amazonaws.robomaker#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "\n

End of support notice: On September 10, 2025, Amazon Web Services\n will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will\n no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. \n For more information on transitioning to Batch to help run containerized\n simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.\n

\n \n

Creates a robot application.

", - "smithy.api#http": { - "method": "POST", - "uri": "/createRobotApplication", - "code": 200 - } - } - }, - "com.amazonaws.robomaker#CreateRobotApplicationRequest": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.robomaker#Name", - "traits": { - "smithy.api#documentation": "

The name of the robot application.

", - "smithy.api#required": {} - } - }, - "sources": { - "target": "com.amazonaws.robomaker#SourceConfigs", - "traits": { - "smithy.api#documentation": "

The sources of the robot application.

" - } - }, - "robotSoftwareSuite": { - "target": "com.amazonaws.robomaker#RobotSoftwareSuite", - "traits": { - "smithy.api#documentation": "

The robot software suite used by the robot application.

", - "smithy.api#required": {} - } - }, - "tags": { - "target": "com.amazonaws.robomaker#TagMap", - "traits": { - "smithy.api#documentation": "

A map that contains tag keys and tag values that are attached to the robot\n application.

" - } - }, - "environment": { - "target": "com.amazonaws.robomaker#Environment", - "traits": { - "smithy.api#documentation": "

The object that contains that URI of the Docker image that you use for your robot\n application.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.robomaker#CreateRobotApplicationResponse": { - "type": "structure", - "members": { - "arn": { - "target": "com.amazonaws.robomaker#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the robot application.

" - } - }, - "name": { - "target": "com.amazonaws.robomaker#Name", - "traits": { - "smithy.api#documentation": "

The name of the robot application.

" - } - }, - "version": { - "target": "com.amazonaws.robomaker#Version", - "traits": { - "smithy.api#documentation": "

The version of the robot application.

" - } - }, - "sources": { - "target": "com.amazonaws.robomaker#Sources", - "traits": { - "smithy.api#documentation": "

The sources of the robot application.

" - } - }, - "robotSoftwareSuite": { - "target": "com.amazonaws.robomaker#RobotSoftwareSuite", - "traits": { - "smithy.api#documentation": "

The robot software suite used by the robot application.

" - } - }, - "lastUpdatedAt": { - "target": "com.amazonaws.robomaker#LastUpdatedAt", - "traits": { - "smithy.api#documentation": "

The time, in milliseconds since the epoch, when the robot application was last\n updated.

" - } - }, - "revisionId": { - "target": "com.amazonaws.robomaker#RevisionId", - "traits": { - "smithy.api#documentation": "

The revision id of the robot application.

" - } - }, - "tags": { - "target": "com.amazonaws.robomaker#TagMap", - "traits": { - "smithy.api#documentation": "

The list of all tags added to the robot application.

" - } - }, - "environment": { - "target": "com.amazonaws.robomaker#Environment", - "traits": { - "smithy.api#documentation": "

An object that contains the Docker image URI used to a create your robot\n application.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.robomaker#CreateRobotApplicationVersion": { - "type": "operation", - "input": { - "target": "com.amazonaws.robomaker#CreateRobotApplicationVersionRequest" - }, - "output": { - "target": "com.amazonaws.robomaker#CreateRobotApplicationVersionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.robomaker#IdempotentParameterMismatchException" - }, - { - "target": "com.amazonaws.robomaker#InternalServerException" - }, - { - "target": "com.amazonaws.robomaker#InvalidParameterException" - }, - { - "target": "com.amazonaws.robomaker#LimitExceededException" - }, - { - "target": "com.amazonaws.robomaker#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "\n

End of support notice: On September 10, 2025, Amazon Web Services\n will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will\n no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. \n For more information on transitioning to Batch to help run containerized\n simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.\n

\n \n

Creates a version of a robot application.

", - "smithy.api#http": { - "method": "POST", - "uri": "/createRobotApplicationVersion", - "code": 200 - } - } - }, - "com.amazonaws.robomaker#CreateRobotApplicationVersionRequest": { - "type": "structure", - "members": { - "application": { - "target": "com.amazonaws.robomaker#Arn", - "traits": { - "smithy.api#documentation": "

The application information for the robot application.

", - "smithy.api#required": {} - } - }, - "currentRevisionId": { - "target": "com.amazonaws.robomaker#RevisionId", - "traits": { - "smithy.api#documentation": "

The current revision id for the robot application. If you provide a value and it matches\n the latest revision ID, a new version will be created.

" - } - }, - "s3Etags": { - "target": "com.amazonaws.robomaker#S3Etags", - "traits": { - "smithy.api#documentation": "

The Amazon S3 identifier for the zip file bundle that you use for your robot\n application.

" - } - }, - "imageDigest": { - "target": "com.amazonaws.robomaker#ImageDigest", - "traits": { - "smithy.api#documentation": "

A SHA256 identifier for the Docker image that you use for your robot application.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.robomaker#CreateRobotApplicationVersionResponse": { - "type": "structure", - "members": { - "arn": { - "target": "com.amazonaws.robomaker#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the robot application.

" - } - }, - "name": { - "target": "com.amazonaws.robomaker#Name", - "traits": { - "smithy.api#documentation": "

The name of the robot application.

" - } - }, - "version": { - "target": "com.amazonaws.robomaker#Version", - "traits": { - "smithy.api#documentation": "

The version of the robot application.

" - } - }, - "sources": { - "target": "com.amazonaws.robomaker#Sources", - "traits": { - "smithy.api#documentation": "

The sources of the robot application.

" - } - }, - "robotSoftwareSuite": { - "target": "com.amazonaws.robomaker#RobotSoftwareSuite", - "traits": { - "smithy.api#documentation": "

The robot software suite used by the robot application.

" - } - }, - "lastUpdatedAt": { - "target": "com.amazonaws.robomaker#LastUpdatedAt", - "traits": { - "smithy.api#documentation": "

The time, in milliseconds since the epoch, when the robot application was last\n updated.

" - } - }, - "revisionId": { - "target": "com.amazonaws.robomaker#RevisionId", - "traits": { - "smithy.api#documentation": "

The revision id of the robot application.

" - } - }, - "environment": { - "target": "com.amazonaws.robomaker#Environment", - "traits": { - "smithy.api#documentation": "

The object that contains the Docker image URI used to create your robot\n application.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.robomaker#CreateRobotRequest": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.robomaker#Name", - "traits": { - "smithy.api#documentation": "

The name for the robot.

", - "smithy.api#required": {} - } - }, - "architecture": { - "target": "com.amazonaws.robomaker#Architecture", - "traits": { - "smithy.api#documentation": "

The target architecture of the robot.

", - "smithy.api#required": {} - } - }, - "greengrassGroupId": { - "target": "com.amazonaws.robomaker#Id", - "traits": { - "smithy.api#documentation": "

The Greengrass group id.

", - "smithy.api#required": {} - } - }, - "tags": { - "target": "com.amazonaws.robomaker#TagMap", - "traits": { - "smithy.api#documentation": "

A map that contains tag keys and tag values that are attached to the robot.

" - } - } - }, - "traits": { - "smithy.api#deprecated": { - "message": "AWS RoboMaker is unable to process this request as the support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." - }, - "smithy.api#input": {} - } - }, - "com.amazonaws.robomaker#CreateRobotResponse": { - "type": "structure", - "members": { - "arn": { - "target": "com.amazonaws.robomaker#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the robot.

" - } - }, - "name": { - "target": "com.amazonaws.robomaker#Name", - "traits": { - "smithy.api#documentation": "

The name of the robot.

" - } - }, - "createdAt": { - "target": "com.amazonaws.robomaker#CreatedAt", - "traits": { - "smithy.api#documentation": "

The time, in milliseconds since the epoch, when the robot was created.

" - } - }, - "greengrassGroupId": { - "target": "com.amazonaws.robomaker#Id", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Greengrass group associated with the robot.

" - } - }, - "architecture": { - "target": "com.amazonaws.robomaker#Architecture", - "traits": { - "smithy.api#documentation": "

The target architecture of the robot.

" - } - }, - "tags": { - "target": "com.amazonaws.robomaker#TagMap", - "traits": { - "smithy.api#documentation": "

The list of all tags added to the robot.

" - } - } - }, - "traits": { - "smithy.api#deprecated": { - "message": "AWS RoboMaker is unable to process this request as the support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." - }, - "smithy.api#output": {} - } - }, - "com.amazonaws.robomaker#CreateSimulationApplication": { - "type": "operation", - "input": { - "target": "com.amazonaws.robomaker#CreateSimulationApplicationRequest" - }, - "output": { - "target": "com.amazonaws.robomaker#CreateSimulationApplicationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.robomaker#IdempotentParameterMismatchException" - }, - { - "target": "com.amazonaws.robomaker#InternalServerException" - }, - { - "target": "com.amazonaws.robomaker#InvalidParameterException" - }, - { - "target": "com.amazonaws.robomaker#LimitExceededException" - }, - { - "target": "com.amazonaws.robomaker#ResourceAlreadyExistsException" - }, - { - "target": "com.amazonaws.robomaker#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "\n

End of support notice: On September 10, 2025, Amazon Web Services\n will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will\n no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. \n For more information on transitioning to Batch to help run containerized\n simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.\n

\n \n

Creates a simulation application.

", - "smithy.api#http": { - "method": "POST", - "uri": "/createSimulationApplication", - "code": 200 - } - } - }, - "com.amazonaws.robomaker#CreateSimulationApplicationRequest": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.robomaker#Name", - "traits": { - "smithy.api#documentation": "

The name of the simulation application.

", - "smithy.api#required": {} - } - }, - "sources": { - "target": "com.amazonaws.robomaker#SourceConfigs", - "traits": { - "smithy.api#documentation": "

The sources of the simulation application.

" - } - }, - "simulationSoftwareSuite": { - "target": "com.amazonaws.robomaker#SimulationSoftwareSuite", - "traits": { - "smithy.api#documentation": "

The simulation software suite used by the simulation application.

", - "smithy.api#required": {} - } - }, - "robotSoftwareSuite": { - "target": "com.amazonaws.robomaker#RobotSoftwareSuite", - "traits": { - "smithy.api#documentation": "

The robot software suite used by the simulation application.

", - "smithy.api#required": {} - } - }, - "renderingEngine": { - "target": "com.amazonaws.robomaker#RenderingEngine", - "traits": { - "smithy.api#documentation": "

The rendering engine for the simulation application.

" - } - }, - "tags": { - "target": "com.amazonaws.robomaker#TagMap", - "traits": { - "smithy.api#documentation": "

A map that contains tag keys and tag values that are attached to the simulation\n application.

" - } - }, - "environment": { - "target": "com.amazonaws.robomaker#Environment", - "traits": { - "smithy.api#documentation": "

The object that contains the Docker image URI used to create your simulation\n application.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.robomaker#CreateSimulationApplicationResponse": { - "type": "structure", - "members": { - "arn": { - "target": "com.amazonaws.robomaker#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the simulation application.

" - } - }, - "name": { - "target": "com.amazonaws.robomaker#Name", - "traits": { - "smithy.api#documentation": "

The name of the simulation application.

" - } - }, - "version": { - "target": "com.amazonaws.robomaker#Version", - "traits": { - "smithy.api#documentation": "

The version of the simulation application.

" - } - }, - "sources": { - "target": "com.amazonaws.robomaker#Sources", - "traits": { - "smithy.api#documentation": "

The sources of the simulation application.

" - } - }, - "simulationSoftwareSuite": { - "target": "com.amazonaws.robomaker#SimulationSoftwareSuite", - "traits": { - "smithy.api#documentation": "

The simulation software suite used by the simulation application.

" - } - }, - "robotSoftwareSuite": { - "target": "com.amazonaws.robomaker#RobotSoftwareSuite", - "traits": { - "smithy.api#documentation": "

Information about the robot software suite.

" - } - }, - "renderingEngine": { - "target": "com.amazonaws.robomaker#RenderingEngine", - "traits": { - "smithy.api#documentation": "

The rendering engine for the simulation application.

" - } - }, - "lastUpdatedAt": { - "target": "com.amazonaws.robomaker#LastUpdatedAt", - "traits": { - "smithy.api#documentation": "

The time, in milliseconds since the epoch, when the simulation application was last\n updated.

" - } - }, - "revisionId": { - "target": "com.amazonaws.robomaker#RevisionId", - "traits": { - "smithy.api#documentation": "

The revision id of the simulation application.

" - } - }, - "tags": { - "target": "com.amazonaws.robomaker#TagMap", - "traits": { - "smithy.api#documentation": "

The list of all tags added to the simulation application.

" - } - }, - "environment": { - "target": "com.amazonaws.robomaker#Environment", - "traits": { - "smithy.api#documentation": "

The object that contains the Docker image URI that you used to create your simulation\n application.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.robomaker#CreateSimulationApplicationVersion": { - "type": "operation", - "input": { - "target": "com.amazonaws.robomaker#CreateSimulationApplicationVersionRequest" - }, - "output": { - "target": "com.amazonaws.robomaker#CreateSimulationApplicationVersionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.robomaker#IdempotentParameterMismatchException" - }, - { - "target": "com.amazonaws.robomaker#InternalServerException" - }, - { - "target": "com.amazonaws.robomaker#InvalidParameterException" - }, - { - "target": "com.amazonaws.robomaker#LimitExceededException" - }, - { - "target": "com.amazonaws.robomaker#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "\n

End of support notice: On September 10, 2025, Amazon Web Services\n will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will\n no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. \n For more information on transitioning to Batch to help run containerized\n simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.\n

\n \n

Creates a simulation application with a specific revision id.

", - "smithy.api#http": { - "method": "POST", - "uri": "/createSimulationApplicationVersion", - "code": 200 - } - } - }, - "com.amazonaws.robomaker#CreateSimulationApplicationVersionRequest": { - "type": "structure", - "members": { - "application": { - "target": "com.amazonaws.robomaker#Arn", - "traits": { - "smithy.api#documentation": "

The application information for the simulation application.

", - "smithy.api#required": {} - } - }, - "currentRevisionId": { - "target": "com.amazonaws.robomaker#RevisionId", - "traits": { - "smithy.api#documentation": "

The current revision id for the simulation application. If you provide a value and it\n matches the latest revision ID, a new version will be created.

" - } - }, - "s3Etags": { - "target": "com.amazonaws.robomaker#S3Etags", - "traits": { - "smithy.api#documentation": "

The Amazon S3 eTag identifier for the zip file bundle that you use to create the\n simulation application.

" - } - }, - "imageDigest": { - "target": "com.amazonaws.robomaker#ImageDigest", - "traits": { - "smithy.api#documentation": "

The SHA256 digest used to identify the Docker image URI used to created the simulation\n application.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.robomaker#CreateSimulationApplicationVersionResponse": { - "type": "structure", - "members": { - "arn": { - "target": "com.amazonaws.robomaker#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the simulation application.

" - } - }, - "name": { - "target": "com.amazonaws.robomaker#Name", - "traits": { - "smithy.api#documentation": "

The name of the simulation application.

" - } - }, - "version": { - "target": "com.amazonaws.robomaker#Version", - "traits": { - "smithy.api#documentation": "

The version of the simulation application.

" - } - }, - "sources": { - "target": "com.amazonaws.robomaker#Sources", - "traits": { - "smithy.api#documentation": "

The sources of the simulation application.

" - } - }, - "simulationSoftwareSuite": { - "target": "com.amazonaws.robomaker#SimulationSoftwareSuite", - "traits": { - "smithy.api#documentation": "

The simulation software suite used by the simulation application.

" - } - }, - "robotSoftwareSuite": { - "target": "com.amazonaws.robomaker#RobotSoftwareSuite", - "traits": { - "smithy.api#documentation": "

Information about the robot software suite.

" - } - }, - "renderingEngine": { - "target": "com.amazonaws.robomaker#RenderingEngine", - "traits": { - "smithy.api#documentation": "

The rendering engine for the simulation application.

" - } - }, - "lastUpdatedAt": { - "target": "com.amazonaws.robomaker#LastUpdatedAt", - "traits": { - "smithy.api#documentation": "

The time, in milliseconds since the epoch, when the simulation application was last\n updated.

" - } - }, - "revisionId": { - "target": "com.amazonaws.robomaker#RevisionId", - "traits": { - "smithy.api#documentation": "

The revision ID of the simulation application.

" - } - }, - "environment": { - "target": "com.amazonaws.robomaker#Environment", - "traits": { - "smithy.api#documentation": "

The object that contains the Docker image URI used to create the simulation\n application.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.robomaker#CreateSimulationJob": { - "type": "operation", - "input": { - "target": "com.amazonaws.robomaker#CreateSimulationJobRequest" - }, - "output": { - "target": "com.amazonaws.robomaker#CreateSimulationJobResponse" - }, - "errors": [ - { - "target": "com.amazonaws.robomaker#IdempotentParameterMismatchException" - }, - { - "target": "com.amazonaws.robomaker#InternalServerException" - }, - { - "target": "com.amazonaws.robomaker#InvalidParameterException" - }, - { - "target": "com.amazonaws.robomaker#LimitExceededException" - }, - { - "target": "com.amazonaws.robomaker#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.robomaker#ServiceUnavailableException" - }, - { - "target": "com.amazonaws.robomaker#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "\n

End of support notice: On September 10, 2025, Amazon Web Services\n will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will\n no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. \n For more information on transitioning to Batch to help run containerized\n simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.\n

\n \n

Creates a simulation job.

\n \n

After 90 days, simulation jobs expire and will be deleted. They will no longer be\n accessible.

\n ", - "smithy.api#http": { - "method": "POST", - "uri": "/createSimulationJob", - "code": 200 - } - } - }, - "com.amazonaws.robomaker#CreateSimulationJobRequest": { - "type": "structure", - "members": { - "clientRequestToken": { - "target": "com.amazonaws.robomaker#ClientRequestToken", - "traits": { - "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request.

", - "smithy.api#idempotencyToken": {} - } - }, - "outputLocation": { - "target": "com.amazonaws.robomaker#OutputLocation", - "traits": { - "smithy.api#documentation": "

Location for output files generated by the simulation job.

" - } - }, - "loggingConfig": { - "target": "com.amazonaws.robomaker#LoggingConfig", - "traits": { - "smithy.api#documentation": "

The logging configuration.

" - } - }, - "maxJobDurationInSeconds": { - "target": "com.amazonaws.robomaker#JobDuration", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum simulation job duration in seconds (up to 14 days or 1,209,600 seconds. When\n maxJobDurationInSeconds is reached, the simulation job will status will\n transition to Completed.

", - "smithy.api#required": {} - } - }, - "iamRole": { - "target": "com.amazonaws.robomaker#IamRole", - "traits": { - "smithy.api#documentation": "

The IAM role name that allows the simulation instance to call the AWS APIs that are\n specified in its associated policies on your behalf. This is how credentials are passed in\n to your simulation job.

", - "smithy.api#required": {} - } - }, - "failureBehavior": { - "target": "com.amazonaws.robomaker#FailureBehavior", - "traits": { - "smithy.api#documentation": "

The failure behavior the simulation job.

\n
\n
Continue
\n
\n

Leaves the instance running for its maximum timeout duration after a\n 4XX error code.

\n
\n
Fail
\n
\n

Stop the simulation job and terminate the instance.

\n
\n
" - } - }, - "robotApplications": { - "target": "com.amazonaws.robomaker#RobotApplicationConfigs", - "traits": { - "smithy.api#documentation": "

The robot application to use in the simulation job.

" - } - }, - "simulationApplications": { - "target": "com.amazonaws.robomaker#SimulationApplicationConfigs", - "traits": { - "smithy.api#documentation": "

The simulation application to use in the simulation job.

" - } - }, - "dataSources": { - "target": "com.amazonaws.robomaker#DataSourceConfigs", - "traits": { - "smithy.api#documentation": "

Specify data sources to mount read-only files from S3 into your simulation. These files\n are available under /opt/robomaker/datasources/data_source_name.

\n \n

There is a limit of 100 files and a combined size of 25GB for all\n DataSourceConfig objects.

\n " - } - }, - "tags": { - "target": "com.amazonaws.robomaker#TagMap", - "traits": { - "smithy.api#documentation": "

A map that contains tag keys and tag values that are attached to the simulation\n job.

" - } - }, - "vpcConfig": { - "target": "com.amazonaws.robomaker#VPCConfig", - "traits": { - "smithy.api#documentation": "

If your simulation job accesses resources in a VPC, you provide this parameter\n identifying the list of security group IDs and subnet IDs. These must belong to the same\n VPC. You must provide at least one security group and one subnet ID.

" - } - }, - "compute": { - "target": "com.amazonaws.robomaker#Compute", - "traits": { - "smithy.api#documentation": "

Compute information for the simulation job.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.robomaker#CreateSimulationJobRequests": { - "type": "list", - "member": { - "target": "com.amazonaws.robomaker#SimulationJobRequest" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1000 - } - } - }, - "com.amazonaws.robomaker#CreateSimulationJobResponse": { - "type": "structure", - "members": { - "arn": { - "target": "com.amazonaws.robomaker#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the simulation job.

" - } - }, - "status": { - "target": "com.amazonaws.robomaker#SimulationJobStatus", - "traits": { - "smithy.api#documentation": "

The status of the simulation job.

" - } - }, - "lastStartedAt": { - "target": "com.amazonaws.robomaker#LastStartedAt", - "traits": { - "smithy.api#documentation": "

The time, in milliseconds since the epoch, when the simulation job was last\n started.

" - } - }, - "lastUpdatedAt": { - "target": "com.amazonaws.robomaker#LastUpdatedAt", - "traits": { - "smithy.api#documentation": "

The time, in milliseconds since the epoch, when the simulation job was last\n updated.

" - } - }, - "failureBehavior": { - "target": "com.amazonaws.robomaker#FailureBehavior", - "traits": { - "smithy.api#documentation": "

the failure behavior for the simulation job.

" - } - }, - "failureCode": { - "target": "com.amazonaws.robomaker#SimulationJobErrorCode", - "traits": { - "smithy.api#documentation": "

The failure code of the simulation job if it failed:

\n
\n
InternalServiceError
\n
\n

Internal service error.

\n
\n
RobotApplicationCrash
\n
\n

Robot application exited abnormally.

\n
\n
SimulationApplicationCrash
\n
\n

Simulation application exited abnormally.

\n
\n
BadPermissionsRobotApplication
\n
\n

Robot application bundle could not be downloaded.

\n
\n
BadPermissionsSimulationApplication
\n
\n

Simulation application bundle could not be downloaded.

\n
\n
BadPermissionsS3Output
\n
\n

Unable to publish outputs to customer-provided S3 bucket.

\n
\n
BadPermissionsCloudwatchLogs
\n
\n

Unable to publish logs to customer-provided CloudWatch Logs resource.

\n
\n
SubnetIpLimitExceeded
\n
\n

Subnet IP limit exceeded.

\n
\n
ENILimitExceeded
\n
\n

ENI limit exceeded.

\n
\n
BadPermissionsUserCredentials
\n
\n

Unable to use the Role provided.

\n
\n
InvalidBundleRobotApplication
\n
\n

Robot bundle cannot be extracted (invalid format, bundling error, or other\n issue).

\n
\n
InvalidBundleSimulationApplication
\n
\n

Simulation bundle cannot be extracted (invalid format, bundling error, or other\n issue).

\n
\n
RobotApplicationVersionMismatchedEtag
\n
\n

Etag for RobotApplication does not match value during version creation.

\n
\n
SimulationApplicationVersionMismatchedEtag
\n
\n

Etag for SimulationApplication does not match value during version\n creation.

\n
\n
" - } - }, - "clientRequestToken": { - "target": "com.amazonaws.robomaker#ClientRequestToken", - "traits": { - "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request.

" - } - }, - "outputLocation": { - "target": "com.amazonaws.robomaker#OutputLocation", - "traits": { - "smithy.api#documentation": "

Simulation job output files location.

" - } - }, - "loggingConfig": { - "target": "com.amazonaws.robomaker#LoggingConfig", - "traits": { - "smithy.api#documentation": "

The logging configuration.

" - } - }, - "maxJobDurationInSeconds": { - "target": "com.amazonaws.robomaker#JobDuration", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum simulation job duration in seconds.

" - } - }, - "simulationTimeMillis": { - "target": "com.amazonaws.robomaker#SimulationTimeMillis", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The simulation job execution duration in milliseconds.

" - } - }, - "iamRole": { - "target": "com.amazonaws.robomaker#IamRole", - "traits": { - "smithy.api#documentation": "

The IAM role that allows the simulation job to call the AWS APIs that are specified in\n its associated policies on your behalf.

" - } - }, - "robotApplications": { - "target": "com.amazonaws.robomaker#RobotApplicationConfigs", - "traits": { - "smithy.api#documentation": "

The robot application used by the simulation job.

" - } - }, - "simulationApplications": { - "target": "com.amazonaws.robomaker#SimulationApplicationConfigs", - "traits": { - "smithy.api#documentation": "

The simulation application used by the simulation job.

" - } - }, - "dataSources": { - "target": "com.amazonaws.robomaker#DataSources", - "traits": { - "smithy.api#documentation": "

The data sources for the simulation job.

" - } - }, - "tags": { - "target": "com.amazonaws.robomaker#TagMap", - "traits": { - "smithy.api#documentation": "

The list of all tags added to the simulation job.

" - } - }, - "vpcConfig": { - "target": "com.amazonaws.robomaker#VPCConfigResponse", - "traits": { - "smithy.api#documentation": "

Information about the vpc configuration.

" - } - }, - "compute": { - "target": "com.amazonaws.robomaker#ComputeResponse", - "traits": { - "smithy.api#documentation": "

Compute information for the simulation job.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.robomaker#CreateWorldExportJob": { - "type": "operation", - "input": { - "target": "com.amazonaws.robomaker#CreateWorldExportJobRequest" - }, - "output": { - "target": "com.amazonaws.robomaker#CreateWorldExportJobResponse" - }, - "errors": [ - { - "target": "com.amazonaws.robomaker#IdempotentParameterMismatchException" - }, - { - "target": "com.amazonaws.robomaker#InternalServerException" - }, - { - "target": "com.amazonaws.robomaker#InvalidParameterException" - }, - { - "target": "com.amazonaws.robomaker#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.robomaker#ServiceUnavailableException" - }, - { - "target": "com.amazonaws.robomaker#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "\n

End of support notice: On September 10, 2025, Amazon Web Services\n will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will\n no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. \n For more information on transitioning to Batch to help run containerized\n simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.\n

\n \n

Creates a world export job.

", - "smithy.api#http": { - "method": "POST", - "uri": "/createWorldExportJob", - "code": 200 - } - } - }, - "com.amazonaws.robomaker#CreateWorldExportJobRequest": { - "type": "structure", - "members": { - "clientRequestToken": { - "target": "com.amazonaws.robomaker#ClientRequestToken", - "traits": { - "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request.

", - "smithy.api#idempotencyToken": {} - } - }, - "worlds": { - "target": "com.amazonaws.robomaker#Arns", - "traits": { - "smithy.api#documentation": "

A list of Amazon Resource Names (arns) that correspond to worlds to export.

", - "smithy.api#required": {} - } - }, - "outputLocation": { - "target": "com.amazonaws.robomaker#OutputLocation", - "traits": { - "smithy.api#required": {} - } - }, - "iamRole": { - "target": "com.amazonaws.robomaker#IamRole", - "traits": { - "smithy.api#documentation": "

The IAM role that the world export process uses to access the Amazon S3 bucket and put\n the export.

", - "smithy.api#required": {} - } - }, - "tags": { - "target": "com.amazonaws.robomaker#TagMap", - "traits": { - "smithy.api#documentation": "

A map that contains tag keys and tag values that are attached to the world export\n job.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.robomaker#CreateWorldExportJobResponse": { - "type": "structure", - "members": { - "arn": { - "target": "com.amazonaws.robomaker#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the world export job.

" - } - }, - "status": { - "target": "com.amazonaws.robomaker#WorldExportJobStatus", - "traits": { - "smithy.api#documentation": "

The status of the world export job.

\n
\n
Pending
\n
\n

The world export job request is pending.

\n
\n
Running
\n
\n

The world export job is running.

\n
\n
Completed
\n
\n

The world export job completed.

\n
\n
Failed
\n
\n

The world export job failed. See failureCode for more information.\n

\n
\n
Canceled
\n
\n

The world export job was cancelled.

\n
\n
Canceling
\n
\n

The world export job is being cancelled.

\n
\n
" - } - }, - "createdAt": { - "target": "com.amazonaws.robomaker#CreatedAt", - "traits": { - "smithy.api#documentation": "

The time, in milliseconds since the epoch, when the world export job was created.

" - } - }, - "failureCode": { - "target": "com.amazonaws.robomaker#WorldExportJobErrorCode", - "traits": { - "smithy.api#documentation": "

The failure code of the world export job if it failed:

\n
\n
InternalServiceError
\n
\n

Internal service error.

\n
\n
LimitExceeded
\n
\n

The requested resource exceeds the maximum number allowed, or the number of\n concurrent stream requests exceeds the maximum number allowed.

\n
\n
ResourceNotFound
\n
\n

The specified resource could not be found.

\n
\n
RequestThrottled
\n
\n

The request was throttled.

\n
\n
InvalidInput
\n
\n

An input parameter in the request is not valid.

\n
\n
AllWorldGenerationFailed
\n
\n

All of the worlds in the world generation job failed. This can happen if your\n worldCount is greater than 50 or less than 1.

\n
\n
\n

For more information about troubleshooting WorldForge, see Troubleshooting Simulation WorldForge.

" - } - }, - "clientRequestToken": { - "target": "com.amazonaws.robomaker#ClientRequestToken", - "traits": { - "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request.

" - } - }, - "outputLocation": { - "target": "com.amazonaws.robomaker#OutputLocation" - }, - "iamRole": { - "target": "com.amazonaws.robomaker#IamRole", - "traits": { - "smithy.api#documentation": "

The IAM role that the world export process uses to access the Amazon S3 bucket and put\n the export.

" - } - }, - "tags": { - "target": "com.amazonaws.robomaker#TagMap", - "traits": { - "smithy.api#documentation": "

A map that contains tag keys and tag values that are attached to the world export\n job.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.robomaker#CreateWorldGenerationJob": { - "type": "operation", - "input": { - "target": "com.amazonaws.robomaker#CreateWorldGenerationJobRequest" - }, - "output": { - "target": "com.amazonaws.robomaker#CreateWorldGenerationJobResponse" - }, - "errors": [ - { - "target": "com.amazonaws.robomaker#IdempotentParameterMismatchException" - }, - { - "target": "com.amazonaws.robomaker#InternalServerException" - }, - { - "target": "com.amazonaws.robomaker#InvalidParameterException" - }, - { - "target": "com.amazonaws.robomaker#LimitExceededException" - }, - { - "target": "com.amazonaws.robomaker#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.robomaker#ServiceUnavailableException" - }, - { - "target": "com.amazonaws.robomaker#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "\n

End of support notice: On September 10, 2025, Amazon Web Services\n will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will\n no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. \n For more information on transitioning to Batch to help run containerized\n simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.\n

\n \n

Creates worlds using the specified template.

", - "smithy.api#http": { - "method": "POST", - "uri": "/createWorldGenerationJob", - "code": 200 - } - } - }, - "com.amazonaws.robomaker#CreateWorldGenerationJobRequest": { - "type": "structure", - "members": { - "clientRequestToken": { - "target": "com.amazonaws.robomaker#ClientRequestToken", - "traits": { - "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request.

", - "smithy.api#idempotencyToken": {} - } - }, - "template": { - "target": "com.amazonaws.robomaker#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (arn) of the world template describing the worlds you want to\n create.

", - "smithy.api#required": {} - } - }, - "worldCount": { - "target": "com.amazonaws.robomaker#WorldCount", - "traits": { - "smithy.api#documentation": "

Information about the world count.

", - "smithy.api#required": {} - } - }, - "tags": { - "target": "com.amazonaws.robomaker#TagMap", - "traits": { - "smithy.api#documentation": "

A map that contains tag keys and tag values that are attached to the world generator\n job.

" - } - }, - "worldTags": { - "target": "com.amazonaws.robomaker#TagMap", - "traits": { - "smithy.api#documentation": "

A map that contains tag keys and tag values that are attached to the generated\n worlds.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.robomaker#CreateWorldGenerationJobResponse": { - "type": "structure", - "members": { - "arn": { - "target": "com.amazonaws.robomaker#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the world generator job.

" - } - }, - "status": { - "target": "com.amazonaws.robomaker#WorldGenerationJobStatus", - "traits": { - "smithy.api#documentation": "

The status of the world generator job.

\n
\n
Pending
\n
\n

The world generator job request is pending.

\n
\n
Running
\n
\n

The world generator job is running.

\n
\n
Completed
\n
\n

The world generator job completed.

\n
\n
Failed
\n
\n

The world generator job failed. See failureCode for more\n information.

\n
\n
PartialFailed
\n
\n

Some worlds did not generate.

\n
\n
Canceled
\n
\n

The world generator job was cancelled.

\n
\n
Canceling
\n
\n

The world generator job is being cancelled.

\n
\n
" - } - }, - "createdAt": { - "target": "com.amazonaws.robomaker#CreatedAt", - "traits": { - "smithy.api#documentation": "

The time, in milliseconds since the epoch, when the world generator job was\n created.

" - } - }, - "failureCode": { - "target": "com.amazonaws.robomaker#WorldGenerationJobErrorCode", - "traits": { - "smithy.api#documentation": "

The failure code of the world generator job if it failed:

\n
\n
InternalServiceError
\n
\n

Internal service error.

\n
\n
LimitExceeded
\n
\n

The requested resource exceeds the maximum number allowed, or the number of\n concurrent stream requests exceeds the maximum number allowed.

\n
\n
ResourceNotFound
\n
\n

The specified resource could not be found.

\n
\n
RequestThrottled
\n
\n

The request was throttled.

\n
\n
InvalidInput
\n
\n

An input parameter in the request is not valid.

\n
\n
" - } - }, - "clientRequestToken": { - "target": "com.amazonaws.robomaker#ClientRequestToken", - "traits": { - "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request.

" - } - }, - "template": { - "target": "com.amazonaws.robomaker#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (arn) of the world template.

" - } - }, - "worldCount": { - "target": "com.amazonaws.robomaker#WorldCount", - "traits": { - "smithy.api#documentation": "

Information about the world count.

" - } - }, - "tags": { - "target": "com.amazonaws.robomaker#TagMap", - "traits": { - "smithy.api#documentation": "

A map that contains tag keys and tag values that are attached to the world generator\n job.

" - } - }, - "worldTags": { - "target": "com.amazonaws.robomaker#TagMap", - "traits": { - "smithy.api#documentation": "

A map that contains tag keys and tag values that are attached to the generated\n worlds.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.robomaker#CreateWorldTemplate": { - "type": "operation", - "input": { - "target": "com.amazonaws.robomaker#CreateWorldTemplateRequest" - }, - "output": { - "target": "com.amazonaws.robomaker#CreateWorldTemplateResponse" - }, - "errors": [ - { - "target": "com.amazonaws.robomaker#InternalServerException" - }, - { - "target": "com.amazonaws.robomaker#InvalidParameterException" - }, - { - "target": "com.amazonaws.robomaker#LimitExceededException" - }, - { - "target": "com.amazonaws.robomaker#ResourceAlreadyExistsException" - }, - { - "target": "com.amazonaws.robomaker#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.robomaker#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "\n

End of support notice: On September 10, 2025, Amazon Web Services\n will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will\n no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. \n For more information on transitioning to Batch to help run containerized\n simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.\n

\n \n

Creates a world template.

", - "smithy.api#http": { - "method": "POST", - "uri": "/createWorldTemplate", - "code": 200 - } - } - }, - "com.amazonaws.robomaker#CreateWorldTemplateRequest": { - "type": "structure", - "members": { - "clientRequestToken": { - "target": "com.amazonaws.robomaker#ClientRequestToken", - "traits": { - "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request.

" - } - }, - "name": { - "target": "com.amazonaws.robomaker#TemplateName", - "traits": { - "smithy.api#documentation": "

The name of the world template.

" - } - }, - "templateBody": { - "target": "com.amazonaws.robomaker#Json", - "traits": { - "smithy.api#documentation": "

The world template body.

" - } - }, - "templateLocation": { - "target": "com.amazonaws.robomaker#TemplateLocation", - "traits": { - "smithy.api#documentation": "

The location of the world template.

" - } - }, - "tags": { - "target": "com.amazonaws.robomaker#TagMap", - "traits": { - "smithy.api#documentation": "

A map that contains tag keys and tag values that are attached to the world\n template.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.robomaker#CreateWorldTemplateResponse": { - "type": "structure", - "members": { - "arn": { - "target": "com.amazonaws.robomaker#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the world template.

" - } - }, - "clientRequestToken": { - "target": "com.amazonaws.robomaker#ClientRequestToken", - "traits": { - "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request.

" - } - }, - "createdAt": { - "target": "com.amazonaws.robomaker#CreatedAt", - "traits": { - "smithy.api#documentation": "

The time, in milliseconds since the epoch, when the world template was created.

" - } - }, - "name": { - "target": "com.amazonaws.robomaker#TemplateName", - "traits": { - "smithy.api#documentation": "

The name of the world template.

" - } - }, - "tags": { - "target": "com.amazonaws.robomaker#TagMap", - "traits": { - "smithy.api#documentation": "

A map that contains tag keys and tag values that are attached to the world\n template.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.robomaker#CreatedAt": { - "type": "timestamp" - }, - "com.amazonaws.robomaker#DataSource": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.robomaker#Name", - "traits": { - "smithy.api#documentation": "

The name of the data source.

" - } - }, - "s3Bucket": { - "target": "com.amazonaws.robomaker#S3Bucket", - "traits": { - "smithy.api#documentation": "

The S3 bucket where the data files are located.

" - } - }, - "s3Keys": { - "target": "com.amazonaws.robomaker#S3KeyOutputs", - "traits": { - "smithy.api#documentation": "

The list of S3 keys identifying the data source files.

" - } - }, - "type": { - "target": "com.amazonaws.robomaker#DataSourceType", - "traits": { - "smithy.api#documentation": "

The data type for the data source that you're using for your container image or\n simulation job. You can use this field to specify whether your data source is an Archive,\n an Amazon S3 prefix, or a file.

\n

If you don't specify a field, the default value is File.

" - } - }, - "destination": { - "target": "com.amazonaws.robomaker#Path", - "traits": { - "smithy.api#documentation": "

The location where your files are mounted in the container image.

\n

If you've specified the type of the data source as an Archive,\n you must provide an Amazon S3 object key to your archive. The object key must point to\n either a .zip or .tar.gz file.

\n

If you've specified the type of the data source as a Prefix,\n you provide the Amazon S3 prefix that points to the files that you are using for your data\n source.

\n

If you've specified the type of the data source as a File, you\n provide the Amazon S3 path to the file that you're using as your data source.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about a data source.

" - } - }, - "com.amazonaws.robomaker#DataSourceConfig": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.robomaker#Name", - "traits": { - "smithy.api#documentation": "

The name of the data source.

", - "smithy.api#required": {} - } - }, - "s3Bucket": { - "target": "com.amazonaws.robomaker#S3Bucket", - "traits": { - "smithy.api#documentation": "

The S3 bucket where the data files are located.

", - "smithy.api#required": {} - } - }, - "s3Keys": { - "target": "com.amazonaws.robomaker#S3KeysOrPrefixes", - "traits": { - "smithy.api#documentation": "

The list of S3 keys identifying the data source files.

", - "smithy.api#required": {} - } - }, - "type": { - "target": "com.amazonaws.robomaker#DataSourceType", - "traits": { - "smithy.api#documentation": "

The data type for the data source that you're using for your container image or\n simulation job. You can use this field to specify whether your data source is an Archive,\n an Amazon S3 prefix, or a file.

\n

If you don't specify a field, the default value is File.

" - } - }, - "destination": { - "target": "com.amazonaws.robomaker#Path", - "traits": { - "smithy.api#documentation": "

The location where your files are mounted in the container image.

\n

If you've specified the type of the data source as an Archive,\n you must provide an Amazon S3 object key to your archive. The object key must point to\n either a .zip or .tar.gz file.

\n

If you've specified the type of the data source as a Prefix,\n you provide the Amazon S3 prefix that points to the files that you are using for your data\n source.

\n

If you've specified the type of the data source as a File, you\n provide the Amazon S3 path to the file that you're using as your data source.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about a data source.

" - } - }, - "com.amazonaws.robomaker#DataSourceConfigs": { - "type": "list", - "member": { - "target": "com.amazonaws.robomaker#DataSourceConfig" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 6 - } - } - }, - "com.amazonaws.robomaker#DataSourceNames": { - "type": "list", - "member": { - "target": "com.amazonaws.robomaker#Name" - } - }, - "com.amazonaws.robomaker#DataSourceType": { - "type": "enum", - "members": { - "Prefix": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Prefix" - } - }, - "Archive": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Archive" - } - }, - "File": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "File" - } - } - } - }, - "com.amazonaws.robomaker#DataSources": { - "type": "list", - "member": { - "target": "com.amazonaws.robomaker#DataSource" - } - }, - "com.amazonaws.robomaker#DeleteFleet": { - "type": "operation", - "input": { - "target": "com.amazonaws.robomaker#DeleteFleetRequest" - }, - "output": { - "target": "com.amazonaws.robomaker#DeleteFleetResponse" - }, - "errors": [ - { - "target": "com.amazonaws.robomaker#InternalServerException" - }, - { - "target": "com.amazonaws.robomaker#InvalidParameterException" - }, - { - "target": "com.amazonaws.robomaker#ThrottlingException" - } - ], - "traits": { - "smithy.api#deprecated": { - "message": "Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." - }, - "smithy.api#documentation": "\n

End of support notice: On September 10, 2025, Amazon Web Services\n will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will\n no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. \n For more information on transitioning to Batch to help run containerized\n simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.\n

\n \n \n

This API is no longer supported. For more information, see the May 2, 2022 update in the Support policy page.

\n \n

Deletes a fleet.

", - "smithy.api#http": { - "method": "POST", - "uri": "/deleteFleet", - "code": 200 - } - } - }, - "com.amazonaws.robomaker#DeleteFleetRequest": { - "type": "structure", - "members": { - "fleet": { - "target": "com.amazonaws.robomaker#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the fleet.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#deprecated": { - "message": "Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." - }, - "smithy.api#input": {} - } - }, - "com.amazonaws.robomaker#DeleteFleetResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#deprecated": { - "message": "Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." - }, - "smithy.api#output": {} - } - }, - "com.amazonaws.robomaker#DeleteRobot": { - "type": "operation", - "input": { - "target": "com.amazonaws.robomaker#DeleteRobotRequest" - }, - "output": { - "target": "com.amazonaws.robomaker#DeleteRobotResponse" - }, - "errors": [ - { - "target": "com.amazonaws.robomaker#InternalServerException" - }, - { - "target": "com.amazonaws.robomaker#InvalidParameterException" - }, - { - "target": "com.amazonaws.robomaker#ThrottlingException" - } - ], - "traits": { - "smithy.api#deprecated": { - "message": "Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." - }, - "smithy.api#documentation": "\n

End of support notice: On September 10, 2025, Amazon Web Services\n will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will\n no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. \n For more information on transitioning to Batch to help run containerized\n simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.\n

\n \n \n

This API is no longer supported. For more information, see the May 2, 2022 update in the Support policy page.

\n \n

Deletes a robot.

", - "smithy.api#http": { - "method": "POST", - "uri": "/deleteRobot", - "code": 200 - } - } - }, - "com.amazonaws.robomaker#DeleteRobotApplication": { - "type": "operation", - "input": { - "target": "com.amazonaws.robomaker#DeleteRobotApplicationRequest" - }, - "output": { - "target": "com.amazonaws.robomaker#DeleteRobotApplicationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.robomaker#InternalServerException" - }, - { - "target": "com.amazonaws.robomaker#InvalidParameterException" - }, - { - "target": "com.amazonaws.robomaker#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "\n

End of support notice: On September 10, 2025, Amazon Web Services\n will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will\n no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. \n For more information on transitioning to Batch to help run containerized\n simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.\n

\n \n

Deletes a robot application.

", - "smithy.api#http": { - "method": "POST", - "uri": "/deleteRobotApplication", - "code": 200 - } - } - }, - "com.amazonaws.robomaker#DeleteRobotApplicationRequest": { - "type": "structure", - "members": { - "application": { - "target": "com.amazonaws.robomaker#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the the robot application.

", - "smithy.api#required": {} - } - }, - "applicationVersion": { - "target": "com.amazonaws.robomaker#Version", - "traits": { - "smithy.api#documentation": "

The version of the robot application to delete.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.robomaker#DeleteRobotApplicationResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.robomaker#DeleteRobotRequest": { - "type": "structure", - "members": { - "robot": { - "target": "com.amazonaws.robomaker#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the robot.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#deprecated": { - "message": "Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." - }, - "smithy.api#input": {} - } - }, - "com.amazonaws.robomaker#DeleteRobotResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#deprecated": { - "message": "Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." - }, - "smithy.api#output": {} - } - }, - "com.amazonaws.robomaker#DeleteSimulationApplication": { - "type": "operation", - "input": { - "target": "com.amazonaws.robomaker#DeleteSimulationApplicationRequest" - }, - "output": { - "target": "com.amazonaws.robomaker#DeleteSimulationApplicationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.robomaker#InternalServerException" - }, - { - "target": "com.amazonaws.robomaker#InvalidParameterException" - }, - { - "target": "com.amazonaws.robomaker#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "\n

End of support notice: On September 10, 2025, Amazon Web Services\n will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will\n no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. \n For more information on transitioning to Batch to help run containerized\n simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.\n

\n \n

Deletes a simulation application.

", - "smithy.api#http": { - "method": "POST", - "uri": "/deleteSimulationApplication", - "code": 200 - } - } - }, - "com.amazonaws.robomaker#DeleteSimulationApplicationRequest": { - "type": "structure", - "members": { - "application": { - "target": "com.amazonaws.robomaker#Arn", - "traits": { - "smithy.api#documentation": "

The application information for the simulation application to delete.

", - "smithy.api#required": {} - } - }, - "applicationVersion": { - "target": "com.amazonaws.robomaker#Version", - "traits": { - "smithy.api#documentation": "

The version of the simulation application to delete.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.robomaker#DeleteSimulationApplicationResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.robomaker#DeleteWorldTemplate": { - "type": "operation", - "input": { - "target": "com.amazonaws.robomaker#DeleteWorldTemplateRequest" - }, - "output": { - "target": "com.amazonaws.robomaker#DeleteWorldTemplateResponse" - }, - "errors": [ - { - "target": "com.amazonaws.robomaker#InternalServerException" - }, - { - "target": "com.amazonaws.robomaker#InvalidParameterException" - }, - { - "target": "com.amazonaws.robomaker#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.robomaker#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "\n

End of support notice: On September 10, 2025, Amazon Web Services\n will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will\n no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. \n For more information on transitioning to Batch to help run containerized\n simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.\n

\n \n

Deletes a world template.

", - "smithy.api#http": { - "method": "POST", - "uri": "/deleteWorldTemplate", - "code": 200 - } - } - }, - "com.amazonaws.robomaker#DeleteWorldTemplateRequest": { - "type": "structure", - "members": { - "template": { - "target": "com.amazonaws.robomaker#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (arn) of the world template you want to delete.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.robomaker#DeleteWorldTemplateResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.robomaker#DeploymentApplicationConfig": { - "type": "structure", - "members": { - "application": { - "target": "com.amazonaws.robomaker#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the robot application.

", - "smithy.api#required": {} - } - }, - "applicationVersion": { - "target": "com.amazonaws.robomaker#DeploymentVersion", - "traits": { - "smithy.api#documentation": "

The version of the application.

", - "smithy.api#required": {} - } - }, - "launchConfig": { - "target": "com.amazonaws.robomaker#DeploymentLaunchConfig", - "traits": { - "smithy.api#documentation": "

The launch configuration.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about a deployment application configuration.

" - } - }, - "com.amazonaws.robomaker#DeploymentApplicationConfigs": { - "type": "list", - "member": { - "target": "com.amazonaws.robomaker#DeploymentApplicationConfig" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1 - } - } - }, - "com.amazonaws.robomaker#DeploymentConfig": { - "type": "structure", - "members": { - "concurrentDeploymentPercentage": { - "target": "com.amazonaws.robomaker#Percentage", - "traits": { - "smithy.api#documentation": "

The percentage of robots receiving the deployment at the same time.

" - } - }, - "failureThresholdPercentage": { - "target": "com.amazonaws.robomaker#Percentage", - "traits": { - "smithy.api#documentation": "

The percentage of deployments that need to fail before stopping deployment.

" - } - }, - "robotDeploymentTimeoutInSeconds": { - "target": "com.amazonaws.robomaker#DeploymentTimeout", - "traits": { - "smithy.api#documentation": "

The amount of time, in seconds, to wait for deployment to a single robot to complete.\n Choose a time between 1 minute and 7 days. The default is 5 hours.

" - } - }, - "downloadConditionFile": { - "target": "com.amazonaws.robomaker#S3Object", - "traits": { - "smithy.api#documentation": "

The download condition file.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about a deployment configuration.

" - } - }, - "com.amazonaws.robomaker#DeploymentJob": { - "type": "structure", - "members": { - "arn": { - "target": "com.amazonaws.robomaker#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the deployment job.

" - } - }, - "fleet": { - "target": "com.amazonaws.robomaker#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the fleet.

" - } - }, - "status": { - "target": "com.amazonaws.robomaker#DeploymentStatus", - "traits": { - "smithy.api#documentation": "

The status of the deployment job.

" - } - }, - "deploymentApplicationConfigs": { - "target": "com.amazonaws.robomaker#DeploymentApplicationConfigs", - "traits": { - "smithy.api#documentation": "

The deployment application configuration.

" - } - }, - "deploymentConfig": { - "target": "com.amazonaws.robomaker#DeploymentConfig", - "traits": { - "smithy.api#documentation": "

The deployment configuration.

" - } - }, - "failureReason": { - "target": "com.amazonaws.robomaker#GenericString", - "traits": { - "smithy.api#documentation": "

A short description of the reason why the deployment job failed.

" - } - }, - "failureCode": { - "target": "com.amazonaws.robomaker#DeploymentJobErrorCode", - "traits": { - "smithy.api#documentation": "

The deployment job failure code.

" - } - }, - "createdAt": { - "target": "com.amazonaws.robomaker#CreatedAt", - "traits": { - "smithy.api#documentation": "

The time, in milliseconds since the epoch, when the deployment job was created.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about a deployment job.

" - } - }, - "com.amazonaws.robomaker#DeploymentJobErrorCode": { - "type": "enum", - "members": { - "ResourceNotFound": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ResourceNotFound" - } - }, - "EnvironmentSetupError": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EnvironmentSetupError" - } - }, - "EtagMismatch": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EtagMismatch" - } - }, - "FailureThresholdBreached": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FailureThresholdBreached" - } - }, - "RobotDeploymentAborted": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RobotDeploymentAborted" - } - }, - "RobotDeploymentNoResponse": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RobotDeploymentNoResponse" - } - }, - "RobotAgentConnectionTimeout": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RobotAgentConnectionTimeout" - } - }, - "GreengrassDeploymentFailed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "GreengrassDeploymentFailed" - } - }, - "InvalidGreengrassGroup": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "InvalidGreengrassGroup" - } - }, - "MissingRobotArchitecture": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MissingRobotArchitecture" - } - }, - "MissingRobotApplicationArchitecture": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MissingRobotApplicationArchitecture" - } - }, - "MissingRobotDeploymentResource": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MissingRobotDeploymentResource" - } - }, - "GreengrassGroupVersionDoesNotExist": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "GreengrassGroupVersionDoesNotExist" - } - }, - "LambdaDeleted": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LambdaDeleted" - } - }, - "ExtractingBundleFailure": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ExtractingBundleFailure" - } - }, - "PreLaunchFileFailure": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PreLaunchFileFailure" - } - }, - "PostLaunchFileFailure": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PostLaunchFileFailure" - } - }, - "BadPermissionError": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BadPermissionError" - } - }, - "DownloadConditionFailed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DownloadConditionFailed" - } - }, - "BadLambdaAssociated": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BadLambdaAssociated" - } - }, - "InternalServerError": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "InternalServerError" - } - }, - "RobotApplicationDoesNotExist": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RobotApplicationDoesNotExist" - } - }, - "DeploymentFleetDoesNotExist": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DeploymentFleetDoesNotExist" - } - }, - "FleetDeploymentTimeout": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FleetDeploymentTimeout" - } - } - } - }, - "com.amazonaws.robomaker#DeploymentJobs": { - "type": "list", - "member": { - "target": "com.amazonaws.robomaker#DeploymentJob" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 200 - } - } - }, - "com.amazonaws.robomaker#DeploymentLaunchConfig": { - "type": "structure", - "members": { - "packageName": { - "target": "com.amazonaws.robomaker#Command", - "traits": { - "smithy.api#documentation": "

The package name.

", - "smithy.api#required": {} - } - }, - "preLaunchFile": { - "target": "com.amazonaws.robomaker#Path", - "traits": { - "smithy.api#documentation": "

The deployment pre-launch file. This file will be executed prior to the launch\n file.

" - } - }, - "launchFile": { - "target": "com.amazonaws.robomaker#Command", - "traits": { - "smithy.api#documentation": "

The launch file name.

", - "smithy.api#required": {} - } - }, - "postLaunchFile": { - "target": "com.amazonaws.robomaker#Path", - "traits": { - "smithy.api#documentation": "

The deployment post-launch file. This file will be executed after the launch\n file.

" - } - }, - "environmentVariables": { - "target": "com.amazonaws.robomaker#EnvironmentVariableMap", - "traits": { - "smithy.api#documentation": "

An array of key/value pairs specifying environment variables for the robot\n application

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Configuration information for a deployment launch.

" - } - }, - "com.amazonaws.robomaker#DeploymentStatus": { - "type": "enum", - "members": { - "Pending": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Pending" - } - }, - "Preparing": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Preparing" - } - }, - "InProgress": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "InProgress" - } - }, - "Failed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Failed" - } - }, - "Succeeded": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Succeeded" - } - }, - "Canceled": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Canceled" - } - } - } - }, - "com.amazonaws.robomaker#DeploymentTimeout": { - "type": "long" - }, - "com.amazonaws.robomaker#DeploymentVersion": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 255 - }, - "smithy.api#pattern": "^[0-9]*$" - } - }, - "com.amazonaws.robomaker#DeregisterRobot": { - "type": "operation", - "input": { - "target": "com.amazonaws.robomaker#DeregisterRobotRequest" - }, - "output": { - "target": "com.amazonaws.robomaker#DeregisterRobotResponse" - }, - "errors": [ - { - "target": "com.amazonaws.robomaker#InternalServerException" - }, - { - "target": "com.amazonaws.robomaker#InvalidParameterException" - }, - { - "target": "com.amazonaws.robomaker#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.robomaker#ThrottlingException" - } - ], - "traits": { - "smithy.api#deprecated": { - "message": "Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." - }, - "smithy.api#documentation": "\n

End of support notice: On September 10, 2025, Amazon Web Services\n will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will\n no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. \n For more information on transitioning to Batch to help run containerized\n simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.\n

\n \n \n

This API is no longer supported. For more information, see the May 2, 2022 update in the Support policy page.

\n \n

Deregisters a robot.

", - "smithy.api#http": { - "method": "POST", - "uri": "/deregisterRobot", - "code": 200 - } - } - }, - "com.amazonaws.robomaker#DeregisterRobotRequest": { - "type": "structure", - "members": { - "fleet": { - "target": "com.amazonaws.robomaker#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the fleet.

", - "smithy.api#required": {} - } - }, - "robot": { - "target": "com.amazonaws.robomaker#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the robot.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#deprecated": { - "message": "Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." - }, - "smithy.api#input": {} - } - }, - "com.amazonaws.robomaker#DeregisterRobotResponse": { - "type": "structure", - "members": { - "fleet": { - "target": "com.amazonaws.robomaker#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the fleet.

" - } - }, - "robot": { - "target": "com.amazonaws.robomaker#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the robot.

" - } - } - }, - "traits": { - "smithy.api#deprecated": { - "message": "Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." - }, - "smithy.api#output": {} - } - }, - "com.amazonaws.robomaker#DescribeDeploymentJob": { - "type": "operation", - "input": { - "target": "com.amazonaws.robomaker#DescribeDeploymentJobRequest" - }, - "output": { - "target": "com.amazonaws.robomaker#DescribeDeploymentJobResponse" - }, - "errors": [ - { - "target": "com.amazonaws.robomaker#InternalServerException" - }, - { - "target": "com.amazonaws.robomaker#InvalidParameterException" - }, - { - "target": "com.amazonaws.robomaker#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.robomaker#ThrottlingException" - } - ], - "traits": { - "smithy.api#deprecated": { - "message": "Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." - }, - "smithy.api#documentation": "\n

End of support notice: On September 10, 2025, Amazon Web Services\n will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will\n no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. \n For more information on transitioning to Batch to help run containerized\n simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.\n

\n \n \n

This API is no longer supported. For more information, see the May 2, 2022 update in the Support policy page.

\n \n

Describes a deployment job.

", - "smithy.api#http": { - "method": "POST", - "uri": "/describeDeploymentJob", - "code": 200 - } - } - }, - "com.amazonaws.robomaker#DescribeDeploymentJobRequest": { - "type": "structure", - "members": { - "job": { - "target": "com.amazonaws.robomaker#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the deployment job.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#deprecated": { - "message": "Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." - }, - "smithy.api#input": {} - } - }, - "com.amazonaws.robomaker#DescribeDeploymentJobResponse": { - "type": "structure", - "members": { - "arn": { - "target": "com.amazonaws.robomaker#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the deployment job.

" - } - }, - "fleet": { - "target": "com.amazonaws.robomaker#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the fleet.

" - } - }, - "status": { - "target": "com.amazonaws.robomaker#DeploymentStatus", - "traits": { - "smithy.api#documentation": "

The status of the deployment job.

" - } - }, - "deploymentConfig": { - "target": "com.amazonaws.robomaker#DeploymentConfig", - "traits": { - "smithy.api#documentation": "

The deployment configuration.

" - } - }, - "deploymentApplicationConfigs": { - "target": "com.amazonaws.robomaker#DeploymentApplicationConfigs", - "traits": { - "smithy.api#documentation": "

The deployment application configuration.

" - } - }, - "failureReason": { - "target": "com.amazonaws.robomaker#GenericString", - "traits": { - "smithy.api#documentation": "

A short description of the reason why the deployment job failed.

" - } - }, - "failureCode": { - "target": "com.amazonaws.robomaker#DeploymentJobErrorCode", - "traits": { - "smithy.api#documentation": "

The deployment job failure code.

" - } - }, - "createdAt": { - "target": "com.amazonaws.robomaker#CreatedAt", - "traits": { - "smithy.api#documentation": "

The time, in milliseconds since the epoch, when the deployment job was created.

" - } - }, - "robotDeploymentSummary": { - "target": "com.amazonaws.robomaker#RobotDeploymentSummary", - "traits": { - "smithy.api#documentation": "

A list of robot deployment summaries.

" - } - }, - "tags": { - "target": "com.amazonaws.robomaker#TagMap", - "traits": { - "smithy.api#documentation": "

The list of all tags added to the specified deployment job.

" - } - } - }, - "traits": { - "smithy.api#deprecated": { - "message": "Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." - }, - "smithy.api#output": {} - } - }, - "com.amazonaws.robomaker#DescribeFleet": { - "type": "operation", - "input": { - "target": "com.amazonaws.robomaker#DescribeFleetRequest" - }, - "output": { - "target": "com.amazonaws.robomaker#DescribeFleetResponse" - }, - "errors": [ - { - "target": "com.amazonaws.robomaker#InternalServerException" - }, - { - "target": "com.amazonaws.robomaker#InvalidParameterException" - }, - { - "target": "com.amazonaws.robomaker#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.robomaker#ThrottlingException" - } - ], - "traits": { - "smithy.api#deprecated": { - "message": "Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." - }, - "smithy.api#documentation": "\n

End of support notice: On September 10, 2025, Amazon Web Services\n will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will\n no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. \n For more information on transitioning to Batch to help run containerized\n simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.\n

\n \n \n

This API is no longer supported. For more information, see the May 2, 2022 update in the Support policy page.

\n \n

Describes a fleet.

", - "smithy.api#http": { - "method": "POST", - "uri": "/describeFleet", - "code": 200 - } - } - }, - "com.amazonaws.robomaker#DescribeFleetRequest": { - "type": "structure", - "members": { - "fleet": { - "target": "com.amazonaws.robomaker#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the fleet.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#deprecated": { - "message": "Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." - }, - "smithy.api#input": {} - } - }, - "com.amazonaws.robomaker#DescribeFleetResponse": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.robomaker#Name", - "traits": { - "smithy.api#documentation": "

The name of the fleet.

" - } - }, - "arn": { - "target": "com.amazonaws.robomaker#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the fleet.

" - } - }, - "robots": { - "target": "com.amazonaws.robomaker#Robots", - "traits": { - "smithy.api#documentation": "

A list of robots.

" - } - }, - "createdAt": { - "target": "com.amazonaws.robomaker#CreatedAt", - "traits": { - "smithy.api#documentation": "

The time, in milliseconds since the epoch, when the fleet was created.

" - } - }, - "lastDeploymentStatus": { - "target": "com.amazonaws.robomaker#DeploymentStatus", - "traits": { - "smithy.api#documentation": "

The status of the last deployment.

" - } - }, - "lastDeploymentJob": { - "target": "com.amazonaws.robomaker#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the last deployment job.

" - } - }, - "lastDeploymentTime": { - "target": "com.amazonaws.robomaker#CreatedAt", - "traits": { - "smithy.api#documentation": "

The time of the last deployment.

" - } - }, - "tags": { - "target": "com.amazonaws.robomaker#TagMap", - "traits": { - "smithy.api#documentation": "

The list of all tags added to the specified fleet.

" - } - } - }, - "traits": { - "smithy.api#deprecated": { - "message": "Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." - }, - "smithy.api#output": {} - } - }, - "com.amazonaws.robomaker#DescribeRobot": { - "type": "operation", - "input": { - "target": "com.amazonaws.robomaker#DescribeRobotRequest" - }, - "output": { - "target": "com.amazonaws.robomaker#DescribeRobotResponse" - }, - "errors": [ - { - "target": "com.amazonaws.robomaker#InternalServerException" - }, - { - "target": "com.amazonaws.robomaker#InvalidParameterException" - }, - { - "target": "com.amazonaws.robomaker#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.robomaker#ThrottlingException" - } - ], - "traits": { - "smithy.api#deprecated": { - "message": "Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." - }, - "smithy.api#documentation": "\n

End of support notice: On September 10, 2025, Amazon Web Services\n will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will\n no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. \n For more information on transitioning to Batch to help run containerized\n simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.\n

\n \n \n

This API is no longer supported. For more information, see the May 2, 2022 update in the Support policy page.

\n \n

Describes a robot.

", - "smithy.api#http": { - "method": "POST", - "uri": "/describeRobot", - "code": 200 - } - } - }, - "com.amazonaws.robomaker#DescribeRobotApplication": { - "type": "operation", - "input": { - "target": "com.amazonaws.robomaker#DescribeRobotApplicationRequest" - }, - "output": { - "target": "com.amazonaws.robomaker#DescribeRobotApplicationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.robomaker#InternalServerException" - }, - { - "target": "com.amazonaws.robomaker#InvalidParameterException" - }, - { - "target": "com.amazonaws.robomaker#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.robomaker#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "\n

End of support notice: On September 10, 2025, Amazon Web Services\n will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will\n no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. \n For more information on transitioning to Batch to help run containerized\n simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.\n

\n \n

Describes a robot application.

", - "smithy.api#http": { - "method": "POST", - "uri": "/describeRobotApplication", - "code": 200 - } - } - }, - "com.amazonaws.robomaker#DescribeRobotApplicationRequest": { - "type": "structure", - "members": { - "application": { - "target": "com.amazonaws.robomaker#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the robot application.

", - "smithy.api#required": {} - } - }, - "applicationVersion": { - "target": "com.amazonaws.robomaker#Version", - "traits": { - "smithy.api#documentation": "

The version of the robot application to describe.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.robomaker#DescribeRobotApplicationResponse": { - "type": "structure", - "members": { - "arn": { - "target": "com.amazonaws.robomaker#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the robot application.

" - } - }, - "name": { - "target": "com.amazonaws.robomaker#Name", - "traits": { - "smithy.api#documentation": "

The name of the robot application.

" - } - }, - "version": { - "target": "com.amazonaws.robomaker#Version", - "traits": { - "smithy.api#documentation": "

The version of the robot application.

" - } - }, - "sources": { - "target": "com.amazonaws.robomaker#Sources", - "traits": { - "smithy.api#documentation": "

The sources of the robot application.

" - } - }, - "robotSoftwareSuite": { - "target": "com.amazonaws.robomaker#RobotSoftwareSuite", - "traits": { - "smithy.api#documentation": "

The robot software suite used by the robot application.

" - } - }, - "revisionId": { - "target": "com.amazonaws.robomaker#RevisionId", - "traits": { - "smithy.api#documentation": "

The revision id of the robot application.

" - } - }, - "lastUpdatedAt": { - "target": "com.amazonaws.robomaker#LastUpdatedAt", - "traits": { - "smithy.api#documentation": "

The time, in milliseconds since the epoch, when the robot application was last\n updated.

" - } - }, - "tags": { - "target": "com.amazonaws.robomaker#TagMap", - "traits": { - "smithy.api#documentation": "

The list of all tags added to the specified robot application.

" - } - }, - "environment": { - "target": "com.amazonaws.robomaker#Environment", - "traits": { - "smithy.api#documentation": "

The object that contains the Docker image URI used to create the robot\n application.

" - } - }, - "imageDigest": { - "target": "com.amazonaws.robomaker#ImageDigest", - "traits": { - "smithy.api#documentation": "

A SHA256 identifier for the Docker image that you use for your robot application.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.robomaker#DescribeRobotRequest": { - "type": "structure", - "members": { - "robot": { - "target": "com.amazonaws.robomaker#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the robot to be described.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#deprecated": { - "message": "Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." - }, - "smithy.api#input": {} - } - }, - "com.amazonaws.robomaker#DescribeRobotResponse": { - "type": "structure", - "members": { - "arn": { - "target": "com.amazonaws.robomaker#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the robot.

" - } - }, - "name": { - "target": "com.amazonaws.robomaker#Name", - "traits": { - "smithy.api#documentation": "

The name of the robot.

" - } - }, - "fleetArn": { - "target": "com.amazonaws.robomaker#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the fleet.

" - } - }, - "status": { - "target": "com.amazonaws.robomaker#RobotStatus", - "traits": { - "smithy.api#documentation": "

The status of the fleet.

" - } - }, - "greengrassGroupId": { - "target": "com.amazonaws.robomaker#Id", - "traits": { - "smithy.api#documentation": "

The Greengrass group id.

" - } - }, - "createdAt": { - "target": "com.amazonaws.robomaker#CreatedAt", - "traits": { - "smithy.api#documentation": "

The time, in milliseconds since the epoch, when the robot was created.

" - } - }, - "architecture": { - "target": "com.amazonaws.robomaker#Architecture", - "traits": { - "smithy.api#documentation": "

The target architecture of the robot application.

" - } - }, - "lastDeploymentJob": { - "target": "com.amazonaws.robomaker#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the last deployment job.

" - } - }, - "lastDeploymentTime": { - "target": "com.amazonaws.robomaker#CreatedAt", - "traits": { - "smithy.api#documentation": "

The time of the last deployment job.

" - } - }, - "tags": { - "target": "com.amazonaws.robomaker#TagMap", - "traits": { - "smithy.api#documentation": "

The list of all tags added to the specified robot.

" - } - } - }, - "traits": { - "smithy.api#deprecated": { - "message": "Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." - }, - "smithy.api#output": {} - } - }, - "com.amazonaws.robomaker#DescribeSimulationApplication": { - "type": "operation", - "input": { - "target": "com.amazonaws.robomaker#DescribeSimulationApplicationRequest" - }, - "output": { - "target": "com.amazonaws.robomaker#DescribeSimulationApplicationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.robomaker#InternalServerException" - }, - { - "target": "com.amazonaws.robomaker#InvalidParameterException" - }, - { - "target": "com.amazonaws.robomaker#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.robomaker#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "\n

End of support notice: On September 10, 2025, Amazon Web Services\n will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will\n no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. \n For more information on transitioning to Batch to help run containerized\n simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.\n

\n \n

Describes a simulation application.

", - "smithy.api#http": { - "method": "POST", - "uri": "/describeSimulationApplication", - "code": 200 - } - } - }, - "com.amazonaws.robomaker#DescribeSimulationApplicationRequest": { - "type": "structure", - "members": { - "application": { - "target": "com.amazonaws.robomaker#Arn", - "traits": { - "smithy.api#documentation": "

The application information for the simulation application.

", - "smithy.api#required": {} - } - }, - "applicationVersion": { - "target": "com.amazonaws.robomaker#Version", - "traits": { - "smithy.api#documentation": "

The version of the simulation application to describe.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.robomaker#DescribeSimulationApplicationResponse": { - "type": "structure", - "members": { - "arn": { - "target": "com.amazonaws.robomaker#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the robot simulation application.

" - } - }, - "name": { - "target": "com.amazonaws.robomaker#Name", - "traits": { - "smithy.api#documentation": "

The name of the simulation application.

" - } - }, - "version": { - "target": "com.amazonaws.robomaker#Version", - "traits": { - "smithy.api#documentation": "

The version of the simulation application.

" - } - }, - "sources": { - "target": "com.amazonaws.robomaker#Sources", - "traits": { - "smithy.api#documentation": "

The sources of the simulation application.

" - } - }, - "simulationSoftwareSuite": { - "target": "com.amazonaws.robomaker#SimulationSoftwareSuite", - "traits": { - "smithy.api#documentation": "

The simulation software suite used by the simulation application.

" - } - }, - "robotSoftwareSuite": { - "target": "com.amazonaws.robomaker#RobotSoftwareSuite", - "traits": { - "smithy.api#documentation": "

Information about the robot software suite.

" - } - }, - "renderingEngine": { - "target": "com.amazonaws.robomaker#RenderingEngine", - "traits": { - "smithy.api#documentation": "

The rendering engine for the simulation application.

" - } - }, - "revisionId": { - "target": "com.amazonaws.robomaker#RevisionId", - "traits": { - "smithy.api#documentation": "

The revision id of the simulation application.

" - } - }, - "lastUpdatedAt": { - "target": "com.amazonaws.robomaker#LastUpdatedAt", - "traits": { - "smithy.api#documentation": "

The time, in milliseconds since the epoch, when the simulation application was last\n updated.

" - } - }, - "tags": { - "target": "com.amazonaws.robomaker#TagMap", - "traits": { - "smithy.api#documentation": "

The list of all tags added to the specified simulation application.

" - } - }, - "environment": { - "target": "com.amazonaws.robomaker#Environment", - "traits": { - "smithy.api#documentation": "

The object that contains the Docker image URI used to create the simulation\n application.

" - } - }, - "imageDigest": { - "target": "com.amazonaws.robomaker#ImageDigest", - "traits": { - "smithy.api#documentation": "

A SHA256 identifier for the Docker image that you use for your simulation\n application.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.robomaker#DescribeSimulationJob": { - "type": "operation", - "input": { - "target": "com.amazonaws.robomaker#DescribeSimulationJobRequest" - }, - "output": { - "target": "com.amazonaws.robomaker#DescribeSimulationJobResponse" - }, - "errors": [ - { - "target": "com.amazonaws.robomaker#InternalServerException" - }, - { - "target": "com.amazonaws.robomaker#InvalidParameterException" - }, - { - "target": "com.amazonaws.robomaker#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.robomaker#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "\n

End of support notice: On September 10, 2025, Amazon Web Services\n will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will\n no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. \n For more information on transitioning to Batch to help run containerized\n simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.\n

\n \n

Describes a simulation job.

", - "smithy.api#http": { - "method": "POST", - "uri": "/describeSimulationJob", - "code": 200 - } - } - }, - "com.amazonaws.robomaker#DescribeSimulationJobBatch": { - "type": "operation", - "input": { - "target": "com.amazonaws.robomaker#DescribeSimulationJobBatchRequest" - }, - "output": { - "target": "com.amazonaws.robomaker#DescribeSimulationJobBatchResponse" - }, - "errors": [ - { - "target": "com.amazonaws.robomaker#InternalServerException" - }, - { - "target": "com.amazonaws.robomaker#InvalidParameterException" - }, - { - "target": "com.amazonaws.robomaker#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "\n

End of support notice: On September 10, 2025, Amazon Web Services\n will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will\n no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. \n For more information on transitioning to Batch to help run containerized\n simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.\n

\n \n

Describes a simulation job batch.

", - "smithy.api#http": { - "method": "POST", - "uri": "/describeSimulationJobBatch", - "code": 200 - } - } - }, - "com.amazonaws.robomaker#DescribeSimulationJobBatchRequest": { - "type": "structure", - "members": { - "batch": { - "target": "com.amazonaws.robomaker#Arn", - "traits": { - "smithy.api#documentation": "

The id of the batch to describe.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.robomaker#DescribeSimulationJobBatchResponse": { - "type": "structure", - "members": { - "arn": { - "target": "com.amazonaws.robomaker#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the batch.

" - } - }, - "status": { - "target": "com.amazonaws.robomaker#SimulationJobBatchStatus", - "traits": { - "smithy.api#documentation": "

The status of the batch.

\n
\n
Pending
\n
\n

The simulation job batch request is pending.

\n
\n
InProgress
\n
\n

The simulation job batch is in progress.

\n
\n
Failed
\n
\n

The simulation job batch failed. One or more simulation job requests could not\n be completed due to an internal failure (like InternalServiceError).\n See failureCode and failureReason for more\n information.

\n
\n
Completed
\n
\n

The simulation batch job completed. A batch is complete when (1) there are no\n pending simulation job requests in the batch and none of the failed simulation job\n requests are due to InternalServiceError and (2) when all created\n simulation jobs have reached a terminal state (for example, Completed\n or Failed).

\n
\n
Canceled
\n
\n

The simulation batch job was cancelled.

\n
\n
Canceling
\n
\n

The simulation batch job is being cancelled.

\n
\n
Completing
\n
\n

The simulation batch job is completing.

\n
\n
TimingOut
\n
\n

The simulation job batch is timing out.

\n

If a batch timing out, and there are pending requests that were failing due to\n an internal failure (like InternalServiceError), the batch status\n will be Failed. If there are no such failing request, the batch\n status will be TimedOut.

\n
\n
TimedOut
\n
\n

The simulation batch job timed out.

\n
\n
" - } - }, - "lastUpdatedAt": { - "target": "com.amazonaws.robomaker#LastUpdatedAt", - "traits": { - "smithy.api#documentation": "

The time, in milliseconds since the epoch, when the simulation job batch was last\n updated.

" - } - }, - "createdAt": { - "target": "com.amazonaws.robomaker#CreatedAt", - "traits": { - "smithy.api#documentation": "

The time, in milliseconds since the epoch, when the simulation job batch was\n created.

" - } - }, - "clientRequestToken": { - "target": "com.amazonaws.robomaker#ClientRequestToken", - "traits": { - "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request.

" - } - }, - "batchPolicy": { - "target": "com.amazonaws.robomaker#BatchPolicy", - "traits": { - "smithy.api#documentation": "

The batch policy.

" - } - }, - "failureCode": { - "target": "com.amazonaws.robomaker#SimulationJobBatchErrorCode", - "traits": { - "smithy.api#documentation": "

The failure code of the simulation job batch.

" - } - }, - "failureReason": { - "target": "com.amazonaws.robomaker#GenericString", - "traits": { - "smithy.api#documentation": "

The reason the simulation job batch failed.

" - } - }, - "failedRequests": { - "target": "com.amazonaws.robomaker#FailedCreateSimulationJobRequests", - "traits": { - "smithy.api#documentation": "

A list of failed create simulation job requests. The request failed to be created into a\n simulation job. Failed requests do not have a simulation job ID.

" - } - }, - "pendingRequests": { - "target": "com.amazonaws.robomaker#CreateSimulationJobRequests", - "traits": { - "smithy.api#documentation": "

A list of pending simulation job requests. These requests have not yet been created into\n simulation jobs.

" - } - }, - "createdRequests": { - "target": "com.amazonaws.robomaker#SimulationJobSummaries", - "traits": { - "smithy.api#documentation": "

A list of created simulation job summaries.

" - } - }, - "tags": { - "target": "com.amazonaws.robomaker#TagMap", - "traits": { - "smithy.api#documentation": "

A map that contains tag keys and tag values that are attached to the simulation job\n batch.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.robomaker#DescribeSimulationJobRequest": { - "type": "structure", - "members": { - "job": { - "target": "com.amazonaws.robomaker#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the simulation job to be described.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.robomaker#DescribeSimulationJobResponse": { - "type": "structure", - "members": { - "arn": { - "target": "com.amazonaws.robomaker#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the simulation job.

" - } - }, - "name": { - "target": "com.amazonaws.robomaker#Name", - "traits": { - "smithy.api#documentation": "

The name of the simulation job.

" - } - }, - "status": { - "target": "com.amazonaws.robomaker#SimulationJobStatus", - "traits": { - "smithy.api#documentation": "

The status of the simulation job.

" - } - }, - "lastStartedAt": { - "target": "com.amazonaws.robomaker#LastStartedAt", - "traits": { - "smithy.api#documentation": "

The time, in milliseconds since the epoch, when the simulation job was last\n started.

" - } - }, - "lastUpdatedAt": { - "target": "com.amazonaws.robomaker#LastUpdatedAt", - "traits": { - "smithy.api#documentation": "

The time, in milliseconds since the epoch, when the simulation job was last\n updated.

" - } - }, - "failureBehavior": { - "target": "com.amazonaws.robomaker#FailureBehavior", - "traits": { - "smithy.api#documentation": "

The failure behavior for the simulation job.

" - } - }, - "failureCode": { - "target": "com.amazonaws.robomaker#SimulationJobErrorCode", - "traits": { - "smithy.api#documentation": "

The failure code of the simulation job if it failed:

\n
\n
InternalServiceError
\n
\n

Internal service error.

\n
\n
RobotApplicationCrash
\n
\n

Robot application exited abnormally.

\n
\n
SimulationApplicationCrash
\n
\n

Simulation application exited abnormally.

\n
\n
BadPermissionsRobotApplication
\n
\n

Robot application bundle could not be downloaded.

\n
\n
BadPermissionsSimulationApplication
\n
\n

Simulation application bundle could not be downloaded.

\n
\n
BadPermissionsS3Output
\n
\n

Unable to publish outputs to customer-provided S3 bucket.

\n
\n
BadPermissionsCloudwatchLogs
\n
\n

Unable to publish logs to customer-provided CloudWatch Logs resource.

\n
\n
SubnetIpLimitExceeded
\n
\n

Subnet IP limit exceeded.

\n
\n
ENILimitExceeded
\n
\n

ENI limit exceeded.

\n
\n
BadPermissionsUserCredentials
\n
\n

Unable to use the Role provided.

\n
\n
InvalidBundleRobotApplication
\n
\n

Robot bundle cannot be extracted (invalid format, bundling error, or other\n issue).

\n
\n
InvalidBundleSimulationApplication
\n
\n

Simulation bundle cannot be extracted (invalid format, bundling error, or other\n issue).

\n
\n
RobotApplicationVersionMismatchedEtag
\n
\n

Etag for RobotApplication does not match value during version creation.

\n
\n
SimulationApplicationVersionMismatchedEtag
\n
\n

Etag for SimulationApplication does not match value during version\n creation.

\n
\n
" - } - }, - "failureReason": { - "target": "com.amazonaws.robomaker#GenericString", - "traits": { - "smithy.api#documentation": "

Details about why the simulation job failed. For more information about troubleshooting,\n see Troubleshooting.

" - } - }, - "clientRequestToken": { - "target": "com.amazonaws.robomaker#ClientRequestToken", - "traits": { - "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request.

" - } - }, - "outputLocation": { - "target": "com.amazonaws.robomaker#OutputLocation", - "traits": { - "smithy.api#documentation": "

Location for output files generated by the simulation job.

" - } - }, - "loggingConfig": { - "target": "com.amazonaws.robomaker#LoggingConfig", - "traits": { - "smithy.api#documentation": "

The logging configuration.

" - } - }, - "maxJobDurationInSeconds": { - "target": "com.amazonaws.robomaker#JobDuration", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum job duration in seconds. The value must be 8 days (691,200 seconds) or\n less.

" - } - }, - "simulationTimeMillis": { - "target": "com.amazonaws.robomaker#SimulationTimeMillis", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The simulation job execution duration in milliseconds.

" - } - }, - "iamRole": { - "target": "com.amazonaws.robomaker#IamRole", - "traits": { - "smithy.api#documentation": "

The IAM role that allows the simulation instance to call the AWS APIs that are specified\n in its associated policies on your behalf.

" - } - }, - "robotApplications": { - "target": "com.amazonaws.robomaker#RobotApplicationConfigs", - "traits": { - "smithy.api#documentation": "

A list of robot applications.

" - } - }, - "simulationApplications": { - "target": "com.amazonaws.robomaker#SimulationApplicationConfigs", - "traits": { - "smithy.api#documentation": "

A list of simulation applications.

" - } - }, - "dataSources": { - "target": "com.amazonaws.robomaker#DataSources", - "traits": { - "smithy.api#documentation": "

The data sources for the simulation job.

" - } - }, - "tags": { - "target": "com.amazonaws.robomaker#TagMap", - "traits": { - "smithy.api#documentation": "

The list of all tags added to the specified simulation job.

" - } - }, - "vpcConfig": { - "target": "com.amazonaws.robomaker#VPCConfigResponse", - "traits": { - "smithy.api#documentation": "

The VPC configuration.

" - } - }, - "networkInterface": { - "target": "com.amazonaws.robomaker#NetworkInterface", - "traits": { - "smithy.api#documentation": "

The network interface information for the simulation job.

" - } - }, - "compute": { - "target": "com.amazonaws.robomaker#ComputeResponse", - "traits": { - "smithy.api#documentation": "

Compute information for the simulation job.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.robomaker#DescribeWorld": { - "type": "operation", - "input": { - "target": "com.amazonaws.robomaker#DescribeWorldRequest" - }, - "output": { - "target": "com.amazonaws.robomaker#DescribeWorldResponse" - }, - "errors": [ - { - "target": "com.amazonaws.robomaker#InternalServerException" - }, - { - "target": "com.amazonaws.robomaker#InvalidParameterException" - }, - { - "target": "com.amazonaws.robomaker#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.robomaker#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "\n

End of support notice: On September 10, 2025, Amazon Web Services\n will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will\n no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. \n For more information on transitioning to Batch to help run containerized\n simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.\n

\n \n

Describes a world.

", - "smithy.api#http": { - "method": "POST", - "uri": "/describeWorld", - "code": 200 - } - } - }, - "com.amazonaws.robomaker#DescribeWorldExportJob": { - "type": "operation", - "input": { - "target": "com.amazonaws.robomaker#DescribeWorldExportJobRequest" - }, - "output": { - "target": "com.amazonaws.robomaker#DescribeWorldExportJobResponse" - }, - "errors": [ - { - "target": "com.amazonaws.robomaker#InternalServerException" - }, - { - "target": "com.amazonaws.robomaker#InvalidParameterException" - }, - { - "target": "com.amazonaws.robomaker#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.robomaker#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "\n

End of support notice: On September 10, 2025, Amazon Web Services\n will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will\n no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. \n For more information on transitioning to Batch to help run containerized\n simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.\n

\n \n

Describes a world export job.

", - "smithy.api#http": { - "method": "POST", - "uri": "/describeWorldExportJob", - "code": 200 - } - } - }, - "com.amazonaws.robomaker#DescribeWorldExportJobRequest": { - "type": "structure", - "members": { - "job": { - "target": "com.amazonaws.robomaker#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (arn) of the world export job to describe.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.robomaker#DescribeWorldExportJobResponse": { - "type": "structure", - "members": { - "arn": { - "target": "com.amazonaws.robomaker#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the world export job.

" - } - }, - "status": { - "target": "com.amazonaws.robomaker#WorldExportJobStatus", - "traits": { - "smithy.api#documentation": "

The status of the world export job.

\n
\n
Pending
\n
\n

The world export job request is pending.

\n
\n
Running
\n
\n

The world export job is running.

\n
\n
Completed
\n
\n

The world export job completed.

\n
\n
Failed
\n
\n

The world export job failed. See failureCode and\n failureReason for more information.

\n
\n
Canceled
\n
\n

The world export job was cancelled.

\n
\n
Canceling
\n
\n

The world export job is being cancelled.

\n
\n
" - } - }, - "createdAt": { - "target": "com.amazonaws.robomaker#CreatedAt", - "traits": { - "smithy.api#documentation": "

The time, in milliseconds since the epoch, when the world export job was created.

" - } - }, - "failureCode": { - "target": "com.amazonaws.robomaker#WorldExportJobErrorCode", - "traits": { - "smithy.api#documentation": "

The failure code of the world export job if it failed:

\n
\n
InternalServiceError
\n
\n

Internal service error.

\n
\n
LimitExceeded
\n
\n

The requested resource exceeds the maximum number allowed, or the number of\n concurrent stream requests exceeds the maximum number allowed.

\n
\n
ResourceNotFound
\n
\n

The specified resource could not be found.

\n
\n
RequestThrottled
\n
\n

The request was throttled.

\n
\n
InvalidInput
\n
\n

An input parameter in the request is not valid.

\n
\n
" - } - }, - "failureReason": { - "target": "com.amazonaws.robomaker#GenericString", - "traits": { - "smithy.api#documentation": "

The reason why the world export job failed.

" - } - }, - "clientRequestToken": { - "target": "com.amazonaws.robomaker#ClientRequestToken", - "traits": { - "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request.

" - } - }, - "worlds": { - "target": "com.amazonaws.robomaker#Arns", - "traits": { - "smithy.api#documentation": "

A list of Amazon Resource Names (arns) that correspond to worlds to be exported.

" - } - }, - "outputLocation": { - "target": "com.amazonaws.robomaker#OutputLocation" - }, - "iamRole": { - "target": "com.amazonaws.robomaker#IamRole", - "traits": { - "smithy.api#documentation": "

The IAM role that the world export process uses to access the Amazon S3 bucket and put\n the export.

" - } - }, - "tags": { - "target": "com.amazonaws.robomaker#TagMap", - "traits": { - "smithy.api#documentation": "

A map that contains tag keys and tag values that are attached to the world export\n job.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.robomaker#DescribeWorldGenerationJob": { - "type": "operation", - "input": { - "target": "com.amazonaws.robomaker#DescribeWorldGenerationJobRequest" - }, - "output": { - "target": "com.amazonaws.robomaker#DescribeWorldGenerationJobResponse" - }, - "errors": [ - { - "target": "com.amazonaws.robomaker#InternalServerException" - }, - { - "target": "com.amazonaws.robomaker#InvalidParameterException" - }, - { - "target": "com.amazonaws.robomaker#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.robomaker#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "\n

End of support notice: On September 10, 2025, Amazon Web Services\n will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will\n no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. \n For more information on transitioning to Batch to help run containerized\n simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.\n

\n \n

Describes a world generation job.

", - "smithy.api#http": { - "method": "POST", - "uri": "/describeWorldGenerationJob", - "code": 200 - } - } - }, - "com.amazonaws.robomaker#DescribeWorldGenerationJobRequest": { - "type": "structure", - "members": { - "job": { - "target": "com.amazonaws.robomaker#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (arn) of the world generation job to describe.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.robomaker#DescribeWorldGenerationJobResponse": { - "type": "structure", - "members": { - "arn": { - "target": "com.amazonaws.robomaker#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the world generation job.

" - } - }, - "status": { - "target": "com.amazonaws.robomaker#WorldGenerationJobStatus", - "traits": { - "smithy.api#documentation": "

The status of the world generation job:

\n
\n
Pending
\n
\n

The world generation job request is pending.

\n
\n
Running
\n
\n

The world generation job is running.

\n
\n
Completed
\n
\n

The world generation job completed.

\n
\n
Failed
\n
\n

The world generation job failed. See failureCode for more\n information.

\n
\n
PartialFailed
\n
\n

Some worlds did not generate.

\n
\n
Canceled
\n
\n

The world generation job was cancelled.

\n
\n
Canceling
\n
\n

The world generation job is being cancelled.

\n
\n
" - } - }, - "createdAt": { - "target": "com.amazonaws.robomaker#CreatedAt", - "traits": { - "smithy.api#documentation": "

The time, in milliseconds since the epoch, when the world generation job was\n created.

" - } - }, - "failureCode": { - "target": "com.amazonaws.robomaker#WorldGenerationJobErrorCode", - "traits": { - "smithy.api#documentation": "

The failure code of the world generation job if it failed:

\n
\n
InternalServiceError
\n
\n

Internal service error.

\n
\n
LimitExceeded
\n
\n

The requested resource exceeds the maximum number allowed, or the number of\n concurrent stream requests exceeds the maximum number allowed.

\n
\n
ResourceNotFound
\n
\n

The specified resource could not be found.

\n
\n
RequestThrottled
\n
\n

The request was throttled.

\n
\n
InvalidInput
\n
\n

An input parameter in the request is not valid.

\n
\n
" - } - }, - "failureReason": { - "target": "com.amazonaws.robomaker#GenericString", - "traits": { - "smithy.api#documentation": "

The reason why the world generation job failed.

" - } - }, - "clientRequestToken": { - "target": "com.amazonaws.robomaker#ClientRequestToken", - "traits": { - "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request.

" - } - }, - "template": { - "target": "com.amazonaws.robomaker#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (arn) of the world template.

" - } - }, - "worldCount": { - "target": "com.amazonaws.robomaker#WorldCount", - "traits": { - "smithy.api#documentation": "

Information about the world count.

" - } - }, - "finishedWorldsSummary": { - "target": "com.amazonaws.robomaker#FinishedWorldsSummary", - "traits": { - "smithy.api#documentation": "

Summary information about finished worlds.

" - } - }, - "tags": { - "target": "com.amazonaws.robomaker#TagMap", - "traits": { - "smithy.api#documentation": "

A map that contains tag keys and tag values that are attached to the world generation\n job.

" - } - }, - "worldTags": { - "target": "com.amazonaws.robomaker#TagMap", - "traits": { - "smithy.api#documentation": "

A map that contains tag keys and tag values that are attached to the generated\n worlds.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.robomaker#DescribeWorldRequest": { - "type": "structure", - "members": { - "world": { - "target": "com.amazonaws.robomaker#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (arn) of the world you want to describe.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.robomaker#DescribeWorldResponse": { - "type": "structure", - "members": { - "arn": { - "target": "com.amazonaws.robomaker#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (arn) of the world.

" - } - }, - "generationJob": { - "target": "com.amazonaws.robomaker#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (arn) of the world generation job that generated the\n world.

" - } - }, - "template": { - "target": "com.amazonaws.robomaker#Arn", - "traits": { - "smithy.api#documentation": "

The world template.

" - } - }, - "createdAt": { - "target": "com.amazonaws.robomaker#CreatedAt", - "traits": { - "smithy.api#documentation": "

The time, in milliseconds since the epoch, when the world was created.

" - } - }, - "tags": { - "target": "com.amazonaws.robomaker#TagMap", - "traits": { - "smithy.api#documentation": "

A map that contains tag keys and tag values that are attached to the world.

" - } - }, - "worldDescriptionBody": { - "target": "com.amazonaws.robomaker#Json", - "traits": { - "smithy.api#documentation": "

Returns the JSON formatted string that describes the contents of your world.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.robomaker#DescribeWorldTemplate": { - "type": "operation", - "input": { - "target": "com.amazonaws.robomaker#DescribeWorldTemplateRequest" - }, - "output": { - "target": "com.amazonaws.robomaker#DescribeWorldTemplateResponse" - }, - "errors": [ - { - "target": "com.amazonaws.robomaker#InternalServerException" - }, - { - "target": "com.amazonaws.robomaker#InvalidParameterException" - }, - { - "target": "com.amazonaws.robomaker#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.robomaker#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "\n

End of support notice: On September 10, 2025, Amazon Web Services\n will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will\n no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. \n For more information on transitioning to Batch to help run containerized\n simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.\n

\n \n

Describes a world template.

", - "smithy.api#http": { - "method": "POST", - "uri": "/describeWorldTemplate", - "code": 200 - } - } - }, - "com.amazonaws.robomaker#DescribeWorldTemplateRequest": { - "type": "structure", - "members": { - "template": { - "target": "com.amazonaws.robomaker#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (arn) of the world template you want to describe.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.robomaker#DescribeWorldTemplateResponse": { - "type": "structure", - "members": { - "arn": { - "target": "com.amazonaws.robomaker#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the world template.

" - } - }, - "clientRequestToken": { - "target": "com.amazonaws.robomaker#ClientRequestToken", - "traits": { - "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request.

" - } - }, - "name": { - "target": "com.amazonaws.robomaker#TemplateName", - "traits": { - "smithy.api#documentation": "

The name of the world template.

" - } - }, - "createdAt": { - "target": "com.amazonaws.robomaker#CreatedAt", - "traits": { - "smithy.api#documentation": "

The time, in milliseconds since the epoch, when the world template was created.

" - } - }, - "lastUpdatedAt": { - "target": "com.amazonaws.robomaker#LastUpdatedAt", - "traits": { - "smithy.api#documentation": "

The time, in milliseconds since the epoch, when the world template was last\n updated.

" - } - }, - "tags": { - "target": "com.amazonaws.robomaker#TagMap", - "traits": { - "smithy.api#documentation": "

A map that contains tag keys and tag values that are attached to the world\n template.

" - } - }, - "version": { - "target": "com.amazonaws.robomaker#GenericString", - "traits": { - "smithy.api#documentation": "

The version of the world template that you're using.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.robomaker#Environment": { - "type": "structure", - "members": { - "uri": { - "target": "com.amazonaws.robomaker#RepositoryUrl", - "traits": { - "smithy.api#documentation": "

The Docker image URI for either your robot or simulation applications.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The object that contains the Docker image URI for either your robot or simulation\n applications.

" - } - }, - "com.amazonaws.robomaker#EnvironmentVariableKey": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1024 - }, - "smithy.api#pattern": "^[A-Z_][A-Z0-9_]*$" - } - }, - "com.amazonaws.robomaker#EnvironmentVariableMap": { - "type": "map", - "key": { - "target": "com.amazonaws.robomaker#EnvironmentVariableKey" - }, - "value": { - "target": "com.amazonaws.robomaker#EnvironmentVariableValue" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 20 - } - } - }, - "com.amazonaws.robomaker#EnvironmentVariableValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1024 - }, - "smithy.api#pattern": ".*" - } - }, - "com.amazonaws.robomaker#ExitBehavior": { - "type": "enum", - "members": { - "FAIL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAIL" - } - }, - "RESTART": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RESTART" - } - } - } - }, - "com.amazonaws.robomaker#FailedAt": { - "type": "timestamp" - }, - "com.amazonaws.robomaker#FailedCreateSimulationJobRequest": { - "type": "structure", - "members": { - "request": { - "target": "com.amazonaws.robomaker#SimulationJobRequest", - "traits": { - "smithy.api#documentation": "

The simulation job request.

" - } - }, - "failureReason": { - "target": "com.amazonaws.robomaker#GenericString", - "traits": { - "smithy.api#documentation": "

The failure reason of the simulation job request.

" - } - }, - "failureCode": { - "target": "com.amazonaws.robomaker#SimulationJobErrorCode", - "traits": { - "smithy.api#documentation": "

The failure code.

" - } - }, - "failedAt": { - "target": "com.amazonaws.robomaker#FailedAt", - "traits": { - "smithy.api#documentation": "

The time, in milliseconds since the epoch, when the simulation job batch failed.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about a failed create simulation job request.

" - } - }, - "com.amazonaws.robomaker#FailedCreateSimulationJobRequests": { - "type": "list", - "member": { - "target": "com.amazonaws.robomaker#FailedCreateSimulationJobRequest" - } - }, - "com.amazonaws.robomaker#FailureBehavior": { - "type": "enum", - "members": { - "Fail": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Fail" - } - }, - "Continue": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Continue" - } - } - } - }, - "com.amazonaws.robomaker#FailureSummary": { - "type": "structure", - "members": { - "totalFailureCount": { - "target": "com.amazonaws.robomaker#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The total number of failures.

" - } - }, - "failures": { - "target": "com.amazonaws.robomaker#WorldFailures", - "traits": { - "smithy.api#documentation": "

The worlds that failed.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about worlds that failed.

" - } - }, - "com.amazonaws.robomaker#Filter": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.robomaker#Name", - "traits": { - "smithy.api#documentation": "

The name of the filter.

" - } - }, - "values": { - "target": "com.amazonaws.robomaker#FilterValues", - "traits": { - "smithy.api#documentation": "

A list of values.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about a filter.

" - } - }, - "com.amazonaws.robomaker#FilterValues": { - "type": "list", - "member": { - "target": "com.amazonaws.robomaker#Name" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1 - } - } - }, - "com.amazonaws.robomaker#Filters": { - "type": "list", - "member": { - "target": "com.amazonaws.robomaker#Filter" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1 - } - } - }, - "com.amazonaws.robomaker#FinishedWorldsSummary": { - "type": "structure", - "members": { - "finishedCount": { - "target": "com.amazonaws.robomaker#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The total number of finished worlds.

" - } - }, - "succeededWorlds": { - "target": "com.amazonaws.robomaker#Arns", - "traits": { - "smithy.api#documentation": "

A list of worlds that succeeded.

" - } - }, - "failureSummary": { - "target": "com.amazonaws.robomaker#FailureSummary", - "traits": { - "smithy.api#documentation": "

Information about worlds that failed.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about worlds that finished.

" - } - }, - "com.amazonaws.robomaker#Fleet": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.robomaker#Name", - "traits": { - "smithy.api#documentation": "

The name of the fleet.

" - } - }, - "arn": { - "target": "com.amazonaws.robomaker#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the fleet.

" - } - }, - "createdAt": { - "target": "com.amazonaws.robomaker#CreatedAt", - "traits": { - "smithy.api#documentation": "

The time, in milliseconds since the epoch, when the fleet was created.

" - } - }, - "lastDeploymentStatus": { - "target": "com.amazonaws.robomaker#DeploymentStatus", - "traits": { - "smithy.api#documentation": "

The status of the last fleet deployment.

" - } - }, - "lastDeploymentJob": { - "target": "com.amazonaws.robomaker#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the last deployment job.

" - } - }, - "lastDeploymentTime": { - "target": "com.amazonaws.robomaker#CreatedAt", - "traits": { - "smithy.api#documentation": "

The time of the last deployment.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about a fleet.

" - } - }, - "com.amazonaws.robomaker#Fleets": { - "type": "list", - "member": { - "target": "com.amazonaws.robomaker#Fleet" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 200 - } - } - }, - "com.amazonaws.robomaker#FloorplanCount": { - "type": "integer" - }, - "com.amazonaws.robomaker#GPUUnit": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 0, - "max": 1 - } - } - }, - "com.amazonaws.robomaker#GenericInteger": { - "type": "integer" - }, - "com.amazonaws.robomaker#GenericString": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1024 - }, - "smithy.api#pattern": ".*" - } - }, - "com.amazonaws.robomaker#GetWorldTemplateBody": { - "type": "operation", - "input": { - "target": "com.amazonaws.robomaker#GetWorldTemplateBodyRequest" - }, - "output": { - "target": "com.amazonaws.robomaker#GetWorldTemplateBodyResponse" - }, - "errors": [ - { - "target": "com.amazonaws.robomaker#InternalServerException" - }, - { - "target": "com.amazonaws.robomaker#InvalidParameterException" - }, - { - "target": "com.amazonaws.robomaker#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.robomaker#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "\n

End of support notice: On September 10, 2025, Amazon Web Services\n will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will\n no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. \n For more information on transitioning to Batch to help run containerized\n simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.\n

\n \n

Gets the world template body.

", - "smithy.api#http": { - "method": "POST", - "uri": "/getWorldTemplateBody", - "code": 200 - } - } - }, - "com.amazonaws.robomaker#GetWorldTemplateBodyRequest": { - "type": "structure", - "members": { - "template": { - "target": "com.amazonaws.robomaker#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (arn) of the world template.

" - } - }, - "generationJob": { - "target": "com.amazonaws.robomaker#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (arn) of the world generator job.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.robomaker#GetWorldTemplateBodyResponse": { - "type": "structure", - "members": { - "templateBody": { - "target": "com.amazonaws.robomaker#Json", - "traits": { - "smithy.api#documentation": "

The world template body.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.robomaker#IamRole": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 255 - }, - "smithy.api#pattern": "^arn:aws:iam::\\w+:role/" - } - }, - "com.amazonaws.robomaker#Id": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1224 - }, - "smithy.api#pattern": ".*" - } - }, - "com.amazonaws.robomaker#IdempotentParameterMismatchException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.robomaker#errorMessage" - } - }, - "traits": { - "smithy.api#documentation": "

The request uses the same client token as a previous, but non-identical request. Do not\n reuse a client token with different requests, unless the requests are identical.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.robomaker#ImageDigest": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 72 - }, - "smithy.api#pattern": "^[Ss][Hh][Aa]256:[0-9a-fA-F]{64}$" - } - }, - "com.amazonaws.robomaker#Integer": { - "type": "integer", - "traits": { - "smithy.api#default": 0 - } - }, - "com.amazonaws.robomaker#InteriorCountPerFloorplan": { - "type": "integer" - }, - "com.amazonaws.robomaker#InternalServerException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.robomaker#errorMessage" - } - }, - "traits": { - "smithy.api#documentation": "

AWS RoboMaker experienced a service issue. Try your call again.

", - "smithy.api#error": "server", - "smithy.api#httpError": 500 - } - }, - "com.amazonaws.robomaker#InvalidParameterException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.robomaker#errorMessage" - } - }, - "traits": { - "smithy.api#documentation": "

A parameter specified in a request is not valid, is unsupported, or cannot be used. The\n returned message provides an explanation of the error value.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.robomaker#JobDuration": { - "type": "long", - "traits": { - "smithy.api#default": 0 - } - }, - "com.amazonaws.robomaker#Json": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 262144 - }, - "smithy.api#pattern": "^[\\S\\s]+$" - } - }, - "com.amazonaws.robomaker#LastStartedAt": { - "type": "timestamp" - }, - "com.amazonaws.robomaker#LastUpdatedAt": { - "type": "timestamp" - }, - "com.amazonaws.robomaker#LaunchConfig": { - "type": "structure", - "members": { - "packageName": { - "target": "com.amazonaws.robomaker#Command", - "traits": { - "smithy.api#documentation": "

The package name.

" - } - }, - "launchFile": { - "target": "com.amazonaws.robomaker#Command", - "traits": { - "smithy.api#documentation": "

The launch file name.

" - } - }, - "environmentVariables": { - "target": "com.amazonaws.robomaker#EnvironmentVariableMap", - "traits": { - "smithy.api#documentation": "

The environment variables for the application launch.

" - } - }, - "portForwardingConfig": { - "target": "com.amazonaws.robomaker#PortForwardingConfig", - "traits": { - "smithy.api#documentation": "

The port forwarding configuration.

" - } - }, - "streamUI": { - "target": "com.amazonaws.robomaker#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Boolean indicating whether a streaming session will be configured for the application.\n If True, AWS RoboMaker will configure a connection so you can interact with\n your application as it is running in the simulation. You must configure and launch the\n component. It must have a graphical user interface.

" - } - }, - "command": { - "target": "com.amazonaws.robomaker#CommandList", - "traits": { - "smithy.api#documentation": "

If you've specified General as the value for your RobotSoftwareSuite, you can use this field to specify a list of commands for your container image.

\n

If you've specified SimulationRuntime as the value for your SimulationSoftwareSuite, you can use this field to specify a list of commands for your container image.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about a launch configuration.

" - } - }, - "com.amazonaws.robomaker#LimitExceededException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.robomaker#errorMessage" - } - }, - "traits": { - "smithy.api#documentation": "

The requested resource exceeds the maximum number allowed, or the number of concurrent\n stream requests exceeds the maximum number allowed.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.robomaker#ListDeploymentJobs": { - "type": "operation", - "input": { - "target": "com.amazonaws.robomaker#ListDeploymentJobsRequest" - }, - "output": { - "target": "com.amazonaws.robomaker#ListDeploymentJobsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.robomaker#InternalServerException" - }, - { - "target": "com.amazonaws.robomaker#InvalidParameterException" - }, - { - "target": "com.amazonaws.robomaker#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.robomaker#ThrottlingException" - } - ], - "traits": { - "smithy.api#deprecated": { - "message": "Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." - }, - "smithy.api#documentation": "\n

End of support notice: On September 10, 2025, Amazon Web Services\n will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will\n no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. \n For more information on transitioning to Batch to help run containerized\n simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.\n

\n \n \n

This API is no longer supported. For more information, see the May 2, 2022 update in the Support policy page.

\n \n

\n Returns a list of deployment jobs for a fleet. You can optionally provide filters to retrieve specific deployment jobs.\n

", - "smithy.api#http": { - "method": "POST", - "uri": "/listDeploymentJobs", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "items": "deploymentJobs", - "pageSize": "maxResults" - } - } - }, - "com.amazonaws.robomaker#ListDeploymentJobsRequest": { - "type": "structure", - "members": { - "filters": { - "target": "com.amazonaws.robomaker#Filters", - "traits": { - "smithy.api#documentation": "

Optional filters to limit results.

\n

The filter names status and fleetName are supported. When\n filtering, you must use the complete value of the filtered item. You can use up to three\n filters, but they must be for the same named item. For example, if you are looking for\n items with the status InProgress or the status Pending.

" - } - }, - "nextToken": { - "target": "com.amazonaws.robomaker#PaginationToken", - "traits": { - "smithy.api#documentation": "

If the previous paginated request did not return all of the remaining results, the\n response object's nextToken parameter value is set to a token. To retrieve the\n next set of results, call ListDeploymentJobs again and assign that token to\n the request object's nextToken parameter. If there are no remaining results,\n the previous response object's NextToken parameter is set to null.

" - } - }, - "maxResults": { - "target": "com.amazonaws.robomaker#MaxResults", - "traits": { - "smithy.api#documentation": "

When this parameter is used, ListDeploymentJobs only returns\n maxResults results in a single page along with a nextToken\n response element. The remaining results of the initial request can be seen by sending\n another ListDeploymentJobs request with the returned nextToken\n value. This value can be between 1 and 200. If this parameter is not used, then\n ListDeploymentJobs returns up to 200 results and a nextToken\n value if applicable.

" - } - } - }, - "traits": { - "smithy.api#deprecated": { - "message": "Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." - }, - "smithy.api#input": {} - } - }, - "com.amazonaws.robomaker#ListDeploymentJobsResponse": { - "type": "structure", - "members": { - "deploymentJobs": { - "target": "com.amazonaws.robomaker#DeploymentJobs", - "traits": { - "smithy.api#documentation": "

A list of deployment jobs that meet the criteria of the request.

" - } - }, - "nextToken": { - "target": "com.amazonaws.robomaker#PaginationToken", - "traits": { - "smithy.api#documentation": "

If the previous paginated request did not return all of the remaining results, the\n response object's nextToken parameter value is set to a token. To retrieve the\n next set of results, call ListDeploymentJobs again and assign that token to\n the request object's nextToken parameter. If there are no remaining results,\n the previous response object's NextToken parameter is set to null.

" - } - } - }, - "traits": { - "smithy.api#deprecated": { - "message": "Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." - }, - "smithy.api#output": {} - } - }, - "com.amazonaws.robomaker#ListFleets": { - "type": "operation", - "input": { - "target": "com.amazonaws.robomaker#ListFleetsRequest" - }, - "output": { - "target": "com.amazonaws.robomaker#ListFleetsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.robomaker#InternalServerException" - }, - { - "target": "com.amazonaws.robomaker#InvalidParameterException" - }, - { - "target": "com.amazonaws.robomaker#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.robomaker#ThrottlingException" - } - ], - "traits": { - "smithy.api#deprecated": { - "message": "Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." - }, - "smithy.api#documentation": "\n

End of support notice: On September 10, 2025, Amazon Web Services\n will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will\n no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. \n For more information on transitioning to Batch to help run containerized\n simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.\n

\n \n \n

This API is no longer supported. For more information, see the May 2, 2022 update in the Support policy page.

\n \n

\n Returns a list of fleets. You can optionally provide filters to retrieve specific fleets.\n

", - "smithy.api#http": { - "method": "POST", - "uri": "/listFleets", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "items": "fleetDetails", - "pageSize": "maxResults" - } - } - }, - "com.amazonaws.robomaker#ListFleetsRequest": { - "type": "structure", - "members": { - "nextToken": { - "target": "com.amazonaws.robomaker#PaginationToken", - "traits": { - "smithy.api#documentation": "

If the previous paginated request did not return all of the remaining results, the\n response object's nextToken parameter value is set to a token. To retrieve the\n next set of results, call ListFleets again and assign that token to the\n request object's nextToken parameter. If there are no remaining results, the\n previous response object's NextToken parameter is set to null.

\n \n

This token should be treated as an opaque identifier that is only used to retrieve\n the next items in a list and not for other programmatic purposes.

\n " - } - }, - "maxResults": { - "target": "com.amazonaws.robomaker#MaxResults", - "traits": { - "smithy.api#documentation": "

When this parameter is used, ListFleets only returns\n maxResults results in a single page along with a nextToken\n response element. The remaining results of the initial request can be seen by sending\n another ListFleets request with the returned nextToken value.\n This value can be between 1 and 200. If this parameter is not used, then\n ListFleets returns up to 200 results and a nextToken value if\n applicable.

" - } - }, - "filters": { - "target": "com.amazonaws.robomaker#Filters", - "traits": { - "smithy.api#documentation": "

Optional filters to limit results.

\n

The filter name name is supported. When filtering, you must use the\n complete value of the filtered item. You can use up to three filters.

" - } - } - }, - "traits": { - "smithy.api#deprecated": { - "message": "Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." - }, - "smithy.api#input": {} - } - }, - "com.amazonaws.robomaker#ListFleetsResponse": { - "type": "structure", - "members": { - "fleetDetails": { - "target": "com.amazonaws.robomaker#Fleets", - "traits": { - "smithy.api#documentation": "

A list of fleet details meeting the request criteria.

" - } - }, - "nextToken": { - "target": "com.amazonaws.robomaker#PaginationToken", - "traits": { - "smithy.api#documentation": "

If the previous paginated request did not return all of the remaining results, the\n response object's nextToken parameter value is set to a token. To retrieve the\n next set of results, call ListFleets again and assign that token to the\n request object's nextToken parameter. If there are no remaining results, the\n previous response object's NextToken parameter is set to null.

" - } - } - }, - "traits": { - "smithy.api#deprecated": { - "message": "Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." - }, - "smithy.api#output": {} - } - }, - "com.amazonaws.robomaker#ListRobotApplications": { - "type": "operation", - "input": { - "target": "com.amazonaws.robomaker#ListRobotApplicationsRequest" - }, - "output": { - "target": "com.amazonaws.robomaker#ListRobotApplicationsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.robomaker#InternalServerException" - }, - { - "target": "com.amazonaws.robomaker#InvalidParameterException" - }, - { - "target": "com.amazonaws.robomaker#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "\n

End of support notice: On September 10, 2025, Amazon Web Services\n will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will\n no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. \n For more information on transitioning to Batch to help run containerized\n simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.\n

\n \n

Returns a list of robot application. You can optionally provide filters to retrieve\n specific robot applications.

", - "smithy.api#http": { - "method": "POST", - "uri": "/listRobotApplications", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "items": "robotApplicationSummaries", - "pageSize": "maxResults" - } - } - }, - "com.amazonaws.robomaker#ListRobotApplicationsRequest": { - "type": "structure", - "members": { - "versionQualifier": { - "target": "com.amazonaws.robomaker#VersionQualifier", - "traits": { - "smithy.api#documentation": "

The version qualifier of the robot application.

" - } - }, - "nextToken": { - "target": "com.amazonaws.robomaker#PaginationToken", - "traits": { - "smithy.api#documentation": "

If the previous paginated request did not return all of the remaining results, the\n response object's nextToken parameter value is set to a token. To retrieve the\n next set of results, call ListRobotApplications again and assign that token to\n the request object's nextToken parameter. If there are no remaining results,\n the previous response object's NextToken parameter is set to null.

" - } - }, - "maxResults": { - "target": "com.amazonaws.robomaker#MaxResults", - "traits": { - "smithy.api#documentation": "

When this parameter is used, ListRobotApplications only returns\n maxResults results in a single page along with a nextToken\n response element. The remaining results of the initial request can be seen by sending\n another ListRobotApplications request with the returned nextToken\n value. This value can be between 1 and 100. If this parameter is not used, then\n ListRobotApplications returns up to 100 results and a\n nextToken value if applicable.

" - } - }, - "filters": { - "target": "com.amazonaws.robomaker#Filters", - "traits": { - "smithy.api#documentation": "

Optional filters to limit results.

\n

The filter name name is supported. When filtering, you must use the\n complete value of the filtered item. You can use up to three filters.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.robomaker#ListRobotApplicationsResponse": { - "type": "structure", - "members": { - "robotApplicationSummaries": { - "target": "com.amazonaws.robomaker#RobotApplicationSummaries", - "traits": { - "smithy.api#documentation": "

A list of robot application summaries that meet the criteria of the request.

" - } - }, - "nextToken": { - "target": "com.amazonaws.robomaker#PaginationToken", - "traits": { - "smithy.api#documentation": "

If the previous paginated request did not return all of the remaining results, the\n response object's nextToken parameter value is set to a token. To retrieve the\n next set of results, call ListRobotApplications again and assign that token to\n the request object's nextToken parameter. If there are no remaining results,\n the previous response object's NextToken parameter is set to null.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.robomaker#ListRobots": { - "type": "operation", - "input": { - "target": "com.amazonaws.robomaker#ListRobotsRequest" - }, - "output": { - "target": "com.amazonaws.robomaker#ListRobotsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.robomaker#InternalServerException" - }, - { - "target": "com.amazonaws.robomaker#InvalidParameterException" - }, - { - "target": "com.amazonaws.robomaker#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.robomaker#ThrottlingException" - } - ], - "traits": { - "smithy.api#deprecated": { - "message": "Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." - }, - "smithy.api#documentation": "\n

End of support notice: On September 10, 2025, Amazon Web Services\n will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will\n no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. \n For more information on transitioning to Batch to help run containerized\n simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.\n

\n \n \n

This API is no longer supported. For more information, see the May 2, 2022 update in the Support policy page.

\n \n

\n Returns a list of robots. You can optionally provide filters to retrieve specific robots.\n

", - "smithy.api#http": { - "method": "POST", - "uri": "/listRobots", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "items": "robots", - "pageSize": "maxResults" - } - } - }, - "com.amazonaws.robomaker#ListRobotsRequest": { - "type": "structure", - "members": { - "nextToken": { - "target": "com.amazonaws.robomaker#PaginationToken", - "traits": { - "smithy.api#documentation": "

If the previous paginated request did not return all of the remaining results, the\n response object's nextToken parameter value is set to a token. To retrieve the\n next set of results, call ListRobots again and assign that token to the\n request object's nextToken parameter. If there are no remaining results, the\n previous response object's NextToken parameter is set to null.

" - } - }, - "maxResults": { - "target": "com.amazonaws.robomaker#MaxResults", - "traits": { - "smithy.api#documentation": "

When this parameter is used, ListRobots only returns\n maxResults results in a single page along with a nextToken\n response element. The remaining results of the initial request can be seen by sending\n another ListRobots request with the returned nextToken value.\n This value can be between 1 and 200. If this parameter is not used, then\n ListRobots returns up to 200 results and a nextToken value if\n applicable.

" - } - }, - "filters": { - "target": "com.amazonaws.robomaker#Filters", - "traits": { - "smithy.api#documentation": "

Optional filters to limit results.

\n

The filter names status and fleetName are supported. When\n filtering, you must use the complete value of the filtered item. You can use up to three\n filters, but they must be for the same named item. For example, if you are looking for\n items with the status Registered or the status Available.

" - } - } - }, - "traits": { - "smithy.api#deprecated": { - "message": "Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." - }, - "smithy.api#input": {} - } - }, - "com.amazonaws.robomaker#ListRobotsResponse": { - "type": "structure", - "members": { - "robots": { - "target": "com.amazonaws.robomaker#Robots", - "traits": { - "smithy.api#documentation": "

A list of robots that meet the criteria of the request.

" - } - }, - "nextToken": { - "target": "com.amazonaws.robomaker#PaginationToken", - "traits": { - "smithy.api#documentation": "

If the previous paginated request did not return all of the remaining results, the\n response object's nextToken parameter value is set to a token. To retrieve the\n next set of results, call ListRobots again and assign that token to the\n request object's nextToken parameter. If there are no remaining results, the\n previous response object's NextToken parameter is set to null.

" - } - } - }, - "traits": { - "smithy.api#deprecated": { - "message": "Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." - }, - "smithy.api#output": {} - } - }, - "com.amazonaws.robomaker#ListSimulationApplications": { - "type": "operation", - "input": { - "target": "com.amazonaws.robomaker#ListSimulationApplicationsRequest" - }, - "output": { - "target": "com.amazonaws.robomaker#ListSimulationApplicationsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.robomaker#InternalServerException" - }, - { - "target": "com.amazonaws.robomaker#InvalidParameterException" - }, - { - "target": "com.amazonaws.robomaker#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "\n

End of support notice: On September 10, 2025, Amazon Web Services\n will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will\n no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. \n For more information on transitioning to Batch to help run containerized\n simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.\n

\n \n

Returns a list of simulation applications. You can optionally provide filters to\n retrieve specific simulation applications.

", - "smithy.api#http": { - "method": "POST", - "uri": "/listSimulationApplications", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "items": "simulationApplicationSummaries", - "pageSize": "maxResults" - } - } - }, - "com.amazonaws.robomaker#ListSimulationApplicationsRequest": { - "type": "structure", - "members": { - "versionQualifier": { - "target": "com.amazonaws.robomaker#VersionQualifier", - "traits": { - "smithy.api#documentation": "

The version qualifier of the simulation application.

" - } - }, - "nextToken": { - "target": "com.amazonaws.robomaker#PaginationToken", - "traits": { - "smithy.api#documentation": "

If the previous paginated request did not return all of the remaining results, the\n response object's nextToken parameter value is set to a token. To retrieve the\n next set of results, call ListSimulationApplications again and assign that\n token to the request object's nextToken parameter. If there are no remaining\n results, the previous response object's NextToken parameter is set to null.

" - } - }, - "maxResults": { - "target": "com.amazonaws.robomaker#MaxResults", - "traits": { - "smithy.api#documentation": "

When this parameter is used, ListSimulationApplications only returns\n maxResults results in a single page along with a nextToken\n response element. The remaining results of the initial request can be seen by sending\n another ListSimulationApplications request with the returned\n nextToken value. This value can be between 1 and 100. If this parameter is\n not used, then ListSimulationApplications returns up to 100 results and a\n nextToken value if applicable.

" - } - }, - "filters": { - "target": "com.amazonaws.robomaker#Filters", - "traits": { - "smithy.api#documentation": "

Optional list of filters to limit results.

\n

The filter name name is supported. When filtering, you must use the\n complete value of the filtered item. You can use up to three filters.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.robomaker#ListSimulationApplicationsResponse": { - "type": "structure", - "members": { - "simulationApplicationSummaries": { - "target": "com.amazonaws.robomaker#SimulationApplicationSummaries", - "traits": { - "smithy.api#documentation": "

A list of simulation application summaries that meet the criteria of the request.

" - } - }, - "nextToken": { - "target": "com.amazonaws.robomaker#PaginationToken", - "traits": { - "smithy.api#documentation": "

If the previous paginated request did not return all of the remaining results, the\n response object's nextToken parameter value is set to a token. To retrieve the\n next set of results, call ListSimulationApplications again and assign that\n token to the request object's nextToken parameter. If there are no remaining\n results, the previous response object's NextToken parameter is set to null.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.robomaker#ListSimulationJobBatches": { - "type": "operation", - "input": { - "target": "com.amazonaws.robomaker#ListSimulationJobBatchesRequest" - }, - "output": { - "target": "com.amazonaws.robomaker#ListSimulationJobBatchesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.robomaker#InternalServerException" - }, - { - "target": "com.amazonaws.robomaker#InvalidParameterException" - } - ], - "traits": { - "smithy.api#documentation": "\n

End of support notice: On September 10, 2025, Amazon Web Services\n will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will\n no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. \n For more information on transitioning to Batch to help run containerized\n simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.\n

\n \n

Returns a list simulation job batches. You can optionally provide filters to retrieve\n specific simulation batch jobs.

", - "smithy.api#http": { - "method": "POST", - "uri": "/listSimulationJobBatches", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "items": "simulationJobBatchSummaries", - "pageSize": "maxResults" - } - } - }, - "com.amazonaws.robomaker#ListSimulationJobBatchesRequest": { - "type": "structure", - "members": { - "nextToken": { - "target": "com.amazonaws.robomaker#PaginationToken", - "traits": { - "smithy.api#documentation": "

If the previous paginated request did not return all of the remaining results, the\n response object's nextToken parameter value is set to a token. To retrieve the\n next set of results, call ListSimulationJobBatches again and assign that token\n to the request object's nextToken parameter. If there are no remaining\n results, the previous response object's NextToken parameter is set to null.

" - } - }, - "maxResults": { - "target": "com.amazonaws.robomaker#MaxResults", - "traits": { - "smithy.api#documentation": "

When this parameter is used, ListSimulationJobBatches only returns\n maxResults results in a single page along with a nextToken\n response element. The remaining results of the initial request can be seen by sending\n another ListSimulationJobBatches request with the returned\n nextToken value.

" - } - }, - "filters": { - "target": "com.amazonaws.robomaker#Filters", - "traits": { - "smithy.api#documentation": "

Optional filters to limit results.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.robomaker#ListSimulationJobBatchesResponse": { - "type": "structure", - "members": { - "simulationJobBatchSummaries": { - "target": "com.amazonaws.robomaker#SimulationJobBatchSummaries", - "traits": { - "smithy.api#documentation": "

A list of simulation job batch summaries.

" - } - }, - "nextToken": { - "target": "com.amazonaws.robomaker#PaginationToken", - "traits": { - "smithy.api#documentation": "

If the previous paginated request did not return all of the remaining results, the\n response object's nextToken parameter value is set to a token. To retrieve the\n next set of results, call ListSimulationJobBatches again and assign that token\n to the request object's nextToken parameter. If there are no remaining\n results, the previous response object's NextToken parameter is set to null.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.robomaker#ListSimulationJobs": { - "type": "operation", - "input": { - "target": "com.amazonaws.robomaker#ListSimulationJobsRequest" - }, - "output": { - "target": "com.amazonaws.robomaker#ListSimulationJobsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.robomaker#InternalServerException" - }, - { - "target": "com.amazonaws.robomaker#InvalidParameterException" - }, - { - "target": "com.amazonaws.robomaker#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "\n

End of support notice: On September 10, 2025, Amazon Web Services\n will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will\n no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. \n For more information on transitioning to Batch to help run containerized\n simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.\n

\n \n

Returns a list of simulation jobs. You can optionally provide filters to retrieve\n specific simulation jobs.

", - "smithy.api#http": { - "method": "POST", - "uri": "/listSimulationJobs", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "items": "simulationJobSummaries", - "pageSize": "maxResults" - } - } - }, - "com.amazonaws.robomaker#ListSimulationJobsRequest": { - "type": "structure", - "members": { - "nextToken": { - "target": "com.amazonaws.robomaker#PaginationToken", - "traits": { - "smithy.api#documentation": "

If the previous paginated request did not return all of the remaining results, the\n response object's nextToken parameter value is set to a token. To retrieve the\n next set of results, call ListSimulationJobs again and assign that token to\n the request object's nextToken parameter. If there are no remaining results,\n the previous response object's NextToken parameter is set to null.

" - } - }, - "maxResults": { - "target": "com.amazonaws.robomaker#MaxResults", - "traits": { - "smithy.api#documentation": "

When this parameter is used, ListSimulationJobs only returns\n maxResults results in a single page along with a nextToken\n response element. The remaining results of the initial request can be seen by sending\n another ListSimulationJobs request with the returned nextToken\n value. This value can be between 1 and 1000. If this parameter is not used, then\n ListSimulationJobs returns up to 1000 results and a nextToken\n value if applicable.

" - } - }, - "filters": { - "target": "com.amazonaws.robomaker#Filters", - "traits": { - "smithy.api#documentation": "

Optional filters to limit results.

\n

The filter names status and simulationApplicationName and\n robotApplicationName are supported. When filtering, you must use the\n complete value of the filtered item. You can use up to three filters, but they must be for\n the same named item. For example, if you are looking for items with the status\n Preparing or the status Running.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.robomaker#ListSimulationJobsResponse": { - "type": "structure", - "members": { - "simulationJobSummaries": { - "target": "com.amazonaws.robomaker#SimulationJobSummaries", - "traits": { - "smithy.api#documentation": "

A list of simulation job summaries that meet the criteria of the request.

", - "smithy.api#required": {} - } - }, - "nextToken": { - "target": "com.amazonaws.robomaker#PaginationToken", - "traits": { - "smithy.api#documentation": "

If the previous paginated request did not return all of the remaining results, the\n response object's nextToken parameter value is set to a token. To retrieve the\n next set of results, call ListSimulationJobs again and assign that token to\n the request object's nextToken parameter. If there are no remaining results,\n the previous response object's NextToken parameter is set to null.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.robomaker#ListTagsForResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.robomaker#ListTagsForResourceRequest" - }, - "output": { - "target": "com.amazonaws.robomaker#ListTagsForResourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.robomaker#InternalServerException" - }, - { - "target": "com.amazonaws.robomaker#InvalidParameterException" - }, - { - "target": "com.amazonaws.robomaker#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.robomaker#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "\n

End of support notice: On September 10, 2025, Amazon Web Services\n will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will\n no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. \n For more information on transitioning to Batch to help run containerized\n simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.\n

\n \n

Lists all tags on a AWS RoboMaker resource.

", - "smithy.api#http": { - "method": "GET", - "uri": "/tags/{resourceArn}", - "code": 200 - } - } - }, - "com.amazonaws.robomaker#ListTagsForResourceRequest": { - "type": "structure", - "members": { - "resourceArn": { - "target": "com.amazonaws.robomaker#Arn", - "traits": { - "smithy.api#documentation": "

The AWS RoboMaker Amazon Resource Name (ARN) with tags to be listed.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.robomaker#ListTagsForResourceResponse": { - "type": "structure", - "members": { - "tags": { - "target": "com.amazonaws.robomaker#TagMap", - "traits": { - "smithy.api#documentation": "

The list of all tags added to the specified resource.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.robomaker#ListWorldExportJobs": { - "type": "operation", - "input": { - "target": "com.amazonaws.robomaker#ListWorldExportJobsRequest" - }, - "output": { - "target": "com.amazonaws.robomaker#ListWorldExportJobsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.robomaker#InternalServerException" - }, - { - "target": "com.amazonaws.robomaker#InvalidParameterException" - }, - { - "target": "com.amazonaws.robomaker#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "\n

End of support notice: On September 10, 2025, Amazon Web Services\n will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will\n no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. \n For more information on transitioning to Batch to help run containerized\n simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.\n

\n \n

Lists world export jobs.

", - "smithy.api#http": { - "method": "POST", - "uri": "/listWorldExportJobs", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "items": "worldExportJobSummaries", - "pageSize": "maxResults" - } - } - }, - "com.amazonaws.robomaker#ListWorldExportJobsRequest": { - "type": "structure", - "members": { - "nextToken": { - "target": "com.amazonaws.robomaker#PaginationToken", - "traits": { - "smithy.api#documentation": "

If the previous paginated request did not return all of the remaining results, the\n response object's nextToken parameter value is set to a token. To retrieve the\n next set of results, call ListWorldExportJobs again and assign that token to\n the request object's nextToken parameter. If there are no remaining results,\n the previous response object's NextToken parameter is set to null.

" - } - }, - "maxResults": { - "target": "com.amazonaws.robomaker#MaxResults", - "traits": { - "smithy.api#documentation": "

When this parameter is used, ListWorldExportJobs only returns\n maxResults results in a single page along with a nextToken\n response element. The remaining results of the initial request can be seen by sending\n another ListWorldExportJobs request with the returned nextToken\n value. This value can be between 1 and 100. If this parameter is not used, then\n ListWorldExportJobs returns up to 100 results and a nextToken\n value if applicable.

" - } - }, - "filters": { - "target": "com.amazonaws.robomaker#Filters", - "traits": { - "smithy.api#documentation": "

Optional filters to limit results. You can use generationJobId and\n templateId.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.robomaker#ListWorldExportJobsResponse": { - "type": "structure", - "members": { - "worldExportJobSummaries": { - "target": "com.amazonaws.robomaker#WorldExportJobSummaries", - "traits": { - "smithy.api#documentation": "

Summary information for world export jobs.

", - "smithy.api#required": {} - } - }, - "nextToken": { - "target": "com.amazonaws.robomaker#PaginationToken", - "traits": { - "smithy.api#documentation": "

If the previous paginated request did not return all of the remaining results, the\n response object's nextToken parameter value is set to a token. To retrieve the\n next set of results, call ListWorldExportJobsRequest again and assign that\n token to the request object's nextToken parameter. If there are no remaining\n results, the previous response object's NextToken parameter is set to null.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.robomaker#ListWorldGenerationJobs": { - "type": "operation", - "input": { - "target": "com.amazonaws.robomaker#ListWorldGenerationJobsRequest" - }, - "output": { - "target": "com.amazonaws.robomaker#ListWorldGenerationJobsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.robomaker#InternalServerException" - }, - { - "target": "com.amazonaws.robomaker#InvalidParameterException" - }, - { - "target": "com.amazonaws.robomaker#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "\n

End of support notice: On September 10, 2025, Amazon Web Services\n will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will\n no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. \n For more information on transitioning to Batch to help run containerized\n simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.\n

\n \n

Lists world generator jobs.

", - "smithy.api#http": { - "method": "POST", - "uri": "/listWorldGenerationJobs", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "items": "worldGenerationJobSummaries", - "pageSize": "maxResults" - } - } - }, - "com.amazonaws.robomaker#ListWorldGenerationJobsRequest": { - "type": "structure", - "members": { - "nextToken": { - "target": "com.amazonaws.robomaker#PaginationToken", - "traits": { - "smithy.api#documentation": "

If the previous paginated request did not return all of the remaining results, the\n response object's nextToken parameter value is set to a token. To retrieve the\n next set of results, call ListWorldGenerationJobsRequest again and assign that\n token to the request object's nextToken parameter. If there are no remaining\n results, the previous response object's NextToken parameter is set to null.

" - } - }, - "maxResults": { - "target": "com.amazonaws.robomaker#MaxResults", - "traits": { - "smithy.api#documentation": "

When this parameter is used, ListWorldGeneratorJobs only returns\n maxResults results in a single page along with a nextToken\n response element. The remaining results of the initial request can be seen by sending\n another ListWorldGeneratorJobs request with the returned\n nextToken value. This value can be between 1 and 100. If this parameter is\n not used, then ListWorldGeneratorJobs returns up to 100 results and a\n nextToken value if applicable.

" - } - }, - "filters": { - "target": "com.amazonaws.robomaker#Filters", - "traits": { - "smithy.api#documentation": "

Optional filters to limit results. You can use status and\n templateId.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.robomaker#ListWorldGenerationJobsResponse": { - "type": "structure", - "members": { - "worldGenerationJobSummaries": { - "target": "com.amazonaws.robomaker#WorldGenerationJobSummaries", - "traits": { - "smithy.api#documentation": "

Summary information for world generator jobs.

", - "smithy.api#required": {} - } - }, - "nextToken": { - "target": "com.amazonaws.robomaker#PaginationToken", - "traits": { - "smithy.api#documentation": "

If the previous paginated request did not return all of the remaining results, the\n response object's nextToken parameter value is set to a token. To retrieve the\n next set of results, call ListWorldGeneratorJobsRequest again and assign that\n token to the request object's nextToken parameter. If there are no remaining\n results, the previous response object's NextToken parameter is set to null.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.robomaker#ListWorldTemplates": { - "type": "operation", - "input": { - "target": "com.amazonaws.robomaker#ListWorldTemplatesRequest" - }, - "output": { - "target": "com.amazonaws.robomaker#ListWorldTemplatesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.robomaker#InternalServerException" - }, - { - "target": "com.amazonaws.robomaker#InvalidParameterException" - }, - { - "target": "com.amazonaws.robomaker#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "\n

End of support notice: On September 10, 2025, Amazon Web Services\n will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will\n no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. \n For more information on transitioning to Batch to help run containerized\n simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.\n

\n \n

Lists world templates.

", - "smithy.api#http": { - "method": "POST", - "uri": "/listWorldTemplates", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "items": "templateSummaries", - "pageSize": "maxResults" - } - } - }, - "com.amazonaws.robomaker#ListWorldTemplatesRequest": { - "type": "structure", - "members": { - "nextToken": { - "target": "com.amazonaws.robomaker#PaginationToken", - "traits": { - "smithy.api#documentation": "

If the previous paginated request did not return all of the remaining results, the\n response object's nextToken parameter value is set to a token. To retrieve the\n next set of results, call ListWorldTemplates again and assign that token to\n the request object's nextToken parameter. If there are no remaining results,\n the previous response object's NextToken parameter is set to null.

" - } - }, - "maxResults": { - "target": "com.amazonaws.robomaker#MaxResults", - "traits": { - "smithy.api#documentation": "

When this parameter is used, ListWorldTemplates only returns\n maxResults results in a single page along with a nextToken\n response element. The remaining results of the initial request can be seen by sending\n another ListWorldTemplates request with the returned nextToken\n value. This value can be between 1 and 100. If this parameter is not used, then\n ListWorldTemplates returns up to 100 results and a nextToken\n value if applicable.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.robomaker#ListWorldTemplatesResponse": { - "type": "structure", - "members": { - "templateSummaries": { - "target": "com.amazonaws.robomaker#TemplateSummaries", - "traits": { - "smithy.api#documentation": "

Summary information for templates.

" - } - }, - "nextToken": { - "target": "com.amazonaws.robomaker#PaginationToken", - "traits": { - "smithy.api#documentation": "

If the previous paginated request did not return all of the remaining results, the\n response object's nextToken parameter value is set to a token. To retrieve the\n next set of results, call ListWorldTemplates again and assign that token to\n the request object's nextToken parameter. If there are no remaining results,\n the previous response object's NextToken parameter is set to null.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.robomaker#ListWorlds": { - "type": "operation", - "input": { - "target": "com.amazonaws.robomaker#ListWorldsRequest" - }, - "output": { - "target": "com.amazonaws.robomaker#ListWorldsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.robomaker#InternalServerException" - }, - { - "target": "com.amazonaws.robomaker#InvalidParameterException" - }, - { - "target": "com.amazonaws.robomaker#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "\n

End of support notice: On September 10, 2025, Amazon Web Services\n will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will\n no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. \n For more information on transitioning to Batch to help run containerized\n simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.\n

\n \n

Lists worlds.

", - "smithy.api#http": { - "method": "POST", - "uri": "/listWorlds", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "items": "worldSummaries", - "pageSize": "maxResults" - } - } - }, - "com.amazonaws.robomaker#ListWorldsRequest": { - "type": "structure", - "members": { - "nextToken": { - "target": "com.amazonaws.robomaker#PaginationToken", - "traits": { - "smithy.api#documentation": "

If the previous paginated request did not return all of the remaining results, the\n response object's nextToken parameter value is set to a token. To retrieve the\n next set of results, call ListWorlds again and assign that token to the\n request object's nextToken parameter. If there are no remaining results, the\n previous response object's NextToken parameter is set to null.

" - } - }, - "maxResults": { - "target": "com.amazonaws.robomaker#MaxResults", - "traits": { - "smithy.api#documentation": "

When this parameter is used, ListWorlds only returns\n maxResults results in a single page along with a nextToken\n response element. The remaining results of the initial request can be seen by sending\n another ListWorlds request with the returned nextToken value.\n This value can be between 1 and 100. If this parameter is not used, then\n ListWorlds returns up to 100 results and a nextToken value if\n applicable.

" - } - }, - "filters": { - "target": "com.amazonaws.robomaker#Filters", - "traits": { - "smithy.api#documentation": "

Optional filters to limit results. You can use status.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.robomaker#ListWorldsResponse": { - "type": "structure", - "members": { - "worldSummaries": { - "target": "com.amazonaws.robomaker#WorldSummaries", - "traits": { - "smithy.api#documentation": "

Summary information for worlds.

" - } - }, - "nextToken": { - "target": "com.amazonaws.robomaker#PaginationToken", - "traits": { - "smithy.api#documentation": "

If the previous paginated request did not return all of the remaining results, the\n response object's nextToken parameter value is set to a token. To retrieve the\n next set of results, call ListWorlds again and assign that token to the\n request object's nextToken parameter. If there are no remaining results, the\n previous response object's NextToken parameter is set to null.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.robomaker#LoggingConfig": { - "type": "structure", - "members": { - "recordAllRosTopics": { - "target": "com.amazonaws.robomaker#BoxedBoolean", - "traits": { - "smithy.api#deprecated": { - "message": "AWS RoboMaker is ending support for ROS software suite. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/software-support-policy.html." - }, - "smithy.api#documentation": "

A boolean indicating whether to record all ROS topics.

\n \n

This API is no longer supported and will throw an error if used.

\n " - } - } - }, - "traits": { - "smithy.api#documentation": "

The logging configuration.

" - } - }, - "com.amazonaws.robomaker#MaxConcurrency": { - "type": "integer" - }, - "com.amazonaws.robomaker#MaxResults": { - "type": "integer" - }, - "com.amazonaws.robomaker#Name": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 255 - }, - "smithy.api#pattern": "^[a-zA-Z0-9_\\-]*$" - } - }, - "com.amazonaws.robomaker#NetworkInterface": { - "type": "structure", - "members": { - "networkInterfaceId": { - "target": "com.amazonaws.robomaker#GenericString", - "traits": { - "smithy.api#documentation": "

The ID of the network interface.

" - } - }, - "privateIpAddress": { - "target": "com.amazonaws.robomaker#GenericString", - "traits": { - "smithy.api#documentation": "

The IPv4 address of the network interface within the subnet.

" - } - }, - "publicIpAddress": { - "target": "com.amazonaws.robomaker#GenericString", - "traits": { - "smithy.api#documentation": "

The IPv4 public address of the network interface.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a network interface.

" - } - }, - "com.amazonaws.robomaker#NonEmptyString": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 255 - }, - "smithy.api#pattern": "^.+$" - } - }, - "com.amazonaws.robomaker#NonSystemPort": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1024, - "max": 65535 - } - } - }, - "com.amazonaws.robomaker#OutputLocation": { - "type": "structure", - "members": { - "s3Bucket": { - "target": "com.amazonaws.robomaker#S3Bucket", - "traits": { - "smithy.api#documentation": "

The S3 bucket for output.

" - } - }, - "s3Prefix": { - "target": "com.amazonaws.robomaker#S3Key", - "traits": { - "smithy.api#documentation": "

The S3 folder in the s3Bucket where output files will be placed.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The output location.

" - } - }, - "com.amazonaws.robomaker#PaginationToken": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2048 - }, - "smithy.api#pattern": "^[a-zA-Z0-9_.\\-\\/+=]*$" - } - }, - "com.amazonaws.robomaker#Path": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1024 - }, - "smithy.api#pattern": ".*" - } - }, - "com.amazonaws.robomaker#PercentDone": { - "type": "float", - "traits": { - "smithy.api#range": { - "min": 0.0, - "max": 100.0 - } - } - }, - "com.amazonaws.robomaker#Percentage": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 100 - } - } - }, - "com.amazonaws.robomaker#Port": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 65535 - } - } - }, - "com.amazonaws.robomaker#PortForwardingConfig": { - "type": "structure", - "members": { - "portMappings": { - "target": "com.amazonaws.robomaker#PortMappingList", - "traits": { - "smithy.api#documentation": "

The port mappings for the configuration.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Configuration information for port forwarding.

" - } - }, - "com.amazonaws.robomaker#PortMapping": { - "type": "structure", - "members": { - "jobPort": { - "target": "com.amazonaws.robomaker#Port", - "traits": { - "smithy.api#documentation": "

The port number on the simulation job instance to use as a remote connection point.\n

", - "smithy.api#required": {} - } - }, - "applicationPort": { - "target": "com.amazonaws.robomaker#NonSystemPort", - "traits": { - "smithy.api#documentation": "

The port number on the application.

", - "smithy.api#required": {} - } - }, - "enableOnPublicIp": { - "target": "com.amazonaws.robomaker#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A Boolean indicating whether to enable this port mapping on public IP.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

An object representing a port mapping.

" - } - }, - "com.amazonaws.robomaker#PortMappingList": { - "type": "list", - "member": { - "target": "com.amazonaws.robomaker#PortMapping" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 10 - } - } - }, - "com.amazonaws.robomaker#ProgressDetail": { - "type": "structure", - "members": { - "currentProgress": { - "target": "com.amazonaws.robomaker#RobotDeploymentStep", - "traits": { - "smithy.api#documentation": "

The current progress status.

\n
\n
Validating
\n
\n

Validating the deployment.

\n
\n
DownloadingExtracting
\n
\n

Downloading and extracting the bundle on the robot.

\n
\n
ExecutingPreLaunch
\n
\n

Executing pre-launch script(s) if provided.

\n
\n
Launching
\n
\n

Launching the robot application.

\n
\n
ExecutingPostLaunch
\n
\n

Executing post-launch script(s) if provided.

\n
\n
Finished
\n
\n

Deployment is complete.

\n
\n
" - } - }, - "percentDone": { - "target": "com.amazonaws.robomaker#PercentDone", - "traits": { - "smithy.api#documentation": "

Precentage of the step that is done. This currently only applies to the\n Downloading/Extracting step of the deployment. It is empty for other\n steps.

" - } - }, - "estimatedTimeRemainingSeconds": { - "target": "com.amazonaws.robomaker#GenericInteger", - "traits": { - "smithy.api#documentation": "

Estimated amount of time in seconds remaining in the step. This currently only applies\n to the Downloading/Extracting step of the deployment. It is empty for other\n steps.

" - } - }, - "targetResource": { - "target": "com.amazonaws.robomaker#GenericString", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the deployment job.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about the progress of a deployment job.

" - } - }, - "com.amazonaws.robomaker#RegisterRobot": { - "type": "operation", - "input": { - "target": "com.amazonaws.robomaker#RegisterRobotRequest" - }, - "output": { - "target": "com.amazonaws.robomaker#RegisterRobotResponse" - }, - "errors": [ - { - "target": "com.amazonaws.robomaker#InternalServerException" - }, - { - "target": "com.amazonaws.robomaker#InvalidParameterException" - }, - { - "target": "com.amazonaws.robomaker#LimitExceededException" - }, - { - "target": "com.amazonaws.robomaker#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.robomaker#ThrottlingException" - } - ], - "traits": { - "smithy.api#deprecated": { - "message": "AWS RoboMaker is unable to process this request as the support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." - }, - "smithy.api#documentation": "\n

End of support notice: On September 10, 2025, Amazon Web Services\n will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will\n no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. \n For more information on transitioning to Batch to help run containerized\n simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.\n

\n \n

Registers a robot with a fleet.

\n \n

This API is no longer supported and will throw an error if used. For more information, see the January 31, 2022 update in the Support policy page.

\n ", - "smithy.api#http": { - "method": "POST", - "uri": "/registerRobot", - "code": 200 - } - } - }, - "com.amazonaws.robomaker#RegisterRobotRequest": { - "type": "structure", - "members": { - "fleet": { - "target": "com.amazonaws.robomaker#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the fleet.

", - "smithy.api#required": {} - } - }, - "robot": { - "target": "com.amazonaws.robomaker#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the robot.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#deprecated": { - "message": "AWS RoboMaker is unable to process this request as the support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." - }, - "smithy.api#input": {} - } - }, - "com.amazonaws.robomaker#RegisterRobotResponse": { - "type": "structure", - "members": { - "fleet": { - "target": "com.amazonaws.robomaker#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the fleet that the robot will join.

" - } - }, - "robot": { - "target": "com.amazonaws.robomaker#Arn", - "traits": { - "smithy.api#documentation": "

Information about the robot registration.

" - } - } - }, - "traits": { - "smithy.api#deprecated": { - "message": "AWS RoboMaker is unable to process this request as the support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." - }, - "smithy.api#output": {} - } - }, - "com.amazonaws.robomaker#RenderingEngine": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.robomaker#RenderingEngineType", - "traits": { - "smithy.api#documentation": "

The name of the rendering engine.

" - } - }, - "version": { - "target": "com.amazonaws.robomaker#RenderingEngineVersionType", - "traits": { - "smithy.api#documentation": "

The version of the rendering engine.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about a rendering engine.

" - } - }, - "com.amazonaws.robomaker#RenderingEngineType": { - "type": "enum", - "members": { - "OGRE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "OGRE" - } - } - } - }, - "com.amazonaws.robomaker#RenderingEngineVersionType": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 4 - }, - "smithy.api#pattern": "^1.x$" - } - }, - "com.amazonaws.robomaker#RepositoryUrl": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1024 - }, - "smithy.api#pattern": "^.+$" - } - }, - "com.amazonaws.robomaker#ResourceAlreadyExistsException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.robomaker#errorMessage" - } - }, - "traits": { - "smithy.api#documentation": "

The specified resource already exists.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.robomaker#ResourceNotFoundException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.robomaker#errorMessage" - } - }, - "traits": { - "smithy.api#documentation": "

The specified resource does not exist.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.robomaker#RestartSimulationJob": { - "type": "operation", - "input": { - "target": "com.amazonaws.robomaker#RestartSimulationJobRequest" - }, - "output": { - "target": "com.amazonaws.robomaker#RestartSimulationJobResponse" - }, - "errors": [ - { - "target": "com.amazonaws.robomaker#InternalServerException" - }, - { - "target": "com.amazonaws.robomaker#InvalidParameterException" - }, - { - "target": "com.amazonaws.robomaker#LimitExceededException" - }, - { - "target": "com.amazonaws.robomaker#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.robomaker#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "\n

End of support notice: On September 10, 2025, Amazon Web Services\n will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will\n no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. \n For more information on transitioning to Batch to help run containerized\n simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.\n

\n \n

Restarts a running simulation job.

", - "smithy.api#http": { - "method": "POST", - "uri": "/restartSimulationJob", - "code": 200 - } - } - }, - "com.amazonaws.robomaker#RestartSimulationJobRequest": { - "type": "structure", - "members": { - "job": { - "target": "com.amazonaws.robomaker#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the simulation job.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.robomaker#RestartSimulationJobResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.robomaker#RevisionId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 40 - }, - "smithy.api#pattern": "^[a-zA-Z0-9_.\\-]*$" - } - }, - "com.amazonaws.robomaker#Robot": { - "type": "structure", - "members": { - "arn": { - "target": "com.amazonaws.robomaker#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the robot.

" - } - }, - "name": { - "target": "com.amazonaws.robomaker#Name", - "traits": { - "smithy.api#documentation": "

The name of the robot.

" - } - }, - "fleetArn": { - "target": "com.amazonaws.robomaker#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the fleet.

" - } - }, - "status": { - "target": "com.amazonaws.robomaker#RobotStatus", - "traits": { - "smithy.api#documentation": "

The status of the robot.

" - } - }, - "greenGrassGroupId": { - "target": "com.amazonaws.robomaker#Id", - "traits": { - "smithy.api#documentation": "

The Greengrass group associated with the robot.

" - } - }, - "createdAt": { - "target": "com.amazonaws.robomaker#CreatedAt", - "traits": { - "smithy.api#documentation": "

The time, in milliseconds since the epoch, when the robot was created.

" - } - }, - "architecture": { - "target": "com.amazonaws.robomaker#Architecture", - "traits": { - "smithy.api#documentation": "

The architecture of the robot.

" - } - }, - "lastDeploymentJob": { - "target": "com.amazonaws.robomaker#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the last deployment job.

" - } - }, - "lastDeploymentTime": { - "target": "com.amazonaws.robomaker#CreatedAt", - "traits": { - "smithy.api#documentation": "

The time of the last deployment.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about a robot.

" - } - }, - "com.amazonaws.robomaker#RobotApplicationConfig": { - "type": "structure", - "members": { - "application": { - "target": "com.amazonaws.robomaker#Arn", - "traits": { - "smithy.api#documentation": "

The application information for the robot application.

", - "smithy.api#required": {} - } - }, - "applicationVersion": { - "target": "com.amazonaws.robomaker#Version", - "traits": { - "smithy.api#documentation": "

The version of the robot application.

" - } - }, - "launchConfig": { - "target": "com.amazonaws.robomaker#LaunchConfig", - "traits": { - "smithy.api#documentation": "

The launch configuration for the robot application.

", - "smithy.api#required": {} - } - }, - "uploadConfigurations": { - "target": "com.amazonaws.robomaker#UploadConfigurations", - "traits": { - "smithy.api#documentation": "

The upload configurations for the robot application.

" - } - }, - "useDefaultUploadConfigurations": { - "target": "com.amazonaws.robomaker#BoxedBoolean", - "traits": { - "smithy.api#deprecated": { - "message": "AWS RoboMaker is ending support for ROS software suite. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/software-support-policy.html." - }, - "smithy.api#documentation": "

A Boolean indicating whether to use default upload configurations. By default,\n .ros and .gazebo files are uploaded when the application\n terminates and all ROS topics will be recorded.

\n

If you set this value, you must specify an outputLocation.

\n \n

This API is no longer supported and will throw an error if used.

\n " - } - }, - "tools": { - "target": "com.amazonaws.robomaker#Tools", - "traits": { - "smithy.api#documentation": "

Information about tools configured for the robot application.

" - } - }, - "useDefaultTools": { - "target": "com.amazonaws.robomaker#BoxedBoolean", - "traits": { - "smithy.api#deprecated": { - "message": "AWS RoboMaker is ending support for ROS software suite. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/software-support-policy.html." - }, - "smithy.api#documentation": "

A Boolean indicating whether to use default robot application tools. The default tools\n are rviz, rqt, terminal and rosbag record. The default is False.

\n \n

This API is no longer supported and will throw an error if used.

\n " - } - } - }, - "traits": { - "smithy.api#documentation": "

Application configuration information for a robot.

" - } - }, - "com.amazonaws.robomaker#RobotApplicationConfigs": { - "type": "list", - "member": { - "target": "com.amazonaws.robomaker#RobotApplicationConfig" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1 - } - } - }, - "com.amazonaws.robomaker#RobotApplicationNames": { - "type": "list", - "member": { - "target": "com.amazonaws.robomaker#Name" - } - }, - "com.amazonaws.robomaker#RobotApplicationSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.robomaker#RobotApplicationSummary" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.robomaker#RobotApplicationSummary": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.robomaker#Name", - "traits": { - "smithy.api#documentation": "

The name of the robot application.

" - } - }, - "arn": { - "target": "com.amazonaws.robomaker#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the robot.

" - } - }, - "version": { - "target": "com.amazonaws.robomaker#Version", - "traits": { - "smithy.api#documentation": "

The version of the robot application.

" - } - }, - "lastUpdatedAt": { - "target": "com.amazonaws.robomaker#LastUpdatedAt", - "traits": { - "smithy.api#documentation": "

The time, in milliseconds since the epoch, when the robot application was last\n updated.

" - } - }, - "robotSoftwareSuite": { - "target": "com.amazonaws.robomaker#RobotSoftwareSuite", - "traits": { - "smithy.api#documentation": "

Information about a robot software suite.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Summary information for a robot application.

" - } - }, - "com.amazonaws.robomaker#RobotDeployment": { - "type": "structure", - "members": { - "arn": { - "target": "com.amazonaws.robomaker#Arn", - "traits": { - "smithy.api#documentation": "

The robot deployment Amazon Resource Name (ARN).

" - } - }, - "deploymentStartTime": { - "target": "com.amazonaws.robomaker#CreatedAt", - "traits": { - "smithy.api#documentation": "

The time, in milliseconds since the epoch, when the deployment was started.

" - } - }, - "deploymentFinishTime": { - "target": "com.amazonaws.robomaker#CreatedAt", - "traits": { - "smithy.api#documentation": "

The time, in milliseconds since the epoch, when the deployment finished.

" - } - }, - "status": { - "target": "com.amazonaws.robomaker#RobotStatus", - "traits": { - "smithy.api#documentation": "

The status of the robot deployment.

" - } - }, - "progressDetail": { - "target": "com.amazonaws.robomaker#ProgressDetail", - "traits": { - "smithy.api#documentation": "

Information about how the deployment is progressing.

" - } - }, - "failureReason": { - "target": "com.amazonaws.robomaker#GenericString", - "traits": { - "smithy.api#documentation": "

A short description of the reason why the robot deployment failed.

" - } - }, - "failureCode": { - "target": "com.amazonaws.robomaker#DeploymentJobErrorCode", - "traits": { - "smithy.api#documentation": "

The robot deployment failure code.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about a robot deployment.

" - } - }, - "com.amazonaws.robomaker#RobotDeploymentStep": { - "type": "enum", - "members": { - "ValidatingStep": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Validating" - } - }, - "DownloadingExtractingStep": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DownloadingExtracting" - } - }, - "ExecutingDownloadCondition": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ExecutingDownloadCondition" - } - }, - "PreLaunchStep": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ExecutingPreLaunch" - } - }, - "LaunchingStep": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Launching" - } - }, - "PostLaunchStep": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ExecutingPostLaunch" - } - }, - "FinishedStep": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Finished" - } - } - } - }, - "com.amazonaws.robomaker#RobotDeploymentSummary": { - "type": "list", - "member": { - "target": "com.amazonaws.robomaker#RobotDeployment" - } - }, - "com.amazonaws.robomaker#RobotSoftwareSuite": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.robomaker#RobotSoftwareSuiteType", - "traits": { - "smithy.api#documentation": "

The name of the robot software suite. General is the only supported value.

" - } - }, - "version": { - "target": "com.amazonaws.robomaker#RobotSoftwareSuiteVersionType", - "traits": { - "smithy.api#documentation": "

The version of the robot software suite. Not applicable for General software suite.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about a robot software suite.

" - } - }, - "com.amazonaws.robomaker#RobotSoftwareSuiteType": { - "type": "enum", - "members": { - "ROS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ROS" - } - }, - "ROS2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ROS2" - } - }, - "General": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "General" - } - } - } - }, - "com.amazonaws.robomaker#RobotSoftwareSuiteVersionType": { - "type": "enum", - "members": { - "Kinetic": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Kinetic" - } - }, - "Melodic": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Melodic" - } - }, - "Dashing": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Dashing" - } - }, - "Foxy": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Foxy" - } - } - } - }, - "com.amazonaws.robomaker#RobotStatus": { - "type": "enum", - "members": { - "Available": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Available" - } - }, - "Registered": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Registered" - } - }, - "PendingNewDeployment": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PendingNewDeployment" - } - }, - "Deploying": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Deploying" - } - }, - "Failed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Failed" - } - }, - "InSync": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "InSync" - } - }, - "NoResponse": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NoResponse" - } - } - } - }, - "com.amazonaws.robomaker#Robots": { - "type": "list", - "member": { - "target": "com.amazonaws.robomaker#Robot" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1000 - } - } - }, - "com.amazonaws.robomaker#S3Bucket": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 3, - "max": 63 - }, - "smithy.api#pattern": "^[a-z0-9][a-z0-9.\\-]*[a-z0-9]$" - } - }, - "com.amazonaws.robomaker#S3Etag": { - "type": "string" - }, - "com.amazonaws.robomaker#S3Etags": { - "type": "list", - "member": { - "target": "com.amazonaws.robomaker#S3Etag" - } - }, - "com.amazonaws.robomaker#S3Key": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1024 - }, - "smithy.api#pattern": ".*" - } - }, - "com.amazonaws.robomaker#S3KeyOrPrefix": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1024 - }, - "smithy.api#pattern": ".*" - } - }, - "com.amazonaws.robomaker#S3KeyOutput": { - "type": "structure", - "members": { - "s3Key": { - "target": "com.amazonaws.robomaker#S3KeyOrPrefix", - "traits": { - "smithy.api#documentation": "

The S3 key.

" - } - }, - "etag": { - "target": "com.amazonaws.robomaker#S3Etag", - "traits": { - "smithy.api#documentation": "

The etag for the object.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about S3 keys.

" - } - }, - "com.amazonaws.robomaker#S3KeyOutputs": { - "type": "list", - "member": { - "target": "com.amazonaws.robomaker#S3KeyOutput" - } - }, - "com.amazonaws.robomaker#S3KeysOrPrefixes": { - "type": "list", - "member": { - "target": "com.amazonaws.robomaker#S3KeyOrPrefix" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 100 - } - } - }, - "com.amazonaws.robomaker#S3Object": { - "type": "structure", - "members": { - "bucket": { - "target": "com.amazonaws.robomaker#S3Bucket", - "traits": { - "smithy.api#documentation": "

The bucket containing the object.

", - "smithy.api#required": {} - } - }, - "key": { - "target": "com.amazonaws.robomaker#S3Key", - "traits": { - "smithy.api#documentation": "

The key of the object.

", - "smithy.api#required": {} - } - }, - "etag": { - "target": "com.amazonaws.robomaker#S3Etag", - "traits": { - "smithy.api#documentation": "

The etag of the object.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about an S3 object.

" - } - }, - "com.amazonaws.robomaker#SecurityGroups": { - "type": "list", - "member": { - "target": "com.amazonaws.robomaker#NonEmptyString" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 5 - } - } - }, - "com.amazonaws.robomaker#ServiceUnavailableException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.robomaker#errorMessage" - } - }, - "traits": { - "smithy.api#documentation": "

The request has failed due to a temporary failure of the server.

", - "smithy.api#error": "server", - "smithy.api#httpError": 503 - } - }, - "com.amazonaws.robomaker#SimulationApplicationConfig": { - "type": "structure", - "members": { - "application": { - "target": "com.amazonaws.robomaker#Arn", - "traits": { - "smithy.api#documentation": "

The application information for the simulation application.

", - "smithy.api#required": {} - } - }, - "applicationVersion": { - "target": "com.amazonaws.robomaker#Version", - "traits": { - "smithy.api#documentation": "

The version of the simulation application.

" - } - }, - "launchConfig": { - "target": "com.amazonaws.robomaker#LaunchConfig", - "traits": { - "smithy.api#documentation": "

The launch configuration for the simulation application.

", - "smithy.api#required": {} - } - }, - "uploadConfigurations": { - "target": "com.amazonaws.robomaker#UploadConfigurations", - "traits": { - "smithy.api#documentation": "

Information about upload configurations for the simulation application.

" - } - }, - "worldConfigs": { - "target": "com.amazonaws.robomaker#WorldConfigs", - "traits": { - "smithy.api#documentation": "

A list of world configurations.

\n \n

This API is no longer supported and will throw an error if used.

\n " - } - }, - "useDefaultUploadConfigurations": { - "target": "com.amazonaws.robomaker#BoxedBoolean", - "traits": { - "smithy.api#deprecated": { - "message": "AWS RoboMaker is ending support for ROS software suite. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/software-support-policy.html." - }, - "smithy.api#documentation": "

A Boolean indicating whether to use default upload configurations. By default,\n .ros and .gazebo files are uploaded when the application\n terminates and all ROS topics will be recorded.

\n

If you set this value, you must specify an outputLocation.

\n \n

This API is no longer supported and will throw an error if used.

\n " - } - }, - "tools": { - "target": "com.amazonaws.robomaker#Tools", - "traits": { - "smithy.api#documentation": "

Information about tools configured for the simulation application.

" - } - }, - "useDefaultTools": { - "target": "com.amazonaws.robomaker#BoxedBoolean", - "traits": { - "smithy.api#deprecated": { - "message": "AWS RoboMaker is ending support for ROS software suite. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/software-support-policy.html." - }, - "smithy.api#documentation": "

A Boolean indicating whether to use default simulation application tools. The default\n tools are rviz, rqt, terminal and rosbag record. The default is False.

\n \n

This API is no longer supported and will throw an error if used.

\n " - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about a simulation application configuration.

" - } - }, - "com.amazonaws.robomaker#SimulationApplicationConfigs": { - "type": "list", - "member": { - "target": "com.amazonaws.robomaker#SimulationApplicationConfig" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1 - } - } - }, - "com.amazonaws.robomaker#SimulationApplicationNames": { - "type": "list", - "member": { - "target": "com.amazonaws.robomaker#Name" - } - }, - "com.amazonaws.robomaker#SimulationApplicationSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.robomaker#SimulationApplicationSummary" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.robomaker#SimulationApplicationSummary": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.robomaker#Name", - "traits": { - "smithy.api#documentation": "

The name of the simulation application.

" - } - }, - "arn": { - "target": "com.amazonaws.robomaker#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the simulation application.

" - } - }, - "version": { - "target": "com.amazonaws.robomaker#Version", - "traits": { - "smithy.api#documentation": "

The version of the simulation application.

" - } - }, - "lastUpdatedAt": { - "target": "com.amazonaws.robomaker#LastUpdatedAt", - "traits": { - "smithy.api#documentation": "

The time, in milliseconds since the epoch, when the simulation application was last\n updated.

" - } - }, - "robotSoftwareSuite": { - "target": "com.amazonaws.robomaker#RobotSoftwareSuite", - "traits": { - "smithy.api#documentation": "

Information about a robot software suite.

" - } - }, - "simulationSoftwareSuite": { - "target": "com.amazonaws.robomaker#SimulationSoftwareSuite", - "traits": { - "smithy.api#documentation": "

Information about a simulation software suite.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Summary information for a simulation application.

" - } - }, - "com.amazonaws.robomaker#SimulationJob": { - "type": "structure", - "members": { - "arn": { - "target": "com.amazonaws.robomaker#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the simulation job.

" - } - }, - "name": { - "target": "com.amazonaws.robomaker#Name", - "traits": { - "smithy.api#documentation": "

The name of the simulation job.

" - } - }, - "status": { - "target": "com.amazonaws.robomaker#SimulationJobStatus", - "traits": { - "smithy.api#documentation": "

Status of the simulation job.

" - } - }, - "lastStartedAt": { - "target": "com.amazonaws.robomaker#LastStartedAt", - "traits": { - "smithy.api#documentation": "

The time, in milliseconds since the epoch, when the simulation job was last\n started.

" - } - }, - "lastUpdatedAt": { - "target": "com.amazonaws.robomaker#LastUpdatedAt", - "traits": { - "smithy.api#documentation": "

The time, in milliseconds since the epoch, when the simulation job was last\n updated.

" - } - }, - "failureBehavior": { - "target": "com.amazonaws.robomaker#FailureBehavior", - "traits": { - "smithy.api#documentation": "

The failure behavior the simulation job.

\n
\n
Continue
\n
\n

Leaves the host running for its maximum timeout duration after a\n 4XX error code.

\n
\n
Fail
\n
\n

Stop the simulation job and terminate the instance.

\n
\n
" - } - }, - "failureCode": { - "target": "com.amazonaws.robomaker#SimulationJobErrorCode", - "traits": { - "smithy.api#documentation": "

The failure code of the simulation job if it failed.

" - } - }, - "failureReason": { - "target": "com.amazonaws.robomaker#GenericString", - "traits": { - "smithy.api#documentation": "

The reason why the simulation job failed.

" - } - }, - "clientRequestToken": { - "target": "com.amazonaws.robomaker#ClientRequestToken", - "traits": { - "smithy.api#documentation": "

A unique identifier for this SimulationJob request.

" - } - }, - "outputLocation": { - "target": "com.amazonaws.robomaker#OutputLocation", - "traits": { - "smithy.api#documentation": "

Location for output files generated by the simulation job.

" - } - }, - "loggingConfig": { - "target": "com.amazonaws.robomaker#LoggingConfig", - "traits": { - "smithy.api#documentation": "

The logging configuration.

" - } - }, - "maxJobDurationInSeconds": { - "target": "com.amazonaws.robomaker#JobDuration", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum simulation job duration in seconds. The value must be 8 days (691,200\n seconds) or less.

" - } - }, - "simulationTimeMillis": { - "target": "com.amazonaws.robomaker#SimulationTimeMillis", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The simulation job execution duration in milliseconds.

" - } - }, - "iamRole": { - "target": "com.amazonaws.robomaker#IamRole", - "traits": { - "smithy.api#documentation": "

The IAM role that allows the simulation instance to call the AWS APIs that are specified\n in its associated policies on your behalf. This is how credentials are passed in to your\n simulation job.

" - } - }, - "robotApplications": { - "target": "com.amazonaws.robomaker#RobotApplicationConfigs", - "traits": { - "smithy.api#documentation": "

A list of robot applications.

" - } - }, - "simulationApplications": { - "target": "com.amazonaws.robomaker#SimulationApplicationConfigs", - "traits": { - "smithy.api#documentation": "

A list of simulation applications.

" - } - }, - "dataSources": { - "target": "com.amazonaws.robomaker#DataSources", - "traits": { - "smithy.api#documentation": "

The data sources for the simulation job.

" - } - }, - "tags": { - "target": "com.amazonaws.robomaker#TagMap", - "traits": { - "smithy.api#documentation": "

A map that contains tag keys and tag values that are attached to the simulation\n job.

" - } - }, - "vpcConfig": { - "target": "com.amazonaws.robomaker#VPCConfigResponse", - "traits": { - "smithy.api#documentation": "

VPC configuration information.

" - } - }, - "networkInterface": { - "target": "com.amazonaws.robomaker#NetworkInterface", - "traits": { - "smithy.api#documentation": "

Information about a network interface.

" - } - }, - "compute": { - "target": "com.amazonaws.robomaker#ComputeResponse", - "traits": { - "smithy.api#documentation": "

Compute information for the simulation job

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about a simulation job.

" - } - }, - "com.amazonaws.robomaker#SimulationJobBatchErrorCode": { - "type": "enum", - "members": { - "InternalServiceError": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "InternalServiceError" - } - } - } - }, - "com.amazonaws.robomaker#SimulationJobBatchStatus": { - "type": "enum", - "members": { - "Pending": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Pending" - } - }, - "InProgress": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "InProgress" - } - }, - "Failed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Failed" - } - }, - "Completed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Completed" - } - }, - "Canceled": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Canceled" - } - }, - "Canceling": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Canceling" - } - }, - "Completing": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Completing" - } - }, - "TimingOut": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TimingOut" - } - }, - "TimedOut": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TimedOut" - } - } - } - }, - "com.amazonaws.robomaker#SimulationJobBatchSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.robomaker#SimulationJobBatchSummary" - } - }, - "com.amazonaws.robomaker#SimulationJobBatchSummary": { - "type": "structure", - "members": { - "arn": { - "target": "com.amazonaws.robomaker#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the batch.

" - } - }, - "lastUpdatedAt": { - "target": "com.amazonaws.robomaker#LastUpdatedAt", - "traits": { - "smithy.api#documentation": "

The time, in milliseconds since the epoch, when the simulation job batch was last updated.\n

" - } - }, - "createdAt": { - "target": "com.amazonaws.robomaker#CreatedAt", - "traits": { - "smithy.api#documentation": "

The time, in milliseconds since the epoch, when the simulation job batch was\n created.

" - } - }, - "status": { - "target": "com.amazonaws.robomaker#SimulationJobBatchStatus", - "traits": { - "smithy.api#documentation": "

The status of the simulation job batch.

\n
\n
Pending
\n
\n

The simulation job batch request is pending.

\n
\n
InProgress
\n
\n

The simulation job batch is in progress.

\n
\n
Failed
\n
\n

The simulation job batch failed. One or more simulation job requests could not\n be completed due to an internal failure (like InternalServiceError).\n See failureCode and failureReason for more\n information.

\n
\n
Completed
\n
\n

The simulation batch job completed. A batch is complete when (1) there are no\n pending simulation job requests in the batch and none of the failed simulation job\n requests are due to InternalServiceError and (2) when all created\n simulation jobs have reached a terminal state (for example, Completed\n or Failed).

\n
\n
Canceled
\n
\n

The simulation batch job was cancelled.

\n
\n
Canceling
\n
\n

The simulation batch job is being cancelled.

\n
\n
Completing
\n
\n

The simulation batch job is completing.

\n
\n
TimingOut
\n
\n

The simulation job batch is timing out.

\n

If a batch timing out, and there are pending requests that were failing due to\n an internal failure (like InternalServiceError), the batch status\n will be Failed. If there are no such failing request, the batch\n status will be TimedOut.

\n
\n
TimedOut
\n
\n

The simulation batch job timed out.

\n
\n
" - } - }, - "failedRequestCount": { - "target": "com.amazonaws.robomaker#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of failed simulation job requests.

" - } - }, - "pendingRequestCount": { - "target": "com.amazonaws.robomaker#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of pending simulation job requests.

" - } - }, - "createdRequestCount": { - "target": "com.amazonaws.robomaker#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of created simulation job requests.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about a simulation job batch.

" - } - }, - "com.amazonaws.robomaker#SimulationJobErrorCode": { - "type": "enum", - "members": { - "InternalServiceError": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "InternalServiceError" - } - }, - "RobotApplicationCrash": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RobotApplicationCrash" - } - }, - "SimulationApplicationCrash": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SimulationApplicationCrash" - } - }, - "RobotApplicationHealthCheckFailure": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RobotApplicationHealthCheckFailure" - } - }, - "SimulationApplicationHealthCheckFailure": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SimulationApplicationHealthCheckFailure" - } - }, - "BadPermissionsRobotApplication": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BadPermissionsRobotApplication" - } - }, - "BadPermissionsSimulationApplication": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BadPermissionsSimulationApplication" - } - }, - "BadPermissionsS3Object": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BadPermissionsS3Object" - } - }, - "BadPermissionsS3Output": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BadPermissionsS3Output" - } - }, - "BadPermissionsCloudwatchLogs": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BadPermissionsCloudwatchLogs" - } - }, - "SubnetIpLimitExceeded": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SubnetIpLimitExceeded" - } - }, - "ENILimitExceeded": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ENILimitExceeded" - } - }, - "BadPermissionsUserCredentials": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BadPermissionsUserCredentials" - } - }, - "InvalidBundleRobotApplication": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "InvalidBundleRobotApplication" - } - }, - "InvalidBundleSimulationApplication": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "InvalidBundleSimulationApplication" - } - }, - "InvalidS3Resource": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "InvalidS3Resource" - } - }, - "ThrottlingError": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ThrottlingError" - } - }, - "LimitExceeded": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LimitExceeded" - } - }, - "MismatchedEtag": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MismatchedEtag" - } - }, - "RobotApplicationVersionMismatchedEtag": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RobotApplicationVersionMismatchedEtag" - } - }, - "SimulationApplicationVersionMismatchedEtag": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SimulationApplicationVersionMismatchedEtag" - } - }, - "ResourceNotFound": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ResourceNotFound" - } - }, - "RequestThrottled": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RequestThrottled" - } - }, - "BatchTimedOut": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BatchTimedOut" - } - }, - "BatchCanceled": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BatchCanceled" - } - }, - "InvalidInput": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "InvalidInput" - } - }, - "WrongRegionS3Bucket": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "WrongRegionS3Bucket" - } - }, - "WrongRegionS3Output": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "WrongRegionS3Output" - } - }, - "WrongRegionRobotApplication": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "WrongRegionRobotApplication" - } - }, - "WrongRegionSimulationApplication": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "WrongRegionSimulationApplication" - } - }, - "UploadContentMismatchError": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UploadContentMismatchError" - } - } - } - }, - "com.amazonaws.robomaker#SimulationJobRequest": { - "type": "structure", - "members": { - "outputLocation": { - "target": "com.amazonaws.robomaker#OutputLocation" - }, - "loggingConfig": { - "target": "com.amazonaws.robomaker#LoggingConfig" - }, - "maxJobDurationInSeconds": { - "target": "com.amazonaws.robomaker#JobDuration", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum simulation job duration in seconds. The value must be 8 days (691,200\n seconds) or less.

", - "smithy.api#required": {} - } - }, - "iamRole": { - "target": "com.amazonaws.robomaker#IamRole", - "traits": { - "smithy.api#documentation": "

The IAM role name that allows the simulation instance to call the AWS APIs that are\n specified in its associated policies on your behalf. This is how credentials are passed in\n to your simulation job.

" - } - }, - "failureBehavior": { - "target": "com.amazonaws.robomaker#FailureBehavior", - "traits": { - "smithy.api#documentation": "

The failure behavior the simulation job.

\n
\n
Continue
\n
\n

Leaves the host running for its maximum timeout duration after a\n 4XX error code.

\n
\n
Fail
\n
\n

Stop the simulation job and terminate the instance.

\n
\n
" - } - }, - "useDefaultApplications": { - "target": "com.amazonaws.robomaker#BoxedBoolean", - "traits": { - "smithy.api#documentation": "

A Boolean indicating whether to use default applications in the simulation job. Default\n applications include Gazebo, rqt, rviz and terminal access.

" - } - }, - "robotApplications": { - "target": "com.amazonaws.robomaker#RobotApplicationConfigs", - "traits": { - "smithy.api#documentation": "

The robot applications to use in the simulation job.

" - } - }, - "simulationApplications": { - "target": "com.amazonaws.robomaker#SimulationApplicationConfigs", - "traits": { - "smithy.api#documentation": "

The simulation applications to use in the simulation job.

" - } - }, - "dataSources": { - "target": "com.amazonaws.robomaker#DataSourceConfigs", - "traits": { - "smithy.api#documentation": "

Specify data sources to mount read-only files from S3 into your simulation. These files\n are available under /opt/robomaker/datasources/data_source_name.

\n \n

There is a limit of 100 files and a combined size of 25GB for all\n DataSourceConfig objects.

\n " - } - }, - "vpcConfig": { - "target": "com.amazonaws.robomaker#VPCConfig" - }, - "compute": { - "target": "com.amazonaws.robomaker#Compute", - "traits": { - "smithy.api#documentation": "

Compute information for the simulation job

" - } - }, - "tags": { - "target": "com.amazonaws.robomaker#TagMap", - "traits": { - "smithy.api#documentation": "

A map that contains tag keys and tag values that are attached to the simulation job\n request.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about a simulation job request.

" - } - }, - "com.amazonaws.robomaker#SimulationJobStatus": { - "type": "enum", - "members": { - "Pending": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Pending" - } - }, - "Preparing": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Preparing" - } - }, - "Running": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Running" - } - }, - "Restarting": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Restarting" - } - }, - "Completed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Completed" - } - }, - "Failed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Failed" - } - }, - "RunningFailed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RunningFailed" - } - }, - "Terminating": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Terminating" - } - }, - "Terminated": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Terminated" - } - }, - "Canceled": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Canceled" - } - } - } - }, - "com.amazonaws.robomaker#SimulationJobSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.robomaker#SimulationJobSummary" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.robomaker#SimulationJobSummary": { - "type": "structure", - "members": { - "arn": { - "target": "com.amazonaws.robomaker#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the simulation job.

" - } - }, - "lastUpdatedAt": { - "target": "com.amazonaws.robomaker#LastUpdatedAt", - "traits": { - "smithy.api#documentation": "

The time, in milliseconds since the epoch, when the simulation job was last\n updated.

" - } - }, - "name": { - "target": "com.amazonaws.robomaker#Name", - "traits": { - "smithy.api#documentation": "

The name of the simulation job.

" - } - }, - "status": { - "target": "com.amazonaws.robomaker#SimulationJobStatus", - "traits": { - "smithy.api#documentation": "

The status of the simulation job.

" - } - }, - "simulationApplicationNames": { - "target": "com.amazonaws.robomaker#SimulationApplicationNames", - "traits": { - "smithy.api#documentation": "

A list of simulation job simulation application names.

" - } - }, - "robotApplicationNames": { - "target": "com.amazonaws.robomaker#RobotApplicationNames", - "traits": { - "smithy.api#documentation": "

A list of simulation job robot application names.

" - } - }, - "dataSourceNames": { - "target": "com.amazonaws.robomaker#DataSourceNames", - "traits": { - "smithy.api#documentation": "

The names of the data sources.

" - } - }, - "computeType": { - "target": "com.amazonaws.robomaker#ComputeType", - "traits": { - "smithy.api#documentation": "

The compute type for the simulation job summary.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Summary information for a simulation job.

" - } - }, - "com.amazonaws.robomaker#SimulationJobs": { - "type": "list", - "member": { - "target": "com.amazonaws.robomaker#SimulationJob" - } - }, - "com.amazonaws.robomaker#SimulationSoftwareSuite": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.robomaker#SimulationSoftwareSuiteType", - "traits": { - "smithy.api#documentation": "

The name of the simulation software suite. SimulationRuntime is the only supported value.

" - } - }, - "version": { - "target": "com.amazonaws.robomaker#SimulationSoftwareSuiteVersionType", - "traits": { - "smithy.api#documentation": "

The version of the simulation software suite. Not applicable for SimulationRuntime.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about a simulation software suite.

" - } - }, - "com.amazonaws.robomaker#SimulationSoftwareSuiteType": { - "type": "enum", - "members": { - "Gazebo": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Gazebo" - } - }, - "RosbagPlay": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RosbagPlay" - } - }, - "SimulationRuntime": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SimulationRuntime" - } - } - } - }, - "com.amazonaws.robomaker#SimulationSoftwareSuiteVersionType": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1024 - }, - "smithy.api#pattern": "^7|9|11|Kinetic|Melodic|Dashing|Foxy$" - } - }, - "com.amazonaws.robomaker#SimulationTimeMillis": { - "type": "long", - "traits": { - "smithy.api#default": 0 - } - }, - "com.amazonaws.robomaker#SimulationUnit": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 15 - } - } - }, - "com.amazonaws.robomaker#Source": { - "type": "structure", - "members": { - "s3Bucket": { - "target": "com.amazonaws.robomaker#S3Bucket", - "traits": { - "smithy.api#documentation": "

The s3 bucket name.

" - } - }, - "s3Key": { - "target": "com.amazonaws.robomaker#S3Key", - "traits": { - "smithy.api#documentation": "

The s3 object key.

" - } - }, - "etag": { - "target": "com.amazonaws.robomaker#S3Etag", - "traits": { - "smithy.api#documentation": "

A hash of the object specified by s3Bucket and s3Key.

" - } - }, - "architecture": { - "target": "com.amazonaws.robomaker#Architecture", - "traits": { - "smithy.api#documentation": "

The taget processor architecture for the application.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about a source.

" - } - }, - "com.amazonaws.robomaker#SourceConfig": { - "type": "structure", - "members": { - "s3Bucket": { - "target": "com.amazonaws.robomaker#S3Bucket", - "traits": { - "smithy.api#documentation": "

The Amazon S3 bucket name.

" - } - }, - "s3Key": { - "target": "com.amazonaws.robomaker#S3Key", - "traits": { - "smithy.api#documentation": "

The s3 object key.

" - } - }, - "architecture": { - "target": "com.amazonaws.robomaker#Architecture", - "traits": { - "smithy.api#documentation": "

The target processor architecture for the application.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about a source configuration.

" - } - }, - "com.amazonaws.robomaker#SourceConfigs": { - "type": "list", - "member": { - "target": "com.amazonaws.robomaker#SourceConfig" - } - }, - "com.amazonaws.robomaker#Sources": { - "type": "list", - "member": { - "target": "com.amazonaws.robomaker#Source" - } - }, - "com.amazonaws.robomaker#StartSimulationJobBatch": { - "type": "operation", - "input": { - "target": "com.amazonaws.robomaker#StartSimulationJobBatchRequest" - }, - "output": { - "target": "com.amazonaws.robomaker#StartSimulationJobBatchResponse" - }, - "errors": [ - { - "target": "com.amazonaws.robomaker#IdempotentParameterMismatchException" - }, - { - "target": "com.amazonaws.robomaker#InternalServerException" - }, - { - "target": "com.amazonaws.robomaker#InvalidParameterException" - }, - { - "target": "com.amazonaws.robomaker#LimitExceededException" - }, - { - "target": "com.amazonaws.robomaker#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "\n

End of support notice: On September 10, 2025, Amazon Web Services\n will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will\n no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. \n For more information on transitioning to Batch to help run containerized\n simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.\n

\n \n

Starts a new simulation job batch. The batch is defined using one or more\n SimulationJobRequest objects.

", - "smithy.api#http": { - "method": "POST", - "uri": "/startSimulationJobBatch", - "code": 200 - } - } - }, - "com.amazonaws.robomaker#StartSimulationJobBatchRequest": { - "type": "structure", - "members": { - "clientRequestToken": { - "target": "com.amazonaws.robomaker#ClientRequestToken", - "traits": { - "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request.

", - "smithy.api#idempotencyToken": {} - } - }, - "batchPolicy": { - "target": "com.amazonaws.robomaker#BatchPolicy", - "traits": { - "smithy.api#documentation": "

The batch policy.

" - } - }, - "createSimulationJobRequests": { - "target": "com.amazonaws.robomaker#CreateSimulationJobRequests", - "traits": { - "smithy.api#documentation": "

A list of simulation job requests to create in the batch.

", - "smithy.api#required": {} - } - }, - "tags": { - "target": "com.amazonaws.robomaker#TagMap", - "traits": { - "smithy.api#documentation": "

A map that contains tag keys and tag values that are attached to the deployment job\n batch.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.robomaker#StartSimulationJobBatchResponse": { - "type": "structure", - "members": { - "arn": { - "target": "com.amazonaws.robomaker#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (arn) of the batch.

" - } - }, - "status": { - "target": "com.amazonaws.robomaker#SimulationJobBatchStatus", - "traits": { - "smithy.api#documentation": "

The status of the simulation job batch.

\n
\n
Pending
\n
\n

The simulation job batch request is pending.

\n
\n
InProgress
\n
\n

The simulation job batch is in progress.

\n
\n
Failed
\n
\n

The simulation job batch failed. One or more simulation job requests could not\n be completed due to an internal failure (like InternalServiceError).\n See failureCode and failureReason for more\n information.

\n
\n
Completed
\n
\n

The simulation batch job completed. A batch is complete when (1) there are no\n pending simulation job requests in the batch and none of the failed simulation job\n requests are due to InternalServiceError and (2) when all created\n simulation jobs have reached a terminal state (for example, Completed\n or Failed).

\n
\n
Canceled
\n
\n

The simulation batch job was cancelled.

\n
\n
Canceling
\n
\n

The simulation batch job is being cancelled.

\n
\n
Completing
\n
\n

The simulation batch job is completing.

\n
\n
TimingOut
\n
\n

The simulation job batch is timing out.

\n

If a batch timing out, and there are pending requests that were failing due to\n an internal failure (like InternalServiceError), the batch status\n will be Failed. If there are no such failing request, the batch\n status will be TimedOut.

\n
\n
TimedOut
\n
\n

The simulation batch job timed out.

\n
\n
" - } - }, - "createdAt": { - "target": "com.amazonaws.robomaker#CreatedAt", - "traits": { - "smithy.api#documentation": "

The time, in milliseconds since the epoch, when the simulation job batch was\n created.

" - } - }, - "clientRequestToken": { - "target": "com.amazonaws.robomaker#ClientRequestToken", - "traits": { - "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request.

" - } - }, - "batchPolicy": { - "target": "com.amazonaws.robomaker#BatchPolicy", - "traits": { - "smithy.api#documentation": "

The batch policy.

" - } - }, - "failureCode": { - "target": "com.amazonaws.robomaker#SimulationJobBatchErrorCode", - "traits": { - "smithy.api#documentation": "

The failure code if the simulation job batch failed.

" - } - }, - "failureReason": { - "target": "com.amazonaws.robomaker#GenericString", - "traits": { - "smithy.api#documentation": "

The reason the simulation job batch failed.

" - } - }, - "failedRequests": { - "target": "com.amazonaws.robomaker#FailedCreateSimulationJobRequests", - "traits": { - "smithy.api#documentation": "

A list of failed simulation job requests. The request failed to be created into a\n simulation job. Failed requests do not have a simulation job ID.

" - } - }, - "pendingRequests": { - "target": "com.amazonaws.robomaker#CreateSimulationJobRequests", - "traits": { - "smithy.api#documentation": "

A list of pending simulation job requests. These requests have not yet been created into\n simulation jobs.

" - } - }, - "createdRequests": { - "target": "com.amazonaws.robomaker#SimulationJobSummaries", - "traits": { - "smithy.api#documentation": "

A list of created simulation job request summaries.

" - } - }, - "tags": { - "target": "com.amazonaws.robomaker#TagMap", - "traits": { - "smithy.api#documentation": "

A map that contains tag keys and tag values that are attached to the deployment job\n batch.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.robomaker#Subnets": { - "type": "list", - "member": { - "target": "com.amazonaws.robomaker#NonEmptyString" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 16 - } - } - }, - "com.amazonaws.robomaker#SyncDeploymentJob": { - "type": "operation", - "input": { - "target": "com.amazonaws.robomaker#SyncDeploymentJobRequest" - }, - "output": { - "target": "com.amazonaws.robomaker#SyncDeploymentJobResponse" - }, - "errors": [ - { - "target": "com.amazonaws.robomaker#ConcurrentDeploymentException" - }, - { - "target": "com.amazonaws.robomaker#IdempotentParameterMismatchException" - }, - { - "target": "com.amazonaws.robomaker#InternalServerException" - }, - { - "target": "com.amazonaws.robomaker#InvalidParameterException" - }, - { - "target": "com.amazonaws.robomaker#LimitExceededException" - }, - { - "target": "com.amazonaws.robomaker#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.robomaker#ThrottlingException" - } - ], - "traits": { - "smithy.api#deprecated": { - "message": "Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." - }, - "smithy.api#documentation": "\n

End of support notice: On September 10, 2025, Amazon Web Services\n will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will\n no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. \n For more information on transitioning to Batch to help run containerized\n simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.\n

\n \n \n

This API is no longer supported. For more information, see the May 2, 2022 update in the Support policy page.

\n \n

\n Syncrhonizes robots in a fleet to the latest deployment. This is helpful if robots were added after a deployment.\n

", - "smithy.api#http": { - "method": "POST", - "uri": "/syncDeploymentJob", - "code": 200 - } - } - }, - "com.amazonaws.robomaker#SyncDeploymentJobRequest": { - "type": "structure", - "members": { - "clientRequestToken": { - "target": "com.amazonaws.robomaker#ClientRequestToken", - "traits": { - "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request.

", - "smithy.api#idempotencyToken": {}, - "smithy.api#required": {} - } - }, - "fleet": { - "target": "com.amazonaws.robomaker#Arn", - "traits": { - "smithy.api#documentation": "

The target fleet for the synchronization.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#deprecated": { - "message": "Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." - }, - "smithy.api#input": {} - } - }, - "com.amazonaws.robomaker#SyncDeploymentJobResponse": { - "type": "structure", - "members": { - "arn": { - "target": "com.amazonaws.robomaker#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the synchronization request.

" - } - }, - "fleet": { - "target": "com.amazonaws.robomaker#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the fleet.

" - } - }, - "status": { - "target": "com.amazonaws.robomaker#DeploymentStatus", - "traits": { - "smithy.api#documentation": "

The status of the synchronization job.

" - } - }, - "deploymentConfig": { - "target": "com.amazonaws.robomaker#DeploymentConfig", - "traits": { - "smithy.api#documentation": "

Information about the deployment configuration.

" - } - }, - "deploymentApplicationConfigs": { - "target": "com.amazonaws.robomaker#DeploymentApplicationConfigs", - "traits": { - "smithy.api#documentation": "

Information about the deployment application configurations.

" - } - }, - "failureReason": { - "target": "com.amazonaws.robomaker#GenericString", - "traits": { - "smithy.api#documentation": "

The failure reason if the job fails.

" - } - }, - "failureCode": { - "target": "com.amazonaws.robomaker#DeploymentJobErrorCode", - "traits": { - "smithy.api#documentation": "

The failure code if the job fails:

\n
\n
InternalServiceError
\n
\n

Internal service error.

\n
\n
RobotApplicationCrash
\n
\n

Robot application exited abnormally.

\n
\n
SimulationApplicationCrash
\n
\n

Simulation application exited abnormally.

\n
\n
BadPermissionsRobotApplication
\n
\n

Robot application bundle could not be downloaded.

\n
\n
BadPermissionsSimulationApplication
\n
\n

Simulation application bundle could not be downloaded.

\n
\n
BadPermissionsS3Output
\n
\n

Unable to publish outputs to customer-provided S3 bucket.

\n
\n
BadPermissionsCloudwatchLogs
\n
\n

Unable to publish logs to customer-provided CloudWatch Logs resource.

\n
\n
SubnetIpLimitExceeded
\n
\n

Subnet IP limit exceeded.

\n
\n
ENILimitExceeded
\n
\n

ENI limit exceeded.

\n
\n
BadPermissionsUserCredentials
\n
\n

Unable to use the Role provided.

\n
\n
InvalidBundleRobotApplication
\n
\n

Robot bundle cannot be extracted (invalid format, bundling error, or other\n issue).

\n
\n
InvalidBundleSimulationApplication
\n
\n

Simulation bundle cannot be extracted (invalid format, bundling error, or other\n issue).

\n
\n
RobotApplicationVersionMismatchedEtag
\n
\n

Etag for RobotApplication does not match value during version creation.

\n
\n
SimulationApplicationVersionMismatchedEtag
\n
\n

Etag for SimulationApplication does not match value during version\n creation.

\n
\n
" - } - }, - "createdAt": { - "target": "com.amazonaws.robomaker#CreatedAt", - "traits": { - "smithy.api#documentation": "

The time, in milliseconds since the epoch, when the fleet was created.

" - } - } - }, - "traits": { - "smithy.api#deprecated": { - "message": "Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." - }, - "smithy.api#output": {} - } - }, - "com.amazonaws.robomaker#TagKey": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - }, - "smithy.api#pattern": "^[a-zA-Z0-9 _.\\-\\/+=:]*$" - } - }, - "com.amazonaws.robomaker#TagKeyList": { - "type": "list", - "member": { - "target": "com.amazonaws.robomaker#TagKey" - } - }, - "com.amazonaws.robomaker#TagMap": { - "type": "map", - "key": { - "target": "com.amazonaws.robomaker#TagKey" - }, - "value": { - "target": "com.amazonaws.robomaker#TagValue" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 50 - } - } - }, - "com.amazonaws.robomaker#TagResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.robomaker#TagResourceRequest" - }, - "output": { - "target": "com.amazonaws.robomaker#TagResourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.robomaker#InternalServerException" - }, - { - "target": "com.amazonaws.robomaker#InvalidParameterException" - }, - { - "target": "com.amazonaws.robomaker#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.robomaker#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "\n

End of support notice: On September 10, 2025, Amazon Web Services\n will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will\n no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. \n For more information on transitioning to Batch to help run containerized\n simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.\n

\n \n

Adds or edits tags for a AWS RoboMaker resource.

\n

Each tag consists of a tag key and a tag value. Tag keys and tag values are both\n required, but tag values can be empty strings.

\n

For information about the rules that apply to tag keys and tag values, see User-Defined Tag Restrictions in the AWS Billing and Cost Management\n User Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/tags/{resourceArn}", - "code": 200 - } - } - }, - "com.amazonaws.robomaker#TagResourceRequest": { - "type": "structure", - "members": { - "resourceArn": { - "target": "com.amazonaws.robomaker#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS RoboMaker resource you are tagging.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "tags": { - "target": "com.amazonaws.robomaker#TagMap", - "traits": { - "smithy.api#documentation": "

A map that contains tag keys and tag values that are attached to the resource.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.robomaker#TagResourceResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.robomaker#TagValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - }, - "smithy.api#pattern": "^[a-zA-Z0-9 _.\\-\\/+=:]*$" - } - }, - "com.amazonaws.robomaker#TemplateLocation": { - "type": "structure", - "members": { - "s3Bucket": { - "target": "com.amazonaws.robomaker#S3Bucket", - "traits": { - "smithy.api#documentation": "

The Amazon S3 bucket name.

", - "smithy.api#required": {} - } - }, - "s3Key": { - "target": "com.amazonaws.robomaker#S3Key", - "traits": { - "smithy.api#documentation": "

The list of S3 keys identifying the data source files.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about a template location.

" - } - }, - "com.amazonaws.robomaker#TemplateName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 255 - }, - "smithy.api#pattern": ".*" - } - }, - "com.amazonaws.robomaker#TemplateSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.robomaker#TemplateSummary" - } - }, - "com.amazonaws.robomaker#TemplateSummary": { - "type": "structure", - "members": { - "arn": { - "target": "com.amazonaws.robomaker#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the template.

" - } - }, - "createdAt": { - "target": "com.amazonaws.robomaker#CreatedAt", - "traits": { - "smithy.api#documentation": "

The time, in milliseconds since the epoch, when the template was created.

" - } - }, - "lastUpdatedAt": { - "target": "com.amazonaws.robomaker#LastUpdatedAt", - "traits": { - "smithy.api#documentation": "

The time, in milliseconds since the epoch, when the template was last updated.

" - } - }, - "name": { - "target": "com.amazonaws.robomaker#TemplateName", - "traits": { - "smithy.api#documentation": "

The name of the template.

" - } - }, - "version": { - "target": "com.amazonaws.robomaker#GenericString", - "traits": { - "smithy.api#documentation": "

The version of the template that you're using.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Summary information for a template.

" - } - }, - "com.amazonaws.robomaker#ThrottlingException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.robomaker#errorMessage" - } - }, - "traits": { - "smithy.api#documentation": "

AWS RoboMaker is temporarily unable to process the request. Try your call again.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.robomaker#Tool": { - "type": "structure", - "members": { - "streamUI": { - "target": "com.amazonaws.robomaker#BoxedBoolean", - "traits": { - "smithy.api#documentation": "

Boolean indicating whether a streaming session will be configured for the tool. If\n True, AWS RoboMaker will configure a connection so you can interact with\n the tool as it is running in the simulation. It must have a graphical user interface. The\n default is False.

" - } - }, - "name": { - "target": "com.amazonaws.robomaker#Name", - "traits": { - "smithy.api#documentation": "

The name of the tool.

", - "smithy.api#required": {} - } - }, - "command": { - "target": "com.amazonaws.robomaker#UnrestrictedCommand", - "traits": { - "smithy.api#documentation": "

Command-line arguments for the tool. It must include the tool executable name.

", - "smithy.api#required": {} - } - }, - "streamOutputToCloudWatch": { - "target": "com.amazonaws.robomaker#BoxedBoolean", - "traits": { - "smithy.api#documentation": "

Boolean indicating whether logs will be recorded in CloudWatch for the tool. The default\n is False.

" - } - }, - "exitBehavior": { - "target": "com.amazonaws.robomaker#ExitBehavior", - "traits": { - "smithy.api#documentation": "

Exit behavior determines what happens when your tool quits running. RESTART\n will cause your tool to be restarted. FAIL will cause your job to exit. The\n default is RESTART.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about a tool. Tools are used in a simulation job.

" - } - }, - "com.amazonaws.robomaker#Tools": { - "type": "list", - "member": { - "target": "com.amazonaws.robomaker#Tool" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 10 - } - } - }, - "com.amazonaws.robomaker#UnrestrictedCommand": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1024 - }, - "smithy.api#pattern": ".*" - } - }, - "com.amazonaws.robomaker#UntagResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.robomaker#UntagResourceRequest" - }, - "output": { - "target": "com.amazonaws.robomaker#UntagResourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.robomaker#InternalServerException" - }, - { - "target": "com.amazonaws.robomaker#InvalidParameterException" - }, - { - "target": "com.amazonaws.robomaker#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.robomaker#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "\n

End of support notice: On September 10, 2025, Amazon Web Services\n will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will\n no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. \n For more information on transitioning to Batch to help run containerized\n simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.\n

\n \n

Removes the specified tags from the specified AWS RoboMaker resource.

\n

To remove a tag, specify the tag key. To change the tag value of an existing tag key,\n use \n TagResource\n .

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/tags/{resourceArn}", - "code": 200 - } - } - }, - "com.amazonaws.robomaker#UntagResourceRequest": { - "type": "structure", - "members": { - "resourceArn": { - "target": "com.amazonaws.robomaker#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS RoboMaker resource you are removing\n tags.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "tagKeys": { - "target": "com.amazonaws.robomaker#TagKeyList", - "traits": { - "smithy.api#documentation": "

A map that contains tag keys and tag values that will be unattached from the\n resource.

", - "smithy.api#httpQuery": "tagKeys", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.robomaker#UntagResourceResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.robomaker#UpdateRobotApplication": { - "type": "operation", - "input": { - "target": "com.amazonaws.robomaker#UpdateRobotApplicationRequest" - }, - "output": { - "target": "com.amazonaws.robomaker#UpdateRobotApplicationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.robomaker#InternalServerException" - }, - { - "target": "com.amazonaws.robomaker#InvalidParameterException" - }, - { - "target": "com.amazonaws.robomaker#LimitExceededException" - }, - { - "target": "com.amazonaws.robomaker#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.robomaker#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "\n

End of support notice: On September 10, 2025, Amazon Web Services\n will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will\n no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. \n For more information on transitioning to Batch to help run containerized\n simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.\n

\n \n

Updates a robot application.

", - "smithy.api#http": { - "method": "POST", - "uri": "/updateRobotApplication", - "code": 200 - } - } - }, - "com.amazonaws.robomaker#UpdateRobotApplicationRequest": { - "type": "structure", - "members": { - "application": { - "target": "com.amazonaws.robomaker#Arn", - "traits": { - "smithy.api#documentation": "

The application information for the robot application.

", - "smithy.api#required": {} - } - }, - "sources": { - "target": "com.amazonaws.robomaker#SourceConfigs", - "traits": { - "smithy.api#documentation": "

The sources of the robot application.

" - } - }, - "robotSoftwareSuite": { - "target": "com.amazonaws.robomaker#RobotSoftwareSuite", - "traits": { - "smithy.api#documentation": "

The robot software suite used by the robot application.

", - "smithy.api#required": {} - } - }, - "currentRevisionId": { - "target": "com.amazonaws.robomaker#RevisionId", - "traits": { - "smithy.api#documentation": "

The revision id for the robot application.

" - } - }, - "environment": { - "target": "com.amazonaws.robomaker#Environment", - "traits": { - "smithy.api#documentation": "

The object that contains the Docker image URI for your robot application.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.robomaker#UpdateRobotApplicationResponse": { - "type": "structure", - "members": { - "arn": { - "target": "com.amazonaws.robomaker#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the updated robot application.

" - } - }, - "name": { - "target": "com.amazonaws.robomaker#Name", - "traits": { - "smithy.api#documentation": "

The name of the robot application.

" - } - }, - "version": { - "target": "com.amazonaws.robomaker#Version", - "traits": { - "smithy.api#documentation": "

The version of the robot application.

" - } - }, - "sources": { - "target": "com.amazonaws.robomaker#Sources", - "traits": { - "smithy.api#documentation": "

The sources of the robot application.

" - } - }, - "robotSoftwareSuite": { - "target": "com.amazonaws.robomaker#RobotSoftwareSuite", - "traits": { - "smithy.api#documentation": "

The robot software suite used by the robot application.

" - } - }, - "lastUpdatedAt": { - "target": "com.amazonaws.robomaker#LastUpdatedAt", - "traits": { - "smithy.api#documentation": "

The time, in milliseconds since the epoch, when the robot application was last\n updated.

" - } - }, - "revisionId": { - "target": "com.amazonaws.robomaker#RevisionId", - "traits": { - "smithy.api#documentation": "

The revision id of the robot application.

" - } - }, - "environment": { - "target": "com.amazonaws.robomaker#Environment", - "traits": { - "smithy.api#documentation": "

The object that contains the Docker image URI for your robot application.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.robomaker#UpdateSimulationApplication": { - "type": "operation", - "input": { - "target": "com.amazonaws.robomaker#UpdateSimulationApplicationRequest" - }, - "output": { - "target": "com.amazonaws.robomaker#UpdateSimulationApplicationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.robomaker#InternalServerException" - }, - { - "target": "com.amazonaws.robomaker#InvalidParameterException" - }, - { - "target": "com.amazonaws.robomaker#LimitExceededException" - }, - { - "target": "com.amazonaws.robomaker#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.robomaker#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "\n

End of support notice: On September 10, 2025, Amazon Web Services\n will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will\n no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. \n For more information on transitioning to Batch to help run containerized\n simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.\n

\n \n

Updates a simulation application.

", - "smithy.api#http": { - "method": "POST", - "uri": "/updateSimulationApplication", - "code": 200 - } - } - }, - "com.amazonaws.robomaker#UpdateSimulationApplicationRequest": { - "type": "structure", - "members": { - "application": { - "target": "com.amazonaws.robomaker#Arn", - "traits": { - "smithy.api#documentation": "

The application information for the simulation application.

", - "smithy.api#required": {} - } - }, - "sources": { - "target": "com.amazonaws.robomaker#SourceConfigs", - "traits": { - "smithy.api#documentation": "

The sources of the simulation application.

" - } - }, - "simulationSoftwareSuite": { - "target": "com.amazonaws.robomaker#SimulationSoftwareSuite", - "traits": { - "smithy.api#documentation": "

The simulation software suite used by the simulation application.

", - "smithy.api#required": {} - } - }, - "robotSoftwareSuite": { - "target": "com.amazonaws.robomaker#RobotSoftwareSuite", - "traits": { - "smithy.api#documentation": "

Information about the robot software suite.

", - "smithy.api#required": {} - } - }, - "renderingEngine": { - "target": "com.amazonaws.robomaker#RenderingEngine", - "traits": { - "smithy.api#documentation": "

The rendering engine for the simulation application.

" - } - }, - "currentRevisionId": { - "target": "com.amazonaws.robomaker#RevisionId", - "traits": { - "smithy.api#documentation": "

The revision id for the robot application.

" - } - }, - "environment": { - "target": "com.amazonaws.robomaker#Environment", - "traits": { - "smithy.api#documentation": "

The object that contains the Docker image URI for your simulation application.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.robomaker#UpdateSimulationApplicationResponse": { - "type": "structure", - "members": { - "arn": { - "target": "com.amazonaws.robomaker#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the updated simulation application.

" - } - }, - "name": { - "target": "com.amazonaws.robomaker#Name", - "traits": { - "smithy.api#documentation": "

The name of the simulation application.

" - } - }, - "version": { - "target": "com.amazonaws.robomaker#Version", - "traits": { - "smithy.api#documentation": "

The version of the robot application.

" - } - }, - "sources": { - "target": "com.amazonaws.robomaker#Sources", - "traits": { - "smithy.api#documentation": "

The sources of the simulation application.

" - } - }, - "simulationSoftwareSuite": { - "target": "com.amazonaws.robomaker#SimulationSoftwareSuite", - "traits": { - "smithy.api#documentation": "

The simulation software suite used by the simulation application.

" - } - }, - "robotSoftwareSuite": { - "target": "com.amazonaws.robomaker#RobotSoftwareSuite", - "traits": { - "smithy.api#documentation": "

Information about the robot software suite.

" - } - }, - "renderingEngine": { - "target": "com.amazonaws.robomaker#RenderingEngine", - "traits": { - "smithy.api#documentation": "

The rendering engine for the simulation application.

" - } - }, - "lastUpdatedAt": { - "target": "com.amazonaws.robomaker#LastUpdatedAt", - "traits": { - "smithy.api#documentation": "

The time, in milliseconds since the epoch, when the simulation application was last\n updated.

" - } - }, - "revisionId": { - "target": "com.amazonaws.robomaker#RevisionId", - "traits": { - "smithy.api#documentation": "

The revision id of the simulation application.

" - } - }, - "environment": { - "target": "com.amazonaws.robomaker#Environment", - "traits": { - "smithy.api#documentation": "

The object that contains the Docker image URI used for your simulation\n application.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.robomaker#UpdateWorldTemplate": { - "type": "operation", - "input": { - "target": "com.amazonaws.robomaker#UpdateWorldTemplateRequest" - }, - "output": { - "target": "com.amazonaws.robomaker#UpdateWorldTemplateResponse" - }, - "errors": [ - { - "target": "com.amazonaws.robomaker#InternalServerException" - }, - { - "target": "com.amazonaws.robomaker#InvalidParameterException" - }, - { - "target": "com.amazonaws.robomaker#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.robomaker#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "\n

End of support notice: On September 10, 2025, Amazon Web Services\n will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will\n no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. \n For more information on transitioning to Batch to help run containerized\n simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.\n

\n \n

Updates a world template.

", - "smithy.api#http": { - "method": "POST", - "uri": "/updateWorldTemplate", - "code": 200 - } - } - }, - "com.amazonaws.robomaker#UpdateWorldTemplateRequest": { - "type": "structure", - "members": { - "template": { - "target": "com.amazonaws.robomaker#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (arn) of the world template to update.

", - "smithy.api#required": {} - } - }, - "name": { - "target": "com.amazonaws.robomaker#TemplateName", - "traits": { - "smithy.api#documentation": "

The name of the template.

" - } - }, - "templateBody": { - "target": "com.amazonaws.robomaker#Json", - "traits": { - "smithy.api#documentation": "

The world template body.

" - } - }, - "templateLocation": { - "target": "com.amazonaws.robomaker#TemplateLocation", - "traits": { - "smithy.api#documentation": "

The location of the world template.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.robomaker#UpdateWorldTemplateResponse": { - "type": "structure", - "members": { - "arn": { - "target": "com.amazonaws.robomaker#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (arn) of the world template.

" - } - }, - "name": { - "target": "com.amazonaws.robomaker#TemplateName", - "traits": { - "smithy.api#documentation": "

The name of the world template.

" - } - }, - "createdAt": { - "target": "com.amazonaws.robomaker#CreatedAt", - "traits": { - "smithy.api#documentation": "

The time, in milliseconds since the epoch, when the world template was created.

" - } - }, - "lastUpdatedAt": { - "target": "com.amazonaws.robomaker#LastUpdatedAt", - "traits": { - "smithy.api#documentation": "

The time, in milliseconds since the epoch, when the world template was last\n updated.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.robomaker#UploadBehavior": { - "type": "enum", - "members": { - "UPLOAD_ON_TERMINATE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UPLOAD_ON_TERMINATE" - } - }, - "UPLOAD_ROLLING_AUTO_REMOVE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UPLOAD_ROLLING_AUTO_REMOVE" - } - } - } - }, - "com.amazonaws.robomaker#UploadConfiguration": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.robomaker#Name", - "traits": { - "smithy.api#documentation": "

A prefix that specifies where files will be uploaded in Amazon S3. It is appended to the\n simulation output location to determine the final path.

\n

For example, if your simulation output location is s3://amzn-s3-demo-bucket and your\n upload configuration name is robot-test, your files will be uploaded to\n s3://amzn-s3-demo-bucket///robot-test.

", - "smithy.api#required": {} - } - }, - "path": { - "target": "com.amazonaws.robomaker#Path", - "traits": { - "smithy.api#documentation": "

Specifies the path of the file(s) to upload. Standard Unix glob matching rules are\n accepted, with the addition of ** as a super asterisk.\n For example, specifying /var/log/**.log causes all .log files in the\n /var/log directory tree to be collected. For more examples, see Glob Library.

", - "smithy.api#required": {} - } - }, - "uploadBehavior": { - "target": "com.amazonaws.robomaker#UploadBehavior", - "traits": { - "smithy.api#documentation": "

Specifies when to upload the files:

\n
\n
UPLOAD_ON_TERMINATE
\n
\n

Matching files are uploaded once the simulation enters the\n TERMINATING state. Matching files are not uploaded until all of\n your code (including tools) have stopped.

\n

If there is a problem uploading a file, the upload is retried. If problems\n persist, no further upload attempts will be made.

\n
\n
UPLOAD_ROLLING_AUTO_REMOVE
\n
\n

Matching files are uploaded as they are created. They are deleted after they\n are uploaded. The specified path is checked every 5 seconds. A final check is made\n when all of your code (including tools) have stopped.

\n
\n
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Provides upload configuration information. Files are uploaded from the simulation job to\n a location you specify.

" - } - }, - "com.amazonaws.robomaker#UploadConfigurations": { - "type": "list", - "member": { - "target": "com.amazonaws.robomaker#UploadConfiguration" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 10 - } - } - }, - "com.amazonaws.robomaker#VPCConfig": { - "type": "structure", - "members": { - "subnets": { - "target": "com.amazonaws.robomaker#Subnets", - "traits": { - "smithy.api#documentation": "

A list of one or more subnet IDs in your VPC.

", - "smithy.api#required": {} - } - }, - "securityGroups": { - "target": "com.amazonaws.robomaker#SecurityGroups", - "traits": { - "smithy.api#documentation": "

A list of one or more security groups IDs in your VPC.

" - } - }, - "assignPublicIp": { - "target": "com.amazonaws.robomaker#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A boolean indicating whether to assign a public IP address.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

If your simulation job accesses resources in a VPC, you provide this parameter\n identifying the list of security group IDs and subnet IDs. These must belong to the same\n VPC. You must provide at least one security group and two subnet IDs.

" - } - }, - "com.amazonaws.robomaker#VPCConfigResponse": { - "type": "structure", - "members": { - "subnets": { - "target": "com.amazonaws.robomaker#Subnets", - "traits": { - "smithy.api#documentation": "

A list of subnet IDs associated with the simulation job.

" - } - }, - "securityGroups": { - "target": "com.amazonaws.robomaker#SecurityGroups", - "traits": { - "smithy.api#documentation": "

A list of security group IDs associated with the simulation job.

" - } - }, - "vpcId": { - "target": "com.amazonaws.robomaker#GenericString", - "traits": { - "smithy.api#documentation": "

The VPC ID associated with your simulation job.

" - } - }, - "assignPublicIp": { - "target": "com.amazonaws.robomaker#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A boolean indicating if a public IP was assigned.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

VPC configuration associated with your simulation job.

" - } - }, - "com.amazonaws.robomaker#Version": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 255 - }, - "smithy.api#pattern": "^(\\$LATEST)|[0-9]*$" - } - }, - "com.amazonaws.robomaker#VersionQualifier": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 255 - }, - "smithy.api#pattern": "^ALL$" - } - }, - "com.amazonaws.robomaker#WorldConfig": { - "type": "structure", - "members": { - "world": { - "target": "com.amazonaws.robomaker#Arn", - "traits": { - "smithy.api#documentation": "

The world generated by Simulation WorldForge.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Configuration information for a world.

" - } - }, - "com.amazonaws.robomaker#WorldConfigs": { - "type": "list", - "member": { - "target": "com.amazonaws.robomaker#WorldConfig" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1 - } - } - }, - "com.amazonaws.robomaker#WorldCount": { - "type": "structure", - "members": { - "floorplanCount": { - "target": "com.amazonaws.robomaker#FloorplanCount", - "traits": { - "smithy.api#documentation": "

The number of unique floorplans.

" - } - }, - "interiorCountPerFloorplan": { - "target": "com.amazonaws.robomaker#InteriorCountPerFloorplan", - "traits": { - "smithy.api#documentation": "

The number of unique interiors per floorplan.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The number of worlds that will be created. You can configure the number of unique\n floorplans and the number of unique interiors for each floor plan. For example, if you want\n 1 world with 20 unique interiors, you set floorplanCount = 1 and\n interiorCountPerFloorplan = 20. This will result in 20 worlds\n (floorplanCount * interiorCountPerFloorplan).

\n

If you set floorplanCount = 4 and interiorCountPerFloorplan =\n 5, there will be 20 worlds with 5 unique floor plans.

" - } - }, - "com.amazonaws.robomaker#WorldExportJobErrorCode": { - "type": "enum", - "members": { - "InternalServiceError": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "InternalServiceError" - } - }, - "LimitExceeded": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LimitExceeded" - } - }, - "ResourceNotFound": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ResourceNotFound" - } - }, - "RequestThrottled": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RequestThrottled" - } - }, - "InvalidInput": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "InvalidInput" - } - }, - "AccessDenied": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AccessDenied" - } - } - } - }, - "com.amazonaws.robomaker#WorldExportJobStatus": { - "type": "enum", - "members": { - "Pending": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Pending" - } - }, - "Running": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Running" - } - }, - "Completed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Completed" - } - }, - "Failed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Failed" - } - }, - "Canceling": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Canceling" - } - }, - "Canceled": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Canceled" - } - } - } - }, - "com.amazonaws.robomaker#WorldExportJobSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.robomaker#WorldExportJobSummary" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.robomaker#WorldExportJobSummary": { - "type": "structure", - "members": { - "arn": { - "target": "com.amazonaws.robomaker#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the world export job.

" - } - }, - "status": { - "target": "com.amazonaws.robomaker#WorldExportJobStatus", - "traits": { - "smithy.api#documentation": "

The status of the world export job.

\n
\n
Pending
\n
\n

The world export job request is pending.

\n
\n
Running
\n
\n

The world export job is running.

\n
\n
Completed
\n
\n

The world export job completed.

\n
\n
Failed
\n
\n

The world export job failed. See failureCode for more information.\n

\n
\n
Canceled
\n
\n

The world export job was cancelled.

\n
\n
Canceling
\n
\n

The world export job is being cancelled.

\n
\n
" - } - }, - "createdAt": { - "target": "com.amazonaws.robomaker#CreatedAt", - "traits": { - "smithy.api#documentation": "

The time, in milliseconds since the epoch, when the world export job was created.

" - } - }, - "worlds": { - "target": "com.amazonaws.robomaker#Arns", - "traits": { - "smithy.api#documentation": "

A list of worlds.

" - } - }, - "outputLocation": { - "target": "com.amazonaws.robomaker#OutputLocation" - } - }, - "traits": { - "smithy.api#documentation": "

Information about a world export job.

" - } - }, - "com.amazonaws.robomaker#WorldFailure": { - "type": "structure", - "members": { - "failureCode": { - "target": "com.amazonaws.robomaker#WorldGenerationJobErrorCode", - "traits": { - "smithy.api#documentation": "

The failure code of the world export job if it failed:

\n
\n
InternalServiceError
\n
\n

Internal service error.

\n
\n
LimitExceeded
\n
\n

The requested resource exceeds the maximum number allowed, or the number of\n concurrent stream requests exceeds the maximum number allowed.

\n
\n
ResourceNotFound
\n
\n

The specified resource could not be found.

\n
\n
RequestThrottled
\n
\n

The request was throttled.

\n
\n
InvalidInput
\n
\n

An input parameter in the request is not valid.

\n
\n
" - } - }, - "sampleFailureReason": { - "target": "com.amazonaws.robomaker#GenericString", - "traits": { - "smithy.api#documentation": "

The sample reason why the world failed. World errors are aggregated. A sample is used as\n the sampleFailureReason.

" - } - }, - "failureCount": { - "target": "com.amazonaws.robomaker#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of failed worlds.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about a failed world.

" - } - }, - "com.amazonaws.robomaker#WorldFailures": { - "type": "list", - "member": { - "target": "com.amazonaws.robomaker#WorldFailure" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.robomaker#WorldGenerationJobErrorCode": { - "type": "enum", - "members": { - "InternalServiceError": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "InternalServiceError" - } - }, - "LimitExceeded": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LimitExceeded" - } - }, - "ResourceNotFound": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ResourceNotFound" - } - }, - "RequestThrottled": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RequestThrottled" - } - }, - "InvalidInput": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "InvalidInput" - } - }, - "AllWorldGenerationFailed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AllWorldGenerationFailed" - } - } - } - }, - "com.amazonaws.robomaker#WorldGenerationJobStatus": { - "type": "enum", - "members": { - "Pending": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Pending" - } - }, - "Running": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Running" - } - }, - "Completed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Completed" - } - }, - "Failed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Failed" - } - }, - "PartialFailed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PartialFailed" - } - }, - "Canceling": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Canceling" - } - }, - "Canceled": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Canceled" - } - } - } - }, - "com.amazonaws.robomaker#WorldGenerationJobSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.robomaker#WorldGenerationJobSummary" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.robomaker#WorldGenerationJobSummary": { - "type": "structure", - "members": { - "arn": { - "target": "com.amazonaws.robomaker#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the world generator job.

" - } - }, - "template": { - "target": "com.amazonaws.robomaker#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (arn) of the world template.

" - } - }, - "createdAt": { - "target": "com.amazonaws.robomaker#CreatedAt", - "traits": { - "smithy.api#documentation": "

The time, in milliseconds since the epoch, when the world generator job was\n created.

" - } - }, - "status": { - "target": "com.amazonaws.robomaker#WorldGenerationJobStatus", - "traits": { - "smithy.api#documentation": "

The status of the world generator job:

\n
\n
Pending
\n
\n

The world generator job request is pending.

\n
\n
Running
\n
\n

The world generator job is running.

\n
\n
Completed
\n
\n

The world generator job completed.

\n
\n
Failed
\n
\n

The world generator job failed. See failureCode for more\n information.

\n
\n
PartialFailed
\n
\n

Some worlds did not generate.

\n
\n
Canceled
\n
\n

The world generator job was cancelled.

\n
\n
Canceling
\n
\n

The world generator job is being cancelled.

\n
\n
" - } - }, - "worldCount": { - "target": "com.amazonaws.robomaker#WorldCount", - "traits": { - "smithy.api#documentation": "

Information about the world count.

" - } - }, - "succeededWorldCount": { - "target": "com.amazonaws.robomaker#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of worlds that were generated.

" - } - }, - "failedWorldCount": { - "target": "com.amazonaws.robomaker#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of worlds that failed.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about a world generator job.

" - } - }, - "com.amazonaws.robomaker#WorldSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.robomaker#WorldSummary" - } - }, - "com.amazonaws.robomaker#WorldSummary": { - "type": "structure", - "members": { - "arn": { - "target": "com.amazonaws.robomaker#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the world.

" - } - }, - "createdAt": { - "target": "com.amazonaws.robomaker#CreatedAt", - "traits": { - "smithy.api#documentation": "

The time, in milliseconds since the epoch, when the world was created.

" - } - }, - "generationJob": { - "target": "com.amazonaws.robomaker#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (arn) of the world generation job.

" - } - }, - "template": { - "target": "com.amazonaws.robomaker#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (arn) of the world template.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about a world.

" - } - }, - "com.amazonaws.robomaker#errorMessage": { - "type": "string" - }, - "com.amazonaws.robomaker#robomaker": { - "type": "service", - "version": "2018-06-29", - "operations": [ - { - "target": "com.amazonaws.robomaker#BatchDeleteWorlds" - }, - { - "target": "com.amazonaws.robomaker#BatchDescribeSimulationJob" - }, - { - "target": "com.amazonaws.robomaker#CancelDeploymentJob" - }, - { - "target": "com.amazonaws.robomaker#CancelSimulationJob" - }, - { - "target": "com.amazonaws.robomaker#CancelSimulationJobBatch" - }, - { - "target": "com.amazonaws.robomaker#CancelWorldExportJob" - }, - { - "target": "com.amazonaws.robomaker#CancelWorldGenerationJob" - }, - { - "target": "com.amazonaws.robomaker#CreateDeploymentJob" - }, - { - "target": "com.amazonaws.robomaker#CreateFleet" - }, - { - "target": "com.amazonaws.robomaker#CreateRobot" - }, - { - "target": "com.amazonaws.robomaker#CreateRobotApplication" - }, - { - "target": "com.amazonaws.robomaker#CreateRobotApplicationVersion" - }, - { - "target": "com.amazonaws.robomaker#CreateSimulationApplication" - }, - { - "target": "com.amazonaws.robomaker#CreateSimulationApplicationVersion" - }, - { - "target": "com.amazonaws.robomaker#CreateSimulationJob" - }, - { - "target": "com.amazonaws.robomaker#CreateWorldExportJob" - }, - { - "target": "com.amazonaws.robomaker#CreateWorldGenerationJob" - }, - { - "target": "com.amazonaws.robomaker#CreateWorldTemplate" - }, - { - "target": "com.amazonaws.robomaker#DeleteFleet" - }, - { - "target": "com.amazonaws.robomaker#DeleteRobot" - }, - { - "target": "com.amazonaws.robomaker#DeleteRobotApplication" - }, - { - "target": "com.amazonaws.robomaker#DeleteSimulationApplication" - }, - { - "target": "com.amazonaws.robomaker#DeleteWorldTemplate" - }, - { - "target": "com.amazonaws.robomaker#DeregisterRobot" - }, - { - "target": "com.amazonaws.robomaker#DescribeDeploymentJob" - }, - { - "target": "com.amazonaws.robomaker#DescribeFleet" - }, - { - "target": "com.amazonaws.robomaker#DescribeRobot" - }, - { - "target": "com.amazonaws.robomaker#DescribeRobotApplication" - }, - { - "target": "com.amazonaws.robomaker#DescribeSimulationApplication" - }, - { - "target": "com.amazonaws.robomaker#DescribeSimulationJob" - }, - { - "target": "com.amazonaws.robomaker#DescribeSimulationJobBatch" - }, - { - "target": "com.amazonaws.robomaker#DescribeWorld" - }, - { - "target": "com.amazonaws.robomaker#DescribeWorldExportJob" - }, - { - "target": "com.amazonaws.robomaker#DescribeWorldGenerationJob" - }, - { - "target": "com.amazonaws.robomaker#DescribeWorldTemplate" - }, - { - "target": "com.amazonaws.robomaker#GetWorldTemplateBody" - }, - { - "target": "com.amazonaws.robomaker#ListDeploymentJobs" - }, - { - "target": "com.amazonaws.robomaker#ListFleets" - }, - { - "target": "com.amazonaws.robomaker#ListRobotApplications" - }, - { - "target": "com.amazonaws.robomaker#ListRobots" - }, - { - "target": "com.amazonaws.robomaker#ListSimulationApplications" - }, - { - "target": "com.amazonaws.robomaker#ListSimulationJobBatches" - }, - { - "target": "com.amazonaws.robomaker#ListSimulationJobs" - }, - { - "target": "com.amazonaws.robomaker#ListTagsForResource" - }, - { - "target": "com.amazonaws.robomaker#ListWorldExportJobs" - }, - { - "target": "com.amazonaws.robomaker#ListWorldGenerationJobs" - }, - { - "target": "com.amazonaws.robomaker#ListWorlds" - }, - { - "target": "com.amazonaws.robomaker#ListWorldTemplates" - }, - { - "target": "com.amazonaws.robomaker#RegisterRobot" - }, - { - "target": "com.amazonaws.robomaker#RestartSimulationJob" - }, - { - "target": "com.amazonaws.robomaker#StartSimulationJobBatch" - }, - { - "target": "com.amazonaws.robomaker#SyncDeploymentJob" - }, - { - "target": "com.amazonaws.robomaker#TagResource" - }, - { - "target": "com.amazonaws.robomaker#UntagResource" - }, - { - "target": "com.amazonaws.robomaker#UpdateRobotApplication" - }, - { - "target": "com.amazonaws.robomaker#UpdateSimulationApplication" - }, - { - "target": "com.amazonaws.robomaker#UpdateWorldTemplate" - } - ], - "traits": { - "aws.api#service": { - "sdkId": "RoboMaker", - "arnNamespace": "robomaker", - "cloudFormationName": "RoboMaker", - "cloudTrailEventSource": "robomaker.amazonaws.com", - "endpointPrefix": "robomaker" - }, - "aws.auth#sigv4": { - "name": "robomaker" - }, - "aws.protocols#restJson1": {}, - "smithy.api#documentation": "

This section provides documentation for the AWS RoboMaker API operations.

", - "smithy.api#title": "AWS RoboMaker", - "smithy.rules#endpointRuleSet": { - "version": "1.0", - "parameters": { - "Region": { - "builtIn": "AWS::Region", - "required": false, - "documentation": "The AWS region used to dispatch the request.", - "type": "string" - }, - "UseDualStack": { - "builtIn": "AWS::UseDualStack", - "required": true, - "default": false, - "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", - "type": "boolean" - }, - "UseFIPS": { - "builtIn": "AWS::UseFIPS", - "required": true, - "default": false, - "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", - "type": "boolean" - }, - "Endpoint": { - "builtIn": "SDK::Endpoint", - "required": false, - "documentation": "Override the endpoint used to send this request", - "type": "string" - } - }, - "rules": [ - { - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Endpoint" - } - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "error": "Invalid Configuration: FIPS and custom endpoint are not supported", - "type": "error" - }, - { - "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" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Region" - } - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "aws.partition", - "argv": [ - { - "ref": "Region" - } - ], - "assign": "PartitionResult" - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - }, - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://robomaker-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - }, - true - ] - } - ], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://robomaker-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://robomaker.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [], - "endpoint": { - "url": "https://robomaker.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" - } - ] - }, - "smithy.rules#endpointTests": { - "testCases": [ - { - "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://robomaker.ap-northeast-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-northeast-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://robomaker.ap-southeast-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-southeast-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://robomaker.eu-central-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-central-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://robomaker.eu-west-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-west-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://robomaker.us-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://robomaker.us-east-2.amazonaws.com" - } - }, - "params": { - "Region": "us-east-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://robomaker.us-west-2.amazonaws.com" - } - }, - "params": { - "Region": "us-west-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://robomaker-fips.us-east-1.api.aws" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://robomaker-fips.us-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://robomaker.us-east-1.api.aws" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://robomaker-fips.cn-north-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://robomaker-fips.cn-north-1.amazonaws.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://robomaker.cn-north-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://robomaker.cn-north-1.amazonaws.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://robomaker.us-gov-west-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-west-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://robomaker-fips.us-gov-east-1.api.aws" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://robomaker-fips.us-gov-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://robomaker.us-gov-east-1.api.aws" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://robomaker.us-gov-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://robomaker-fips.us-iso-east-1.c2s.ic.gov" - } - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://robomaker.us-iso-east-1.c2s.ic.gov" - } - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://robomaker-fips.us-isob-east-1.sc2s.sgov.gov" - } - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://robomaker.us-isob-east-1.sc2s.sgov.gov" - } - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", - "expect": { - "endpoint": { - "url": "https://example.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": false, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", - "expect": { - "endpoint": { - "url": "https://example.com" - } - }, - "params": { - "UseFIPS": false, - "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": { - "Region": "us-east-1", - "UseFIPS": true, - "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": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": true, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "Missing region", - "expect": { - "error": "Invalid Configuration: Missing Region" - } - } - ], - "version": "1.0" - } - } - } - } -} \ No newline at end of file