From 656c191e2c6107620acc9cd970a04acdb45d0461 Mon Sep 17 00:00:00 2001 From: awstools Date: Tue, 24 Jan 2023 19:05:43 +0000 Subject: [PATCH] chore(models): update API models --- codegen/sdk-codegen/aws-models/databrew.json | 16163 ++++++------ codegen/sdk-codegen/aws-models/route-53.json | 23217 +++++++++-------- codegen/sdk-codegen/aws-models/ssm-sap.json | 5260 ++-- 3 files changed, 22151 insertions(+), 22489 deletions(-) diff --git a/codegen/sdk-codegen/aws-models/databrew.json b/codegen/sdk-codegen/aws-models/databrew.json index 50755cae237a..fbbf4efb43c9 100644 --- a/codegen/sdk-codegen/aws-models/databrew.json +++ b/codegen/sdk-codegen/aws-models/databrew.json @@ -1,8449 +1,7914 @@ { - "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.databrew#AWSGlueDataBrew": { - "type": "service", - "version": "2017-07-25", - "operations": [ - { - "target": "com.amazonaws.databrew#BatchDeleteRecipeVersion" - }, - { - "target": "com.amazonaws.databrew#CreateDataset" - }, - { - "target": "com.amazonaws.databrew#CreateProfileJob" - }, - { - "target": "com.amazonaws.databrew#CreateProject" - }, - { - "target": "com.amazonaws.databrew#CreateRecipe" - }, - { - "target": "com.amazonaws.databrew#CreateRecipeJob" - }, - { - "target": "com.amazonaws.databrew#CreateRuleset" - }, - { - "target": "com.amazonaws.databrew#CreateSchedule" - }, - { - "target": "com.amazonaws.databrew#DeleteDataset" - }, - { - "target": "com.amazonaws.databrew#DeleteJob" - }, - { - "target": "com.amazonaws.databrew#DeleteProject" - }, - { - "target": "com.amazonaws.databrew#DeleteRecipeVersion" - }, - { - "target": "com.amazonaws.databrew#DeleteRuleset" - }, - { - "target": "com.amazonaws.databrew#DeleteSchedule" - }, - { - "target": "com.amazonaws.databrew#DescribeDataset" - }, - { - "target": "com.amazonaws.databrew#DescribeJob" - }, - { - "target": "com.amazonaws.databrew#DescribeJobRun" - }, - { - "target": "com.amazonaws.databrew#DescribeProject" - }, - { - "target": "com.amazonaws.databrew#DescribeRecipe" - }, - { - "target": "com.amazonaws.databrew#DescribeRuleset" - }, - { - "target": "com.amazonaws.databrew#DescribeSchedule" - }, - { - "target": "com.amazonaws.databrew#ListDatasets" - }, - { - "target": "com.amazonaws.databrew#ListJobRuns" - }, - { - "target": "com.amazonaws.databrew#ListJobs" - }, - { - "target": "com.amazonaws.databrew#ListProjects" - }, - { - "target": "com.amazonaws.databrew#ListRecipes" - }, - { - "target": "com.amazonaws.databrew#ListRecipeVersions" - }, - { - "target": "com.amazonaws.databrew#ListRulesets" - }, - { - "target": "com.amazonaws.databrew#ListSchedules" - }, - { - "target": "com.amazonaws.databrew#ListTagsForResource" - }, - { - "target": "com.amazonaws.databrew#PublishRecipe" - }, - { - "target": "com.amazonaws.databrew#SendProjectSessionAction" - }, - { - "target": "com.amazonaws.databrew#StartJobRun" - }, - { - "target": "com.amazonaws.databrew#StartProjectSession" - }, - { - "target": "com.amazonaws.databrew#StopJobRun" - }, - { - "target": "com.amazonaws.databrew#TagResource" - }, - { - "target": "com.amazonaws.databrew#UntagResource" - }, - { - "target": "com.amazonaws.databrew#UpdateDataset" - }, - { - "target": "com.amazonaws.databrew#UpdateProfileJob" - }, - { - "target": "com.amazonaws.databrew#UpdateProject" - }, - { - "target": "com.amazonaws.databrew#UpdateRecipe" - }, - { - "target": "com.amazonaws.databrew#UpdateRecipeJob" - }, - { - "target": "com.amazonaws.databrew#UpdateRuleset" - }, - { - "target": "com.amazonaws.databrew#UpdateSchedule" - } - ], - "traits": { - "aws.api#service": { - "sdkId": "DataBrew", - "arnNamespace": "databrew", - "cloudFormationName": "DataBrew", - "cloudTrailEventSource": "databrew.amazonaws.com", - "endpointPrefix": "databrew" - }, - "aws.auth#sigv4": { - "name": "databrew" - }, - "aws.protocols#restJson1": {}, - "smithy.api#documentation": "

Glue DataBrew is a visual, cloud-scale data-preparation service. DataBrew\n simplifies data preparation tasks, targeting data issues that are hard to spot and\n time-consuming to fix. DataBrew empowers users of all technical levels to visualize the\n data and perform one-click data transformations, with no coding required.

", - "smithy.api#title": "AWS Glue DataBrew", - "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": [ + "smithy": "2.0", + "metadata": { + "suppressions": [ + { + "id": "HttpMethodSemantics", + "namespace": "*" + }, + { + "id": "HttpResponseCodeSemantics", + "namespace": "*" + }, { - "conditions": [ + "id": "PaginatedTrait", + "namespace": "*" + }, + { + "id": "HttpHeaderTrait", + "namespace": "*" + }, + { + "id": "HttpUriConflict", + "namespace": "*" + }, + { + "id": "Service", + "namespace": "*" + } + ] + }, + "shapes": { + "com.amazonaws.databrew#AWSGlueDataBrew": { + "type": "service", + "version": "2017-07-25", + "operations": [ { - "fn": "aws.partition", - "argv": [ - { - "ref": "Region" - } - ], - "assign": "PartitionResult" - } - ], - "type": "tree", - "rules": [ + "target": "com.amazonaws.databrew#BatchDeleteRecipeVersion" + }, { - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Endpoint" + "target": "com.amazonaws.databrew#CreateDataset" + }, + { + "target": "com.amazonaws.databrew#CreateProfileJob" + }, + { + "target": "com.amazonaws.databrew#CreateProject" + }, + { + "target": "com.amazonaws.databrew#CreateRecipe" + }, + { + "target": "com.amazonaws.databrew#CreateRecipeJob" + }, + { + "target": "com.amazonaws.databrew#CreateRuleset" + }, + { + "target": "com.amazonaws.databrew#CreateSchedule" + }, + { + "target": "com.amazonaws.databrew#DeleteDataset" + }, + { + "target": "com.amazonaws.databrew#DeleteJob" + }, + { + "target": "com.amazonaws.databrew#DeleteProject" + }, + { + "target": "com.amazonaws.databrew#DeleteRecipeVersion" + }, + { + "target": "com.amazonaws.databrew#DeleteRuleset" + }, + { + "target": "com.amazonaws.databrew#DeleteSchedule" + }, + { + "target": "com.amazonaws.databrew#DescribeDataset" + }, + { + "target": "com.amazonaws.databrew#DescribeJob" + }, + { + "target": "com.amazonaws.databrew#DescribeJobRun" + }, + { + "target": "com.amazonaws.databrew#DescribeProject" + }, + { + "target": "com.amazonaws.databrew#DescribeRecipe" + }, + { + "target": "com.amazonaws.databrew#DescribeRuleset" + }, + { + "target": "com.amazonaws.databrew#DescribeSchedule" + }, + { + "target": "com.amazonaws.databrew#ListDatasets" + }, + { + "target": "com.amazonaws.databrew#ListJobRuns" + }, + { + "target": "com.amazonaws.databrew#ListJobs" + }, + { + "target": "com.amazonaws.databrew#ListProjects" + }, + { + "target": "com.amazonaws.databrew#ListRecipes" + }, + { + "target": "com.amazonaws.databrew#ListRecipeVersions" + }, + { + "target": "com.amazonaws.databrew#ListRulesets" + }, + { + "target": "com.amazonaws.databrew#ListSchedules" + }, + { + "target": "com.amazonaws.databrew#ListTagsForResource" + }, + { + "target": "com.amazonaws.databrew#PublishRecipe" + }, + { + "target": "com.amazonaws.databrew#SendProjectSessionAction" + }, + { + "target": "com.amazonaws.databrew#StartJobRun" + }, + { + "target": "com.amazonaws.databrew#StartProjectSession" + }, + { + "target": "com.amazonaws.databrew#StopJobRun" + }, + { + "target": "com.amazonaws.databrew#TagResource" + }, + { + "target": "com.amazonaws.databrew#UntagResource" + }, + { + "target": "com.amazonaws.databrew#UpdateDataset" + }, + { + "target": "com.amazonaws.databrew#UpdateProfileJob" + }, + { + "target": "com.amazonaws.databrew#UpdateProject" + }, + { + "target": "com.amazonaws.databrew#UpdateRecipe" + }, + { + "target": "com.amazonaws.databrew#UpdateRecipeJob" + }, + { + "target": "com.amazonaws.databrew#UpdateRuleset" + }, + { + "target": "com.amazonaws.databrew#UpdateSchedule" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "DataBrew", + "arnNamespace": "databrew", + "cloudFormationName": "DataBrew", + "cloudTrailEventSource": "databrew.amazonaws.com", + "endpointPrefix": "databrew" + }, + "aws.auth#sigv4": { + "name": "databrew" + }, + "aws.protocols#restJson1": {}, + "smithy.api#documentation": "

Glue DataBrew is a visual, cloud-scale data-preparation service. DataBrew\n simplifies data preparation tasks, targeting data issues that are hard to spot and\n time-consuming to fix. DataBrew empowers users of all technical levels to visualize the\n data and perform one-click data transformations, with no coding required.

", + "smithy.api#title": "AWS Glue DataBrew", + "smithy.rules#endpointRuleSet": { + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": true, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" } - ] }, - { - "fn": "parseURL", - "argv": [ + "rules": [ { - "ref": "Endpoint" + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://databrew-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "us-gov-west-1" + ] + } + ], + "endpoint": { + "url": "https://databrew.us-gov-west-1.amazonaws.com", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://databrew-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://databrew.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ] + }, + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://databrew.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] } - ], - "assign": "url" - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" + "documentation": "For region ap-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://databrew.ap-east-1.amazonaws.com" + } }, - true - ] - } - ], - "error": "Invalid Configuration: FIPS and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [], - "type": "tree", - "rules": [ + "params": { + "Region": "ap-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] + "documentation": "For region af-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://databrew.af-south-1.amazonaws.com" + } + }, + "params": { + "Region": "af-south-1", + "UseFIPS": false, + "UseDualStack": false } - ], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" }, { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" + "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://databrew.sa-east-1.amazonaws.com" + } }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] - } - ] - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ + "params": { + "Region": "sa-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, { - "ref": "UseFIPS" + "documentation": "For region eu-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://databrew.eu-south-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-south-1", + "UseFIPS": false, + "UseDualStack": false + } }, - true - ] - }, - { - "fn": "booleanEquals", - "argv": [ { - "ref": "UseDualStack" + "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://databrew.us-west-2.amazonaws.com" + } + }, + "params": { + "Region": "us-west-2", + "UseFIPS": false, + "UseDualStack": false + } }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] + "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://databrew.us-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-west-1", + "UseFIPS": false, + "UseDualStack": false } - ] }, { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] + "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://databrew.eu-central-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-central-1", + "UseFIPS": false, + "UseDualStack": false } - ] - } - ], - "type": "tree", - "rules": [ + }, { - "conditions": [], - "endpoint": { - "url": "https://databrew-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] - }, - { - "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" - } - ] - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ + "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://databrew.ap-northeast-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-1", + "UseFIPS": false, + "UseDualStack": false + } + }, { - "ref": "UseFIPS" + "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://databrew.ap-northeast-2.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-2", + "UseFIPS": false, + "UseDualStack": false + } }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] + "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://databrew.eu-west-3.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-3", + "UseFIPS": false, + "UseDualStack": false } - ] - } - ], - "type": "tree", - "rules": [ + }, { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://databrew-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" + "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://databrew.eu-west-2.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-2", + "UseFIPS": false, + "UseDualStack": false } - ] - } - ] - }, - { - "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" - } - ] - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ + }, { - "ref": "UseDualStack" + "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://databrew.eu-west-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-1", + "UseFIPS": false, + "UseDualStack": false + } }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] + "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://databrew.us-east-2.amazonaws.com" + } + }, + "params": { + "Region": "us-east-2", + "UseFIPS": false, + "UseDualStack": false } - ] - } - ], - "type": "tree", - "rules": [ + }, { - "conditions": [], - "endpoint": { - "url": "https://databrew.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" - } - ] - }, - { - "conditions": [], - "endpoint": { - "url": "https://databrew.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] - } - ] - }, - "smithy.rules#endpointTests": { - "testCases": [ - { - "documentation": "For region ap-south-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://databrew-fips.ap-south-1.api.aws" - } - }, - "params": { - "Region": "ap-south-1", - "UseDualStack": true, - "UseFIPS": true - } - }, - { - "documentation": "For region ap-south-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://databrew-fips.ap-south-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-south-1", - "UseDualStack": false, - "UseFIPS": true - } - }, - { - "documentation": "For region ap-south-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://databrew.ap-south-1.api.aws" - } - }, - "params": { - "Region": "ap-south-1", - "UseDualStack": true, - "UseFIPS": false - } - }, - { - "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://databrew.ap-south-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-south-1", - "UseDualStack": false, - "UseFIPS": false - } - }, - { - "documentation": "For region eu-south-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://databrew-fips.eu-south-1.api.aws" - } - }, - "params": { - "Region": "eu-south-1", - "UseDualStack": true, - "UseFIPS": true - } - }, - { - "documentation": "For region eu-south-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://databrew-fips.eu-south-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-south-1", - "UseDualStack": false, - "UseFIPS": true - } - }, - { - "documentation": "For region eu-south-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://databrew.eu-south-1.api.aws" - } - }, - "params": { - "Region": "eu-south-1", - "UseDualStack": true, - "UseFIPS": false - } - }, - { - "documentation": "For region eu-south-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://databrew.eu-south-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-south-1", - "UseDualStack": false, - "UseFIPS": false - } - }, - { - "documentation": "For region ca-central-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://databrew-fips.ca-central-1.api.aws" - } - }, - "params": { - "Region": "ca-central-1", - "UseDualStack": true, - "UseFIPS": true - } - }, - { - "documentation": "For region ca-central-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://databrew-fips.ca-central-1.amazonaws.com" - } - }, - "params": { - "Region": "ca-central-1", - "UseDualStack": false, - "UseFIPS": true - } - }, - { - "documentation": "For region ca-central-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://databrew.ca-central-1.api.aws" - } - }, - "params": { - "Region": "ca-central-1", - "UseDualStack": true, - "UseFIPS": false - } - }, - { - "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://databrew.ca-central-1.amazonaws.com" - } - }, - "params": { - "Region": "ca-central-1", - "UseDualStack": false, - "UseFIPS": false - } - }, - { - "documentation": "For region eu-central-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://databrew-fips.eu-central-1.api.aws" - } - }, - "params": { - "Region": "eu-central-1", - "UseDualStack": true, - "UseFIPS": true - } - }, - { - "documentation": "For region eu-central-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://databrew-fips.eu-central-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-central-1", - "UseDualStack": false, - "UseFIPS": true - } - }, - { - "documentation": "For region eu-central-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://databrew.eu-central-1.api.aws" - } - }, - "params": { - "Region": "eu-central-1", - "UseDualStack": true, - "UseFIPS": false - } - }, - { - "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://databrew.eu-central-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-central-1", - "UseDualStack": false, - "UseFIPS": false - } - }, - { - "documentation": "For region us-west-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://databrew-fips.us-west-1.api.aws" - } - }, - "params": { - "Region": "us-west-1", - "UseDualStack": true, - "UseFIPS": true - } - }, - { - "documentation": "For region us-west-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://databrew-fips.us-west-1.amazonaws.com" - } - }, - "params": { - "Region": "us-west-1", - "UseDualStack": false, - "UseFIPS": true - } + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://databrew.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://databrew.ap-southeast-2.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://databrew.eu-north-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-north-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://databrew.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://databrew.ap-southeast-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://databrew.ca-central-1.amazonaws.com" + } + }, + "params": { + "Region": "ca-central-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://databrew-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://databrew-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://databrew.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://databrew-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://databrew.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://databrew.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://databrew.cn-northwest-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-northwest-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://databrew-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://databrew-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://databrew.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://databrew-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://databrew.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://databrew.us-gov-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://databrew.us-gov-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-west-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://databrew-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://databrew-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://databrew.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://databrew.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For custom endpoint with 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 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" + } + } + ], + "version": "1.0" + } + } + }, + "com.amazonaws.databrew#AccessDeniedException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.databrew#Message" + } }, - { - "documentation": "For region us-west-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://databrew.us-west-1.api.aws" - } - }, - "params": { - "Region": "us-west-1", - "UseDualStack": true, - "UseFIPS": false - } + "traits": { + "smithy.api#documentation": "

Access to the specified resource was denied.

", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.databrew#AccountId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 255 + } + } + }, + "com.amazonaws.databrew#ActionId": { + "type": "integer" + }, + "com.amazonaws.databrew#AllowedStatisticList": { + "type": "list", + "member": { + "target": "com.amazonaws.databrew#AllowedStatistics" }, - { - "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://databrew.us-west-1.amazonaws.com" - } - }, - "params": { - "Region": "us-west-1", - "UseDualStack": false, - "UseFIPS": false - } + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.databrew#AllowedStatistics": { + "type": "structure", + "members": { + "Statistics": { + "target": "com.amazonaws.databrew#StatisticList", + "traits": { + "smithy.api#documentation": "

One or more column statistics to allow for columns that contain detected entities.

", + "smithy.api#required": {} + } + } }, - { - "documentation": "For region us-west-2 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://databrew-fips.us-west-2.api.aws" - } - }, - "params": { - "Region": "us-west-2", - "UseDualStack": true, - "UseFIPS": true - } + "traits": { + "smithy.api#documentation": "

Configuration of statistics that are allowed to be run on columns that \n contain detected entities. When undefined, no statistics will be computed \n on columns that contain detected entities.

" + } + }, + "com.amazonaws.databrew#AnalyticsMode": { + "type": "enum", + "members": { + "ENABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLE" + } + }, + "DISABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLE" + } + } + } + }, + "com.amazonaws.databrew#Arn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + } + } + }, + "com.amazonaws.databrew#AssumeControl": { + "type": "boolean", + "traits": { + "smithy.api#default": false + } + }, + "com.amazonaws.databrew#Attempt": { + "type": "integer", + "traits": { + "smithy.api#default": 0 + } + }, + "com.amazonaws.databrew#BatchDeleteRecipeVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.databrew#BatchDeleteRecipeVersionRequest" }, - { - "documentation": "For region us-west-2 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://databrew-fips.us-west-2.amazonaws.com" - } - }, - "params": { - "Region": "us-west-2", - "UseDualStack": false, - "UseFIPS": true - } + "output": { + "target": "com.amazonaws.databrew#BatchDeleteRecipeVersionResponse" }, - { - "documentation": "For region us-west-2 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://databrew.us-west-2.api.aws" - } - }, - "params": { - "Region": "us-west-2", - "UseDualStack": true, - "UseFIPS": false - } + "errors": [ + { + "target": "com.amazonaws.databrew#ConflictException" + }, + { + "target": "com.amazonaws.databrew#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.databrew#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes one or more versions of a recipe at a time.

\n

The entire request will be rejected if:

\n \n

The request will complete successfully, but with partial failures, if:

\n \n

The LATEST_WORKING version will only be deleted if the recipe has no\n other versions. If you try to delete LATEST_WORKING while other versions\n exist (or if they can't be deleted), then LATEST_WORKING will be listed as\n partial failure in the response.

", + "smithy.api#http": { + "method": "POST", + "uri": "/recipes/{Name}/batchDeleteRecipeVersion", + "code": 200 + } + } + }, + "com.amazonaws.databrew#BatchDeleteRecipeVersionRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.databrew#RecipeName", + "traits": { + "smithy.api#documentation": "

The name of the recipe whose versions are to be deleted.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "RecipeVersions": { + "target": "com.amazonaws.databrew#RecipeVersionList", + "traits": { + "smithy.api#documentation": "

An array of version identifiers, for the recipe versions to be deleted. You can\n specify numeric versions (X.Y) or LATEST_WORKING.\n LATEST_PUBLISHED is not supported.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.databrew#BatchDeleteRecipeVersionResponse": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.databrew#RecipeName", + "traits": { + "smithy.api#documentation": "

The name of the recipe that was modified.

", + "smithy.api#required": {} + } + }, + "Errors": { + "target": "com.amazonaws.databrew#RecipeErrorList", + "traits": { + "smithy.api#documentation": "

Errors, if any, that occurred while attempting to delete the recipe versions.

" + } + } + } + }, + "com.amazonaws.databrew#Bucket": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 63 + } + } + }, + "com.amazonaws.databrew#BucketOwner": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 12, + "max": 12 + }, + "smithy.api#pattern": "^[0-9]{12}$" + } + }, + "com.amazonaws.databrew#CatalogId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "com.amazonaws.databrew#ClientSessionId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.databrew#ColumnName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "com.amazonaws.databrew#ColumnNameList": { + "type": "list", + "member": { + "target": "com.amazonaws.databrew#ColumnName" }, - { - "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://databrew.us-west-2.amazonaws.com" - } - }, - "params": { - "Region": "us-west-2", - "UseDualStack": false, - "UseFIPS": false - } + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.databrew#ColumnRange": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 20 + } + } + }, + "com.amazonaws.databrew#ColumnSelector": { + "type": "structure", + "members": { + "Regex": { + "target": "com.amazonaws.databrew#ColumnName", + "traits": { + "smithy.api#documentation": "

A regular expression for selecting a column from a dataset.

" + } + }, + "Name": { + "target": "com.amazonaws.databrew#ColumnName", + "traits": { + "smithy.api#documentation": "

The name of a column from a dataset.

" + } + } }, - { - "documentation": "For region af-south-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://databrew-fips.af-south-1.api.aws" - } - }, - "params": { - "Region": "af-south-1", - "UseDualStack": true, - "UseFIPS": true - } + "traits": { + "smithy.api#documentation": "

Selector of a column from a dataset for profile job configuration. \n One selector includes either a column name or a regular expression.

" + } + }, + "com.amazonaws.databrew#ColumnSelectorList": { + "type": "list", + "member": { + "target": "com.amazonaws.databrew#ColumnSelector" }, - { - "documentation": "For region af-south-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://databrew-fips.af-south-1.amazonaws.com" - } - }, - "params": { - "Region": "af-south-1", - "UseDualStack": false, - "UseFIPS": true - } + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.databrew#ColumnStatisticsConfiguration": { + "type": "structure", + "members": { + "Selectors": { + "target": "com.amazonaws.databrew#ColumnSelectorList", + "traits": { + "smithy.api#documentation": "

List of column selectors. Selectors can be used to select columns from the dataset. \n When selectors are undefined, configuration will be applied to all supported columns.\n

" + } + }, + "Statistics": { + "target": "com.amazonaws.databrew#StatisticsConfiguration", + "traits": { + "smithy.api#documentation": "

Configuration for evaluations. Statistics can be used to select evaluations and override \n parameters of evaluations. \n

", + "smithy.api#required": {} + } + } }, - { - "documentation": "For region af-south-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://databrew.af-south-1.api.aws" - } - }, - "params": { - "Region": "af-south-1", - "UseDualStack": true, - "UseFIPS": false - } + "traits": { + "smithy.api#documentation": "

Configuration for column evaluations for a profile job. ColumnStatisticsConfiguration can be used to select \n evaluations and override parameters of evaluations for particular columns. \n

" + } + }, + "com.amazonaws.databrew#ColumnStatisticsConfigurationList": { + "type": "list", + "member": { + "target": "com.amazonaws.databrew#ColumnStatisticsConfiguration" }, - { - "documentation": "For region af-south-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://databrew.af-south-1.amazonaws.com" - } - }, - "params": { - "Region": "af-south-1", - "UseDualStack": false, - "UseFIPS": false - } + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.databrew#CompressionFormat": { + "type": "enum", + "members": { + "GZIP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GZIP" + } + }, + "LZ4": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LZ4" + } + }, + "SNAPPY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SNAPPY" + } + }, + "BZIP2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BZIP2" + } + }, + "DEFLATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEFLATE" + } + }, + "LZO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LZO" + } + }, + "BROTLI": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BROTLI" + } + }, + "ZSTD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ZSTD" + } + }, + "ZLIB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ZLIB" + } + } + } + }, + "com.amazonaws.databrew#Condition": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[A-Z\\_]+$" + } + }, + "com.amazonaws.databrew#ConditionExpression": { + "type": "structure", + "members": { + "Condition": { + "target": "com.amazonaws.databrew#Condition", + "traits": { + "smithy.api#documentation": "

A specific condition to apply to a recipe action. For more information, see Recipe\n structure in the Glue DataBrew Developer\n Guide.

", + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.databrew#ConditionValue", + "traits": { + "smithy.api#documentation": "

A value that the condition must evaluate to for the condition to succeed.

" + } + }, + "TargetColumn": { + "target": "com.amazonaws.databrew#TargetColumn", + "traits": { + "smithy.api#documentation": "

A column to apply this condition to.

", + "smithy.api#required": {} + } + } }, - { - "documentation": "For region eu-north-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://databrew-fips.eu-north-1.api.aws" - } - }, - "params": { - "Region": "eu-north-1", - "UseDualStack": true, - "UseFIPS": true - } + "traits": { + "smithy.api#documentation": "

Represents an individual condition that evaluates to true or false.

\n

Conditions are used with recipe actions. The action is only performed for column values where the \n condition evaluates to true.

\n

If a recipe requires more than one condition, then the recipe must specify multiple \n ConditionExpression elements. Each condition is applied to the rows in a dataset first, before \n the recipe action is performed.

" + } + }, + "com.amazonaws.databrew#ConditionExpressionList": { + "type": "list", + "member": { + "target": "com.amazonaws.databrew#ConditionExpression" + } + }, + "com.amazonaws.databrew#ConditionValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + } + } + }, + "com.amazonaws.databrew#ConflictException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.databrew#Message" + } }, - { - "documentation": "For region eu-north-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://databrew-fips.eu-north-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-north-1", - "UseDualStack": false, - "UseFIPS": true - } + "traits": { + "smithy.api#documentation": "

Updating or deleting a resource can cause an inconsistent state.

", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.databrew#CreateColumn": { + "type": "boolean", + "traits": { + "smithy.api#default": false + } + }, + "com.amazonaws.databrew#CreateDataset": { + "type": "operation", + "input": { + "target": "com.amazonaws.databrew#CreateDatasetRequest" }, - { - "documentation": "For region eu-north-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://databrew.eu-north-1.api.aws" - } - }, - "params": { - "Region": "eu-north-1", - "UseDualStack": true, - "UseFIPS": false - } + "output": { + "target": "com.amazonaws.databrew#CreateDatasetResponse" }, - { - "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://databrew.eu-north-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-north-1", - "UseDualStack": false, - "UseFIPS": false - } - }, - { - "documentation": "For region eu-west-3 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://databrew-fips.eu-west-3.api.aws" - } - }, - "params": { - "Region": "eu-west-3", - "UseDualStack": true, - "UseFIPS": true - } - }, - { - "documentation": "For region eu-west-3 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://databrew-fips.eu-west-3.amazonaws.com" - } - }, - "params": { - "Region": "eu-west-3", - "UseDualStack": false, - "UseFIPS": true - } - }, - { - "documentation": "For region eu-west-3 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://databrew.eu-west-3.api.aws" - } - }, - "params": { - "Region": "eu-west-3", - "UseDualStack": true, - "UseFIPS": false - } - }, - { - "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://databrew.eu-west-3.amazonaws.com" - } - }, - "params": { - "Region": "eu-west-3", - "UseDualStack": false, - "UseFIPS": false - } + "errors": [ + { + "target": "com.amazonaws.databrew#AccessDeniedException" + }, + { + "target": "com.amazonaws.databrew#ConflictException" + }, + { + "target": "com.amazonaws.databrew#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.databrew#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new DataBrew dataset.

", + "smithy.api#http": { + "method": "POST", + "uri": "/datasets", + "code": 200 + } + } + }, + "com.amazonaws.databrew#CreateDatasetRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.databrew#DatasetName", + "traits": { + "smithy.api#documentation": "

The name of the dataset to be created. Valid characters are alphanumeric (A-Z, a-z,\n 0-9), hyphen (-), period (.), and space.

", + "smithy.api#required": {} + } + }, + "Format": { + "target": "com.amazonaws.databrew#InputFormat", + "traits": { + "smithy.api#documentation": "

The file format of a dataset that is created from an Amazon S3 file or folder.

" + } + }, + "FormatOptions": { + "target": "com.amazonaws.databrew#FormatOptions" + }, + "Input": { + "target": "com.amazonaws.databrew#Input", + "traits": { + "smithy.api#required": {} + } + }, + "PathOptions": { + "target": "com.amazonaws.databrew#PathOptions", + "traits": { + "smithy.api#documentation": "

A set of options that defines how DataBrew interprets an Amazon S3 path of the dataset.

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

Metadata tags to apply to this dataset.

" + } + } + } + }, + "com.amazonaws.databrew#CreateDatasetResponse": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.databrew#DatasetName", + "traits": { + "smithy.api#documentation": "

The name of the dataset that you created.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.databrew#CreateProfileJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.databrew#CreateProfileJobRequest" }, - { - "documentation": "For region eu-west-2 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://databrew-fips.eu-west-2.api.aws" - } - }, - "params": { - "Region": "eu-west-2", - "UseDualStack": true, - "UseFIPS": true - } + "output": { + "target": "com.amazonaws.databrew#CreateProfileJobResponse" }, - { - "documentation": "For region eu-west-2 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://databrew-fips.eu-west-2.amazonaws.com" - } - }, - "params": { - "Region": "eu-west-2", - "UseDualStack": false, - "UseFIPS": true - } + "errors": [ + { + "target": "com.amazonaws.databrew#AccessDeniedException" + }, + { + "target": "com.amazonaws.databrew#ConflictException" + }, + { + "target": "com.amazonaws.databrew#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.databrew#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.databrew#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new job to analyze a dataset and create its data profile.

", + "smithy.api#http": { + "method": "POST", + "uri": "/profileJobs", + "code": 200 + } + } + }, + "com.amazonaws.databrew#CreateProfileJobRequest": { + "type": "structure", + "members": { + "DatasetName": { + "target": "com.amazonaws.databrew#DatasetName", + "traits": { + "smithy.api#documentation": "

The name of the dataset that this job is to act upon.

", + "smithy.api#required": {} + } + }, + "EncryptionKeyArn": { + "target": "com.amazonaws.databrew#EncryptionKeyArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an encryption key that is used to protect the\n job.

" + } + }, + "EncryptionMode": { + "target": "com.amazonaws.databrew#EncryptionMode", + "traits": { + "smithy.api#documentation": "

The encryption mode for the job, which can be one of the following:

\n " + } + }, + "Name": { + "target": "com.amazonaws.databrew#JobName", + "traits": { + "smithy.api#documentation": "

The name of the job to be created. Valid characters are alphanumeric (A-Z, a-z, 0-9),\n hyphen (-), period (.), and space.

", + "smithy.api#required": {} + } + }, + "LogSubscription": { + "target": "com.amazonaws.databrew#LogSubscription", + "traits": { + "smithy.api#documentation": "

Enables or disables Amazon CloudWatch logging for the job. If logging is enabled,\n CloudWatch writes one log stream for each job run.

" + } + }, + "MaxCapacity": { + "target": "com.amazonaws.databrew#MaxCapacity", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of nodes that DataBrew can use when the job processes data.

" + } + }, + "MaxRetries": { + "target": "com.amazonaws.databrew#MaxRetries", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of times to retry the job after a job run fails.

" + } + }, + "OutputLocation": { + "target": "com.amazonaws.databrew#S3Location", + "traits": { + "smithy.api#required": {} + } + }, + "Configuration": { + "target": "com.amazonaws.databrew#ProfileConfiguration", + "traits": { + "smithy.api#documentation": "

Configuration for profile jobs. Used to select columns, do evaluations, \n and override default parameters of evaluations. When configuration is null, the\n profile job will run with default settings.

" + } + }, + "ValidationConfigurations": { + "target": "com.amazonaws.databrew#ValidationConfigurationList", + "traits": { + "smithy.api#documentation": "

List of validation configurations that are applied to the profile job.

" + } + }, + "RoleArn": { + "target": "com.amazonaws.databrew#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role to\n be assumed when DataBrew runs the job.

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

Metadata tags to apply to this job.

" + } + }, + "Timeout": { + "target": "com.amazonaws.databrew#Timeout", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The job's timeout in minutes. A job that attempts to run longer than this timeout\n period ends with a status of TIMEOUT.

" + } + }, + "JobSample": { + "target": "com.amazonaws.databrew#JobSample", + "traits": { + "smithy.api#documentation": "

Sample configuration for profile jobs only. Determines the number of rows on which the\n profile job will be executed. If a JobSample value is not provided, the default value\n will be used. The default value is CUSTOM_ROWS for the mode parameter and 20000 for the\n size parameter.

" + } + } + } + }, + "com.amazonaws.databrew#CreateProfileJobResponse": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.databrew#JobName", + "traits": { + "smithy.api#documentation": "

The name of the job that was created.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.databrew#CreateProject": { + "type": "operation", + "input": { + "target": "com.amazonaws.databrew#CreateProjectRequest" }, - { - "documentation": "For region eu-west-2 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://databrew.eu-west-2.api.aws" - } - }, - "params": { - "Region": "eu-west-2", - "UseDualStack": true, - "UseFIPS": false - } + "output": { + "target": "com.amazonaws.databrew#CreateProjectResponse" }, - { - "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://databrew.eu-west-2.amazonaws.com" - } - }, - "params": { - "Region": "eu-west-2", - "UseDualStack": false, - "UseFIPS": false - } + "errors": [ + { + "target": "com.amazonaws.databrew#ConflictException" + }, + { + "target": "com.amazonaws.databrew#InternalServerException" + }, + { + "target": "com.amazonaws.databrew#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.databrew#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new DataBrew project.

", + "smithy.api#http": { + "method": "POST", + "uri": "/projects", + "code": 200 + } + } + }, + "com.amazonaws.databrew#CreateProjectRequest": { + "type": "structure", + "members": { + "DatasetName": { + "target": "com.amazonaws.databrew#DatasetName", + "traits": { + "smithy.api#documentation": "

The name of an existing dataset to associate this project with.

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.databrew#ProjectName", + "traits": { + "smithy.api#documentation": "

A unique name for the new project. Valid characters are alphanumeric (A-Z, a-z, 0-9),\n hyphen (-), period (.), and space.

", + "smithy.api#required": {} + } + }, + "RecipeName": { + "target": "com.amazonaws.databrew#RecipeName", + "traits": { + "smithy.api#documentation": "

The name of an existing recipe to associate with the project.

", + "smithy.api#required": {} + } + }, + "Sample": { + "target": "com.amazonaws.databrew#Sample" + }, + "RoleArn": { + "target": "com.amazonaws.databrew#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role to\n be assumed for this request.

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

Metadata tags to apply to this project.

" + } + } + } + }, + "com.amazonaws.databrew#CreateProjectResponse": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.databrew#ProjectName", + "traits": { + "smithy.api#documentation": "

The name of the project that you created.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.databrew#CreateRecipe": { + "type": "operation", + "input": { + "target": "com.amazonaws.databrew#CreateRecipeRequest" }, - { - "documentation": "For region eu-west-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://databrew-fips.eu-west-1.api.aws" - } - }, - "params": { - "Region": "eu-west-1", - "UseDualStack": true, - "UseFIPS": true - } + "output": { + "target": "com.amazonaws.databrew#CreateRecipeResponse" }, - { - "documentation": "For region eu-west-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://databrew-fips.eu-west-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-west-1", - "UseDualStack": false, - "UseFIPS": true - } + "errors": [ + { + "target": "com.amazonaws.databrew#ConflictException" + }, + { + "target": "com.amazonaws.databrew#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.databrew#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new DataBrew recipe.

", + "smithy.api#http": { + "method": "POST", + "uri": "/recipes", + "code": 200 + } + } + }, + "com.amazonaws.databrew#CreateRecipeJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.databrew#CreateRecipeJobRequest" }, - { - "documentation": "For region eu-west-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://databrew.eu-west-1.api.aws" - } - }, - "params": { - "Region": "eu-west-1", - "UseDualStack": true, - "UseFIPS": false - } + "output": { + "target": "com.amazonaws.databrew#CreateRecipeJobResponse" }, - { - "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://databrew.eu-west-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-west-1", - "UseDualStack": false, - "UseFIPS": false - } + "errors": [ + { + "target": "com.amazonaws.databrew#AccessDeniedException" + }, + { + "target": "com.amazonaws.databrew#ConflictException" + }, + { + "target": "com.amazonaws.databrew#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.databrew#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.databrew#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new job to transform input data, using steps defined in an existing Glue DataBrew recipe

", + "smithy.api#http": { + "method": "POST", + "uri": "/recipeJobs", + "code": 200 + } + } + }, + "com.amazonaws.databrew#CreateRecipeJobRequest": { + "type": "structure", + "members": { + "DatasetName": { + "target": "com.amazonaws.databrew#DatasetName", + "traits": { + "smithy.api#documentation": "

The name of the dataset that this job processes.

" + } + }, + "EncryptionKeyArn": { + "target": "com.amazonaws.databrew#EncryptionKeyArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an encryption key that is used to protect the\n job.

" + } + }, + "EncryptionMode": { + "target": "com.amazonaws.databrew#EncryptionMode", + "traits": { + "smithy.api#documentation": "

The encryption mode for the job, which can be one of the following:

\n " + } + }, + "Name": { + "target": "com.amazonaws.databrew#JobName", + "traits": { + "smithy.api#documentation": "

A unique name for the job. Valid characters are alphanumeric (A-Z, a-z, 0-9), hyphen\n (-), period (.), and space.

", + "smithy.api#required": {} + } + }, + "LogSubscription": { + "target": "com.amazonaws.databrew#LogSubscription", + "traits": { + "smithy.api#documentation": "

Enables or disables Amazon CloudWatch logging for the job. If logging is enabled,\n CloudWatch writes one log stream for each job run.

" + } + }, + "MaxCapacity": { + "target": "com.amazonaws.databrew#MaxCapacity", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of nodes that DataBrew can consume when the job processes\n data.

" + } + }, + "MaxRetries": { + "target": "com.amazonaws.databrew#MaxRetries", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of times to retry the job after a job run fails.

" + } + }, + "Outputs": { + "target": "com.amazonaws.databrew#OutputList", + "traits": { + "smithy.api#documentation": "

One or more artifacts that represent the output from running the job.

" + } + }, + "DataCatalogOutputs": { + "target": "com.amazonaws.databrew#DataCatalogOutputList", + "traits": { + "smithy.api#documentation": "

One or more artifacts that represent the Glue Data Catalog output from running the job.

" + } + }, + "DatabaseOutputs": { + "target": "com.amazonaws.databrew#DatabaseOutputList", + "traits": { + "smithy.api#documentation": "

Represents a list of JDBC database output objects which defines the output destination for \n a DataBrew recipe job to write to.

" + } + }, + "ProjectName": { + "target": "com.amazonaws.databrew#ProjectName", + "traits": { + "smithy.api#documentation": "

Either the name of an existing project, or a combination of a recipe and a dataset to\n associate with the recipe.

" + } + }, + "RecipeReference": { + "target": "com.amazonaws.databrew#RecipeReference" + }, + "RoleArn": { + "target": "com.amazonaws.databrew#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role to\n be assumed when DataBrew runs the job.

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

Metadata tags to apply to this job.

" + } + }, + "Timeout": { + "target": "com.amazonaws.databrew#Timeout", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The job's timeout in minutes. A job that attempts to run longer than this timeout\n period ends with a status of TIMEOUT.

" + } + } + } + }, + "com.amazonaws.databrew#CreateRecipeJobResponse": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.databrew#JobName", + "traits": { + "smithy.api#documentation": "

The name of the job that you created.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.databrew#CreateRecipeRequest": { + "type": "structure", + "members": { + "Description": { + "target": "com.amazonaws.databrew#RecipeDescription", + "traits": { + "smithy.api#documentation": "

A description for the recipe.

" + } + }, + "Name": { + "target": "com.amazonaws.databrew#RecipeName", + "traits": { + "smithy.api#documentation": "

A unique name for the recipe. Valid characters are alphanumeric (A-Z, a-z, 0-9),\n hyphen (-), period (.), and space.

", + "smithy.api#required": {} + } + }, + "Steps": { + "target": "com.amazonaws.databrew#RecipeStepList", + "traits": { + "smithy.api#documentation": "

An array containing the steps to be performed by the recipe. Each recipe step consists\n of one recipe action and (optionally) an array of condition expressions.

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

Metadata tags to apply to this recipe.

" + } + } + } + }, + "com.amazonaws.databrew#CreateRecipeResponse": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.databrew#RecipeName", + "traits": { + "smithy.api#documentation": "

The name of the recipe that you created.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.databrew#CreateRuleset": { + "type": "operation", + "input": { + "target": "com.amazonaws.databrew#CreateRulesetRequest" }, - { - "documentation": "For region ap-northeast-2 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://databrew-fips.ap-northeast-2.api.aws" - } - }, - "params": { - "Region": "ap-northeast-2", - "UseDualStack": true, - "UseFIPS": true - } + "output": { + "target": "com.amazonaws.databrew#CreateRulesetResponse" }, - { - "documentation": "For region ap-northeast-2 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://databrew-fips.ap-northeast-2.amazonaws.com" - } - }, - "params": { - "Region": "ap-northeast-2", - "UseDualStack": false, - "UseFIPS": true - } + "errors": [ + { + "target": "com.amazonaws.databrew#ConflictException" + }, + { + "target": "com.amazonaws.databrew#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.databrew#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new ruleset that can be used in a profile job to validate \n the data quality of a dataset.

", + "smithy.api#http": { + "method": "POST", + "uri": "/rulesets", + "code": 200 + } + } + }, + "com.amazonaws.databrew#CreateRulesetRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.databrew#RulesetName", + "traits": { + "smithy.api#documentation": "

The name of the ruleset to be created. Valid characters are alphanumeric \n (A-Z, a-z, 0-9), hyphen (-), period (.), and space.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.databrew#RulesetDescription", + "traits": { + "smithy.api#documentation": "

The description of the ruleset.

" + } + }, + "TargetArn": { + "target": "com.amazonaws.databrew#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a resource (dataset) that the \n ruleset is associated with.

", + "smithy.api#required": {} + } + }, + "Rules": { + "target": "com.amazonaws.databrew#RuleList", + "traits": { + "smithy.api#documentation": "

A list of rules that are defined with the ruleset. A rule includes \n one or more checks to be validated on a DataBrew dataset.

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

Metadata tags to apply to the ruleset.

" + } + } + } + }, + "com.amazonaws.databrew#CreateRulesetResponse": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.databrew#RulesetName", + "traits": { + "smithy.api#documentation": "

The unique name of the created ruleset.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.databrew#CreateSchedule": { + "type": "operation", + "input": { + "target": "com.amazonaws.databrew#CreateScheduleRequest" }, - { - "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://databrew.ap-northeast-2.api.aws" - } - }, - "params": { - "Region": "ap-northeast-2", - "UseDualStack": true, - "UseFIPS": false - } + "output": { + "target": "com.amazonaws.databrew#CreateScheduleResponse" }, - { - "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://databrew.ap-northeast-2.amazonaws.com" - } - }, - "params": { - "Region": "ap-northeast-2", - "UseDualStack": false, - "UseFIPS": false - } + "errors": [ + { + "target": "com.amazonaws.databrew#ConflictException" + }, + { + "target": "com.amazonaws.databrew#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.databrew#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new schedule for one or more DataBrew jobs. Jobs can be run at a specific\n date and time, or at regular intervals.

", + "smithy.api#http": { + "method": "POST", + "uri": "/schedules", + "code": 200 + } + } + }, + "com.amazonaws.databrew#CreateScheduleRequest": { + "type": "structure", + "members": { + "JobNames": { + "target": "com.amazonaws.databrew#JobNameList", + "traits": { + "smithy.api#documentation": "

The name or names of one or more jobs to be run.

" + } + }, + "CronExpression": { + "target": "com.amazonaws.databrew#CronExpression", + "traits": { + "smithy.api#documentation": "

The date or dates and time or times when the jobs are to be run. For more information,\n see Cron\n expressions in the Glue DataBrew Developer\n Guide.

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

Metadata tags to apply to this schedule.

" + } + }, + "Name": { + "target": "com.amazonaws.databrew#ScheduleName", + "traits": { + "smithy.api#documentation": "

A unique name for the schedule. Valid characters are alphanumeric (A-Z, a-z, 0-9),\n hyphen (-), period (.), and space.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.databrew#CreateScheduleResponse": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.databrew#ScheduleName", + "traits": { + "smithy.api#documentation": "

The name of the schedule that was created.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.databrew#CreatedBy": { + "type": "string" + }, + "com.amazonaws.databrew#CronExpression": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + } + } + }, + "com.amazonaws.databrew#CsvOptions": { + "type": "structure", + "members": { + "Delimiter": { + "target": "com.amazonaws.databrew#Delimiter", + "traits": { + "smithy.api#documentation": "

A single character that specifies the delimiter being used in the CSV file.

" + } + }, + "HeaderRow": { + "target": "com.amazonaws.databrew#HeaderRow", + "traits": { + "smithy.api#documentation": "

A variable that specifies whether the first row in the file is parsed as the\n header. If this value is false, column names are auto-generated.

" + } + } }, - { - "documentation": "For region ap-northeast-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://databrew-fips.ap-northeast-1.api.aws" - } - }, - "params": { - "Region": "ap-northeast-1", - "UseDualStack": true, - "UseFIPS": true - } + "traits": { + "smithy.api#documentation": "

Represents a set of options that define how DataBrew will read a \n comma-separated value (CSV) file when creating a dataset from that file.

" + } + }, + "com.amazonaws.databrew#CsvOutputOptions": { + "type": "structure", + "members": { + "Delimiter": { + "target": "com.amazonaws.databrew#Delimiter", + "traits": { + "smithy.api#documentation": "

A single character that specifies the delimiter used to create CSV job output.

" + } + } }, - { - "documentation": "For region ap-northeast-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://databrew-fips.ap-northeast-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-northeast-1", - "UseDualStack": false, - "UseFIPS": true - } - }, - { - "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://databrew.ap-northeast-1.api.aws" - } - }, - "params": { - "Region": "ap-northeast-1", - "UseDualStack": true, - "UseFIPS": false - } - }, - { - "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://databrew.ap-northeast-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-northeast-1", - "UseDualStack": false, - "UseFIPS": false - } + "traits": { + "smithy.api#documentation": "

Represents a set of options that define how DataBrew will write a \n comma-separated value (CSV) file.

" + } + }, + "com.amazonaws.databrew#DataCatalogInputDefinition": { + "type": "structure", + "members": { + "CatalogId": { + "target": "com.amazonaws.databrew#CatalogId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the Amazon Web Services account that holds the Data Catalog that stores the\n data.

" + } + }, + "DatabaseName": { + "target": "com.amazonaws.databrew#DatabaseName", + "traits": { + "smithy.api#documentation": "

The name of a database in the Data Catalog.

", + "smithy.api#required": {} + } + }, + "TableName": { + "target": "com.amazonaws.databrew#TableName", + "traits": { + "smithy.api#documentation": "

The name of a database table in the Data Catalog. This table corresponds to a DataBrew\n dataset.

", + "smithy.api#required": {} + } + }, + "TempDirectory": { + "target": "com.amazonaws.databrew#S3Location", + "traits": { + "smithy.api#documentation": "

Represents an Amazon location where DataBrew can store intermediate results.

" + } + } }, - { - "documentation": "For region sa-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://databrew-fips.sa-east-1.api.aws" - } - }, - "params": { - "Region": "sa-east-1", - "UseDualStack": true, - "UseFIPS": true - } + "traits": { + "smithy.api#documentation": "

Represents how metadata stored in the Glue Data Catalog is defined in a DataBrew\n dataset.

" + } + }, + "com.amazonaws.databrew#DataCatalogOutput": { + "type": "structure", + "members": { + "CatalogId": { + "target": "com.amazonaws.databrew#CatalogId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the Amazon Web Services account that holds the Data Catalog that \n stores the data.

" + } + }, + "DatabaseName": { + "target": "com.amazonaws.databrew#DatabaseName", + "traits": { + "smithy.api#documentation": "

The name of a database in the Data Catalog.

", + "smithy.api#required": {} + } + }, + "TableName": { + "target": "com.amazonaws.databrew#TableName", + "traits": { + "smithy.api#documentation": "

The name of a table in the Data Catalog.

", + "smithy.api#required": {} + } + }, + "S3Options": { + "target": "com.amazonaws.databrew#S3TableOutputOptions", + "traits": { + "smithy.api#documentation": "

Represents options that specify how and where DataBrew writes the Amazon S3 \n output generated by recipe jobs.

" + } + }, + "DatabaseOptions": { + "target": "com.amazonaws.databrew#DatabaseTableOutputOptions", + "traits": { + "smithy.api#documentation": "

Represents options that specify how and where DataBrew writes the database output \n generated by recipe jobs.

" + } + }, + "Overwrite": { + "target": "com.amazonaws.databrew#OverwriteOutput", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A value that, if true, means that any data in the location specified for output \n is overwritten with new output. Not supported with DatabaseOptions.

" + } + } }, - { - "documentation": "For region sa-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://databrew-fips.sa-east-1.amazonaws.com" - } - }, - "params": { - "Region": "sa-east-1", - "UseDualStack": false, - "UseFIPS": true - } + "traits": { + "smithy.api#documentation": "

Represents options that specify how and where in the Glue Data Catalog DataBrew \n writes the output generated by recipe jobs.

" + } + }, + "com.amazonaws.databrew#DataCatalogOutputList": { + "type": "list", + "member": { + "target": "com.amazonaws.databrew#DataCatalogOutput" }, - { - "documentation": "For region sa-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://databrew.sa-east-1.api.aws" - } - }, - "params": { - "Region": "sa-east-1", - "UseDualStack": true, - "UseFIPS": false - } + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.databrew#DatabaseInputDefinition": { + "type": "structure", + "members": { + "GlueConnectionName": { + "target": "com.amazonaws.databrew#GlueConnectionName", + "traits": { + "smithy.api#documentation": "

The Glue Connection that stores the connection information for the target\n database.

", + "smithy.api#required": {} + } + }, + "DatabaseTableName": { + "target": "com.amazonaws.databrew#DatabaseTableName", + "traits": { + "smithy.api#documentation": "

The table within the target database.

" + } + }, + "TempDirectory": { + "target": "com.amazonaws.databrew#S3Location" + }, + "QueryString": { + "target": "com.amazonaws.databrew#QueryString", + "traits": { + "smithy.api#documentation": "

Custom SQL to run against the provided Glue connection. This SQL will be used as \n the input for DataBrew projects and jobs.

" + } + } }, - { - "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://databrew.sa-east-1.amazonaws.com" - } - }, - "params": { - "Region": "sa-east-1", - "UseDualStack": false, - "UseFIPS": false - } + "traits": { + "smithy.api#documentation": "

Connection information for dataset input files stored in a database.

" + } + }, + "com.amazonaws.databrew#DatabaseName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "com.amazonaws.databrew#DatabaseOutput": { + "type": "structure", + "members": { + "GlueConnectionName": { + "target": "com.amazonaws.databrew#GlueConnectionName", + "traits": { + "smithy.api#documentation": "

The Glue connection that stores the connection information for the \n target database.

", + "smithy.api#required": {} + } + }, + "DatabaseOptions": { + "target": "com.amazonaws.databrew#DatabaseTableOutputOptions", + "traits": { + "smithy.api#documentation": "

Represents options that specify how and where DataBrew writes the database output \n generated by recipe jobs.

", + "smithy.api#required": {} + } + }, + "DatabaseOutputMode": { + "target": "com.amazonaws.databrew#DatabaseOutputMode", + "traits": { + "smithy.api#documentation": "

The output mode to write into the database. Currently supported option: NEW_TABLE.

" + } + } }, - { - "documentation": "For region ap-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://databrew-fips.ap-east-1.api.aws" - } - }, - "params": { - "Region": "ap-east-1", - "UseDualStack": true, - "UseFIPS": true - } + "traits": { + "smithy.api#documentation": "

Represents a JDBC database output object which defines the output destination for \n a DataBrew recipe job to write into.

" + } + }, + "com.amazonaws.databrew#DatabaseOutputList": { + "type": "list", + "member": { + "target": "com.amazonaws.databrew#DatabaseOutput" }, - { - "documentation": "For region ap-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://databrew-fips.ap-east-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-east-1", - "UseDualStack": false, - "UseFIPS": true - } + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.databrew#DatabaseOutputMode": { + "type": "enum", + "members": { + "NEW_TABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NEW_TABLE" + } + } + } + }, + "com.amazonaws.databrew#DatabaseTableName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "com.amazonaws.databrew#DatabaseTableOutputOptions": { + "type": "structure", + "members": { + "TempDirectory": { + "target": "com.amazonaws.databrew#S3Location", + "traits": { + "smithy.api#documentation": "

Represents an Amazon S3 location (bucket name and object key) where DataBrew can store \n intermediate results.

" + } + }, + "TableName": { + "target": "com.amazonaws.databrew#DatabaseTableName", + "traits": { + "smithy.api#documentation": "

A prefix for the name of a table DataBrew will create in the database.

", + "smithy.api#required": {} + } + } }, - { - "documentation": "For region ap-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://databrew.ap-east-1.api.aws" - } - }, - "params": { - "Region": "ap-east-1", - "UseDualStack": true, - "UseFIPS": false - } + "traits": { + "smithy.api#documentation": "

Represents options that specify how and where DataBrew writes the database \n output generated by recipe jobs.

" + } + }, + "com.amazonaws.databrew#Dataset": { + "type": "structure", + "members": { + "AccountId": { + "target": "com.amazonaws.databrew#AccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the dataset.

" + } + }, + "CreatedBy": { + "target": "com.amazonaws.databrew#CreatedBy", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the user who created the dataset.

" + } + }, + "CreateDate": { + "target": "com.amazonaws.databrew#Date", + "traits": { + "smithy.api#documentation": "

The date and time that the dataset was created.

" + } + }, + "Name": { + "target": "com.amazonaws.databrew#DatasetName", + "traits": { + "smithy.api#documentation": "

The unique name of the dataset.

", + "smithy.api#required": {} + } + }, + "Format": { + "target": "com.amazonaws.databrew#InputFormat", + "traits": { + "smithy.api#documentation": "

The file format of a dataset that is created from an Amazon S3 file or folder.

" + } + }, + "FormatOptions": { + "target": "com.amazonaws.databrew#FormatOptions", + "traits": { + "smithy.api#documentation": "

A set of options that define how DataBrew interprets the data in the dataset.

" + } + }, + "Input": { + "target": "com.amazonaws.databrew#Input", + "traits": { + "smithy.api#documentation": "

Information on how DataBrew can find the dataset, in either the Glue Data Catalog\n or Amazon S3.

", + "smithy.api#required": {} + } + }, + "LastModifiedDate": { + "target": "com.amazonaws.databrew#Date", + "traits": { + "smithy.api#documentation": "

The last modification date and time of the dataset.

" + } + }, + "LastModifiedBy": { + "target": "com.amazonaws.databrew#LastModifiedBy", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the user who last modified the dataset.

" + } + }, + "Source": { + "target": "com.amazonaws.databrew#Source", + "traits": { + "smithy.api#documentation": "

The location of the data for the dataset, either Amazon S3 or the Glue Data Catalog.

" + } + }, + "PathOptions": { + "target": "com.amazonaws.databrew#PathOptions", + "traits": { + "smithy.api#documentation": "

A set of options that defines how DataBrew interprets an Amazon S3 \n path of the dataset.

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

Metadata tags that have been applied to the dataset.

" + } + }, + "ResourceArn": { + "target": "com.amazonaws.databrew#Arn", + "traits": { + "smithy.api#documentation": "

The unique Amazon Resource Name (ARN) for the dataset.

" + } + } }, - { - "documentation": "For region ap-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://databrew.ap-east-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-east-1", - "UseDualStack": false, - "UseFIPS": false - } + "traits": { + "smithy.api#documentation": "

Represents a dataset that can be processed by DataBrew.

" + } + }, + "com.amazonaws.databrew#DatasetList": { + "type": "list", + "member": { + "target": "com.amazonaws.databrew#Dataset" + } + }, + "com.amazonaws.databrew#DatasetName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "com.amazonaws.databrew#DatasetParameter": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.databrew#PathParameterName", + "traits": { + "smithy.api#documentation": "

The name of the parameter that is used in the dataset's Amazon S3 path.

", + "smithy.api#required": {} + } + }, + "Type": { + "target": "com.amazonaws.databrew#ParameterType", + "traits": { + "smithy.api#documentation": "

The type of the dataset parameter, can be one of a 'String', 'Number' or 'Datetime'.

", + "smithy.api#required": {} + } + }, + "DatetimeOptions": { + "target": "com.amazonaws.databrew#DatetimeOptions", + "traits": { + "smithy.api#documentation": "

Additional parameter options such as a format and a timezone. Required for datetime parameters.

" + } + }, + "CreateColumn": { + "target": "com.amazonaws.databrew#CreateColumn", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Optional boolean value that defines whether the captured value of this parameter \n should be used to create a new column in a dataset.

" + } + }, + "Filter": { + "target": "com.amazonaws.databrew#FilterExpression", + "traits": { + "smithy.api#documentation": "

The optional filter expression structure to apply additional matching criteria to the parameter.

" + } + } }, - { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://databrew-fips.cn-north-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseDualStack": true, - "UseFIPS": true - } + "traits": { + "smithy.api#documentation": "

Represents a dataset parameter that defines type and conditions for a parameter in the\n Amazon S3 path of the dataset.

" + } + }, + "com.amazonaws.databrew#Date": { + "type": "timestamp" + }, + "com.amazonaws.databrew#DatetimeFormat": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 2, + "max": 100 + } + } + }, + "com.amazonaws.databrew#DatetimeOptions": { + "type": "structure", + "members": { + "Format": { + "target": "com.amazonaws.databrew#DatetimeFormat", + "traits": { + "smithy.api#documentation": "

Required option, that defines the datetime format used for a date parameter in the \n Amazon S3 path. Should use only supported datetime specifiers and separation characters, all \n literal a-z or A-Z characters should be escaped with single quotes. E.g. \"MM.dd.yyyy-'at'-HH:mm\".

", + "smithy.api#required": {} + } + }, + "TimezoneOffset": { + "target": "com.amazonaws.databrew#TimezoneOffset", + "traits": { + "smithy.api#documentation": "

Optional value for a timezone offset of the datetime parameter value in the Amazon S3 \n path. Shouldn't be used if Format for this parameter includes timezone fields.\n If no offset specified, UTC is assumed.

" + } + }, + "LocaleCode": { + "target": "com.amazonaws.databrew#LocaleCode", + "traits": { + "smithy.api#documentation": "

Optional value for a non-US locale code, needed for correct interpretation of some date formats.

" + } + } }, - { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://databrew-fips.cn-north-1.amazonaws.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseDualStack": false, - "UseFIPS": true - } + "traits": { + "smithy.api#documentation": "

Represents additional options for correct interpretation of datetime parameters used in \n the Amazon S3 path of a dataset.

" + } + }, + "com.amazonaws.databrew#DeleteDataset": { + "type": "operation", + "input": { + "target": "com.amazonaws.databrew#DeleteDatasetRequest" }, - { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://databrew.cn-north-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseDualStack": true, - "UseFIPS": false - } + "output": { + "target": "com.amazonaws.databrew#DeleteDatasetResponse" }, - { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://databrew.cn-north-1.amazonaws.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseDualStack": false, - "UseFIPS": false - } + "errors": [ + { + "target": "com.amazonaws.databrew#ConflictException" + }, + { + "target": "com.amazonaws.databrew#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.databrew#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a dataset from DataBrew.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/datasets/{Name}", + "code": 200 + } + } + }, + "com.amazonaws.databrew#DeleteDatasetRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.databrew#DatasetName", + "traits": { + "smithy.api#documentation": "

The name of the dataset to be deleted.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.databrew#DeleteDatasetResponse": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.databrew#DatasetName", + "traits": { + "smithy.api#documentation": "

The name of the dataset that you deleted.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.databrew#DeleteJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.databrew#DeleteJobRequest" }, - { - "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://databrew-fips.us-gov-west-1.api.aws" - } - }, - "params": { - "Region": "us-gov-west-1", - "UseDualStack": true, - "UseFIPS": true - } + "output": { + "target": "com.amazonaws.databrew#DeleteJobResponse" }, - { - "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://databrew-fips.us-gov-west-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-west-1", - "UseDualStack": false, - "UseFIPS": true - } + "errors": [ + { + "target": "com.amazonaws.databrew#ConflictException" + }, + { + "target": "com.amazonaws.databrew#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.databrew#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the specified DataBrew job.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/jobs/{Name}", + "code": 200 + } + } + }, + "com.amazonaws.databrew#DeleteJobRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.databrew#JobName", + "traits": { + "smithy.api#documentation": "

The name of the job to be deleted.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.databrew#DeleteJobResponse": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.databrew#JobName", + "traits": { + "smithy.api#documentation": "

The name of the job that you deleted.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.databrew#DeleteProject": { + "type": "operation", + "input": { + "target": "com.amazonaws.databrew#DeleteProjectRequest" }, - { - "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://databrew.us-gov-west-1.api.aws" - } - }, - "params": { - "Region": "us-gov-west-1", - "UseDualStack": true, - "UseFIPS": false - } + "output": { + "target": "com.amazonaws.databrew#DeleteProjectResponse" }, - { - "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://databrew.us-gov-west-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-west-1", - "UseDualStack": false, - "UseFIPS": false - } + "errors": [ + { + "target": "com.amazonaws.databrew#ConflictException" + }, + { + "target": "com.amazonaws.databrew#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.databrew#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes an existing DataBrew project.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/projects/{Name}", + "code": 200 + } + } + }, + "com.amazonaws.databrew#DeleteProjectRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.databrew#ProjectName", + "traits": { + "smithy.api#documentation": "

The name of the project to be deleted.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.databrew#DeleteProjectResponse": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.databrew#ProjectName", + "traits": { + "smithy.api#documentation": "

The name of the project that you deleted.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.databrew#DeleteRecipeVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.databrew#DeleteRecipeVersionRequest" }, - { - "documentation": "For region ap-southeast-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://databrew-fips.ap-southeast-1.api.aws" - } - }, - "params": { - "Region": "ap-southeast-1", - "UseDualStack": true, - "UseFIPS": true - } + "output": { + "target": "com.amazonaws.databrew#DeleteRecipeVersionResponse" }, - { - "documentation": "For region ap-southeast-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://databrew-fips.ap-southeast-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-southeast-1", - "UseDualStack": false, - "UseFIPS": true - } + "errors": [ + { + "target": "com.amazonaws.databrew#ConflictException" + }, + { + "target": "com.amazonaws.databrew#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.databrew#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a single version of a DataBrew recipe.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/recipes/{Name}/recipeVersion/{RecipeVersion}", + "code": 200 + } + } + }, + "com.amazonaws.databrew#DeleteRecipeVersionRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.databrew#RecipeName", + "traits": { + "smithy.api#documentation": "

The name of the recipe.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "RecipeVersion": { + "target": "com.amazonaws.databrew#RecipeVersion", + "traits": { + "smithy.api#documentation": "

The version of the recipe to be deleted. You can specify a numeric versions\n (X.Y) or LATEST_WORKING. LATEST_PUBLISHED is\n not supported.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.databrew#DeleteRecipeVersionResponse": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.databrew#RecipeName", + "traits": { + "smithy.api#documentation": "

The name of the recipe that was deleted.

", + "smithy.api#required": {} + } + }, + "RecipeVersion": { + "target": "com.amazonaws.databrew#RecipeVersion", + "traits": { + "smithy.api#documentation": "

The version of the recipe that was deleted.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.databrew#DeleteRuleset": { + "type": "operation", + "input": { + "target": "com.amazonaws.databrew#DeleteRulesetRequest" }, - { - "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://databrew.ap-southeast-1.api.aws" - } - }, - "params": { - "Region": "ap-southeast-1", - "UseDualStack": true, - "UseFIPS": false - } + "output": { + "target": "com.amazonaws.databrew#DeleteRulesetResponse" }, - { - "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://databrew.ap-southeast-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-southeast-1", - "UseDualStack": false, - "UseFIPS": false - } + "errors": [ + { + "target": "com.amazonaws.databrew#ConflictException" + }, + { + "target": "com.amazonaws.databrew#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.databrew#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a ruleset.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/rulesets/{Name}", + "code": 200 + } + } + }, + "com.amazonaws.databrew#DeleteRulesetRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.databrew#RulesetName", + "traits": { + "smithy.api#documentation": "

The name of the ruleset to be deleted.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.databrew#DeleteRulesetResponse": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.databrew#RulesetName", + "traits": { + "smithy.api#documentation": "

The name of the deleted ruleset.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.databrew#DeleteSchedule": { + "type": "operation", + "input": { + "target": "com.amazonaws.databrew#DeleteScheduleRequest" }, - { - "documentation": "For region ap-southeast-2 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://databrew-fips.ap-southeast-2.api.aws" - } - }, - "params": { - "Region": "ap-southeast-2", - "UseDualStack": true, - "UseFIPS": true - } + "output": { + "target": "com.amazonaws.databrew#DeleteScheduleResponse" }, - { - "documentation": "For region ap-southeast-2 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://databrew-fips.ap-southeast-2.amazonaws.com" - } - }, - "params": { - "Region": "ap-southeast-2", - "UseDualStack": false, - "UseFIPS": true - } + "errors": [ + { + "target": "com.amazonaws.databrew#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.databrew#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the specified DataBrew schedule.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/schedules/{Name}", + "code": 200 + } + } + }, + "com.amazonaws.databrew#DeleteScheduleRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.databrew#ScheduleName", + "traits": { + "smithy.api#documentation": "

The name of the schedule to be deleted.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.databrew#DeleteScheduleResponse": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.databrew#ScheduleName", + "traits": { + "smithy.api#documentation": "

The name of the schedule that was deleted.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.databrew#Delimiter": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.databrew#DescribeDataset": { + "type": "operation", + "input": { + "target": "com.amazonaws.databrew#DescribeDatasetRequest" }, - { - "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://databrew.ap-southeast-2.api.aws" - } - }, - "params": { - "Region": "ap-southeast-2", - "UseDualStack": true, - "UseFIPS": false - } + "output": { + "target": "com.amazonaws.databrew#DescribeDatasetResponse" }, - { - "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://databrew.ap-southeast-2.amazonaws.com" - } - }, - "params": { - "Region": "ap-southeast-2", - "UseDualStack": false, - "UseFIPS": false - } - }, - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://databrew-fips.us-east-1.api.aws" - } - }, - "params": { - "Region": "us-east-1", - "UseDualStack": true, - "UseFIPS": true - } - }, - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://databrew-fips.us-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-east-1", - "UseDualStack": false, - "UseFIPS": true - } - }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://databrew.us-east-1.api.aws" - } - }, - "params": { - "Region": "us-east-1", - "UseDualStack": true, - "UseFIPS": false - } - }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://databrew.us-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-east-1", - "UseDualStack": false, - "UseFIPS": false - } - }, - { - "documentation": "For region us-east-2 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://databrew-fips.us-east-2.api.aws" - } - }, - "params": { - "Region": "us-east-2", - "UseDualStack": true, - "UseFIPS": true - } + "errors": [ + { + "target": "com.amazonaws.databrew#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.databrew#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns the definition of a specific DataBrew dataset.

", + "smithy.api#http": { + "method": "GET", + "uri": "/datasets/{Name}", + "code": 200 + } + } + }, + "com.amazonaws.databrew#DescribeDatasetRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.databrew#DatasetName", + "traits": { + "smithy.api#documentation": "

The name of the dataset to be described.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.databrew#DescribeDatasetResponse": { + "type": "structure", + "members": { + "CreatedBy": { + "target": "com.amazonaws.databrew#CreatedBy", + "traits": { + "smithy.api#documentation": "

The identifier (user name) of the user who created the dataset.

" + } + }, + "CreateDate": { + "target": "com.amazonaws.databrew#Date", + "traits": { + "smithy.api#documentation": "

The date and time that the dataset was created.

" + } + }, + "Name": { + "target": "com.amazonaws.databrew#DatasetName", + "traits": { + "smithy.api#documentation": "

The name of the dataset.

", + "smithy.api#required": {} + } + }, + "Format": { + "target": "com.amazonaws.databrew#InputFormat", + "traits": { + "smithy.api#documentation": "

The file format of a dataset that is created from an Amazon S3 file \n or folder.

" + } + }, + "FormatOptions": { + "target": "com.amazonaws.databrew#FormatOptions" + }, + "Input": { + "target": "com.amazonaws.databrew#Input", + "traits": { + "smithy.api#required": {} + } + }, + "LastModifiedDate": { + "target": "com.amazonaws.databrew#Date", + "traits": { + "smithy.api#documentation": "

The date and time that the dataset was last modified.

" + } + }, + "LastModifiedBy": { + "target": "com.amazonaws.databrew#LastModifiedBy", + "traits": { + "smithy.api#documentation": "

The identifier (user name) of the user who last modified the dataset.

" + } + }, + "Source": { + "target": "com.amazonaws.databrew#Source", + "traits": { + "smithy.api#documentation": "

The location of the data for this dataset, Amazon S3 or the \n Glue Data Catalog.

" + } + }, + "PathOptions": { + "target": "com.amazonaws.databrew#PathOptions", + "traits": { + "smithy.api#documentation": "

A set of options that defines how DataBrew interprets an Amazon S3 \n path of the dataset.

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

Metadata tags associated with this dataset.

" + } + }, + "ResourceArn": { + "target": "com.amazonaws.databrew#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset.

" + } + } + } + }, + "com.amazonaws.databrew#DescribeJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.databrew#DescribeJobRequest" }, - { - "documentation": "For region us-east-2 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://databrew-fips.us-east-2.amazonaws.com" - } - }, - "params": { - "Region": "us-east-2", - "UseDualStack": false, - "UseFIPS": true - } + "output": { + "target": "com.amazonaws.databrew#DescribeJobResponse" }, - { - "documentation": "For region us-east-2 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://databrew.us-east-2.api.aws" - } - }, - "params": { - "Region": "us-east-2", - "UseDualStack": true, - "UseFIPS": false - } + "errors": [ + { + "target": "com.amazonaws.databrew#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.databrew#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns the definition of a specific DataBrew job.

", + "smithy.api#http": { + "method": "GET", + "uri": "/jobs/{Name}", + "code": 200 + } + } + }, + "com.amazonaws.databrew#DescribeJobRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.databrew#JobName", + "traits": { + "smithy.api#documentation": "

The name of the job to be described.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.databrew#DescribeJobResponse": { + "type": "structure", + "members": { + "CreateDate": { + "target": "com.amazonaws.databrew#Date", + "traits": { + "smithy.api#documentation": "

The date and time that the job was created.

" + } + }, + "CreatedBy": { + "target": "com.amazonaws.databrew#CreatedBy", + "traits": { + "smithy.api#documentation": "

The identifier (user name) of the user associated with the creation of the job.

" + } + }, + "DatasetName": { + "target": "com.amazonaws.databrew#DatasetName", + "traits": { + "smithy.api#documentation": "

The dataset that the job acts upon.

" + } + }, + "EncryptionKeyArn": { + "target": "com.amazonaws.databrew#EncryptionKeyArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an encryption key that is used to protect the\n job.

" + } + }, + "EncryptionMode": { + "target": "com.amazonaws.databrew#EncryptionMode", + "traits": { + "smithy.api#documentation": "

The encryption mode for the job, which can be one of the following:

\n " + } + }, + "Name": { + "target": "com.amazonaws.databrew#JobName", + "traits": { + "smithy.api#documentation": "

The name of the job.

", + "smithy.api#required": {} + } + }, + "Type": { + "target": "com.amazonaws.databrew#JobType", + "traits": { + "smithy.api#documentation": "

The job type, which must be one of the following:

\n " + } + }, + "LastModifiedBy": { + "target": "com.amazonaws.databrew#LastModifiedBy", + "traits": { + "smithy.api#documentation": "

The identifier (user name) of the user who last modified the job.

" + } + }, + "LastModifiedDate": { + "target": "com.amazonaws.databrew#Date", + "traits": { + "smithy.api#documentation": "

The date and time that the job was last modified.

" + } + }, + "LogSubscription": { + "target": "com.amazonaws.databrew#LogSubscription", + "traits": { + "smithy.api#documentation": "

Indicates whether Amazon CloudWatch logging is enabled for this job.

" + } + }, + "MaxCapacity": { + "target": "com.amazonaws.databrew#MaxCapacity", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of compute nodes that DataBrew can consume when the job processes\n data.

" + } + }, + "MaxRetries": { + "target": "com.amazonaws.databrew#MaxRetries", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of times to retry the job after a job run fails.

" + } + }, + "Outputs": { + "target": "com.amazonaws.databrew#OutputList", + "traits": { + "smithy.api#documentation": "

One or more artifacts that represent the output from running the job.

" + } + }, + "DataCatalogOutputs": { + "target": "com.amazonaws.databrew#DataCatalogOutputList", + "traits": { + "smithy.api#documentation": "

One or more artifacts that represent the Glue Data Catalog output from running the job.

" + } + }, + "DatabaseOutputs": { + "target": "com.amazonaws.databrew#DatabaseOutputList", + "traits": { + "smithy.api#documentation": "

Represents a list of JDBC database output objects which defines the output \n destination for a DataBrew recipe job to write into.

" + } + }, + "ProjectName": { + "target": "com.amazonaws.databrew#ProjectName", + "traits": { + "smithy.api#documentation": "

The DataBrew project associated with this job.

" + } + }, + "ProfileConfiguration": { + "target": "com.amazonaws.databrew#ProfileConfiguration", + "traits": { + "smithy.api#documentation": "

Configuration for profile jobs. Used to select columns, do evaluations, \n and override default parameters of evaluations. When configuration is null, the\n profile job will run with default settings.

" + } + }, + "ValidationConfigurations": { + "target": "com.amazonaws.databrew#ValidationConfigurationList", + "traits": { + "smithy.api#documentation": "

List of validation configurations that are applied to the profile job.

" + } + }, + "RecipeReference": { + "target": "com.amazonaws.databrew#RecipeReference" + }, + "ResourceArn": { + "target": "com.amazonaws.databrew#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the job.

" + } + }, + "RoleArn": { + "target": "com.amazonaws.databrew#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the Identity and Access Management (IAM) role to be assumed when\n DataBrew runs the job.

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

Metadata tags associated with this job.

" + } + }, + "Timeout": { + "target": "com.amazonaws.databrew#Timeout", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The job's timeout in minutes. A job that attempts to run longer than this timeout\n period ends with a status of TIMEOUT.

" + } + }, + "JobSample": { + "target": "com.amazonaws.databrew#JobSample", + "traits": { + "smithy.api#documentation": "

Sample configuration for profile jobs only. Determines the number of rows on which the\n profile job will be executed.

" + } + } + } + }, + "com.amazonaws.databrew#DescribeJobRun": { + "type": "operation", + "input": { + "target": "com.amazonaws.databrew#DescribeJobRunRequest" }, - { - "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://databrew.us-east-2.amazonaws.com" - } - }, - "params": { - "Region": "us-east-2", - "UseDualStack": false, - "UseFIPS": false - } + "output": { + "target": "com.amazonaws.databrew#DescribeJobRunResponse" }, - { - "documentation": "For region cn-northwest-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://databrew-fips.cn-northwest-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "Region": "cn-northwest-1", - "UseDualStack": true, - "UseFIPS": true - } + "errors": [ + { + "target": "com.amazonaws.databrew#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.databrew#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Represents one run of a DataBrew job.

", + "smithy.api#http": { + "method": "GET", + "uri": "/jobs/{Name}/jobRun/{RunId}", + "code": 200 + } + } + }, + "com.amazonaws.databrew#DescribeJobRunRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.databrew#JobName", + "traits": { + "smithy.api#documentation": "

The name of the job being processed during this run.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "RunId": { + "target": "com.amazonaws.databrew#JobRunId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the job run.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.databrew#DescribeJobRunResponse": { + "type": "structure", + "members": { + "Attempt": { + "target": "com.amazonaws.databrew#Attempt", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of times that DataBrew has attempted to run the job.

" + } + }, + "CompletedOn": { + "target": "com.amazonaws.databrew#Date", + "traits": { + "smithy.api#documentation": "

The date and time when the job completed processing.

" + } + }, + "DatasetName": { + "target": "com.amazonaws.databrew#DatasetName", + "traits": { + "smithy.api#documentation": "

The name of the dataset for the job to process.

" + } + }, + "ErrorMessage": { + "target": "com.amazonaws.databrew#JobRunErrorMessage", + "traits": { + "smithy.api#documentation": "

A message indicating an error (if any) that was encountered when the job ran.

" + } + }, + "ExecutionTime": { + "target": "com.amazonaws.databrew#ExecutionTime", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The amount of time, in seconds, during which the job run consumed resources.

" + } + }, + "JobName": { + "target": "com.amazonaws.databrew#JobName", + "traits": { + "smithy.api#documentation": "

The name of the job being processed during this run.

", + "smithy.api#required": {} + } + }, + "ProfileConfiguration": { + "target": "com.amazonaws.databrew#ProfileConfiguration", + "traits": { + "smithy.api#documentation": "

Configuration for profile jobs. Used to select columns, do evaluations, \n and override default parameters of evaluations. When configuration is null, the\n profile job will run with default settings.

" + } + }, + "ValidationConfigurations": { + "target": "com.amazonaws.databrew#ValidationConfigurationList", + "traits": { + "smithy.api#documentation": "

List of validation configurations that are applied to the profile job.

" + } + }, + "RunId": { + "target": "com.amazonaws.databrew#JobRunId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the job run.

" + } + }, + "State": { + "target": "com.amazonaws.databrew#JobRunState", + "traits": { + "smithy.api#documentation": "

The current state of the job run entity itself.

" + } + }, + "LogSubscription": { + "target": "com.amazonaws.databrew#LogSubscription", + "traits": { + "smithy.api#documentation": "

The current status of Amazon CloudWatch logging for the job run.

" + } + }, + "LogGroupName": { + "target": "com.amazonaws.databrew#LogGroupName", + "traits": { + "smithy.api#documentation": "

The name of an Amazon CloudWatch log group, where the job writes diagnostic messages\n when it runs.

" + } + }, + "Outputs": { + "target": "com.amazonaws.databrew#OutputList", + "traits": { + "smithy.api#documentation": "

One or more output artifacts from a job run.

" + } + }, + "DataCatalogOutputs": { + "target": "com.amazonaws.databrew#DataCatalogOutputList", + "traits": { + "smithy.api#documentation": "

One or more artifacts that represent the Glue Data Catalog output from running the job.

" + } + }, + "DatabaseOutputs": { + "target": "com.amazonaws.databrew#DatabaseOutputList", + "traits": { + "smithy.api#documentation": "

Represents a list of JDBC database output objects which defines the output \n destination for a DataBrew recipe job to write into.

" + } + }, + "RecipeReference": { + "target": "com.amazonaws.databrew#RecipeReference" + }, + "StartedBy": { + "target": "com.amazonaws.databrew#StartedBy", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the user who started the job run.

" + } + }, + "StartedOn": { + "target": "com.amazonaws.databrew#Date", + "traits": { + "smithy.api#documentation": "

The date and time when the job run began.

" + } + }, + "JobSample": { + "target": "com.amazonaws.databrew#JobSample", + "traits": { + "smithy.api#documentation": "

Sample configuration for profile jobs only. Determines the number of rows on which the\n profile job will be executed. If a JobSample value is not provided, the default value\n will be used. The default value is CUSTOM_ROWS for the mode parameter and 20000 for the\n size parameter.

" + } + } + } + }, + "com.amazonaws.databrew#DescribeProject": { + "type": "operation", + "input": { + "target": "com.amazonaws.databrew#DescribeProjectRequest" }, - { - "documentation": "For region cn-northwest-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://databrew-fips.cn-northwest-1.amazonaws.com.cn" - } - }, - "params": { - "Region": "cn-northwest-1", - "UseDualStack": false, - "UseFIPS": true - } + "output": { + "target": "com.amazonaws.databrew#DescribeProjectResponse" }, - { - "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://databrew.cn-northwest-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "Region": "cn-northwest-1", - "UseDualStack": true, - "UseFIPS": false - } + "errors": [ + { + "target": "com.amazonaws.databrew#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.databrew#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns the definition of a specific DataBrew project.

", + "smithy.api#http": { + "method": "GET", + "uri": "/projects/{Name}", + "code": 200 + } + } + }, + "com.amazonaws.databrew#DescribeProjectRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.databrew#ProjectName", + "traits": { + "smithy.api#documentation": "

The name of the project to be described.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.databrew#DescribeProjectResponse": { + "type": "structure", + "members": { + "CreateDate": { + "target": "com.amazonaws.databrew#Date", + "traits": { + "smithy.api#documentation": "

The date and time that the project was created.

" + } + }, + "CreatedBy": { + "target": "com.amazonaws.databrew#CreatedBy", + "traits": { + "smithy.api#documentation": "

The identifier (user name) of the user who created the project.

" + } + }, + "DatasetName": { + "target": "com.amazonaws.databrew#DatasetName", + "traits": { + "smithy.api#documentation": "

The dataset associated with the project.

" + } + }, + "LastModifiedDate": { + "target": "com.amazonaws.databrew#Date", + "traits": { + "smithy.api#documentation": "

The date and time that the project was last modified.

" + } + }, + "LastModifiedBy": { + "target": "com.amazonaws.databrew#LastModifiedBy", + "traits": { + "smithy.api#documentation": "

The identifier (user name) of the user who last modified the project.

" + } + }, + "Name": { + "target": "com.amazonaws.databrew#ProjectName", + "traits": { + "smithy.api#documentation": "

The name of the project.

", + "smithy.api#required": {} + } + }, + "RecipeName": { + "target": "com.amazonaws.databrew#RecipeName", + "traits": { + "smithy.api#documentation": "

The recipe associated with this job.

" + } + }, + "ResourceArn": { + "target": "com.amazonaws.databrew#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the project.

" + } + }, + "Sample": { + "target": "com.amazonaws.databrew#Sample" + }, + "RoleArn": { + "target": "com.amazonaws.databrew#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the Identity and Access Management (IAM) role to be assumed when\n DataBrew runs the job.

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

Metadata tags associated with this project.

" + } + }, + "SessionStatus": { + "target": "com.amazonaws.databrew#SessionStatus", + "traits": { + "smithy.api#documentation": "

Describes the current state of the session:

\n " + } + }, + "OpenedBy": { + "target": "com.amazonaws.databrew#OpenedBy", + "traits": { + "smithy.api#documentation": "

The identifier (user name) of the user that opened the project for use.

" + } + }, + "OpenDate": { + "target": "com.amazonaws.databrew#Date", + "traits": { + "smithy.api#documentation": "

The date and time when the project was opened.

" + } + } + } + }, + "com.amazonaws.databrew#DescribeRecipe": { + "type": "operation", + "input": { + "target": "com.amazonaws.databrew#DescribeRecipeRequest" }, - { - "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://databrew.cn-northwest-1.amazonaws.com.cn" - } - }, - "params": { - "Region": "cn-northwest-1", - "UseDualStack": false, - "UseFIPS": false - } + "output": { + "target": "com.amazonaws.databrew#DescribeRecipeResponse" }, - { - "documentation": "For custom endpoint with fips disabled and dualstack disabled", - "expect": { - "endpoint": { - "url": "https://example.com" - } - }, - "params": { - "Region": "us-east-1", - "UseDualStack": false, - "UseFIPS": false, - "Endpoint": "https://example.com" - } + "errors": [ + { + "target": "com.amazonaws.databrew#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.databrew#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns the definition of a specific DataBrew recipe corresponding to a particular\n version.

", + "smithy.api#http": { + "method": "GET", + "uri": "/recipes/{Name}", + "code": 200 + } + } + }, + "com.amazonaws.databrew#DescribeRecipeRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.databrew#RecipeName", + "traits": { + "smithy.api#documentation": "

The name of the recipe to be described.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "RecipeVersion": { + "target": "com.amazonaws.databrew#RecipeVersion", + "traits": { + "smithy.api#documentation": "

The recipe version identifier. If this parameter isn't specified, then the latest\n published version is returned.

", + "smithy.api#httpQuery": "recipeVersion" + } + } + } + }, + "com.amazonaws.databrew#DescribeRecipeResponse": { + "type": "structure", + "members": { + "CreatedBy": { + "target": "com.amazonaws.databrew#CreatedBy", + "traits": { + "smithy.api#documentation": "

The identifier (user name) of the user who created the recipe.

" + } + }, + "CreateDate": { + "target": "com.amazonaws.databrew#Date", + "traits": { + "smithy.api#documentation": "

The date and time that the recipe was created.

" + } + }, + "LastModifiedBy": { + "target": "com.amazonaws.databrew#LastModifiedBy", + "traits": { + "smithy.api#documentation": "

The identifier (user name) of the user who last modified the recipe.

" + } + }, + "LastModifiedDate": { + "target": "com.amazonaws.databrew#Date", + "traits": { + "smithy.api#documentation": "

The date and time that the recipe was last modified.

" + } + }, + "ProjectName": { + "target": "com.amazonaws.databrew#ProjectName", + "traits": { + "smithy.api#documentation": "

The name of the project associated with this recipe.

" + } + }, + "PublishedBy": { + "target": "com.amazonaws.databrew#PublishedBy", + "traits": { + "smithy.api#documentation": "

The identifier (user name) of the user who last published the recipe.

" + } + }, + "PublishedDate": { + "target": "com.amazonaws.databrew#Date", + "traits": { + "smithy.api#documentation": "

The date and time when the recipe was last published.

" + } + }, + "Description": { + "target": "com.amazonaws.databrew#RecipeDescription", + "traits": { + "smithy.api#documentation": "

The description of the recipe.

" + } + }, + "Name": { + "target": "com.amazonaws.databrew#RecipeName", + "traits": { + "smithy.api#documentation": "

The name of the recipe.

", + "smithy.api#required": {} + } + }, + "Steps": { + "target": "com.amazonaws.databrew#RecipeStepList", + "traits": { + "smithy.api#documentation": "

One or more steps to be performed by the recipe. Each step consists of an action, and\n the conditions under which the action should succeed.

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

Metadata tags associated with this project.

" + } + }, + "ResourceArn": { + "target": "com.amazonaws.databrew#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the recipe.

" + } + }, + "RecipeVersion": { + "target": "com.amazonaws.databrew#RecipeVersion", + "traits": { + "smithy.api#documentation": "

The recipe version identifier.

" + } + } + } + }, + "com.amazonaws.databrew#DescribeRuleset": { + "type": "operation", + "input": { + "target": "com.amazonaws.databrew#DescribeRulesetRequest" }, - { - "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", - "UseDualStack": false, - "UseFIPS": true, - "Endpoint": "https://example.com" - } + "output": { + "target": "com.amazonaws.databrew#DescribeRulesetResponse" }, - { - "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", - "UseDualStack": true, - "UseFIPS": false, - "Endpoint": "https://example.com" - } - } - ], - "version": "1.0" - } - } - }, - "com.amazonaws.databrew#AccessDeniedException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.databrew#Message" - } - }, - "traits": { - "smithy.api#documentation": "

Access to the specified resource was denied.

", - "smithy.api#error": "client", - "smithy.api#httpError": 403 - } - }, - "com.amazonaws.databrew#AccountId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 255 - } - } - }, - "com.amazonaws.databrew#ActionId": { - "type": "integer" - }, - "com.amazonaws.databrew#AllowedStatisticList": { - "type": "list", - "member": { - "target": "com.amazonaws.databrew#AllowedStatistics" - }, - "traits": { - "smithy.api#length": { - "min": 1 - } - } - }, - "com.amazonaws.databrew#AllowedStatistics": { - "type": "structure", - "members": { - "Statistics": { - "target": "com.amazonaws.databrew#StatisticList", - "traits": { - "smithy.api#documentation": "

One or more column statistics to allow for columns that contain detected entities.

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

Configuration of statistics that are allowed to be run on columns that \n contain detected entities. When undefined, no statistics will be computed \n on columns that contain detected entities.

" - } - }, - "com.amazonaws.databrew#AnalyticsMode": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ENABLE", - "name": "ENABLE" - }, - { - "value": "DISABLE", - "name": "DISABLE" - } - ] - } - }, - "com.amazonaws.databrew#Arn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 20, - "max": 2048 - } - } - }, - "com.amazonaws.databrew#AssumeControl": { - "type": "boolean", - "traits": { - "smithy.api#default": false - } - }, - "com.amazonaws.databrew#Attempt": { - "type": "integer", - "traits": { - "smithy.api#default": 0 - } - }, - "com.amazonaws.databrew#BatchDeleteRecipeVersion": { - "type": "operation", - "input": { - "target": "com.amazonaws.databrew#BatchDeleteRecipeVersionRequest" - }, - "output": { - "target": "com.amazonaws.databrew#BatchDeleteRecipeVersionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.databrew#ConflictException" - }, - { - "target": "com.amazonaws.databrew#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.databrew#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes one or more versions of a recipe at a time.

\n\n

The entire request will be rejected if:

\n \n\n

The request will complete successfully, but with partial failures, if:

\n \n

The LATEST_WORKING version will only be deleted if the recipe has no\n other versions. If you try to delete LATEST_WORKING while other versions\n exist (or if they can't be deleted), then LATEST_WORKING will be listed as\n partial failure in the response.

", - "smithy.api#http": { - "method": "POST", - "uri": "/recipes/{Name}/batchDeleteRecipeVersion", - "code": 200 - } - } - }, - "com.amazonaws.databrew#BatchDeleteRecipeVersionRequest": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.databrew#RecipeName", - "traits": { - "smithy.api#documentation": "

The name of the recipe whose versions are to be deleted.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "RecipeVersions": { - "target": "com.amazonaws.databrew#RecipeVersionList", - "traits": { - "smithy.api#documentation": "

An array of version identifiers, for the recipe versions to be deleted. You can\n specify numeric versions (X.Y) or LATEST_WORKING.\n LATEST_PUBLISHED is not supported.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.databrew#BatchDeleteRecipeVersionResponse": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.databrew#RecipeName", - "traits": { - "smithy.api#documentation": "

The name of the recipe that was modified.

", - "smithy.api#required": {} - } - }, - "Errors": { - "target": "com.amazonaws.databrew#RecipeErrorList", - "traits": { - "smithy.api#documentation": "

Errors, if any, that occurred while attempting to delete the recipe versions.

" - } - } - } - }, - "com.amazonaws.databrew#Bucket": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 3, - "max": 63 - } - } - }, - "com.amazonaws.databrew#BucketOwner": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 12, - "max": 12 - }, - "smithy.api#pattern": "^[0-9]{12}$" - } - }, - "com.amazonaws.databrew#CatalogId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 255 - } - } - }, - "com.amazonaws.databrew#ClientSessionId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 255 - }, - "smithy.api#pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]*$", - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.databrew#ColumnName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 255 - } - } - }, - "com.amazonaws.databrew#ColumnNameList": { - "type": "list", - "member": { - "target": "com.amazonaws.databrew#ColumnName" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 200 - } - } - }, - "com.amazonaws.databrew#ColumnRange": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 0, - "max": 20 - } - } - }, - "com.amazonaws.databrew#ColumnSelector": { - "type": "structure", - "members": { - "Regex": { - "target": "com.amazonaws.databrew#ColumnName", - "traits": { - "smithy.api#documentation": "

A regular expression for selecting a column from a dataset.

" - } - }, - "Name": { - "target": "com.amazonaws.databrew#ColumnName", - "traits": { - "smithy.api#documentation": "

The name of a column from a dataset.

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

Selector of a column from a dataset for profile job configuration. \n One selector includes either a column name or a regular expression.

" - } - }, - "com.amazonaws.databrew#ColumnSelectorList": { - "type": "list", - "member": { - "target": "com.amazonaws.databrew#ColumnSelector" - }, - "traits": { - "smithy.api#length": { - "min": 1 - } - } - }, - "com.amazonaws.databrew#ColumnStatisticsConfiguration": { - "type": "structure", - "members": { - "Selectors": { - "target": "com.amazonaws.databrew#ColumnSelectorList", - "traits": { - "smithy.api#documentation": "

List of column selectors. Selectors can be used to select columns from the dataset. \n When selectors are undefined, configuration will be applied to all supported columns.\n

" - } - }, - "Statistics": { - "target": "com.amazonaws.databrew#StatisticsConfiguration", - "traits": { - "smithy.api#documentation": "

Configuration for evaluations. Statistics can be used to select evaluations and override \n parameters of evaluations. \n

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

Configuration for column evaluations for a profile job. ColumnStatisticsConfiguration can be used to select \n evaluations and override parameters of evaluations for particular columns. \n

" - } - }, - "com.amazonaws.databrew#ColumnStatisticsConfigurationList": { - "type": "list", - "member": { - "target": "com.amazonaws.databrew#ColumnStatisticsConfiguration" - }, - "traits": { - "smithy.api#length": { - "min": 1 - } - } - }, - "com.amazonaws.databrew#CompressionFormat": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "GZIP", - "name": "GZIP" - }, - { - "value": "LZ4", - "name": "LZ4" - }, - { - "value": "SNAPPY", - "name": "SNAPPY" - }, - { - "value": "BZIP2", - "name": "BZIP2" - }, - { - "value": "DEFLATE", - "name": "DEFLATE" - }, - { - "value": "LZO", - "name": "LZO" - }, - { - "value": "BROTLI", - "name": "BROTLI" - }, - { - "value": "ZSTD", - "name": "ZSTD" - }, - { - "value": "ZLIB", - "name": "ZLIB" - } - ] - } - }, - "com.amazonaws.databrew#Condition": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - }, - "smithy.api#pattern": "^[A-Z\\_]+$" - } - }, - "com.amazonaws.databrew#ConditionExpression": { - "type": "structure", - "members": { - "Condition": { - "target": "com.amazonaws.databrew#Condition", - "traits": { - "smithy.api#documentation": "

A specific condition to apply to a recipe action. For more information, see Recipe\n structure in the Glue DataBrew Developer\n Guide.

", - "smithy.api#required": {} - } - }, - "Value": { - "target": "com.amazonaws.databrew#ConditionValue", - "traits": { - "smithy.api#documentation": "

A value that the condition must evaluate to for the condition to succeed.

" - } - }, - "TargetColumn": { - "target": "com.amazonaws.databrew#TargetColumn", - "traits": { - "smithy.api#documentation": "

A column to apply this condition to.

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

Represents an individual condition that evaluates to true or false.

\n

Conditions are used with recipe actions. The action is only performed for column values where the \n condition evaluates to true.

\n

If a recipe requires more than one condition, then the recipe must specify multiple \n ConditionExpression elements. Each condition is applied to the rows in a dataset first, before \n the recipe action is performed.

" - } - }, - "com.amazonaws.databrew#ConditionExpressionList": { - "type": "list", - "member": { - "target": "com.amazonaws.databrew#ConditionExpression" - } - }, - "com.amazonaws.databrew#ConditionValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1024 - } - } - }, - "com.amazonaws.databrew#ConflictException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.databrew#Message" - } - }, - "traits": { - "smithy.api#documentation": "

Updating or deleting a resource can cause an inconsistent state.

", - "smithy.api#error": "client", - "smithy.api#httpError": 409 - } - }, - "com.amazonaws.databrew#CreateColumn": { - "type": "boolean", - "traits": { - "smithy.api#default": false - } - }, - "com.amazonaws.databrew#CreateDataset": { - "type": "operation", - "input": { - "target": "com.amazonaws.databrew#CreateDatasetRequest" - }, - "output": { - "target": "com.amazonaws.databrew#CreateDatasetResponse" - }, - "errors": [ - { - "target": "com.amazonaws.databrew#AccessDeniedException" - }, - { - "target": "com.amazonaws.databrew#ConflictException" - }, - { - "target": "com.amazonaws.databrew#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.databrew#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a new DataBrew dataset.

", - "smithy.api#http": { - "method": "POST", - "uri": "/datasets", - "code": 200 - } - } - }, - "com.amazonaws.databrew#CreateDatasetRequest": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.databrew#DatasetName", - "traits": { - "smithy.api#documentation": "

The name of the dataset to be created. Valid characters are alphanumeric (A-Z, a-z,\n 0-9), hyphen (-), period (.), and space.

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

The file format of a dataset that is created from an Amazon S3 file or folder.

" - } - }, - "FormatOptions": { - "target": "com.amazonaws.databrew#FormatOptions" - }, - "Input": { - "target": "com.amazonaws.databrew#Input", - "traits": { - "smithy.api#required": {} - } - }, - "PathOptions": { - "target": "com.amazonaws.databrew#PathOptions", - "traits": { - "smithy.api#documentation": "

A set of options that defines how DataBrew interprets an Amazon S3 path of the dataset.

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

Metadata tags to apply to this dataset.

" - } - } - } - }, - "com.amazonaws.databrew#CreateDatasetResponse": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.databrew#DatasetName", - "traits": { - "smithy.api#documentation": "

The name of the dataset that you created.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.databrew#CreateProfileJob": { - "type": "operation", - "input": { - "target": "com.amazonaws.databrew#CreateProfileJobRequest" - }, - "output": { - "target": "com.amazonaws.databrew#CreateProfileJobResponse" - }, - "errors": [ - { - "target": "com.amazonaws.databrew#AccessDeniedException" - }, - { - "target": "com.amazonaws.databrew#ConflictException" - }, - { - "target": "com.amazonaws.databrew#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.databrew#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.databrew#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a new job to analyze a dataset and create its data profile.

", - "smithy.api#http": { - "method": "POST", - "uri": "/profileJobs", - "code": 200 - } - } - }, - "com.amazonaws.databrew#CreateProfileJobRequest": { - "type": "structure", - "members": { - "DatasetName": { - "target": "com.amazonaws.databrew#DatasetName", - "traits": { - "smithy.api#documentation": "

The name of the dataset that this job is to act upon.

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

The Amazon Resource Name (ARN) of an encryption key that is used to protect the\n job.

" - } - }, - "EncryptionMode": { - "target": "com.amazonaws.databrew#EncryptionMode", - "traits": { - "smithy.api#documentation": "

The encryption mode for the job, which can be one of the following:

\n " - } - }, - "Name": { - "target": "com.amazonaws.databrew#JobName", - "traits": { - "smithy.api#documentation": "

The name of the job to be created. Valid characters are alphanumeric (A-Z, a-z, 0-9),\n hyphen (-), period (.), and space.

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

Enables or disables Amazon CloudWatch logging for the job. If logging is enabled,\n CloudWatch writes one log stream for each job run.

" - } - }, - "MaxCapacity": { - "target": "com.amazonaws.databrew#MaxCapacity", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of nodes that DataBrew can use when the job processes data.

" - } - }, - "MaxRetries": { - "target": "com.amazonaws.databrew#MaxRetries", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of times to retry the job after a job run fails.

" - } - }, - "OutputLocation": { - "target": "com.amazonaws.databrew#S3Location", - "traits": { - "smithy.api#required": {} - } - }, - "Configuration": { - "target": "com.amazonaws.databrew#ProfileConfiguration", - "traits": { - "smithy.api#documentation": "

Configuration for profile jobs. Used to select columns, do evaluations, \n and override default parameters of evaluations. When configuration is null, the\n profile job will run with default settings.

" - } - }, - "ValidationConfigurations": { - "target": "com.amazonaws.databrew#ValidationConfigurationList", - "traits": { - "smithy.api#documentation": "

List of validation configurations that are applied to the profile job.

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

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role to\n be assumed when DataBrew runs the job.

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

Metadata tags to apply to this job.

" - } - }, - "Timeout": { - "target": "com.amazonaws.databrew#Timeout", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The job's timeout in minutes. A job that attempts to run longer than this timeout\n period ends with a status of TIMEOUT.

" - } - }, - "JobSample": { - "target": "com.amazonaws.databrew#JobSample", - "traits": { - "smithy.api#documentation": "

Sample configuration for profile jobs only. Determines the number of rows on which the\n profile job will be executed. If a JobSample value is not provided, the default value\n will be used. The default value is CUSTOM_ROWS for the mode parameter and 20000 for the\n size parameter.

" - } - } - } - }, - "com.amazonaws.databrew#CreateProfileJobResponse": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.databrew#JobName", - "traits": { - "smithy.api#documentation": "

The name of the job that was created.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.databrew#CreateProject": { - "type": "operation", - "input": { - "target": "com.amazonaws.databrew#CreateProjectRequest" - }, - "output": { - "target": "com.amazonaws.databrew#CreateProjectResponse" - }, - "errors": [ - { - "target": "com.amazonaws.databrew#ConflictException" - }, - { - "target": "com.amazonaws.databrew#InternalServerException" - }, - { - "target": "com.amazonaws.databrew#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.databrew#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a new DataBrew project.

", - "smithy.api#http": { - "method": "POST", - "uri": "/projects", - "code": 200 - } - } - }, - "com.amazonaws.databrew#CreateProjectRequest": { - "type": "structure", - "members": { - "DatasetName": { - "target": "com.amazonaws.databrew#DatasetName", - "traits": { - "smithy.api#documentation": "

The name of an existing dataset to associate this project with.

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

A unique name for the new project. Valid characters are alphanumeric (A-Z, a-z, 0-9),\n hyphen (-), period (.), and space.

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

The name of an existing recipe to associate with the project.

", - "smithy.api#required": {} - } - }, - "Sample": { - "target": "com.amazonaws.databrew#Sample" - }, - "RoleArn": { - "target": "com.amazonaws.databrew#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role to\n be assumed for this request.

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

Metadata tags to apply to this project.

" - } - } - } - }, - "com.amazonaws.databrew#CreateProjectResponse": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.databrew#ProjectName", - "traits": { - "smithy.api#documentation": "

The name of the project that you created.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.databrew#CreateRecipe": { - "type": "operation", - "input": { - "target": "com.amazonaws.databrew#CreateRecipeRequest" - }, - "output": { - "target": "com.amazonaws.databrew#CreateRecipeResponse" - }, - "errors": [ - { - "target": "com.amazonaws.databrew#ConflictException" - }, - { - "target": "com.amazonaws.databrew#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.databrew#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a new DataBrew recipe.

", - "smithy.api#http": { - "method": "POST", - "uri": "/recipes", - "code": 200 - } - } - }, - "com.amazonaws.databrew#CreateRecipeJob": { - "type": "operation", - "input": { - "target": "com.amazonaws.databrew#CreateRecipeJobRequest" - }, - "output": { - "target": "com.amazonaws.databrew#CreateRecipeJobResponse" - }, - "errors": [ - { - "target": "com.amazonaws.databrew#AccessDeniedException" - }, - { - "target": "com.amazonaws.databrew#ConflictException" - }, - { - "target": "com.amazonaws.databrew#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.databrew#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.databrew#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a new job to transform input data, using steps defined in an existing Glue DataBrew recipe

", - "smithy.api#http": { - "method": "POST", - "uri": "/recipeJobs", - "code": 200 - } - } - }, - "com.amazonaws.databrew#CreateRecipeJobRequest": { - "type": "structure", - "members": { - "DatasetName": { - "target": "com.amazonaws.databrew#DatasetName", - "traits": { - "smithy.api#documentation": "

The name of the dataset that this job processes.

" - } - }, - "EncryptionKeyArn": { - "target": "com.amazonaws.databrew#EncryptionKeyArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an encryption key that is used to protect the\n job.

" - } - }, - "EncryptionMode": { - "target": "com.amazonaws.databrew#EncryptionMode", - "traits": { - "smithy.api#documentation": "

The encryption mode for the job, which can be one of the following:

\n " - } - }, - "Name": { - "target": "com.amazonaws.databrew#JobName", - "traits": { - "smithy.api#documentation": "

A unique name for the job. Valid characters are alphanumeric (A-Z, a-z, 0-9), hyphen\n (-), period (.), and space.

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

Enables or disables Amazon CloudWatch logging for the job. If logging is enabled,\n CloudWatch writes one log stream for each job run.

" - } - }, - "MaxCapacity": { - "target": "com.amazonaws.databrew#MaxCapacity", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of nodes that DataBrew can consume when the job processes\n data.

" - } - }, - "MaxRetries": { - "target": "com.amazonaws.databrew#MaxRetries", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of times to retry the job after a job run fails.

" - } - }, - "Outputs": { - "target": "com.amazonaws.databrew#OutputList", - "traits": { - "smithy.api#documentation": "

One or more artifacts that represent the output from running the job.

" - } - }, - "DataCatalogOutputs": { - "target": "com.amazonaws.databrew#DataCatalogOutputList", - "traits": { - "smithy.api#documentation": "

One or more artifacts that represent the Glue Data Catalog output from running the job.

" - } - }, - "DatabaseOutputs": { - "target": "com.amazonaws.databrew#DatabaseOutputList", - "traits": { - "smithy.api#documentation": "

Represents a list of JDBC database output objects which defines the output destination for \n a DataBrew recipe job to write to.

" - } - }, - "ProjectName": { - "target": "com.amazonaws.databrew#ProjectName", - "traits": { - "smithy.api#documentation": "

Either the name of an existing project, or a combination of a recipe and a dataset to\n associate with the recipe.

" - } - }, - "RecipeReference": { - "target": "com.amazonaws.databrew#RecipeReference" - }, - "RoleArn": { - "target": "com.amazonaws.databrew#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role to\n be assumed when DataBrew runs the job.

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

Metadata tags to apply to this job.

" - } - }, - "Timeout": { - "target": "com.amazonaws.databrew#Timeout", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The job's timeout in minutes. A job that attempts to run longer than this timeout\n period ends with a status of TIMEOUT.

" - } - } - } - }, - "com.amazonaws.databrew#CreateRecipeJobResponse": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.databrew#JobName", - "traits": { - "smithy.api#documentation": "

The name of the job that you created.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.databrew#CreateRecipeRequest": { - "type": "structure", - "members": { - "Description": { - "target": "com.amazonaws.databrew#RecipeDescription", - "traits": { - "smithy.api#documentation": "

A description for the recipe.

" - } - }, - "Name": { - "target": "com.amazonaws.databrew#RecipeName", - "traits": { - "smithy.api#documentation": "

A unique name for the recipe. Valid characters are alphanumeric (A-Z, a-z, 0-9),\n hyphen (-), period (.), and space.

", - "smithy.api#required": {} - } - }, - "Steps": { - "target": "com.amazonaws.databrew#RecipeStepList", - "traits": { - "smithy.api#documentation": "

An array containing the steps to be performed by the recipe. Each recipe step consists\n of one recipe action and (optionally) an array of condition expressions.

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

Metadata tags to apply to this recipe.

" - } - } - } - }, - "com.amazonaws.databrew#CreateRecipeResponse": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.databrew#RecipeName", - "traits": { - "smithy.api#documentation": "

The name of the recipe that you created.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.databrew#CreateRuleset": { - "type": "operation", - "input": { - "target": "com.amazonaws.databrew#CreateRulesetRequest" - }, - "output": { - "target": "com.amazonaws.databrew#CreateRulesetResponse" - }, - "errors": [ - { - "target": "com.amazonaws.databrew#ConflictException" - }, - { - "target": "com.amazonaws.databrew#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.databrew#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a new ruleset that can be used in a profile job to validate \n the data quality of a dataset.

", - "smithy.api#http": { - "method": "POST", - "uri": "/rulesets", - "code": 200 - } - } - }, - "com.amazonaws.databrew#CreateRulesetRequest": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.databrew#RulesetName", - "traits": { - "smithy.api#documentation": "

The name of the ruleset to be created. Valid characters are alphanumeric \n (A-Z, a-z, 0-9), hyphen (-), period (.), and space.

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

The description of the ruleset.

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

The Amazon Resource Name (ARN) of a resource (dataset) that the \n ruleset is associated with.

", - "smithy.api#required": {} - } - }, - "Rules": { - "target": "com.amazonaws.databrew#RuleList", - "traits": { - "smithy.api#documentation": "

A list of rules that are defined with the ruleset. A rule includes \n one or more checks to be validated on a DataBrew dataset.

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

Metadata tags to apply to the ruleset.

" - } - } - } - }, - "com.amazonaws.databrew#CreateRulesetResponse": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.databrew#RulesetName", - "traits": { - "smithy.api#documentation": "

The unique name of the created ruleset.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.databrew#CreateSchedule": { - "type": "operation", - "input": { - "target": "com.amazonaws.databrew#CreateScheduleRequest" - }, - "output": { - "target": "com.amazonaws.databrew#CreateScheduleResponse" - }, - "errors": [ - { - "target": "com.amazonaws.databrew#ConflictException" - }, - { - "target": "com.amazonaws.databrew#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.databrew#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a new schedule for one or more DataBrew jobs. Jobs can be run at a specific\n date and time, or at regular intervals.

", - "smithy.api#http": { - "method": "POST", - "uri": "/schedules", - "code": 200 - } - } - }, - "com.amazonaws.databrew#CreateScheduleRequest": { - "type": "structure", - "members": { - "JobNames": { - "target": "com.amazonaws.databrew#JobNameList", - "traits": { - "smithy.api#documentation": "

The name or names of one or more jobs to be run.

" - } - }, - "CronExpression": { - "target": "com.amazonaws.databrew#CronExpression", - "traits": { - "smithy.api#documentation": "

The date or dates and time or times when the jobs are to be run. For more information,\n see Cron\n expressions in the Glue DataBrew Developer\n Guide.

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

Metadata tags to apply to this schedule.

" - } - }, - "Name": { - "target": "com.amazonaws.databrew#ScheduleName", - "traits": { - "smithy.api#documentation": "

A unique name for the schedule. Valid characters are alphanumeric (A-Z, a-z, 0-9),\n hyphen (-), period (.), and space.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.databrew#CreateScheduleResponse": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.databrew#ScheduleName", - "traits": { - "smithy.api#documentation": "

The name of the schedule that was created.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.databrew#CreatedBy": { - "type": "string" - }, - "com.amazonaws.databrew#CronExpression": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 512 - } - } - }, - "com.amazonaws.databrew#CsvOptions": { - "type": "structure", - "members": { - "Delimiter": { - "target": "com.amazonaws.databrew#Delimiter", - "traits": { - "smithy.api#documentation": "

A single character that specifies the delimiter being used in the CSV file.

" - } - }, - "HeaderRow": { - "target": "com.amazonaws.databrew#HeaderRow", - "traits": { - "smithy.api#documentation": "

A variable that specifies whether the first row in the file is parsed as the\n header. If this value is false, column names are auto-generated.

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

Represents a set of options that define how DataBrew will read a \n comma-separated value (CSV) file when creating a dataset from that file.

" - } - }, - "com.amazonaws.databrew#CsvOutputOptions": { - "type": "structure", - "members": { - "Delimiter": { - "target": "com.amazonaws.databrew#Delimiter", - "traits": { - "smithy.api#documentation": "

A single character that specifies the delimiter used to create CSV job output.

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

Represents a set of options that define how DataBrew will write a \n comma-separated value (CSV) file.

" - } - }, - "com.amazonaws.databrew#DataCatalogInputDefinition": { - "type": "structure", - "members": { - "CatalogId": { - "target": "com.amazonaws.databrew#CatalogId", - "traits": { - "smithy.api#documentation": "

The unique identifier of the Amazon Web Services account that holds the Data Catalog that stores the\n data.

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

The name of a database in the Data Catalog.

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

The name of a database table in the Data Catalog. This table corresponds to a DataBrew\n dataset.

", - "smithy.api#required": {} - } - }, - "TempDirectory": { - "target": "com.amazonaws.databrew#S3Location", - "traits": { - "smithy.api#documentation": "

Represents an Amazon location where DataBrew can store intermediate results.

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

Represents how metadata stored in the Glue Data Catalog is defined in a DataBrew\n dataset.

" - } - }, - "com.amazonaws.databrew#DataCatalogOutput": { - "type": "structure", - "members": { - "CatalogId": { - "target": "com.amazonaws.databrew#CatalogId", - "traits": { - "smithy.api#documentation": "

The unique identifier of the Amazon Web Services account that holds the Data Catalog that \n stores the data.

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

The name of a database in the Data Catalog.

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

The name of a table in the Data Catalog.

", - "smithy.api#required": {} - } - }, - "S3Options": { - "target": "com.amazonaws.databrew#S3TableOutputOptions", - "traits": { - "smithy.api#documentation": "

Represents options that specify how and where DataBrew writes the Amazon S3 \n output generated by recipe jobs.

" - } - }, - "DatabaseOptions": { - "target": "com.amazonaws.databrew#DatabaseTableOutputOptions", - "traits": { - "smithy.api#documentation": "

Represents options that specify how and where DataBrew writes the database output \n generated by recipe jobs.

" - } - }, - "Overwrite": { - "target": "com.amazonaws.databrew#OverwriteOutput", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A value that, if true, means that any data in the location specified for output \n is overwritten with new output. Not supported with DatabaseOptions.

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

Represents options that specify how and where in the Glue Data Catalog DataBrew \n writes the output generated by recipe jobs.

" - } - }, - "com.amazonaws.databrew#DataCatalogOutputList": { - "type": "list", - "member": { - "target": "com.amazonaws.databrew#DataCatalogOutput" - }, - "traits": { - "smithy.api#length": { - "min": 1 - } - } - }, - "com.amazonaws.databrew#DatabaseInputDefinition": { - "type": "structure", - "members": { - "GlueConnectionName": { - "target": "com.amazonaws.databrew#GlueConnectionName", - "traits": { - "smithy.api#documentation": "

The Glue Connection that stores the connection information for the target\n database.

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

The table within the target database.

" - } - }, - "TempDirectory": { - "target": "com.amazonaws.databrew#S3Location" - }, - "QueryString": { - "target": "com.amazonaws.databrew#QueryString", - "traits": { - "smithy.api#documentation": "

Custom SQL to run against the provided Glue connection. This SQL will be used as \n the input for DataBrew projects and jobs.

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

Connection information for dataset input files stored in a database.

" - } - }, - "com.amazonaws.databrew#DatabaseName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 255 - } - } - }, - "com.amazonaws.databrew#DatabaseOutput": { - "type": "structure", - "members": { - "GlueConnectionName": { - "target": "com.amazonaws.databrew#GlueConnectionName", - "traits": { - "smithy.api#documentation": "

The Glue connection that stores the connection information for the \n target database.

", - "smithy.api#required": {} - } - }, - "DatabaseOptions": { - "target": "com.amazonaws.databrew#DatabaseTableOutputOptions", - "traits": { - "smithy.api#documentation": "

Represents options that specify how and where DataBrew writes the database output \n generated by recipe jobs.

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

The output mode to write into the database. Currently supported option: NEW_TABLE.

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

Represents a JDBC database output object which defines the output destination for \n a DataBrew recipe job to write into.

" - } - }, - "com.amazonaws.databrew#DatabaseOutputList": { - "type": "list", - "member": { - "target": "com.amazonaws.databrew#DatabaseOutput" - }, - "traits": { - "smithy.api#length": { - "min": 1 - } - } - }, - "com.amazonaws.databrew#DatabaseOutputMode": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "NEW_TABLE", - "name": "NEW_TABLE" - } - ] - } - }, - "com.amazonaws.databrew#DatabaseTableName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 255 - } - } - }, - "com.amazonaws.databrew#DatabaseTableOutputOptions": { - "type": "structure", - "members": { - "TempDirectory": { - "target": "com.amazonaws.databrew#S3Location", - "traits": { - "smithy.api#documentation": "

Represents an Amazon S3 location (bucket name and object key) where DataBrew can store \n intermediate results.

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

A prefix for the name of a table DataBrew will create in the database.

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

Represents options that specify how and where DataBrew writes the database \n output generated by recipe jobs.

" - } - }, - "com.amazonaws.databrew#Dataset": { - "type": "structure", - "members": { - "AccountId": { - "target": "com.amazonaws.databrew#AccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the dataset.

" - } - }, - "CreatedBy": { - "target": "com.amazonaws.databrew#CreatedBy", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the user who created the dataset.

" - } - }, - "CreateDate": { - "target": "com.amazonaws.databrew#Date", - "traits": { - "smithy.api#documentation": "

The date and time that the dataset was created.

" - } - }, - "Name": { - "target": "com.amazonaws.databrew#DatasetName", - "traits": { - "smithy.api#documentation": "

The unique name of the dataset.

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

The file format of a dataset that is created from an Amazon S3 file or folder.

" - } - }, - "FormatOptions": { - "target": "com.amazonaws.databrew#FormatOptions", - "traits": { - "smithy.api#documentation": "

A set of options that define how DataBrew interprets the data in the dataset.

" - } - }, - "Input": { - "target": "com.amazonaws.databrew#Input", - "traits": { - "smithy.api#documentation": "

Information on how DataBrew can find the dataset, in either the Glue Data Catalog\n or Amazon S3.

", - "smithy.api#required": {} - } - }, - "LastModifiedDate": { - "target": "com.amazonaws.databrew#Date", - "traits": { - "smithy.api#documentation": "

The last modification date and time of the dataset.

" - } - }, - "LastModifiedBy": { - "target": "com.amazonaws.databrew#LastModifiedBy", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the user who last modified the dataset.

" - } - }, - "Source": { - "target": "com.amazonaws.databrew#Source", - "traits": { - "smithy.api#documentation": "

The location of the data for the dataset, either Amazon S3 or the Glue Data Catalog.

" - } - }, - "PathOptions": { - "target": "com.amazonaws.databrew#PathOptions", - "traits": { - "smithy.api#documentation": "

A set of options that defines how DataBrew interprets an Amazon S3 \n path of the dataset.

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

Metadata tags that have been applied to the dataset.

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

The unique Amazon Resource Name (ARN) for the dataset.

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

Represents a dataset that can be processed by DataBrew.

" - } - }, - "com.amazonaws.databrew#DatasetList": { - "type": "list", - "member": { - "target": "com.amazonaws.databrew#Dataset" - } - }, - "com.amazonaws.databrew#DatasetName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 255 - } - } - }, - "com.amazonaws.databrew#DatasetParameter": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.databrew#PathParameterName", - "traits": { - "smithy.api#documentation": "

The name of the parameter that is used in the dataset's Amazon S3 path.

", - "smithy.api#required": {} - } - }, - "Type": { - "target": "com.amazonaws.databrew#ParameterType", - "traits": { - "smithy.api#documentation": "

The type of the dataset parameter, can be one of a 'String', 'Number' or 'Datetime'.

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

Additional parameter options such as a format and a timezone. Required for datetime parameters.

" - } - }, - "CreateColumn": { - "target": "com.amazonaws.databrew#CreateColumn", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Optional boolean value that defines whether the captured value of this parameter \n should be used to create a new column in a dataset.

" - } - }, - "Filter": { - "target": "com.amazonaws.databrew#FilterExpression", - "traits": { - "smithy.api#documentation": "

The optional filter expression structure to apply additional matching criteria to the parameter.

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

Represents a dataset parameter that defines type and conditions for a parameter in the\n Amazon S3 path of the dataset.

" - } - }, - "com.amazonaws.databrew#Date": { - "type": "timestamp" - }, - "com.amazonaws.databrew#DatetimeFormat": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 2, - "max": 100 - } - } - }, - "com.amazonaws.databrew#DatetimeOptions": { - "type": "structure", - "members": { - "Format": { - "target": "com.amazonaws.databrew#DatetimeFormat", - "traits": { - "smithy.api#documentation": "

Required option, that defines the datetime format used for a date parameter in the \n Amazon S3 path. Should use only supported datetime specifiers and separation characters, all \n literal a-z or A-Z characters should be escaped with single quotes. E.g. \"MM.dd.yyyy-'at'-HH:mm\".

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

Optional value for a timezone offset of the datetime parameter value in the Amazon S3 \n path. Shouldn't be used if Format for this parameter includes timezone fields.\n If no offset specified, UTC is assumed.

" - } - }, - "LocaleCode": { - "target": "com.amazonaws.databrew#LocaleCode", - "traits": { - "smithy.api#documentation": "

Optional value for a non-US locale code, needed for correct interpretation of some date formats.

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

Represents additional options for correct interpretation of datetime parameters used in \n the Amazon S3 path of a dataset.

" - } - }, - "com.amazonaws.databrew#DeleteDataset": { - "type": "operation", - "input": { - "target": "com.amazonaws.databrew#DeleteDatasetRequest" - }, - "output": { - "target": "com.amazonaws.databrew#DeleteDatasetResponse" - }, - "errors": [ - { - "target": "com.amazonaws.databrew#ConflictException" - }, - { - "target": "com.amazonaws.databrew#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.databrew#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes a dataset from DataBrew.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/datasets/{Name}", - "code": 200 - } - } - }, - "com.amazonaws.databrew#DeleteDatasetRequest": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.databrew#DatasetName", - "traits": { - "smithy.api#documentation": "

The name of the dataset to be deleted.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.databrew#DeleteDatasetResponse": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.databrew#DatasetName", - "traits": { - "smithy.api#documentation": "

The name of the dataset that you deleted.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.databrew#DeleteJob": { - "type": "operation", - "input": { - "target": "com.amazonaws.databrew#DeleteJobRequest" - }, - "output": { - "target": "com.amazonaws.databrew#DeleteJobResponse" - }, - "errors": [ - { - "target": "com.amazonaws.databrew#ConflictException" - }, - { - "target": "com.amazonaws.databrew#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.databrew#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes the specified DataBrew job.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/jobs/{Name}", - "code": 200 - } - } - }, - "com.amazonaws.databrew#DeleteJobRequest": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.databrew#JobName", - "traits": { - "smithy.api#documentation": "

The name of the job to be deleted.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.databrew#DeleteJobResponse": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.databrew#JobName", - "traits": { - "smithy.api#documentation": "

The name of the job that you deleted.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.databrew#DeleteProject": { - "type": "operation", - "input": { - "target": "com.amazonaws.databrew#DeleteProjectRequest" - }, - "output": { - "target": "com.amazonaws.databrew#DeleteProjectResponse" - }, - "errors": [ - { - "target": "com.amazonaws.databrew#ConflictException" - }, - { - "target": "com.amazonaws.databrew#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.databrew#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes an existing DataBrew project.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/projects/{Name}", - "code": 200 - } - } - }, - "com.amazonaws.databrew#DeleteProjectRequest": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.databrew#ProjectName", - "traits": { - "smithy.api#documentation": "

The name of the project to be deleted.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.databrew#DeleteProjectResponse": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.databrew#ProjectName", - "traits": { - "smithy.api#documentation": "

The name of the project that you deleted.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.databrew#DeleteRecipeVersion": { - "type": "operation", - "input": { - "target": "com.amazonaws.databrew#DeleteRecipeVersionRequest" - }, - "output": { - "target": "com.amazonaws.databrew#DeleteRecipeVersionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.databrew#ConflictException" - }, - { - "target": "com.amazonaws.databrew#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.databrew#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes a single version of a DataBrew recipe.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/recipes/{Name}/recipeVersion/{RecipeVersion}", - "code": 200 - } - } - }, - "com.amazonaws.databrew#DeleteRecipeVersionRequest": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.databrew#RecipeName", - "traits": { - "smithy.api#documentation": "

The name of the recipe.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "RecipeVersion": { - "target": "com.amazonaws.databrew#RecipeVersion", - "traits": { - "smithy.api#documentation": "

The version of the recipe to be deleted. You can specify a numeric versions\n (X.Y) or LATEST_WORKING. LATEST_PUBLISHED is\n not supported.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.databrew#DeleteRecipeVersionResponse": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.databrew#RecipeName", - "traits": { - "smithy.api#documentation": "

The name of the recipe that was deleted.

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

The version of the recipe that was deleted.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.databrew#DeleteRuleset": { - "type": "operation", - "input": { - "target": "com.amazonaws.databrew#DeleteRulesetRequest" - }, - "output": { - "target": "com.amazonaws.databrew#DeleteRulesetResponse" - }, - "errors": [ - { - "target": "com.amazonaws.databrew#ConflictException" - }, - { - "target": "com.amazonaws.databrew#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.databrew#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes a ruleset.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/rulesets/{Name}", - "code": 200 - } - } - }, - "com.amazonaws.databrew#DeleteRulesetRequest": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.databrew#RulesetName", - "traits": { - "smithy.api#documentation": "

The name of the ruleset to be deleted.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.databrew#DeleteRulesetResponse": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.databrew#RulesetName", - "traits": { - "smithy.api#documentation": "

The name of the deleted ruleset.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.databrew#DeleteSchedule": { - "type": "operation", - "input": { - "target": "com.amazonaws.databrew#DeleteScheduleRequest" - }, - "output": { - "target": "com.amazonaws.databrew#DeleteScheduleResponse" - }, - "errors": [ - { - "target": "com.amazonaws.databrew#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.databrew#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes the specified DataBrew schedule.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/schedules/{Name}", - "code": 200 - } - } - }, - "com.amazonaws.databrew#DeleteScheduleRequest": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.databrew#ScheduleName", - "traits": { - "smithy.api#documentation": "

The name of the schedule to be deleted.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.databrew#DeleteScheduleResponse": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.databrew#ScheduleName", - "traits": { - "smithy.api#documentation": "

The name of the schedule that was deleted.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.databrew#Delimiter": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1 - } - } - }, - "com.amazonaws.databrew#DescribeDataset": { - "type": "operation", - "input": { - "target": "com.amazonaws.databrew#DescribeDatasetRequest" - }, - "output": { - "target": "com.amazonaws.databrew#DescribeDatasetResponse" - }, - "errors": [ - { - "target": "com.amazonaws.databrew#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.databrew#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns the definition of a specific DataBrew dataset.

", - "smithy.api#http": { - "method": "GET", - "uri": "/datasets/{Name}", - "code": 200 - } - } - }, - "com.amazonaws.databrew#DescribeDatasetRequest": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.databrew#DatasetName", - "traits": { - "smithy.api#documentation": "

The name of the dataset to be described.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.databrew#DescribeDatasetResponse": { - "type": "structure", - "members": { - "CreatedBy": { - "target": "com.amazonaws.databrew#CreatedBy", - "traits": { - "smithy.api#documentation": "

The identifier (user name) of the user who created the dataset.

" - } - }, - "CreateDate": { - "target": "com.amazonaws.databrew#Date", - "traits": { - "smithy.api#documentation": "

The date and time that the dataset was created.

" - } - }, - "Name": { - "target": "com.amazonaws.databrew#DatasetName", - "traits": { - "smithy.api#documentation": "

The name of the dataset.

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

The file format of a dataset that is created from an Amazon S3 file \n or folder.

" - } - }, - "FormatOptions": { - "target": "com.amazonaws.databrew#FormatOptions" - }, - "Input": { - "target": "com.amazonaws.databrew#Input", - "traits": { - "smithy.api#required": {} - } - }, - "LastModifiedDate": { - "target": "com.amazonaws.databrew#Date", - "traits": { - "smithy.api#documentation": "

The date and time that the dataset was last modified.

" - } - }, - "LastModifiedBy": { - "target": "com.amazonaws.databrew#LastModifiedBy", - "traits": { - "smithy.api#documentation": "

The identifier (user name) of the user who last modified the dataset.

" - } - }, - "Source": { - "target": "com.amazonaws.databrew#Source", - "traits": { - "smithy.api#documentation": "

The location of the data for this dataset, Amazon S3 or the \n Glue Data Catalog.

" - } - }, - "PathOptions": { - "target": "com.amazonaws.databrew#PathOptions", - "traits": { - "smithy.api#documentation": "

A set of options that defines how DataBrew interprets an Amazon S3 \n path of the dataset.

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

Metadata tags associated with this dataset.

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

The Amazon Resource Name (ARN) of the dataset.

" - } - } - } - }, - "com.amazonaws.databrew#DescribeJob": { - "type": "operation", - "input": { - "target": "com.amazonaws.databrew#DescribeJobRequest" - }, - "output": { - "target": "com.amazonaws.databrew#DescribeJobResponse" - }, - "errors": [ - { - "target": "com.amazonaws.databrew#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.databrew#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns the definition of a specific DataBrew job.

", - "smithy.api#http": { - "method": "GET", - "uri": "/jobs/{Name}", - "code": 200 - } - } - }, - "com.amazonaws.databrew#DescribeJobRequest": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.databrew#JobName", - "traits": { - "smithy.api#documentation": "

The name of the job to be described.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.databrew#DescribeJobResponse": { - "type": "structure", - "members": { - "CreateDate": { - "target": "com.amazonaws.databrew#Date", - "traits": { - "smithy.api#documentation": "

The date and time that the job was created.

" - } - }, - "CreatedBy": { - "target": "com.amazonaws.databrew#CreatedBy", - "traits": { - "smithy.api#documentation": "

The identifier (user name) of the user associated with the creation of the job.

" - } - }, - "DatasetName": { - "target": "com.amazonaws.databrew#DatasetName", - "traits": { - "smithy.api#documentation": "

The dataset that the job acts upon.

" - } - }, - "EncryptionKeyArn": { - "target": "com.amazonaws.databrew#EncryptionKeyArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an encryption key that is used to protect the\n job.

" - } - }, - "EncryptionMode": { - "target": "com.amazonaws.databrew#EncryptionMode", - "traits": { - "smithy.api#documentation": "

The encryption mode for the job, which can be one of the following:

\n " - } - }, - "Name": { - "target": "com.amazonaws.databrew#JobName", - "traits": { - "smithy.api#documentation": "

The name of the job.

", - "smithy.api#required": {} - } - }, - "Type": { - "target": "com.amazonaws.databrew#JobType", - "traits": { - "smithy.api#documentation": "

The job type, which must be one of the following:

\n " - } - }, - "LastModifiedBy": { - "target": "com.amazonaws.databrew#LastModifiedBy", - "traits": { - "smithy.api#documentation": "

The identifier (user name) of the user who last modified the job.

" - } - }, - "LastModifiedDate": { - "target": "com.amazonaws.databrew#Date", - "traits": { - "smithy.api#documentation": "

The date and time that the job was last modified.

" - } - }, - "LogSubscription": { - "target": "com.amazonaws.databrew#LogSubscription", - "traits": { - "smithy.api#documentation": "

Indicates whether Amazon CloudWatch logging is enabled for this job.

" - } - }, - "MaxCapacity": { - "target": "com.amazonaws.databrew#MaxCapacity", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of compute nodes that DataBrew can consume when the job processes\n data.

" - } - }, - "MaxRetries": { - "target": "com.amazonaws.databrew#MaxRetries", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of times to retry the job after a job run fails.

" - } - }, - "Outputs": { - "target": "com.amazonaws.databrew#OutputList", - "traits": { - "smithy.api#documentation": "

One or more artifacts that represent the output from running the job.

" - } - }, - "DataCatalogOutputs": { - "target": "com.amazonaws.databrew#DataCatalogOutputList", - "traits": { - "smithy.api#documentation": "

One or more artifacts that represent the Glue Data Catalog output from running the job.

" - } - }, - "DatabaseOutputs": { - "target": "com.amazonaws.databrew#DatabaseOutputList", - "traits": { - "smithy.api#documentation": "

Represents a list of JDBC database output objects which defines the output \n destination for a DataBrew recipe job to write into.

" - } - }, - "ProjectName": { - "target": "com.amazonaws.databrew#ProjectName", - "traits": { - "smithy.api#documentation": "

The DataBrew project associated with this job.

" - } - }, - "ProfileConfiguration": { - "target": "com.amazonaws.databrew#ProfileConfiguration", - "traits": { - "smithy.api#documentation": "

Configuration for profile jobs. Used to select columns, do evaluations, \n and override default parameters of evaluations. When configuration is null, the\n profile job will run with default settings.

" - } - }, - "ValidationConfigurations": { - "target": "com.amazonaws.databrew#ValidationConfigurationList", - "traits": { - "smithy.api#documentation": "

List of validation configurations that are applied to the profile job.

" - } - }, - "RecipeReference": { - "target": "com.amazonaws.databrew#RecipeReference" - }, - "ResourceArn": { - "target": "com.amazonaws.databrew#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the job.

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

The ARN of the Identity and Access Management (IAM) role to be assumed when\n DataBrew runs the job.

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

Metadata tags associated with this job.

" - } - }, - "Timeout": { - "target": "com.amazonaws.databrew#Timeout", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The job's timeout in minutes. A job that attempts to run longer than this timeout\n period ends with a status of TIMEOUT.

" - } - }, - "JobSample": { - "target": "com.amazonaws.databrew#JobSample", - "traits": { - "smithy.api#documentation": "

Sample configuration for profile jobs only. Determines the number of rows on which the\n profile job will be executed.

" - } - } - } - }, - "com.amazonaws.databrew#DescribeJobRun": { - "type": "operation", - "input": { - "target": "com.amazonaws.databrew#DescribeJobRunRequest" - }, - "output": { - "target": "com.amazonaws.databrew#DescribeJobRunResponse" - }, - "errors": [ - { - "target": "com.amazonaws.databrew#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.databrew#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Represents one run of a DataBrew job.

", - "smithy.api#http": { - "method": "GET", - "uri": "/jobs/{Name}/jobRun/{RunId}", - "code": 200 - } - } - }, - "com.amazonaws.databrew#DescribeJobRunRequest": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.databrew#JobName", - "traits": { - "smithy.api#documentation": "

The name of the job being processed during this run.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "RunId": { - "target": "com.amazonaws.databrew#JobRunId", - "traits": { - "smithy.api#documentation": "

The unique identifier of the job run.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.databrew#DescribeJobRunResponse": { - "type": "structure", - "members": { - "Attempt": { - "target": "com.amazonaws.databrew#Attempt", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of times that DataBrew has attempted to run the job.

" - } - }, - "CompletedOn": { - "target": "com.amazonaws.databrew#Date", - "traits": { - "smithy.api#documentation": "

The date and time when the job completed processing.

" - } - }, - "DatasetName": { - "target": "com.amazonaws.databrew#DatasetName", - "traits": { - "smithy.api#documentation": "

The name of the dataset for the job to process.

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

A message indicating an error (if any) that was encountered when the job ran.

" - } - }, - "ExecutionTime": { - "target": "com.amazonaws.databrew#ExecutionTime", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The amount of time, in seconds, during which the job run consumed resources.

" - } - }, - "JobName": { - "target": "com.amazonaws.databrew#JobName", - "traits": { - "smithy.api#documentation": "

The name of the job being processed during this run.

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

Configuration for profile jobs. Used to select columns, do evaluations, \n and override default parameters of evaluations. When configuration is null, the\n profile job will run with default settings.

" - } - }, - "ValidationConfigurations": { - "target": "com.amazonaws.databrew#ValidationConfigurationList", - "traits": { - "smithy.api#documentation": "

List of validation configurations that are applied to the profile job.

" - } - }, - "RunId": { - "target": "com.amazonaws.databrew#JobRunId", - "traits": { - "smithy.api#documentation": "

The unique identifier of the job run.

" - } - }, - "State": { - "target": "com.amazonaws.databrew#JobRunState", - "traits": { - "smithy.api#documentation": "

The current state of the job run entity itself.

" - } - }, - "LogSubscription": { - "target": "com.amazonaws.databrew#LogSubscription", - "traits": { - "smithy.api#documentation": "

The current status of Amazon CloudWatch logging for the job run.

" - } - }, - "LogGroupName": { - "target": "com.amazonaws.databrew#LogGroupName", - "traits": { - "smithy.api#documentation": "

The name of an Amazon CloudWatch log group, where the job writes diagnostic messages\n when it runs.

" - } - }, - "Outputs": { - "target": "com.amazonaws.databrew#OutputList", - "traits": { - "smithy.api#documentation": "

One or more output artifacts from a job run.

" - } - }, - "DataCatalogOutputs": { - "target": "com.amazonaws.databrew#DataCatalogOutputList", - "traits": { - "smithy.api#documentation": "

One or more artifacts that represent the Glue Data Catalog output from running the job.

" - } - }, - "DatabaseOutputs": { - "target": "com.amazonaws.databrew#DatabaseOutputList", - "traits": { - "smithy.api#documentation": "

Represents a list of JDBC database output objects which defines the output \n destination for a DataBrew recipe job to write into.

" - } - }, - "RecipeReference": { - "target": "com.amazonaws.databrew#RecipeReference" - }, - "StartedBy": { - "target": "com.amazonaws.databrew#StartedBy", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the user who started the job run.

" - } - }, - "StartedOn": { - "target": "com.amazonaws.databrew#Date", - "traits": { - "smithy.api#documentation": "

The date and time when the job run began.

" - } - }, - "JobSample": { - "target": "com.amazonaws.databrew#JobSample", - "traits": { - "smithy.api#documentation": "

Sample configuration for profile jobs only. Determines the number of rows on which the\n profile job will be executed. If a JobSample value is not provided, the default value\n will be used. The default value is CUSTOM_ROWS for the mode parameter and 20000 for the\n size parameter.

" - } - } - } - }, - "com.amazonaws.databrew#DescribeProject": { - "type": "operation", - "input": { - "target": "com.amazonaws.databrew#DescribeProjectRequest" - }, - "output": { - "target": "com.amazonaws.databrew#DescribeProjectResponse" - }, - "errors": [ - { - "target": "com.amazonaws.databrew#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.databrew#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns the definition of a specific DataBrew project.

", - "smithy.api#http": { - "method": "GET", - "uri": "/projects/{Name}", - "code": 200 - } - } - }, - "com.amazonaws.databrew#DescribeProjectRequest": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.databrew#ProjectName", - "traits": { - "smithy.api#documentation": "

The name of the project to be described.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.databrew#DescribeProjectResponse": { - "type": "structure", - "members": { - "CreateDate": { - "target": "com.amazonaws.databrew#Date", - "traits": { - "smithy.api#documentation": "

The date and time that the project was created.

" - } - }, - "CreatedBy": { - "target": "com.amazonaws.databrew#CreatedBy", - "traits": { - "smithy.api#documentation": "

The identifier (user name) of the user who created the project.

" - } - }, - "DatasetName": { - "target": "com.amazonaws.databrew#DatasetName", - "traits": { - "smithy.api#documentation": "

The dataset associated with the project.

" - } - }, - "LastModifiedDate": { - "target": "com.amazonaws.databrew#Date", - "traits": { - "smithy.api#documentation": "

The date and time that the project was last modified.

" - } - }, - "LastModifiedBy": { - "target": "com.amazonaws.databrew#LastModifiedBy", - "traits": { - "smithy.api#documentation": "

The identifier (user name) of the user who last modified the project.

" - } - }, - "Name": { - "target": "com.amazonaws.databrew#ProjectName", - "traits": { - "smithy.api#documentation": "

The name of the project.

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

The recipe associated with this job.

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

The Amazon Resource Name (ARN) of the project.

" - } - }, - "Sample": { - "target": "com.amazonaws.databrew#Sample" - }, - "RoleArn": { - "target": "com.amazonaws.databrew#Arn", - "traits": { - "smithy.api#documentation": "

The ARN of the Identity and Access Management (IAM) role to be assumed when\n DataBrew runs the job.

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

Metadata tags associated with this project.

" - } - }, - "SessionStatus": { - "target": "com.amazonaws.databrew#SessionStatus", - "traits": { - "smithy.api#documentation": "

Describes the current state of the session:

\n " - } - }, - "OpenedBy": { - "target": "com.amazonaws.databrew#OpenedBy", - "traits": { - "smithy.api#documentation": "

The identifier (user name) of the user that opened the project for use.

" - } - }, - "OpenDate": { - "target": "com.amazonaws.databrew#Date", - "traits": { - "smithy.api#documentation": "

The date and time when the project was opened.

" - } - } - } - }, - "com.amazonaws.databrew#DescribeRecipe": { - "type": "operation", - "input": { - "target": "com.amazonaws.databrew#DescribeRecipeRequest" - }, - "output": { - "target": "com.amazonaws.databrew#DescribeRecipeResponse" - }, - "errors": [ - { - "target": "com.amazonaws.databrew#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.databrew#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns the definition of a specific DataBrew recipe corresponding to a particular\n version.

", - "smithy.api#http": { - "method": "GET", - "uri": "/recipes/{Name}", - "code": 200 - } - } - }, - "com.amazonaws.databrew#DescribeRecipeRequest": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.databrew#RecipeName", - "traits": { - "smithy.api#documentation": "

The name of the recipe to be described.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "RecipeVersion": { - "target": "com.amazonaws.databrew#RecipeVersion", - "traits": { - "smithy.api#documentation": "

The recipe version identifier. If this parameter isn't specified, then the latest\n published version is returned.

", - "smithy.api#httpQuery": "recipeVersion" - } - } - } - }, - "com.amazonaws.databrew#DescribeRecipeResponse": { - "type": "structure", - "members": { - "CreatedBy": { - "target": "com.amazonaws.databrew#CreatedBy", - "traits": { - "smithy.api#documentation": "

The identifier (user name) of the user who created the recipe.

" - } - }, - "CreateDate": { - "target": "com.amazonaws.databrew#Date", - "traits": { - "smithy.api#documentation": "

The date and time that the recipe was created.

" - } - }, - "LastModifiedBy": { - "target": "com.amazonaws.databrew#LastModifiedBy", - "traits": { - "smithy.api#documentation": "

The identifier (user name) of the user who last modified the recipe.

" - } - }, - "LastModifiedDate": { - "target": "com.amazonaws.databrew#Date", - "traits": { - "smithy.api#documentation": "

The date and time that the recipe was last modified.

" - } - }, - "ProjectName": { - "target": "com.amazonaws.databrew#ProjectName", - "traits": { - "smithy.api#documentation": "

The name of the project associated with this recipe.

" - } - }, - "PublishedBy": { - "target": "com.amazonaws.databrew#PublishedBy", - "traits": { - "smithy.api#documentation": "

The identifier (user name) of the user who last published the recipe.

" - } - }, - "PublishedDate": { - "target": "com.amazonaws.databrew#Date", - "traits": { - "smithy.api#documentation": "

The date and time when the recipe was last published.

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

The description of the recipe.

" - } - }, - "Name": { - "target": "com.amazonaws.databrew#RecipeName", - "traits": { - "smithy.api#documentation": "

The name of the recipe.

", - "smithy.api#required": {} - } - }, - "Steps": { - "target": "com.amazonaws.databrew#RecipeStepList", - "traits": { - "smithy.api#documentation": "

One or more steps to be performed by the recipe. Each step consists of an action, and\n the conditions under which the action should succeed.

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

Metadata tags associated with this project.

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

The ARN of the recipe.

" - } - }, - "RecipeVersion": { - "target": "com.amazonaws.databrew#RecipeVersion", - "traits": { - "smithy.api#documentation": "

The recipe version identifier.

" - } - } - } - }, - "com.amazonaws.databrew#DescribeRuleset": { - "type": "operation", - "input": { - "target": "com.amazonaws.databrew#DescribeRulesetRequest" - }, - "output": { - "target": "com.amazonaws.databrew#DescribeRulesetResponse" - }, - "errors": [ - { - "target": "com.amazonaws.databrew#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.databrew#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Retrieves detailed information about the ruleset.

", - "smithy.api#http": { - "method": "GET", - "uri": "/rulesets/{Name}", - "code": 200 - } - } - }, - "com.amazonaws.databrew#DescribeRulesetRequest": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.databrew#RulesetName", - "traits": { - "smithy.api#documentation": "

The name of the ruleset to be described.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.databrew#DescribeRulesetResponse": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.databrew#RulesetName", - "traits": { - "smithy.api#documentation": "

The name of the ruleset.

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

The description of the ruleset.

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

The Amazon Resource Name (ARN) of a resource (dataset) that the ruleset is \n associated with.

" - } - }, - "Rules": { - "target": "com.amazonaws.databrew#RuleList", - "traits": { - "smithy.api#documentation": "

A list of rules that are defined with the ruleset. A rule includes one \n or more checks to be validated on a DataBrew dataset.

" - } - }, - "CreateDate": { - "target": "com.amazonaws.databrew#Date", - "traits": { - "smithy.api#documentation": "

The date and time that the ruleset was created.

" - } - }, - "CreatedBy": { - "target": "com.amazonaws.databrew#CreatedBy", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the user who created the ruleset.

" - } - }, - "LastModifiedBy": { - "target": "com.amazonaws.databrew#LastModifiedBy", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the user who last modified the ruleset.

" - } - }, - "LastModifiedDate": { - "target": "com.amazonaws.databrew#Date", - "traits": { - "smithy.api#documentation": "

The modification date and time of the ruleset.

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

The Amazon Resource Name (ARN) for the ruleset.

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

Metadata tags that have been applied to the ruleset.

" - } - } - } - }, - "com.amazonaws.databrew#DescribeSchedule": { - "type": "operation", - "input": { - "target": "com.amazonaws.databrew#DescribeScheduleRequest" - }, - "output": { - "target": "com.amazonaws.databrew#DescribeScheduleResponse" - }, - "errors": [ - { - "target": "com.amazonaws.databrew#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.databrew#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns the definition of a specific DataBrew schedule.

", - "smithy.api#http": { - "method": "GET", - "uri": "/schedules/{Name}", - "code": 200 - } - } - }, - "com.amazonaws.databrew#DescribeScheduleRequest": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.databrew#ScheduleName", - "traits": { - "smithy.api#documentation": "

The name of the schedule to be described.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.databrew#DescribeScheduleResponse": { - "type": "structure", - "members": { - "CreateDate": { - "target": "com.amazonaws.databrew#Date", - "traits": { - "smithy.api#documentation": "

The date and time that the schedule was created.

" - } - }, - "CreatedBy": { - "target": "com.amazonaws.databrew#CreatedBy", - "traits": { - "smithy.api#documentation": "

The identifier (user name) of the user who created the schedule.

" - } - }, - "JobNames": { - "target": "com.amazonaws.databrew#JobNameList", - "traits": { - "smithy.api#documentation": "

The name or names of one or more jobs to be run by using the schedule.

" - } - }, - "LastModifiedBy": { - "target": "com.amazonaws.databrew#LastModifiedBy", - "traits": { - "smithy.api#documentation": "

The identifier (user name) of the user who last modified the schedule.

" - } - }, - "LastModifiedDate": { - "target": "com.amazonaws.databrew#Date", - "traits": { - "smithy.api#documentation": "

The date and time that the schedule was last modified.

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

The Amazon Resource Name (ARN) of the schedule.

" - } - }, - "CronExpression": { - "target": "com.amazonaws.databrew#CronExpression", - "traits": { - "smithy.api#documentation": "

The date or dates and time or times when the jobs are to be run for the schedule. For\n more information, see Cron expressions in the\n Glue DataBrew Developer Guide.

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

Metadata tags associated with this schedule.

" - } - }, - "Name": { - "target": "com.amazonaws.databrew#ScheduleName", - "traits": { - "smithy.api#documentation": "

The name of the schedule.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.databrew#Disabled": { - "type": "boolean", - "traits": { - "smithy.api#default": false - } - }, - "com.amazonaws.databrew#EncryptionKeyArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 20, - "max": 2048 - } - } - }, - "com.amazonaws.databrew#EncryptionMode": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "SSE-KMS", - "name": "SSEKMS" - }, - { - "value": "SSE-S3", - "name": "SSES3" - } - ] - } - }, - "com.amazonaws.databrew#EntityDetectorConfiguration": { - "type": "structure", - "members": { - "EntityTypes": { - "target": "com.amazonaws.databrew#EntityTypeList", - "traits": { - "smithy.api#documentation": "

Entity types to detect. Can be any of the following:

\n \n

The Entity type group USA_ALL is also supported, and includes all of the \n above entity types except PERSON_NAME and DATE.

", - "smithy.api#required": {} - } - }, - "AllowedStatistics": { - "target": "com.amazonaws.databrew#AllowedStatisticList", - "traits": { - "smithy.api#documentation": "

Configuration of statistics that are allowed to be run on columns that \n contain detected entities. When undefined, no statistics will be computed \n on columns that contain detected entities.

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

Configuration of entity detection for a profile job. When undefined, entity \n detection is disabled.

" - } - }, - "com.amazonaws.databrew#EntityType": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - }, - "smithy.api#pattern": "^[A-Z_][A-Z\\\\d_]*$" - } - }, - "com.amazonaws.databrew#EntityTypeList": { - "type": "list", - "member": { - "target": "com.amazonaws.databrew#EntityType" - }, - "traits": { - "smithy.api#length": { - "min": 1 - } - } - }, - "com.amazonaws.databrew#ErrorCode": { - "type": "string", - "traits": { - "smithy.api#pattern": "^[1-5][0-9][0-9]$" - } - }, - "com.amazonaws.databrew#ExcelOptions": { - "type": "structure", - "members": { - "SheetNames": { - "target": "com.amazonaws.databrew#SheetNameList", - "traits": { - "smithy.api#documentation": "

One or more named sheets in the Excel file that will be included in the dataset.

" - } - }, - "SheetIndexes": { - "target": "com.amazonaws.databrew#SheetIndexList", - "traits": { - "smithy.api#documentation": "

One or more sheet numbers in the Excel file that will be included in the\n dataset.

" - } - }, - "HeaderRow": { - "target": "com.amazonaws.databrew#HeaderRow", - "traits": { - "smithy.api#documentation": "

A variable that specifies whether the first row in the file is parsed as the\n header. If this value is false, column names are auto-generated.

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

Represents a set of options that define how DataBrew will interpret a Microsoft Excel file when \n creating a dataset from that file.

" - } - }, - "com.amazonaws.databrew#ExecutionTime": { - "type": "integer", - "traits": { - "smithy.api#default": 0 - } - }, - "com.amazonaws.databrew#Expression": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 4, - "max": 1024 - }, - "smithy.api#pattern": "^[<>0-9A-Za-z_.,:)(!= ]+$" - } - }, - "com.amazonaws.databrew#FilesLimit": { - "type": "structure", - "members": { - "MaxFiles": { - "target": "com.amazonaws.databrew#MaxFiles", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of Amazon S3 files to select.

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

A criteria to use for Amazon S3 files sorting before their selection. By default uses LAST_MODIFIED_DATE as \n a sorting criteria. Currently it's the only allowed value.

" - } - }, - "Order": { - "target": "com.amazonaws.databrew#Order", - "traits": { - "smithy.api#documentation": "

A criteria to use for Amazon S3 files sorting before their selection. By\n default uses DESCENDING order, i.e. most recent files are selected first. Another\n possible value is ASCENDING.

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

Represents a limit imposed on number of Amazon S3 files that should be selected for a \n dataset from a connected Amazon S3 path.

" - } - }, - "com.amazonaws.databrew#FilterExpression": { - "type": "structure", - "members": { - "Expression": { - "target": "com.amazonaws.databrew#Expression", - "traits": { - "smithy.api#documentation": "

The expression which includes condition names followed by substitution variables, possibly grouped \n and combined with other conditions. For example, \"(starts_with :prefix1 or starts_with :prefix2) and \n (ends_with :suffix1 or ends_with :suffix2)\". Substitution variables should start with ':' symbol.

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

The map of substitution variable names to their values used in this filter expression.

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

Represents a structure for defining parameter conditions. Supported conditions are described\n here: Supported \n conditions for dynamic datasets in the \n Glue DataBrew Developer Guide.

" - } - }, - "com.amazonaws.databrew#FormatOptions": { - "type": "structure", - "members": { - "Json": { - "target": "com.amazonaws.databrew#JsonOptions", - "traits": { - "smithy.api#documentation": "

Options that define how JSON input is to be interpreted by DataBrew.

" - } - }, - "Excel": { - "target": "com.amazonaws.databrew#ExcelOptions", - "traits": { - "smithy.api#documentation": "

Options that define how Excel input is to be interpreted by DataBrew.

" - } - }, - "Csv": { - "target": "com.amazonaws.databrew#CsvOptions", - "traits": { - "smithy.api#documentation": "

Options that define how CSV input is to be interpreted by DataBrew.

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

Represents a set of options that define the structure of either comma-separated value (CSV),\n Excel, or JSON input.

" - } - }, - "com.amazonaws.databrew#GlueConnectionName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 255 - } - } - }, - "com.amazonaws.databrew#HeaderRow": { - "type": "boolean" - }, - "com.amazonaws.databrew#HiddenColumnList": { - "type": "list", - "member": { - "target": "com.amazonaws.databrew#ColumnName" - } - }, - "com.amazonaws.databrew#Input": { - "type": "structure", - "members": { - "S3InputDefinition": { - "target": "com.amazonaws.databrew#S3Location", - "traits": { - "smithy.api#documentation": "

The Amazon S3 location where the data is stored.

" - } - }, - "DataCatalogInputDefinition": { - "target": "com.amazonaws.databrew#DataCatalogInputDefinition", - "traits": { - "smithy.api#documentation": "

The Glue Data Catalog parameters for the data.

" - } - }, - "DatabaseInputDefinition": { - "target": "com.amazonaws.databrew#DatabaseInputDefinition", - "traits": { - "smithy.api#documentation": "

Connection information for dataset input files stored in a database.

" - } - }, - "Metadata": { - "target": "com.amazonaws.databrew#Metadata", - "traits": { - "smithy.api#documentation": "

Contains additional resource information needed for specific datasets.

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

Represents information on how DataBrew can find data, in either the Glue Data Catalog or\n Amazon S3.

" - } - }, - "com.amazonaws.databrew#InputFormat": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "CSV", - "name": "CSV" - }, - { - "value": "JSON", - "name": "JSON" - }, - { - "value": "PARQUET", - "name": "PARQUET" - }, - { - "value": "EXCEL", - "name": "EXCEL" - }, - { - "value": "ORC", - "name": "ORC" - } - ] - } - }, - "com.amazonaws.databrew#InternalServerException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.databrew#Message" - } - }, - "traits": { - "smithy.api#documentation": "

An internal service failure occurred.

", - "smithy.api#error": "server", - "smithy.api#httpError": 500 - } - }, - "com.amazonaws.databrew#Job": { - "type": "structure", - "members": { - "AccountId": { - "target": "com.amazonaws.databrew#AccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the job.

" - } - }, - "CreatedBy": { - "target": "com.amazonaws.databrew#CreatedBy", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the user who created the job.

" - } - }, - "CreateDate": { - "target": "com.amazonaws.databrew#Date", - "traits": { - "smithy.api#documentation": "

The date and time that the job was created.

" - } - }, - "DatasetName": { - "target": "com.amazonaws.databrew#DatasetName", - "traits": { - "smithy.api#documentation": "

A dataset that the job is to process.

" - } - }, - "EncryptionKeyArn": { - "target": "com.amazonaws.databrew#EncryptionKeyArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an encryption key that is used to protect the job\n output. For more information, see Encrypting data\n written by DataBrew jobs\n

" - } - }, - "EncryptionMode": { - "target": "com.amazonaws.databrew#EncryptionMode", - "traits": { - "smithy.api#documentation": "

The encryption mode for the job, which can be one of the following:

\n " - } - }, - "Name": { - "target": "com.amazonaws.databrew#JobName", - "traits": { - "smithy.api#documentation": "

The unique name of the job.

", - "smithy.api#required": {} - } - }, - "Type": { - "target": "com.amazonaws.databrew#JobType", - "traits": { - "smithy.api#documentation": "

The job type of the job, which must be one of the following:

\n " - } - }, - "LastModifiedBy": { - "target": "com.amazonaws.databrew#LastModifiedBy", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the user who last modified the job.

" - } - }, - "LastModifiedDate": { - "target": "com.amazonaws.databrew#Date", - "traits": { - "smithy.api#documentation": "

The modification date and time of the job.

" - } - }, - "LogSubscription": { - "target": "com.amazonaws.databrew#LogSubscription", - "traits": { - "smithy.api#documentation": "

The current status of Amazon CloudWatch logging for the job.

" - } - }, - "MaxCapacity": { - "target": "com.amazonaws.databrew#MaxCapacity", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of nodes that can be consumed when the job processes data.

" - } - }, - "MaxRetries": { - "target": "com.amazonaws.databrew#MaxRetries", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of times to retry the job after a job run fails.

" - } - }, - "Outputs": { - "target": "com.amazonaws.databrew#OutputList", - "traits": { - "smithy.api#documentation": "

One or more artifacts that represent output from running the job.

" - } - }, - "DataCatalogOutputs": { - "target": "com.amazonaws.databrew#DataCatalogOutputList", - "traits": { - "smithy.api#documentation": "

One or more artifacts that represent the Glue Data Catalog output \n from running the job.

" - } - }, - "DatabaseOutputs": { - "target": "com.amazonaws.databrew#DatabaseOutputList", - "traits": { - "smithy.api#documentation": "

Represents a list of JDBC database output objects which defines the output \n destination for a DataBrew recipe job to write into.

" - } - }, - "ProjectName": { - "target": "com.amazonaws.databrew#ProjectName", - "traits": { - "smithy.api#documentation": "

The name of the project that the job is associated with.

" - } - }, - "RecipeReference": { - "target": "com.amazonaws.databrew#RecipeReference", - "traits": { - "smithy.api#documentation": "

A set of steps that the job runs.

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

The unique Amazon Resource Name (ARN) for the job.

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

The Amazon Resource Name (ARN) of the role to be assumed for this job.

" - } - }, - "Timeout": { - "target": "com.amazonaws.databrew#Timeout", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The job's timeout in minutes. A job that attempts to run longer than this timeout\n period ends with a status of TIMEOUT.

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

Metadata tags that have been applied to the job.

" - } - }, - "JobSample": { - "target": "com.amazonaws.databrew#JobSample", - "traits": { - "smithy.api#documentation": "

A sample configuration for profile jobs only, which determines the number of rows on which the\n profile job is run. If a JobSample value isn't provided, the default value\n is used. The default value is CUSTOM_ROWS for the mode parameter and 20,000 for the\n size parameter.

" - } - }, - "ValidationConfigurations": { - "target": "com.amazonaws.databrew#ValidationConfigurationList", - "traits": { - "smithy.api#documentation": "

List of validation configurations that are applied to the profile job.

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

Represents all of the attributes of a DataBrew job.

" - } - }, - "com.amazonaws.databrew#JobList": { - "type": "list", - "member": { - "target": "com.amazonaws.databrew#Job" - } - }, - "com.amazonaws.databrew#JobName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 240 - } - } - }, - "com.amazonaws.databrew#JobNameList": { - "type": "list", - "member": { - "target": "com.amazonaws.databrew#JobName" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 50 - } - } - }, - "com.amazonaws.databrew#JobRun": { - "type": "structure", - "members": { - "Attempt": { - "target": "com.amazonaws.databrew#Attempt", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of times that DataBrew has attempted to run the job.

" - } - }, - "CompletedOn": { - "target": "com.amazonaws.databrew#Date", - "traits": { - "smithy.api#documentation": "

The date and time when the job completed processing.

" - } - }, - "DatasetName": { - "target": "com.amazonaws.databrew#DatasetName", - "traits": { - "smithy.api#documentation": "

The name of the dataset for the job to process.

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

A message indicating an error (if any) that was encountered when the job ran.

" - } - }, - "ExecutionTime": { - "target": "com.amazonaws.databrew#ExecutionTime", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The amount of time, in seconds, during which a job run consumed resources.

" - } - }, - "JobName": { - "target": "com.amazonaws.databrew#JobName", - "traits": { - "smithy.api#documentation": "

The name of the job being processed during this run.

" - } - }, - "RunId": { - "target": "com.amazonaws.databrew#JobRunId", - "traits": { - "smithy.api#documentation": "

The unique identifier of the job run.

" - } - }, - "State": { - "target": "com.amazonaws.databrew#JobRunState", - "traits": { - "smithy.api#documentation": "

The current state of the job run entity itself.

" - } - }, - "LogSubscription": { - "target": "com.amazonaws.databrew#LogSubscription", - "traits": { - "smithy.api#documentation": "

The current status of Amazon CloudWatch logging for the job run.

" - } - }, - "LogGroupName": { - "target": "com.amazonaws.databrew#LogGroupName", - "traits": { - "smithy.api#documentation": "

The name of an Amazon CloudWatch log group, where the job writes diagnostic messages\n when it runs.

" - } - }, - "Outputs": { - "target": "com.amazonaws.databrew#OutputList", - "traits": { - "smithy.api#documentation": "

One or more output artifacts from a job run.

" - } - }, - "DataCatalogOutputs": { - "target": "com.amazonaws.databrew#DataCatalogOutputList", - "traits": { - "smithy.api#documentation": "

One or more artifacts that represent the Glue Data Catalog output \n from running the job.

" - } - }, - "DatabaseOutputs": { - "target": "com.amazonaws.databrew#DatabaseOutputList", - "traits": { - "smithy.api#documentation": "

Represents a list of JDBC database output objects which defines the output \n destination for a DataBrew recipe job to write into.

" - } - }, - "RecipeReference": { - "target": "com.amazonaws.databrew#RecipeReference", - "traits": { - "smithy.api#documentation": "

The set of steps processed by the job.

" - } - }, - "StartedBy": { - "target": "com.amazonaws.databrew#StartedBy", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the user who initiated the job run.

" - } - }, - "StartedOn": { - "target": "com.amazonaws.databrew#Date", - "traits": { - "smithy.api#documentation": "

The date and time when the job run began.

" - } - }, - "JobSample": { - "target": "com.amazonaws.databrew#JobSample", - "traits": { - "smithy.api#documentation": "

A sample configuration for profile jobs only, which determines the number of rows on which the\n profile job is run. If a JobSample value isn't provided, the default\n is used. The default value is CUSTOM_ROWS for the mode parameter and 20,000 for the\n size parameter.

" - } - }, - "ValidationConfigurations": { - "target": "com.amazonaws.databrew#ValidationConfigurationList", - "traits": { - "smithy.api#documentation": "

List of validation configurations that are applied to the profile job run.

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

Represents one run of a DataBrew job.

" - } - }, - "com.amazonaws.databrew#JobRunErrorMessage": { - "type": "string" - }, - "com.amazonaws.databrew#JobRunId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 255 - } - } - }, - "com.amazonaws.databrew#JobRunList": { - "type": "list", - "member": { - "target": "com.amazonaws.databrew#JobRun" - } - }, - "com.amazonaws.databrew#JobRunState": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "STARTING", - "name": "STARTING" - }, - { - "value": "RUNNING", - "name": "RUNNING" - }, - { - "value": "STOPPING", - "name": "STOPPING" - }, - { - "value": "STOPPED", - "name": "STOPPED" - }, - { - "value": "SUCCEEDED", - "name": "SUCCEEDED" - }, - { - "value": "FAILED", - "name": "FAILED" - }, - { - "value": "TIMEOUT", - "name": "TIMEOUT" - } - ] - } - }, - "com.amazonaws.databrew#JobSample": { - "type": "structure", - "members": { - "Mode": { - "target": "com.amazonaws.databrew#SampleMode", - "traits": { - "smithy.api#documentation": "

A value that determines whether the profile job is run on the entire dataset or a\n specified number of rows. This value must be one of the following:

\n " - } - }, - "Size": { - "target": "com.amazonaws.databrew#JobSize", - "traits": { - "smithy.api#documentation": "

The Size parameter is only required when the mode is CUSTOM_ROWS. The\n profile job is run on the specified number of rows. The maximum value for size is\n Long.MAX_VALUE.

\n

Long.MAX_VALUE = 9223372036854775807

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

A sample configuration for profile jobs only, which determines the number of rows on which the\n profile job is run. If a JobSample value isn't provided, the\n default is used. The default value is CUSTOM_ROWS for the mode parameter and\n 20,000 for the size parameter.

" - } - }, - "com.amazonaws.databrew#JobSize": { - "type": "long" - }, - "com.amazonaws.databrew#JobType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "PROFILE", - "name": "PROFILE" - }, - { - "value": "RECIPE", - "name": "RECIPE" - } - ] - } - }, - "com.amazonaws.databrew#JsonOptions": { - "type": "structure", - "members": { - "MultiLine": { - "target": "com.amazonaws.databrew#MultiLine", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A value that specifies whether JSON input contains embedded new line\n characters.

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

Represents the JSON-specific options that define how input is to be interpreted by Glue DataBrew.

" - } - }, - "com.amazonaws.databrew#Key": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1280 - } - } - }, - "com.amazonaws.databrew#LastModifiedBy": { - "type": "string" - }, - "com.amazonaws.databrew#ListDatasets": { - "type": "operation", - "input": { - "target": "com.amazonaws.databrew#ListDatasetsRequest" - }, - "output": { - "target": "com.amazonaws.databrew#ListDatasetsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.databrew#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists all of the DataBrew datasets.

", - "smithy.api#http": { - "method": "GET", - "uri": "/datasets", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "Datasets", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.databrew#ListDatasetsRequest": { - "type": "structure", - "members": { - "MaxResults": { - "target": "com.amazonaws.databrew#MaxResults100", - "traits": { - "smithy.api#documentation": "

The maximum number of results to return in this request.

", - "smithy.api#httpQuery": "maxResults" - } - }, - "NextToken": { - "target": "com.amazonaws.databrew#NextToken", - "traits": { - "smithy.api#documentation": "

The token returned by a previous call to retrieve the next set of results.

", - "smithy.api#httpQuery": "nextToken" - } - } - } - }, - "com.amazonaws.databrew#ListDatasetsResponse": { - "type": "structure", - "members": { - "Datasets": { - "target": "com.amazonaws.databrew#DatasetList", - "traits": { - "smithy.api#documentation": "

A list of datasets that are defined.

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

A token that you can use in a subsequent call to retrieve the next set of\n results.

" - } - } - } - }, - "com.amazonaws.databrew#ListJobRuns": { - "type": "operation", - "input": { - "target": "com.amazonaws.databrew#ListJobRunsRequest" - }, - "output": { - "target": "com.amazonaws.databrew#ListJobRunsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.databrew#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.databrew#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists all of the previous runs of a particular DataBrew job.

", - "smithy.api#http": { - "method": "GET", - "uri": "/jobs/{Name}/jobRuns", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "JobRuns", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.databrew#ListJobRunsRequest": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.databrew#JobName", - "traits": { - "smithy.api#documentation": "

The name of the job.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "MaxResults": { - "target": "com.amazonaws.databrew#MaxResults100", - "traits": { - "smithy.api#documentation": "

The maximum number of results to return in this request.

", - "smithy.api#httpQuery": "maxResults" - } - }, - "NextToken": { - "target": "com.amazonaws.databrew#NextToken", - "traits": { - "smithy.api#documentation": "

The token returned by a previous call to retrieve the next set of results.

", - "smithy.api#httpQuery": "nextToken" - } - } - } - }, - "com.amazonaws.databrew#ListJobRunsResponse": { - "type": "structure", - "members": { - "JobRuns": { - "target": "com.amazonaws.databrew#JobRunList", - "traits": { - "smithy.api#documentation": "

A list of job runs that have occurred for the specified job.

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

A token that you can use in a subsequent call to retrieve the next set of\n results.

" - } - } - } - }, - "com.amazonaws.databrew#ListJobs": { - "type": "operation", - "input": { - "target": "com.amazonaws.databrew#ListJobsRequest" - }, - "output": { - "target": "com.amazonaws.databrew#ListJobsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.databrew#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists all of the DataBrew jobs that are defined.

", - "smithy.api#http": { - "method": "GET", - "uri": "/jobs", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "Jobs", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.databrew#ListJobsRequest": { - "type": "structure", - "members": { - "DatasetName": { - "target": "com.amazonaws.databrew#DatasetName", - "traits": { - "smithy.api#documentation": "

The name of a dataset. Using this parameter indicates to return only those jobs that\n act on the specified dataset.

", - "smithy.api#httpQuery": "datasetName" - } - }, - "MaxResults": { - "target": "com.amazonaws.databrew#MaxResults100", - "traits": { - "smithy.api#documentation": "

The maximum number of results to return in this request.

", - "smithy.api#httpQuery": "maxResults" - } - }, - "NextToken": { - "target": "com.amazonaws.databrew#NextToken", - "traits": { - "smithy.api#documentation": "

A token generated by DataBrew that specifies where to continue pagination if a\n previous request was truncated. To get the next set of pages, pass in the NextToken\n value from the response object of the previous page call.

", - "smithy.api#httpQuery": "nextToken" - } - }, - "ProjectName": { - "target": "com.amazonaws.databrew#ProjectName", - "traits": { - "smithy.api#documentation": "

The name of a project. Using this parameter indicates to return only those jobs that\n are associated with the specified project.

", - "smithy.api#httpQuery": "projectName" - } - } - } - }, - "com.amazonaws.databrew#ListJobsResponse": { - "type": "structure", - "members": { - "Jobs": { - "target": "com.amazonaws.databrew#JobList", - "traits": { - "smithy.api#documentation": "

A list of jobs that are defined.

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

A token that you can use in a subsequent call to retrieve the next set of\n results.

" - } - } - } - }, - "com.amazonaws.databrew#ListProjects": { - "type": "operation", - "input": { - "target": "com.amazonaws.databrew#ListProjectsRequest" - }, - "output": { - "target": "com.amazonaws.databrew#ListProjectsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.databrew#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists all of the DataBrew projects that are defined.

", - "smithy.api#http": { - "method": "GET", - "uri": "/projects", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "Projects", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.databrew#ListProjectsRequest": { - "type": "structure", - "members": { - "NextToken": { - "target": "com.amazonaws.databrew#NextToken", - "traits": { - "smithy.api#documentation": "

The token returned by a previous call to retrieve the next set of results.

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

The maximum number of results to return in this request.

", - "smithy.api#httpQuery": "maxResults" - } - } - } - }, - "com.amazonaws.databrew#ListProjectsResponse": { - "type": "structure", - "members": { - "Projects": { - "target": "com.amazonaws.databrew#ProjectList", - "traits": { - "smithy.api#documentation": "

A list of projects that are defined .

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

A token that you can use in a subsequent call to retrieve the next set of\n results.

" - } - } - } - }, - "com.amazonaws.databrew#ListRecipeVersions": { - "type": "operation", - "input": { - "target": "com.amazonaws.databrew#ListRecipeVersionsRequest" - }, - "output": { - "target": "com.amazonaws.databrew#ListRecipeVersionsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.databrew#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists the versions of a particular DataBrew recipe, except for\n LATEST_WORKING.

", - "smithy.api#http": { - "method": "GET", - "uri": "/recipeVersions", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "Recipes", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.databrew#ListRecipeVersionsRequest": { - "type": "structure", - "members": { - "MaxResults": { - "target": "com.amazonaws.databrew#MaxResults100", - "traits": { - "smithy.api#documentation": "

The maximum number of results to return in this request.

", - "smithy.api#httpQuery": "maxResults" - } - }, - "NextToken": { - "target": "com.amazonaws.databrew#NextToken", - "traits": { - "smithy.api#documentation": "

The token returned by a previous call to retrieve the next set of results.

", - "smithy.api#httpQuery": "nextToken" - } - }, - "Name": { - "target": "com.amazonaws.databrew#RecipeName", - "traits": { - "smithy.api#documentation": "

The name of the recipe for which to return version information.

", - "smithy.api#httpQuery": "name", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.databrew#ListRecipeVersionsResponse": { - "type": "structure", - "members": { - "NextToken": { - "target": "com.amazonaws.databrew#NextToken", - "traits": { - "smithy.api#documentation": "

A token that you can use in a subsequent call to retrieve the next set of\n results.

" - } - }, - "Recipes": { - "target": "com.amazonaws.databrew#RecipeList", - "traits": { - "smithy.api#documentation": "

A list of versions for the specified recipe.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.databrew#ListRecipes": { - "type": "operation", - "input": { - "target": "com.amazonaws.databrew#ListRecipesRequest" - }, - "output": { - "target": "com.amazonaws.databrew#ListRecipesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.databrew#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists all of the DataBrew recipes that are defined.

", - "smithy.api#http": { - "method": "GET", - "uri": "/recipes", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "Recipes", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.databrew#ListRecipesRequest": { - "type": "structure", - "members": { - "MaxResults": { - "target": "com.amazonaws.databrew#MaxResults100", - "traits": { - "smithy.api#documentation": "

The maximum number of results to return in this request.

", - "smithy.api#httpQuery": "maxResults" - } - }, - "NextToken": { - "target": "com.amazonaws.databrew#NextToken", - "traits": { - "smithy.api#documentation": "

The token returned by a previous call to retrieve the next set of results.

", - "smithy.api#httpQuery": "nextToken" - } - }, - "RecipeVersion": { - "target": "com.amazonaws.databrew#RecipeVersion", - "traits": { - "smithy.api#documentation": "

Return only those recipes with a version identifier of LATEST_WORKING or\n LATEST_PUBLISHED. If RecipeVersion is omitted,\n ListRecipes returns all of the LATEST_PUBLISHED recipe\n versions.

\n

Valid values: LATEST_WORKING | LATEST_PUBLISHED\n

", - "smithy.api#httpQuery": "recipeVersion" - } - } - } - }, - "com.amazonaws.databrew#ListRecipesResponse": { - "type": "structure", - "members": { - "Recipes": { - "target": "com.amazonaws.databrew#RecipeList", - "traits": { - "smithy.api#documentation": "

A list of recipes that are defined.

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

A token that you can use in a subsequent call to retrieve the next set of\n results.

" - } - } - } - }, - "com.amazonaws.databrew#ListRulesets": { - "type": "operation", - "input": { - "target": "com.amazonaws.databrew#ListRulesetsRequest" - }, - "output": { - "target": "com.amazonaws.databrew#ListRulesetsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.databrew#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.databrew#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

List all rulesets available in the current account or rulesets associated \n with a specific resource (dataset).

", - "smithy.api#http": { - "method": "GET", - "uri": "/rulesets", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "Rulesets", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.databrew#ListRulesetsRequest": { - "type": "structure", - "members": { - "TargetArn": { - "target": "com.amazonaws.databrew#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a resource (dataset). Using this parameter \n indicates to return only those rulesets that are associated with the specified resource.

", - "smithy.api#httpQuery": "targetArn" - } - }, - "MaxResults": { - "target": "com.amazonaws.databrew#MaxResults100", - "traits": { - "smithy.api#documentation": "

The maximum number of results to return in this request.

", - "smithy.api#httpQuery": "maxResults" - } - }, - "NextToken": { - "target": "com.amazonaws.databrew#NextToken", - "traits": { - "smithy.api#documentation": "

A token generated by DataBrew that specifies where to continue pagination \n if a previous request was truncated. To get the next set of pages, pass in \n the NextToken value from the response object of the previous page call.

", - "smithy.api#httpQuery": "nextToken" - } - } - } - }, - "com.amazonaws.databrew#ListRulesetsResponse": { - "type": "structure", - "members": { - "Rulesets": { - "target": "com.amazonaws.databrew#RulesetItemList", - "traits": { - "smithy.api#documentation": "

A list of RulesetItem. RulesetItem contains meta data of a ruleset.

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

A token that you can use in a subsequent call to retrieve the next set of\n results.

" - } - } - } - }, - "com.amazonaws.databrew#ListSchedules": { - "type": "operation", - "input": { - "target": "com.amazonaws.databrew#ListSchedulesRequest" - }, - "output": { - "target": "com.amazonaws.databrew#ListSchedulesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.databrew#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists the DataBrew schedules that are defined.

", - "smithy.api#http": { - "method": "GET", - "uri": "/schedules", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "Schedules", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.databrew#ListSchedulesRequest": { - "type": "structure", - "members": { - "JobName": { - "target": "com.amazonaws.databrew#JobName", - "traits": { - "smithy.api#documentation": "

The name of the job that these schedules apply to.

", - "smithy.api#httpQuery": "jobName" - } - }, - "MaxResults": { - "target": "com.amazonaws.databrew#MaxResults100", - "traits": { - "smithy.api#documentation": "

The maximum number of results to return in this request.

", - "smithy.api#httpQuery": "maxResults" - } - }, - "NextToken": { - "target": "com.amazonaws.databrew#NextToken", - "traits": { - "smithy.api#documentation": "

The token returned by a previous call to retrieve the next set of results.

", - "smithy.api#httpQuery": "nextToken" - } - } - } - }, - "com.amazonaws.databrew#ListSchedulesResponse": { - "type": "structure", - "members": { - "Schedules": { - "target": "com.amazonaws.databrew#ScheduleList", - "traits": { - "smithy.api#documentation": "

A list of schedules that are defined.

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

A token that you can use in a subsequent call to retrieve the next set of\n results.

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

Lists all the tags for a DataBrew resource.

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

The Amazon Resource Name (ARN) string that uniquely identifies the DataBrew resource.\n

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

A list of tags associated with the DataBrew resource.

" - } - } - } - }, - "com.amazonaws.databrew#LocaleCode": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 2, - "max": 100 - }, - "smithy.api#pattern": "^[A-Za-z0-9_\\.#@\\-]+$" - } - }, - "com.amazonaws.databrew#LogGroupName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 512 - } - } - }, - "com.amazonaws.databrew#LogSubscription": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ENABLE", - "name": "ENABLE" - }, - { - "value": "DISABLE", - "name": "DISABLE" - } - ] - } - }, - "com.amazonaws.databrew#MaxCapacity": { - "type": "integer", - "traits": { - "smithy.api#default": 0 - } - }, - "com.amazonaws.databrew#MaxFiles": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 1 - } - } - }, - "com.amazonaws.databrew#MaxOutputFiles": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 999 - } - } - }, - "com.amazonaws.databrew#MaxResults100": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 100 - } - } - }, - "com.amazonaws.databrew#MaxRetries": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 0 - } - } - }, - "com.amazonaws.databrew#Message": { - "type": "string" - }, - "com.amazonaws.databrew#Metadata": { - "type": "structure", - "members": { - "SourceArn": { - "target": "com.amazonaws.databrew#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) associated with the dataset. Currently, DataBrew \n only supports ARNs from Amazon AppFlow.

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

Contains additional resource information needed for specific datasets.

" - } - }, - "com.amazonaws.databrew#MultiLine": { - "type": "boolean", - "traits": { - "smithy.api#default": false - } - }, - "com.amazonaws.databrew#NextToken": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2000 - } - } - }, - "com.amazonaws.databrew#OpenedBy": { - "type": "string" - }, - "com.amazonaws.databrew#Operation": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - }, - "smithy.api#pattern": "^[A-Z\\_]+$" - } - }, - "com.amazonaws.databrew#Order": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "DESCENDING", - "name": "DESCENDING" - }, - { - "value": "ASCENDING", - "name": "ASCENDING" - } - ] - } - }, - "com.amazonaws.databrew#OrderedBy": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "LAST_MODIFIED_DATE", - "name": "LAST_MODIFIED_DATE" - } - ] - } - }, - "com.amazonaws.databrew#Output": { - "type": "structure", - "members": { - "CompressionFormat": { - "target": "com.amazonaws.databrew#CompressionFormat", - "traits": { - "smithy.api#documentation": "

The compression algorithm used to compress the output text of the job.

" - } - }, - "Format": { - "target": "com.amazonaws.databrew#OutputFormat", - "traits": { - "smithy.api#documentation": "

The data format of the output of the job.

" - } - }, - "PartitionColumns": { - "target": "com.amazonaws.databrew#ColumnNameList", - "traits": { - "smithy.api#documentation": "

The names of one or more partition columns for the output of the job.

" - } - }, - "Location": { - "target": "com.amazonaws.databrew#S3Location", - "traits": { - "smithy.api#documentation": "

The location in Amazon S3 where the job writes its output.

", - "smithy.api#required": {} - } - }, - "Overwrite": { - "target": "com.amazonaws.databrew#OverwriteOutput", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A value that, if true, means that any data in the location specified for output is\n overwritten with new output.

" - } - }, - "FormatOptions": { - "target": "com.amazonaws.databrew#OutputFormatOptions", - "traits": { - "smithy.api#documentation": "

Represents options that define how DataBrew formats job output files.

" - } - }, - "MaxOutputFiles": { - "target": "com.amazonaws.databrew#MaxOutputFiles", - "traits": { - "smithy.api#documentation": "

Maximum number of files to be generated by the job and written to the output folder. For output partitioned \n by column(s), the MaxOutputFiles value is the maximum number of files per partition.

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

Represents options that specify how and where in Amazon S3 DataBrew writes the output generated by\n recipe jobs or profile jobs.

" - } - }, - "com.amazonaws.databrew#OutputFormat": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "CSV", - "name": "CSV" - }, - { - "value": "JSON", - "name": "JSON" - }, - { - "value": "PARQUET", - "name": "PARQUET" - }, - { - "value": "GLUEPARQUET", - "name": "GLUEPARQUET" - }, - { - "value": "AVRO", - "name": "AVRO" - }, - { - "value": "ORC", - "name": "ORC" - }, - { - "value": "XML", - "name": "XML" - }, - { - "value": "TABLEAUHYPER", - "name": "TABLEAUHYPER" - } - ] - } - }, - "com.amazonaws.databrew#OutputFormatOptions": { - "type": "structure", - "members": { - "Csv": { - "target": "com.amazonaws.databrew#CsvOutputOptions", - "traits": { - "smithy.api#documentation": "

Represents a set of options that define the structure of comma-separated value (CSV)\n job output.

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

Represents a set of options that define the structure of comma-separated (CSV) job output.

" - } - }, - "com.amazonaws.databrew#OutputList": { - "type": "list", - "member": { - "target": "com.amazonaws.databrew#Output" - }, - "traits": { - "smithy.api#length": { - "min": 1 - } - } - }, - "com.amazonaws.databrew#OverwriteOutput": { - "type": "boolean", - "traits": { - "smithy.api#default": false - } - }, - "com.amazonaws.databrew#ParameterMap": { - "type": "map", - "key": { - "target": "com.amazonaws.databrew#ParameterName" - }, - "value": { - "target": "com.amazonaws.databrew#ParameterValue" - } - }, - "com.amazonaws.databrew#ParameterName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - }, - "smithy.api#pattern": "^[A-Za-z0-9]+$" - } - }, - "com.amazonaws.databrew#ParameterType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Datetime", - "name": "Datetime" - }, - { - "value": "Number", - "name": "Number" - }, - { - "value": "String", - "name": "String" - } - ] - } - }, - "com.amazonaws.databrew#ParameterValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 32768 - } - } - }, - "com.amazonaws.databrew#PathOptions": { - "type": "structure", - "members": { - "LastModifiedDateCondition": { - "target": "com.amazonaws.databrew#FilterExpression", - "traits": { - "smithy.api#documentation": "

If provided, this structure defines a date range for matching Amazon S3 objects based on their \n LastModifiedDate attribute in Amazon S3.

" - } - }, - "FilesLimit": { - "target": "com.amazonaws.databrew#FilesLimit", - "traits": { - "smithy.api#documentation": "

If provided, this structure imposes a limit on a number of files that should be selected.

" - } - }, - "Parameters": { - "target": "com.amazonaws.databrew#PathParametersMap", - "traits": { - "smithy.api#documentation": "

A structure that maps names of parameters used in the Amazon S3 path of a dataset to their definitions.

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

Represents a set of options that define how DataBrew selects files for a given Amazon S3 \n path in a dataset.

" - } - }, - "com.amazonaws.databrew#PathParameterName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 255 - } - } - }, - "com.amazonaws.databrew#PathParametersMap": { - "type": "map", - "key": { - "target": "com.amazonaws.databrew#PathParameterName" - }, - "value": { - "target": "com.amazonaws.databrew#DatasetParameter" - }, - "traits": { - "smithy.api#documentation": "

A structure that map names of parameters used in the Amazon S3 path of a dataset to their definitions. \n A definition includes parameter type and conditions.

", - "smithy.api#length": { - "min": 1, - "max": 10 - } - } - }, - "com.amazonaws.databrew#Preview": { - "type": "boolean", - "traits": { - "smithy.api#default": false - } - }, - "com.amazonaws.databrew#ProfileConfiguration": { - "type": "structure", - "members": { - "DatasetStatisticsConfiguration": { - "target": "com.amazonaws.databrew#StatisticsConfiguration", - "traits": { - "smithy.api#documentation": "

Configuration for inter-column evaluations. Configuration can be used to select evaluations and override \n parameters of evaluations. When configuration is undefined, the profile job will run all supported \n inter-column evaluations.\n

" - } - }, - "ProfileColumns": { - "target": "com.amazonaws.databrew#ColumnSelectorList", - "traits": { - "smithy.api#documentation": "

List of column selectors. ProfileColumns can be used to select columns from the dataset. When \n ProfileColumns is undefined, the profile job will profile all supported columns.\n

" - } - }, - "ColumnStatisticsConfigurations": { - "target": "com.amazonaws.databrew#ColumnStatisticsConfigurationList", - "traits": { - "smithy.api#documentation": "

List of configurations for column evaluations. ColumnStatisticsConfigurations are used to \n select evaluations and override parameters of evaluations for particular columns. When \n ColumnStatisticsConfigurations is undefined, the profile job will profile all supported columns \n and run all supported evaluations.\n

" - } - }, - "EntityDetectorConfiguration": { - "target": "com.amazonaws.databrew#EntityDetectorConfiguration", - "traits": { - "smithy.api#documentation": "

Configuration of entity detection for a profile job. When undefined, entity detection is disabled.

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

Configuration for profile jobs. Configuration can be used to select columns, do evaluations, and override default \n parameters of evaluations. When configuration is undefined, the profile job will apply default settings to all \n supported columns.\n

" - } - }, - "com.amazonaws.databrew#Project": { - "type": "structure", - "members": { - "AccountId": { - "target": "com.amazonaws.databrew#AccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the project.

" - } - }, - "CreateDate": { - "target": "com.amazonaws.databrew#Date", - "traits": { - "smithy.api#documentation": "

The date and time that the project was created.

" - } - }, - "CreatedBy": { - "target": "com.amazonaws.databrew#CreatedBy", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the user who crated the project.

" - } - }, - "DatasetName": { - "target": "com.amazonaws.databrew#DatasetName", - "traits": { - "smithy.api#documentation": "

The dataset that the project is to act upon.

" - } - }, - "LastModifiedDate": { - "target": "com.amazonaws.databrew#Date", - "traits": { - "smithy.api#documentation": "

The last modification date and time for the project.

" - } - }, - "LastModifiedBy": { - "target": "com.amazonaws.databrew#LastModifiedBy", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the user who last modified the project.

" - } - }, - "Name": { - "target": "com.amazonaws.databrew#ProjectName", - "traits": { - "smithy.api#documentation": "

The unique name of a project.

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

The name of a recipe that will be developed during a project session.

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

The Amazon Resource Name (ARN) for the project.

" - } - }, - "Sample": { - "target": "com.amazonaws.databrew#Sample", - "traits": { - "smithy.api#documentation": "

The sample size and sampling type to apply to the data. If this parameter isn't\n specified, then the sample consists of the first 500 rows from the dataset.

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

Metadata tags that have been applied to the project.

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

The Amazon Resource Name (ARN) of the role that will be assumed for this\n project.

" - } - }, - "OpenedBy": { - "target": "com.amazonaws.databrew#OpenedBy", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the user that opened the project for use.

" - } - }, - "OpenDate": { - "target": "com.amazonaws.databrew#Date", - "traits": { - "smithy.api#documentation": "

The date and time when the project was opened.

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

Represents all of the attributes of a DataBrew project.

" - } - }, - "com.amazonaws.databrew#ProjectList": { - "type": "list", - "member": { - "target": "com.amazonaws.databrew#Project" - } - }, - "com.amazonaws.databrew#ProjectName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 255 - } - } - }, - "com.amazonaws.databrew#PublishRecipe": { - "type": "operation", - "input": { - "target": "com.amazonaws.databrew#PublishRecipeRequest" - }, - "output": { - "target": "com.amazonaws.databrew#PublishRecipeResponse" - }, - "errors": [ - { - "target": "com.amazonaws.databrew#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.databrew#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.databrew#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Publishes a new version of a DataBrew recipe.

", - "smithy.api#http": { - "method": "POST", - "uri": "/recipes/{Name}/publishRecipe", - "code": 200 - } - } - }, - "com.amazonaws.databrew#PublishRecipeRequest": { - "type": "structure", - "members": { - "Description": { - "target": "com.amazonaws.databrew#RecipeDescription", - "traits": { - "smithy.api#documentation": "

A description of the recipe to be published, for this version of the recipe.

" - } - }, - "Name": { - "target": "com.amazonaws.databrew#RecipeName", - "traits": { - "smithy.api#documentation": "

The name of the recipe to be published.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.databrew#PublishRecipeResponse": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.databrew#RecipeName", - "traits": { - "smithy.api#documentation": "

The name of the recipe that you published.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.databrew#PublishedBy": { - "type": "string" - }, - "com.amazonaws.databrew#QueryString": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 10000 - } - } - }, - "com.amazonaws.databrew#Recipe": { - "type": "structure", - "members": { - "CreatedBy": { - "target": "com.amazonaws.databrew#CreatedBy", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the user who created the recipe.

" - } - }, - "CreateDate": { - "target": "com.amazonaws.databrew#Date", - "traits": { - "smithy.api#documentation": "

The date and time that the recipe was created.

" - } - }, - "LastModifiedBy": { - "target": "com.amazonaws.databrew#LastModifiedBy", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the user who last modified the recipe.

" - } - }, - "LastModifiedDate": { - "target": "com.amazonaws.databrew#Date", - "traits": { - "smithy.api#documentation": "

The last modification date and time of the recipe.

" - } - }, - "ProjectName": { - "target": "com.amazonaws.databrew#ProjectName", - "traits": { - "smithy.api#documentation": "

The name of the project that the recipe is associated with.

" - } - }, - "PublishedBy": { - "target": "com.amazonaws.databrew#PublishedBy", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the user who published the recipe.

" - } - }, - "PublishedDate": { - "target": "com.amazonaws.databrew#Date", - "traits": { - "smithy.api#documentation": "

The date and time when the recipe was published.

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

The description of the recipe.

" - } - }, - "Name": { - "target": "com.amazonaws.databrew#RecipeName", - "traits": { - "smithy.api#documentation": "

The unique name for the recipe.

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

The Amazon Resource Name (ARN) for the recipe.

" - } - }, - "Steps": { - "target": "com.amazonaws.databrew#RecipeStepList", - "traits": { - "smithy.api#documentation": "

A list of steps that are defined by the recipe.

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

Metadata tags that have been applied to the recipe.

" - } - }, - "RecipeVersion": { - "target": "com.amazonaws.databrew#RecipeVersion", - "traits": { - "smithy.api#documentation": "

The identifier for the version for the recipe. Must be one of the following:

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

Represents one or more actions to be performed on a DataBrew dataset.

" - } - }, - "com.amazonaws.databrew#RecipeAction": { - "type": "structure", - "members": { - "Operation": { - "target": "com.amazonaws.databrew#Operation", - "traits": { - "smithy.api#documentation": "

The name of a valid DataBrew transformation to be performed on the data.

", - "smithy.api#required": {} - } - }, - "Parameters": { - "target": "com.amazonaws.databrew#ParameterMap", - "traits": { - "smithy.api#documentation": "

Contextual parameters for the transformation.

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

Represents a transformation and associated parameters that are used to apply a change\n to a DataBrew dataset. For more information, see Recipe\n actions reference.

" - } - }, - "com.amazonaws.databrew#RecipeDescription": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1024 - } - } - }, - "com.amazonaws.databrew#RecipeErrorList": { - "type": "list", - "member": { - "target": "com.amazonaws.databrew#RecipeVersionErrorDetail" - } - }, - "com.amazonaws.databrew#RecipeErrorMessage": { - "type": "string" - }, - "com.amazonaws.databrew#RecipeList": { - "type": "list", - "member": { - "target": "com.amazonaws.databrew#Recipe" - } - }, - "com.amazonaws.databrew#RecipeName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 255 - } - } - }, - "com.amazonaws.databrew#RecipeReference": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.databrew#RecipeName", - "traits": { - "smithy.api#documentation": "

The name of the recipe.

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

The identifier for the version for the recipe.

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

Represents the name and version of a DataBrew recipe.

" - } - }, - "com.amazonaws.databrew#RecipeStep": { - "type": "structure", - "members": { - "Action": { - "target": "com.amazonaws.databrew#RecipeAction", - "traits": { - "smithy.api#documentation": "

The particular action to be performed in the recipe step.

", - "smithy.api#required": {} - } - }, - "ConditionExpressions": { - "target": "com.amazonaws.databrew#ConditionExpressionList", - "traits": { - "smithy.api#documentation": "

One or more conditions that must be met for the recipe step to succeed.

\n \n

All of the conditions in the array must be met. In other words, all of the\n conditions must be combined using a logical AND operation.

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

Represents a single step from a DataBrew recipe to be performed.

" - } - }, - "com.amazonaws.databrew#RecipeStepList": { - "type": "list", - "member": { - "target": "com.amazonaws.databrew#RecipeStep" - } - }, - "com.amazonaws.databrew#RecipeVersion": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 16 - } - } - }, - "com.amazonaws.databrew#RecipeVersionErrorDetail": { - "type": "structure", - "members": { - "ErrorCode": { - "target": "com.amazonaws.databrew#ErrorCode", - "traits": { - "smithy.api#documentation": "

The HTTP status code for the error.

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

The text of the error message.

" - } - }, - "RecipeVersion": { - "target": "com.amazonaws.databrew#RecipeVersion", - "traits": { - "smithy.api#documentation": "

The identifier for the recipe version associated with this error.

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

Represents any errors encountered when attempting to delete multiple recipe\n versions.

" - } - }, - "com.amazonaws.databrew#RecipeVersionList": { - "type": "list", - "member": { - "target": "com.amazonaws.databrew#RecipeVersion" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 50 - } - } - }, - "com.amazonaws.databrew#ResourceNotFoundException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.databrew#Message" - } - }, - "traits": { - "smithy.api#documentation": "

One or more resources can't be found.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.databrew#Result": { - "type": "string" - }, - "com.amazonaws.databrew#RowRange": { - "type": "integer" - }, - "com.amazonaws.databrew#Rule": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.databrew#RuleName", - "traits": { - "smithy.api#documentation": "

The name of the rule.

", - "smithy.api#required": {} - } - }, - "Disabled": { - "target": "com.amazonaws.databrew#Disabled", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A value that specifies whether the rule is disabled. Once a rule is \n disabled, a profile job will not validate it during a job run. Default \n value is false.

" - } - }, - "CheckExpression": { - "target": "com.amazonaws.databrew#Expression", - "traits": { - "smithy.api#documentation": "

The expression which includes column references, condition names followed by variable\n references, possibly grouped and combined with other conditions. For example,\n (:col1 starts_with :prefix1 or :col1 starts_with :prefix2) and (:col1\n ends_with :suffix1 or :col1 ends_with :suffix2). Column and value references\n are substitution variables that should start with the ':' symbol. Depending on the\n context, substitution variables' values can be either an actual value or a column name.\n These values are defined in the SubstitutionMap. If a CheckExpression starts with a\n column reference, then ColumnSelectors in the rule should be null. If ColumnSelectors\n has been defined, then there should be no column reference in the left side of a\n condition, for example, is_between :val1 and :val2.

\n

For more information, see Available checks\n

", - "smithy.api#required": {} - } - }, - "SubstitutionMap": { - "target": "com.amazonaws.databrew#ValuesMap", - "traits": { - "smithy.api#documentation": "

The map of substitution variable names to their values used in a check \n expression. Variable names should start with a ':' (colon). Variable values can either \n be actual values or column names. To differentiate between the two, column names \n should be enclosed in backticks, for example, \":col1\": \"`Column A`\".\n

" - } - }, - "Threshold": { - "target": "com.amazonaws.databrew#Threshold", - "traits": { - "smithy.api#documentation": "

The threshold used with a non-aggregate check expression. Non-aggregate check expressions \n will be applied to each row in a specific column, and the threshold will be used to determine \n whether the validation succeeds.

" - } - }, - "ColumnSelectors": { - "target": "com.amazonaws.databrew#ColumnSelectorList", - "traits": { - "smithy.api#documentation": "

List of column selectors. Selectors can be used to select columns using a name or regular \n expression from the dataset. Rule will be applied to selected columns.

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

Represents a single data quality requirement that should be validated in the \n scope of this dataset.

" - } - }, - "com.amazonaws.databrew#RuleCount": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 0 - } - } - }, - "com.amazonaws.databrew#RuleList": { - "type": "list", - "member": { - "target": "com.amazonaws.databrew#Rule" - }, - "traits": { - "smithy.api#length": { - "min": 1 - } - } - }, - "com.amazonaws.databrew#RuleName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - } - } - }, - "com.amazonaws.databrew#RulesetDescription": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1024 - } - } - }, - "com.amazonaws.databrew#RulesetItem": { - "type": "structure", - "members": { - "AccountId": { - "target": "com.amazonaws.databrew#AccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the ruleset.

" - } - }, - "CreatedBy": { - "target": "com.amazonaws.databrew#CreatedBy", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the user who created the ruleset.

" - } - }, - "CreateDate": { - "target": "com.amazonaws.databrew#Date", - "traits": { - "smithy.api#documentation": "

The date and time that the ruleset was created.

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

The description of the ruleset.

" - } - }, - "LastModifiedBy": { - "target": "com.amazonaws.databrew#LastModifiedBy", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the user who last modified the ruleset.

" - } - }, - "LastModifiedDate": { - "target": "com.amazonaws.databrew#Date", - "traits": { - "smithy.api#documentation": "

The modification date and time of the ruleset.

" - } - }, - "Name": { - "target": "com.amazonaws.databrew#RulesetName", - "traits": { - "smithy.api#documentation": "

The name of the ruleset.

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

The Amazon Resource Name (ARN) for the ruleset.

" - } - }, - "RuleCount": { - "target": "com.amazonaws.databrew#RuleCount", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of rules that are defined in the ruleset.

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

Metadata tags that have been applied to the ruleset.

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

The Amazon Resource Name (ARN) of a resource (dataset) that the ruleset is \n associated with.

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

Contains metadata about the ruleset.

" - } - }, - "com.amazonaws.databrew#RulesetItemList": { - "type": "list", - "member": { - "target": "com.amazonaws.databrew#RulesetItem" - } - }, - "com.amazonaws.databrew#RulesetName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 255 - } - } - }, - "com.amazonaws.databrew#S3Location": { - "type": "structure", - "members": { - "Bucket": { - "target": "com.amazonaws.databrew#Bucket", - "traits": { - "smithy.api#documentation": "

The Amazon S3 bucket name.

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

The unique name of the object in the bucket.

" - } - }, - "BucketOwner": { - "target": "com.amazonaws.databrew#BucketOwner", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID of the bucket owner.

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

Represents an Amazon S3 location (bucket name, bucket owner, and object key) where DataBrew can read\n input data, or write output from a job.

" - } - }, - "com.amazonaws.databrew#S3TableOutputOptions": { - "type": "structure", - "members": { - "Location": { - "target": "com.amazonaws.databrew#S3Location", - "traits": { - "smithy.api#documentation": "

Represents an Amazon S3 location (bucket name and object key) where DataBrew can write output \n from a job.

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

Represents options that specify how and where DataBrew writes the Amazon S3 output \n generated by recipe jobs.

" - } - }, - "com.amazonaws.databrew#Sample": { - "type": "structure", - "members": { - "Size": { - "target": "com.amazonaws.databrew#SampleSize", - "traits": { - "smithy.api#documentation": "

The number of rows in the sample.

" - } - }, - "Type": { - "target": "com.amazonaws.databrew#SampleType", - "traits": { - "smithy.api#documentation": "

The way in which DataBrew obtains rows from a dataset.

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

Represents the sample size and sampling type for DataBrew to use for interactive data\n analysis.

" - } - }, - "com.amazonaws.databrew#SampleMode": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "FULL_DATASET", - "name": "FULL_DATASET" - }, - { - "value": "CUSTOM_ROWS", - "name": "CUSTOM_ROWS" - } - ] - } - }, - "com.amazonaws.databrew#SampleSize": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 5000 - } - } - }, - "com.amazonaws.databrew#SampleType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "FIRST_N", - "name": "FIRST_N" - }, - { - "value": "LAST_N", - "name": "LAST_N" - }, - { - "value": "RANDOM", - "name": "RANDOM" - } - ] - } - }, - "com.amazonaws.databrew#Schedule": { - "type": "structure", - "members": { - "AccountId": { - "target": "com.amazonaws.databrew#AccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the schedule.

" - } - }, - "CreatedBy": { - "target": "com.amazonaws.databrew#CreatedBy", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the user who created the schedule.

" - } - }, - "CreateDate": { - "target": "com.amazonaws.databrew#Date", - "traits": { - "smithy.api#documentation": "

The date and time that the schedule was created.

" - } - }, - "JobNames": { - "target": "com.amazonaws.databrew#JobNameList", - "traits": { - "smithy.api#documentation": "

A list of jobs to be run, according to the schedule.

" - } - }, - "LastModifiedBy": { - "target": "com.amazonaws.databrew#LastModifiedBy", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the user who last modified the schedule.

" - } - }, - "LastModifiedDate": { - "target": "com.amazonaws.databrew#Date", - "traits": { - "smithy.api#documentation": "

The date and time when the schedule was last modified.

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

The Amazon Resource Name (ARN) of the schedule.

" - } - }, - "CronExpression": { - "target": "com.amazonaws.databrew#CronExpression", - "traits": { - "smithy.api#documentation": "

The dates and times when the job is to run. For more information, see Cron\n expressions in the Glue DataBrew Developer\n Guide.

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

Metadata tags that have been applied to the schedule.

" - } - }, - "Name": { - "target": "com.amazonaws.databrew#ScheduleName", - "traits": { - "smithy.api#documentation": "

The name of the schedule.

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

Represents one or more dates and times when a job is to run.

" - } - }, - "com.amazonaws.databrew#ScheduleList": { - "type": "list", - "member": { - "target": "com.amazonaws.databrew#Schedule" - } - }, - "com.amazonaws.databrew#ScheduleName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 255 - } - } - }, - "com.amazonaws.databrew#SendProjectSessionAction": { - "type": "operation", - "input": { - "target": "com.amazonaws.databrew#SendProjectSessionActionRequest" - }, - "output": { - "target": "com.amazonaws.databrew#SendProjectSessionActionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.databrew#ConflictException" - }, - { - "target": "com.amazonaws.databrew#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.databrew#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Performs a recipe step within an interactive DataBrew session that's currently\n open.

", - "smithy.api#http": { - "method": "PUT", - "uri": "/projects/{Name}/sendProjectSessionAction", - "code": 200 - } - } - }, - "com.amazonaws.databrew#SendProjectSessionActionRequest": { - "type": "structure", - "members": { - "Preview": { - "target": "com.amazonaws.databrew#Preview", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

If true, the result of the recipe step will be returned, but not applied.

" - } - }, - "Name": { - "target": "com.amazonaws.databrew#ProjectName", - "traits": { - "smithy.api#documentation": "

The name of the project to apply the action to.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "RecipeStep": { - "target": "com.amazonaws.databrew#RecipeStep" - }, - "StepIndex": { - "target": "com.amazonaws.databrew#StepIndex", - "traits": { - "smithy.api#documentation": "

The index from which to preview a step. This index is used to preview the result of\n steps that have already been applied, so that the resulting view frame is from earlier\n in the view frame stack.

" - } - }, - "ClientSessionId": { - "target": "com.amazonaws.databrew#ClientSessionId", - "traits": { - "smithy.api#documentation": "

A unique identifier for an interactive session that's currently open and ready for\n work. The action will be performed on this session.

" - } - }, - "ViewFrame": { - "target": "com.amazonaws.databrew#ViewFrame" - } - } - }, - "com.amazonaws.databrew#SendProjectSessionActionResponse": { - "type": "structure", - "members": { - "Result": { - "target": "com.amazonaws.databrew#Result", - "traits": { - "smithy.api#documentation": "

A message indicating the result of performing the action.

" - } - }, - "Name": { - "target": "com.amazonaws.databrew#ProjectName", - "traits": { - "smithy.api#documentation": "

The name of the project that was affected by the action.

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

A unique identifier for the action that was performed.

" - } - } - } - }, - "com.amazonaws.databrew#ServiceQuotaExceededException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.databrew#Message" - } - }, - "traits": { - "smithy.api#documentation": "

A service quota is exceeded.

", - "smithy.api#error": "client", - "smithy.api#httpError": 402 - } - }, - "com.amazonaws.databrew#SessionStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ASSIGNED", - "name": "ASSIGNED" - }, - { - "value": "FAILED", - "name": "FAILED" - }, - { - "value": "INITIALIZING", - "name": "INITIALIZING" - }, - { - "value": "PROVISIONING", - "name": "PROVISIONING" - }, - { - "value": "READY", - "name": "READY" - }, - { - "value": "RECYCLING", - "name": "RECYCLING" - }, - { - "value": "ROTATING", - "name": "ROTATING" - }, - { - "value": "TERMINATED", - "name": "TERMINATED" - }, - { - "value": "TERMINATING", - "name": "TERMINATING" - }, - { - "value": "UPDATING", - "name": "UPDATING" - } - ] - } - }, - "com.amazonaws.databrew#SheetIndex": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 0, - "max": 200 - } - } - }, - "com.amazonaws.databrew#SheetIndexList": { - "type": "list", - "member": { - "target": "com.amazonaws.databrew#SheetIndex" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1 - } - } - }, - "com.amazonaws.databrew#SheetName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 31 - } - } - }, - "com.amazonaws.databrew#SheetNameList": { - "type": "list", - "member": { - "target": "com.amazonaws.databrew#SheetName" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1 - } - } - }, - "com.amazonaws.databrew#Source": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "S3", - "name": "S3" - }, - { - "value": "DATA-CATALOG", - "name": "DATACATALOG" - }, - { - "value": "DATABASE", - "name": "DATABASE" - } - ] - } - }, - "com.amazonaws.databrew#StartColumnIndex": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 0 - } - } - }, - "com.amazonaws.databrew#StartJobRun": { - "type": "operation", - "input": { - "target": "com.amazonaws.databrew#StartJobRunRequest" - }, - "output": { - "target": "com.amazonaws.databrew#StartJobRunResponse" - }, - "errors": [ - { - "target": "com.amazonaws.databrew#ConflictException" - }, - { - "target": "com.amazonaws.databrew#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.databrew#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.databrew#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Runs a DataBrew job.

", - "smithy.api#http": { - "method": "POST", - "uri": "/jobs/{Name}/startJobRun", - "code": 200 - } - } - }, - "com.amazonaws.databrew#StartJobRunRequest": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.databrew#JobName", - "traits": { - "smithy.api#documentation": "

The name of the job to be run.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.databrew#StartJobRunResponse": { - "type": "structure", - "members": { - "RunId": { - "target": "com.amazonaws.databrew#JobRunId", - "traits": { - "smithy.api#documentation": "

A system-generated identifier for this particular job run.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.databrew#StartProjectSession": { - "type": "operation", - "input": { - "target": "com.amazonaws.databrew#StartProjectSessionRequest" - }, - "output": { - "target": "com.amazonaws.databrew#StartProjectSessionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.databrew#ConflictException" - }, - { - "target": "com.amazonaws.databrew#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.databrew#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.databrew#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates an interactive session, enabling you to manipulate data in a DataBrew\n project.

", - "smithy.api#http": { - "method": "PUT", - "uri": "/projects/{Name}/startProjectSession", - "code": 200 - } - } - }, - "com.amazonaws.databrew#StartProjectSessionRequest": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.databrew#ProjectName", - "traits": { - "smithy.api#documentation": "

The name of the project to act upon.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "AssumeControl": { - "target": "com.amazonaws.databrew#AssumeControl", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A value that, if true, enables you to take control of a session, even if a different\n client is currently accessing the project.

" - } - } - } - }, - "com.amazonaws.databrew#StartProjectSessionResponse": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.databrew#ProjectName", - "traits": { - "smithy.api#documentation": "

The name of the project to be acted upon.

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

A system-generated identifier for the session.

" - } - } - } - }, - "com.amazonaws.databrew#StartRowIndex": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 0 - } - } - }, - "com.amazonaws.databrew#StartedBy": { - "type": "string" - }, - "com.amazonaws.databrew#Statistic": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - }, - "smithy.api#pattern": "^[A-Z\\_]+$" - } - }, - "com.amazonaws.databrew#StatisticList": { - "type": "list", - "member": { - "target": "com.amazonaws.databrew#Statistic" - }, - "traits": { - "smithy.api#length": { - "min": 1 - } - } - }, - "com.amazonaws.databrew#StatisticOverride": { - "type": "structure", - "members": { - "Statistic": { - "target": "com.amazonaws.databrew#Statistic", - "traits": { - "smithy.api#documentation": "

The name of an evaluation

", - "smithy.api#required": {} - } - }, - "Parameters": { - "target": "com.amazonaws.databrew#ParameterMap", - "traits": { - "smithy.api#documentation": "

A map that includes overrides of an evaluation’s parameters.

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

Override of a particular evaluation for a profile job.

" - } - }, - "com.amazonaws.databrew#StatisticOverrideList": { - "type": "list", - "member": { - "target": "com.amazonaws.databrew#StatisticOverride" - }, - "traits": { - "smithy.api#length": { - "min": 1 - } - } - }, - "com.amazonaws.databrew#StatisticsConfiguration": { - "type": "structure", - "members": { - "IncludedStatistics": { - "target": "com.amazonaws.databrew#StatisticList", - "traits": { - "smithy.api#documentation": "

List of included evaluations. When the list is undefined, all supported \n evaluations will be included.

" - } - }, - "Overrides": { - "target": "com.amazonaws.databrew#StatisticOverrideList", - "traits": { - "smithy.api#documentation": "

List of overrides for evaluations.

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

Configuration of evaluations for a profile job. This configuration can be used to select \n evaluations and override the parameters of selected evaluations.\n

" - } - }, - "com.amazonaws.databrew#StepIndex": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 0 - } - } - }, - "com.amazonaws.databrew#StopJobRun": { - "type": "operation", - "input": { - "target": "com.amazonaws.databrew#StopJobRunRequest" - }, - "output": { - "target": "com.amazonaws.databrew#StopJobRunResponse" - }, - "errors": [ - { - "target": "com.amazonaws.databrew#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.databrew#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Stops a particular run of a job.

", - "smithy.api#http": { - "method": "POST", - "uri": "/jobs/{Name}/jobRun/{RunId}/stopJobRun", - "code": 200 - } - } - }, - "com.amazonaws.databrew#StopJobRunRequest": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.databrew#JobName", - "traits": { - "smithy.api#documentation": "

The name of the job to be stopped.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "RunId": { - "target": "com.amazonaws.databrew#JobRunId", - "traits": { - "smithy.api#documentation": "

The ID of the job run to be stopped.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.databrew#StopJobRunResponse": { - "type": "structure", - "members": { - "RunId": { - "target": "com.amazonaws.databrew#JobRunId", - "traits": { - "smithy.api#documentation": "

The ID of the job run that you stopped.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.databrew#TableName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 255 - } - } - }, - "com.amazonaws.databrew#TagKey": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - } - } - }, - "com.amazonaws.databrew#TagKeyList": { - "type": "list", - "member": { - "target": "com.amazonaws.databrew#TagKey" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 200 - } - } - }, - "com.amazonaws.databrew#TagMap": { - "type": "map", - "key": { - "target": "com.amazonaws.databrew#TagKey" - }, - "value": { - "target": "com.amazonaws.databrew#TagValue" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 200 - } - } - }, - "com.amazonaws.databrew#TagResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.databrew#TagResourceRequest" - }, - "output": { - "target": "com.amazonaws.databrew#TagResourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.databrew#InternalServerException" - }, - { - "target": "com.amazonaws.databrew#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.databrew#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Adds metadata tags to a DataBrew resource, such as a dataset, project, recipe, job, or\n schedule.

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

The DataBrew resource to which tags should be added. The value for this parameter is\n an Amazon Resource Name (ARN). For DataBrew, you can tag a dataset, a job, a project, or\n a recipe.

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

One or more tags to be assigned to the resource.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.databrew#TagResourceResponse": { - "type": "structure", - "members": {} - }, - "com.amazonaws.databrew#TagValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - } - } - }, - "com.amazonaws.databrew#TargetColumn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1024 - } - } - }, - "com.amazonaws.databrew#Threshold": { - "type": "structure", - "members": { - "Value": { - "target": "com.amazonaws.databrew#ThresholdValue", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The value of a threshold.

", - "smithy.api#required": {} - } - }, - "Type": { - "target": "com.amazonaws.databrew#ThresholdType", - "traits": { - "smithy.api#documentation": "

The type of a threshold. Used for comparison of an actual count of rows that satisfy the \n rule to the threshold value.

" - } - }, - "Unit": { - "target": "com.amazonaws.databrew#ThresholdUnit", - "traits": { - "smithy.api#documentation": "

Unit of threshold value. Can be either a COUNT or PERCENTAGE of the full sample size \n used for validation.

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

The threshold used with a non-aggregate check expression. The non-aggregate check expression \n will be applied to each row in a specific column. Then the threshold will be used to determine \n whether the validation succeeds.

" - } - }, - "com.amazonaws.databrew#ThresholdType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "GREATER_THAN_OR_EQUAL", - "name": "GREATER_THAN_OR_EQUAL" - }, - { - "value": "LESS_THAN_OR_EQUAL", - "name": "LESS_THAN_OR_EQUAL" - }, - { - "value": "GREATER_THAN", - "name": "GREATER_THAN" - }, - { - "value": "LESS_THAN", - "name": "LESS_THAN" - } - ] - } - }, - "com.amazonaws.databrew#ThresholdUnit": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "COUNT", - "name": "COUNT" - }, - { - "value": "PERCENTAGE", - "name": "PERCENTAGE" - } - ] - } - }, - "com.amazonaws.databrew#ThresholdValue": { - "type": "double", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 0 - } - } - }, - "com.amazonaws.databrew#Timeout": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 0 - } - } - }, - "com.amazonaws.databrew#TimezoneOffset": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 6 - }, - "smithy.api#pattern": "^(Z|[-+](\\d|\\d{2}|\\d{2}:?\\d{2}))$" - } - }, - "com.amazonaws.databrew#UntagResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.databrew#UntagResourceRequest" - }, - "output": { - "target": "com.amazonaws.databrew#UntagResourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.databrew#InternalServerException" - }, - { - "target": "com.amazonaws.databrew#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.databrew#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Removes metadata tags from a DataBrew resource.

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

A DataBrew resource from which you want to remove a tag or tags. The value for this\n parameter is an Amazon Resource Name (ARN).

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

The tag keys (names) of one or more tags to be removed.

", - "smithy.api#httpQuery": "tagKeys", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.databrew#UntagResourceResponse": { - "type": "structure", - "members": {} - }, - "com.amazonaws.databrew#UpdateDataset": { - "type": "operation", - "input": { - "target": "com.amazonaws.databrew#UpdateDatasetRequest" - }, - "output": { - "target": "com.amazonaws.databrew#UpdateDatasetResponse" - }, - "errors": [ - { - "target": "com.amazonaws.databrew#AccessDeniedException" - }, - { - "target": "com.amazonaws.databrew#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.databrew#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Modifies the definition of an existing DataBrew dataset.

", - "smithy.api#http": { - "method": "PUT", - "uri": "/datasets/{Name}", - "code": 200 - } - } - }, - "com.amazonaws.databrew#UpdateDatasetRequest": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.databrew#DatasetName", - "traits": { - "smithy.api#documentation": "

The name of the dataset to be updated.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Format": { - "target": "com.amazonaws.databrew#InputFormat", - "traits": { - "smithy.api#documentation": "

The file format of a dataset that is created from an Amazon S3 file or folder.

" - } - }, - "FormatOptions": { - "target": "com.amazonaws.databrew#FormatOptions" - }, - "Input": { - "target": "com.amazonaws.databrew#Input", - "traits": { - "smithy.api#required": {} - } - }, - "PathOptions": { - "target": "com.amazonaws.databrew#PathOptions", - "traits": { - "smithy.api#documentation": "

A set of options that defines how DataBrew interprets an Amazon S3 path of the dataset.

" - } - } - } - }, - "com.amazonaws.databrew#UpdateDatasetResponse": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.databrew#DatasetName", - "traits": { - "smithy.api#documentation": "

The name of the dataset that you updated.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.databrew#UpdateProfileJob": { - "type": "operation", - "input": { - "target": "com.amazonaws.databrew#UpdateProfileJobRequest" - }, - "output": { - "target": "com.amazonaws.databrew#UpdateProfileJobResponse" - }, - "errors": [ - { - "target": "com.amazonaws.databrew#AccessDeniedException" - }, - { - "target": "com.amazonaws.databrew#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.databrew#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Modifies the definition of an existing profile job.

", - "smithy.api#http": { - "method": "PUT", - "uri": "/profileJobs/{Name}", - "code": 200 - } - } - }, - "com.amazonaws.databrew#UpdateProfileJobRequest": { - "type": "structure", - "members": { - "Configuration": { - "target": "com.amazonaws.databrew#ProfileConfiguration", - "traits": { - "smithy.api#documentation": "

Configuration for profile jobs. Used to select columns, do evaluations, \n and override default parameters of evaluations. When configuration is null, the\n profile job will run with default settings.

" - } - }, - "EncryptionKeyArn": { - "target": "com.amazonaws.databrew#EncryptionKeyArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an encryption key that is used to protect the\n job.

" - } - }, - "EncryptionMode": { - "target": "com.amazonaws.databrew#EncryptionMode", - "traits": { - "smithy.api#documentation": "

The encryption mode for the job, which can be one of the following:

\n " - } - }, - "Name": { - "target": "com.amazonaws.databrew#JobName", - "traits": { - "smithy.api#documentation": "

The name of the job to be updated.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "LogSubscription": { - "target": "com.amazonaws.databrew#LogSubscription", - "traits": { - "smithy.api#documentation": "

Enables or disables Amazon CloudWatch logging for the job. If logging is enabled,\n CloudWatch writes one log stream for each job run.

" - } - }, - "MaxCapacity": { - "target": "com.amazonaws.databrew#MaxCapacity", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of compute nodes that DataBrew can use when the job processes\n data.

" - } - }, - "MaxRetries": { - "target": "com.amazonaws.databrew#MaxRetries", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of times to retry the job after a job run fails.

" - } - }, - "OutputLocation": { - "target": "com.amazonaws.databrew#S3Location", - "traits": { - "smithy.api#required": {} - } - }, - "ValidationConfigurations": { - "target": "com.amazonaws.databrew#ValidationConfigurationList", - "traits": { - "smithy.api#documentation": "

List of validation configurations that are applied to the profile job.

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

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role to\n be assumed when DataBrew runs the job.

", - "smithy.api#required": {} - } - }, - "Timeout": { - "target": "com.amazonaws.databrew#Timeout", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The job's timeout in minutes. A job that attempts to run longer than this timeout\n period ends with a status of TIMEOUT.

" - } - }, - "JobSample": { - "target": "com.amazonaws.databrew#JobSample", - "traits": { - "smithy.api#documentation": "

Sample configuration for Profile Jobs only. Determines the number of rows on which the\n Profile job will be executed. If a JobSample value is not provided for profile jobs, the\n default value will be used. The default value is CUSTOM_ROWS for the mode parameter and\n 20000 for the size parameter.

" - } - } - } - }, - "com.amazonaws.databrew#UpdateProfileJobResponse": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.databrew#JobName", - "traits": { - "smithy.api#documentation": "

The name of the job that was updated.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.databrew#UpdateProject": { - "type": "operation", - "input": { - "target": "com.amazonaws.databrew#UpdateProjectRequest" - }, - "output": { - "target": "com.amazonaws.databrew#UpdateProjectResponse" - }, - "errors": [ - { - "target": "com.amazonaws.databrew#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.databrew#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Modifies the definition of an existing DataBrew project.

", - "smithy.api#http": { - "method": "PUT", - "uri": "/projects/{Name}", - "code": 200 - } - } - }, - "com.amazonaws.databrew#UpdateProjectRequest": { - "type": "structure", - "members": { - "Sample": { - "target": "com.amazonaws.databrew#Sample" - }, - "RoleArn": { - "target": "com.amazonaws.databrew#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role to be assumed for this request.

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

The name of the project to be updated.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.databrew#UpdateProjectResponse": { - "type": "structure", - "members": { - "LastModifiedDate": { - "target": "com.amazonaws.databrew#Date", - "traits": { - "smithy.api#documentation": "

The date and time that the project was last modified.

" - } - }, - "Name": { - "target": "com.amazonaws.databrew#ProjectName", - "traits": { - "smithy.api#documentation": "

The name of the project that you updated.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.databrew#UpdateRecipe": { - "type": "operation", - "input": { - "target": "com.amazonaws.databrew#UpdateRecipeRequest" - }, - "output": { - "target": "com.amazonaws.databrew#UpdateRecipeResponse" - }, - "errors": [ - { - "target": "com.amazonaws.databrew#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.databrew#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Modifies the definition of the LATEST_WORKING version of a DataBrew\n recipe.

", - "smithy.api#http": { - "method": "PUT", - "uri": "/recipes/{Name}", - "code": 200 - } - } - }, - "com.amazonaws.databrew#UpdateRecipeJob": { - "type": "operation", - "input": { - "target": "com.amazonaws.databrew#UpdateRecipeJobRequest" - }, - "output": { - "target": "com.amazonaws.databrew#UpdateRecipeJobResponse" - }, - "errors": [ - { - "target": "com.amazonaws.databrew#AccessDeniedException" - }, - { - "target": "com.amazonaws.databrew#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.databrew#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Modifies the definition of an existing DataBrew recipe job.

", - "smithy.api#http": { - "method": "PUT", - "uri": "/recipeJobs/{Name}", - "code": 200 - } - } - }, - "com.amazonaws.databrew#UpdateRecipeJobRequest": { - "type": "structure", - "members": { - "EncryptionKeyArn": { - "target": "com.amazonaws.databrew#EncryptionKeyArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an encryption key that is used to protect the\n job.

" - } - }, - "EncryptionMode": { - "target": "com.amazonaws.databrew#EncryptionMode", - "traits": { - "smithy.api#documentation": "

The encryption mode for the job, which can be one of the following:

\n " - } - }, - "Name": { - "target": "com.amazonaws.databrew#JobName", - "traits": { - "smithy.api#documentation": "

The name of the job to update.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "LogSubscription": { - "target": "com.amazonaws.databrew#LogSubscription", - "traits": { - "smithy.api#documentation": "

Enables or disables Amazon CloudWatch logging for the job. If logging is enabled,\n CloudWatch writes one log stream for each job run.

" - } - }, - "MaxCapacity": { - "target": "com.amazonaws.databrew#MaxCapacity", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of nodes that DataBrew can consume when the job processes\n data.

" - } - }, - "MaxRetries": { - "target": "com.amazonaws.databrew#MaxRetries", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of times to retry the job after a job run fails.

" - } - }, - "Outputs": { - "target": "com.amazonaws.databrew#OutputList", - "traits": { - "smithy.api#documentation": "

One or more artifacts that represent the output from running the job.

" - } - }, - "DataCatalogOutputs": { - "target": "com.amazonaws.databrew#DataCatalogOutputList", - "traits": { - "smithy.api#documentation": "

One or more artifacts that represent the Glue Data Catalog output from running the job.

" - } - }, - "DatabaseOutputs": { - "target": "com.amazonaws.databrew#DatabaseOutputList", - "traits": { - "smithy.api#documentation": "

Represents a list of JDBC database output objects which defines the output destination for a \n DataBrew recipe job to write into.

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

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role to\n be assumed when DataBrew runs the job.

", - "smithy.api#required": {} - } - }, - "Timeout": { - "target": "com.amazonaws.databrew#Timeout", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The job's timeout in minutes. A job that attempts to run longer than this timeout\n period ends with a status of TIMEOUT.

" - } - } - } - }, - "com.amazonaws.databrew#UpdateRecipeJobResponse": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.databrew#JobName", - "traits": { - "smithy.api#documentation": "

The name of the job that you updated.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.databrew#UpdateRecipeRequest": { - "type": "structure", - "members": { - "Description": { - "target": "com.amazonaws.databrew#RecipeDescription", - "traits": { - "smithy.api#documentation": "

A description of the recipe.

" - } - }, - "Name": { - "target": "com.amazonaws.databrew#RecipeName", - "traits": { - "smithy.api#documentation": "

The name of the recipe to be updated.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Steps": { - "target": "com.amazonaws.databrew#RecipeStepList", - "traits": { - "smithy.api#documentation": "

One or more steps to be performed by the recipe. Each step consists of an action, and\n the conditions under which the action should succeed.

" - } - } - } - }, - "com.amazonaws.databrew#UpdateRecipeResponse": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.databrew#RecipeName", - "traits": { - "smithy.api#documentation": "

The name of the recipe that was updated.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.databrew#UpdateRuleset": { - "type": "operation", - "input": { - "target": "com.amazonaws.databrew#UpdateRulesetRequest" - }, - "output": { - "target": "com.amazonaws.databrew#UpdateRulesetResponse" - }, - "errors": [ - { - "target": "com.amazonaws.databrew#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.databrew#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates specified ruleset.

", - "smithy.api#http": { - "method": "PUT", - "uri": "/rulesets/{Name}", - "code": 200 - } - } - }, - "com.amazonaws.databrew#UpdateRulesetRequest": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.databrew#RulesetName", - "traits": { - "smithy.api#documentation": "

The name of the ruleset to be updated.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Description": { - "target": "com.amazonaws.databrew#RulesetDescription", - "traits": { - "smithy.api#documentation": "

The description of the ruleset.

" - } - }, - "Rules": { - "target": "com.amazonaws.databrew#RuleList", - "traits": { - "smithy.api#documentation": "

A list of rules that are defined with the ruleset. A rule includes one or more \n checks to be validated on a DataBrew dataset.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.databrew#UpdateRulesetResponse": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.databrew#RulesetName", - "traits": { - "smithy.api#documentation": "

The name of the updated ruleset.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.databrew#UpdateSchedule": { - "type": "operation", - "input": { - "target": "com.amazonaws.databrew#UpdateScheduleRequest" - }, - "output": { - "target": "com.amazonaws.databrew#UpdateScheduleResponse" - }, - "errors": [ - { - "target": "com.amazonaws.databrew#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.databrew#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.databrew#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Modifies the definition of an existing DataBrew schedule.

", - "smithy.api#http": { - "method": "PUT", - "uri": "/schedules/{Name}", - "code": 200 - } - } - }, - "com.amazonaws.databrew#UpdateScheduleRequest": { - "type": "structure", - "members": { - "JobNames": { - "target": "com.amazonaws.databrew#JobNameList", - "traits": { - "smithy.api#documentation": "

The name or names of one or more jobs to be run for this schedule.

" - } - }, - "CronExpression": { - "target": "com.amazonaws.databrew#CronExpression", - "traits": { - "smithy.api#documentation": "

The date or dates and time or times when the jobs are to be run. For more information,\n see Cron\n expressions in the Glue DataBrew Developer\n Guide.

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

The name of the schedule to update.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.databrew#UpdateScheduleResponse": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.databrew#ScheduleName", - "traits": { - "smithy.api#documentation": "

The name of the schedule that was updated.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.databrew#ValidationConfiguration": { - "type": "structure", - "members": { - "RulesetArn": { - "target": "com.amazonaws.databrew#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the ruleset to be validated in the profile job. \n The TargetArn of the selected ruleset should be the same as the Amazon Resource Name (ARN) of \n the dataset that is associated with the profile job.

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

Mode of data quality validation. Default mode is “CHECK_ALL” which verifies all rules \n defined in the selected ruleset.

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

Configuration for data quality validation. Used to select the Rulesets and Validation Mode \n to be used in the profile job. When ValidationConfiguration is null, the profile \n job will run without data quality validation.

" - } - }, - "com.amazonaws.databrew#ValidationConfigurationList": { - "type": "list", - "member": { - "target": "com.amazonaws.databrew#ValidationConfiguration" - }, - "traits": { - "smithy.api#length": { - "min": 1 - } - } - }, - "com.amazonaws.databrew#ValidationException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.databrew#Message" - } - }, - "traits": { - "smithy.api#documentation": "

The input parameters for this request failed validation.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.databrew#ValidationMode": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "CHECK_ALL", - "name": "CHECK_ALL" - } - ] - } - }, - "com.amazonaws.databrew#ValueReference": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 2, - "max": 128 - }, - "smithy.api#pattern": "^:[A-Za-z0-9_]+$" - } - }, - "com.amazonaws.databrew#ValuesMap": { - "type": "map", - "key": { - "target": "com.amazonaws.databrew#ValueReference" - }, - "value": { - "target": "com.amazonaws.databrew#ConditionValue" - } - }, - "com.amazonaws.databrew#ViewFrame": { - "type": "structure", - "members": { - "StartColumnIndex": { - "target": "com.amazonaws.databrew#StartColumnIndex", - "traits": { - "smithy.api#documentation": "

The starting index for the range of columns to return in the view frame.

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

The number of columns to include in the view frame, beginning with the\n StartColumnIndex value and ignoring any columns in the\n HiddenColumns list.

" - } - }, - "HiddenColumns": { - "target": "com.amazonaws.databrew#HiddenColumnList", - "traits": { - "smithy.api#documentation": "

A list of columns to hide in the view frame.

" - } - }, - "StartRowIndex": { - "target": "com.amazonaws.databrew#StartRowIndex", - "traits": { - "smithy.api#documentation": "

The starting index for the range of rows to return in the view frame.

" - } - }, - "RowRange": { - "target": "com.amazonaws.databrew#RowRange", - "traits": { - "smithy.api#documentation": "

The number of rows to include in the view frame, beginning with the \n StartRowIndex value.

" - } - }, - "Analytics": { - "target": "com.amazonaws.databrew#AnalyticsMode", - "traits": { - "smithy.api#documentation": "

Controls if analytics computation is enabled or disabled. Enabled by default.

" - } + "errors": [ + { + "target": "com.amazonaws.databrew#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.databrew#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves detailed information about the ruleset.

", + "smithy.api#http": { + "method": "GET", + "uri": "/rulesets/{Name}", + "code": 200 + } + } + }, + "com.amazonaws.databrew#DescribeRulesetRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.databrew#RulesetName", + "traits": { + "smithy.api#documentation": "

The name of the ruleset to be described.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.databrew#DescribeRulesetResponse": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.databrew#RulesetName", + "traits": { + "smithy.api#documentation": "

The name of the ruleset.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.databrew#RulesetDescription", + "traits": { + "smithy.api#documentation": "

The description of the ruleset.

" + } + }, + "TargetArn": { + "target": "com.amazonaws.databrew#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a resource (dataset) that the ruleset is \n associated with.

" + } + }, + "Rules": { + "target": "com.amazonaws.databrew#RuleList", + "traits": { + "smithy.api#documentation": "

A list of rules that are defined with the ruleset. A rule includes one \n or more checks to be validated on a DataBrew dataset.

" + } + }, + "CreateDate": { + "target": "com.amazonaws.databrew#Date", + "traits": { + "smithy.api#documentation": "

The date and time that the ruleset was created.

" + } + }, + "CreatedBy": { + "target": "com.amazonaws.databrew#CreatedBy", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the user who created the ruleset.

" + } + }, + "LastModifiedBy": { + "target": "com.amazonaws.databrew#LastModifiedBy", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the user who last modified the ruleset.

" + } + }, + "LastModifiedDate": { + "target": "com.amazonaws.databrew#Date", + "traits": { + "smithy.api#documentation": "

The modification date and time of the ruleset.

" + } + }, + "ResourceArn": { + "target": "com.amazonaws.databrew#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the ruleset.

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

Metadata tags that have been applied to the ruleset.

" + } + } + } + }, + "com.amazonaws.databrew#DescribeSchedule": { + "type": "operation", + "input": { + "target": "com.amazonaws.databrew#DescribeScheduleRequest" + }, + "output": { + "target": "com.amazonaws.databrew#DescribeScheduleResponse" + }, + "errors": [ + { + "target": "com.amazonaws.databrew#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.databrew#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns the definition of a specific DataBrew schedule.

", + "smithy.api#http": { + "method": "GET", + "uri": "/schedules/{Name}", + "code": 200 + } + } + }, + "com.amazonaws.databrew#DescribeScheduleRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.databrew#ScheduleName", + "traits": { + "smithy.api#documentation": "

The name of the schedule to be described.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.databrew#DescribeScheduleResponse": { + "type": "structure", + "members": { + "CreateDate": { + "target": "com.amazonaws.databrew#Date", + "traits": { + "smithy.api#documentation": "

The date and time that the schedule was created.

" + } + }, + "CreatedBy": { + "target": "com.amazonaws.databrew#CreatedBy", + "traits": { + "smithy.api#documentation": "

The identifier (user name) of the user who created the schedule.

" + } + }, + "JobNames": { + "target": "com.amazonaws.databrew#JobNameList", + "traits": { + "smithy.api#documentation": "

The name or names of one or more jobs to be run by using the schedule.

" + } + }, + "LastModifiedBy": { + "target": "com.amazonaws.databrew#LastModifiedBy", + "traits": { + "smithy.api#documentation": "

The identifier (user name) of the user who last modified the schedule.

" + } + }, + "LastModifiedDate": { + "target": "com.amazonaws.databrew#Date", + "traits": { + "smithy.api#documentation": "

The date and time that the schedule was last modified.

" + } + }, + "ResourceArn": { + "target": "com.amazonaws.databrew#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the schedule.

" + } + }, + "CronExpression": { + "target": "com.amazonaws.databrew#CronExpression", + "traits": { + "smithy.api#documentation": "

The date or dates and time or times when the jobs are to be run for the schedule. For\n more information, see Cron expressions in the\n Glue DataBrew Developer Guide.

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

Metadata tags associated with this schedule.

" + } + }, + "Name": { + "target": "com.amazonaws.databrew#ScheduleName", + "traits": { + "smithy.api#documentation": "

The name of the schedule.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.databrew#Disabled": { + "type": "boolean", + "traits": { + "smithy.api#default": false + } + }, + "com.amazonaws.databrew#EncryptionKeyArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + } + } + }, + "com.amazonaws.databrew#EncryptionMode": { + "type": "enum", + "members": { + "SSEKMS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SSE-KMS" + } + }, + "SSES3": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SSE-S3" + } + } + } + }, + "com.amazonaws.databrew#EntityDetectorConfiguration": { + "type": "structure", + "members": { + "EntityTypes": { + "target": "com.amazonaws.databrew#EntityTypeList", + "traits": { + "smithy.api#documentation": "

Entity types to detect. Can be any of the following:

\n \n

The Entity type group USA_ALL is also supported, and includes all of the \n above entity types except PERSON_NAME and DATE.

", + "smithy.api#required": {} + } + }, + "AllowedStatistics": { + "target": "com.amazonaws.databrew#AllowedStatisticList", + "traits": { + "smithy.api#documentation": "

Configuration of statistics that are allowed to be run on columns that \n contain detected entities. When undefined, no statistics will be computed \n on columns that contain detected entities.

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

Configuration of entity detection for a profile job. When undefined, entity \n detection is disabled.

" + } + }, + "com.amazonaws.databrew#EntityType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[A-Z_][A-Z\\\\d_]*$" + } + }, + "com.amazonaws.databrew#EntityTypeList": { + "type": "list", + "member": { + "target": "com.amazonaws.databrew#EntityType" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.databrew#ErrorCode": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[1-5][0-9][0-9]$" + } + }, + "com.amazonaws.databrew#ExcelOptions": { + "type": "structure", + "members": { + "SheetNames": { + "target": "com.amazonaws.databrew#SheetNameList", + "traits": { + "smithy.api#documentation": "

One or more named sheets in the Excel file that will be included in the dataset.

" + } + }, + "SheetIndexes": { + "target": "com.amazonaws.databrew#SheetIndexList", + "traits": { + "smithy.api#documentation": "

One or more sheet numbers in the Excel file that will be included in the\n dataset.

" + } + }, + "HeaderRow": { + "target": "com.amazonaws.databrew#HeaderRow", + "traits": { + "smithy.api#documentation": "

A variable that specifies whether the first row in the file is parsed as the\n header. If this value is false, column names are auto-generated.

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

Represents a set of options that define how DataBrew will interpret a Microsoft Excel file when \n creating a dataset from that file.

" + } + }, + "com.amazonaws.databrew#ExecutionTime": { + "type": "integer", + "traits": { + "smithy.api#default": 0 + } + }, + "com.amazonaws.databrew#Expression": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 4, + "max": 1024 + }, + "smithy.api#pattern": "^[<>0-9A-Za-z_.,:)(!= ]+$" + } + }, + "com.amazonaws.databrew#FilesLimit": { + "type": "structure", + "members": { + "MaxFiles": { + "target": "com.amazonaws.databrew#MaxFiles", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of Amazon S3 files to select.

", + "smithy.api#required": {} + } + }, + "OrderedBy": { + "target": "com.amazonaws.databrew#OrderedBy", + "traits": { + "smithy.api#documentation": "

A criteria to use for Amazon S3 files sorting before their selection. By default uses LAST_MODIFIED_DATE as \n a sorting criteria. Currently it's the only allowed value.

" + } + }, + "Order": { + "target": "com.amazonaws.databrew#Order", + "traits": { + "smithy.api#documentation": "

A criteria to use for Amazon S3 files sorting before their selection. By\n default uses DESCENDING order, i.e. most recent files are selected first. Another\n possible value is ASCENDING.

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

Represents a limit imposed on number of Amazon S3 files that should be selected for a \n dataset from a connected Amazon S3 path.

" + } + }, + "com.amazonaws.databrew#FilterExpression": { + "type": "structure", + "members": { + "Expression": { + "target": "com.amazonaws.databrew#Expression", + "traits": { + "smithy.api#documentation": "

The expression which includes condition names followed by substitution variables, possibly grouped \n and combined with other conditions. For example, \"(starts_with :prefix1 or starts_with :prefix2) and \n (ends_with :suffix1 or ends_with :suffix2)\". Substitution variables should start with ':' symbol.

", + "smithy.api#required": {} + } + }, + "ValuesMap": { + "target": "com.amazonaws.databrew#ValuesMap", + "traits": { + "smithy.api#documentation": "

The map of substitution variable names to their values used in this filter expression.

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

Represents a structure for defining parameter conditions. Supported conditions are described\n here: Supported \n conditions for dynamic datasets in the \n Glue DataBrew Developer Guide.

" + } + }, + "com.amazonaws.databrew#FormatOptions": { + "type": "structure", + "members": { + "Json": { + "target": "com.amazonaws.databrew#JsonOptions", + "traits": { + "smithy.api#documentation": "

Options that define how JSON input is to be interpreted by DataBrew.

" + } + }, + "Excel": { + "target": "com.amazonaws.databrew#ExcelOptions", + "traits": { + "smithy.api#documentation": "

Options that define how Excel input is to be interpreted by DataBrew.

" + } + }, + "Csv": { + "target": "com.amazonaws.databrew#CsvOptions", + "traits": { + "smithy.api#documentation": "

Options that define how CSV input is to be interpreted by DataBrew.

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

Represents a set of options that define the structure of either comma-separated value (CSV),\n Excel, or JSON input.

" + } + }, + "com.amazonaws.databrew#GlueConnectionName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "com.amazonaws.databrew#HeaderRow": { + "type": "boolean" + }, + "com.amazonaws.databrew#HiddenColumnList": { + "type": "list", + "member": { + "target": "com.amazonaws.databrew#ColumnName" + } + }, + "com.amazonaws.databrew#Input": { + "type": "structure", + "members": { + "S3InputDefinition": { + "target": "com.amazonaws.databrew#S3Location", + "traits": { + "smithy.api#documentation": "

The Amazon S3 location where the data is stored.

" + } + }, + "DataCatalogInputDefinition": { + "target": "com.amazonaws.databrew#DataCatalogInputDefinition", + "traits": { + "smithy.api#documentation": "

The Glue Data Catalog parameters for the data.

" + } + }, + "DatabaseInputDefinition": { + "target": "com.amazonaws.databrew#DatabaseInputDefinition", + "traits": { + "smithy.api#documentation": "

Connection information for dataset input files stored in a database.

" + } + }, + "Metadata": { + "target": "com.amazonaws.databrew#Metadata", + "traits": { + "smithy.api#documentation": "

Contains additional resource information needed for specific datasets.

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

Represents information on how DataBrew can find data, in either the Glue Data Catalog or\n Amazon S3.

" + } + }, + "com.amazonaws.databrew#InputFormat": { + "type": "enum", + "members": { + "CSV": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CSV" + } + }, + "JSON": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "JSON" + } + }, + "PARQUET": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PARQUET" + } + }, + "EXCEL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXCEL" + } + }, + "ORC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ORC" + } + } + } + }, + "com.amazonaws.databrew#InternalServerException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.databrew#Message" + } + }, + "traits": { + "smithy.api#documentation": "

An internal service failure occurred.

", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.databrew#Job": { + "type": "structure", + "members": { + "AccountId": { + "target": "com.amazonaws.databrew#AccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the job.

" + } + }, + "CreatedBy": { + "target": "com.amazonaws.databrew#CreatedBy", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the user who created the job.

" + } + }, + "CreateDate": { + "target": "com.amazonaws.databrew#Date", + "traits": { + "smithy.api#documentation": "

The date and time that the job was created.

" + } + }, + "DatasetName": { + "target": "com.amazonaws.databrew#DatasetName", + "traits": { + "smithy.api#documentation": "

A dataset that the job is to process.

" + } + }, + "EncryptionKeyArn": { + "target": "com.amazonaws.databrew#EncryptionKeyArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an encryption key that is used to protect the job\n output. For more information, see Encrypting data\n written by DataBrew jobs\n

" + } + }, + "EncryptionMode": { + "target": "com.amazonaws.databrew#EncryptionMode", + "traits": { + "smithy.api#documentation": "

The encryption mode for the job, which can be one of the following:

\n " + } + }, + "Name": { + "target": "com.amazonaws.databrew#JobName", + "traits": { + "smithy.api#documentation": "

The unique name of the job.

", + "smithy.api#required": {} + } + }, + "Type": { + "target": "com.amazonaws.databrew#JobType", + "traits": { + "smithy.api#documentation": "

The job type of the job, which must be one of the following:

\n " + } + }, + "LastModifiedBy": { + "target": "com.amazonaws.databrew#LastModifiedBy", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the user who last modified the job.

" + } + }, + "LastModifiedDate": { + "target": "com.amazonaws.databrew#Date", + "traits": { + "smithy.api#documentation": "

The modification date and time of the job.

" + } + }, + "LogSubscription": { + "target": "com.amazonaws.databrew#LogSubscription", + "traits": { + "smithy.api#documentation": "

The current status of Amazon CloudWatch logging for the job.

" + } + }, + "MaxCapacity": { + "target": "com.amazonaws.databrew#MaxCapacity", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of nodes that can be consumed when the job processes data.

" + } + }, + "MaxRetries": { + "target": "com.amazonaws.databrew#MaxRetries", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of times to retry the job after a job run fails.

" + } + }, + "Outputs": { + "target": "com.amazonaws.databrew#OutputList", + "traits": { + "smithy.api#documentation": "

One or more artifacts that represent output from running the job.

" + } + }, + "DataCatalogOutputs": { + "target": "com.amazonaws.databrew#DataCatalogOutputList", + "traits": { + "smithy.api#documentation": "

One or more artifacts that represent the Glue Data Catalog output \n from running the job.

" + } + }, + "DatabaseOutputs": { + "target": "com.amazonaws.databrew#DatabaseOutputList", + "traits": { + "smithy.api#documentation": "

Represents a list of JDBC database output objects which defines the output \n destination for a DataBrew recipe job to write into.

" + } + }, + "ProjectName": { + "target": "com.amazonaws.databrew#ProjectName", + "traits": { + "smithy.api#documentation": "

The name of the project that the job is associated with.

" + } + }, + "RecipeReference": { + "target": "com.amazonaws.databrew#RecipeReference", + "traits": { + "smithy.api#documentation": "

A set of steps that the job runs.

" + } + }, + "ResourceArn": { + "target": "com.amazonaws.databrew#Arn", + "traits": { + "smithy.api#documentation": "

The unique Amazon Resource Name (ARN) for the job.

" + } + }, + "RoleArn": { + "target": "com.amazonaws.databrew#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the role to be assumed for this job.

" + } + }, + "Timeout": { + "target": "com.amazonaws.databrew#Timeout", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The job's timeout in minutes. A job that attempts to run longer than this timeout\n period ends with a status of TIMEOUT.

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

Metadata tags that have been applied to the job.

" + } + }, + "JobSample": { + "target": "com.amazonaws.databrew#JobSample", + "traits": { + "smithy.api#documentation": "

A sample configuration for profile jobs only, which determines the number of rows on which the\n profile job is run. If a JobSample value isn't provided, the default value\n is used. The default value is CUSTOM_ROWS for the mode parameter and 20,000 for the\n size parameter.

" + } + }, + "ValidationConfigurations": { + "target": "com.amazonaws.databrew#ValidationConfigurationList", + "traits": { + "smithy.api#documentation": "

List of validation configurations that are applied to the profile job.

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

Represents all of the attributes of a DataBrew job.

" + } + }, + "com.amazonaws.databrew#JobList": { + "type": "list", + "member": { + "target": "com.amazonaws.databrew#Job" + } + }, + "com.amazonaws.databrew#JobName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 240 + } + } + }, + "com.amazonaws.databrew#JobNameList": { + "type": "list", + "member": { + "target": "com.amazonaws.databrew#JobName" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.databrew#JobRun": { + "type": "structure", + "members": { + "Attempt": { + "target": "com.amazonaws.databrew#Attempt", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of times that DataBrew has attempted to run the job.

" + } + }, + "CompletedOn": { + "target": "com.amazonaws.databrew#Date", + "traits": { + "smithy.api#documentation": "

The date and time when the job completed processing.

" + } + }, + "DatasetName": { + "target": "com.amazonaws.databrew#DatasetName", + "traits": { + "smithy.api#documentation": "

The name of the dataset for the job to process.

" + } + }, + "ErrorMessage": { + "target": "com.amazonaws.databrew#JobRunErrorMessage", + "traits": { + "smithy.api#documentation": "

A message indicating an error (if any) that was encountered when the job ran.

" + } + }, + "ExecutionTime": { + "target": "com.amazonaws.databrew#ExecutionTime", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The amount of time, in seconds, during which a job run consumed resources.

" + } + }, + "JobName": { + "target": "com.amazonaws.databrew#JobName", + "traits": { + "smithy.api#documentation": "

The name of the job being processed during this run.

" + } + }, + "RunId": { + "target": "com.amazonaws.databrew#JobRunId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the job run.

" + } + }, + "State": { + "target": "com.amazonaws.databrew#JobRunState", + "traits": { + "smithy.api#documentation": "

The current state of the job run entity itself.

" + } + }, + "LogSubscription": { + "target": "com.amazonaws.databrew#LogSubscription", + "traits": { + "smithy.api#documentation": "

The current status of Amazon CloudWatch logging for the job run.

" + } + }, + "LogGroupName": { + "target": "com.amazonaws.databrew#LogGroupName", + "traits": { + "smithy.api#documentation": "

The name of an Amazon CloudWatch log group, where the job writes diagnostic messages\n when it runs.

" + } + }, + "Outputs": { + "target": "com.amazonaws.databrew#OutputList", + "traits": { + "smithy.api#documentation": "

One or more output artifacts from a job run.

" + } + }, + "DataCatalogOutputs": { + "target": "com.amazonaws.databrew#DataCatalogOutputList", + "traits": { + "smithy.api#documentation": "

One or more artifacts that represent the Glue Data Catalog output \n from running the job.

" + } + }, + "DatabaseOutputs": { + "target": "com.amazonaws.databrew#DatabaseOutputList", + "traits": { + "smithy.api#documentation": "

Represents a list of JDBC database output objects which defines the output \n destination for a DataBrew recipe job to write into.

" + } + }, + "RecipeReference": { + "target": "com.amazonaws.databrew#RecipeReference", + "traits": { + "smithy.api#documentation": "

The set of steps processed by the job.

" + } + }, + "StartedBy": { + "target": "com.amazonaws.databrew#StartedBy", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the user who initiated the job run.

" + } + }, + "StartedOn": { + "target": "com.amazonaws.databrew#Date", + "traits": { + "smithy.api#documentation": "

The date and time when the job run began.

" + } + }, + "JobSample": { + "target": "com.amazonaws.databrew#JobSample", + "traits": { + "smithy.api#documentation": "

A sample configuration for profile jobs only, which determines the number of rows on which the\n profile job is run. If a JobSample value isn't provided, the default\n is used. The default value is CUSTOM_ROWS for the mode parameter and 20,000 for the\n size parameter.

" + } + }, + "ValidationConfigurations": { + "target": "com.amazonaws.databrew#ValidationConfigurationList", + "traits": { + "smithy.api#documentation": "

List of validation configurations that are applied to the profile job run.

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

Represents one run of a DataBrew job.

" + } + }, + "com.amazonaws.databrew#JobRunErrorMessage": { + "type": "string" + }, + "com.amazonaws.databrew#JobRunId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "com.amazonaws.databrew#JobRunList": { + "type": "list", + "member": { + "target": "com.amazonaws.databrew#JobRun" + } + }, + "com.amazonaws.databrew#JobRunState": { + "type": "enum", + "members": { + "STARTING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STARTING" + } + }, + "RUNNING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RUNNING" + } + }, + "STOPPING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STOPPING" + } + }, + "STOPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STOPPED" + } + }, + "SUCCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUCCEEDED" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "TIMEOUT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TIMEOUT" + } + } + } + }, + "com.amazonaws.databrew#JobSample": { + "type": "structure", + "members": { + "Mode": { + "target": "com.amazonaws.databrew#SampleMode", + "traits": { + "smithy.api#documentation": "

A value that determines whether the profile job is run on the entire dataset or a\n specified number of rows. This value must be one of the following:

\n " + } + }, + "Size": { + "target": "com.amazonaws.databrew#JobSize", + "traits": { + "smithy.api#documentation": "

The Size parameter is only required when the mode is CUSTOM_ROWS. The\n profile job is run on the specified number of rows. The maximum value for size is\n Long.MAX_VALUE.

\n

Long.MAX_VALUE = 9223372036854775807

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

A sample configuration for profile jobs only, which determines the number of rows on which the\n profile job is run. If a JobSample value isn't provided, the\n default is used. The default value is CUSTOM_ROWS for the mode parameter and\n 20,000 for the size parameter.

" + } + }, + "com.amazonaws.databrew#JobSize": { + "type": "long" + }, + "com.amazonaws.databrew#JobType": { + "type": "enum", + "members": { + "PROFILE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PROFILE" + } + }, + "RECIPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RECIPE" + } + } + } + }, + "com.amazonaws.databrew#JsonOptions": { + "type": "structure", + "members": { + "MultiLine": { + "target": "com.amazonaws.databrew#MultiLine", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A value that specifies whether JSON input contains embedded new line\n characters.

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

Represents the JSON-specific options that define how input is to be interpreted by Glue DataBrew.

" + } + }, + "com.amazonaws.databrew#Key": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1280 + } + } + }, + "com.amazonaws.databrew#LastModifiedBy": { + "type": "string" + }, + "com.amazonaws.databrew#ListDatasets": { + "type": "operation", + "input": { + "target": "com.amazonaws.databrew#ListDatasetsRequest" + }, + "output": { + "target": "com.amazonaws.databrew#ListDatasetsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.databrew#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists all of the DataBrew datasets.

", + "smithy.api#http": { + "method": "GET", + "uri": "/datasets", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Datasets", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.databrew#ListDatasetsRequest": { + "type": "structure", + "members": { + "MaxResults": { + "target": "com.amazonaws.databrew#MaxResults100", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return in this request.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.databrew#NextToken", + "traits": { + "smithy.api#documentation": "

The token returned by a previous call to retrieve the next set of results.

", + "smithy.api#httpQuery": "nextToken" + } + } + } + }, + "com.amazonaws.databrew#ListDatasetsResponse": { + "type": "structure", + "members": { + "Datasets": { + "target": "com.amazonaws.databrew#DatasetList", + "traits": { + "smithy.api#documentation": "

A list of datasets that are defined.

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.databrew#NextToken", + "traits": { + "smithy.api#documentation": "

A token that you can use in a subsequent call to retrieve the next set of\n results.

" + } + } + } + }, + "com.amazonaws.databrew#ListJobRuns": { + "type": "operation", + "input": { + "target": "com.amazonaws.databrew#ListJobRunsRequest" + }, + "output": { + "target": "com.amazonaws.databrew#ListJobRunsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.databrew#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.databrew#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists all of the previous runs of a particular DataBrew job.

", + "smithy.api#http": { + "method": "GET", + "uri": "/jobs/{Name}/jobRuns", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "JobRuns", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.databrew#ListJobRunsRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.databrew#JobName", + "traits": { + "smithy.api#documentation": "

The name of the job.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "MaxResults": { + "target": "com.amazonaws.databrew#MaxResults100", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return in this request.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.databrew#NextToken", + "traits": { + "smithy.api#documentation": "

The token returned by a previous call to retrieve the next set of results.

", + "smithy.api#httpQuery": "nextToken" + } + } + } + }, + "com.amazonaws.databrew#ListJobRunsResponse": { + "type": "structure", + "members": { + "JobRuns": { + "target": "com.amazonaws.databrew#JobRunList", + "traits": { + "smithy.api#documentation": "

A list of job runs that have occurred for the specified job.

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.databrew#NextToken", + "traits": { + "smithy.api#documentation": "

A token that you can use in a subsequent call to retrieve the next set of\n results.

" + } + } + } + }, + "com.amazonaws.databrew#ListJobs": { + "type": "operation", + "input": { + "target": "com.amazonaws.databrew#ListJobsRequest" + }, + "output": { + "target": "com.amazonaws.databrew#ListJobsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.databrew#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists all of the DataBrew jobs that are defined.

", + "smithy.api#http": { + "method": "GET", + "uri": "/jobs", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Jobs", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.databrew#ListJobsRequest": { + "type": "structure", + "members": { + "DatasetName": { + "target": "com.amazonaws.databrew#DatasetName", + "traits": { + "smithy.api#documentation": "

The name of a dataset. Using this parameter indicates to return only those jobs that\n act on the specified dataset.

", + "smithy.api#httpQuery": "datasetName" + } + }, + "MaxResults": { + "target": "com.amazonaws.databrew#MaxResults100", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return in this request.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.databrew#NextToken", + "traits": { + "smithy.api#documentation": "

A token generated by DataBrew that specifies where to continue pagination if a\n previous request was truncated. To get the next set of pages, pass in the NextToken\n value from the response object of the previous page call.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "ProjectName": { + "target": "com.amazonaws.databrew#ProjectName", + "traits": { + "smithy.api#documentation": "

The name of a project. Using this parameter indicates to return only those jobs that\n are associated with the specified project.

", + "smithy.api#httpQuery": "projectName" + } + } + } + }, + "com.amazonaws.databrew#ListJobsResponse": { + "type": "structure", + "members": { + "Jobs": { + "target": "com.amazonaws.databrew#JobList", + "traits": { + "smithy.api#documentation": "

A list of jobs that are defined.

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.databrew#NextToken", + "traits": { + "smithy.api#documentation": "

A token that you can use in a subsequent call to retrieve the next set of\n results.

" + } + } + } + }, + "com.amazonaws.databrew#ListProjects": { + "type": "operation", + "input": { + "target": "com.amazonaws.databrew#ListProjectsRequest" + }, + "output": { + "target": "com.amazonaws.databrew#ListProjectsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.databrew#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists all of the DataBrew projects that are defined.

", + "smithy.api#http": { + "method": "GET", + "uri": "/projects", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Projects", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.databrew#ListProjectsRequest": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.databrew#NextToken", + "traits": { + "smithy.api#documentation": "

The token returned by a previous call to retrieve the next set of results.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "MaxResults": { + "target": "com.amazonaws.databrew#MaxResults100", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return in this request.

", + "smithy.api#httpQuery": "maxResults" + } + } + } + }, + "com.amazonaws.databrew#ListProjectsResponse": { + "type": "structure", + "members": { + "Projects": { + "target": "com.amazonaws.databrew#ProjectList", + "traits": { + "smithy.api#documentation": "

A list of projects that are defined .

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.databrew#NextToken", + "traits": { + "smithy.api#documentation": "

A token that you can use in a subsequent call to retrieve the next set of\n results.

" + } + } + } + }, + "com.amazonaws.databrew#ListRecipeVersions": { + "type": "operation", + "input": { + "target": "com.amazonaws.databrew#ListRecipeVersionsRequest" + }, + "output": { + "target": "com.amazonaws.databrew#ListRecipeVersionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.databrew#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the versions of a particular DataBrew recipe, except for\n LATEST_WORKING.

", + "smithy.api#http": { + "method": "GET", + "uri": "/recipeVersions", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Recipes", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.databrew#ListRecipeVersionsRequest": { + "type": "structure", + "members": { + "MaxResults": { + "target": "com.amazonaws.databrew#MaxResults100", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return in this request.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.databrew#NextToken", + "traits": { + "smithy.api#documentation": "

The token returned by a previous call to retrieve the next set of results.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "Name": { + "target": "com.amazonaws.databrew#RecipeName", + "traits": { + "smithy.api#documentation": "

The name of the recipe for which to return version information.

", + "smithy.api#httpQuery": "name", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.databrew#ListRecipeVersionsResponse": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.databrew#NextToken", + "traits": { + "smithy.api#documentation": "

A token that you can use in a subsequent call to retrieve the next set of\n results.

" + } + }, + "Recipes": { + "target": "com.amazonaws.databrew#RecipeList", + "traits": { + "smithy.api#documentation": "

A list of versions for the specified recipe.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.databrew#ListRecipes": { + "type": "operation", + "input": { + "target": "com.amazonaws.databrew#ListRecipesRequest" + }, + "output": { + "target": "com.amazonaws.databrew#ListRecipesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.databrew#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists all of the DataBrew recipes that are defined.

", + "smithy.api#http": { + "method": "GET", + "uri": "/recipes", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Recipes", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.databrew#ListRecipesRequest": { + "type": "structure", + "members": { + "MaxResults": { + "target": "com.amazonaws.databrew#MaxResults100", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return in this request.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.databrew#NextToken", + "traits": { + "smithy.api#documentation": "

The token returned by a previous call to retrieve the next set of results.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "RecipeVersion": { + "target": "com.amazonaws.databrew#RecipeVersion", + "traits": { + "smithy.api#documentation": "

Return only those recipes with a version identifier of LATEST_WORKING or\n LATEST_PUBLISHED. If RecipeVersion is omitted,\n ListRecipes returns all of the LATEST_PUBLISHED recipe\n versions.

\n

Valid values: LATEST_WORKING | LATEST_PUBLISHED\n

", + "smithy.api#httpQuery": "recipeVersion" + } + } + } + }, + "com.amazonaws.databrew#ListRecipesResponse": { + "type": "structure", + "members": { + "Recipes": { + "target": "com.amazonaws.databrew#RecipeList", + "traits": { + "smithy.api#documentation": "

A list of recipes that are defined.

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.databrew#NextToken", + "traits": { + "smithy.api#documentation": "

A token that you can use in a subsequent call to retrieve the next set of\n results.

" + } + } + } + }, + "com.amazonaws.databrew#ListRulesets": { + "type": "operation", + "input": { + "target": "com.amazonaws.databrew#ListRulesetsRequest" + }, + "output": { + "target": "com.amazonaws.databrew#ListRulesetsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.databrew#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.databrew#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

List all rulesets available in the current account or rulesets associated \n with a specific resource (dataset).

", + "smithy.api#http": { + "method": "GET", + "uri": "/rulesets", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Rulesets", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.databrew#ListRulesetsRequest": { + "type": "structure", + "members": { + "TargetArn": { + "target": "com.amazonaws.databrew#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a resource (dataset). Using this parameter \n indicates to return only those rulesets that are associated with the specified resource.

", + "smithy.api#httpQuery": "targetArn" + } + }, + "MaxResults": { + "target": "com.amazonaws.databrew#MaxResults100", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return in this request.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.databrew#NextToken", + "traits": { + "smithy.api#documentation": "

A token generated by DataBrew that specifies where to continue pagination \n if a previous request was truncated. To get the next set of pages, pass in \n the NextToken value from the response object of the previous page call.

", + "smithy.api#httpQuery": "nextToken" + } + } + } + }, + "com.amazonaws.databrew#ListRulesetsResponse": { + "type": "structure", + "members": { + "Rulesets": { + "target": "com.amazonaws.databrew#RulesetItemList", + "traits": { + "smithy.api#documentation": "

A list of RulesetItem. RulesetItem contains meta data of a ruleset.

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.databrew#NextToken", + "traits": { + "smithy.api#documentation": "

A token that you can use in a subsequent call to retrieve the next set of\n results.

" + } + } + } + }, + "com.amazonaws.databrew#ListSchedules": { + "type": "operation", + "input": { + "target": "com.amazonaws.databrew#ListSchedulesRequest" + }, + "output": { + "target": "com.amazonaws.databrew#ListSchedulesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.databrew#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the DataBrew schedules that are defined.

", + "smithy.api#http": { + "method": "GET", + "uri": "/schedules", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Schedules", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.databrew#ListSchedulesRequest": { + "type": "structure", + "members": { + "JobName": { + "target": "com.amazonaws.databrew#JobName", + "traits": { + "smithy.api#documentation": "

The name of the job that these schedules apply to.

", + "smithy.api#httpQuery": "jobName" + } + }, + "MaxResults": { + "target": "com.amazonaws.databrew#MaxResults100", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return in this request.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.databrew#NextToken", + "traits": { + "smithy.api#documentation": "

The token returned by a previous call to retrieve the next set of results.

", + "smithy.api#httpQuery": "nextToken" + } + } + } + }, + "com.amazonaws.databrew#ListSchedulesResponse": { + "type": "structure", + "members": { + "Schedules": { + "target": "com.amazonaws.databrew#ScheduleList", + "traits": { + "smithy.api#documentation": "

A list of schedules that are defined.

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.databrew#NextToken", + "traits": { + "smithy.api#documentation": "

A token that you can use in a subsequent call to retrieve the next set of\n results.

" + } + } + } + }, + "com.amazonaws.databrew#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.databrew#ListTagsForResourceRequest" + }, + "output": { + "target": "com.amazonaws.databrew#ListTagsForResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.databrew#InternalServerException" + }, + { + "target": "com.amazonaws.databrew#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.databrew#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists all the tags for a DataBrew resource.

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

The Amazon Resource Name (ARN) string that uniquely identifies the DataBrew resource.\n

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.databrew#ListTagsForResourceResponse": { + "type": "structure", + "members": { + "Tags": { + "target": "com.amazonaws.databrew#TagMap", + "traits": { + "smithy.api#documentation": "

A list of tags associated with the DataBrew resource.

" + } + } + } + }, + "com.amazonaws.databrew#LocaleCode": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 2, + "max": 100 + }, + "smithy.api#pattern": "^[A-Za-z0-9_\\.#@\\-]+$" + } + }, + "com.amazonaws.databrew#LogGroupName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + } + } + }, + "com.amazonaws.databrew#LogSubscription": { + "type": "enum", + "members": { + "ENABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLE" + } + }, + "DISABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLE" + } + } + } + }, + "com.amazonaws.databrew#MaxCapacity": { + "type": "integer", + "traits": { + "smithy.api#default": 0 + } + }, + "com.amazonaws.databrew#MaxFiles": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.databrew#MaxOutputFiles": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 999 + } + } + }, + "com.amazonaws.databrew#MaxResults100": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.databrew#MaxRetries": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.databrew#Message": { + "type": "string" + }, + "com.amazonaws.databrew#Metadata": { + "type": "structure", + "members": { + "SourceArn": { + "target": "com.amazonaws.databrew#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) associated with the dataset. Currently, DataBrew \n only supports ARNs from Amazon AppFlow.

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

Contains additional resource information needed for specific datasets.

" + } + }, + "com.amazonaws.databrew#MultiLine": { + "type": "boolean", + "traits": { + "smithy.api#default": false + } + }, + "com.amazonaws.databrew#NextToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2000 + } + } + }, + "com.amazonaws.databrew#OpenedBy": { + "type": "string" + }, + "com.amazonaws.databrew#Operation": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[A-Z\\_]+$" + } + }, + "com.amazonaws.databrew#Order": { + "type": "enum", + "members": { + "DESCENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DESCENDING" + } + }, + "ASCENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ASCENDING" + } + } + } + }, + "com.amazonaws.databrew#OrderedBy": { + "type": "enum", + "members": { + "LAST_MODIFIED_DATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LAST_MODIFIED_DATE" + } + } + } + }, + "com.amazonaws.databrew#Output": { + "type": "structure", + "members": { + "CompressionFormat": { + "target": "com.amazonaws.databrew#CompressionFormat", + "traits": { + "smithy.api#documentation": "

The compression algorithm used to compress the output text of the job.

" + } + }, + "Format": { + "target": "com.amazonaws.databrew#OutputFormat", + "traits": { + "smithy.api#documentation": "

The data format of the output of the job.

" + } + }, + "PartitionColumns": { + "target": "com.amazonaws.databrew#ColumnNameList", + "traits": { + "smithy.api#documentation": "

The names of one or more partition columns for the output of the job.

" + } + }, + "Location": { + "target": "com.amazonaws.databrew#S3Location", + "traits": { + "smithy.api#documentation": "

The location in Amazon S3 where the job writes its output.

", + "smithy.api#required": {} + } + }, + "Overwrite": { + "target": "com.amazonaws.databrew#OverwriteOutput", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A value that, if true, means that any data in the location specified for output is\n overwritten with new output.

" + } + }, + "FormatOptions": { + "target": "com.amazonaws.databrew#OutputFormatOptions", + "traits": { + "smithy.api#documentation": "

Represents options that define how DataBrew formats job output files.

" + } + }, + "MaxOutputFiles": { + "target": "com.amazonaws.databrew#MaxOutputFiles", + "traits": { + "smithy.api#documentation": "

Maximum number of files to be generated by the job and written to the output folder. For output partitioned \n by column(s), the MaxOutputFiles value is the maximum number of files per partition.

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

Represents options that specify how and where in Amazon S3 DataBrew writes the output generated by\n recipe jobs or profile jobs.

" + } + }, + "com.amazonaws.databrew#OutputFormat": { + "type": "enum", + "members": { + "CSV": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CSV" + } + }, + "JSON": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "JSON" + } + }, + "PARQUET": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PARQUET" + } + }, + "GLUEPARQUET": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GLUEPARQUET" + } + }, + "AVRO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AVRO" + } + }, + "ORC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ORC" + } + }, + "XML": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "XML" + } + }, + "TABLEAUHYPER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TABLEAUHYPER" + } + } + } + }, + "com.amazonaws.databrew#OutputFormatOptions": { + "type": "structure", + "members": { + "Csv": { + "target": "com.amazonaws.databrew#CsvOutputOptions", + "traits": { + "smithy.api#documentation": "

Represents a set of options that define the structure of comma-separated value (CSV)\n job output.

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

Represents a set of options that define the structure of comma-separated (CSV) job output.

" + } + }, + "com.amazonaws.databrew#OutputList": { + "type": "list", + "member": { + "target": "com.amazonaws.databrew#Output" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.databrew#OverwriteOutput": { + "type": "boolean", + "traits": { + "smithy.api#default": false + } + }, + "com.amazonaws.databrew#ParameterMap": { + "type": "map", + "key": { + "target": "com.amazonaws.databrew#ParameterName" + }, + "value": { + "target": "com.amazonaws.databrew#ParameterValue" + } + }, + "com.amazonaws.databrew#ParameterName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[A-Za-z0-9]+$" + } + }, + "com.amazonaws.databrew#ParameterType": { + "type": "enum", + "members": { + "Datetime": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Datetime" + } + }, + "Number": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Number" + } + }, + "String": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "String" + } + } + } + }, + "com.amazonaws.databrew#ParameterValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 32768 + } + } + }, + "com.amazonaws.databrew#PathOptions": { + "type": "structure", + "members": { + "LastModifiedDateCondition": { + "target": "com.amazonaws.databrew#FilterExpression", + "traits": { + "smithy.api#documentation": "

If provided, this structure defines a date range for matching Amazon S3 objects based on their \n LastModifiedDate attribute in Amazon S3.

" + } + }, + "FilesLimit": { + "target": "com.amazonaws.databrew#FilesLimit", + "traits": { + "smithy.api#documentation": "

If provided, this structure imposes a limit on a number of files that should be selected.

" + } + }, + "Parameters": { + "target": "com.amazonaws.databrew#PathParametersMap", + "traits": { + "smithy.api#documentation": "

A structure that maps names of parameters used in the Amazon S3 path of a dataset to their definitions.

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

Represents a set of options that define how DataBrew selects files for a given Amazon S3 \n path in a dataset.

" + } + }, + "com.amazonaws.databrew#PathParameterName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "com.amazonaws.databrew#PathParametersMap": { + "type": "map", + "key": { + "target": "com.amazonaws.databrew#PathParameterName" + }, + "value": { + "target": "com.amazonaws.databrew#DatasetParameter" + }, + "traits": { + "smithy.api#documentation": "

A structure that map names of parameters used in the Amazon S3 path of a dataset to their definitions. \n A definition includes parameter type and conditions.

", + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.databrew#Preview": { + "type": "boolean", + "traits": { + "smithy.api#default": false + } + }, + "com.amazonaws.databrew#ProfileConfiguration": { + "type": "structure", + "members": { + "DatasetStatisticsConfiguration": { + "target": "com.amazonaws.databrew#StatisticsConfiguration", + "traits": { + "smithy.api#documentation": "

Configuration for inter-column evaluations. Configuration can be used to select evaluations and override \n parameters of evaluations. When configuration is undefined, the profile job will run all supported \n inter-column evaluations.\n

" + } + }, + "ProfileColumns": { + "target": "com.amazonaws.databrew#ColumnSelectorList", + "traits": { + "smithy.api#documentation": "

List of column selectors. ProfileColumns can be used to select columns from the dataset. When \n ProfileColumns is undefined, the profile job will profile all supported columns.\n

" + } + }, + "ColumnStatisticsConfigurations": { + "target": "com.amazonaws.databrew#ColumnStatisticsConfigurationList", + "traits": { + "smithy.api#documentation": "

List of configurations for column evaluations. ColumnStatisticsConfigurations are used to \n select evaluations and override parameters of evaluations for particular columns. When \n ColumnStatisticsConfigurations is undefined, the profile job will profile all supported columns \n and run all supported evaluations.\n

" + } + }, + "EntityDetectorConfiguration": { + "target": "com.amazonaws.databrew#EntityDetectorConfiguration", + "traits": { + "smithy.api#documentation": "

Configuration of entity detection for a profile job. When undefined, entity detection is disabled.

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

Configuration for profile jobs. Configuration can be used to select columns, do evaluations, and override default \n parameters of evaluations. When configuration is undefined, the profile job will apply default settings to all \n supported columns.\n

" + } + }, + "com.amazonaws.databrew#Project": { + "type": "structure", + "members": { + "AccountId": { + "target": "com.amazonaws.databrew#AccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the project.

" + } + }, + "CreateDate": { + "target": "com.amazonaws.databrew#Date", + "traits": { + "smithy.api#documentation": "

The date and time that the project was created.

" + } + }, + "CreatedBy": { + "target": "com.amazonaws.databrew#CreatedBy", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the user who crated the project.

" + } + }, + "DatasetName": { + "target": "com.amazonaws.databrew#DatasetName", + "traits": { + "smithy.api#documentation": "

The dataset that the project is to act upon.

" + } + }, + "LastModifiedDate": { + "target": "com.amazonaws.databrew#Date", + "traits": { + "smithy.api#documentation": "

The last modification date and time for the project.

" + } + }, + "LastModifiedBy": { + "target": "com.amazonaws.databrew#LastModifiedBy", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the user who last modified the project.

" + } + }, + "Name": { + "target": "com.amazonaws.databrew#ProjectName", + "traits": { + "smithy.api#documentation": "

The unique name of a project.

", + "smithy.api#required": {} + } + }, + "RecipeName": { + "target": "com.amazonaws.databrew#RecipeName", + "traits": { + "smithy.api#documentation": "

The name of a recipe that will be developed during a project session.

", + "smithy.api#required": {} + } + }, + "ResourceArn": { + "target": "com.amazonaws.databrew#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the project.

" + } + }, + "Sample": { + "target": "com.amazonaws.databrew#Sample", + "traits": { + "smithy.api#documentation": "

The sample size and sampling type to apply to the data. If this parameter isn't\n specified, then the sample consists of the first 500 rows from the dataset.

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

Metadata tags that have been applied to the project.

" + } + }, + "RoleArn": { + "target": "com.amazonaws.databrew#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the role that will be assumed for this\n project.

" + } + }, + "OpenedBy": { + "target": "com.amazonaws.databrew#OpenedBy", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the user that opened the project for use.

" + } + }, + "OpenDate": { + "target": "com.amazonaws.databrew#Date", + "traits": { + "smithy.api#documentation": "

The date and time when the project was opened.

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

Represents all of the attributes of a DataBrew project.

" + } + }, + "com.amazonaws.databrew#ProjectList": { + "type": "list", + "member": { + "target": "com.amazonaws.databrew#Project" + } + }, + "com.amazonaws.databrew#ProjectName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "com.amazonaws.databrew#PublishRecipe": { + "type": "operation", + "input": { + "target": "com.amazonaws.databrew#PublishRecipeRequest" + }, + "output": { + "target": "com.amazonaws.databrew#PublishRecipeResponse" + }, + "errors": [ + { + "target": "com.amazonaws.databrew#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.databrew#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.databrew#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Publishes a new version of a DataBrew recipe.

", + "smithy.api#http": { + "method": "POST", + "uri": "/recipes/{Name}/publishRecipe", + "code": 200 + } + } + }, + "com.amazonaws.databrew#PublishRecipeRequest": { + "type": "structure", + "members": { + "Description": { + "target": "com.amazonaws.databrew#RecipeDescription", + "traits": { + "smithy.api#documentation": "

A description of the recipe to be published, for this version of the recipe.

" + } + }, + "Name": { + "target": "com.amazonaws.databrew#RecipeName", + "traits": { + "smithy.api#documentation": "

The name of the recipe to be published.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.databrew#PublishRecipeResponse": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.databrew#RecipeName", + "traits": { + "smithy.api#documentation": "

The name of the recipe that you published.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.databrew#PublishedBy": { + "type": "string" + }, + "com.amazonaws.databrew#QueryString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10000 + } + } + }, + "com.amazonaws.databrew#Recipe": { + "type": "structure", + "members": { + "CreatedBy": { + "target": "com.amazonaws.databrew#CreatedBy", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the user who created the recipe.

" + } + }, + "CreateDate": { + "target": "com.amazonaws.databrew#Date", + "traits": { + "smithy.api#documentation": "

The date and time that the recipe was created.

" + } + }, + "LastModifiedBy": { + "target": "com.amazonaws.databrew#LastModifiedBy", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the user who last modified the recipe.

" + } + }, + "LastModifiedDate": { + "target": "com.amazonaws.databrew#Date", + "traits": { + "smithy.api#documentation": "

The last modification date and time of the recipe.

" + } + }, + "ProjectName": { + "target": "com.amazonaws.databrew#ProjectName", + "traits": { + "smithy.api#documentation": "

The name of the project that the recipe is associated with.

" + } + }, + "PublishedBy": { + "target": "com.amazonaws.databrew#PublishedBy", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the user who published the recipe.

" + } + }, + "PublishedDate": { + "target": "com.amazonaws.databrew#Date", + "traits": { + "smithy.api#documentation": "

The date and time when the recipe was published.

" + } + }, + "Description": { + "target": "com.amazonaws.databrew#RecipeDescription", + "traits": { + "smithy.api#documentation": "

The description of the recipe.

" + } + }, + "Name": { + "target": "com.amazonaws.databrew#RecipeName", + "traits": { + "smithy.api#documentation": "

The unique name for the recipe.

", + "smithy.api#required": {} + } + }, + "ResourceArn": { + "target": "com.amazonaws.databrew#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the recipe.

" + } + }, + "Steps": { + "target": "com.amazonaws.databrew#RecipeStepList", + "traits": { + "smithy.api#documentation": "

A list of steps that are defined by the recipe.

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

Metadata tags that have been applied to the recipe.

" + } + }, + "RecipeVersion": { + "target": "com.amazonaws.databrew#RecipeVersion", + "traits": { + "smithy.api#documentation": "

The identifier for the version for the recipe. Must be one of the following:

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents one or more actions to be performed on a DataBrew dataset.

" + } + }, + "com.amazonaws.databrew#RecipeAction": { + "type": "structure", + "members": { + "Operation": { + "target": "com.amazonaws.databrew#Operation", + "traits": { + "smithy.api#documentation": "

The name of a valid DataBrew transformation to be performed on the data.

", + "smithy.api#required": {} + } + }, + "Parameters": { + "target": "com.amazonaws.databrew#ParameterMap", + "traits": { + "smithy.api#documentation": "

Contextual parameters for the transformation.

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

Represents a transformation and associated parameters that are used to apply a change\n to a DataBrew dataset. For more information, see Recipe\n actions reference.

" + } + }, + "com.amazonaws.databrew#RecipeDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + } + } + }, + "com.amazonaws.databrew#RecipeErrorList": { + "type": "list", + "member": { + "target": "com.amazonaws.databrew#RecipeVersionErrorDetail" + } + }, + "com.amazonaws.databrew#RecipeErrorMessage": { + "type": "string" + }, + "com.amazonaws.databrew#RecipeList": { + "type": "list", + "member": { + "target": "com.amazonaws.databrew#Recipe" + } + }, + "com.amazonaws.databrew#RecipeName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "com.amazonaws.databrew#RecipeReference": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.databrew#RecipeName", + "traits": { + "smithy.api#documentation": "

The name of the recipe.

", + "smithy.api#required": {} + } + }, + "RecipeVersion": { + "target": "com.amazonaws.databrew#RecipeVersion", + "traits": { + "smithy.api#documentation": "

The identifier for the version for the recipe.

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

Represents the name and version of a DataBrew recipe.

" + } + }, + "com.amazonaws.databrew#RecipeStep": { + "type": "structure", + "members": { + "Action": { + "target": "com.amazonaws.databrew#RecipeAction", + "traits": { + "smithy.api#documentation": "

The particular action to be performed in the recipe step.

", + "smithy.api#required": {} + } + }, + "ConditionExpressions": { + "target": "com.amazonaws.databrew#ConditionExpressionList", + "traits": { + "smithy.api#documentation": "

One or more conditions that must be met for the recipe step to succeed.

\n \n

All of the conditions in the array must be met. In other words, all of the\n conditions must be combined using a logical AND operation.

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents a single step from a DataBrew recipe to be performed.

" + } + }, + "com.amazonaws.databrew#RecipeStepList": { + "type": "list", + "member": { + "target": "com.amazonaws.databrew#RecipeStep" + } + }, + "com.amazonaws.databrew#RecipeVersion": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 16 + } + } + }, + "com.amazonaws.databrew#RecipeVersionErrorDetail": { + "type": "structure", + "members": { + "ErrorCode": { + "target": "com.amazonaws.databrew#ErrorCode", + "traits": { + "smithy.api#documentation": "

The HTTP status code for the error.

" + } + }, + "ErrorMessage": { + "target": "com.amazonaws.databrew#RecipeErrorMessage", + "traits": { + "smithy.api#documentation": "

The text of the error message.

" + } + }, + "RecipeVersion": { + "target": "com.amazonaws.databrew#RecipeVersion", + "traits": { + "smithy.api#documentation": "

The identifier for the recipe version associated with this error.

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

Represents any errors encountered when attempting to delete multiple recipe\n versions.

" + } + }, + "com.amazonaws.databrew#RecipeVersionList": { + "type": "list", + "member": { + "target": "com.amazonaws.databrew#RecipeVersion" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.databrew#ResourceNotFoundException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.databrew#Message" + } + }, + "traits": { + "smithy.api#documentation": "

One or more resources can't be found.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.databrew#Result": { + "type": "string" + }, + "com.amazonaws.databrew#RowRange": { + "type": "integer" + }, + "com.amazonaws.databrew#Rule": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.databrew#RuleName", + "traits": { + "smithy.api#documentation": "

The name of the rule.

", + "smithy.api#required": {} + } + }, + "Disabled": { + "target": "com.amazonaws.databrew#Disabled", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A value that specifies whether the rule is disabled. Once a rule is \n disabled, a profile job will not validate it during a job run. Default \n value is false.

" + } + }, + "CheckExpression": { + "target": "com.amazonaws.databrew#Expression", + "traits": { + "smithy.api#documentation": "

The expression which includes column references, condition names followed by variable\n references, possibly grouped and combined with other conditions. For example,\n (:col1 starts_with :prefix1 or :col1 starts_with :prefix2) and (:col1\n ends_with :suffix1 or :col1 ends_with :suffix2). Column and value references\n are substitution variables that should start with the ':' symbol. Depending on the\n context, substitution variables' values can be either an actual value or a column name.\n These values are defined in the SubstitutionMap. If a CheckExpression starts with a\n column reference, then ColumnSelectors in the rule should be null. If ColumnSelectors\n has been defined, then there should be no column reference in the left side of a\n condition, for example, is_between :val1 and :val2.

\n

For more information, see Available checks\n

", + "smithy.api#required": {} + } + }, + "SubstitutionMap": { + "target": "com.amazonaws.databrew#ValuesMap", + "traits": { + "smithy.api#documentation": "

The map of substitution variable names to their values used in a check \n expression. Variable names should start with a ':' (colon). Variable values can either \n be actual values or column names. To differentiate between the two, column names \n should be enclosed in backticks, for example, \":col1\": \"`Column A`\".\n

" + } + }, + "Threshold": { + "target": "com.amazonaws.databrew#Threshold", + "traits": { + "smithy.api#documentation": "

The threshold used with a non-aggregate check expression. Non-aggregate check expressions \n will be applied to each row in a specific column, and the threshold will be used to determine \n whether the validation succeeds.

" + } + }, + "ColumnSelectors": { + "target": "com.amazonaws.databrew#ColumnSelectorList", + "traits": { + "smithy.api#documentation": "

List of column selectors. Selectors can be used to select columns using a name or regular \n expression from the dataset. Rule will be applied to selected columns.

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

Represents a single data quality requirement that should be validated in the \n scope of this dataset.

" + } + }, + "com.amazonaws.databrew#RuleCount": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.databrew#RuleList": { + "type": "list", + "member": { + "target": "com.amazonaws.databrew#Rule" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.databrew#RuleName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.databrew#RulesetDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + } + } + }, + "com.amazonaws.databrew#RulesetItem": { + "type": "structure", + "members": { + "AccountId": { + "target": "com.amazonaws.databrew#AccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the ruleset.

" + } + }, + "CreatedBy": { + "target": "com.amazonaws.databrew#CreatedBy", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the user who created the ruleset.

" + } + }, + "CreateDate": { + "target": "com.amazonaws.databrew#Date", + "traits": { + "smithy.api#documentation": "

The date and time that the ruleset was created.

" + } + }, + "Description": { + "target": "com.amazonaws.databrew#RulesetDescription", + "traits": { + "smithy.api#documentation": "

The description of the ruleset.

" + } + }, + "LastModifiedBy": { + "target": "com.amazonaws.databrew#LastModifiedBy", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the user who last modified the ruleset.

" + } + }, + "LastModifiedDate": { + "target": "com.amazonaws.databrew#Date", + "traits": { + "smithy.api#documentation": "

The modification date and time of the ruleset.

" + } + }, + "Name": { + "target": "com.amazonaws.databrew#RulesetName", + "traits": { + "smithy.api#documentation": "

The name of the ruleset.

", + "smithy.api#required": {} + } + }, + "ResourceArn": { + "target": "com.amazonaws.databrew#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the ruleset.

" + } + }, + "RuleCount": { + "target": "com.amazonaws.databrew#RuleCount", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of rules that are defined in the ruleset.

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

Metadata tags that have been applied to the ruleset.

" + } + }, + "TargetArn": { + "target": "com.amazonaws.databrew#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a resource (dataset) that the ruleset is \n associated with.

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

Contains metadata about the ruleset.

" + } + }, + "com.amazonaws.databrew#RulesetItemList": { + "type": "list", + "member": { + "target": "com.amazonaws.databrew#RulesetItem" + } + }, + "com.amazonaws.databrew#RulesetName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "com.amazonaws.databrew#S3Location": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.databrew#Bucket", + "traits": { + "smithy.api#documentation": "

The Amazon S3 bucket name.

", + "smithy.api#required": {} + } + }, + "Key": { + "target": "com.amazonaws.databrew#Key", + "traits": { + "smithy.api#documentation": "

The unique name of the object in the bucket.

" + } + }, + "BucketOwner": { + "target": "com.amazonaws.databrew#BucketOwner", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID of the bucket owner.

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

Represents an Amazon S3 location (bucket name, bucket owner, and object key) where DataBrew can read\n input data, or write output from a job.

" + } + }, + "com.amazonaws.databrew#S3TableOutputOptions": { + "type": "structure", + "members": { + "Location": { + "target": "com.amazonaws.databrew#S3Location", + "traits": { + "smithy.api#documentation": "

Represents an Amazon S3 location (bucket name and object key) where DataBrew can write output \n from a job.

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

Represents options that specify how and where DataBrew writes the Amazon S3 output \n generated by recipe jobs.

" + } + }, + "com.amazonaws.databrew#Sample": { + "type": "structure", + "members": { + "Size": { + "target": "com.amazonaws.databrew#SampleSize", + "traits": { + "smithy.api#documentation": "

The number of rows in the sample.

" + } + }, + "Type": { + "target": "com.amazonaws.databrew#SampleType", + "traits": { + "smithy.api#documentation": "

The way in which DataBrew obtains rows from a dataset.

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

Represents the sample size and sampling type for DataBrew to use for interactive data\n analysis.

" + } + }, + "com.amazonaws.databrew#SampleMode": { + "type": "enum", + "members": { + "FULL_DATASET": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FULL_DATASET" + } + }, + "CUSTOM_ROWS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CUSTOM_ROWS" + } + } + } + }, + "com.amazonaws.databrew#SampleSize": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 5000 + } + } + }, + "com.amazonaws.databrew#SampleType": { + "type": "enum", + "members": { + "FIRST_N": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FIRST_N" + } + }, + "LAST_N": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LAST_N" + } + }, + "RANDOM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RANDOM" + } + } + } + }, + "com.amazonaws.databrew#Schedule": { + "type": "structure", + "members": { + "AccountId": { + "target": "com.amazonaws.databrew#AccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the schedule.

" + } + }, + "CreatedBy": { + "target": "com.amazonaws.databrew#CreatedBy", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the user who created the schedule.

" + } + }, + "CreateDate": { + "target": "com.amazonaws.databrew#Date", + "traits": { + "smithy.api#documentation": "

The date and time that the schedule was created.

" + } + }, + "JobNames": { + "target": "com.amazonaws.databrew#JobNameList", + "traits": { + "smithy.api#documentation": "

A list of jobs to be run, according to the schedule.

" + } + }, + "LastModifiedBy": { + "target": "com.amazonaws.databrew#LastModifiedBy", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the user who last modified the schedule.

" + } + }, + "LastModifiedDate": { + "target": "com.amazonaws.databrew#Date", + "traits": { + "smithy.api#documentation": "

The date and time when the schedule was last modified.

" + } + }, + "ResourceArn": { + "target": "com.amazonaws.databrew#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the schedule.

" + } + }, + "CronExpression": { + "target": "com.amazonaws.databrew#CronExpression", + "traits": { + "smithy.api#documentation": "

The dates and times when the job is to run. For more information, see Cron\n expressions in the Glue DataBrew Developer\n Guide.

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

Metadata tags that have been applied to the schedule.

" + } + }, + "Name": { + "target": "com.amazonaws.databrew#ScheduleName", + "traits": { + "smithy.api#documentation": "

The name of the schedule.

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

Represents one or more dates and times when a job is to run.

" + } + }, + "com.amazonaws.databrew#ScheduleList": { + "type": "list", + "member": { + "target": "com.amazonaws.databrew#Schedule" + } + }, + "com.amazonaws.databrew#ScheduleName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "com.amazonaws.databrew#SendProjectSessionAction": { + "type": "operation", + "input": { + "target": "com.amazonaws.databrew#SendProjectSessionActionRequest" + }, + "output": { + "target": "com.amazonaws.databrew#SendProjectSessionActionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.databrew#ConflictException" + }, + { + "target": "com.amazonaws.databrew#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.databrew#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Performs a recipe step within an interactive DataBrew session that's currently\n open.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/projects/{Name}/sendProjectSessionAction", + "code": 200 + } + } + }, + "com.amazonaws.databrew#SendProjectSessionActionRequest": { + "type": "structure", + "members": { + "Preview": { + "target": "com.amazonaws.databrew#Preview", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

If true, the result of the recipe step will be returned, but not applied.

" + } + }, + "Name": { + "target": "com.amazonaws.databrew#ProjectName", + "traits": { + "smithy.api#documentation": "

The name of the project to apply the action to.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "RecipeStep": { + "target": "com.amazonaws.databrew#RecipeStep" + }, + "StepIndex": { + "target": "com.amazonaws.databrew#StepIndex", + "traits": { + "smithy.api#documentation": "

The index from which to preview a step. This index is used to preview the result of\n steps that have already been applied, so that the resulting view frame is from earlier\n in the view frame stack.

" + } + }, + "ClientSessionId": { + "target": "com.amazonaws.databrew#ClientSessionId", + "traits": { + "smithy.api#documentation": "

A unique identifier for an interactive session that's currently open and ready for\n work. The action will be performed on this session.

" + } + }, + "ViewFrame": { + "target": "com.amazonaws.databrew#ViewFrame" + } + } + }, + "com.amazonaws.databrew#SendProjectSessionActionResponse": { + "type": "structure", + "members": { + "Result": { + "target": "com.amazonaws.databrew#Result", + "traits": { + "smithy.api#documentation": "

A message indicating the result of performing the action.

" + } + }, + "Name": { + "target": "com.amazonaws.databrew#ProjectName", + "traits": { + "smithy.api#documentation": "

The name of the project that was affected by the action.

", + "smithy.api#required": {} + } + }, + "ActionId": { + "target": "com.amazonaws.databrew#ActionId", + "traits": { + "smithy.api#documentation": "

A unique identifier for the action that was performed.

" + } + } + } + }, + "com.amazonaws.databrew#ServiceQuotaExceededException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.databrew#Message" + } + }, + "traits": { + "smithy.api#documentation": "

A service quota is exceeded.

", + "smithy.api#error": "client", + "smithy.api#httpError": 402 + } + }, + "com.amazonaws.databrew#SessionStatus": { + "type": "enum", + "members": { + "ASSIGNED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ASSIGNED" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "INITIALIZING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INITIALIZING" + } + }, + "PROVISIONING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PROVISIONING" + } + }, + "READY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "READY" + } + }, + "RECYCLING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RECYCLING" + } + }, + "ROTATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ROTATING" + } + }, + "TERMINATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TERMINATED" + } + }, + "TERMINATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TERMINATING" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" + } + } + } + }, + "com.amazonaws.databrew#SheetIndex": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.databrew#SheetIndexList": { + "type": "list", + "member": { + "target": "com.amazonaws.databrew#SheetIndex" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.databrew#SheetName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 31 + } + } + }, + "com.amazonaws.databrew#SheetNameList": { + "type": "list", + "member": { + "target": "com.amazonaws.databrew#SheetName" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.databrew#Source": { + "type": "enum", + "members": { + "S3": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "S3" + } + }, + "DATACATALOG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DATA-CATALOG" + } + }, + "DATABASE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DATABASE" + } + } + } + }, + "com.amazonaws.databrew#StartColumnIndex": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.databrew#StartJobRun": { + "type": "operation", + "input": { + "target": "com.amazonaws.databrew#StartJobRunRequest" + }, + "output": { + "target": "com.amazonaws.databrew#StartJobRunResponse" + }, + "errors": [ + { + "target": "com.amazonaws.databrew#ConflictException" + }, + { + "target": "com.amazonaws.databrew#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.databrew#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.databrew#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Runs a DataBrew job.

", + "smithy.api#http": { + "method": "POST", + "uri": "/jobs/{Name}/startJobRun", + "code": 200 + } + } + }, + "com.amazonaws.databrew#StartJobRunRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.databrew#JobName", + "traits": { + "smithy.api#documentation": "

The name of the job to be run.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.databrew#StartJobRunResponse": { + "type": "structure", + "members": { + "RunId": { + "target": "com.amazonaws.databrew#JobRunId", + "traits": { + "smithy.api#documentation": "

A system-generated identifier for this particular job run.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.databrew#StartProjectSession": { + "type": "operation", + "input": { + "target": "com.amazonaws.databrew#StartProjectSessionRequest" + }, + "output": { + "target": "com.amazonaws.databrew#StartProjectSessionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.databrew#ConflictException" + }, + { + "target": "com.amazonaws.databrew#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.databrew#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.databrew#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates an interactive session, enabling you to manipulate data in a DataBrew\n project.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/projects/{Name}/startProjectSession", + "code": 200 + } + } + }, + "com.amazonaws.databrew#StartProjectSessionRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.databrew#ProjectName", + "traits": { + "smithy.api#documentation": "

The name of the project to act upon.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AssumeControl": { + "target": "com.amazonaws.databrew#AssumeControl", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A value that, if true, enables you to take control of a session, even if a different\n client is currently accessing the project.

" + } + } + } + }, + "com.amazonaws.databrew#StartProjectSessionResponse": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.databrew#ProjectName", + "traits": { + "smithy.api#documentation": "

The name of the project to be acted upon.

", + "smithy.api#required": {} + } + }, + "ClientSessionId": { + "target": "com.amazonaws.databrew#ClientSessionId", + "traits": { + "smithy.api#documentation": "

A system-generated identifier for the session.

" + } + } + } + }, + "com.amazonaws.databrew#StartRowIndex": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.databrew#StartedBy": { + "type": "string" + }, + "com.amazonaws.databrew#Statistic": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[A-Z\\_]+$" + } + }, + "com.amazonaws.databrew#StatisticList": { + "type": "list", + "member": { + "target": "com.amazonaws.databrew#Statistic" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.databrew#StatisticOverride": { + "type": "structure", + "members": { + "Statistic": { + "target": "com.amazonaws.databrew#Statistic", + "traits": { + "smithy.api#documentation": "

The name of an evaluation

", + "smithy.api#required": {} + } + }, + "Parameters": { + "target": "com.amazonaws.databrew#ParameterMap", + "traits": { + "smithy.api#documentation": "

A map that includes overrides of an evaluation’s parameters.

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

Override of a particular evaluation for a profile job.

" + } + }, + "com.amazonaws.databrew#StatisticOverrideList": { + "type": "list", + "member": { + "target": "com.amazonaws.databrew#StatisticOverride" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.databrew#StatisticsConfiguration": { + "type": "structure", + "members": { + "IncludedStatistics": { + "target": "com.amazonaws.databrew#StatisticList", + "traits": { + "smithy.api#documentation": "

List of included evaluations. When the list is undefined, all supported \n evaluations will be included.

" + } + }, + "Overrides": { + "target": "com.amazonaws.databrew#StatisticOverrideList", + "traits": { + "smithy.api#documentation": "

List of overrides for evaluations.

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

Configuration of evaluations for a profile job. This configuration can be used to select \n evaluations and override the parameters of selected evaluations.\n

" + } + }, + "com.amazonaws.databrew#StepIndex": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.databrew#StopJobRun": { + "type": "operation", + "input": { + "target": "com.amazonaws.databrew#StopJobRunRequest" + }, + "output": { + "target": "com.amazonaws.databrew#StopJobRunResponse" + }, + "errors": [ + { + "target": "com.amazonaws.databrew#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.databrew#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Stops a particular run of a job.

", + "smithy.api#http": { + "method": "POST", + "uri": "/jobs/{Name}/jobRun/{RunId}/stopJobRun", + "code": 200 + } + } + }, + "com.amazonaws.databrew#StopJobRunRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.databrew#JobName", + "traits": { + "smithy.api#documentation": "

The name of the job to be stopped.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "RunId": { + "target": "com.amazonaws.databrew#JobRunId", + "traits": { + "smithy.api#documentation": "

The ID of the job run to be stopped.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.databrew#StopJobRunResponse": { + "type": "structure", + "members": { + "RunId": { + "target": "com.amazonaws.databrew#JobRunId", + "traits": { + "smithy.api#documentation": "

The ID of the job run that you stopped.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.databrew#TableName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "com.amazonaws.databrew#TagKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.databrew#TagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.databrew#TagKey" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + } + } + }, + "com.amazonaws.databrew#TagMap": { + "type": "map", + "key": { + "target": "com.amazonaws.databrew#TagKey" + }, + "value": { + "target": "com.amazonaws.databrew#TagValue" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + } + } + }, + "com.amazonaws.databrew#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.databrew#TagResourceRequest" + }, + "output": { + "target": "com.amazonaws.databrew#TagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.databrew#InternalServerException" + }, + { + "target": "com.amazonaws.databrew#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.databrew#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Adds metadata tags to a DataBrew resource, such as a dataset, project, recipe, job, or\n schedule.

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

The DataBrew resource to which tags should be added. The value for this parameter is\n an Amazon Resource Name (ARN). For DataBrew, you can tag a dataset, a job, a project, or\n a recipe.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.databrew#TagMap", + "traits": { + "smithy.api#documentation": "

One or more tags to be assigned to the resource.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.databrew#TagResourceResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.databrew#TagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.databrew#TargetColumn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + } + } + }, + "com.amazonaws.databrew#Threshold": { + "type": "structure", + "members": { + "Value": { + "target": "com.amazonaws.databrew#ThresholdValue", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The value of a threshold.

", + "smithy.api#required": {} + } + }, + "Type": { + "target": "com.amazonaws.databrew#ThresholdType", + "traits": { + "smithy.api#documentation": "

The type of a threshold. Used for comparison of an actual count of rows that satisfy the \n rule to the threshold value.

" + } + }, + "Unit": { + "target": "com.amazonaws.databrew#ThresholdUnit", + "traits": { + "smithy.api#documentation": "

Unit of threshold value. Can be either a COUNT or PERCENTAGE of the full sample size \n used for validation.

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

The threshold used with a non-aggregate check expression. The non-aggregate check expression \n will be applied to each row in a specific column. Then the threshold will be used to determine \n whether the validation succeeds.

" + } + }, + "com.amazonaws.databrew#ThresholdType": { + "type": "enum", + "members": { + "GREATER_THAN_OR_EQUAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GREATER_THAN_OR_EQUAL" + } + }, + "LESS_THAN_OR_EQUAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LESS_THAN_OR_EQUAL" + } + }, + "GREATER_THAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GREATER_THAN" + } + }, + "LESS_THAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LESS_THAN" + } + } + } + }, + "com.amazonaws.databrew#ThresholdUnit": { + "type": "enum", + "members": { + "COUNT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COUNT" + } + }, + "PERCENTAGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PERCENTAGE" + } + } + } + }, + "com.amazonaws.databrew#ThresholdValue": { + "type": "double", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.databrew#Timeout": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.databrew#TimezoneOffset": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 6 + }, + "smithy.api#pattern": "^(Z|[-+](\\d|\\d{2}|\\d{2}:?\\d{2}))$" + } + }, + "com.amazonaws.databrew#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.databrew#UntagResourceRequest" + }, + "output": { + "target": "com.amazonaws.databrew#UntagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.databrew#InternalServerException" + }, + { + "target": "com.amazonaws.databrew#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.databrew#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Removes metadata tags from a DataBrew resource.

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

A DataBrew resource from which you want to remove a tag or tags. The value for this\n parameter is an Amazon Resource Name (ARN).

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "TagKeys": { + "target": "com.amazonaws.databrew#TagKeyList", + "traits": { + "smithy.api#documentation": "

The tag keys (names) of one or more tags to be removed.

", + "smithy.api#httpQuery": "tagKeys", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.databrew#UntagResourceResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.databrew#UpdateDataset": { + "type": "operation", + "input": { + "target": "com.amazonaws.databrew#UpdateDatasetRequest" + }, + "output": { + "target": "com.amazonaws.databrew#UpdateDatasetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.databrew#AccessDeniedException" + }, + { + "target": "com.amazonaws.databrew#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.databrew#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Modifies the definition of an existing DataBrew dataset.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/datasets/{Name}", + "code": 200 + } + } + }, + "com.amazonaws.databrew#UpdateDatasetRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.databrew#DatasetName", + "traits": { + "smithy.api#documentation": "

The name of the dataset to be updated.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Format": { + "target": "com.amazonaws.databrew#InputFormat", + "traits": { + "smithy.api#documentation": "

The file format of a dataset that is created from an Amazon S3 file or folder.

" + } + }, + "FormatOptions": { + "target": "com.amazonaws.databrew#FormatOptions" + }, + "Input": { + "target": "com.amazonaws.databrew#Input", + "traits": { + "smithy.api#required": {} + } + }, + "PathOptions": { + "target": "com.amazonaws.databrew#PathOptions", + "traits": { + "smithy.api#documentation": "

A set of options that defines how DataBrew interprets an Amazon S3 path of the dataset.

" + } + } + } + }, + "com.amazonaws.databrew#UpdateDatasetResponse": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.databrew#DatasetName", + "traits": { + "smithy.api#documentation": "

The name of the dataset that you updated.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.databrew#UpdateProfileJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.databrew#UpdateProfileJobRequest" + }, + "output": { + "target": "com.amazonaws.databrew#UpdateProfileJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.databrew#AccessDeniedException" + }, + { + "target": "com.amazonaws.databrew#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.databrew#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Modifies the definition of an existing profile job.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/profileJobs/{Name}", + "code": 200 + } + } + }, + "com.amazonaws.databrew#UpdateProfileJobRequest": { + "type": "structure", + "members": { + "Configuration": { + "target": "com.amazonaws.databrew#ProfileConfiguration", + "traits": { + "smithy.api#documentation": "

Configuration for profile jobs. Used to select columns, do evaluations, \n and override default parameters of evaluations. When configuration is null, the\n profile job will run with default settings.

" + } + }, + "EncryptionKeyArn": { + "target": "com.amazonaws.databrew#EncryptionKeyArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an encryption key that is used to protect the\n job.

" + } + }, + "EncryptionMode": { + "target": "com.amazonaws.databrew#EncryptionMode", + "traits": { + "smithy.api#documentation": "

The encryption mode for the job, which can be one of the following:

\n " + } + }, + "Name": { + "target": "com.amazonaws.databrew#JobName", + "traits": { + "smithy.api#documentation": "

The name of the job to be updated.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "LogSubscription": { + "target": "com.amazonaws.databrew#LogSubscription", + "traits": { + "smithy.api#documentation": "

Enables or disables Amazon CloudWatch logging for the job. If logging is enabled,\n CloudWatch writes one log stream for each job run.

" + } + }, + "MaxCapacity": { + "target": "com.amazonaws.databrew#MaxCapacity", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of compute nodes that DataBrew can use when the job processes\n data.

" + } + }, + "MaxRetries": { + "target": "com.amazonaws.databrew#MaxRetries", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of times to retry the job after a job run fails.

" + } + }, + "OutputLocation": { + "target": "com.amazonaws.databrew#S3Location", + "traits": { + "smithy.api#required": {} + } + }, + "ValidationConfigurations": { + "target": "com.amazonaws.databrew#ValidationConfigurationList", + "traits": { + "smithy.api#documentation": "

List of validation configurations that are applied to the profile job.

" + } + }, + "RoleArn": { + "target": "com.amazonaws.databrew#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role to\n be assumed when DataBrew runs the job.

", + "smithy.api#required": {} + } + }, + "Timeout": { + "target": "com.amazonaws.databrew#Timeout", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The job's timeout in minutes. A job that attempts to run longer than this timeout\n period ends with a status of TIMEOUT.

" + } + }, + "JobSample": { + "target": "com.amazonaws.databrew#JobSample", + "traits": { + "smithy.api#documentation": "

Sample configuration for Profile Jobs only. Determines the number of rows on which the\n Profile job will be executed. If a JobSample value is not provided for profile jobs, the\n default value will be used. The default value is CUSTOM_ROWS for the mode parameter and\n 20000 for the size parameter.

" + } + } + } + }, + "com.amazonaws.databrew#UpdateProfileJobResponse": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.databrew#JobName", + "traits": { + "smithy.api#documentation": "

The name of the job that was updated.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.databrew#UpdateProject": { + "type": "operation", + "input": { + "target": "com.amazonaws.databrew#UpdateProjectRequest" + }, + "output": { + "target": "com.amazonaws.databrew#UpdateProjectResponse" + }, + "errors": [ + { + "target": "com.amazonaws.databrew#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.databrew#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Modifies the definition of an existing DataBrew project.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/projects/{Name}", + "code": 200 + } + } + }, + "com.amazonaws.databrew#UpdateProjectRequest": { + "type": "structure", + "members": { + "Sample": { + "target": "com.amazonaws.databrew#Sample" + }, + "RoleArn": { + "target": "com.amazonaws.databrew#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role to be assumed for this request.

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.databrew#ProjectName", + "traits": { + "smithy.api#documentation": "

The name of the project to be updated.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.databrew#UpdateProjectResponse": { + "type": "structure", + "members": { + "LastModifiedDate": { + "target": "com.amazonaws.databrew#Date", + "traits": { + "smithy.api#documentation": "

The date and time that the project was last modified.

" + } + }, + "Name": { + "target": "com.amazonaws.databrew#ProjectName", + "traits": { + "smithy.api#documentation": "

The name of the project that you updated.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.databrew#UpdateRecipe": { + "type": "operation", + "input": { + "target": "com.amazonaws.databrew#UpdateRecipeRequest" + }, + "output": { + "target": "com.amazonaws.databrew#UpdateRecipeResponse" + }, + "errors": [ + { + "target": "com.amazonaws.databrew#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.databrew#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Modifies the definition of the LATEST_WORKING version of a DataBrew\n recipe.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/recipes/{Name}", + "code": 200 + } + } + }, + "com.amazonaws.databrew#UpdateRecipeJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.databrew#UpdateRecipeJobRequest" + }, + "output": { + "target": "com.amazonaws.databrew#UpdateRecipeJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.databrew#AccessDeniedException" + }, + { + "target": "com.amazonaws.databrew#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.databrew#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Modifies the definition of an existing DataBrew recipe job.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/recipeJobs/{Name}", + "code": 200 + } + } + }, + "com.amazonaws.databrew#UpdateRecipeJobRequest": { + "type": "structure", + "members": { + "EncryptionKeyArn": { + "target": "com.amazonaws.databrew#EncryptionKeyArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an encryption key that is used to protect the\n job.

" + } + }, + "EncryptionMode": { + "target": "com.amazonaws.databrew#EncryptionMode", + "traits": { + "smithy.api#documentation": "

The encryption mode for the job, which can be one of the following:

\n " + } + }, + "Name": { + "target": "com.amazonaws.databrew#JobName", + "traits": { + "smithy.api#documentation": "

The name of the job to update.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "LogSubscription": { + "target": "com.amazonaws.databrew#LogSubscription", + "traits": { + "smithy.api#documentation": "

Enables or disables Amazon CloudWatch logging for the job. If logging is enabled,\n CloudWatch writes one log stream for each job run.

" + } + }, + "MaxCapacity": { + "target": "com.amazonaws.databrew#MaxCapacity", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of nodes that DataBrew can consume when the job processes\n data.

" + } + }, + "MaxRetries": { + "target": "com.amazonaws.databrew#MaxRetries", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of times to retry the job after a job run fails.

" + } + }, + "Outputs": { + "target": "com.amazonaws.databrew#OutputList", + "traits": { + "smithy.api#documentation": "

One or more artifacts that represent the output from running the job.

" + } + }, + "DataCatalogOutputs": { + "target": "com.amazonaws.databrew#DataCatalogOutputList", + "traits": { + "smithy.api#documentation": "

One or more artifacts that represent the Glue Data Catalog output from running the job.

" + } + }, + "DatabaseOutputs": { + "target": "com.amazonaws.databrew#DatabaseOutputList", + "traits": { + "smithy.api#documentation": "

Represents a list of JDBC database output objects which defines the output destination for a \n DataBrew recipe job to write into.

" + } + }, + "RoleArn": { + "target": "com.amazonaws.databrew#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role to\n be assumed when DataBrew runs the job.

", + "smithy.api#required": {} + } + }, + "Timeout": { + "target": "com.amazonaws.databrew#Timeout", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The job's timeout in minutes. A job that attempts to run longer than this timeout\n period ends with a status of TIMEOUT.

" + } + } + } + }, + "com.amazonaws.databrew#UpdateRecipeJobResponse": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.databrew#JobName", + "traits": { + "smithy.api#documentation": "

The name of the job that you updated.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.databrew#UpdateRecipeRequest": { + "type": "structure", + "members": { + "Description": { + "target": "com.amazonaws.databrew#RecipeDescription", + "traits": { + "smithy.api#documentation": "

A description of the recipe.

" + } + }, + "Name": { + "target": "com.amazonaws.databrew#RecipeName", + "traits": { + "smithy.api#documentation": "

The name of the recipe to be updated.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Steps": { + "target": "com.amazonaws.databrew#RecipeStepList", + "traits": { + "smithy.api#documentation": "

One or more steps to be performed by the recipe. Each step consists of an action, and\n the conditions under which the action should succeed.

" + } + } + } + }, + "com.amazonaws.databrew#UpdateRecipeResponse": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.databrew#RecipeName", + "traits": { + "smithy.api#documentation": "

The name of the recipe that was updated.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.databrew#UpdateRuleset": { + "type": "operation", + "input": { + "target": "com.amazonaws.databrew#UpdateRulesetRequest" + }, + "output": { + "target": "com.amazonaws.databrew#UpdateRulesetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.databrew#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.databrew#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates specified ruleset.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/rulesets/{Name}", + "code": 200 + } + } + }, + "com.amazonaws.databrew#UpdateRulesetRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.databrew#RulesetName", + "traits": { + "smithy.api#documentation": "

The name of the ruleset to be updated.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.databrew#RulesetDescription", + "traits": { + "smithy.api#documentation": "

The description of the ruleset.

" + } + }, + "Rules": { + "target": "com.amazonaws.databrew#RuleList", + "traits": { + "smithy.api#documentation": "

A list of rules that are defined with the ruleset. A rule includes one or more \n checks to be validated on a DataBrew dataset.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.databrew#UpdateRulesetResponse": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.databrew#RulesetName", + "traits": { + "smithy.api#documentation": "

The name of the updated ruleset.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.databrew#UpdateSchedule": { + "type": "operation", + "input": { + "target": "com.amazonaws.databrew#UpdateScheduleRequest" + }, + "output": { + "target": "com.amazonaws.databrew#UpdateScheduleResponse" + }, + "errors": [ + { + "target": "com.amazonaws.databrew#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.databrew#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.databrew#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Modifies the definition of an existing DataBrew schedule.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/schedules/{Name}", + "code": 200 + } + } + }, + "com.amazonaws.databrew#UpdateScheduleRequest": { + "type": "structure", + "members": { + "JobNames": { + "target": "com.amazonaws.databrew#JobNameList", + "traits": { + "smithy.api#documentation": "

The name or names of one or more jobs to be run for this schedule.

" + } + }, + "CronExpression": { + "target": "com.amazonaws.databrew#CronExpression", + "traits": { + "smithy.api#documentation": "

The date or dates and time or times when the jobs are to be run. For more information,\n see Cron\n expressions in the Glue DataBrew Developer\n Guide.

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.databrew#ScheduleName", + "traits": { + "smithy.api#documentation": "

The name of the schedule to update.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.databrew#UpdateScheduleResponse": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.databrew#ScheduleName", + "traits": { + "smithy.api#documentation": "

The name of the schedule that was updated.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.databrew#ValidationConfiguration": { + "type": "structure", + "members": { + "RulesetArn": { + "target": "com.amazonaws.databrew#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the ruleset to be validated in the profile job. \n The TargetArn of the selected ruleset should be the same as the Amazon Resource Name (ARN) of \n the dataset that is associated with the profile job.

", + "smithy.api#required": {} + } + }, + "ValidationMode": { + "target": "com.amazonaws.databrew#ValidationMode", + "traits": { + "smithy.api#documentation": "

Mode of data quality validation. Default mode is “CHECK_ALL” which verifies all rules \n defined in the selected ruleset.

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

Configuration for data quality validation. Used to select the Rulesets and Validation Mode \n to be used in the profile job. When ValidationConfiguration is null, the profile \n job will run without data quality validation.

" + } + }, + "com.amazonaws.databrew#ValidationConfigurationList": { + "type": "list", + "member": { + "target": "com.amazonaws.databrew#ValidationConfiguration" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.databrew#ValidationException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.databrew#Message" + } + }, + "traits": { + "smithy.api#documentation": "

The input parameters for this request failed validation.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.databrew#ValidationMode": { + "type": "enum", + "members": { + "CHECK_ALL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CHECK_ALL" + } + } + } + }, + "com.amazonaws.databrew#ValueReference": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 2, + "max": 128 + }, + "smithy.api#pattern": "^:[A-Za-z0-9_]+$" + } + }, + "com.amazonaws.databrew#ValuesMap": { + "type": "map", + "key": { + "target": "com.amazonaws.databrew#ValueReference" + }, + "value": { + "target": "com.amazonaws.databrew#ConditionValue" + } + }, + "com.amazonaws.databrew#ViewFrame": { + "type": "structure", + "members": { + "StartColumnIndex": { + "target": "com.amazonaws.databrew#StartColumnIndex", + "traits": { + "smithy.api#documentation": "

The starting index for the range of columns to return in the view frame.

", + "smithy.api#required": {} + } + }, + "ColumnRange": { + "target": "com.amazonaws.databrew#ColumnRange", + "traits": { + "smithy.api#documentation": "

The number of columns to include in the view frame, beginning with the\n StartColumnIndex value and ignoring any columns in the\n HiddenColumns list.

" + } + }, + "HiddenColumns": { + "target": "com.amazonaws.databrew#HiddenColumnList", + "traits": { + "smithy.api#documentation": "

A list of columns to hide in the view frame.

" + } + }, + "StartRowIndex": { + "target": "com.amazonaws.databrew#StartRowIndex", + "traits": { + "smithy.api#documentation": "

The starting index for the range of rows to return in the view frame.

" + } + }, + "RowRange": { + "target": "com.amazonaws.databrew#RowRange", + "traits": { + "smithy.api#documentation": "

The number of rows to include in the view frame, beginning with the \n StartRowIndex value.

" + } + }, + "Analytics": { + "target": "com.amazonaws.databrew#AnalyticsMode", + "traits": { + "smithy.api#documentation": "

Controls if analytics computation is enabled or disabled. Enabled by default.

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

Represents the data being transformed during an action.

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

Represents the data being transformed during an action.

" - } } - } -} \ No newline at end of file +} diff --git a/codegen/sdk-codegen/aws-models/route-53.json b/codegen/sdk-codegen/aws-models/route-53.json index ea0fee9aa8ff..38b7bca90394 100644 --- a/codegen/sdk-codegen/aws-models/route-53.json +++ b/codegen/sdk-codegen/aws-models/route-53.json @@ -1,11707 +1,11716 @@ { - "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.route53#ARN": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 20, - "max": 2048 - }, - "smithy.api#pattern": "\\S" - } - }, - "com.amazonaws.route53#AWSAccountID": { - "type": "string" - }, - "com.amazonaws.route53#AWSDnsV20130401": { - "type": "service", - "version": "2013-04-01", - "operations": [ - { - "target": "com.amazonaws.route53#ActivateKeySigningKey" - }, - { - "target": "com.amazonaws.route53#AssociateVPCWithHostedZone" - }, - { - "target": "com.amazonaws.route53#ChangeCidrCollection" - }, - { - "target": "com.amazonaws.route53#ChangeResourceRecordSets" - }, - { - "target": "com.amazonaws.route53#ChangeTagsForResource" - }, - { - "target": "com.amazonaws.route53#CreateCidrCollection" - }, - { - "target": "com.amazonaws.route53#CreateHealthCheck" - }, - { - "target": "com.amazonaws.route53#CreateHostedZone" - }, - { - "target": "com.amazonaws.route53#CreateKeySigningKey" - }, - { - "target": "com.amazonaws.route53#CreateQueryLoggingConfig" - }, - { - "target": "com.amazonaws.route53#CreateReusableDelegationSet" - }, - { - "target": "com.amazonaws.route53#CreateTrafficPolicy" - }, - { - "target": "com.amazonaws.route53#CreateTrafficPolicyInstance" - }, - { - "target": "com.amazonaws.route53#CreateTrafficPolicyVersion" - }, - { - "target": "com.amazonaws.route53#CreateVPCAssociationAuthorization" - }, - { - "target": "com.amazonaws.route53#DeactivateKeySigningKey" - }, - { - "target": "com.amazonaws.route53#DeleteCidrCollection" - }, - { - "target": "com.amazonaws.route53#DeleteHealthCheck" - }, - { - "target": "com.amazonaws.route53#DeleteHostedZone" - }, - { - "target": "com.amazonaws.route53#DeleteKeySigningKey" - }, - { - "target": "com.amazonaws.route53#DeleteQueryLoggingConfig" - }, - { - "target": "com.amazonaws.route53#DeleteReusableDelegationSet" - }, - { - "target": "com.amazonaws.route53#DeleteTrafficPolicy" - }, - { - "target": "com.amazonaws.route53#DeleteTrafficPolicyInstance" - }, - { - "target": "com.amazonaws.route53#DeleteVPCAssociationAuthorization" - }, - { - "target": "com.amazonaws.route53#DisableHostedZoneDNSSEC" - }, - { - "target": "com.amazonaws.route53#DisassociateVPCFromHostedZone" - }, - { - "target": "com.amazonaws.route53#EnableHostedZoneDNSSEC" - }, - { - "target": "com.amazonaws.route53#GetAccountLimit" - }, - { - "target": "com.amazonaws.route53#GetChange" - }, - { - "target": "com.amazonaws.route53#GetCheckerIpRanges" - }, - { - "target": "com.amazonaws.route53#GetDNSSEC" - }, - { - "target": "com.amazonaws.route53#GetGeoLocation" - }, - { - "target": "com.amazonaws.route53#GetHealthCheck" - }, - { - "target": "com.amazonaws.route53#GetHealthCheckCount" - }, - { - "target": "com.amazonaws.route53#GetHealthCheckLastFailureReason" - }, - { - "target": "com.amazonaws.route53#GetHealthCheckStatus" - }, - { - "target": "com.amazonaws.route53#GetHostedZone" - }, - { - "target": "com.amazonaws.route53#GetHostedZoneCount" - }, - { - "target": "com.amazonaws.route53#GetHostedZoneLimit" - }, - { - "target": "com.amazonaws.route53#GetQueryLoggingConfig" - }, - { - "target": "com.amazonaws.route53#GetReusableDelegationSet" - }, - { - "target": "com.amazonaws.route53#GetReusableDelegationSetLimit" - }, - { - "target": "com.amazonaws.route53#GetTrafficPolicy" - }, - { - "target": "com.amazonaws.route53#GetTrafficPolicyInstance" - }, - { - "target": "com.amazonaws.route53#GetTrafficPolicyInstanceCount" - }, - { - "target": "com.amazonaws.route53#ListCidrBlocks" - }, - { - "target": "com.amazonaws.route53#ListCidrCollections" - }, - { - "target": "com.amazonaws.route53#ListCidrLocations" - }, - { - "target": "com.amazonaws.route53#ListGeoLocations" - }, - { - "target": "com.amazonaws.route53#ListHealthChecks" - }, - { - "target": "com.amazonaws.route53#ListHostedZones" - }, - { - "target": "com.amazonaws.route53#ListHostedZonesByName" - }, - { - "target": "com.amazonaws.route53#ListHostedZonesByVPC" - }, - { - "target": "com.amazonaws.route53#ListQueryLoggingConfigs" - }, - { - "target": "com.amazonaws.route53#ListResourceRecordSets" - }, - { - "target": "com.amazonaws.route53#ListReusableDelegationSets" - }, - { - "target": "com.amazonaws.route53#ListTagsForResource" - }, - { - "target": "com.amazonaws.route53#ListTagsForResources" - }, - { - "target": "com.amazonaws.route53#ListTrafficPolicies" - }, - { - "target": "com.amazonaws.route53#ListTrafficPolicyInstances" - }, - { - "target": "com.amazonaws.route53#ListTrafficPolicyInstancesByHostedZone" - }, - { - "target": "com.amazonaws.route53#ListTrafficPolicyInstancesByPolicy" - }, - { - "target": "com.amazonaws.route53#ListTrafficPolicyVersions" - }, - { - "target": "com.amazonaws.route53#ListVPCAssociationAuthorizations" - }, - { - "target": "com.amazonaws.route53#TestDNSAnswer" - }, - { - "target": "com.amazonaws.route53#UpdateHealthCheck" - }, - { - "target": "com.amazonaws.route53#UpdateHostedZoneComment" + "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.route53#ARN": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "\\S" + } }, - { - "target": "com.amazonaws.route53#UpdateTrafficPolicyComment" + "com.amazonaws.route53#AWSAccountID": { + "type": "string" }, - { - "target": "com.amazonaws.route53#UpdateTrafficPolicyInstance" - } - ], - "traits": { - "aws.api#service": { - "sdkId": "Route 53", - "arnNamespace": "route53", - "cloudFormationName": "Route53", - "cloudTrailEventSource": "route53.amazonaws.com", - "endpointPrefix": "route53" - }, - "aws.auth#sigv4": { - "name": "route53" - }, - "aws.protocols#restXml": {}, - "smithy.api#documentation": "

Amazon Route 53 is a highly available and scalable Domain Name System (DNS) web\n\t\t\tservice.

\n\t\t

You can use Route 53 to:

\n\t\t ", - "smithy.api#title": "Amazon Route 53", - "smithy.api#xmlNamespace": { - "uri": "https://route53.amazonaws.com/doc/2013-04-01/" - }, - "smithy.rules#endpointRuleSet": { - "version": "1.0", - "parameters": { - "Region": { - "builtIn": "AWS::Region", - "required": true, - "documentation": "The AWS region used to dispatch the request.", - "type": "String" - }, - "UseDualStack": { - "builtIn": "AWS::UseDualStack", - "required": true, - "default": false, - "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", - "type": "Boolean" - }, - "UseFIPS": { - "builtIn": "AWS::UseFIPS", - "required": true, - "default": false, - "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", - "type": "Boolean" - }, - "Endpoint": { - "builtIn": "SDK::Endpoint", - "required": false, - "documentation": "Override the endpoint used to send this request", - "type": "String" - } - }, - "rules": [ - { - "conditions": [ + "com.amazonaws.route53#AWSDnsV20130401": { + "type": "service", + "version": "2013-04-01", + "operations": [ { - "fn": "aws.partition", - "argv": [ - { - "ref": "Region" - } - ], - "assign": "PartitionResult" - } - ], - "type": "tree", - "rules": [ + "target": "com.amazonaws.route53#ActivateKeySigningKey" + }, { - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Endpoint" - } - ] - }, - { - "fn": "parseURL", - "argv": [ - { - "ref": "Endpoint" - } - ], - "assign": "url" - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "error": "Invalid Configuration: FIPS and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" - }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] - } - ] + "target": "com.amazonaws.route53#AssociateVPCWithHostedZone" }, { - "conditions": [ - { - "fn": "stringEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "name" - ] - }, - "aws" - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - }, - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://route-53-fips.{Region}.api.aws", - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "us-east-1", - "signingName": "route53" - } - ] - }, - "headers": {} - }, - "type": "endpoint" - } - ] - }, - { - "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" - } - ] - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://route53-fips.amazonaws.com", - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "us-east-1", - "signingName": "route53" - } - ] - }, - "headers": {} - }, - "type": "endpoint" - } - ] - }, - { - "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" - } - ] - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://route-53.{Region}.api.aws", - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "us-east-1", - "signingName": "route53" - } - ] - }, - "headers": {} - }, - "type": "endpoint" - } - ] - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" - } - ] - }, - { - "conditions": [], - "endpoint": { - "url": "https://route53.amazonaws.com", - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "us-east-1", - "signingName": "route53" - } - ] - }, - "headers": {} - }, - "type": "endpoint" - } - ] + "target": "com.amazonaws.route53#ChangeCidrCollection" }, { - "conditions": [ - { - "fn": "stringEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "name" - ] - }, - "aws-cn" - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - }, - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://route-53-fips.{Region}.api.amazonwebservices.com.cn", - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "cn-northwest-1", - "signingName": "route53" - } - ] - }, - "headers": {} - }, - "type": "endpoint" - } - ] - }, - { - "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" - } - ] - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://route-53-fips.{Region}.amazonaws.com.cn", - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "cn-northwest-1", - "signingName": "route53" - } - ] - }, - "headers": {} - }, - "type": "endpoint" - } - ] - }, - { - "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" - } - ] - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://route-53.{Region}.api.amazonwebservices.com.cn", - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "cn-northwest-1", - "signingName": "route53" - } - ] - }, - "headers": {} - }, - "type": "endpoint" - } - ] - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" - } - ] - }, - { - "conditions": [], - "endpoint": { - "url": "https://route53.amazonaws.com.cn", - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "cn-northwest-1", - "signingName": "route53" - } - ] - }, - "headers": {} - }, - "type": "endpoint" - } - ] + "target": "com.amazonaws.route53#ChangeResourceRecordSets" }, { - "conditions": [ - { - "fn": "stringEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "name" - ] - }, - "aws-us-gov" - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] + "target": "com.amazonaws.route53#ChangeTagsForResource" + }, + { + "target": "com.amazonaws.route53#CreateCidrCollection" + }, + { + "target": "com.amazonaws.route53#CreateHealthCheck" + }, + { + "target": "com.amazonaws.route53#CreateHostedZone" + }, + { + "target": "com.amazonaws.route53#CreateKeySigningKey" + }, + { + "target": "com.amazonaws.route53#CreateQueryLoggingConfig" + }, + { + "target": "com.amazonaws.route53#CreateReusableDelegationSet" + }, + { + "target": "com.amazonaws.route53#CreateTrafficPolicy" + }, + { + "target": "com.amazonaws.route53#CreateTrafficPolicyInstance" + }, + { + "target": "com.amazonaws.route53#CreateTrafficPolicyVersion" + }, + { + "target": "com.amazonaws.route53#CreateVPCAssociationAuthorization" + }, + { + "target": "com.amazonaws.route53#DeactivateKeySigningKey" + }, + { + "target": "com.amazonaws.route53#DeleteCidrCollection" + }, + { + "target": "com.amazonaws.route53#DeleteHealthCheck" + }, + { + "target": "com.amazonaws.route53#DeleteHostedZone" + }, + { + "target": "com.amazonaws.route53#DeleteKeySigningKey" + }, + { + "target": "com.amazonaws.route53#DeleteQueryLoggingConfig" + }, + { + "target": "com.amazonaws.route53#DeleteReusableDelegationSet" + }, + { + "target": "com.amazonaws.route53#DeleteTrafficPolicy" + }, + { + "target": "com.amazonaws.route53#DeleteTrafficPolicyInstance" + }, + { + "target": "com.amazonaws.route53#DeleteVPCAssociationAuthorization" + }, + { + "target": "com.amazonaws.route53#DisableHostedZoneDNSSEC" + }, + { + "target": "com.amazonaws.route53#DisassociateVPCFromHostedZone" + }, + { + "target": "com.amazonaws.route53#EnableHostedZoneDNSSEC" + }, + { + "target": "com.amazonaws.route53#GetAccountLimit" + }, + { + "target": "com.amazonaws.route53#GetChange" + }, + { + "target": "com.amazonaws.route53#GetCheckerIpRanges" + }, + { + "target": "com.amazonaws.route53#GetDNSSEC" + }, + { + "target": "com.amazonaws.route53#GetGeoLocation" + }, + { + "target": "com.amazonaws.route53#GetHealthCheck" + }, + { + "target": "com.amazonaws.route53#GetHealthCheckCount" + }, + { + "target": "com.amazonaws.route53#GetHealthCheckLastFailureReason" + }, + { + "target": "com.amazonaws.route53#GetHealthCheckStatus" + }, + { + "target": "com.amazonaws.route53#GetHostedZone" + }, + { + "target": "com.amazonaws.route53#GetHostedZoneCount" + }, + { + "target": "com.amazonaws.route53#GetHostedZoneLimit" + }, + { + "target": "com.amazonaws.route53#GetQueryLoggingConfig" + }, + { + "target": "com.amazonaws.route53#GetReusableDelegationSet" + }, + { + "target": "com.amazonaws.route53#GetReusableDelegationSetLimit" + }, + { + "target": "com.amazonaws.route53#GetTrafficPolicy" + }, + { + "target": "com.amazonaws.route53#GetTrafficPolicyInstance" + }, + { + "target": "com.amazonaws.route53#GetTrafficPolicyInstanceCount" + }, + { + "target": "com.amazonaws.route53#ListCidrBlocks" + }, + { + "target": "com.amazonaws.route53#ListCidrCollections" + }, + { + "target": "com.amazonaws.route53#ListCidrLocations" + }, + { + "target": "com.amazonaws.route53#ListGeoLocations" + }, + { + "target": "com.amazonaws.route53#ListHealthChecks" + }, + { + "target": "com.amazonaws.route53#ListHostedZones" + }, + { + "target": "com.amazonaws.route53#ListHostedZonesByName" + }, + { + "target": "com.amazonaws.route53#ListHostedZonesByVPC" + }, + { + "target": "com.amazonaws.route53#ListQueryLoggingConfigs" + }, + { + "target": "com.amazonaws.route53#ListResourceRecordSets" + }, + { + "target": "com.amazonaws.route53#ListReusableDelegationSets" + }, + { + "target": "com.amazonaws.route53#ListTagsForResource" + }, + { + "target": "com.amazonaws.route53#ListTagsForResources" + }, + { + "target": "com.amazonaws.route53#ListTrafficPolicies" + }, + { + "target": "com.amazonaws.route53#ListTrafficPolicyInstances" + }, + { + "target": "com.amazonaws.route53#ListTrafficPolicyInstancesByHostedZone" + }, + { + "target": "com.amazonaws.route53#ListTrafficPolicyInstancesByPolicy" + }, + { + "target": "com.amazonaws.route53#ListTrafficPolicyVersions" + }, + { + "target": "com.amazonaws.route53#ListVPCAssociationAuthorizations" + }, + { + "target": "com.amazonaws.route53#TestDNSAnswer" + }, + { + "target": "com.amazonaws.route53#UpdateHealthCheck" + }, + { + "target": "com.amazonaws.route53#UpdateHostedZoneComment" + }, + { + "target": "com.amazonaws.route53#UpdateTrafficPolicyComment" + }, + { + "target": "com.amazonaws.route53#UpdateTrafficPolicyInstance" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "Route 53", + "arnNamespace": "route53", + "cloudFormationName": "Route53", + "cloudTrailEventSource": "route53.amazonaws.com", + "endpointPrefix": "route53" + }, + "aws.auth#sigv4": { + "name": "route53" + }, + "aws.protocols#restXml": {}, + "smithy.api#documentation": "

Amazon Route 53 is a highly available and scalable Domain Name System (DNS) web\n\t\t\tservice.

\n

You can use Route 53 to:

\n ", + "smithy.api#title": "Amazon Route 53", + "smithy.api#xmlNamespace": { + "uri": "https://route53.amazonaws.com/doc/2013-04-01/" + }, + "smithy.rules#endpointRuleSet": { + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": true, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] + "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" } - ], - "type": "tree", - "rules": [ + }, + "rules": [ { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, + "conditions": [ { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" } - ] - }, - { - "fn": "booleanEquals", - "argv": [ - true, + ], + "type": "tree", + "rules": [ { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://route-53-fips.{Region}.api.aws", - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "us-gov-west-1", - "signingName": "route53" - } - ] + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] }, - "headers": {} - }, - "type": "endpoint" - } - ] - }, - { - "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" - } - ] - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + }, + "aws" + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://route-53-fips.{Region}.api.aws", + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "us-east-1", + "signingName": "route53" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + } + ] + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://route53-fips.amazonaws.com", + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "us-east-1", + "signingName": "route53" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + } + ] + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://route-53.{Region}.api.aws", + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "us-east-1", + "signingName": "route53" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + } + ] + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ] + }, + { + "conditions": [], + "endpoint": { + "url": "https://route53.amazonaws.com", + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "us-east-1", + "signingName": "route53" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + } + ] + }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + }, + "aws-cn" + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://route-53-fips.{Region}.api.amazonwebservices.com.cn", + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "cn-northwest-1", + "signingName": "route53" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + } + ] + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://route-53-fips.{Region}.amazonaws.com.cn", + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "cn-northwest-1", + "signingName": "route53" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + } + ] + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://route-53.{Region}.api.amazonwebservices.com.cn", + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "cn-northwest-1", + "signingName": "route53" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + } + ] + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ] + }, + { + "conditions": [], + "endpoint": { + "url": "https://route53.amazonaws.com.cn", + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "cn-northwest-1", + "signingName": "route53" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + } + ] + }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + }, + "aws-us-gov" + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://route-53-fips.{Region}.api.aws", + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "us-gov-west-1", + "signingName": "route53" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + } + ] + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://route53.us-gov.amazonaws.com", + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "us-gov-west-1", + "signingName": "route53" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + } + ] + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://route-53.{Region}.api.aws", + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "us-gov-west-1", + "signingName": "route53" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + } + ] + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ] + }, + { + "conditions": [], + "endpoint": { + "url": "https://route53.us-gov.amazonaws.com", + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "us-gov-west-1", + "signingName": "route53" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + } + ] + }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + }, + "aws-iso" + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://route-53-fips.{Region}.c2s.ic.gov", + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "us-iso-east-1", + "signingName": "route53" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + } + ] + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ] + }, + { + "conditions": [], + "endpoint": { + "url": "https://route53.c2s.ic.gov", + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "us-iso-east-1", + "signingName": "route53" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + } + ] + }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + }, + "aws-iso-b" + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://route-53-fips.{Region}.sc2s.sgov.gov", + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "us-isob-east-1", + "signingName": "route53" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + } + ] + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ] + }, + { + "conditions": [], + "endpoint": { + "url": "https://route53.sc2s.sgov.gov", + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "us-isob-east-1", + "signingName": "route53" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://route53-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "aws-global" + ] + } + ], + "endpoint": { + "url": "https://route53-fips.amazonaws.com", + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "us-east-1", + "signingName": "route53" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "aws-us-gov-global" + ] + } + ], + "endpoint": { + "url": "https://route53.us-gov.amazonaws.com", + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "us-gov-west-1", + "signingName": "route53" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://route53-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://route53.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ] + }, + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "aws-global" + ] + } + ], + "endpoint": { + "url": "https://route53.amazonaws.com", + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "us-east-1", + "signingName": "route53" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "aws-cn-global" + ] + } + ], + "endpoint": { + "url": "https://route53.amazonaws.com.cn", + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "cn-northwest-1", + "signingName": "route53" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "aws-us-gov-global" + ] + } + ], + "endpoint": { + "url": "https://route53.us-gov.amazonaws.com", + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "us-gov-west-1", + "signingName": "route53" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "aws-iso-global" + ] + } + ], + "endpoint": { + "url": "https://route53.c2s.ic.gov", + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "us-iso-east-1", + "signingName": "route53" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "aws-iso-b-global" + ] + } + ], + "endpoint": { + "url": "https://route53.sc2s.sgov.gov", + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "us-isob-east-1", + "signingName": "route53" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://route53.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] } - ], - "type": "tree", - "rules": [ + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" + "documentation": "For region aws-cn-global with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "route53", + "signingRegion": "cn-northwest-1" + } + ] }, - "supportsFIPS" - ] + "url": "https://route53.amazonaws.com.cn" } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://route53.us-gov.amazonaws.com", - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "us-gov-west-1", - "signingName": "route53" - } - ] - }, - "headers": {} - }, - "type": "endpoint" + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "aws-cn-global" } - ] }, { - "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" - } - ] - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" + "documentation": "For region aws-global with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "route53", + "signingRegion": "us-east-1" + } + ] }, - "supportsDualStack" - ] + "url": "https://route53.amazonaws.com" } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://route-53.{Region}.api.aws", - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "us-gov-west-1", - "signingName": "route53" - } - ] - }, - "headers": {} - }, - "type": "endpoint" + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "aws-global" } - ] }, { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" - } - ] - }, - { - "conditions": [], - "endpoint": { - "url": "https://route53.us-gov.amazonaws.com", - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "us-gov-west-1", - "signingName": "route53" + "documentation": "For region aws-iso-global with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "route53", + "signingRegion": "us-iso-east-1" + } + ] + }, + "url": "https://route53.c2s.ic.gov" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "aws-iso-global" } - ] }, - "headers": {} - }, - "type": "endpoint" - } - ] - }, - { - "conditions": [ - { - "fn": "stringEquals", - "argv": [ { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" + "documentation": "For region aws-iso-b-global with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "route53", + "signingRegion": "us-isob-east-1" + } + ] + }, + "url": "https://route53.sc2s.sgov.gov" + } }, - "name" - ] + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "aws-iso-b-global" + } }, - "aws-iso" - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "type": "tree", - "rules": [ { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" + "documentation": "For region aws-us-gov-global with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "route53", + "signingRegion": "us-gov-west-1" + } + ] }, - "supportsFIPS" - ] + "url": "https://route53.us-gov.amazonaws.com" } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://route-53-fips.{Region}.c2s.ic.gov", - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "us-iso-east-1", - "signingName": "route53" - } - ] - }, - "headers": {} - }, - "type": "endpoint" + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "aws-us-gov-global" } - ] }, { - "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" - } - ] - }, - { - "conditions": [], - "endpoint": { - "url": "https://route53.c2s.ic.gov", - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "us-iso-east-1", - "signingName": "route53" + "documentation": "For custom endpoint with fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "us-east-1", + "Endpoint": "https://example.com" } - ] }, - "headers": {} - }, - "type": "endpoint" - } - ] - }, - { - "conditions": [ - { - "fn": "stringEquals", - "argv": [ { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" + "documentation": "For custom endpoint with fips enabled and dualstack disabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, - "name" - ] + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "us-east-1", + "Endpoint": "https://example.com" + } }, - "aws-iso-b" - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" + "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://route-53-fips.{Region}.sc2s.sgov.gov", - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "us-isob-east-1", - "signingName": "route53" - } - ] - }, - "headers": {} - }, - "type": "endpoint" + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "us-east-1", + "Endpoint": "https://example.com" } - ] - }, - { - "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" } - ] - }, - { - "conditions": [], - "endpoint": { - "url": "https://route53.sc2s.sgov.gov", - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "us-isob-east-1", - "signingName": "route53" - } - ] - }, - "headers": {} - }, - "type": "endpoint" + ], + "version": "1.0" + } + } + }, + "com.amazonaws.route53#AccountLimit": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.route53#AccountLimitType", + "traits": { + "smithy.api#documentation": "

The limit that you requested. Valid values include the following:

\n ", + "smithy.api#required": {} } - ] }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - }, - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://route53-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] - }, - { - "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" + "Value": { + "target": "com.amazonaws.route53#LimitValue", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The current value for the limit that is specified by Type.

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

A complex type that contains the type of limit that you specified in the request and\n\t\t\tthe current value for that limit.

" + } + }, + "com.amazonaws.route53#AccountLimitType": { + "type": "enum", + "members": { + "MAX_HEALTH_CHECKS_BY_OWNER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MAX_HEALTH_CHECKS_BY_OWNER" } - ] }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "stringEquals", - "argv": [ - { - "ref": "Region" - }, - "aws-global" - ] - } - ], - "endpoint": { - "url": "https://route53-fips.amazonaws.com", - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "us-east-1", - "signingName": "route53" - } - ] - }, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [ - { - "fn": "stringEquals", - "argv": [ - { - "ref": "Region" - }, - "aws-us-gov-global" - ] - } - ], - "endpoint": { - "url": "https://route53.us-gov.amazonaws.com", - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "us-gov-west-1", - "signingName": "route53" - } - ] - }, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [], - "endpoint": { - "url": "https://route53-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] - } - ] - }, - { - "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" + "MAX_HOSTED_ZONES_BY_OWNER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MAX_HOSTED_ZONES_BY_OWNER" } - ] }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://route53.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" + "MAX_TRAFFIC_POLICY_INSTANCES_BY_OWNER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MAX_TRAFFIC_POLICY_INSTANCES_BY_OWNER" } - ] }, + "MAX_REUSABLE_DELEGATION_SETS_BY_OWNER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MAX_REUSABLE_DELEGATION_SETS_BY_OWNER" + } + }, + "MAX_TRAFFIC_POLICIES_BY_OWNER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MAX_TRAFFIC_POLICIES_BY_OWNER" + } + } + } + }, + "com.amazonaws.route53#ActivateKeySigningKey": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#ActivateKeySigningKeyRequest" + }, + "output": { + "target": "com.amazonaws.route53#ActivateKeySigningKeyResponse" + }, + "errors": [ { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "stringEquals", - "argv": [ - { - "ref": "Region" - }, - "aws-global" - ] - } - ], - "endpoint": { - "url": "https://route53.amazonaws.com", - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "us-east-1", - "signingName": "route53" - } - ] - }, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [ - { - "fn": "stringEquals", - "argv": [ - { - "ref": "Region" - }, - "aws-cn-global" - ] - } - ], - "endpoint": { - "url": "https://route53.amazonaws.com.cn", - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "cn-northwest-1", - "signingName": "route53" - } - ] - }, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [ - { - "fn": "stringEquals", - "argv": [ - { - "ref": "Region" - }, - "aws-us-gov-global" - ] - } - ], - "endpoint": { - "url": "https://route53.us-gov.amazonaws.com", - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "us-gov-west-1", - "signingName": "route53" - } - ] - }, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [ - { - "fn": "stringEquals", - "argv": [ - { - "ref": "Region" - }, - "aws-iso-global" - ] - } - ], - "endpoint": { - "url": "https://route53.c2s.ic.gov", - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "us-iso-east-1", - "signingName": "route53" - } - ] - }, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [ - { - "fn": "stringEquals", - "argv": [ - { - "ref": "Region" - }, - "aws-iso-b-global" - ] - } - ], - "endpoint": { - "url": "https://route53.sc2s.sgov.gov", - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingRegion": "us-isob-east-1", - "signingName": "route53" - } - ] - }, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [], - "endpoint": { - "url": "https://route53.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" + "target": "com.amazonaws.route53#ConcurrentModification" + }, + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#InvalidKeySigningKeyStatus" + }, + { + "target": "com.amazonaws.route53#InvalidKMSArn" + }, + { + "target": "com.amazonaws.route53#InvalidSigningStatus" + }, + { + "target": "com.amazonaws.route53#NoSuchKeySigningKey" + } + ], + "traits": { + "smithy.api#documentation": "

Activates a key-signing key (KSK) so that it can be used for signing by DNSSEC. This\n\t\t\toperation changes the KSK status to ACTIVE.

", + "smithy.api#http": { + "method": "POST", + "uri": "/2013-04-01/keysigningkey/{HostedZoneId}/{Name}/activate", + "code": 200 + } + } + }, + "com.amazonaws.route53#ActivateKeySigningKeyRequest": { + "type": "structure", + "members": { + "HostedZoneId": { + "target": "com.amazonaws.route53#ResourceId", + "traits": { + "smithy.api#documentation": "

A unique string used to identify a hosted zone.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.route53#SigningKeyName", + "traits": { + "smithy.api#documentation": "

A string used to identify a key-signing key (KSK). Name can include\n\t\t\tnumbers, letters, and underscores (_). Name must be unique for each\n\t\t\tkey-signing key in the same hosted zone.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } - ] } - ] } - ] }, - "smithy.rules#endpointTests": { - "testCases": [ - { - "documentation": "For region aws-cn-global with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingName": "route53", - "signingRegion": "cn-northwest-1" - } - ] - }, - "url": "https://route53.amazonaws.com.cn" + "com.amazonaws.route53#ActivateKeySigningKeyResponse": { + "type": "structure", + "members": { + "ChangeInfo": { + "target": "com.amazonaws.route53#ChangeInfo", + "traits": { + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.route53#AlarmIdentifier": { + "type": "structure", + "members": { + "Region": { + "target": "com.amazonaws.route53#CloudWatchRegion", + "traits": { + "smithy.api#documentation": "

For the CloudWatch alarm that you want Route 53 health checkers to use to determine\n\t\t\twhether this health check is healthy, the region that the alarm was created in.

\n

For the current list of CloudWatch regions, see Amazon CloudWatch endpoints and\n\t\t\t\tquotas in the Amazon Web Services General\n\t\t\tReference.

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.route53#AlarmName", + "traits": { + "smithy.api#documentation": "

The name of the CloudWatch alarm that you want Amazon Route 53 health checkers to use\n\t\t\tto determine whether this health check is healthy.

\n \n

Route 53 supports CloudWatch alarms with the following features:

\n \n ", + "smithy.api#required": {} + } } - }, - "params": { - "UseDualStack": false, - "Region": "aws-cn-global", - "UseFIPS": false - } }, - { - "documentation": "For region aws-global with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingName": "route53", - "signingRegion": "us-east-1" - } - ] - }, - "url": "https://route53.amazonaws.com" + "traits": { + "smithy.api#documentation": "

A complex type that identifies the CloudWatch alarm that you want Amazon Route 53\n\t\t\thealth checkers to use to determine whether the specified health check is\n\t\t\thealthy.

" + } + }, + "com.amazonaws.route53#AlarmName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, + "com.amazonaws.route53#AliasHealthEnabled": { + "type": "boolean", + "traits": { + "smithy.api#default": false + } + }, + "com.amazonaws.route53#AliasTarget": { + "type": "structure", + "members": { + "HostedZoneId": { + "target": "com.amazonaws.route53#ResourceId", + "traits": { + "smithy.api#documentation": "

\n Alias resource records sets only: The value used depends on where\n\t\t\tyou want to route traffic:

\n
\n
Amazon API Gateway custom regional APIs and edge-optimized APIs
\n
\n

Specify the hosted zone ID for your API. You can get the applicable value\n\t\t\t\t\t\tusing the CLI command get-domain-names:

\n
    \n
  • \n

    For regional APIs, specify the value of\n\t\t\t\t\t\t\t\t\tregionalHostedZoneId.

    \n
    • \n
  • \n

    For edge-optimized APIs, specify the value of\n\t\t\t\t\t\t\t\t\tdistributionHostedZoneId.

    \n
    • \n
\n
\n
Amazon Virtual Private Cloud interface VPC endpoint
\n
\n

Specify the hosted zone ID for your interface endpoint. You can get the\n\t\t\t\t\t\tvalue of HostedZoneId using the CLI command\n\t\t\t\t\t\t\tdescribe-vpc-endpoints.

\n
\n
CloudFront distribution
\n
\n

Specify Z2FDTNDATAQYW2.

\n \n

Alias resource record sets for CloudFront can't be created in a\n\t\t\t\t\t\t\tprivate zone.

\n \n
\n
Elastic Beanstalk environment
\n
\n

Specify the hosted zone ID for the region that you created the environment\n\t\t\t\t\t\tin. The environment must have a regionalized subdomain. For a list of\n\t\t\t\t\t\tregions and the corresponding hosted zone IDs, see Elastic Beanstalk endpoints and quotas in the the\n\t\t\t\t\t\t\tAmazon Web Services General Reference.

\n
\n
ELB load balancer
\n
\n

Specify the value of the hosted zone ID for the load balancer. Use the\n\t\t\t\t\t\tfollowing methods to get the hosted zone ID:

\n
    \n
  • \n

    \n Elastic Load Balancing endpoints and quotas topic in\n\t\t\t\t\t\t\t\tthe Amazon Web Services General Reference: Use\n\t\t\t\t\t\t\t\tthe value that corresponds with the region that you created your\n\t\t\t\t\t\t\t\tload balancer in. Note that there are separate columns for\n\t\t\t\t\t\t\t\tApplication and Classic Load Balancers and for Network Load\n\t\t\t\t\t\t\t\tBalancers.

    \n
    • \n
  • \n

    \n Amazon Web Services Management Console: Go to the\n\t\t\t\t\t\t\t\tAmazon EC2 page, choose Load\n\t\t\t\t\t\t\t\t\tBalancers in the navigation pane, select the load\n\t\t\t\t\t\t\t\tbalancer, and get the value of the Hosted\n\t\t\t\t\t\t\t\t\tzone field on the Description tab.

    \n
    • \n
  • \n

    \n Elastic Load Balancing API: Use\n\t\t\t\t\t\t\t\t\tDescribeLoadBalancers to get the applicable value.\n\t\t\t\t\t\t\t\tFor more information, see the applicable guide:

    \n
      \n
    • \n

      Classic Load Balancers: Use DescribeLoadBalancers to get the value of\n\t\t\t\t\t\t\t\t\t\t\tCanonicalHostedZoneNameId.

      \n
      • \n
    • \n

      Application and Network Load Balancers: Use DescribeLoadBalancers to get the value of\n\t\t\t\t\t\t\t\t\t\t\tCanonicalHostedZoneId.

      \n
      • \n
    \n
    • \n
  • \n

    \n CLI: Use\n\t\t\t\t\t\t\t\t\tdescribe-load-balancers to get the applicable\n\t\t\t\t\t\t\t\tvalue. For more information, see the applicable guide:

    \n
      \n
    • \n

      Classic Load Balancers: Use describe-load-balancers to get the value of\n\t\t\t\t\t\t\t\t\t\t\tCanonicalHostedZoneNameId.

      \n
      • \n
    • \n

      Application and Network Load Balancers: Use describe-load-balancers to get the value of\n\t\t\t\t\t\t\t\t\t\t\tCanonicalHostedZoneId.

      \n
      • \n
    \n
    • \n
\n
\n
Global Accelerator accelerator
\n
\n

Specify Z2BJ6XQ5FK7U4H.

\n
\n
An Amazon S3 bucket configured as a static website
\n
\n

Specify the hosted zone ID for the region that you created the bucket in.\n\t\t\t\t\t\tFor more information about valid values, see the table Amazon S3\n\t\t\t\t\t\t\tWebsite Endpoints in the Amazon Web Services General\n\t\t\t\t\t\t\tReference.

\n
\n
Another Route 53 resource record set in your hosted zone
\n
\n

Specify the hosted zone ID of your hosted zone. (An alias resource record\n\t\t\t\t\t\tset can't reference a resource record set in a different hosted\n\t\t\t\t\t\tzone.)

\n
\n
", + "smithy.api#required": {} + } + }, + "DNSName": { + "target": "com.amazonaws.route53#DNSName", + "traits": { + "smithy.api#documentation": "

\n Alias resource record sets only: The value that you specify\n\t\t\tdepends on where you want to route queries:

\n
\n
Amazon API Gateway custom regional APIs and edge-optimized APIs
\n
\n

Specify the applicable domain name for your API. You can get the\n\t\t\t\t\t\tapplicable value using the CLI command get-domain-names:

\n
    \n
  • \n

    For regional APIs, specify the value of\n\t\t\t\t\t\t\t\t\tregionalDomainName.

    \n
    • \n
  • \n

    For edge-optimized APIs, specify the value of\n\t\t\t\t\t\t\t\t\tdistributionDomainName. This is the name of the\n\t\t\t\t\t\t\t\tassociated CloudFront distribution, such as\n\t\t\t\t\t\t\t\t\tda1b2c3d4e5.cloudfront.net.

    \n
    • \n
\n \n

The name of the record that you're creating must match a custom domain\n\t\t\t\t\t\t\tname for your API, such as api.example.com.

\n \n
\n
Amazon Virtual Private Cloud interface VPC endpoint
\n
\n

Enter the API endpoint for the interface endpoint, such as\n\t\t\t\t\t\t\tvpce-123456789abcdef01-example-us-east-1a.elasticloadbalancing.us-east-1.vpce.amazonaws.com.\n\t\t\t\t\t\tFor edge-optimized APIs, this is the domain name for the corresponding\n\t\t\t\t\t\tCloudFront distribution. You can get the value of DnsName using\n\t\t\t\t\t\tthe CLI command describe-vpc-endpoints.

\n
\n
CloudFront distribution
\n
\n

Specify the domain name that CloudFront assigned when you created your\n\t\t\t\t\t\tdistribution.

\n

Your CloudFront distribution must include an alternate domain name that\n\t\t\t\t\t\tmatches the name of the resource record set. For example, if the name of the\n\t\t\t\t\t\tresource record set is acme.example.com, your\n\t\t\t\t\t\tCloudFront distribution must include acme.example.com\n\t\t\t\t\t\tas one of the alternate domain names. For more information, see Using Alternate\n\t\t\t\t\t\t\tDomain Names (CNAMEs) in the Amazon CloudFront\n\t\t\t\t\t\t\tDeveloper Guide.

\n

You can't create a resource record set in a private hosted zone to route\n\t\t\t\t\t\ttraffic to a CloudFront distribution.

\n \n

For failover alias records, you can't specify a CloudFront\n\t\t\t\t\t\t\tdistribution for both the primary and secondary records. A distribution\n\t\t\t\t\t\t\tmust include an alternate domain name that matches the name of the\n\t\t\t\t\t\t\trecord. However, the primary and secondary records have the same name,\n\t\t\t\t\t\t\tand you can't include the same alternate domain name in more than one\n\t\t\t\t\t\t\tdistribution.

\n \n
\n
Elastic Beanstalk environment
\n
\n

If the domain name for your Elastic Beanstalk environment includes the\n\t\t\t\t\t\tregion that you deployed the environment in, you can create an alias record\n\t\t\t\t\t\tthat routes traffic to the environment. For example, the domain name\n\t\t\t\t\t\t\t\tmy-environment.us-west-2.elasticbeanstalk.com\n\t\t\t\t\t\tis a regionalized domain name.

\n \n

For environments that were created before early 2016, the domain name\n\t\t\t\t\t\t\tdoesn't include the region. To route traffic to these environments, you\n\t\t\t\t\t\t\tmust create a CNAME record instead of an alias record. Note that you\n\t\t\t\t\t\t\tcan't create a CNAME record for the root domain name. For example, if\n\t\t\t\t\t\t\tyour domain name is example.com, you can create a record that routes\n\t\t\t\t\t\t\ttraffic for acme.example.com to your Elastic Beanstalk environment, but\n\t\t\t\t\t\t\tyou can't create a record that routes traffic for example.com to your\n\t\t\t\t\t\t\tElastic Beanstalk environment.

\n \n

For Elastic Beanstalk environments that have regionalized subdomains,\n\t\t\t\t\t\tspecify the CNAME attribute for the environment. You can use\n\t\t\t\t\t\tthe following methods to get the value of the CNAME attribute:

\n
    \n
  • \n

    \n Amazon Web Services Management Console: For information about\n\t\t\t\t\t\t\t\thow to get the value by using the console, see Using Custom\n\t\t\t\t\t\t\t\t\tDomains with Elastic Beanstalk in the\n\t\t\t\t\t\t\t\t\t\tElastic Beanstalk Developer\n\t\t\t\t\t\t\t\tGuide.

    \n
    • \n
  • \n

    \n Elastic Beanstalk API: Use the\n\t\t\t\t\t\t\t\t\tDescribeEnvironments action to get the value of the\n\t\t\t\t\t\t\t\t\tCNAME attribute. For more information, see DescribeEnvironments in the Elastic Beanstalk API Reference.

    \n
    • \n
  • \n

    \n CLI: Use the\n\t\t\t\t\t\t\t\t\tdescribe-environments command to get the value of\n\t\t\t\t\t\t\t\tthe CNAME attribute. For more information, see describe-environments in the CLI Command Reference.

    \n
    • \n
\n
\n
ELB load balancer
\n
\n

Specify the DNS name that is associated with the load balancer. Get the\n\t\t\t\t\t\tDNS name by using the Amazon Web Services Management Console, the ELB API, or the CLI.

\n
    \n
  • \n

    \n Amazon Web Services Management Console: Go to the\n\t\t\t\t\t\t\t\tEC2 page, choose Load Balancers in\n\t\t\t\t\t\t\t\tthe navigation pane, choose the load balancer, choose the Description tab, and get the value of the\n\t\t\t\t\t\t\t\t\tDNS name field.

    \n

    If you're routing traffic to a Classic Load Balancer, get the\n\t\t\t\t\t\t\t\tvalue that begins with dualstack.\n\t\t\t\t\t\t\t\tIf you're routing traffic to another type of load balancer, get the\n\t\t\t\t\t\t\t\tvalue that applies to the record type, A or AAAA.

    \n
    • \n
  • \n

    \n Elastic Load Balancing API: Use\n\t\t\t\t\t\t\t\t\tDescribeLoadBalancers to get the value of\n\t\t\t\t\t\t\t\t\tDNSName. For more information, see the applicable\n\t\t\t\t\t\t\t\tguide:

    \n \n
    • \n
  • \n

    \n CLI: Use\n\t\t\t\t\t\t\t\t\tdescribe-load-balancers to get the value of\n\t\t\t\t\t\t\t\t\tDNSName. For more information, see the applicable\n\t\t\t\t\t\t\t\tguide:

    \n \n
    • \n
\n
\n
Global Accelerator accelerator
\n
\n

Specify the DNS name for your accelerator:

\n \n
\n
Amazon S3 bucket that is configured as a static website
\n
\n

Specify the domain name of the Amazon S3 website endpoint that you created\n\t\t\t\t\t\tthe bucket in, for example, s3-website.us-east-2.amazonaws.com.\n\t\t\t\t\t\tFor more information about valid values, see the table Amazon S3\n\t\t\t\t\t\t\tWebsite Endpoints in the Amazon Web Services General\n\t\t\t\t\t\t\tReference. For more information about using S3 buckets for\n\t\t\t\t\t\twebsites, see Getting Started\n\t\t\t\t\t\t\twith Amazon Route 53 in the Amazon Route 53 Developer\n\t\t\t\t\t\t\tGuide.\n

\n
\n
Another Route 53 resource record set
\n
\n

Specify the value of the Name element for a resource record\n\t\t\t\t\t\tset in the current hosted zone.

\n \n

If you're creating an alias record that has the same name as the\n\t\t\t\t\t\t\thosted zone (known as the zone apex), you can't specify the domain name\n\t\t\t\t\t\t\tfor a record for which the value of Type is\n\t\t\t\t\t\t\t\tCNAME. This is because the alias record must have the\n\t\t\t\t\t\t\tsame type as the record that you're routing traffic to, and creating a\n\t\t\t\t\t\t\tCNAME record for the zone apex isn't supported even for an alias\n\t\t\t\t\t\t\trecord.

\n \n
\n
", + "smithy.api#required": {} + } + }, + "EvaluateTargetHealth": { + "target": "com.amazonaws.route53#AliasHealthEnabled", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

\n Applies only to alias, failover alias, geolocation alias, latency alias, and\n\t\t\t\tweighted alias resource record sets: When\n\t\t\t\tEvaluateTargetHealth is true, an alias resource record set\n\t\t\tinherits the health of the referenced Amazon Web Services resource, such as an ELB load\n\t\t\tbalancer or another resource record set in the hosted zone.

\n

Note the following:

\n
\n
CloudFront distributions
\n
\n

You can't set EvaluateTargetHealth to true when\n\t\t\t\t\t\tthe alias target is a CloudFront distribution.

\n
\n
Elastic Beanstalk environments that have regionalized subdomains
\n
\n

If you specify an Elastic Beanstalk environment in DNSName\n\t\t\t\t\t\tand the environment contains an ELB load balancer, Elastic Load Balancing\n\t\t\t\t\t\troutes queries only to the healthy Amazon EC2 instances that are registered\n\t\t\t\t\t\twith the load balancer. (An environment automatically contains an ELB load\n\t\t\t\t\t\tbalancer if it includes more than one Amazon EC2 instance.) If you set\n\t\t\t\t\t\t\tEvaluateTargetHealth to true and either no\n\t\t\t\t\t\tAmazon EC2 instances are healthy or the load balancer itself is unhealthy,\n\t\t\t\t\t\tRoute 53 routes queries to other available resources that are healthy, if\n\t\t\t\t\t\tany.

\n

If the environment contains a single Amazon EC2 instance, there are no\n\t\t\t\t\t\tspecial requirements.

\n
\n
ELB load balancers
\n
\n

Health checking behavior depends on the type of load balancer:

\n
    \n
  • \n

    \n Classic Load Balancers: If you\n\t\t\t\t\t\t\t\tspecify an ELB Classic Load Balancer in DNSName,\n\t\t\t\t\t\t\t\tElastic Load Balancing routes queries only to the healthy Amazon EC2\n\t\t\t\t\t\t\t\tinstances that are registered with the load balancer. If you set\n\t\t\t\t\t\t\t\t\tEvaluateTargetHealth to true and\n\t\t\t\t\t\t\t\teither no EC2 instances are healthy or the load balancer itself is\n\t\t\t\t\t\t\t\tunhealthy, Route 53 routes queries to other resources.

    \n
    • \n
  • \n

    \n Application and Network Load\n\t\t\t\t\t\t\t\t\tBalancers: If you specify an ELB Application or\n\t\t\t\t\t\t\t\tNetwork Load Balancer and you set EvaluateTargetHealth\n\t\t\t\t\t\t\t\tto true, Route 53 routes queries to the load balancer\n\t\t\t\t\t\t\t\tbased on the health of the target groups that are associated with\n\t\t\t\t\t\t\t\tthe load balancer:

    \n
      \n
    • \n

      For an Application or Network Load Balancer to be\n\t\t\t\t\t\t\t\t\t\tconsidered healthy, every target group that contains targets\n\t\t\t\t\t\t\t\t\t\tmust contain at least one healthy target. If any target\n\t\t\t\t\t\t\t\t\t\tgroup contains only unhealthy targets, the load balancer is\n\t\t\t\t\t\t\t\t\t\tconsidered unhealthy, and Route 53 routes queries to other\n\t\t\t\t\t\t\t\t\t\tresources.

      \n
      • \n
    • \n

      A target group that has no registered targets is\n\t\t\t\t\t\t\t\t\t\tconsidered unhealthy.

      \n
      • \n
    \n
    • \n
\n \n

When you create a load balancer, you configure settings for Elastic\n\t\t\t\t\t\t\tLoad Balancing health checks; they're not Route 53 health checks, but\n\t\t\t\t\t\t\tthey perform a similar function. Do not create Route 53 health checks\n\t\t\t\t\t\t\tfor the EC2 instances that you register with an ELB load balancer.\n\t\t\t\t\t\t

\n \n
\n
S3 buckets
\n
\n

There are no special requirements for setting\n\t\t\t\t\t\t\tEvaluateTargetHealth to true when the alias\n\t\t\t\t\t\ttarget is an S3 bucket.

\n
\n
Other records in the same hosted zone
\n
\n

If the Amazon Web Services resource that you specify in\n\t\t\t\t\t\t\tDNSName is a record or a group of records (for example, a\n\t\t\t\t\t\tgroup of weighted records) but is not another alias record, we recommend\n\t\t\t\t\t\tthat you associate a health check with all of the records in the alias\n\t\t\t\t\t\ttarget. For more information, see What Happens When You Omit Health Checks? in the\n\t\t\t\t\t\t\tAmazon Route 53 Developer Guide.

\n
\n
\n

For more information and examples, see Amazon Route 53 Health Checks\n\t\t\t\tand DNS Failover in the Amazon Route 53 Developer\n\t\t\tGuide.

", + "smithy.api#required": {} + } } - }, - "params": { - "UseDualStack": false, - "Region": "aws-global", - "UseFIPS": false - } }, - { - "documentation": "For region aws-iso-global with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingName": "route53", - "signingRegion": "us-iso-east-1" - } - ] - }, - "url": "https://route53.c2s.ic.gov" + "traits": { + "smithy.api#documentation": "

\n Alias resource record sets only: Information about the Amazon Web Services resource, such as a CloudFront distribution or an Amazon S3 bucket, that\n\t\t\tyou want to route traffic to.

\n

When creating resource record sets for a private hosted zone, note the\n\t\t\tfollowing:

\n " + } + }, + "com.amazonaws.route53#AssociateVPCComment": { + "type": "string" + }, + "com.amazonaws.route53#AssociateVPCWithHostedZone": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#AssociateVPCWithHostedZoneRequest" + }, + "output": { + "target": "com.amazonaws.route53#AssociateVPCWithHostedZoneResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#ConflictingDomainExists" + }, + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#InvalidVPCId" + }, + { + "target": "com.amazonaws.route53#LimitsExceeded" + }, + { + "target": "com.amazonaws.route53#NoSuchHostedZone" + }, + { + "target": "com.amazonaws.route53#NotAuthorizedException" + }, + { + "target": "com.amazonaws.route53#PriorRequestNotComplete" + }, + { + "target": "com.amazonaws.route53#PublicZoneVPCAssociation" + } + ], + "traits": { + "smithy.api#documentation": "

Associates an Amazon VPC with a private hosted zone.

\n \n

To perform the association, the VPC and the private hosted zone must already\n\t\t\t\texist. You can't convert a public hosted zone into a private hosted zone.

\n \n \n

If you want to associate a VPC that was created by using one Amazon Web Services account with a private hosted zone that was created by using a\n\t\t\t\tdifferent account, the Amazon Web Services account that created the private hosted\n\t\t\t\tzone must first submit a CreateVPCAssociationAuthorization request.\n\t\t\t\tThen the account that created the VPC must submit an\n\t\t\t\t\tAssociateVPCWithHostedZone request.

\n \n \n

When granting access, the hosted zone and the Amazon VPC must belong to\n\t\t\t\tthe same partition. A partition is a group of Amazon Web Services Regions. Each\n\t\t\t\t\tAmazon Web Services account is scoped to one partition.

\n

The following are the supported partitions:

\n \n

For more information, see Access Management\n\t\t\t\tin the Amazon Web Services General Reference.

\n ", + "smithy.api#http": { + "method": "POST", + "uri": "/2013-04-01/hostedzone/{HostedZoneId}/associatevpc", + "code": 200 + } + } + }, + "com.amazonaws.route53#AssociateVPCWithHostedZoneRequest": { + "type": "structure", + "members": { + "HostedZoneId": { + "target": "com.amazonaws.route53#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the private hosted zone that you want to associate an Amazon VPC\n\t\t\twith.

\n

Note that you can't associate a VPC with a hosted zone that doesn't have an existing\n\t\t\tVPC association.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "VPC": { + "target": "com.amazonaws.route53#VPC", + "traits": { + "smithy.api#documentation": "

A complex type that contains information about the VPC that you want to associate with\n\t\t\ta private hosted zone.

", + "smithy.api#required": {} + } + }, + "Comment": { + "target": "com.amazonaws.route53#AssociateVPCComment", + "traits": { + "smithy.api#documentation": "

\n Optional: A comment about the association request.

" + } } - }, - "params": { - "UseDualStack": false, - "Region": "aws-iso-global", - "UseFIPS": false - } }, - { - "documentation": "For region aws-iso-b-global with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingName": "route53", - "signingRegion": "us-isob-east-1" - } - ] - }, - "url": "https://route53.sc2s.sgov.gov" + "traits": { + "smithy.api#documentation": "

A complex type that contains information about the request to associate a VPC with a\n\t\t\tprivate hosted zone.

" + } + }, + "com.amazonaws.route53#AssociateVPCWithHostedZoneResponse": { + "type": "structure", + "members": { + "ChangeInfo": { + "target": "com.amazonaws.route53#ChangeInfo", + "traits": { + "smithy.api#documentation": "

A complex type that describes the changes made to your hosted zone.

", + "smithy.api#required": {} + } } - }, - "params": { - "UseDualStack": false, - "Region": "aws-iso-b-global", - "UseFIPS": false - } }, - { - "documentation": "For region aws-us-gov-global with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingName": "route53", - "signingRegion": "us-gov-west-1" - } - ] - }, - "url": "https://route53.us-gov.amazonaws.com" + "traits": { + "smithy.api#documentation": "

A complex type that contains the response information for the\n\t\t\t\tAssociateVPCWithHostedZone request.

" + } + }, + "com.amazonaws.route53#Change": { + "type": "structure", + "members": { + "Action": { + "target": "com.amazonaws.route53#ChangeAction", + "traits": { + "smithy.api#documentation": "

The action to perform:

\n ", + "smithy.api#required": {} + } + }, + "ResourceRecordSet": { + "target": "com.amazonaws.route53#ResourceRecordSet", + "traits": { + "smithy.api#documentation": "

Information about the resource record set to create, delete, or update.

", + "smithy.api#required": {} + } } - }, - "params": { - "UseDualStack": false, - "Region": "aws-us-gov-global", - "UseFIPS": false - } }, - { - "documentation": "For custom endpoint with fips disabled and dualstack disabled", - "expect": { - "endpoint": { - "url": "https://example.com" - } - }, - "params": { - "UseDualStack": false, - "Region": "us-east-1", - "UseFIPS": false, - "Endpoint": "https://example.com" - } + "traits": { + "smithy.api#documentation": "

The information for each resource record set that you want to change.

" + } + }, + "com.amazonaws.route53#ChangeAction": { + "type": "enum", + "members": { + "CREATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE" + } + }, + "DELETE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE" + } + }, + "UPSERT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPSERT" + } + } + } + }, + "com.amazonaws.route53#ChangeBatch": { + "type": "structure", + "members": { + "Comment": { + "target": "com.amazonaws.route53#ResourceDescription", + "traits": { + "smithy.api#documentation": "

\n Optional: Any comments you want to include about a change batch\n\t\t\trequest.

" + } + }, + "Changes": { + "target": "com.amazonaws.route53#Changes", + "traits": { + "smithy.api#documentation": "

Information about the changes to make to the record sets.

", + "smithy.api#required": {} + } + } }, - { - "documentation": "For custom endpoint with fips enabled and dualstack disabled", - "expect": { - "error": "Invalid Configuration: FIPS and custom endpoint are not supported" - }, - "params": { - "UseDualStack": false, - "Region": "us-east-1", - "UseFIPS": true, - "Endpoint": "https://example.com" - } + "traits": { + "smithy.api#documentation": "

The information for a change request.

" + } + }, + "com.amazonaws.route53#ChangeCidrCollection": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#ChangeCidrCollectionRequest" }, - { - "documentation": "For custom endpoint with fips disabled and dualstack enabled", - "expect": { - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" - }, - "params": { - "UseDualStack": true, - "Region": "us-east-1", - "UseFIPS": false, - "Endpoint": "https://example.com" - } - } - ], - "version": "1.0" - } - } - }, - "com.amazonaws.route53#AccountLimit": { - "type": "structure", - "members": { - "Type": { - "target": "com.amazonaws.route53#AccountLimitType", - "traits": { - "smithy.api#documentation": "

The limit that you requested. Valid values include the following:

\n\t\t ", - "smithy.api#required": {} - } - }, - "Value": { - "target": "com.amazonaws.route53#LimitValue", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The current value for the limit that is specified by Type.

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

A complex type that contains the type of limit that you specified in the request and\n\t\t\tthe current value for that limit.

" - } - }, - "com.amazonaws.route53#AccountLimitType": { - "type": "enum", - "members": { - "MAX_HEALTH_CHECKS_BY_OWNER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MAX_HEALTH_CHECKS_BY_OWNER" - } - }, - "MAX_HOSTED_ZONES_BY_OWNER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MAX_HOSTED_ZONES_BY_OWNER" - } - }, - "MAX_TRAFFIC_POLICY_INSTANCES_BY_OWNER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MAX_TRAFFIC_POLICY_INSTANCES_BY_OWNER" - } - }, - "MAX_REUSABLE_DELEGATION_SETS_BY_OWNER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MAX_REUSABLE_DELEGATION_SETS_BY_OWNER" - } - }, - "MAX_TRAFFIC_POLICIES_BY_OWNER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MAX_TRAFFIC_POLICIES_BY_OWNER" - } - } - } - }, - "com.amazonaws.route53#ActivateKeySigningKey": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#ActivateKeySigningKeyRequest" - }, - "output": { - "target": "com.amazonaws.route53#ActivateKeySigningKeyResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#ConcurrentModification" - }, - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#InvalidKeySigningKeyStatus" - }, - { - "target": "com.amazonaws.route53#InvalidKMSArn" - }, - { - "target": "com.amazonaws.route53#InvalidSigningStatus" - }, - { - "target": "com.amazonaws.route53#NoSuchKeySigningKey" - } - ], - "traits": { - "smithy.api#documentation": "

Activates a key-signing key (KSK) so that it can be used for signing by DNSSEC. This\n\t\t\toperation changes the KSK status to ACTIVE.

", - "smithy.api#http": { - "method": "POST", - "uri": "/2013-04-01/keysigningkey/{HostedZoneId}/{Name}/activate", - "code": 200 - } - } - }, - "com.amazonaws.route53#ActivateKeySigningKeyRequest": { - "type": "structure", - "members": { - "HostedZoneId": { - "target": "com.amazonaws.route53#ResourceId", - "traits": { - "smithy.api#documentation": "

A unique string used to identify a hosted zone.

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

A string used to identify a key-signing key (KSK). Name can include\n\t\t\tnumbers, letters, and underscores (_). Name must be unique for each\n\t\t\tkey-signing key in the same hosted zone.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.route53#ActivateKeySigningKeyResponse": { - "type": "structure", - "members": { - "ChangeInfo": { - "target": "com.amazonaws.route53#ChangeInfo", - "traits": { - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.route53#AlarmIdentifier": { - "type": "structure", - "members": { - "Region": { - "target": "com.amazonaws.route53#CloudWatchRegion", - "traits": { - "smithy.api#documentation": "

For the CloudWatch alarm that you want Route 53 health checkers to use to determine\n\t\t\twhether this health check is healthy, the region that the alarm was created in.

\n\t\t

For the current list of CloudWatch regions, see Amazon CloudWatch endpoints and\n\t\t\t\tquotas in the Amazon Web Services General\n\t\t\tReference.

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

The name of the CloudWatch alarm that you want Amazon Route 53 health checkers to use\n\t\t\tto determine whether this health check is healthy.

\n\t\t \n\t\t\t

Route 53 supports CloudWatch alarms with the following features:

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

A complex type that identifies the CloudWatch alarm that you want Amazon Route 53\n\t\t\thealth checkers to use to determine whether the specified health check is\n\t\t\thealthy.

" - } - }, - "com.amazonaws.route53#AlarmName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - } - } - }, - "com.amazonaws.route53#AliasHealthEnabled": { - "type": "boolean", - "traits": { - "smithy.api#default": false - } - }, - "com.amazonaws.route53#AliasTarget": { - "type": "structure", - "members": { - "HostedZoneId": { - "target": "com.amazonaws.route53#ResourceId", - "traits": { - "smithy.api#documentation": "

\n Alias resource records sets only: The value used depends on where\n\t\t\tyou want to route traffic:

\n\t\t
\n
Amazon API Gateway custom regional APIs and edge-optimized APIs
\n
\n\t\t\t\t\t

Specify the hosted zone ID for your API. You can get the applicable value\n\t\t\t\t\t\tusing the CLI command get-domain-names:

\n\t\t\t\t\t
    \n
  • \n\t\t\t\t\t\t\t

    For regional APIs, specify the value of\n\t\t\t\t\t\t\t\t\tregionalHostedZoneId.

    \n\t\t\t\t\t\t
    • \n
  • \n\t\t\t\t\t\t\t

    For edge-optimized APIs, specify the value of\n\t\t\t\t\t\t\t\t\tdistributionHostedZoneId.

    \n\t\t\t\t\t\t
    • \n
\n\t\t\t\t
\n
Amazon Virtual Private Cloud interface VPC endpoint
\n
\n\t\t\t\t\t

Specify the hosted zone ID for your interface endpoint. You can get the\n\t\t\t\t\t\tvalue of HostedZoneId using the CLI command\n\t\t\t\t\t\t\tdescribe-vpc-endpoints.

\n\t\t\t\t
\n
CloudFront distribution
\n
\n\t\t\t\t\t

Specify Z2FDTNDATAQYW2.

\n\t\t\t\t\t \n\t\t\t\t\t\t

Alias resource record sets for CloudFront can't be created in a\n\t\t\t\t\t\t\tprivate zone.

\n\t\t\t\t\t \n\t\t\t\t
\n
Elastic Beanstalk environment
\n
\n\t\t\t\t\t

Specify the hosted zone ID for the region that you created the environment\n\t\t\t\t\t\tin. The environment must have a regionalized subdomain. For a list of\n\t\t\t\t\t\tregions and the corresponding hosted zone IDs, see Elastic Beanstalk endpoints and quotas in the the\n\t\t\t\t\t\t\tAmazon Web Services General Reference.

\n\t\t\t\t
\n
ELB load balancer
\n
\n\t\t\t\t\t

Specify the value of the hosted zone ID for the load balancer. Use the\n\t\t\t\t\t\tfollowing methods to get the hosted zone ID:

\n\t\t\t\t\t
    \n
  • \n\t\t\t\t\t\t\t

    \n Elastic Load Balancing endpoints and quotas topic in\n\t\t\t\t\t\t\t\tthe Amazon Web Services General Reference: Use\n\t\t\t\t\t\t\t\tthe value that corresponds with the region that you created your\n\t\t\t\t\t\t\t\tload balancer in. Note that there are separate columns for\n\t\t\t\t\t\t\t\tApplication and Classic Load Balancers and for Network Load\n\t\t\t\t\t\t\t\tBalancers.

    \n\t\t\t\t\t\t
    • \n
  • \n\t\t\t\t\t\t\t

    \n Amazon Web Services Management Console: Go to the\n\t\t\t\t\t\t\t\tAmazon EC2 page, choose Load\n\t\t\t\t\t\t\t\t\tBalancers in the navigation pane, select the load\n\t\t\t\t\t\t\t\tbalancer, and get the value of the Hosted\n\t\t\t\t\t\t\t\t\tzone field on the Description tab.

    \n\t\t\t\t\t\t
    • \n
  • \n\t\t\t\t\t\t\t

    \n Elastic Load Balancing API: Use\n\t\t\t\t\t\t\t\t\tDescribeLoadBalancers to get the applicable value.\n\t\t\t\t\t\t\t\tFor more information, see the applicable guide:

    \n\t\t\t\t\t\t\t
      \n
    • \n\t\t\t\t\t\t\t\t\t

      Classic Load Balancers: Use DescribeLoadBalancers to get the value of\n\t\t\t\t\t\t\t\t\t\t\tCanonicalHostedZoneNameId.

      \n\t\t\t\t\t\t\t\t
      • \n
    • \n\t\t\t\t\t\t\t\t\t

      Application and Network Load Balancers: Use DescribeLoadBalancers to get the value of\n\t\t\t\t\t\t\t\t\t\t\tCanonicalHostedZoneId.

      \n\t\t\t\t\t\t\t\t
      • \n
    \n\t\t\t\t\t\t
    • \n
  • \n\t\t\t\t\t\t\t

    \n CLI: Use\n\t\t\t\t\t\t\t\t\tdescribe-load-balancers to get the applicable\n\t\t\t\t\t\t\t\tvalue. For more information, see the applicable guide:

    \n\t\t\t\t\t\t\t
      \n
    • \n\t\t\t\t\t\t\t\t\t

      Classic Load Balancers: Use describe-load-balancers to get the value of\n\t\t\t\t\t\t\t\t\t\t\tCanonicalHostedZoneNameId.

      \n\t\t\t\t\t\t\t\t
      • \n
    • \n\t\t\t\t\t\t\t\t\t

      Application and Network Load Balancers: Use describe-load-balancers to get the value of\n\t\t\t\t\t\t\t\t\t\t\tCanonicalHostedZoneId.

      \n\t\t\t\t\t\t\t\t
      • \n
    \n\t\t\t\t\t\t
    • \n
\n\t\t\t\t
\n
Global Accelerator accelerator
\n
\n\t\t\t\t\t

Specify Z2BJ6XQ5FK7U4H.

\n\t\t\t\t
\n
An Amazon S3 bucket configured as a static website
\n
\n\t\t\t\t\t

Specify the hosted zone ID for the region that you created the bucket in.\n\t\t\t\t\t\tFor more information about valid values, see the table Amazon S3\n\t\t\t\t\t\t\tWebsite Endpoints in the Amazon Web Services General\n\t\t\t\t\t\t\tReference.

\n\t\t\t\t
\n
Another Route 53 resource record set in your hosted zone
\n
\n\t\t\t\t\t

Specify the hosted zone ID of your hosted zone. (An alias resource record\n\t\t\t\t\t\tset can't reference a resource record set in a different hosted\n\t\t\t\t\t\tzone.)

\n\t\t\t\t
\n
", - "smithy.api#required": {} - } - }, - "DNSName": { - "target": "com.amazonaws.route53#DNSName", - "traits": { - "smithy.api#documentation": "

\n Alias resource record sets only: The value that you specify\n\t\t\tdepends on where you want to route queries:

\n\t\t
\n
Amazon API Gateway custom regional APIs and edge-optimized APIs
\n
\n\t\t\t\t\t

Specify the applicable domain name for your API. You can get the\n\t\t\t\t\t\tapplicable value using the CLI command get-domain-names:

\n\t\t\t\t\t
    \n
  • \n\t\t\t\t\t\t\t

    For regional APIs, specify the value of\n\t\t\t\t\t\t\t\t\tregionalDomainName.

    \n\t\t\t\t\t\t
    • \n
  • \n\t\t\t\t\t\t\t

    For edge-optimized APIs, specify the value of\n\t\t\t\t\t\t\t\t\tdistributionDomainName. This is the name of the\n\t\t\t\t\t\t\t\tassociated CloudFront distribution, such as\n\t\t\t\t\t\t\t\t\tda1b2c3d4e5.cloudfront.net.

    \n\t\t\t\t\t\t
    • \n
\n\t\t\t\t\t \n\t\t\t\t\t\t

The name of the record that you're creating must match a custom domain\n\t\t\t\t\t\t\tname for your API, such as api.example.com.

\n\t\t\t\t\t \n\t\t\t\t
\n
Amazon Virtual Private Cloud interface VPC endpoint
\n
\n\t\t\t\t\t

Enter the API endpoint for the interface endpoint, such as\n\t\t\t\t\t\t\tvpce-123456789abcdef01-example-us-east-1a.elasticloadbalancing.us-east-1.vpce.amazonaws.com.\n\t\t\t\t\t\tFor edge-optimized APIs, this is the domain name for the corresponding\n\t\t\t\t\t\tCloudFront distribution. You can get the value of DnsName using\n\t\t\t\t\t\tthe CLI command describe-vpc-endpoints.

\n\t\t\t\t
\n
CloudFront distribution
\n
\n\t\t\t\t\t

Specify the domain name that CloudFront assigned when you created your\n\t\t\t\t\t\tdistribution.

\n\t\t\t\t\t

Your CloudFront distribution must include an alternate domain name that\n\t\t\t\t\t\tmatches the name of the resource record set. For example, if the name of the\n\t\t\t\t\t\tresource record set is acme.example.com, your\n\t\t\t\t\t\tCloudFront distribution must include acme.example.com\n\t\t\t\t\t\tas one of the alternate domain names. For more information, see Using Alternate\n\t\t\t\t\t\t\tDomain Names (CNAMEs) in the Amazon CloudFront\n\t\t\t\t\t\t\tDeveloper Guide.

\n\t\t\t\t\t

You can't create a resource record set in a private hosted zone to route\n\t\t\t\t\t\ttraffic to a CloudFront distribution.

\n\t\t\t\t\t \n\t\t\t\t\t\t

For failover alias records, you can't specify a CloudFront\n\t\t\t\t\t\t\tdistribution for both the primary and secondary records. A distribution\n\t\t\t\t\t\t\tmust include an alternate domain name that matches the name of the\n\t\t\t\t\t\t\trecord. However, the primary and secondary records have the same name,\n\t\t\t\t\t\t\tand you can't include the same alternate domain name in more than one\n\t\t\t\t\t\t\tdistribution.

\n\t\t\t\t\t \n\t\t\t\t
\n
Elastic Beanstalk environment
\n
\n\t\t\t\t\t

If the domain name for your Elastic Beanstalk environment includes the\n\t\t\t\t\t\tregion that you deployed the environment in, you can create an alias record\n\t\t\t\t\t\tthat routes traffic to the environment. For example, the domain name\n\t\t\t\t\t\t\t\tmy-environment.us-west-2.elasticbeanstalk.com\n\t\t\t\t\t\tis a regionalized domain name.

\n\t\t\t\t\t \n\t\t\t\t\t\t

For environments that were created before early 2016, the domain name\n\t\t\t\t\t\t\tdoesn't include the region. To route traffic to these environments, you\n\t\t\t\t\t\t\tmust create a CNAME record instead of an alias record. Note that you\n\t\t\t\t\t\t\tcan't create a CNAME record for the root domain name. For example, if\n\t\t\t\t\t\t\tyour domain name is example.com, you can create a record that routes\n\t\t\t\t\t\t\ttraffic for acme.example.com to your Elastic Beanstalk environment, but\n\t\t\t\t\t\t\tyou can't create a record that routes traffic for example.com to your\n\t\t\t\t\t\t\tElastic Beanstalk environment.

\n\t\t\t\t\t \n\t\t\t\t\t

For Elastic Beanstalk environments that have regionalized subdomains,\n\t\t\t\t\t\tspecify the CNAME attribute for the environment. You can use\n\t\t\t\t\t\tthe following methods to get the value of the CNAME attribute:

\n\t\t\t\t\t
    \n
  • \n\t\t\t\t\t\t\t

    \n Amazon Web Services Management Console: For information about\n\t\t\t\t\t\t\t\thow to get the value by using the console, see Using Custom\n\t\t\t\t\t\t\t\t\tDomains with Elastic Beanstalk in the\n\t\t\t\t\t\t\t\t\t\tElastic Beanstalk Developer\n\t\t\t\t\t\t\t\tGuide.

    \n\t\t\t\t\t\t
    • \n
  • \n\t\t\t\t\t\t\t

    \n Elastic Beanstalk API: Use the\n\t\t\t\t\t\t\t\t\tDescribeEnvironments action to get the value of the\n\t\t\t\t\t\t\t\t\tCNAME attribute. For more information, see DescribeEnvironments in the Elastic Beanstalk API Reference.

    \n\t\t\t\t\t\t
    • \n
  • \n\t\t\t\t\t\t\t

    \n CLI: Use the\n\t\t\t\t\t\t\t\t\tdescribe-environments command to get the value of\n\t\t\t\t\t\t\t\tthe CNAME attribute. For more information, see describe-environments in the CLI Command Reference.

    \n\t\t\t\t\t\t
    • \n
\n\t\t\t\t
\n
ELB load balancer
\n
\n\t\t\t\t\t

Specify the DNS name that is associated with the load balancer. Get the\n\t\t\t\t\t\tDNS name by using the Amazon Web Services Management Console, the ELB API, or the CLI.

\n\t\t\t\t\t
    \n
  • \n\t\t\t\t\t\t\t

    \n Amazon Web Services Management Console: Go to the\n\t\t\t\t\t\t\t\tEC2 page, choose Load Balancers in\n\t\t\t\t\t\t\t\tthe navigation pane, choose the load balancer, choose the Description tab, and get the value of the\n\t\t\t\t\t\t\t\t\tDNS name field.

    \n\t\t\t\t\t\t\t

    If you're routing traffic to a Classic Load Balancer, get the\n\t\t\t\t\t\t\t\tvalue that begins with dualstack.\n\t\t\t\t\t\t\t\tIf you're routing traffic to another type of load balancer, get the\n\t\t\t\t\t\t\t\tvalue that applies to the record type, A or AAAA.

    \n\t\t\t\t\t\t
    • \n
  • \n\t\t\t\t\t\t\t

    \n Elastic Load Balancing API: Use\n\t\t\t\t\t\t\t\t\tDescribeLoadBalancers to get the value of\n\t\t\t\t\t\t\t\t\tDNSName. For more information, see the applicable\n\t\t\t\t\t\t\t\tguide:

    \n\t\t\t\t\t\t\t
      \n
    • \n\t\t\t\t\t\t\t\t\t

      Classic Load Balancers: DescribeLoadBalancers\n\t\t\t\t\t\t\t\t\t

      \n\t\t\t\t\t\t\t\t
      • \n
    • \n\t\t\t\t\t\t\t\t\t

      Application and Network Load Balancers: DescribeLoadBalancers\n

      \n\t\t\t\t\t\t\t\t
      • \n
    \n\t\t\t\t\t\t
    • \n
  • \n\t\t\t\t\t\t\t

    \n CLI: Use\n\t\t\t\t\t\t\t\t\tdescribe-load-balancers to get the value of\n\t\t\t\t\t\t\t\t\tDNSName. For more information, see the applicable\n\t\t\t\t\t\t\t\tguide:

    \n\t\t\t\t\t\t\t \n\t\t\t\t\t\t
    • \n
\n\t\t\t\t
\n
Global Accelerator accelerator
\n
\n\t\t\t\t\t

Specify the DNS name for your accelerator:

\n\t\t\t\t\t
    \n
  • \n\t\t\t\t\t\t\t

    \n Global Accelerator API: To get\n\t\t\t\t\t\t\t\tthe DNS name, use DescribeAccelerator.

    \n\t\t\t\t\t\t
    • \n
  • \n\t\t\t\t\t\t\t

    \n CLI: To get the\n\t\t\t\t\t\t\t\tDNS name, use describe-accelerator.

    \n\t\t\t\t\t\t
    • \n
\n\t\t\t\t
\n
Amazon S3 bucket that is configured as a static website
\n
\n\t\t\t\t\t

Specify the domain name of the Amazon S3 website endpoint that you created\n\t\t\t\t\t\tthe bucket in, for example, s3-website.us-east-2.amazonaws.com.\n\t\t\t\t\t\tFor more information about valid values, see the table Amazon S3\n\t\t\t\t\t\t\tWebsite Endpoints in the Amazon Web Services General\n\t\t\t\t\t\t\tReference. For more information about using S3 buckets for\n\t\t\t\t\t\twebsites, see Getting Started\n\t\t\t\t\t\t\twith Amazon Route 53 in the Amazon Route 53 Developer\n\t\t\t\t\t\t\tGuide.\n

\n\t\t\t\t
\n
Another Route 53 resource record set
\n
\n\t\t\t\t\t

Specify the value of the Name element for a resource record\n\t\t\t\t\t\tset in the current hosted zone.

\n\t\t\t\t\t \n\t\t\t\t\t\t

If you're creating an alias record that has the same name as the\n\t\t\t\t\t\t\thosted zone (known as the zone apex), you can't specify the domain name\n\t\t\t\t\t\t\tfor a record for which the value of Type is\n\t\t\t\t\t\t\t\tCNAME. This is because the alias record must have the\n\t\t\t\t\t\t\tsame type as the record that you're routing traffic to, and creating a\n\t\t\t\t\t\t\tCNAME record for the zone apex isn't supported even for an alias\n\t\t\t\t\t\t\trecord.

\n\t\t\t\t\t \n\t\t\t\t
\n
", - "smithy.api#required": {} - } - }, - "EvaluateTargetHealth": { - "target": "com.amazonaws.route53#AliasHealthEnabled", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

\n Applies only to alias, failover alias, geolocation alias, latency alias, and\n\t\t\t\tweighted alias resource record sets: When\n\t\t\t\tEvaluateTargetHealth is true, an alias resource record set\n\t\t\tinherits the health of the referenced Amazon Web Services resource, such as an ELB load\n\t\t\tbalancer or another resource record set in the hosted zone.

\n\t\t

Note the following:

\n\t\t
\n
CloudFront distributions
\n
\n\t\t\t\t\t

You can't set EvaluateTargetHealth to true when\n\t\t\t\t\t\tthe alias target is a CloudFront distribution.

\n\t\t\t\t
\n
Elastic Beanstalk environments that have regionalized subdomains
\n
\n\t\t\t\t\t

If you specify an Elastic Beanstalk environment in DNSName\n\t\t\t\t\t\tand the environment contains an ELB load balancer, Elastic Load Balancing\n\t\t\t\t\t\troutes queries only to the healthy Amazon EC2 instances that are registered\n\t\t\t\t\t\twith the load balancer. (An environment automatically contains an ELB load\n\t\t\t\t\t\tbalancer if it includes more than one Amazon EC2 instance.) If you set\n\t\t\t\t\t\t\tEvaluateTargetHealth to true and either no\n\t\t\t\t\t\tAmazon EC2 instances are healthy or the load balancer itself is unhealthy,\n\t\t\t\t\t\tRoute 53 routes queries to other available resources that are healthy, if\n\t\t\t\t\t\tany.

\n\t\t\t\t\t

If the environment contains a single Amazon EC2 instance, there are no\n\t\t\t\t\t\tspecial requirements.

\n\t\t\t\t
\n
ELB load balancers
\n
\n\t\t\t\t\t

Health checking behavior depends on the type of load balancer:

\n\t\t\t\t\t
    \n
  • \n\t\t\t\t\t\t\t

    \n Classic Load Balancers: If you\n\t\t\t\t\t\t\t\tspecify an ELB Classic Load Balancer in DNSName,\n\t\t\t\t\t\t\t\tElastic Load Balancing routes queries only to the healthy Amazon EC2\n\t\t\t\t\t\t\t\tinstances that are registered with the load balancer. If you set\n\t\t\t\t\t\t\t\t\tEvaluateTargetHealth to true and\n\t\t\t\t\t\t\t\teither no EC2 instances are healthy or the load balancer itself is\n\t\t\t\t\t\t\t\tunhealthy, Route 53 routes queries to other resources.

    \n\t\t\t\t\t\t
    • \n
  • \n\t\t\t\t\t\t\t

    \n Application and Network Load\n\t\t\t\t\t\t\t\t\tBalancers: If you specify an ELB Application or\n\t\t\t\t\t\t\t\tNetwork Load Balancer and you set EvaluateTargetHealth\n\t\t\t\t\t\t\t\tto true, Route 53 routes queries to the load balancer\n\t\t\t\t\t\t\t\tbased on the health of the target groups that are associated with\n\t\t\t\t\t\t\t\tthe load balancer:

    \n\t\t\t\t\t\t\t
      \n
    • \n\t\t\t\t\t\t\t\t\t

      For an Application or Network Load Balancer to be\n\t\t\t\t\t\t\t\t\t\tconsidered healthy, every target group that contains targets\n\t\t\t\t\t\t\t\t\t\tmust contain at least one healthy target. If any target\n\t\t\t\t\t\t\t\t\t\tgroup contains only unhealthy targets, the load balancer is\n\t\t\t\t\t\t\t\t\t\tconsidered unhealthy, and Route 53 routes queries to other\n\t\t\t\t\t\t\t\t\t\tresources.

      \n\t\t\t\t\t\t\t\t
      • \n
    • \n\t\t\t\t\t\t\t\t\t

      A target group that has no registered targets is\n\t\t\t\t\t\t\t\t\t\tconsidered unhealthy.

      \n\t\t\t\t\t\t\t\t
      • \n
    \n\t\t\t\t\t\t
    • \n
\n\t\t\t\t\t \n\t\t\t\t\t\t

When you create a load balancer, you configure settings for Elastic\n\t\t\t\t\t\t\tLoad Balancing health checks; they're not Route 53 health checks, but\n\t\t\t\t\t\t\tthey perform a similar function. Do not create Route 53 health checks\n\t\t\t\t\t\t\tfor the EC2 instances that you register with an ELB load balancer.\n\t\t\t\t\t\t

\n\t\t\t\t\t \n\t\t\t\t
\n
S3 buckets
\n
\n\t\t\t\t\t

There are no special requirements for setting\n\t\t\t\t\t\t\tEvaluateTargetHealth to true when the alias\n\t\t\t\t\t\ttarget is an S3 bucket.

\n\t\t\t\t
\n
Other records in the same hosted zone
\n
\n\t\t\t\t\t

If the Amazon Web Services resource that you specify in\n\t\t\t\t\t\t\tDNSName is a record or a group of records (for example, a\n\t\t\t\t\t\tgroup of weighted records) but is not another alias record, we recommend\n\t\t\t\t\t\tthat you associate a health check with all of the records in the alias\n\t\t\t\t\t\ttarget. For more information, see What Happens When You Omit Health Checks? in the\n\t\t\t\t\t\t\tAmazon Route 53 Developer Guide.

\n\t\t\t\t
\n
\n\t\t

For more information and examples, see Amazon Route 53 Health Checks\n\t\t\t\tand DNS Failover in the Amazon Route 53 Developer\n\t\t\tGuide.

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

\n Alias resource record sets only: Information about the Amazon Web Services resource, such as a CloudFront distribution or an Amazon S3 bucket, that\n\t\t\tyou want to route traffic to.

\n\t\t

When creating resource record sets for a private hosted zone, note the\n\t\t\tfollowing:

\n\t\t " - } - }, - "com.amazonaws.route53#AssociateVPCComment": { - "type": "string" - }, - "com.amazonaws.route53#AssociateVPCWithHostedZone": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#AssociateVPCWithHostedZoneRequest" - }, - "output": { - "target": "com.amazonaws.route53#AssociateVPCWithHostedZoneResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#ConflictingDomainExists" - }, - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#InvalidVPCId" - }, - { - "target": "com.amazonaws.route53#LimitsExceeded" - }, - { - "target": "com.amazonaws.route53#NoSuchHostedZone" - }, - { - "target": "com.amazonaws.route53#NotAuthorizedException" - }, - { - "target": "com.amazonaws.route53#PriorRequestNotComplete" - }, - { - "target": "com.amazonaws.route53#PublicZoneVPCAssociation" - } - ], - "traits": { - "smithy.api#documentation": "

Associates an Amazon VPC with a private hosted zone.

\n\t\t \n\t\t\t

To perform the association, the VPC and the private hosted zone must already\n\t\t\t\texist. You can't convert a public hosted zone into a private hosted zone.

\n\t\t \n\t\t \n\t\t\t

If you want to associate a VPC that was created by using one Amazon Web Services account with a private hosted zone that was created by using a\n\t\t\t\tdifferent account, the Amazon Web Services account that created the private hosted\n\t\t\t\tzone must first submit a CreateVPCAssociationAuthorization request.\n\t\t\t\tThen the account that created the VPC must submit an\n\t\t\t\t\tAssociateVPCWithHostedZone request.

\n\t\t \n\t\t \n\t\t\t

When granting access, the hosted zone and the Amazon VPC must belong to\n\t\t\t\tthe same partition. A partition is a group of Amazon Web Services Regions. Each\n\t\t\t\t\tAmazon Web Services account is scoped to one partition.

\n\t\t\t

The following are the supported partitions:

\n\t\t\t \n\t\t\t

For more information, see Access Management\n\t\t\t\tin the Amazon Web Services General Reference.

\n\t\t ", - "smithy.api#http": { - "method": "POST", - "uri": "/2013-04-01/hostedzone/{HostedZoneId}/associatevpc", - "code": 200 - } - } - }, - "com.amazonaws.route53#AssociateVPCWithHostedZoneRequest": { - "type": "structure", - "members": { - "HostedZoneId": { - "target": "com.amazonaws.route53#ResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the private hosted zone that you want to associate an Amazon VPC\n\t\t\twith.

\n\t\t

Note that you can't associate a VPC with a hosted zone that doesn't have an existing\n\t\t\tVPC association.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "VPC": { - "target": "com.amazonaws.route53#VPC", - "traits": { - "smithy.api#documentation": "

A complex type that contains information about the VPC that you want to associate with\n\t\t\ta private hosted zone.

", - "smithy.api#required": {} - } - }, - "Comment": { - "target": "com.amazonaws.route53#AssociateVPCComment", - "traits": { - "smithy.api#documentation": "

\n Optional: A comment about the association request.

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

A complex type that contains information about the request to associate a VPC with a\n\t\t\tprivate hosted zone.

" - } - }, - "com.amazonaws.route53#AssociateVPCWithHostedZoneResponse": { - "type": "structure", - "members": { - "ChangeInfo": { - "target": "com.amazonaws.route53#ChangeInfo", - "traits": { - "smithy.api#documentation": "

A complex type that describes the changes made to your hosted zone.

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

A complex type that contains the response information for the\n\t\t\t\tAssociateVPCWithHostedZone request.

" - } - }, - "com.amazonaws.route53#Change": { - "type": "structure", - "members": { - "Action": { - "target": "com.amazonaws.route53#ChangeAction", - "traits": { - "smithy.api#documentation": "

The action to perform:

\n\t\t ", - "smithy.api#required": {} - } - }, - "ResourceRecordSet": { - "target": "com.amazonaws.route53#ResourceRecordSet", - "traits": { - "smithy.api#documentation": "

Information about the resource record set to create, delete, or update.

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

The information for each resource record set that you want to change.

" - } - }, - "com.amazonaws.route53#ChangeAction": { - "type": "enum", - "members": { - "CREATE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CREATE" - } - }, - "DELETE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETE" - } - }, - "UPSERT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UPSERT" - } - } - } - }, - "com.amazonaws.route53#ChangeBatch": { - "type": "structure", - "members": { - "Comment": { - "target": "com.amazonaws.route53#ResourceDescription", - "traits": { - "smithy.api#documentation": "

\n Optional: Any comments you want to include about a change batch\n\t\t\trequest.

" - } - }, - "Changes": { - "target": "com.amazonaws.route53#Changes", - "traits": { - "smithy.api#documentation": "

Information about the changes to make to the record sets.

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

The information for a change request.

" - } - }, - "com.amazonaws.route53#ChangeCidrCollection": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#ChangeCidrCollectionRequest" - }, - "output": { - "target": "com.amazonaws.route53#ChangeCidrCollectionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#CidrBlockInUseException" - }, - { - "target": "com.amazonaws.route53#CidrCollectionVersionMismatchException" - }, - { - "target": "com.amazonaws.route53#ConcurrentModification" - }, - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#LimitsExceeded" - }, - { - "target": "com.amazonaws.route53#NoSuchCidrCollectionException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates, changes, or deletes CIDR blocks within a collection. Contains authoritative\n\t\t\tIP information mapping blocks to one or multiple locations.

\n\t\t

A change request can update multiple locations in a collection at a time, which is\n\t\t\thelpful if you want to move one or more CIDR blocks from one location to another in one\n\t\t\ttransaction, without downtime.

\n\t\t

\n Limits\n

\n\t\t

The max number of CIDR blocks included in the request is 1000. As a result, big updates\n\t\t\trequire multiple API calls.

\n\t\t

\n PUT and DELETE_IF_EXISTS\n

\n\t\t

Use ChangeCidrCollection to perform the following actions:

\n\t\t ", - "smithy.api#http": { - "method": "POST", - "uri": "/2013-04-01/cidrcollection/{Id}", - "code": 200 - } - } - }, - "com.amazonaws.route53#ChangeCidrCollectionRequest": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.route53#UUID", - "traits": { - "smithy.api#documentation": "

The UUID of the CIDR collection to update.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "CollectionVersion": { - "target": "com.amazonaws.route53#CollectionVersion", - "traits": { - "smithy.api#documentation": "

A sequential counter that Amazon Route 53 sets to 1 when you create a\n\t\t\tcollection and increments it by 1 each time you update the collection.

\n\t\t

We recommend that you use ListCidrCollection to get the current value of\n\t\t\t\tCollectionVersion for the collection that you want to update, and then\n\t\t\tinclude that value with the change request. This prevents Route 53 from\n\t\t\toverwriting an intervening update:

\n\t\t " - } - }, - "Changes": { - "target": "com.amazonaws.route53#CidrCollectionChanges", - "traits": { - "smithy.api#documentation": "

Information about changes to a CIDR collection.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.route53#ChangeCidrCollectionResponse": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.route53#ChangeId", - "traits": { - "smithy.api#documentation": "

The ID that is returned by ChangeCidrCollection. You can use it as input to\n\t\t\t\tGetChange to see if a CIDR collection change has propagated or\n\t\t\tnot.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.route53#ChangeId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 6500 - } - } - }, - "com.amazonaws.route53#ChangeInfo": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.route53#ResourceId", - "traits": { - "smithy.api#documentation": "

This element contains an ID that you use when performing a GetChange action to get\n\t\t\tdetailed information about the change.

", - "smithy.api#required": {} - } - }, - "Status": { - "target": "com.amazonaws.route53#ChangeStatus", - "traits": { - "smithy.api#documentation": "

The current state of the request. PENDING indicates that this request has\n\t\t\tnot yet been applied to all Amazon Route 53 DNS servers.

", - "smithy.api#required": {} - } - }, - "SubmittedAt": { - "target": "com.amazonaws.route53#TimeStamp", - "traits": { - "smithy.api#documentation": "

The date and time that the change request was submitted in ISO 8601 format and Coordinated\n\t\t\tUniversal Time (UTC). For example, the value 2017-03-27T17:48:16.751Z\n\t\t\trepresents March 27, 2017 at 17:48:16.751 UTC.

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

A comment you can provide.

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

A complex type that describes change information about changes made to your hosted\n\t\t\tzone.

" - } - }, - "com.amazonaws.route53#ChangeResourceRecordSets": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#ChangeResourceRecordSetsRequest" - }, - "output": { - "target": "com.amazonaws.route53#ChangeResourceRecordSetsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#InvalidChangeBatch" - }, - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#NoSuchHealthCheck" - }, - { - "target": "com.amazonaws.route53#NoSuchHostedZone" - }, - { - "target": "com.amazonaws.route53#PriorRequestNotComplete" - } - ], - "traits": { - "smithy.api#documentation": "

Creates, changes, or deletes a resource record set, which contains authoritative DNS\n\t\t\tinformation for a specified domain name or subdomain name. For example, you can use\n\t\t\t\tChangeResourceRecordSets to create a resource record set that routes\n\t\t\ttraffic for test.example.com to a web server that has an IP address of\n\t\t\t192.0.2.44.

\n\t\t

\n Deleting Resource Record Sets\n

\n\t\t

To delete a resource record set, you must specify all the same values that you\n\t\t\tspecified when you created it.

\n\t\t

\n Change Batches and Transactional Changes\n

\n\t\t

The request body must include a document with a\n\t\t\t\tChangeResourceRecordSetsRequest element. The request body contains a\n\t\t\tlist of change items, known as a change batch. Change batches are considered\n\t\t\ttransactional changes. Route 53 validates the changes in the request and then either\n\t\t\tmakes all or none of the changes in the change batch request. This ensures that DNS\n\t\t\trouting isn't adversely affected by partial changes to the resource record sets in a\n\t\t\thosted zone.

\n\t\t

For example, suppose a change batch request contains two changes: it deletes the\n\t\t\t\tCNAME resource record set for www.example.com and creates an alias\n\t\t\tresource record set for www.example.com. If validation for both records succeeds, Route\n\t\t\t53 deletes the first resource record set and creates the second resource record set in a\n\t\t\tsingle operation. If validation for either the DELETE or the\n\t\t\t\tCREATE action fails, then the request is canceled, and the original\n\t\t\t\tCNAME record continues to exist.

\n\t\t \n\t\t\t

If you try to delete the same resource record set more than once in a single\n\t\t\t\tchange batch, Route 53 returns an InvalidChangeBatch error.

\n\t\t \n\t\t

\n Traffic Flow\n

\n\t\t

To create resource record sets for complex routing configurations, use either the\n\t\t\ttraffic flow visual editor in the Route 53 console or the API actions for traffic\n\t\t\tpolicies and traffic policy instances. Save the configuration as a traffic policy, then\n\t\t\tassociate the traffic policy with one or more domain names (such as example.com) or\n\t\t\tsubdomain names (such as www.example.com), in the same hosted zone or in multiple hosted\n\t\t\tzones. You can roll back the updates if the new configuration isn't performing as\n\t\t\texpected. For more information, see Using Traffic Flow to Route\n\t\t\t\tDNS Traffic in the Amazon Route 53 Developer\n\t\t\tGuide.

\n\t\t

\n Create, Delete, and Upsert\n

\n\t\t

Use ChangeResourceRecordsSetsRequest to perform the following\n\t\t\tactions:

\n\t\t \n\t\t

\n Syntaxes for Creating, Updating, and Deleting Resource Record\n\t\t\t\tSets\n

\n\t\t

The syntax for a request depends on the type of resource record set that you want to\n\t\t\tcreate, delete, or update, such as weighted, alias, or failover. The XML elements in\n\t\t\tyour request must appear in the order listed in the syntax.

\n\t\t\n\t\t

For an example for each type of resource record set, see \"Examples.\"

\n\t\t\n\t\t

Don't refer to the syntax in the \"Parameter Syntax\" section, which includes\n\t\t\tall of the elements for every kind of resource record set that you can create, delete,\n\t\t\tor update by using ChangeResourceRecordSets.

\n\t\t

\n Change Propagation to Route 53 DNS Servers\n

\n\t\t

When you submit a ChangeResourceRecordSets request, Route 53 propagates\n\t\t\tyour changes to all of the Route 53 authoritative DNS servers. While your changes are\n\t\t\tpropagating, GetChange returns a status of PENDING. When\n\t\t\tpropagation is complete, GetChange returns a status of INSYNC.\n\t\t\tChanges generally propagate to all Route 53 name servers within 60 seconds. For more\n\t\t\tinformation, see GetChange.

\n\t\t

\n Limits on ChangeResourceRecordSets Requests\n

\n\t\t

For information about the limits on a ChangeResourceRecordSets request,\n\t\t\tsee Limits in the Amazon Route 53 Developer Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/2013-04-01/hostedzone/{HostedZoneId}/rrset", - "code": 200 - } - } - }, - "com.amazonaws.route53#ChangeResourceRecordSetsRequest": { - "type": "structure", - "members": { - "HostedZoneId": { - "target": "com.amazonaws.route53#ResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the hosted zone that contains the resource record sets that you want to\n\t\t\tchange.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ChangeBatch": { - "target": "com.amazonaws.route53#ChangeBatch", - "traits": { - "smithy.api#documentation": "

A complex type that contains an optional comment and the Changes\n\t\t\telement.

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

A complex type that contains change information for the resource record set.

" - } - }, - "com.amazonaws.route53#ChangeResourceRecordSetsResponse": { - "type": "structure", - "members": { - "ChangeInfo": { - "target": "com.amazonaws.route53#ChangeInfo", - "traits": { - "smithy.api#documentation": "

A complex type that contains information about changes made to your hosted\n\t\t\tzone.

\n\t\t

This element contains an ID that you use when performing a GetChange action to get\n\t\t\tdetailed information about the change.

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

A complex type containing the response for the request.

" - } - }, - "com.amazonaws.route53#ChangeStatus": { - "type": "enum", - "members": { - "PENDING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PENDING" - } - }, - "INSYNC": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INSYNC" - } - } - } - }, - "com.amazonaws.route53#ChangeTagsForResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#ChangeTagsForResourceRequest" - }, - "output": { - "target": "com.amazonaws.route53#ChangeTagsForResourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#NoSuchHealthCheck" - }, - { - "target": "com.amazonaws.route53#NoSuchHostedZone" - }, - { - "target": "com.amazonaws.route53#PriorRequestNotComplete" - }, - { - "target": "com.amazonaws.route53#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Adds, edits, or deletes tags for a health check or a hosted zone.

\n\t\t

For information about using tags for cost allocation, see Using Cost Allocation\n\t\t\t\tTags in the Billing and Cost Management User Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/2013-04-01/tags/{ResourceType}/{ResourceId}", - "code": 200 - } - } - }, - "com.amazonaws.route53#ChangeTagsForResourceRequest": { - "type": "structure", - "members": { - "ResourceType": { - "target": "com.amazonaws.route53#TagResourceType", - "traits": { - "smithy.api#documentation": "

The type of the resource.

\n\t\t ", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ResourceId": { - "target": "com.amazonaws.route53#TagResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the resource for which you want to add, change, or delete tags.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "AddTags": { - "target": "com.amazonaws.route53#TagList", - "traits": { - "smithy.api#documentation": "

A complex type that contains a list of the tags that you want to add to the specified\n\t\t\thealth check or hosted zone and/or the tags that you want to edit Value\n\t\t\tfor.

\n\t\t

You can add a maximum of 10 tags to a health check or a hosted zone.

" - } - }, - "RemoveTagKeys": { - "target": "com.amazonaws.route53#TagKeyList", - "traits": { - "smithy.api#documentation": "

A complex type that contains a list of the tags that you want to delete from the\n\t\t\tspecified health check or hosted zone. You can specify up to 10 keys.

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

A complex type that contains information about the tags that you want to add, edit, or\n\t\t\tdelete.

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

Empty response for the request.

" - } - }, - "com.amazonaws.route53#Changes": { - "type": "list", - "member": { - "target": "com.amazonaws.route53#Change", - "traits": { - "smithy.api#xmlName": "Change" - } - }, - "traits": { - "smithy.api#length": { - "min": 1 - } - } - }, - "com.amazonaws.route53#CheckerIpRanges": { - "type": "list", - "member": { - "target": "com.amazonaws.route53#IPAddressCidr" - } - }, - "com.amazonaws.route53#ChildHealthCheckList": { - "type": "list", - "member": { - "target": "com.amazonaws.route53#HealthCheckId", - "traits": { - "smithy.api#xmlName": "ChildHealthCheck" - } - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - } - } - }, - "com.amazonaws.route53#Cidr": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 50 - }, - "smithy.api#pattern": "\\S" - } - }, - "com.amazonaws.route53#CidrBlockInUseException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.route53#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "

This CIDR block is already in use.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.route53#CidrBlockSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.route53#CidrBlockSummary" - } - }, - "com.amazonaws.route53#CidrBlockSummary": { - "type": "structure", - "members": { - "CidrBlock": { - "target": "com.amazonaws.route53#Cidr", - "traits": { - "smithy.api#documentation": "

Value for the CIDR block.

" - } - }, - "LocationName": { - "target": "com.amazonaws.route53#CidrLocationNameDefaultNotAllowed", - "traits": { - "smithy.api#documentation": "

The location name of the CIDR block.

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

A complex type that lists the CIDR blocks.

" - } - }, - "com.amazonaws.route53#CidrCollection": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.route53#ARN", - "traits": { - "smithy.api#documentation": "

The ARN of the collection. Can be used to reference the collection in IAM policy or in\n\t\t\tanother Amazon Web Services account.

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

The unique ID of the CIDR collection.

" - } - }, - "Name": { - "target": "com.amazonaws.route53#CollectionName", - "traits": { - "smithy.api#documentation": "

The name of a CIDR collection.

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

A sequential counter that Route 53 sets to 1 when you create a CIDR\n\t\t\tcollection and increments by 1 each time you update settings for the CIDR\n\t\t\tcollection.

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

A complex\n\t\t\ttype that\n\t\t\tidentifies a CIDR collection.

" - } - }, - "com.amazonaws.route53#CidrCollectionAlreadyExistsException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.route53#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "

A CIDR collection with this name and a different caller reference already exists in this account.

", - "smithy.api#error": "client" - } - }, - "com.amazonaws.route53#CidrCollectionChange": { - "type": "structure", - "members": { - "LocationName": { - "target": "com.amazonaws.route53#CidrLocationNameDefaultNotAllowed", - "traits": { - "smithy.api#documentation": "

Name of the location that is associated with the CIDR\n\t\t\tcollection.

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

CIDR collection change action.

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

List of CIDR blocks.

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

A complex type that contains information about the CIDR collection change.

" - } - }, - "com.amazonaws.route53#CidrCollectionChangeAction": { - "type": "enum", - "members": { - "PUT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PUT" - } - }, - "DELETE_IF_EXISTS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETE_IF_EXISTS" - } - } - } - }, - "com.amazonaws.route53#CidrCollectionChanges": { - "type": "list", - "member": { - "target": "com.amazonaws.route53#CidrCollectionChange" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1000 - } - } - }, - "com.amazonaws.route53#CidrCollectionInUseException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.route53#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "

This CIDR collection is in use, and isn't empty.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.route53#CidrCollectionVersionMismatchException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.route53#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "

The CIDR collection version you provided, doesn't match the one in the\n\t\t\t\tListCidrCollections operation.

", - "smithy.api#error": "client", - "smithy.api#httpError": 409 - } - }, - "com.amazonaws.route53#CidrList": { - "type": "list", - "member": { - "target": "com.amazonaws.route53#Cidr", - "traits": { - "smithy.api#xmlName": "Cidr" - } - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1000 - } - } - }, - "com.amazonaws.route53#CidrLocationNameDefaultAllowed": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 16 - }, - "smithy.api#pattern": "^[0-9A-Za-z_\\-\\*]+$" - } - }, - "com.amazonaws.route53#CidrLocationNameDefaultNotAllowed": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 16 - }, - "smithy.api#pattern": "^[0-9A-Za-z_\\-]+$" - } - }, - "com.amazonaws.route53#CidrNonce": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - }, - "smithy.api#pattern": "^\\p{ASCII}+$" - } - }, - "com.amazonaws.route53#CidrRoutingConfig": { - "type": "structure", - "members": { - "CollectionId": { - "target": "com.amazonaws.route53#UUID", - "traits": { - "smithy.api#documentation": "

The CIDR collection ID.

", - "smithy.api#required": {} - } - }, - "LocationName": { - "target": "com.amazonaws.route53#CidrLocationNameDefaultAllowed", - "traits": { - "smithy.api#documentation": "

The CIDR collection location name.

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

The object that is specified in resource record set object when you are linking a\n\t\t\tresource record set to a CIDR location.

\n\t\t

A LocationName with an asterisk “*” can be used to create a default CIDR\n\t\t\trecord. CollectionId is still required for default record.

" - } - }, - "com.amazonaws.route53#CloudWatchAlarmConfiguration": { - "type": "structure", - "members": { - "EvaluationPeriods": { - "target": "com.amazonaws.route53#EvaluationPeriods", - "traits": { - "smithy.api#documentation": "

For the metric that the CloudWatch alarm is associated with, the number of periods\n\t\t\tthat the metric is compared to the threshold.

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

For the metric that the CloudWatch alarm is associated with, the value the metric is\n\t\t\tcompared with.

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

For the metric that the CloudWatch alarm is associated with, the arithmetic operation\n\t\t\tthat is used for the comparison.

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

For the metric that the CloudWatch alarm is associated with, the duration of one\n\t\t\tevaluation period in seconds.

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

The name of the CloudWatch metric that the alarm is associated with.

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

The namespace of the metric that the alarm is associated with. For more information,\n\t\t\tsee Amazon\n\t\t\t\tCloudWatch Namespaces, Dimensions, and Metrics Reference in the\n\t\t\t\tAmazon CloudWatch User Guide.

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

For the metric that the CloudWatch alarm is associated with, the statistic that is\n\t\t\tapplied to the metric.

", - "smithy.api#required": {} - } - }, - "Dimensions": { - "target": "com.amazonaws.route53#DimensionList", - "traits": { - "smithy.api#documentation": "

For the metric that the CloudWatch alarm is associated with, a complex type that\n\t\t\tcontains information about the dimensions for the metric. For information, see Amazon\n\t\t\t\tCloudWatch Namespaces, Dimensions, and Metrics Reference in the\n\t\t\t\tAmazon CloudWatch User Guide.

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

A complex type that contains information about the CloudWatch alarm that Amazon Route\n\t\t\t53 is monitoring for this health check.

" - } - }, - "com.amazonaws.route53#CloudWatchLogsLogGroupArn": { - "type": "string" - }, - "com.amazonaws.route53#CloudWatchRegion": { - "type": "enum", - "members": { - "us_east_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "us-east-1" - } - }, - "us_east_2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "us-east-2" - } - }, - "us_west_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "us-west-1" - } - }, - "us_west_2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "us-west-2" - } - }, - "ca_central_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ca-central-1" - } - }, - "eu_central_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "eu-central-1" - } - }, - "eu_central_2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "eu-central-2" - } - }, - "eu_west_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "eu-west-1" - } - }, - "eu_west_2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "eu-west-2" - } - }, - "eu_west_3": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "eu-west-3" - } - }, - "ap_east_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ap-east-1" - } - }, - "me_south_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "me-south-1" - } - }, - "me_central_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "me-central-1" - } - }, - "ap_south_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ap-south-1" - } - }, - "ap_south_2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ap-south-2" - } - }, - "ap_southeast_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ap-southeast-1" - } - }, - "ap_southeast_2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ap-southeast-2" - } - }, - "ap_southeast_3": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ap-southeast-3" - } - }, - "ap_northeast_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ap-northeast-1" - } - }, - "ap_northeast_2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ap-northeast-2" - } - }, - "ap_northeast_3": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ap-northeast-3" - } - }, - "eu_north_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "eu-north-1" - } - }, - "sa_east_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "sa-east-1" - } - }, - "cn_northwest_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "cn-northwest-1" - } - }, - "cn_north_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "cn-north-1" - } - }, - "af_south_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "af-south-1" - } - }, - "eu_south_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "eu-south-1" - } - }, - "eu_south_2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "eu-south-2" - } - }, - "us_gov_west_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "us-gov-west-1" - } - }, - "us_gov_east_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "us-gov-east-1" - } - }, - "us_iso_east_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "us-iso-east-1" - } - }, - "us_iso_west_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "us-iso-west-1" - } - }, - "us_isob_east_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "us-isob-east-1" - } - } - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - } - } - }, - "com.amazonaws.route53#CollectionName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - }, - "smithy.api#pattern": "^[0-9A-Za-z_\\-]+$" - } - }, - "com.amazonaws.route53#CollectionSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.route53#CollectionSummary" - } - }, - "com.amazonaws.route53#CollectionSummary": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.route53#ARN", - "traits": { - "smithy.api#documentation": "

The ARN of the collection summary. Can be used to reference the collection in IAM\n\t\t\tpolicy or cross-account.

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

Unique ID for the CIDR collection.

" - } - }, - "Name": { - "target": "com.amazonaws.route53#CollectionName", - "traits": { - "smithy.api#documentation": "

The name of a CIDR collection.

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

A sequential counter that Route 53 sets to 1 when you create a CIDR\n\t\t\tcollection and increments by 1 each time you update settings for the CIDR\n\t\t\tcollection.

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

A complex type that is an entry in an CidrCollection\n\t\t\tarray.

" - } - }, - "com.amazonaws.route53#CollectionVersion": { - "type": "long", - "traits": { - "smithy.api#range": { - "min": 1 - } - } - }, - "com.amazonaws.route53#ComparisonOperator": { - "type": "enum", - "members": { - "GreaterThanOrEqualToThreshold": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "GreaterThanOrEqualToThreshold" - } - }, - "GreaterThanThreshold": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "GreaterThanThreshold" - } - }, - "LessThanThreshold": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LessThanThreshold" - } - }, - "LessThanOrEqualToThreshold": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LessThanOrEqualToThreshold" - } - } - } - }, - "com.amazonaws.route53#ConcurrentModification": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage", - "traits": { - "smithy.api#documentation": "

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

Another user submitted a request to create, update, or delete the object at the same\n\t\t\ttime that you did. Retry the request.

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

The cause of this error depends on the operation that you're performing:

\n\t\t ", - "smithy.api#error": "client" - } - }, - "com.amazonaws.route53#ConflictingTypes": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage", - "traits": { - "smithy.api#documentation": "

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

You tried to update a traffic policy instance by using a traffic policy version that\n\t\t\thas a different DNS type than the current type for the instance. You specified the type\n\t\t\tin the JSON document in the CreateTrafficPolicy or\n\t\t\t\tCreateTrafficPolicyVersionrequest.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.route53#CreateCidrCollection": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#CreateCidrCollectionRequest" - }, - "output": { - "target": "com.amazonaws.route53#CreateCidrCollectionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#CidrCollectionAlreadyExistsException" - }, - { - "target": "com.amazonaws.route53#ConcurrentModification" - }, - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#LimitsExceeded" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a CIDR collection in the current Amazon Web Services account.

", - "smithy.api#http": { - "method": "POST", - "uri": "/2013-04-01/cidrcollection", - "code": 201 - } - } - }, - "com.amazonaws.route53#CreateCidrCollectionRequest": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.route53#CollectionName", - "traits": { - "smithy.api#documentation": "

A unique identifier for the account that can be used to reference the collection from\n\t\t\tother API calls.

", - "smithy.api#required": {} - } - }, - "CallerReference": { - "target": "com.amazonaws.route53#CidrNonce", - "traits": { - "smithy.api#documentation": "

A client-specific token that allows requests to be securely retried so that the\n\t\t\tintended outcome will only occur once, retries receive a similar response, and there are\n\t\t\tno additional edge cases to handle.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.route53#CreateCidrCollectionResponse": { - "type": "structure", - "members": { - "Collection": { - "target": "com.amazonaws.route53#CidrCollection", - "traits": { - "smithy.api#documentation": "

A complex type that contains information about the CIDR collection.

" - } - }, - "Location": { - "target": "com.amazonaws.route53#ResourceURI", - "traits": { - "smithy.api#documentation": "

A unique URL that represents the location for the CIDR collection.

", - "smithy.api#httpHeader": "Location" - } - } - } - }, - "com.amazonaws.route53#CreateHealthCheck": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#CreateHealthCheckRequest" - }, - "output": { - "target": "com.amazonaws.route53#CreateHealthCheckResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#HealthCheckAlreadyExists" - }, - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#TooManyHealthChecks" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a new health check.

\n\t\t

For information about adding health checks to resource record sets, see HealthCheckId in ChangeResourceRecordSets.

\n\t\t

\n ELB Load Balancers\n

\n\t\t

If you're registering EC2 instances with an Elastic Load Balancing (ELB) load\n\t\t\tbalancer, do not create Amazon Route 53 health checks for the EC2 instances. When you\n\t\t\tregister an EC2 instance with a load balancer, you configure settings for an ELB health\n\t\t\tcheck, which performs a similar function to a Route 53 health check.

\n\t\t

\n Private Hosted Zones\n

\n\t\t

You can associate health checks with failover resource record sets in a private hosted\n\t\t\tzone. Note the following:

\n\t\t ", - "smithy.api#http": { - "method": "POST", - "uri": "/2013-04-01/healthcheck", - "code": 201 - } - } - }, - "com.amazonaws.route53#CreateHealthCheckRequest": { - "type": "structure", - "members": { - "CallerReference": { - "target": "com.amazonaws.route53#HealthCheckNonce", - "traits": { - "smithy.api#documentation": "

A unique string that identifies the request and that allows you to retry a failed\n\t\t\t\tCreateHealthCheck request without the risk of creating two identical\n\t\t\thealth checks:

\n\t\t ", - "smithy.api#required": {} - } - }, - "HealthCheckConfig": { - "target": "com.amazonaws.route53#HealthCheckConfig", - "traits": { - "smithy.api#documentation": "

A complex type that contains settings for a new health check.

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

A complex type that contains the health check request information.

" - } - }, - "com.amazonaws.route53#CreateHealthCheckResponse": { - "type": "structure", - "members": { - "HealthCheck": { - "target": "com.amazonaws.route53#HealthCheck", - "traits": { - "smithy.api#documentation": "

A complex type that contains identifying information about the health check.

", - "smithy.api#required": {} - } - }, - "Location": { - "target": "com.amazonaws.route53#ResourceURI", - "traits": { - "smithy.api#documentation": "

The unique URL representing the new health check.

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

A complex type containing the response information for the new health check.

" - } - }, - "com.amazonaws.route53#CreateHostedZone": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#CreateHostedZoneRequest" - }, - "output": { - "target": "com.amazonaws.route53#CreateHostedZoneResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#ConflictingDomainExists" + "output": { + "target": "com.amazonaws.route53#ChangeCidrCollectionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#CidrBlockInUseException" + }, + { + "target": "com.amazonaws.route53#CidrCollectionVersionMismatchException" + }, + { + "target": "com.amazonaws.route53#ConcurrentModification" + }, + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#LimitsExceeded" + }, + { + "target": "com.amazonaws.route53#NoSuchCidrCollectionException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates, changes, or deletes CIDR blocks within a collection. Contains authoritative\n\t\t\tIP information mapping blocks to one or multiple locations.

\n

A change request can update multiple locations in a collection at a time, which is\n\t\t\thelpful if you want to move one or more CIDR blocks from one location to another in one\n\t\t\ttransaction, without downtime.

\n

\n Limits\n

\n

The max number of CIDR blocks included in the request is 1000. As a result, big updates\n\t\t\trequire multiple API calls.

\n

\n PUT and DELETE_IF_EXISTS\n

\n

Use ChangeCidrCollection to perform the following actions:

\n ", + "smithy.api#http": { + "method": "POST", + "uri": "/2013-04-01/cidrcollection/{Id}", + "code": 200 + } + } }, - { - "target": "com.amazonaws.route53#DelegationSetNotAvailable" + "com.amazonaws.route53#ChangeCidrCollectionRequest": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.route53#UUID", + "traits": { + "smithy.api#documentation": "

The UUID of the CIDR collection to update.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "CollectionVersion": { + "target": "com.amazonaws.route53#CollectionVersion", + "traits": { + "smithy.api#documentation": "

A sequential counter that Amazon Route 53 sets to 1 when you create a\n\t\t\tcollection and increments it by 1 each time you update the collection.

\n

We recommend that you use ListCidrCollection to get the current value of\n\t\t\t\tCollectionVersion for the collection that you want to update, and then\n\t\t\tinclude that value with the change request. This prevents Route 53 from\n\t\t\toverwriting an intervening update:

\n " + } + }, + "Changes": { + "target": "com.amazonaws.route53#CidrCollectionChanges", + "traits": { + "smithy.api#documentation": "

Information about changes to a CIDR collection.

", + "smithy.api#required": {} + } + } + } }, - { - "target": "com.amazonaws.route53#DelegationSetNotReusable" + "com.amazonaws.route53#ChangeCidrCollectionResponse": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.route53#ChangeId", + "traits": { + "smithy.api#documentation": "

The ID that is returned by ChangeCidrCollection. You can use it as input to\n\t\t\t\tGetChange to see if a CIDR collection change has propagated or\n\t\t\tnot.

", + "smithy.api#required": {} + } + } + } }, - { - "target": "com.amazonaws.route53#HostedZoneAlreadyExists" + "com.amazonaws.route53#ChangeId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 6500 + } + } }, - { - "target": "com.amazonaws.route53#InvalidDomainName" + "com.amazonaws.route53#ChangeInfo": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.route53#ResourceId", + "traits": { + "smithy.api#documentation": "

This element contains an ID that you use when performing a GetChange action to get\n\t\t\tdetailed information about the change.

", + "smithy.api#required": {} + } + }, + "Status": { + "target": "com.amazonaws.route53#ChangeStatus", + "traits": { + "smithy.api#documentation": "

The current state of the request. PENDING indicates that this request has\n\t\t\tnot yet been applied to all Amazon Route 53 DNS servers.

", + "smithy.api#required": {} + } + }, + "SubmittedAt": { + "target": "com.amazonaws.route53#TimeStamp", + "traits": { + "smithy.api#documentation": "

The date and time that the change request was submitted in ISO 8601 format and Coordinated\n\t\t\tUniversal Time (UTC). For example, the value 2017-03-27T17:48:16.751Z\n\t\t\trepresents March 27, 2017 at 17:48:16.751 UTC.

", + "smithy.api#required": {} + } + }, + "Comment": { + "target": "com.amazonaws.route53#ResourceDescription", + "traits": { + "smithy.api#documentation": "

A comment you can provide.

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

A complex type that describes change information about changes made to your hosted\n\t\t\tzone.

" + } }, - { - "target": "com.amazonaws.route53#InvalidInput" + "com.amazonaws.route53#ChangeResourceRecordSets": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#ChangeResourceRecordSetsRequest" + }, + "output": { + "target": "com.amazonaws.route53#ChangeResourceRecordSetsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#InvalidChangeBatch" + }, + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#NoSuchHealthCheck" + }, + { + "target": "com.amazonaws.route53#NoSuchHostedZone" + }, + { + "target": "com.amazonaws.route53#PriorRequestNotComplete" + } + ], + "traits": { + "smithy.api#documentation": "

Creates, changes, or deletes a resource record set, which contains authoritative DNS\n\t\t\tinformation for a specified domain name or subdomain name. For example, you can use\n\t\t\t\tChangeResourceRecordSets to create a resource record set that routes\n\t\t\ttraffic for test.example.com to a web server that has an IP address of\n\t\t\t192.0.2.44.

\n

\n Deleting Resource Record Sets\n

\n

To delete a resource record set, you must specify all the same values that you\n\t\t\tspecified when you created it.

\n

\n Change Batches and Transactional Changes\n

\n

The request body must include a document with a\n\t\t\t\tChangeResourceRecordSetsRequest element. The request body contains a\n\t\t\tlist of change items, known as a change batch. Change batches are considered\n\t\t\ttransactional changes. Route 53 validates the changes in the request and then either\n\t\t\tmakes all or none of the changes in the change batch request. This ensures that DNS\n\t\t\trouting isn't adversely affected by partial changes to the resource record sets in a\n\t\t\thosted zone.

\n

For example, suppose a change batch request contains two changes: it deletes the\n\t\t\t\tCNAME resource record set for www.example.com and creates an alias\n\t\t\tresource record set for www.example.com. If validation for both records succeeds, Route\n\t\t\t53 deletes the first resource record set and creates the second resource record set in a\n\t\t\tsingle operation. If validation for either the DELETE or the\n\t\t\t\tCREATE action fails, then the request is canceled, and the original\n\t\t\t\tCNAME record continues to exist.

\n \n

If you try to delete the same resource record set more than once in a single\n\t\t\t\tchange batch, Route 53 returns an InvalidChangeBatch error.

\n \n

\n Traffic Flow\n

\n

To create resource record sets for complex routing configurations, use either the\n\t\t\ttraffic flow visual editor in the Route 53 console or the API actions for traffic\n\t\t\tpolicies and traffic policy instances. Save the configuration as a traffic policy, then\n\t\t\tassociate the traffic policy with one or more domain names (such as example.com) or\n\t\t\tsubdomain names (such as www.example.com), in the same hosted zone or in multiple hosted\n\t\t\tzones. You can roll back the updates if the new configuration isn't performing as\n\t\t\texpected. For more information, see Using Traffic Flow to Route\n\t\t\t\tDNS Traffic in the Amazon Route 53 Developer\n\t\t\tGuide.

\n

\n Create, Delete, and Upsert\n

\n

Use ChangeResourceRecordsSetsRequest to perform the following\n\t\t\tactions:

\n \n

\n Syntaxes for Creating, Updating, and Deleting Resource Record\n\t\t\t\tSets\n

\n

The syntax for a request depends on the type of resource record set that you want to\n\t\t\tcreate, delete, or update, such as weighted, alias, or failover. The XML elements in\n\t\t\tyour request must appear in the order listed in the syntax.

\n

For an example for each type of resource record set, see \"Examples.\"

\n

Don't refer to the syntax in the \"Parameter Syntax\" section, which includes\n\t\t\tall of the elements for every kind of resource record set that you can create, delete,\n\t\t\tor update by using ChangeResourceRecordSets.

\n

\n Change Propagation to Route 53 DNS Servers\n

\n

When you submit a ChangeResourceRecordSets request, Route 53 propagates\n\t\t\tyour changes to all of the Route 53 authoritative DNS servers. While your changes are\n\t\t\tpropagating, GetChange returns a status of PENDING. When\n\t\t\tpropagation is complete, GetChange returns a status of INSYNC.\n\t\t\tChanges generally propagate to all Route 53 name servers within 60 seconds. For more\n\t\t\tinformation, see GetChange.

\n

\n Limits on ChangeResourceRecordSets Requests\n

\n

For information about the limits on a ChangeResourceRecordSets request,\n\t\t\tsee Limits in the Amazon Route 53 Developer Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/2013-04-01/hostedzone/{HostedZoneId}/rrset", + "code": 200 + } + } }, - { - "target": "com.amazonaws.route53#InvalidVPCId" + "com.amazonaws.route53#ChangeResourceRecordSetsRequest": { + "type": "structure", + "members": { + "HostedZoneId": { + "target": "com.amazonaws.route53#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the hosted zone that contains the resource record sets that you want to\n\t\t\tchange.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ChangeBatch": { + "target": "com.amazonaws.route53#ChangeBatch", + "traits": { + "smithy.api#documentation": "

A complex type that contains an optional comment and the Changes\n\t\t\telement.

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

A complex type that contains change information for the resource record set.

" + } }, - { - "target": "com.amazonaws.route53#NoSuchDelegationSet" + "com.amazonaws.route53#ChangeResourceRecordSetsResponse": { + "type": "structure", + "members": { + "ChangeInfo": { + "target": "com.amazonaws.route53#ChangeInfo", + "traits": { + "smithy.api#documentation": "

A complex type that contains information about changes made to your hosted\n\t\t\tzone.

\n

This element contains an ID that you use when performing a GetChange action to get\n\t\t\tdetailed information about the change.

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

A complex type containing the response for the request.

" + } }, - { - "target": "com.amazonaws.route53#TooManyHostedZones" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a new public or private hosted zone. You create records in a public hosted\n\t\t\tzone to define how you want to route traffic on the internet for a domain, such as\n\t\t\texample.com, and its subdomains (apex.example.com, acme.example.com). You create records\n\t\t\tin a private hosted zone to define how you want to route traffic for a domain and its\n\t\t\tsubdomains within one or more Amazon Virtual Private Clouds (Amazon VPCs).

\n\t\t \n\t\t\t

You can't convert a public hosted zone to a private hosted zone or vice versa.\n\t\t\t\tInstead, you must create a new hosted zone with the same name and create new\n\t\t\t\tresource record sets.

\n\t\t \n\t\t

For more information about charges for hosted zones, see Amazon Route 53 Pricing.

\n\t\t

Note the following:

\n\t\t \n\t\t

When you submit a CreateHostedZone request, the initial status of the\n\t\t\thosted zone is PENDING. For public hosted zones, this means that the NS and\n\t\t\tSOA records are not yet available on all Route 53 DNS servers. When the NS and\n\t\t\tSOA records are available, the status of the zone changes to INSYNC.

\n\t\t

The CreateHostedZone request requires the caller to have an\n\t\t\t\tec2:DescribeVpcs permission.

\n\t\t \n\t\t\t

When creating private hosted zones, the Amazon VPC must belong to the same\n\t\t\t\tpartition where the hosted zone is created. A partition is a group of Amazon Web Services Regions. Each Amazon Web Services account is scoped to one\n\t\t\t\tpartition.

\n\t\t\t

The following are the supported partitions:

\n\t\t\t \n\t\t\t

For more information, see Access Management\n\t\t\t\tin the Amazon Web Services General Reference.

\n\t\t ", - "smithy.api#http": { - "method": "POST", - "uri": "/2013-04-01/hostedzone", - "code": 201 - } - } - }, - "com.amazonaws.route53#CreateHostedZoneRequest": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.route53#DNSName", - "traits": { - "smithy.api#documentation": "

The name of the domain. Specify a fully qualified domain name, for example,\n\t\t\t\twww.example.com. The trailing dot is optional; Amazon Route 53 assumes that the domain name is fully qualified. This means that\n\t\t\t\tRoute 53 treats www.example.com (without a trailing\n\t\t\tdot) and www.example.com. (with a trailing dot) as\n\t\t\tidentical.

\n\t\t

If you're creating a public hosted zone, this is the name you have registered with\n\t\t\tyour DNS registrar. If your domain name is registered with a registrar other than\n\t\t\t\tRoute 53, change the name servers for your domain to the set of\n\t\t\t\tNameServers that CreateHostedZone returns in\n\t\t\t\tDelegationSet.

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

(Private hosted zones only) A complex type that contains information about the Amazon\n\t\t\tVPC that you're associating with this hosted zone.

\n\t\t

You can specify only one Amazon VPC when you create a private hosted zone. If you are\n\t\t\tassociating a VPC with a hosted zone with this request, the paramaters\n\t\t\t\tVPCId and VPCRegion are also required.

\n\t\t

To associate additional Amazon VPCs with the hosted zone, use AssociateVPCWithHostedZone after you create a hosted zone.

" - } - }, - "CallerReference": { - "target": "com.amazonaws.route53#Nonce", - "traits": { - "smithy.api#documentation": "

A unique string that identifies the request and that allows failed\n\t\t\t\tCreateHostedZone requests to be retried without the risk of executing\n\t\t\tthe operation twice. You must use a unique CallerReference string every\n\t\t\ttime you submit a CreateHostedZone request. CallerReference\n\t\t\tcan be any unique string, for example, a date/time stamp.

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

(Optional) A complex type that contains the following optional values:

\n\t\t \n\t\t

If you don't specify a comment or the PrivateZone element, omit\n\t\t\t\tHostedZoneConfig and the other elements.

" - } - }, - "DelegationSetId": { - "target": "com.amazonaws.route53#ResourceId", - "traits": { - "smithy.api#documentation": "

If you want to associate a reusable delegation set with this hosted zone, the ID that\n\t\t\t\tAmazon Route 53 assigned to the reusable delegation set when you created it.\n\t\t\tFor more information about reusable delegation sets, see CreateReusableDelegationSet.

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

A complex type that contains information about the request to create a public or\n\t\t\tprivate hosted zone.

" - } - }, - "com.amazonaws.route53#CreateHostedZoneResponse": { - "type": "structure", - "members": { - "HostedZone": { - "target": "com.amazonaws.route53#HostedZone", - "traits": { - "smithy.api#documentation": "

A complex type that contains general information about the hosted zone.

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

A complex type that contains information about the CreateHostedZone\n\t\t\trequest.

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

A complex type that describes the name servers for this hosted zone.

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

A complex type that contains information about an Amazon VPC that you associated with\n\t\t\tthis hosted zone.

" - } - }, - "Location": { - "target": "com.amazonaws.route53#ResourceURI", - "traits": { - "smithy.api#documentation": "

The unique URL representing the new hosted zone.

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

A complex type containing the response information for the hosted zone.

" - } - }, - "com.amazonaws.route53#CreateKeySigningKey": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#CreateKeySigningKeyRequest" - }, - "output": { - "target": "com.amazonaws.route53#CreateKeySigningKeyResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#ConcurrentModification" + "com.amazonaws.route53#ChangeStatus": { + "type": "enum", + "members": { + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING" + } + }, + "INSYNC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INSYNC" + } + } + } }, - { - "target": "com.amazonaws.route53#InvalidArgument" + "com.amazonaws.route53#ChangeTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#ChangeTagsForResourceRequest" + }, + "output": { + "target": "com.amazonaws.route53#ChangeTagsForResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#NoSuchHealthCheck" + }, + { + "target": "com.amazonaws.route53#NoSuchHostedZone" + }, + { + "target": "com.amazonaws.route53#PriorRequestNotComplete" + }, + { + "target": "com.amazonaws.route53#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Adds, edits, or deletes tags for a health check or a hosted zone.

\n

For information about using tags for cost allocation, see Using Cost Allocation\n\t\t\t\tTags in the Billing and Cost Management User Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/2013-04-01/tags/{ResourceType}/{ResourceId}", + "code": 200 + } + } }, - { - "target": "com.amazonaws.route53#InvalidInput" + "com.amazonaws.route53#ChangeTagsForResourceRequest": { + "type": "structure", + "members": { + "ResourceType": { + "target": "com.amazonaws.route53#TagResourceType", + "traits": { + "smithy.api#documentation": "

The type of the resource.

\n ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ResourceId": { + "target": "com.amazonaws.route53#TagResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the resource for which you want to add, change, or delete tags.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AddTags": { + "target": "com.amazonaws.route53#TagList", + "traits": { + "smithy.api#documentation": "

A complex type that contains a list of the tags that you want to add to the specified\n\t\t\thealth check or hosted zone and/or the tags that you want to edit Value\n\t\t\tfor.

\n

You can add a maximum of 10 tags to a health check or a hosted zone.

" + } + }, + "RemoveTagKeys": { + "target": "com.amazonaws.route53#TagKeyList", + "traits": { + "smithy.api#documentation": "

A complex type that contains a list of the tags that you want to delete from the\n\t\t\tspecified health check or hosted zone. You can specify up to 10 keys.

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

A complex type that contains information about the tags that you want to add, edit, or\n\t\t\tdelete.

" + } }, - { - "target": "com.amazonaws.route53#InvalidKeySigningKeyName" + "com.amazonaws.route53#ChangeTagsForResourceResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

Empty response for the request.

" + } }, - { - "target": "com.amazonaws.route53#InvalidKeySigningKeyStatus" + "com.amazonaws.route53#Changes": { + "type": "list", + "member": { + "target": "com.amazonaws.route53#Change", + "traits": { + "smithy.api#xmlName": "Change" + } + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } }, - { - "target": "com.amazonaws.route53#InvalidKMSArn" + "com.amazonaws.route53#CheckerIpRanges": { + "type": "list", + "member": { + "target": "com.amazonaws.route53#IPAddressCidr" + } }, - { - "target": "com.amazonaws.route53#InvalidSigningStatus" + "com.amazonaws.route53#ChildHealthCheckList": { + "type": "list", + "member": { + "target": "com.amazonaws.route53#HealthCheckId", + "traits": { + "smithy.api#xmlName": "ChildHealthCheck" + } + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } }, - { - "target": "com.amazonaws.route53#KeySigningKeyAlreadyExists" + "com.amazonaws.route53#Cidr": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + }, + "smithy.api#pattern": "\\S" + } }, - { - "target": "com.amazonaws.route53#NoSuchHostedZone" + "com.amazonaws.route53#CidrBlockInUseException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.route53#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

This CIDR block is already in use.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } }, - { - "target": "com.amazonaws.route53#TooManyKeySigningKeys" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a new key-signing key (KSK) associated with a hosted zone. You can only have\n\t\t\ttwo KSKs per hosted zone.

", - "smithy.api#http": { - "method": "POST", - "uri": "/2013-04-01/keysigningkey", - "code": 201 - } - } - }, - "com.amazonaws.route53#CreateKeySigningKeyRequest": { - "type": "structure", - "members": { - "CallerReference": { - "target": "com.amazonaws.route53#Nonce", - "traits": { - "smithy.api#documentation": "

A unique string that identifies the request.

", - "smithy.api#required": {} - } - }, - "HostedZoneId": { - "target": "com.amazonaws.route53#ResourceId", - "traits": { - "smithy.api#documentation": "

The unique string (ID) used to identify a hosted zone.

", - "smithy.api#required": {} - } - }, - "KeyManagementServiceArn": { - "target": "com.amazonaws.route53#SigningKeyString", - "traits": { - "smithy.api#documentation": "

The Amazon resource name (ARN) for a customer managed key in Key Management Service\n\t\t\t\t(KMS). The KeyManagementServiceArn must be unique for\n\t\t\teach key-signing key (KSK) in a single hosted zone. To see an example of\n\t\t\t\tKeyManagementServiceArn that grants the correct permissions for DNSSEC,\n\t\t\tscroll down to Example.

\n\t\t

You must configure the customer managed customer managed key as follows:

\n\t\t
\n
Status
\n
\n\t\t\t\t\t

Enabled

\n\t\t\t\t
\n
Key spec
\n
\n\t\t\t\t\t

ECC_NIST_P256

\n\t\t\t\t
\n
Key usage
\n
\n\t\t\t\t\t

Sign and verify

\n\t\t\t\t
\n
Key policy
\n
\n\t\t\t\t\t

The key policy must give permission for the following actions:

\n\t\t\t\t\t
    \n
  • \n\t\t\t\t\t\t\t

    DescribeKey

    \n\t\t\t\t\t\t
    • \n
  • \n\t\t\t\t\t\t\t

    GetPublicKey

    \n\t\t\t\t\t\t
    • \n
  • \n\t\t\t\t\t\t\t

    Sign

    \n\t\t\t\t\t\t
    • \n
\n\t\t\t\t\t

The key policy must also include the Amazon Route 53 service in the\n\t\t\t\t\t\tprincipal for your account. Specify the following:

\n\t\t\t\t\t
    \n
  • \n\t\t\t\t\t\t\t

    \n \"Service\": \"dnssec-route53.amazonaws.com\"\n

    \n\t\t\t\t\t\t
    • \n
\n\t\t\t\t
\n
\n\t\t

For more information about working with a customer managed key in KMS, see Key Management Service concepts.

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

A string used to identify a key-signing key (KSK). Name can include\n\t\t\tnumbers, letters, and underscores (_). Name must be unique for each\n\t\t\tkey-signing key in the same hosted zone.

", - "smithy.api#required": {} - } - }, - "Status": { - "target": "com.amazonaws.route53#SigningKeyStatus", - "traits": { - "smithy.api#documentation": "

A string specifying the initial status of the key-signing key (KSK). You can set the\n\t\t\tvalue to ACTIVE or INACTIVE.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.route53#CreateKeySigningKeyResponse": { - "type": "structure", - "members": { - "ChangeInfo": { - "target": "com.amazonaws.route53#ChangeInfo", - "traits": { - "smithy.api#required": {} - } - }, - "KeySigningKey": { - "target": "com.amazonaws.route53#KeySigningKey", - "traits": { - "smithy.api#documentation": "

The key-signing key (KSK) that the request creates.

", - "smithy.api#required": {} - } - }, - "Location": { - "target": "com.amazonaws.route53#ResourceURI", - "traits": { - "smithy.api#documentation": "

The unique URL representing the new key-signing key (KSK).

", - "smithy.api#httpHeader": "Location", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.route53#CreateQueryLoggingConfig": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#CreateQueryLoggingConfigRequest" - }, - "output": { - "target": "com.amazonaws.route53#CreateQueryLoggingConfigResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#ConcurrentModification" - }, - { - "target": "com.amazonaws.route53#InsufficientCloudWatchLogsResourcePolicy" - }, - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#NoSuchCloudWatchLogsLogGroup" - }, - { - "target": "com.amazonaws.route53#NoSuchHostedZone" - }, - { - "target": "com.amazonaws.route53#QueryLoggingConfigAlreadyExists" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a configuration for DNS query logging. After you create a query logging\n\t\t\tconfiguration, Amazon Route 53 begins to publish log data to an Amazon CloudWatch Logs\n\t\t\tlog group.

\n\t\t

DNS query logs contain information about the queries that Route 53 receives for a\n\t\t\tspecified public hosted zone, such as the following:

\n\t\t \n\t\t
\n
Log Group and Resource Policy
\n
\n\t\t\t\t\t

Before you create a query logging configuration, perform the following\n\t\t\t\t\t\toperations.

\n\t\t\t\t\t \n\t\t\t\t\t\t

If you create a query logging configuration using the Route 53\n\t\t\t\t\t\t\tconsole, Route 53 performs these operations automatically.

\n\t\t\t\t\t \n\t\t\t\t\t
    \n
  1. \n\t\t\t\t\t\t\t

    Create a CloudWatch Logs log group, and make note of the ARN,\n\t\t\t\t\t\t\t\twhich you specify when you create a query logging configuration.\n\t\t\t\t\t\t\t\tNote the following:

    \n\t\t\t\t\t\t\t
      \n
    • \n\t\t\t\t\t\t\t\t\t

      You must create the log group in the us-east-1\n\t\t\t\t\t\t\t\t\t\tregion.

      \n\t\t\t\t\t\t\t\t
      • \n
    • \n\t\t\t\t\t\t\t\t\t

      You must use the same Amazon Web Services account to create\n\t\t\t\t\t\t\t\t\t\tthe log group and the hosted zone that you want to configure\n\t\t\t\t\t\t\t\t\t\tquery logging for.

      \n\t\t\t\t\t\t\t\t
      • \n
    • \n\t\t\t\t\t\t\t\t\t

      When you create log groups for query logging, we recommend\n\t\t\t\t\t\t\t\t\t\tthat you use a consistent prefix, for example:

      \n\t\t\t\t\t\t\t\t\t

      \n /aws/route53/hosted zone\n\t\t\t\t\t\t\t\t\t\t\tname\n \n

      \n\t\t\t\t\t\t\t\t\t

      In the next step, you'll create a resource policy, which\n\t\t\t\t\t\t\t\t\t\tcontrols access to one or more log groups and the associated\n\t\t\t\t\t\t\t\t\t\t\tAmazon Web Services resources, such as Route 53 hosted\n\t\t\t\t\t\t\t\t\t\tzones. There's a limit on the number of resource policies\n\t\t\t\t\t\t\t\t\t\tthat you can create, so we recommend that you use a\n\t\t\t\t\t\t\t\t\t\tconsistent prefix so you can use the same resource policy\n\t\t\t\t\t\t\t\t\t\tfor all the log groups that you create for query\n\t\t\t\t\t\t\t\t\t\tlogging.

      \n\t\t\t\t\t\t\t\t
      • \n
    \n\t\t\t\t\t\t
    2. \n
  2. \n\t\t\t\t\t\t\t

    Create a CloudWatch Logs resource policy, and give it the\n\t\t\t\t\t\t\t\tpermissions that Route 53 needs to create log streams and to send\n\t\t\t\t\t\t\t\tquery logs to log streams. For the value of Resource,\n\t\t\t\t\t\t\t\tspecify the ARN for the log group that you created in the previous\n\t\t\t\t\t\t\t\tstep. To use the same resource policy for all the CloudWatch Logs\n\t\t\t\t\t\t\t\tlog groups that you created for query logging configurations,\n\t\t\t\t\t\t\t\treplace the hosted zone name with *, for\n\t\t\t\t\t\t\t\texample:

    \n\t\t\t\t\t\t\t

    \n arn:aws:logs:us-east-1:123412341234:log-group:/aws/route53/*\n

    \n\t\t\t\t\t\t\t

    To avoid the confused deputy problem, a security issue where an\n\t\t\t\t\t\t\t\tentity without a permission for an action can coerce a\n\t\t\t\t\t\t\t\tmore-privileged entity to perform it, you can optionally limit the\n\t\t\t\t\t\t\t\tpermissions that a service has to a resource in a resource-based\n\t\t\t\t\t\t\t\tpolicy by supplying the following values:

    \n\t\t\t\t\t\t\t
      \n
    • \n\t\t\t\t\t\t\t\t\t

      For aws:SourceArn, supply the hosted zone ARN\n\t\t\t\t\t\t\t\t\t\tused in creating the query logging configuration. For\n\t\t\t\t\t\t\t\t\t\texample, aws:SourceArn:\n\t\t\t\t\t\t\t\t\t\t\tarn:aws:route53:::hostedzone/hosted zone\n\t\t\t\t\t\t\t\t\t\tID.

      \n\t\t\t\t\t\t\t\t
      • \n
    • \n\t\t\t\t\t\t\t\t\t

      For aws:SourceAccount, supply the account ID\n\t\t\t\t\t\t\t\t\t\tfor the account that creates the query logging\n\t\t\t\t\t\t\t\t\t\tconfiguration. For example,\n\t\t\t\t\t\t\t\t\t\t\taws:SourceAccount:111111111111.

      \n\t\t\t\t\t\t\t\t
      • \n
    \n\t\t\t\t\t\t\t

    For more information, see The confused\n\t\t\t\t\t\t\t\t\tdeputy problem in the Amazon Web Services\n\t\t\t\t\t\t\t\t\tIAM User Guide.

    \n\t\t\t\t\t\t\t \n\t\t\t\t\t\t\t\t

    You can't use the CloudWatch console to create or edit a\n\t\t\t\t\t\t\t\t\tresource policy. You must use the CloudWatch API, one of the\n\t\t\t\t\t\t\t\t\t\tAmazon Web Services SDKs, or the CLI.

    \n\t\t\t\t\t\t\t     \n\t\t\t\t\t\t
    3. \n
\n\t\t\t\t
\n
Log Streams and Edge Locations
\n
\n\t\t\t\t\t

When Route 53 finishes creating the configuration for DNS query logging,\n\t\t\t\t\t\tit does the following:

\n\t\t\t\t\t
    \n
  • \n\t\t\t\t\t\t\t

    Creates a log stream for an edge location the first time that the\n\t\t\t\t\t\t\t\tedge location responds to DNS queries for the specified hosted zone.\n\t\t\t\t\t\t\t\tThat log stream is used to log all queries that Route 53 responds to\n\t\t\t\t\t\t\t\tfor that edge location.

    \n\t\t\t\t\t\t
    • \n
  • \n\t\t\t\t\t\t\t

    Begins to send query logs to the applicable log stream.

    \n\t\t\t\t\t\t
    • \n
\n\t\t\t\t\t

The name of each log stream is in the following format:

\n\t\t\t\t\t

\n \n hosted zone ID/edge location\n\t\t\t\t\t\t\t\tcode\n \n

\n\t\t\t\t\t

The edge location code is a three-letter code and an arbitrarily assigned\n\t\t\t\t\t\tnumber, for example, DFW3. The three-letter code typically corresponds with\n\t\t\t\t\t\tthe International Air Transport Association airport code for an airport near\n\t\t\t\t\t\tthe edge location. (These abbreviations might change in the future.) For a\n\t\t\t\t\t\tlist of edge locations, see \"The Route 53 Global Network\" on the Route 53 Product Details\n\t\t\t\t\t\tpage.

\n\t\t\t\t
\n
Queries That Are Logged
\n
\n\t\t\t\t\t

Query logs contain only the queries that DNS resolvers forward to Route\n\t\t\t\t\t\t53. If a DNS resolver has already cached the response to a query (such as\n\t\t\t\t\t\tthe IP address for a load balancer for example.com), the resolver will\n\t\t\t\t\t\tcontinue to return the cached response. It doesn't forward another query to\n\t\t\t\t\t\tRoute 53 until the TTL for the corresponding resource record set expires.\n\t\t\t\t\t\tDepending on how many DNS queries are submitted for a resource record set,\n\t\t\t\t\t\tand depending on the TTL for that resource record set, query logs might\n\t\t\t\t\t\tcontain information about only one query out of every several thousand\n\t\t\t\t\t\tqueries that are submitted to DNS. For more information about how DNS works,\n\t\t\t\t\t\tsee Routing\n\t\t\t\t\t\t\tInternet Traffic to Your Website or Web Application in the\n\t\t\t\t\t\t\tAmazon Route 53 Developer Guide.

\n\t\t\t\t
\n
Log File Format
\n
\n\t\t\t\t\t

For a list of the values in each query log and the format of each value,\n\t\t\t\t\t\tsee Logging DNS\n\t\t\t\t\t\t\tQueries in the Amazon Route 53 Developer\n\t\t\t\t\t\t\tGuide.

\n\t\t\t\t
\n
Pricing
\n
\n\t\t\t\t\t

For information about charges for query logs, see Amazon CloudWatch Pricing.

\n\t\t\t\t
\n
How to Stop Logging
\n
\n\t\t\t\t\t

If you want Route 53 to stop sending query logs to CloudWatch Logs, delete\n\t\t\t\t\t\tthe query logging configuration. For more information, see DeleteQueryLoggingConfig.

\n\t\t\t\t
\n
", - "smithy.api#http": { - "method": "POST", - "uri": "/2013-04-01/queryloggingconfig", - "code": 201 - } - } - }, - "com.amazonaws.route53#CreateQueryLoggingConfigRequest": { - "type": "structure", - "members": { - "HostedZoneId": { - "target": "com.amazonaws.route53#ResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the hosted zone that you want to log queries for. You can log queries only\n\t\t\tfor public hosted zones.

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

The Amazon Resource Name (ARN) for the log group that you want to Amazon Route 53 to\n\t\t\tsend query logs to. This is the format of the ARN:

\n\t\t

arn:aws:logs:region:account-id:log-group:log_group_name\n

\n\t\t

To get the ARN for a log group, you can use the CloudWatch console, the DescribeLogGroups API action, the describe-log-groups\n\t\t\tcommand, or the applicable command in one of the Amazon Web Services SDKs.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.route53#CreateQueryLoggingConfigResponse": { - "type": "structure", - "members": { - "QueryLoggingConfig": { - "target": "com.amazonaws.route53#QueryLoggingConfig", - "traits": { - "smithy.api#documentation": "

A complex type that contains the ID for a query logging configuration, the ID of the\n\t\t\thosted zone that you want to log queries for, and the ARN for the log group that you\n\t\t\twant Amazon Route 53 to send query logs to.

", - "smithy.api#required": {} - } - }, - "Location": { - "target": "com.amazonaws.route53#ResourceURI", - "traits": { - "smithy.api#documentation": "

The unique URL representing the new query logging configuration.

", - "smithy.api#httpHeader": "Location", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.route53#CreateReusableDelegationSet": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#CreateReusableDelegationSetRequest" - }, - "output": { - "target": "com.amazonaws.route53#CreateReusableDelegationSetResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#DelegationSetAlreadyCreated" - }, - { - "target": "com.amazonaws.route53#DelegationSetAlreadyReusable" - }, - { - "target": "com.amazonaws.route53#DelegationSetNotAvailable" - }, - { - "target": "com.amazonaws.route53#HostedZoneNotFound" - }, - { - "target": "com.amazonaws.route53#InvalidArgument" - }, - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#LimitsExceeded" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a delegation set (a group of four name servers) that can be reused by multiple\n\t\t\thosted zones that were created by the same Amazon Web Services account.

\n\t\t

You can also create a reusable delegation set that uses the four name servers that are\n\t\t\tassociated with an existing hosted zone. Specify the hosted zone ID in the\n\t\t\t\tCreateReusableDelegationSet request.

\n\t\t \n\t\t\t

You can't associate a reusable delegation set with a private hosted zone.

\n\t\t \n\t\t

For information about using a reusable delegation set to configure white label name\n\t\t\tservers, see Configuring White\n\t\t\t\tLabel Name Servers.

\n\t\t

The process for migrating existing hosted zones to use a reusable delegation set is\n\t\t\tcomparable to the process for configuring white label name servers. You need to perform\n\t\t\tthe following steps:

\n\t\t
    \n
  1. \n\t\t\t\t

    Create a reusable delegation set.

    \n\t\t\t
    2. \n
  2. \n\t\t\t\t

    Recreate hosted zones, and reduce the TTL to 60 seconds or less.

    \n\t\t\t
    3. \n
  3. \n\t\t\t\t

    Recreate resource record sets in the new hosted zones.

    \n\t\t\t
    4. \n
  4. \n\t\t\t\t

    Change the registrar's name servers to use the name servers for the new hosted\n\t\t\t\t\tzones.

    \n\t\t\t
    5. \n
  5. \n\t\t\t\t

    Monitor traffic for the website or application.

    \n\t\t\t
    6. \n
  6. \n\t\t\t\t

    Change TTLs back to their original values.

    \n\t\t\t
    7. \n
\n\t\t

If you want to migrate existing hosted zones to use a reusable delegation set, the\n\t\t\texisting hosted zones can't use any of the name servers that are assigned to the\n\t\t\treusable delegation set. If one or more hosted zones do use one or more name servers\n\t\t\tthat are assigned to the reusable delegation set, you can do one of the\n\t\t\tfollowing:

\n\t\t ", - "smithy.api#http": { - "method": "POST", - "uri": "/2013-04-01/delegationset", - "code": 201 - } - } - }, - "com.amazonaws.route53#CreateReusableDelegationSetRequest": { - "type": "structure", - "members": { - "CallerReference": { - "target": "com.amazonaws.route53#Nonce", - "traits": { - "smithy.api#documentation": "

A unique string that identifies the request, and that allows you to retry failed\n\t\t\t\tCreateReusableDelegationSet requests without the risk of executing the\n\t\t\toperation twice. You must use a unique CallerReference string every time\n\t\t\tyou submit a CreateReusableDelegationSet request.\n\t\t\t\tCallerReference can be any unique string, for example a date/time\n\t\t\tstamp.

", - "smithy.api#required": {} - } - }, - "HostedZoneId": { - "target": "com.amazonaws.route53#ResourceId", - "traits": { - "smithy.api#documentation": "

If you want to mark the delegation set for an existing hosted zone as reusable, the ID\n\t\t\tfor that hosted zone.

" - } - } - } - }, - "com.amazonaws.route53#CreateReusableDelegationSetResponse": { - "type": "structure", - "members": { - "DelegationSet": { - "target": "com.amazonaws.route53#DelegationSet", - "traits": { - "smithy.api#documentation": "

A complex type that contains name server information.

", - "smithy.api#required": {} - } - }, - "Location": { - "target": "com.amazonaws.route53#ResourceURI", - "traits": { - "smithy.api#documentation": "

The unique URL representing the new reusable delegation set.

", - "smithy.api#httpHeader": "Location", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.route53#CreateTrafficPolicy": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#CreateTrafficPolicyRequest" - }, - "output": { - "target": "com.amazonaws.route53#CreateTrafficPolicyResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#InvalidTrafficPolicyDocument" - }, - { - "target": "com.amazonaws.route53#TooManyTrafficPolicies" - }, - { - "target": "com.amazonaws.route53#TrafficPolicyAlreadyExists" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a traffic policy, which you use to create multiple DNS resource record sets\n\t\t\tfor one domain name (such as example.com) or one subdomain name (such as\n\t\t\twww.example.com).

", - "smithy.api#http": { - "method": "POST", - "uri": "/2013-04-01/trafficpolicy", - "code": 201 - } - } - }, - "com.amazonaws.route53#CreateTrafficPolicyInstance": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#CreateTrafficPolicyInstanceRequest" - }, - "output": { - "target": "com.amazonaws.route53#CreateTrafficPolicyInstanceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#NoSuchHostedZone" - }, - { - "target": "com.amazonaws.route53#NoSuchTrafficPolicy" - }, - { - "target": "com.amazonaws.route53#TooManyTrafficPolicyInstances" - }, - { - "target": "com.amazonaws.route53#TrafficPolicyInstanceAlreadyExists" - } - ], - "traits": { - "smithy.api#documentation": "

Creates resource record sets in a specified hosted zone based on the settings in a\n\t\t\tspecified traffic policy version. In addition, CreateTrafficPolicyInstance\n\t\t\tassociates the resource record sets with a specified domain name (such as example.com)\n\t\t\tor subdomain name (such as www.example.com). Amazon Route 53 responds to DNS queries for\n\t\t\tthe domain or subdomain name by using the resource record sets that\n\t\t\t\tCreateTrafficPolicyInstance created.

", - "smithy.api#http": { - "method": "POST", - "uri": "/2013-04-01/trafficpolicyinstance", - "code": 201 - } - } - }, - "com.amazonaws.route53#CreateTrafficPolicyInstanceRequest": { - "type": "structure", - "members": { - "HostedZoneId": { - "target": "com.amazonaws.route53#ResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the hosted zone that you want Amazon Route 53 to create resource record sets\n\t\t\tin by using the configuration in a traffic policy.

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

The domain name (such as example.com) or subdomain name (such as www.example.com) for\n\t\t\twhich Amazon Route 53 responds to DNS queries by using the resource record sets that\n\t\t\tRoute 53 creates for this traffic policy instance.

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

(Optional) The TTL that you want Amazon Route 53 to assign to all of the resource\n\t\t\trecord sets that it creates in the specified hosted zone.

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

The ID of the traffic policy that you want to use to create resource record sets in\n\t\t\tthe specified hosted zone.

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

The version of the traffic policy that you want to use to create resource record sets\n\t\t\tin the specified hosted zone.

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

A complex type that contains information about the resource record sets that you want\n\t\t\tto create based on a specified traffic policy.

" - } - }, - "com.amazonaws.route53#CreateTrafficPolicyInstanceResponse": { - "type": "structure", - "members": { - "TrafficPolicyInstance": { - "target": "com.amazonaws.route53#TrafficPolicyInstance", - "traits": { - "smithy.api#documentation": "

A complex type that contains settings for the new traffic policy instance.

", - "smithy.api#required": {} - } - }, - "Location": { - "target": "com.amazonaws.route53#ResourceURI", - "traits": { - "smithy.api#documentation": "

A unique URL that represents a new traffic policy instance.

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

A complex type that contains the response information for the\n\t\t\t\tCreateTrafficPolicyInstance request.

" - } - }, - "com.amazonaws.route53#CreateTrafficPolicyRequest": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.route53#TrafficPolicyName", - "traits": { - "smithy.api#documentation": "

The name of the traffic policy.

", - "smithy.api#required": {} - } - }, - "Document": { - "target": "com.amazonaws.route53#TrafficPolicyDocument", - "traits": { - "smithy.api#documentation": "

The definition of this traffic policy in JSON format. For more information, see Traffic Policy Document Format.

", - "smithy.api#required": {} - } - }, - "Comment": { - "target": "com.amazonaws.route53#TrafficPolicyComment", - "traits": { - "smithy.api#documentation": "

(Optional) Any comments that you want to include about the traffic policy.

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

A complex type that contains information about the traffic policy that you want to\n\t\t\tcreate.

" - } - }, - "com.amazonaws.route53#CreateTrafficPolicyResponse": { - "type": "structure", - "members": { - "TrafficPolicy": { - "target": "com.amazonaws.route53#TrafficPolicy", - "traits": { - "smithy.api#documentation": "

A complex type that contains settings for the new traffic policy.

", - "smithy.api#required": {} - } - }, - "Location": { - "target": "com.amazonaws.route53#ResourceURI", - "traits": { - "smithy.api#documentation": "

A unique URL that represents a new traffic policy.

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

A complex type that contains the response information for the\n\t\t\t\tCreateTrafficPolicy request.

" - } - }, - "com.amazonaws.route53#CreateTrafficPolicyVersion": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#CreateTrafficPolicyVersionRequest" - }, - "output": { - "target": "com.amazonaws.route53#CreateTrafficPolicyVersionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#ConcurrentModification" - }, - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#InvalidTrafficPolicyDocument" - }, - { - "target": "com.amazonaws.route53#NoSuchTrafficPolicy" - }, - { - "target": "com.amazonaws.route53#TooManyTrafficPolicyVersionsForCurrentPolicy" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a new version of an existing traffic policy. When you create a new version of\n\t\t\ta traffic policy, you specify the ID of the traffic policy that you want to update and a\n\t\t\tJSON-formatted document that describes the new version. You use traffic policies to\n\t\t\tcreate multiple DNS resource record sets for one domain name (such as example.com) or\n\t\t\tone subdomain name (such as www.example.com). You can create a maximum of 1000 versions\n\t\t\tof a traffic policy. If you reach the limit and need to create another version, you'll\n\t\t\tneed to start a new traffic policy.

", - "smithy.api#http": { - "method": "POST", - "uri": "/2013-04-01/trafficpolicy/{Id}", - "code": 201 - } - } - }, - "com.amazonaws.route53#CreateTrafficPolicyVersionRequest": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.route53#TrafficPolicyId", - "traits": { - "smithy.api#documentation": "

The ID of the traffic policy for which you want to create a new version.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Document": { - "target": "com.amazonaws.route53#TrafficPolicyDocument", - "traits": { - "smithy.api#documentation": "

The definition of this version of the traffic policy, in JSON format. You specified\n\t\t\tthe JSON in the CreateTrafficPolicyVersion request. For more information\n\t\t\tabout the JSON format, see CreateTrafficPolicy.

", - "smithy.api#required": {} - } - }, - "Comment": { - "target": "com.amazonaws.route53#TrafficPolicyComment", - "traits": { - "smithy.api#documentation": "

The comment that you specified in the CreateTrafficPolicyVersion request,\n\t\t\tif any.

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

A complex type that contains information about the traffic policy that you want to\n\t\t\tcreate a new version for.

" - } - }, - "com.amazonaws.route53#CreateTrafficPolicyVersionResponse": { - "type": "structure", - "members": { - "TrafficPolicy": { - "target": "com.amazonaws.route53#TrafficPolicy", - "traits": { - "smithy.api#documentation": "

A complex type that contains settings for the new version of the traffic\n\t\t\tpolicy.

", - "smithy.api#required": {} - } - }, - "Location": { - "target": "com.amazonaws.route53#ResourceURI", - "traits": { - "smithy.api#documentation": "

A unique URL that represents a new traffic policy version.

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

A complex type that contains the response information for the\n\t\t\t\tCreateTrafficPolicyVersion request.

" - } - }, - "com.amazonaws.route53#CreateVPCAssociationAuthorization": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#CreateVPCAssociationAuthorizationRequest" - }, - "output": { - "target": "com.amazonaws.route53#CreateVPCAssociationAuthorizationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#ConcurrentModification" - }, - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#InvalidVPCId" - }, - { - "target": "com.amazonaws.route53#NoSuchHostedZone" - }, - { - "target": "com.amazonaws.route53#TooManyVPCAssociationAuthorizations" - } - ], - "traits": { - "smithy.api#documentation": "

Authorizes the Amazon Web Services account that created a specified VPC to submit an\n\t\t\t\tAssociateVPCWithHostedZone request to associate the VPC with a\n\t\t\tspecified hosted zone that was created by a different account. To submit a\n\t\t\t\tCreateVPCAssociationAuthorization request, you must use the account\n\t\t\tthat created the hosted zone. After you authorize the association, use the account that\n\t\t\tcreated the VPC to submit an AssociateVPCWithHostedZone request.

\n\t\t \n\t\t\t

If you want to associate multiple VPCs that you created by using one account with\n\t\t\t\ta hosted zone that you created by using a different account, you must submit one\n\t\t\t\tauthorization request for each VPC.

\n\t\t ", - "smithy.api#http": { - "method": "POST", - "uri": "/2013-04-01/hostedzone/{HostedZoneId}/authorizevpcassociation", - "code": 200 - } - } - }, - "com.amazonaws.route53#CreateVPCAssociationAuthorizationRequest": { - "type": "structure", - "members": { - "HostedZoneId": { - "target": "com.amazonaws.route53#ResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the private hosted zone that you want to authorize associating a VPC\n\t\t\twith.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "VPC": { - "target": "com.amazonaws.route53#VPC", - "traits": { - "smithy.api#documentation": "

A complex type that contains the VPC ID and region for the VPC that you want to\n\t\t\tauthorize associating with your hosted zone.

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

A complex type that contains information about the request to authorize associating a\n\t\t\tVPC with your private hosted zone. Authorization is only required when a private hosted\n\t\t\tzone and a VPC were created by using different accounts.

" - } - }, - "com.amazonaws.route53#CreateVPCAssociationAuthorizationResponse": { - "type": "structure", - "members": { - "HostedZoneId": { - "target": "com.amazonaws.route53#ResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the hosted zone that you authorized associating a VPC with.

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

The VPC that you authorized associating with a hosted zone.

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

A complex type that contains the response information from a\n\t\t\t\tCreateVPCAssociationAuthorization request.

" - } - }, - "com.amazonaws.route53#DNSName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1024 - } - } - }, - "com.amazonaws.route53#DNSRCode": { - "type": "string" - }, - "com.amazonaws.route53#DNSSECNotFound": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "

The hosted zone doesn't have any DNSSEC resources.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.route53#DNSSECStatus": { - "type": "structure", - "members": { - "ServeSignature": { - "target": "com.amazonaws.route53#ServeSignature", - "traits": { - "smithy.api#documentation": "

A string that represents the current hosted zone signing status.

\n\t\t

Status can have one of the following values:

\n\t\t
\n
SIGNING
\n
\n\t\t\t\t\t

DNSSEC signing is enabled for the hosted zone.

\n\t\t\t\t
\n
NOT_SIGNING
\n
\n\t\t\t\t\t

DNSSEC signing is not enabled for the hosted zone.

\n\t\t\t\t
\n
DELETING
\n
\n\t\t\t\t\t

DNSSEC signing is in the process of being removed for the hosted\n\t\t\t\t\t\tzone.

\n\t\t\t\t
\n
ACTION_NEEDED
\n
\n\t\t\t\t\t

There is a problem with signing in the hosted zone that requires you to\n\t\t\t\t\t\ttake action to resolve. For example, the customer managed key might have\n\t\t\t\t\t\tbeen deleted, or the permissions for the customer managed key might have\n\t\t\t\t\t\tbeen changed.

\n\t\t\t\t
\n
INTERNAL_FAILURE
\n
\n\t\t\t\t\t

There was an error during a request. Before you can continue to work with\n\t\t\t\t\t\tDNSSEC signing, including with key-signing keys (KSKs), you must correct the\n\t\t\t\t\t\tproblem by enabling or disabling DNSSEC signing for the hosted zone.

\n\t\t\t\t
\n
" - } - }, - "StatusMessage": { - "target": "com.amazonaws.route53#SigningKeyStatusMessage", - "traits": { - "smithy.api#documentation": "

The status message provided for the following DNSSEC signing status:\n\t\t\t\tINTERNAL_FAILURE. The status message includes information about what\n\t\t\tthe problem might be and steps that you can take to correct the issue.

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

A string repesenting the status of DNSSEC signing.

" - } - }, - "com.amazonaws.route53#DeactivateKeySigningKey": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#DeactivateKeySigningKeyRequest" - }, - "output": { - "target": "com.amazonaws.route53#DeactivateKeySigningKeyResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#ConcurrentModification" - }, - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#InvalidKeySigningKeyStatus" - }, - { - "target": "com.amazonaws.route53#InvalidSigningStatus" - }, - { - "target": "com.amazonaws.route53#KeySigningKeyInParentDSRecord" - }, - { - "target": "com.amazonaws.route53#KeySigningKeyInUse" - }, - { - "target": "com.amazonaws.route53#NoSuchKeySigningKey" - } - ], - "traits": { - "smithy.api#documentation": "

Deactivates a key-signing key (KSK) so that it will not be used for signing by DNSSEC.\n\t\t\tThis operation changes the KSK status to INACTIVE.

", - "smithy.api#http": { - "method": "POST", - "uri": "/2013-04-01/keysigningkey/{HostedZoneId}/{Name}/deactivate", - "code": 200 - } - } - }, - "com.amazonaws.route53#DeactivateKeySigningKeyRequest": { - "type": "structure", - "members": { - "HostedZoneId": { - "target": "com.amazonaws.route53#ResourceId", - "traits": { - "smithy.api#documentation": "

A unique string used to identify a hosted zone.

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

A string used to identify a key-signing key (KSK).

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.route53#DeactivateKeySigningKeyResponse": { - "type": "structure", - "members": { - "ChangeInfo": { - "target": "com.amazonaws.route53#ChangeInfo", - "traits": { - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.route53#DelegationSet": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.route53#ResourceId", - "traits": { - "smithy.api#documentation": "

The ID that Amazon Route 53 assigns to a reusable delegation set.

" - } - }, - "CallerReference": { - "target": "com.amazonaws.route53#Nonce", - "traits": { - "smithy.api#documentation": "

The value that you specified for CallerReference when you created the\n\t\t\treusable delegation set.

" - } - }, - "NameServers": { - "target": "com.amazonaws.route53#DelegationSetNameServers", - "traits": { - "smithy.api#documentation": "

A complex type that contains a list of the authoritative name servers for a hosted\n\t\t\tzone or for a reusable delegation set.

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

A complex type that lists the name servers in a delegation set, as well as the\n\t\t\t\tCallerReference and the ID for the delegation set.

" - } - }, - "com.amazonaws.route53#DelegationSetAlreadyCreated": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage", - "traits": { - "smithy.api#documentation": "

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

A delegation set with the same owner and caller reference combination has already been\n\t\t\tcreated.

", - "smithy.api#error": "client" - } - }, - "com.amazonaws.route53#DelegationSetAlreadyReusable": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage", - "traits": { - "smithy.api#documentation": "

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

The specified delegation set has already been marked as reusable.

", - "smithy.api#error": "client" - } - }, - "com.amazonaws.route53#DelegationSetInUse": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage", - "traits": { - "smithy.api#documentation": "

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

The specified delegation contains associated hosted zones which must be deleted before\n\t\t\tthe reusable delegation set can be deleted.

", - "smithy.api#error": "client" - } - }, - "com.amazonaws.route53#DelegationSetNameServers": { - "type": "list", - "member": { - "target": "com.amazonaws.route53#DNSName", - "traits": { - "smithy.api#xmlName": "NameServer" - } - }, - "traits": { - "smithy.api#length": { - "min": 1 - } - } - }, - "com.amazonaws.route53#DelegationSetNotAvailable": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage", - "traits": { - "smithy.api#documentation": "

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

You can create a hosted zone that has the same name as an existing hosted zone\n\t\t\t(example.com is common), but there is a limit to the number of hosted zones that have\n\t\t\tthe same name. If you get this error, Amazon Route 53 has reached that limit. If you own\n\t\t\tthe domain name and Route 53 generates this error, contact Customer Support.

", - "smithy.api#error": "client" - } - }, - "com.amazonaws.route53#DelegationSetNotReusable": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage", - "traits": { - "smithy.api#documentation": "

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

A reusable delegation set with the specified ID does not exist.

", - "smithy.api#error": "client" - } - }, - "com.amazonaws.route53#DelegationSets": { - "type": "list", - "member": { - "target": "com.amazonaws.route53#DelegationSet", - "traits": { - "smithy.api#xmlName": "DelegationSet" - } - } - }, - "com.amazonaws.route53#DeleteCidrCollection": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#DeleteCidrCollectionRequest" - }, - "output": { - "target": "com.amazonaws.route53#DeleteCidrCollectionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#CidrCollectionInUseException" - }, - { - "target": "com.amazonaws.route53#ConcurrentModification" - }, - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#NoSuchCidrCollectionException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes a CIDR collection in the current Amazon Web Services account. The collection\n\t\t\tmust be empty before it can be deleted.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/2013-04-01/cidrcollection/{Id}", - "code": 200 - } - } - }, - "com.amazonaws.route53#DeleteCidrCollectionRequest": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.route53#UUID", - "traits": { - "smithy.api#documentation": "

The UUID of the collection to delete.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.route53#DeleteCidrCollectionResponse": { - "type": "structure", - "members": {} - }, - "com.amazonaws.route53#DeleteHealthCheck": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#DeleteHealthCheckRequest" - }, - "output": { - "target": "com.amazonaws.route53#DeleteHealthCheckResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#HealthCheckInUse" - }, - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#NoSuchHealthCheck" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes a health check.

\n\t\t \n\t\t\t

Amazon Route 53 does not prevent you from deleting a health check even if the\n\t\t\t\thealth check is associated with one or more resource record sets. If you delete a\n\t\t\t\thealth check and you don't update the associated resource record sets, the future\n\t\t\t\tstatus of the health check can't be predicted and may change. This will affect the\n\t\t\t\trouting of DNS queries for your DNS failover configuration. For more information,\n\t\t\t\tsee Replacing and Deleting Health Checks in the Amazon Route 53\n\t\t\t\t\tDeveloper Guide.

\n\t\t \n\t\t

If you're using Cloud Map and you configured Cloud Map to create a Route 53\n\t\t\thealth check when you register an instance, you can't use the Route 53\n\t\t\t\tDeleteHealthCheck command to delete the health check. The health check\n\t\t\tis deleted automatically when you deregister the instance; there can be a delay of\n\t\t\tseveral hours before the health check is deleted from Route 53.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/2013-04-01/healthcheck/{HealthCheckId}", - "code": 200 - } - } - }, - "com.amazonaws.route53#DeleteHealthCheckRequest": { - "type": "structure", - "members": { - "HealthCheckId": { - "target": "com.amazonaws.route53#HealthCheckId", - "traits": { - "smithy.api#documentation": "

The ID of the health check that you want to delete.

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

This action deletes a health check.

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

An empty element.

" - } - }, - "com.amazonaws.route53#DeleteHostedZone": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#DeleteHostedZoneRequest" - }, - "output": { - "target": "com.amazonaws.route53#DeleteHostedZoneResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#HostedZoneNotEmpty" - }, - { - "target": "com.amazonaws.route53#InvalidDomainName" - }, - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#NoSuchHostedZone" - }, - { - "target": "com.amazonaws.route53#PriorRequestNotComplete" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes a hosted zone.

\n\t\t

If the hosted zone was created by another service, such as Cloud Map, see\n\t\t\t\tDeleting Public Hosted Zones That Were Created by Another Service in the\n\t\t\t\t\tAmazon Route 53 Developer Guide for information\n\t\t\tabout how to delete it. (The process is the same for public and private hosted zones\n\t\t\tthat were created by another service.)

\n\t\t

If you want to keep your domain registration but you want to stop routing internet\n\t\t\ttraffic to your website or web application, we recommend that you delete resource record\n\t\t\tsets in the hosted zone instead of deleting the hosted zone.

\n\t\t \n\t\t\t

If you delete a hosted zone, you can't undelete it. You must create a new hosted\n\t\t\t\tzone and update the name servers for your domain registration, which can require up\n\t\t\t\tto 48 hours to take effect. (If you delegated responsibility for a subdomain to a\n\t\t\t\thosted zone and you delete the child hosted zone, you must update the name servers\n\t\t\t\tin the parent hosted zone.) In addition, if you delete a hosted zone, someone could\n\t\t\t\thijack the domain and route traffic to their own resources using your domain\n\t\t\t\tname.

\n\t\t \n\t\t

If you want to avoid the monthly charge for the hosted zone, you can transfer DNS\n\t\t\tservice for the domain to a free DNS service. When you transfer DNS service, you have to\n\t\t\tupdate the name servers for the domain registration. If the domain is registered with\n\t\t\t\tRoute 53, see UpdateDomainNameservers for information about how to replace Route 53 name servers with name servers for the new DNS service. If the domain is\n\t\t\tregistered with another registrar, use the method provided by the registrar to update\n\t\t\tname servers for the domain registration. For more information, perform an internet\n\t\t\tsearch on \"free DNS service.\"

\n\t\t

You can delete a hosted zone only if it contains only the default SOA record and NS\n\t\t\tresource record sets. If the hosted zone contains other resource record sets, you must\n\t\t\tdelete them before you can delete the hosted zone. If you try to delete a hosted zone\n\t\t\tthat contains other resource record sets, the request fails, and Route 53\n\t\t\treturns a HostedZoneNotEmpty error. For information about deleting records\n\t\t\tfrom your hosted zone, see ChangeResourceRecordSets.

\n\t\t

To verify that the hosted zone has been deleted, do one of the following:

\n\t\t ", - "smithy.api#http": { - "method": "DELETE", - "uri": "/2013-04-01/hostedzone/{Id}", - "code": 200 - } - } - }, - "com.amazonaws.route53#DeleteHostedZoneRequest": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.route53#ResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the hosted zone you want to delete.

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

A request to delete a hosted zone.

" - } - }, - "com.amazonaws.route53#DeleteHostedZoneResponse": { - "type": "structure", - "members": { - "ChangeInfo": { - "target": "com.amazonaws.route53#ChangeInfo", - "traits": { - "smithy.api#documentation": "

A complex type that contains the ID, the status, and the date and time of a request to\n\t\t\tdelete a hosted zone.

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

A complex type that contains the response to a DeleteHostedZone\n\t\t\trequest.

" - } - }, - "com.amazonaws.route53#DeleteKeySigningKey": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#DeleteKeySigningKeyRequest" - }, - "output": { - "target": "com.amazonaws.route53#DeleteKeySigningKeyResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#ConcurrentModification" - }, - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#InvalidKeySigningKeyStatus" - }, - { - "target": "com.amazonaws.route53#InvalidKMSArn" - }, - { - "target": "com.amazonaws.route53#InvalidSigningStatus" - }, - { - "target": "com.amazonaws.route53#NoSuchKeySigningKey" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes a key-signing key (KSK). Before you can delete a KSK, you must deactivate it.\n\t\t\tThe KSK must be deactivated before you can delete it regardless of whether the hosted\n\t\t\tzone is enabled for DNSSEC signing.

\n\t\t

You can use DeactivateKeySigningKey to deactivate the key before you delete it.

\n\t\t

Use GetDNSSEC to verify that the KSK is in an INACTIVE\n\t\t\tstatus.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/2013-04-01/keysigningkey/{HostedZoneId}/{Name}", - "code": 200 - } - } - }, - "com.amazonaws.route53#DeleteKeySigningKeyRequest": { - "type": "structure", - "members": { - "HostedZoneId": { - "target": "com.amazonaws.route53#ResourceId", - "traits": { - "smithy.api#documentation": "

A unique string used to identify a hosted zone.

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

A string used to identify a key-signing key (KSK).

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.route53#DeleteKeySigningKeyResponse": { - "type": "structure", - "members": { - "ChangeInfo": { - "target": "com.amazonaws.route53#ChangeInfo", - "traits": { - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.route53#DeleteQueryLoggingConfig": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#DeleteQueryLoggingConfigRequest" - }, - "output": { - "target": "com.amazonaws.route53#DeleteQueryLoggingConfigResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#ConcurrentModification" - }, - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#NoSuchQueryLoggingConfig" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes a configuration for DNS query logging. If you delete a configuration, Amazon\n\t\t\tRoute 53 stops sending query logs to CloudWatch Logs. Route 53 doesn't delete any logs\n\t\t\tthat are already in CloudWatch Logs.

\n\t\t

For more information about DNS query logs, see CreateQueryLoggingConfig.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/2013-04-01/queryloggingconfig/{Id}", - "code": 200 - } - } - }, - "com.amazonaws.route53#DeleteQueryLoggingConfigRequest": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.route53#QueryLoggingConfigId", - "traits": { - "smithy.api#documentation": "

The ID of the configuration that you want to delete.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.route53#DeleteQueryLoggingConfigResponse": { - "type": "structure", - "members": {} - }, - "com.amazonaws.route53#DeleteReusableDelegationSet": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#DeleteReusableDelegationSetRequest" - }, - "output": { - "target": "com.amazonaws.route53#DeleteReusableDelegationSetResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#DelegationSetInUse" - }, - { - "target": "com.amazonaws.route53#DelegationSetNotReusable" - }, - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#NoSuchDelegationSet" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes a reusable delegation set.

\n\t\t \n\t\t\t

You can delete a reusable delegation set only if it isn't associated with any\n\t\t\t\thosted zones.

\n\t\t \n\t\t

To verify that the reusable delegation set is not associated with any hosted zones,\n\t\t\tsubmit a GetReusableDelegationSet request and specify the ID of the reusable\n\t\t\tdelegation set that you want to delete.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/2013-04-01/delegationset/{Id}", - "code": 200 - } - } - }, - "com.amazonaws.route53#DeleteReusableDelegationSetRequest": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.route53#ResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the reusable delegation set that you want to delete.

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

A request to delete a reusable delegation set.

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

An empty element.

" - } - }, - "com.amazonaws.route53#DeleteTrafficPolicy": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#DeleteTrafficPolicyRequest" - }, - "output": { - "target": "com.amazonaws.route53#DeleteTrafficPolicyResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#ConcurrentModification" - }, - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#NoSuchTrafficPolicy" - }, - { - "target": "com.amazonaws.route53#TrafficPolicyInUse" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes a traffic policy.

\n\t\t

When you delete a traffic policy, Route 53 sets a flag on the policy to indicate that\n\t\t\tit has been deleted. However, Route 53 never fully deletes the traffic policy. Note the\n\t\t\tfollowing:

\n\t\t ", - "smithy.api#http": { - "method": "DELETE", - "uri": "/2013-04-01/trafficpolicy/{Id}/{Version}", - "code": 200 - } - } - }, - "com.amazonaws.route53#DeleteTrafficPolicyInstance": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#DeleteTrafficPolicyInstanceRequest" - }, - "output": { - "target": "com.amazonaws.route53#DeleteTrafficPolicyInstanceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#NoSuchTrafficPolicyInstance" - }, - { - "target": "com.amazonaws.route53#PriorRequestNotComplete" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes a traffic policy instance and all of the resource record sets that Amazon\n\t\t\tRoute 53 created when you created the instance.

\n\t\t \n\t\t\t

In the Route 53 console, traffic policy instances are known as policy\n\t\t\t\trecords.

\n\t\t ", - "smithy.api#http": { - "method": "DELETE", - "uri": "/2013-04-01/trafficpolicyinstance/{Id}", - "code": 200 - } - } - }, - "com.amazonaws.route53#DeleteTrafficPolicyInstanceRequest": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.route53#TrafficPolicyInstanceId", - "traits": { - "smithy.api#documentation": "

The ID of the traffic policy instance that you want to delete.

\n\t\t \n\t\t\t

When you delete a traffic policy instance, Amazon Route 53 also deletes all of the\n\t\t\t\tresource record sets that were created when you created the traffic policy\n\t\t\t\tinstance.

\n\t\t ", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A request to delete a specified traffic policy instance.

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

An empty element.

" - } - }, - "com.amazonaws.route53#DeleteTrafficPolicyRequest": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.route53#TrafficPolicyId", - "traits": { - "smithy.api#documentation": "

The ID of the traffic policy that you want to delete.

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

The version number of the traffic policy that you want to delete.

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

A request to delete a specified traffic policy version.

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

An empty element.

" - } - }, - "com.amazonaws.route53#DeleteVPCAssociationAuthorization": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#DeleteVPCAssociationAuthorizationRequest" - }, - "output": { - "target": "com.amazonaws.route53#DeleteVPCAssociationAuthorizationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#ConcurrentModification" - }, - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#InvalidVPCId" - }, - { - "target": "com.amazonaws.route53#NoSuchHostedZone" - }, - { - "target": "com.amazonaws.route53#VPCAssociationAuthorizationNotFound" - } - ], - "traits": { - "smithy.api#documentation": "

Removes authorization to submit an AssociateVPCWithHostedZone request to\n\t\t\tassociate a specified VPC with a hosted zone that was created by a different account.\n\t\t\tYou must use the account that created the hosted zone to submit a\n\t\t\t\tDeleteVPCAssociationAuthorization request.

\n\t\t \n\t\t\t

Sending this request only prevents the Amazon Web Services account that created the\n\t\t\t\tVPC from associating the VPC with the Amazon Route 53 hosted zone in the future. If\n\t\t\t\tthe VPC is already associated with the hosted zone,\n\t\t\t\t\tDeleteVPCAssociationAuthorization won't disassociate the VPC from\n\t\t\t\tthe hosted zone. If you want to delete an existing association, use\n\t\t\t\t\tDisassociateVPCFromHostedZone.

\n\t\t ", - "smithy.api#http": { - "method": "POST", - "uri": "/2013-04-01/hostedzone/{HostedZoneId}/deauthorizevpcassociation", - "code": 200 - } - } - }, - "com.amazonaws.route53#DeleteVPCAssociationAuthorizationRequest": { - "type": "structure", - "members": { - "HostedZoneId": { - "target": "com.amazonaws.route53#ResourceId", - "traits": { - "smithy.api#documentation": "

When removing authorization to associate a VPC that was created by one Amazon Web Services account with a hosted zone that was created with a different Amazon Web Services account, the ID of the hosted zone.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "VPC": { - "target": "com.amazonaws.route53#VPC", - "traits": { - "smithy.api#documentation": "

When removing authorization to associate a VPC that was created by one Amazon Web Services account with a hosted zone that was created with a different Amazon Web Services account, a complex type that includes the ID and region of the\n\t\t\tVPC.

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

A complex type that contains information about the request to remove authorization to\n\t\t\tassociate a VPC that was created by one Amazon Web Services account with a hosted zone\n\t\t\tthat was created with a different Amazon Web Services account.

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

Empty response for the request.

" - } - }, - "com.amazonaws.route53#Dimension": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.route53#DimensionField", - "traits": { - "smithy.api#documentation": "

For the metric that the CloudWatch alarm is associated with, the name of one\n\t\t\tdimension.

", - "smithy.api#required": {} - } - }, - "Value": { - "target": "com.amazonaws.route53#DimensionField", - "traits": { - "smithy.api#documentation": "

For the metric that the CloudWatch alarm is associated with, the value of one\n\t\t\tdimension.

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

For the metric that the CloudWatch alarm is associated with, a complex type that\n\t\t\tcontains information about one dimension.

" - } - }, - "com.amazonaws.route53#DimensionField": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 255 - } - } - }, - "com.amazonaws.route53#DimensionList": { - "type": "list", - "member": { - "target": "com.amazonaws.route53#Dimension", - "traits": { - "smithy.api#xmlName": "Dimension" - } - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 10 - } - } - }, - "com.amazonaws.route53#DisableHostedZoneDNSSEC": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#DisableHostedZoneDNSSECRequest" - }, - "output": { - "target": "com.amazonaws.route53#DisableHostedZoneDNSSECResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#ConcurrentModification" - }, - { - "target": "com.amazonaws.route53#DNSSECNotFound" - }, - { - "target": "com.amazonaws.route53#InvalidArgument" - }, - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#InvalidKeySigningKeyStatus" - }, - { - "target": "com.amazonaws.route53#InvalidKMSArn" - }, - { - "target": "com.amazonaws.route53#KeySigningKeyInParentDSRecord" - }, - { - "target": "com.amazonaws.route53#NoSuchHostedZone" - } - ], - "traits": { - "smithy.api#documentation": "

Disables DNSSEC signing in a specific hosted zone. This action does not deactivate any\n\t\t\tkey-signing keys (KSKs) that are active in the hosted zone.

", - "smithy.api#http": { - "method": "POST", - "uri": "/2013-04-01/hostedzone/{HostedZoneId}/disable-dnssec", - "code": 200 - } - } - }, - "com.amazonaws.route53#DisableHostedZoneDNSSECRequest": { - "type": "structure", - "members": { - "HostedZoneId": { - "target": "com.amazonaws.route53#ResourceId", - "traits": { - "smithy.api#documentation": "

A unique string used to identify a hosted zone.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.route53#DisableHostedZoneDNSSECResponse": { - "type": "structure", - "members": { - "ChangeInfo": { - "target": "com.amazonaws.route53#ChangeInfo", - "traits": { - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.route53#Disabled": { - "type": "boolean" - }, - "com.amazonaws.route53#DisassociateVPCComment": { - "type": "string" - }, - "com.amazonaws.route53#DisassociateVPCFromHostedZone": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#DisassociateVPCFromHostedZoneRequest" - }, - "output": { - "target": "com.amazonaws.route53#DisassociateVPCFromHostedZoneResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#InvalidVPCId" - }, - { - "target": "com.amazonaws.route53#LastVPCAssociation" - }, - { - "target": "com.amazonaws.route53#NoSuchHostedZone" - }, - { - "target": "com.amazonaws.route53#VPCAssociationNotFound" - } - ], - "traits": { - "smithy.api#documentation": "

Disassociates an Amazon Virtual Private Cloud (Amazon VPC) from an Amazon Route 53\n\t\t\tprivate hosted zone. Note the following:

\n\t\t \n\t\t \n\t\t\t

When revoking access, the hosted zone and the Amazon VPC must belong to\n\t\t\t\tthe same partition. A partition is a group of Amazon Web Services Regions. Each\n\t\t\t\t\tAmazon Web Services account is scoped to one partition.

\n\t\t\t

The following are the supported partitions:

\n\t\t\t \n\t\t\t

For more information, see Access Management\n\t\t\t\tin the Amazon Web Services General Reference.

\n\t\t ", - "smithy.api#http": { - "method": "POST", - "uri": "/2013-04-01/hostedzone/{HostedZoneId}/disassociatevpc", - "code": 200 - } - } - }, - "com.amazonaws.route53#DisassociateVPCFromHostedZoneRequest": { - "type": "structure", - "members": { - "HostedZoneId": { - "target": "com.amazonaws.route53#ResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the private hosted zone that you want to disassociate a VPC from.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "VPC": { - "target": "com.amazonaws.route53#VPC", - "traits": { - "smithy.api#documentation": "

A complex type that contains information about the VPC that you're disassociating from\n\t\t\tthe specified hosted zone.

", - "smithy.api#required": {} - } - }, - "Comment": { - "target": "com.amazonaws.route53#DisassociateVPCComment", - "traits": { - "smithy.api#documentation": "

\n Optional: A comment about the disassociation request.

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

A complex type that contains information about the VPC that you want to disassociate\n\t\t\tfrom a specified private hosted zone.

" - } - }, - "com.amazonaws.route53#DisassociateVPCFromHostedZoneResponse": { - "type": "structure", - "members": { - "ChangeInfo": { - "target": "com.amazonaws.route53#ChangeInfo", - "traits": { - "smithy.api#documentation": "

A complex type that describes the changes made to the specified private hosted\n\t\t\tzone.

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

A complex type that contains the response information for the disassociate\n\t\t\trequest.

" - } - }, - "com.amazonaws.route53#EnableHostedZoneDNSSEC": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#EnableHostedZoneDNSSECRequest" - }, - "output": { - "target": "com.amazonaws.route53#EnableHostedZoneDNSSECResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#ConcurrentModification" + "com.amazonaws.route53#CidrBlockSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.route53#CidrBlockSummary" + } }, - { - "target": "com.amazonaws.route53#DNSSECNotFound" + "com.amazonaws.route53#CidrBlockSummary": { + "type": "structure", + "members": { + "CidrBlock": { + "target": "com.amazonaws.route53#Cidr", + "traits": { + "smithy.api#documentation": "

Value for the CIDR block.

" + } + }, + "LocationName": { + "target": "com.amazonaws.route53#CidrLocationNameDefaultNotAllowed", + "traits": { + "smithy.api#documentation": "

The location name of the CIDR block.

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

A complex type that lists the CIDR blocks.

" + } }, - { - "target": "com.amazonaws.route53#HostedZonePartiallyDelegated" + "com.amazonaws.route53#CidrCollection": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.route53#ARN", + "traits": { + "smithy.api#documentation": "

The ARN of the collection. Can be used to reference the collection in IAM policy or in\n\t\t\tanother Amazon Web Services account.

" + } + }, + "Id": { + "target": "com.amazonaws.route53#UUID", + "traits": { + "smithy.api#documentation": "

The unique ID of the CIDR collection.

" + } + }, + "Name": { + "target": "com.amazonaws.route53#CollectionName", + "traits": { + "smithy.api#documentation": "

The name of a CIDR collection.

" + } + }, + "Version": { + "target": "com.amazonaws.route53#CollectionVersion", + "traits": { + "smithy.api#documentation": "

A sequential counter that Route 53 sets to 1 when you create a CIDR\n\t\t\tcollection and increments by 1 each time you update settings for the CIDR\n\t\t\tcollection.

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

A complex\n\t\t\ttype that\n\t\t\tidentifies a CIDR collection.

" + } }, - { - "target": "com.amazonaws.route53#InvalidArgument" + "com.amazonaws.route53#CidrCollectionAlreadyExistsException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.route53#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

A CIDR collection with this name and a different caller reference already exists in this account.

", + "smithy.api#error": "client" + } }, - { - "target": "com.amazonaws.route53#InvalidInput" + "com.amazonaws.route53#CidrCollectionChange": { + "type": "structure", + "members": { + "LocationName": { + "target": "com.amazonaws.route53#CidrLocationNameDefaultNotAllowed", + "traits": { + "smithy.api#documentation": "

Name of the location that is associated with the CIDR\n\t\t\tcollection.

", + "smithy.api#required": {} + } + }, + "Action": { + "target": "com.amazonaws.route53#CidrCollectionChangeAction", + "traits": { + "smithy.api#documentation": "

CIDR collection change action.

", + "smithy.api#required": {} + } + }, + "CidrList": { + "target": "com.amazonaws.route53#CidrList", + "traits": { + "smithy.api#documentation": "

List of CIDR blocks.

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

A complex type that contains information about the CIDR collection change.

" + } }, - { - "target": "com.amazonaws.route53#InvalidKeySigningKeyStatus" + "com.amazonaws.route53#CidrCollectionChangeAction": { + "type": "enum", + "members": { + "PUT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PUT" + } + }, + "DELETE_IF_EXISTS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_IF_EXISTS" + } + } + } }, - { - "target": "com.amazonaws.route53#InvalidKMSArn" + "com.amazonaws.route53#CidrCollectionChanges": { + "type": "list", + "member": { + "target": "com.amazonaws.route53#CidrCollectionChange" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1000 + } + } }, - { - "target": "com.amazonaws.route53#KeySigningKeyWithActiveStatusNotFound" + "com.amazonaws.route53#CidrCollectionInUseException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.route53#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

This CIDR collection is in use, and isn't empty.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } }, - { - "target": "com.amazonaws.route53#NoSuchHostedZone" - } - ], - "traits": { - "smithy.api#documentation": "

Enables DNSSEC signing in a specific hosted zone.

", - "smithy.api#http": { - "method": "POST", - "uri": "/2013-04-01/hostedzone/{HostedZoneId}/enable-dnssec", - "code": 200 - } - } - }, - "com.amazonaws.route53#EnableHostedZoneDNSSECRequest": { - "type": "structure", - "members": { - "HostedZoneId": { - "target": "com.amazonaws.route53#ResourceId", - "traits": { - "smithy.api#documentation": "

A unique string used to identify a hosted zone.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.route53#EnableHostedZoneDNSSECResponse": { - "type": "structure", - "members": { - "ChangeInfo": { - "target": "com.amazonaws.route53#ChangeInfo", - "traits": { - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.route53#EnableSNI": { - "type": "boolean" - }, - "com.amazonaws.route53#ErrorMessage": { - "type": "string" - }, - "com.amazonaws.route53#ErrorMessages": { - "type": "list", - "member": { - "target": "com.amazonaws.route53#ErrorMessage", - "traits": { - "smithy.api#xmlName": "Message" - } - } - }, - "com.amazonaws.route53#EvaluationPeriods": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1 - } - } - }, - "com.amazonaws.route53#FailureThreshold": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 10 - } - } - }, - "com.amazonaws.route53#FullyQualifiedDomainName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 255 - } - } - }, - "com.amazonaws.route53#GeoLocation": { - "type": "structure", - "members": { - "ContinentCode": { - "target": "com.amazonaws.route53#GeoLocationContinentCode", - "traits": { - "smithy.api#documentation": "

The two-letter code for the continent.

\n\t\t

Amazon Route 53 supports the following continent codes:

\n\t\t \n\t\t

Constraint: Specifying ContinentCode with either CountryCode\n\t\t\tor SubdivisionCode returns an InvalidInput error.

" - } - }, - "CountryCode": { - "target": "com.amazonaws.route53#GeoLocationCountryCode", - "traits": { - "smithy.api#documentation": "

For geolocation resource record sets, the two-letter code for a country.

\n\t\t

Amazon Route 53 uses the two-letter country codes that are specified in ISO standard 3166-1\n\t\t\t\talpha-2.

" - } - }, - "SubdivisionCode": { - "target": "com.amazonaws.route53#GeoLocationSubdivisionCode", - "traits": { - "smithy.api#documentation": "

For geolocation resource record sets, the two-letter code for a state of the United\n\t\t\tStates. Route 53 doesn't support any other values for SubdivisionCode. For\n\t\t\ta list of state abbreviations, see Appendix B: Two–Letter State and Possession Abbreviations on the United\n\t\t\tStates Postal Service website.

\n\t\t

If you specify subdivisioncode, you must also specify US for\n\t\t\t\tCountryCode.

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

A complex type that contains information about a geographic location.

" - } - }, - "com.amazonaws.route53#GeoLocationContinentCode": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 2, - "max": 2 - } - } - }, - "com.amazonaws.route53#GeoLocationContinentName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 32 - } - } - }, - "com.amazonaws.route53#GeoLocationCountryCode": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2 - } - } - }, - "com.amazonaws.route53#GeoLocationCountryName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - } - } - }, - "com.amazonaws.route53#GeoLocationDetails": { - "type": "structure", - "members": { - "ContinentCode": { - "target": "com.amazonaws.route53#GeoLocationContinentCode", - "traits": { - "smithy.api#documentation": "

The two-letter code for the continent.

" - } - }, - "ContinentName": { - "target": "com.amazonaws.route53#GeoLocationContinentName", - "traits": { - "smithy.api#documentation": "

The full name of the continent.

" - } - }, - "CountryCode": { - "target": "com.amazonaws.route53#GeoLocationCountryCode", - "traits": { - "smithy.api#documentation": "

The two-letter code for the country.

" - } - }, - "CountryName": { - "target": "com.amazonaws.route53#GeoLocationCountryName", - "traits": { - "smithy.api#documentation": "

The name of the country.

" - } - }, - "SubdivisionCode": { - "target": "com.amazonaws.route53#GeoLocationSubdivisionCode", - "traits": { - "smithy.api#documentation": "

The code for the subdivision, such as a particular state within the United States. For\n\t\t\ta list of US state abbreviations, see Appendix B: Two–Letter State and\n\t\t\t\tPossession Abbreviations on the United States Postal Service website. For a\n\t\t\tlist of all supported subdivision codes, use the ListGeoLocations\n\t\t\tAPI.

" - } - }, - "SubdivisionName": { - "target": "com.amazonaws.route53#GeoLocationSubdivisionName", - "traits": { - "smithy.api#documentation": "

The full name of the subdivision. Route 53 currently supports only states in the\n\t\t\tUnited States.

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

A complex type that contains the codes and full continent, country, and subdivision\n\t\t\tnames for the specified geolocation code.

" - } - }, - "com.amazonaws.route53#GeoLocationDetailsList": { - "type": "list", - "member": { - "target": "com.amazonaws.route53#GeoLocationDetails", - "traits": { - "smithy.api#xmlName": "GeoLocationDetails" - } - } - }, - "com.amazonaws.route53#GeoLocationSubdivisionCode": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 3 - } - } - }, - "com.amazonaws.route53#GeoLocationSubdivisionName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - } - } - }, - "com.amazonaws.route53#GetAccountLimit": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#GetAccountLimitRequest" - }, - "output": { - "target": "com.amazonaws.route53#GetAccountLimitResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#InvalidInput" - } - ], - "traits": { - "smithy.api#documentation": "

Gets the specified limit for the current account, for example, the maximum number of\n\t\t\thealth checks that you can create using the account.

\n\t\t

For the default limit, see Limits in the\n\t\t\t\tAmazon Route 53 Developer Guide. To request a higher limit,\n\t\t\t\topen a case.

\n\t\t \n\t\t\t

You can also view account limits in Amazon Web Services Trusted Advisor. Sign in to\n\t\t\t\tthe Amazon Web Services Management Console and open the Trusted Advisor console at https://console.aws.amazon.com/trustedadvisor/. Then choose Service limits in the navigation pane.

\n\t\t ", - "smithy.api#http": { - "method": "GET", - "uri": "/2013-04-01/accountlimit/{Type}", - "code": 200 - } - } - }, - "com.amazonaws.route53#GetAccountLimitRequest": { - "type": "structure", - "members": { - "Type": { - "target": "com.amazonaws.route53#AccountLimitType", - "traits": { - "smithy.api#documentation": "

The limit that you want to get. Valid values include the following:

\n\t\t ", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A complex type that contains information about the request to create a hosted\n\t\t\tzone.

" - } - }, - "com.amazonaws.route53#GetAccountLimitResponse": { - "type": "structure", - "members": { - "Limit": { - "target": "com.amazonaws.route53#AccountLimit", - "traits": { - "smithy.api#documentation": "

The current setting for the specified limit. For example, if you specified\n\t\t\t\tMAX_HEALTH_CHECKS_BY_OWNER for the value of Type in the\n\t\t\trequest, the value of Limit is the maximum number of health checks that you\n\t\t\tcan create using the current account.

", - "smithy.api#required": {} - } - }, - "Count": { - "target": "com.amazonaws.route53#UsageCount", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The current number of entities that you have created of the specified type. For\n\t\t\texample, if you specified MAX_HEALTH_CHECKS_BY_OWNER for the value of\n\t\t\t\tType in the request, the value of Count is the current\n\t\t\tnumber of health checks that you have created using the current account.

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

A complex type that contains the requested limit.

" - } - }, - "com.amazonaws.route53#GetChange": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#GetChangeRequest" - }, - "output": { - "target": "com.amazonaws.route53#GetChangeResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#NoSuchChange" - } - ], - "traits": { - "smithy.api#documentation": "

Returns the current status of a change batch request. The status is one of the\n\t\t\tfollowing values:

\n\t\t ", - "smithy.api#http": { - "method": "GET", - "uri": "/2013-04-01/change/{Id}", - "code": 200 - }, - "smithy.waiters#waitable": { - "ResourceRecordSetsChanged": { - "acceptors": [ - { - "state": "success", - "matcher": { - "output": { - "path": "ChangeInfo.Status", - "expected": "INSYNC", - "comparator": "stringEquals" - } - } - } - ], - "minDelay": 30 - } - } - } - }, - "com.amazonaws.route53#GetChangeRequest": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.route53#ChangeId", - "traits": { - "smithy.api#documentation": "

The ID of the change batch request. The value that you specify here is the value that\n\t\t\t\tChangeResourceRecordSets returned in the Id element when\n\t\t\tyou submitted the request.

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

The input for a GetChange request.

" - } - }, - "com.amazonaws.route53#GetChangeResponse": { - "type": "structure", - "members": { - "ChangeInfo": { - "target": "com.amazonaws.route53#ChangeInfo", - "traits": { - "smithy.api#documentation": "

A complex type that contains information about the specified change batch.

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

A complex type that contains the ChangeInfo element.

" - } - }, - "com.amazonaws.route53#GetCheckerIpRanges": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#GetCheckerIpRangesRequest" - }, - "output": { - "target": "com.amazonaws.route53#GetCheckerIpRangesResponse" - }, - "traits": { - "smithy.api#documentation": "

Route 53 does not perform authorization for this API because it retrieves information\n\t\t\tthat is already available to the public.

\n\t\t \n\t\t\t

\n GetCheckerIpRanges still works, but we recommend that you download\n\t\t\t\tip-ranges.json, which includes IP address ranges for all Amazon Web Services\n\t\t\t\tservices. For more information, see IP Address Ranges\n\t\t\t\t\tof Amazon Route 53 Servers in the Amazon Route 53 Developer\n\t\t\t\t\tGuide.

\n\t\t ", - "smithy.api#http": { - "method": "GET", - "uri": "/2013-04-01/checkeripranges", - "code": 200 - } - } - }, - "com.amazonaws.route53#GetCheckerIpRangesRequest": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#documentation": "

Empty request.

" - } - }, - "com.amazonaws.route53#GetCheckerIpRangesResponse": { - "type": "structure", - "members": { - "CheckerIpRanges": { - "target": "com.amazonaws.route53#CheckerIpRanges", - "traits": { - "smithy.api#documentation": "

A complex type that contains sorted list of IP ranges in CIDR format for Amazon Route\n\t\t\t53 health checkers.

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

A complex type that contains the CheckerIpRanges element.

" - } - }, - "com.amazonaws.route53#GetDNSSEC": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#GetDNSSECRequest" - }, - "output": { - "target": "com.amazonaws.route53#GetDNSSECResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#InvalidArgument" - }, - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#NoSuchHostedZone" - } - ], - "traits": { - "smithy.api#documentation": "

Returns information about DNSSEC for a specific hosted zone, including the key-signing\n\t\t\tkeys (KSKs) in the hosted zone.

", - "smithy.api#http": { - "method": "GET", - "uri": "/2013-04-01/hostedzone/{HostedZoneId}/dnssec", - "code": 200 - } - } - }, - "com.amazonaws.route53#GetDNSSECRequest": { - "type": "structure", - "members": { - "HostedZoneId": { - "target": "com.amazonaws.route53#ResourceId", - "traits": { - "smithy.api#documentation": "

A unique string used to identify a hosted zone.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.route53#GetDNSSECResponse": { - "type": "structure", - "members": { - "Status": { - "target": "com.amazonaws.route53#DNSSECStatus", - "traits": { - "smithy.api#documentation": "

A string repesenting the status of DNSSEC.

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

The key-signing keys (KSKs) in your account.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.route53#GetGeoLocation": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#GetGeoLocationRequest" - }, - "output": { - "target": "com.amazonaws.route53#GetGeoLocationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#NoSuchGeoLocation" - } - ], - "traits": { - "smithy.api#documentation": "

Gets information about whether a specified geographic location is supported for Amazon\n\t\t\tRoute 53 geolocation resource record sets.

\n\t\t

Route 53 does not perform authorization for this API because it retrieves information\n\t\t\tthat is already available to the public.

\n\t\t

Use the following syntax to determine whether a continent is supported for\n\t\t\tgeolocation:

\n\t\t

\n GET /2013-04-01/geolocation?continentcode=two-letter abbreviation for\n\t\t\t\t\ta continent\n \n

\n\t\t

Use the following syntax to determine whether a country is supported for\n\t\t\tgeolocation:

\n\t\t

\n GET /2013-04-01/geolocation?countrycode=two-character country\n\t\t\t\t\tcode\n \n

\n\t\t

Use the following syntax to determine whether a subdivision of a country is supported\n\t\t\tfor geolocation:

\n\t\t

\n GET /2013-04-01/geolocation?countrycode=two-character country\n\t\t\t\t\tcode&subdivisioncode=subdivision\n\t\t\tcode\n \n

", - "smithy.api#http": { - "method": "GET", - "uri": "/2013-04-01/geolocation", - "code": 200 - } - } - }, - "com.amazonaws.route53#GetGeoLocationRequest": { - "type": "structure", - "members": { - "ContinentCode": { - "target": "com.amazonaws.route53#GeoLocationContinentCode", - "traits": { - "smithy.api#documentation": "

For geolocation resource record sets, a two-letter abbreviation that identifies a\n\t\t\tcontinent. Amazon Route 53 supports the following continent codes:

\n\t\t ", - "smithy.api#httpQuery": "continentcode" - } - }, - "CountryCode": { - "target": "com.amazonaws.route53#GeoLocationCountryCode", - "traits": { - "smithy.api#documentation": "

Amazon Route 53 uses the two-letter country codes that are specified in ISO standard 3166-1\n\t\t\t\talpha-2.

", - "smithy.api#httpQuery": "countrycode" - } - }, - "SubdivisionCode": { - "target": "com.amazonaws.route53#GeoLocationSubdivisionCode", - "traits": { - "smithy.api#documentation": "

The code for the subdivision, such as a particular state within the United States. For\n\t\t\ta list of US state abbreviations, see Appendix B: Two–Letter State and\n\t\t\t\tPossession Abbreviations on the United States Postal Service website. For a\n\t\t\tlist of all supported subdivision codes, use the ListGeoLocations\n\t\t\tAPI.

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

A request for information about whether a specified geographic location is supported\n\t\t\tfor Amazon Route 53 geolocation resource record sets.

" - } - }, - "com.amazonaws.route53#GetGeoLocationResponse": { - "type": "structure", - "members": { - "GeoLocationDetails": { - "target": "com.amazonaws.route53#GeoLocationDetails", - "traits": { - "smithy.api#documentation": "

A complex type that contains the codes and full continent, country, and subdivision\n\t\t\tnames for the specified geolocation code.

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

A complex type that contains the response information for the specified geolocation\n\t\t\tcode.

" - } - }, - "com.amazonaws.route53#GetHealthCheck": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#GetHealthCheckRequest" - }, - "output": { - "target": "com.amazonaws.route53#GetHealthCheckResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#IncompatibleVersion" - }, - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#NoSuchHealthCheck" - } - ], - "traits": { - "smithy.api#documentation": "

Gets information about a specified health check.

", - "smithy.api#http": { - "method": "GET", - "uri": "/2013-04-01/healthcheck/{HealthCheckId}", - "code": 200 - } - } - }, - "com.amazonaws.route53#GetHealthCheckCount": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#GetHealthCheckCountRequest" - }, - "output": { - "target": "com.amazonaws.route53#GetHealthCheckCountResponse" - }, - "traits": { - "smithy.api#documentation": "

Retrieves the number of health checks that are associated with the current Amazon Web Services account.

", - "smithy.api#http": { - "method": "GET", - "uri": "/2013-04-01/healthcheckcount", - "code": 200 - } - } - }, - "com.amazonaws.route53#GetHealthCheckCountRequest": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#documentation": "

A request for the number of health checks that are associated with the current Amazon Web Services account.

" - } - }, - "com.amazonaws.route53#GetHealthCheckCountResponse": { - "type": "structure", - "members": { - "HealthCheckCount": { - "target": "com.amazonaws.route53#HealthCheckCount", - "traits": { - "smithy.api#documentation": "

The number of health checks associated with the current Amazon Web Services account.

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

A complex type that contains the response to a GetHealthCheckCount\n\t\t\trequest.

" - } - }, - "com.amazonaws.route53#GetHealthCheckLastFailureReason": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#GetHealthCheckLastFailureReasonRequest" - }, - "output": { - "target": "com.amazonaws.route53#GetHealthCheckLastFailureReasonResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#NoSuchHealthCheck" - } - ], - "traits": { - "smithy.api#documentation": "

Gets the reason that a specified health check failed most recently.

", - "smithy.api#http": { - "method": "GET", - "uri": "/2013-04-01/healthcheck/{HealthCheckId}/lastfailurereason", - "code": 200 - } - } - }, - "com.amazonaws.route53#GetHealthCheckLastFailureReasonRequest": { - "type": "structure", - "members": { - "HealthCheckId": { - "target": "com.amazonaws.route53#HealthCheckId", - "traits": { - "smithy.api#documentation": "

The ID for the health check for which you want the last failure reason. When you\n\t\t\tcreated the health check, CreateHealthCheck returned the ID in the\n\t\t\tresponse, in the HealthCheckId element.

\n\t\t \n\t\t\t

If you want to get the last failure reason for a calculated health check, you must\n\t\t\t\tuse the Amazon Route 53 console or the CloudWatch console. You can't use\n\t\t\t\t\tGetHealthCheckLastFailureReason for a calculated health\n\t\t\t\tcheck.

\n\t\t ", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A request for the reason that a health check failed most recently.

" - } - }, - "com.amazonaws.route53#GetHealthCheckLastFailureReasonResponse": { - "type": "structure", - "members": { - "HealthCheckObservations": { - "target": "com.amazonaws.route53#HealthCheckObservations", - "traits": { - "smithy.api#documentation": "

A list that contains one Observation element for each Amazon Route 53\n\t\t\thealth checker that is reporting a last failure reason.

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

A complex type that contains the response to a\n\t\t\t\tGetHealthCheckLastFailureReason request.

" - } - }, - "com.amazonaws.route53#GetHealthCheckRequest": { - "type": "structure", - "members": { - "HealthCheckId": { - "target": "com.amazonaws.route53#HealthCheckId", - "traits": { - "smithy.api#documentation": "

The identifier that Amazon Route 53 assigned to the health check when you created it.\n\t\t\tWhen you add or update a resource record set, you use this value to specify which health\n\t\t\tcheck to use. The value can be up to 64 characters long.

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

A request to get information about a specified health check.

" - } - }, - "com.amazonaws.route53#GetHealthCheckResponse": { - "type": "structure", - "members": { - "HealthCheck": { - "target": "com.amazonaws.route53#HealthCheck", - "traits": { - "smithy.api#documentation": "

A complex type that contains information about one health check that is associated\n\t\t\twith the current Amazon Web Services account.

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

A complex type that contains the response to a GetHealthCheck\n\t\t\trequest.

" - } - }, - "com.amazonaws.route53#GetHealthCheckStatus": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#GetHealthCheckStatusRequest" - }, - "output": { - "target": "com.amazonaws.route53#GetHealthCheckStatusResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#NoSuchHealthCheck" - } - ], - "traits": { - "smithy.api#documentation": "

Gets status of a specified health check.

\n\t\t \n\t\t\t

This API is intended for use during development to diagnose behavior. It doesn’t\n\t\t\t\tsupport production use-cases with high query rates that require immediate and\n\t\t\t\tactionable responses.

\n\t\t ", - "smithy.api#http": { - "method": "GET", - "uri": "/2013-04-01/healthcheck/{HealthCheckId}/status", - "code": 200 - } - } - }, - "com.amazonaws.route53#GetHealthCheckStatusRequest": { - "type": "structure", - "members": { - "HealthCheckId": { - "target": "com.amazonaws.route53#HealthCheckId", - "traits": { - "smithy.api#documentation": "

The ID for the health check that you want the current status for. When you created the\n\t\t\thealth check, CreateHealthCheck returned the ID in the response, in the\n\t\t\t\tHealthCheckId element.

\n\t\t \n\t\t\t

If you want to check the status of a calculated health check, you must use the\n\t\t\t\tAmazon Route 53 console or the CloudWatch console. You can't use\n\t\t\t\t\tGetHealthCheckStatus to get the status of a calculated health\n\t\t\t\tcheck.

\n\t\t ", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A request to get the status for a health check.

" - } - }, - "com.amazonaws.route53#GetHealthCheckStatusResponse": { - "type": "structure", - "members": { - "HealthCheckObservations": { - "target": "com.amazonaws.route53#HealthCheckObservations", - "traits": { - "smithy.api#documentation": "

A list that contains one HealthCheckObservation element for each Amazon\n\t\t\tRoute 53 health checker that is reporting a status about the health check\n\t\t\tendpoint.

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

A complex type that contains the response to a GetHealthCheck\n\t\t\trequest.

" - } - }, - "com.amazonaws.route53#GetHostedZone": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#GetHostedZoneRequest" - }, - "output": { - "target": "com.amazonaws.route53#GetHostedZoneResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#NoSuchHostedZone" - } - ], - "traits": { - "smithy.api#documentation": "

Gets information about a specified hosted zone including the four name servers\n\t\t\tassigned to the hosted zone.

", - "smithy.api#http": { - "method": "GET", - "uri": "/2013-04-01/hostedzone/{Id}", - "code": 200 - } - } - }, - "com.amazonaws.route53#GetHostedZoneCount": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#GetHostedZoneCountRequest" - }, - "output": { - "target": "com.amazonaws.route53#GetHostedZoneCountResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#InvalidInput" - } - ], - "traits": { - "smithy.api#documentation": "

Retrieves the number of hosted zones that are associated with the current Amazon Web Services account.

", - "smithy.api#http": { - "method": "GET", - "uri": "/2013-04-01/hostedzonecount", - "code": 200 - } - } - }, - "com.amazonaws.route53#GetHostedZoneCountRequest": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#documentation": "

A request to retrieve a count of all the hosted zones that are associated with the\n\t\t\tcurrent Amazon Web Services account.

" - } - }, - "com.amazonaws.route53#GetHostedZoneCountResponse": { - "type": "structure", - "members": { - "HostedZoneCount": { - "target": "com.amazonaws.route53#HostedZoneCount", - "traits": { - "smithy.api#documentation": "

The total number of public and private hosted zones that are associated with the\n\t\t\tcurrent Amazon Web Services account.

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

A complex type that contains the response to a GetHostedZoneCount\n\t\t\trequest.

" - } - }, - "com.amazonaws.route53#GetHostedZoneLimit": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#GetHostedZoneLimitRequest" - }, - "output": { - "target": "com.amazonaws.route53#GetHostedZoneLimitResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#HostedZoneNotPrivate" - }, - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#NoSuchHostedZone" - } - ], - "traits": { - "smithy.api#documentation": "

Gets the specified limit for a specified hosted zone, for example, the maximum number\n\t\t\tof records that you can create in the hosted zone.

\n\t\t

For the default limit, see Limits in the\n\t\t\t\tAmazon Route 53 Developer Guide. To request a higher limit,\n\t\t\t\topen a case.

", - "smithy.api#http": { - "method": "GET", - "uri": "/2013-04-01/hostedzonelimit/{HostedZoneId}/{Type}", - "code": 200 - } - } - }, - "com.amazonaws.route53#GetHostedZoneLimitRequest": { - "type": "structure", - "members": { - "Type": { - "target": "com.amazonaws.route53#HostedZoneLimitType", - "traits": { - "smithy.api#documentation": "

The limit that you want to get. Valid values include the following:

\n\t\t ", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "HostedZoneId": { - "target": "com.amazonaws.route53#ResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the hosted zone that you want to get a limit for.

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

A complex type that contains information about the request to create a hosted\n\t\t\tzone.

" - } - }, - "com.amazonaws.route53#GetHostedZoneLimitResponse": { - "type": "structure", - "members": { - "Limit": { - "target": "com.amazonaws.route53#HostedZoneLimit", - "traits": { - "smithy.api#documentation": "

The current setting for the specified limit. For example, if you specified\n\t\t\t\tMAX_RRSETS_BY_ZONE for the value of Type in the request,\n\t\t\tthe value of Limit is the maximum number of records that you can create in\n\t\t\tthe specified hosted zone.

", - "smithy.api#required": {} - } - }, - "Count": { - "target": "com.amazonaws.route53#UsageCount", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The current number of entities that you have created of the specified type. For\n\t\t\texample, if you specified MAX_RRSETS_BY_ZONE for the value of\n\t\t\t\tType in the request, the value of Count is the current\n\t\t\tnumber of records that you have created in the specified hosted zone.

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

A complex type that contains the requested limit.

" - } - }, - "com.amazonaws.route53#GetHostedZoneRequest": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.route53#ResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the hosted zone that you want to get information about.

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

A request to get information about a specified hosted zone.

" - } - }, - "com.amazonaws.route53#GetHostedZoneResponse": { - "type": "structure", - "members": { - "HostedZone": { - "target": "com.amazonaws.route53#HostedZone", - "traits": { - "smithy.api#documentation": "

A complex type that contains general information about the specified hosted\n\t\t\tzone.

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

A complex type that lists the Amazon Route 53 name servers for the specified hosted\n\t\t\tzone.

" - } - }, - "VPCs": { - "target": "com.amazonaws.route53#VPCs", - "traits": { - "smithy.api#documentation": "

A complex type that contains information about the VPCs that are associated with the\n\t\t\tspecified hosted zone.

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

A complex type that contain the response to a GetHostedZone\n\t\t\trequest.

" - } - }, - "com.amazonaws.route53#GetQueryLoggingConfig": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#GetQueryLoggingConfigRequest" - }, - "output": { - "target": "com.amazonaws.route53#GetQueryLoggingConfigResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#NoSuchQueryLoggingConfig" - } - ], - "traits": { - "smithy.api#documentation": "

Gets information about a specified configuration for DNS query logging.

\n\t\t

For more information about DNS query logs, see CreateQueryLoggingConfig and Logging DNS\n\t\t\tQueries.

", - "smithy.api#http": { - "method": "GET", - "uri": "/2013-04-01/queryloggingconfig/{Id}", - "code": 200 - } - } - }, - "com.amazonaws.route53#GetQueryLoggingConfigRequest": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.route53#QueryLoggingConfigId", - "traits": { - "smithy.api#documentation": "

The ID of the configuration for DNS query logging that you want to get information\n\t\t\tabout.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.route53#GetQueryLoggingConfigResponse": { - "type": "structure", - "members": { - "QueryLoggingConfig": { - "target": "com.amazonaws.route53#QueryLoggingConfig", - "traits": { - "smithy.api#documentation": "

A complex type that contains information about the query logging configuration that\n\t\t\tyou specified in a GetQueryLoggingConfig request.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.route53#GetReusableDelegationSet": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#GetReusableDelegationSetRequest" - }, - "output": { - "target": "com.amazonaws.route53#GetReusableDelegationSetResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#DelegationSetNotReusable" - }, - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#NoSuchDelegationSet" - } - ], - "traits": { - "smithy.api#documentation": "

Retrieves information about a specified reusable delegation set, including the four\n\t\t\tname servers that are assigned to the delegation set.

", - "smithy.api#http": { - "method": "GET", - "uri": "/2013-04-01/delegationset/{Id}", - "code": 200 - } - } - }, - "com.amazonaws.route53#GetReusableDelegationSetLimit": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#GetReusableDelegationSetLimitRequest" - }, - "output": { - "target": "com.amazonaws.route53#GetReusableDelegationSetLimitResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#NoSuchDelegationSet" - } - ], - "traits": { - "smithy.api#documentation": "

Gets the maximum number of hosted zones that you can associate with the specified\n\t\t\treusable delegation set.

\n\t\t

For the default limit, see Limits in the\n\t\t\t\tAmazon Route 53 Developer Guide. To request a higher limit,\n\t\t\t\topen a case.

", - "smithy.api#http": { - "method": "GET", - "uri": "/2013-04-01/reusabledelegationsetlimit/{DelegationSetId}/{Type}", - "code": 200 - } - } - }, - "com.amazonaws.route53#GetReusableDelegationSetLimitRequest": { - "type": "structure", - "members": { - "Type": { - "target": "com.amazonaws.route53#ReusableDelegationSetLimitType", - "traits": { - "smithy.api#documentation": "

Specify MAX_ZONES_BY_REUSABLE_DELEGATION_SET to get the maximum number of\n\t\t\thosted zones that you can associate with the specified reusable delegation set.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "DelegationSetId": { - "target": "com.amazonaws.route53#ResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the delegation set that you want to get the limit for.

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

A complex type that contains information about the request to create a hosted\n\t\t\tzone.

" - } - }, - "com.amazonaws.route53#GetReusableDelegationSetLimitResponse": { - "type": "structure", - "members": { - "Limit": { - "target": "com.amazonaws.route53#ReusableDelegationSetLimit", - "traits": { - "smithy.api#documentation": "

The current setting for the limit on hosted zones that you can associate with the\n\t\t\tspecified reusable delegation set.

", - "smithy.api#required": {} - } - }, - "Count": { - "target": "com.amazonaws.route53#UsageCount", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The current number of hosted zones that you can associate with the specified reusable\n\t\t\tdelegation set.

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

A complex type that contains the requested limit.

" - } - }, - "com.amazonaws.route53#GetReusableDelegationSetRequest": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.route53#ResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the reusable delegation set that you want to get a list of name servers\n\t\t\tfor.

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

A request to get information about a specified reusable delegation set.

" - } - }, - "com.amazonaws.route53#GetReusableDelegationSetResponse": { - "type": "structure", - "members": { - "DelegationSet": { - "target": "com.amazonaws.route53#DelegationSet", - "traits": { - "smithy.api#documentation": "

A complex type that contains information about the reusable delegation set.

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

A complex type that contains the response to the GetReusableDelegationSet\n\t\t\trequest.

" - } - }, - "com.amazonaws.route53#GetTrafficPolicy": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#GetTrafficPolicyRequest" - }, - "output": { - "target": "com.amazonaws.route53#GetTrafficPolicyResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#NoSuchTrafficPolicy" - } - ], - "traits": { - "smithy.api#documentation": "

Gets information about a specific traffic policy version.

\n\t\t

For information about how of deleting a traffic policy affects the response from\n\t\t\t\tGetTrafficPolicy, see DeleteTrafficPolicy.

", - "smithy.api#http": { - "method": "GET", - "uri": "/2013-04-01/trafficpolicy/{Id}/{Version}", - "code": 200 - } - } - }, - "com.amazonaws.route53#GetTrafficPolicyInstance": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#GetTrafficPolicyInstanceRequest" - }, - "output": { - "target": "com.amazonaws.route53#GetTrafficPolicyInstanceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#NoSuchTrafficPolicyInstance" - } - ], - "traits": { - "smithy.api#documentation": "

Gets information about a specified traffic policy instance.

\n\t\t \n\t\t\t

After you submit a CreateTrafficPolicyInstance or an\n\t\t\t\t\tUpdateTrafficPolicyInstance request, there's a brief delay while\n\t\t\t\tAmazon Route 53 creates the resource record sets that are specified in the traffic\n\t\t\t\tpolicy definition. For more information, see the State response\n\t\t\t\telement.

\n\t\t \n\t\t \n\t\t\t

In the Route 53 console, traffic policy instances are known as policy\n\t\t\t\trecords.

\n\t\t ", - "smithy.api#http": { - "method": "GET", - "uri": "/2013-04-01/trafficpolicyinstance/{Id}", - "code": 200 - } - } - }, - "com.amazonaws.route53#GetTrafficPolicyInstanceCount": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#GetTrafficPolicyInstanceCountRequest" - }, - "output": { - "target": "com.amazonaws.route53#GetTrafficPolicyInstanceCountResponse" - }, - "traits": { - "smithy.api#documentation": "

Gets the number of traffic policy instances that are associated with the current\n\t\t\t\tAmazon Web Services account.

", - "smithy.api#http": { - "method": "GET", - "uri": "/2013-04-01/trafficpolicyinstancecount", - "code": 200 - } - } - }, - "com.amazonaws.route53#GetTrafficPolicyInstanceCountRequest": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#documentation": "

Request to get the number of traffic policy instances that are associated with the\n\t\t\tcurrent Amazon Web Services account.

" - } - }, - "com.amazonaws.route53#GetTrafficPolicyInstanceCountResponse": { - "type": "structure", - "members": { - "TrafficPolicyInstanceCount": { - "target": "com.amazonaws.route53#TrafficPolicyInstanceCount", - "traits": { - "smithy.api#documentation": "

The number of traffic policy instances that are associated with the current Amazon Web Services account.

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

A complex type that contains information about the resource record sets that Amazon\n\t\t\tRoute 53 created based on a specified traffic policy.

" - } - }, - "com.amazonaws.route53#GetTrafficPolicyInstanceRequest": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.route53#TrafficPolicyInstanceId", - "traits": { - "smithy.api#documentation": "

The ID of the traffic policy instance that you want to get information about.

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

Gets information about a specified traffic policy instance.

" - } - }, - "com.amazonaws.route53#GetTrafficPolicyInstanceResponse": { - "type": "structure", - "members": { - "TrafficPolicyInstance": { - "target": "com.amazonaws.route53#TrafficPolicyInstance", - "traits": { - "smithy.api#documentation": "

A complex type that contains settings for the traffic policy instance.

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

A complex type that contains information about the resource record sets that Amazon\n\t\t\tRoute 53 created based on a specified traffic policy.

" - } - }, - "com.amazonaws.route53#GetTrafficPolicyRequest": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.route53#TrafficPolicyId", - "traits": { - "smithy.api#documentation": "

The ID of the traffic policy that you want to get information about.

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

The version number of the traffic policy that you want to get information\n\t\t\tabout.

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

Gets information about a specific traffic policy version.

" - } - }, - "com.amazonaws.route53#GetTrafficPolicyResponse": { - "type": "structure", - "members": { - "TrafficPolicy": { - "target": "com.amazonaws.route53#TrafficPolicy", - "traits": { - "smithy.api#documentation": "

A complex type that contains settings for the specified traffic policy.

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

A complex type that contains the response information for the request.

" - } - }, - "com.amazonaws.route53#HealthCheck": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.route53#HealthCheckId", - "traits": { - "smithy.api#documentation": "

The identifier that Amazon Route 53 assigned to the health check when you created it.\n\t\t\tWhen you add or update a resource record set, you use this value to specify which health\n\t\t\tcheck to use. The value can be up to 64 characters long.

", - "smithy.api#required": {} - } - }, - "CallerReference": { - "target": "com.amazonaws.route53#HealthCheckNonce", - "traits": { - "smithy.api#documentation": "

A unique string that you specified when you created the health check.

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

If the health check was created by another service, the service that created the\n\t\t\thealth check. When a health check is created by another service, you can't edit or\n\t\t\tdelete it using Amazon Route 53.

" - } - }, - "HealthCheckConfig": { - "target": "com.amazonaws.route53#HealthCheckConfig", - "traits": { - "smithy.api#documentation": "

A complex type that contains detailed information about one health check.

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

The version of the health check. You can optionally pass this value in a call to\n\t\t\t\tUpdateHealthCheck to prevent overwriting another change to the health\n\t\t\tcheck.

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

A complex type that contains information about the CloudWatch alarm that Amazon Route\n\t\t\t53 is monitoring for this health check.

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

A complex type that contains information about one health check that is associated\n\t\t\twith the current Amazon Web Services account.

" - } - }, - "com.amazonaws.route53#HealthCheckAlreadyExists": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage", - "traits": { - "smithy.api#documentation": "

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

The health check you're attempting to create already exists. Amazon Route 53 returns\n\t\t\tthis error when you submit a request that has the following values:

\n\t\t ", - "smithy.api#error": "client", - "smithy.api#httpError": 409 - } - }, - "com.amazonaws.route53#HealthCheckConfig": { - "type": "structure", - "members": { - "IPAddress": { - "target": "com.amazonaws.route53#IPAddress", - "traits": { - "smithy.api#documentation": "

The IPv4 or IPv6 IP address of the endpoint that you want Amazon Route 53 to perform\n\t\t\thealth checks on. If you don't specify a value for IPAddress, Route 53\n\t\t\tsends a DNS request to resolve the domain name that you specify in\n\t\t\t\tFullyQualifiedDomainName at the interval that you specify in\n\t\t\t\tRequestInterval. Using an IP address returned by DNS, Route 53 then\n\t\t\tchecks the health of the endpoint.

\n\t\t

Use one of the following formats for the value of IPAddress:

\n\t\t \n\t\t

If the endpoint is an EC2 instance, we recommend that you create an Elastic IP\n\t\t\taddress, associate it with your EC2 instance, and specify the Elastic IP address for\n\t\t\t\tIPAddress. This ensures that the IP address of your instance will never\n\t\t\tchange.

\n\t\t

For more information, see FullyQualifiedDomainName.

\n\t\t

Constraints: Route 53 can't check the health of endpoints for which the IP address is\n\t\t\tin local, private, non-routable, or multicast ranges. For more information about IP\n\t\t\taddresses for which you can't create health checks, see the following documents:

\n\t\t \n\t\t

When the value of Type is CALCULATED or\n\t\t\t\tCLOUDWATCH_METRIC, omit IPAddress.

" - } - }, - "Port": { - "target": "com.amazonaws.route53#Port", - "traits": { - "smithy.api#documentation": "

The port on the endpoint that you want Amazon Route 53 to perform health checks\n\t\t\ton.

\n\t\t \n\t\t\t

Don't specify a value for Port when you specify a value for\n\t\t\t\t\tType of CLOUDWATCH_METRIC or\n\t\t\t\tCALCULATED.

\n\t\t " - } - }, - "Type": { - "target": "com.amazonaws.route53#HealthCheckType", - "traits": { - "smithy.api#documentation": "

The type of health check that you want to create, which indicates how Amazon Route 53\n\t\t\tdetermines whether an endpoint is healthy.

\n\t\t \n\t\t\t

You can't change the value of Type after you create a health\n\t\t\t\tcheck.

\n\t\t \n\t\t

You can create the following types of health checks:

\n\t\t \n\t\t

For more information, see How Route 53 Determines Whether an Endpoint Is Healthy in the\n\t\t\t\tAmazon Route 53 Developer Guide.

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

The path, if any, that you want Amazon Route 53 to request when performing health\n\t\t\tchecks. The path can be any value for which your endpoint will return an HTTP status\n\t\t\tcode of 2xx or 3xx when the endpoint is healthy, for example, the file\n\t\t\t/docs/route53-health-check.html. You can also include query string parameters, for\n\t\t\texample, /welcome.html?language=jp&login=y.

" - } - }, - "FullyQualifiedDomainName": { - "target": "com.amazonaws.route53#FullyQualifiedDomainName", - "traits": { - "smithy.api#documentation": "

Amazon Route 53 behavior depends on whether you specify a value for\n\t\t\t\tIPAddress.

\n\t\t

\n If you specify a value for\n\t\t\t IPAddress:

\n\t\t

Amazon Route 53 sends health check requests to the specified IPv4 or IPv6 address and\n\t\t\tpasses the value of FullyQualifiedDomainName in the Host\n\t\t\theader for all health checks except TCP health checks. This is typically the fully\n\t\t\tqualified DNS name of the endpoint on which you want Route 53 to perform health\n\t\t\tchecks.

\n\t\t

When Route 53 checks the health of an endpoint, here is how it constructs the\n\t\t\t\tHost header:

\n\t\t \n\t\t

If you don't specify a value for FullyQualifiedDomainName, Route 53\n\t\t\tsubstitutes the value of IPAddress in the Host header in each\n\t\t\tof the preceding cases.

\n\t\t

\n If you don't specify a value for\n\t\t\t IPAddress:

\n\t\t

Route 53 sends a DNS request to the domain that you specify for\n\t\t\t\tFullyQualifiedDomainName at the interval that you specify for\n\t\t\t\tRequestInterval. Using an IPv4 address that DNS returns, Route 53 then\n\t\t\tchecks the health of the endpoint.

\n\t\t \n\t\t\t

If you don't specify a value for IPAddress, Route 53 uses only IPv4\n\t\t\t\tto send health checks to the endpoint. If there's no resource record set with a type\n\t\t\t\tof A for the name that you specify for FullyQualifiedDomainName, the\n\t\t\t\thealth check fails with a \"DNS resolution failed\" error.

\n\t\t \n\t\t

If you want to check the health of weighted, latency, or failover resource record sets\n\t\t\tand you choose to specify the endpoint only by FullyQualifiedDomainName, we\n\t\t\trecommend that you create a separate health check for each endpoint. For example, create\n\t\t\ta health check for each HTTP server that is serving content for www.example.com. For the\n\t\t\tvalue of FullyQualifiedDomainName, specify the domain name of the server\n\t\t\t(such as us-east-2-www.example.com), not the name of the resource record sets\n\t\t\t(www.example.com).

\n\t\t \n\t\t\t

In this configuration, if you create a health check for which the value of\n\t\t\t\t\tFullyQualifiedDomainName matches the name of the resource record\n\t\t\t\tsets and you then associate the health check with those resource record sets, health\n\t\t\t\tcheck results will be unpredictable.

\n\t\t \n\t\t

In addition, if the value that you specify for Type is HTTP,\n\t\t\t\tHTTPS, HTTP_STR_MATCH, or HTTPS_STR_MATCH,\n\t\t\tRoute 53 passes the value of FullyQualifiedDomainName in the\n\t\t\t\tHost header, as it does when you specify a value for\n\t\t\t\tIPAddress. If the value of Type is TCP, Route\n\t\t\t53 doesn't pass a Host header.

" - } - }, - "SearchString": { - "target": "com.amazonaws.route53#SearchString", - "traits": { - "smithy.api#documentation": "

If the value of Type is HTTP_STR_MATCH or HTTPS_STR_MATCH,\n\t\t\tthe string that you want Amazon Route 53 to search for in the response body from the\n\t\t\tspecified resource. If the string appears in the response body, Route 53 considers the\n\t\t\tresource healthy.

\n\t\t

Route 53 considers case when searching for SearchString in the response\n\t\t\tbody.

" - } - }, - "RequestInterval": { - "target": "com.amazonaws.route53#RequestInterval", - "traits": { - "smithy.api#documentation": "

The number of seconds between the time that Amazon Route 53 gets a response from your\n\t\t\tendpoint and the time that it sends the next health check request. Each Route 53 health\n\t\t\tchecker makes requests at this interval.

\n\t\t \n\t\t\t

You can't change the value of RequestInterval after you create a\n\t\t\t\thealth check.

\n\t\t \n\t\t

If you don't specify a value for RequestInterval, the default value is\n\t\t\t\t30 seconds.

" - } - }, - "FailureThreshold": { - "target": "com.amazonaws.route53#FailureThreshold", - "traits": { - "smithy.api#documentation": "

The number of consecutive health checks that an endpoint must pass or fail for Amazon\n\t\t\tRoute 53 to change the current status of the endpoint from unhealthy to healthy or vice\n\t\t\tversa. For more information, see How Amazon Route 53 Determines Whether an Endpoint Is Healthy in the\n\t\t\t\tAmazon Route 53 Developer Guide.

\n\t\t

If you don't specify a value for FailureThreshold, the default value is\n\t\t\tthree health checks.

" - } - }, - "MeasureLatency": { - "target": "com.amazonaws.route53#MeasureLatency", - "traits": { - "smithy.api#documentation": "

Specify whether you want Amazon Route 53 to measure the latency between health\n\t\t\tcheckers in multiple Amazon Web Services regions and your endpoint, and to display\n\t\t\tCloudWatch latency graphs on the Health Checks page in\n\t\t\tthe Route 53 console.

\n\t\t \n\t\t\t

You can't change the value of MeasureLatency after you create a\n\t\t\t\thealth check.

\n\t\t " - } - }, - "Inverted": { - "target": "com.amazonaws.route53#Inverted", - "traits": { - "smithy.api#documentation": "

Specify whether you want Amazon Route 53 to invert the status of a health check, for\n\t\t\texample, to consider a health check unhealthy when it otherwise would be considered\n\t\t\thealthy.

" - } - }, - "Disabled": { - "target": "com.amazonaws.route53#Disabled", - "traits": { - "smithy.api#documentation": "

Stops Route 53 from performing health checks. When you disable a health check, here's\n\t\t\twhat happens:

\n\t\t \n\t\t

After you disable a health check, Route 53 considers the status of the health check to\n\t\t\talways be healthy. If you configured DNS failover, Route 53 continues to route traffic\n\t\t\tto the corresponding resources. If you want to stop routing traffic to a resource,\n\t\t\tchange the value of Inverted.

\n\t\t

Charges for a health check still apply when the health check is disabled. For more\n\t\t\tinformation, see Amazon Route 53\n\t\t\t\tPricing.

" - } - }, - "HealthThreshold": { - "target": "com.amazonaws.route53#HealthThreshold", - "traits": { - "smithy.api#documentation": "

The number of child health checks that are associated with a CALCULATED\n\t\t\thealth check that Amazon Route 53 must consider healthy for the CALCULATED\n\t\t\thealth check to be considered healthy. To specify the child health checks that you want\n\t\t\tto associate with a CALCULATED health check, use the ChildHealthChecks element.

\n\t\t

Note the following:

\n\t\t " - } - }, - "ChildHealthChecks": { - "target": "com.amazonaws.route53#ChildHealthCheckList", - "traits": { - "smithy.api#documentation": "

(CALCULATED Health Checks Only) A complex type that contains one\n\t\t\t\tChildHealthCheck element for each health check that you want to\n\t\t\tassociate with a CALCULATED health check.

" - } - }, - "EnableSNI": { - "target": "com.amazonaws.route53#EnableSNI", - "traits": { - "smithy.api#documentation": "

Specify whether you want Amazon Route 53 to send the value of\n\t\t\t\tFullyQualifiedDomainName to the endpoint in the\n\t\t\t\tclient_hello message during TLS negotiation. This allows the endpoint\n\t\t\tto respond to HTTPS health check requests with the applicable SSL/TLS\n\t\t\tcertificate.

\n\t\t

Some endpoints require that HTTPS requests include the host name in the\n\t\t\t\tclient_hello message. If you don't enable SNI, the status of the health\n\t\t\tcheck will be SSL alert handshake_failure. A health check can also have\n\t\t\tthat status for other reasons. If SNI is enabled and you're still getting the error,\n\t\t\tcheck the SSL/TLS configuration on your endpoint and confirm that your certificate is\n\t\t\tvalid.

\n\t\t

The SSL/TLS certificate on your endpoint includes a domain name in the Common\n\t\t\t\tName field and possibly several more in the Subject Alternative\n\t\t\t\tNames field. One of the domain names in the certificate should match the\n\t\t\tvalue that you specify for FullyQualifiedDomainName. If the endpoint\n\t\t\tresponds to the client_hello message with a certificate that does not\n\t\t\tinclude the domain name that you specified in FullyQualifiedDomainName, a\n\t\t\thealth checker will retry the handshake. In the second attempt, the health checker will\n\t\t\tomit FullyQualifiedDomainName from the client_hello\n\t\t\tmessage.

" - } - }, - "Regions": { - "target": "com.amazonaws.route53#HealthCheckRegionList", - "traits": { - "smithy.api#documentation": "

A complex type that contains one Region element for each region from\n\t\t\twhich you want Amazon Route 53 health checkers to check the specified endpoint.

\n\t\t

If you don't specify any regions, Route 53 health checkers automatically performs\n\t\t\tchecks from all of the regions that are listed under Valid\n\t\t\t\tValues.

\n\t\t

If you update a health check to remove a region that has been performing health\n\t\t\tchecks, Route 53 will briefly continue to perform checks from that region to ensure that\n\t\t\tsome health checkers are always checking the endpoint (for example, if you replace three\n\t\t\tregions with four different regions).

" - } - }, - "AlarmIdentifier": { - "target": "com.amazonaws.route53#AlarmIdentifier", - "traits": { - "smithy.api#documentation": "

A complex type that identifies the CloudWatch alarm that you want Amazon Route 53\n\t\t\thealth checkers to use to determine whether the specified health check is\n\t\t\thealthy.

" - } - }, - "InsufficientDataHealthStatus": { - "target": "com.amazonaws.route53#InsufficientDataHealthStatus", - "traits": { - "smithy.api#documentation": "

When CloudWatch has insufficient data about the metric to determine the alarm state,\n\t\t\tthe status that you want Amazon Route 53 to assign to the health check:

\n\t\t " - } - }, - "RoutingControlArn": { - "target": "com.amazonaws.route53#RoutingControlArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the Route 53 Application Recovery Controller\n\t\t\trouting control.

\n\t\t

For more information about Route 53 Application Recovery Controller, see Route 53 Application Recovery Controller Developer Guide..

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

A complex type that contains information about the health check.

" - } - }, - "com.amazonaws.route53#HealthCheckCount": { - "type": "long" - }, - "com.amazonaws.route53#HealthCheckId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 64 - } - } - }, - "com.amazonaws.route53#HealthCheckInUse": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage", - "traits": { - "smithy.api#documentation": "

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

This error code is not in use.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.route53#HealthCheckNonce": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - } - } - }, - "com.amazonaws.route53#HealthCheckObservation": { - "type": "structure", - "members": { - "Region": { - "target": "com.amazonaws.route53#HealthCheckRegion", - "traits": { - "smithy.api#documentation": "

The region of the Amazon Route 53 health checker that provided the status in\n\t\t\t\tStatusReport.

" - } - }, - "IPAddress": { - "target": "com.amazonaws.route53#IPAddress", - "traits": { - "smithy.api#documentation": "

The IP address of the Amazon Route 53 health checker that provided the failure reason\n\t\t\tin StatusReport.

" - } - }, - "StatusReport": { - "target": "com.amazonaws.route53#StatusReport", - "traits": { - "smithy.api#documentation": "

A complex type that contains the last failure reason as reported by one Amazon Route\n\t\t\t53 health checker and the time of the failed health check.

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

A complex type that contains the last failure reason as reported by one Amazon Route\n\t\t\t53 health checker.

" - } - }, - "com.amazonaws.route53#HealthCheckObservations": { - "type": "list", - "member": { - "target": "com.amazonaws.route53#HealthCheckObservation", - "traits": { - "smithy.api#xmlName": "HealthCheckObservation" - } - } - }, - "com.amazonaws.route53#HealthCheckRegion": { - "type": "enum", - "members": { - "us_east_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "us-east-1" - } - }, - "us_west_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "us-west-1" - } - }, - "us_west_2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "us-west-2" - } - }, - "eu_west_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "eu-west-1" - } - }, - "ap_southeast_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ap-southeast-1" - } - }, - "ap_southeast_2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ap-southeast-2" - } - }, - "ap_northeast_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ap-northeast-1" - } - }, - "sa_east_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "sa-east-1" - } - } - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - } - } - }, - "com.amazonaws.route53#HealthCheckRegionList": { - "type": "list", - "member": { - "target": "com.amazonaws.route53#HealthCheckRegion", - "traits": { - "smithy.api#xmlName": "Region" - } - }, - "traits": { - "smithy.api#length": { - "min": 3, - "max": 64 - } - } - }, - "com.amazonaws.route53#HealthCheckType": { - "type": "enum", - "members": { - "HTTP": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HTTP" - } - }, - "HTTPS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HTTPS" - } - }, - "HTTP_STR_MATCH": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HTTP_STR_MATCH" - } - }, - "HTTPS_STR_MATCH": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HTTPS_STR_MATCH" - } - }, - "TCP": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TCP" - } - }, - "CALCULATED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CALCULATED" - } - }, - "CLOUDWATCH_METRIC": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CLOUDWATCH_METRIC" - } - }, - "RECOVERY_CONTROL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RECOVERY_CONTROL" - } - } - } - }, - "com.amazonaws.route53#HealthCheckVersion": { - "type": "long", - "traits": { - "smithy.api#range": { - "min": 1 - } - } - }, - "com.amazonaws.route53#HealthCheckVersionMismatch": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "

The value of HealthCheckVersion in the request doesn't match the value of\n\t\t\t\tHealthCheckVersion in the health check.

", - "smithy.api#error": "client", - "smithy.api#httpError": 409 - } - }, - "com.amazonaws.route53#HealthChecks": { - "type": "list", - "member": { - "target": "com.amazonaws.route53#HealthCheck", - "traits": { - "smithy.api#xmlName": "HealthCheck" - } - } - }, - "com.amazonaws.route53#HealthThreshold": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 0, - "max": 256 - } - } - }, - "com.amazonaws.route53#HostedZone": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.route53#ResourceId", - "traits": { - "smithy.api#documentation": "

The ID that Amazon Route 53 assigned to the hosted zone when you created it.

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

The name of the domain. For public hosted zones, this is the name that you have\n\t\t\tregistered with your DNS registrar.

\n\t\t

For information about how to specify characters other than a-z,\n\t\t\t\t0-9, and - (hyphen) and how to specify internationalized\n\t\t\tdomain names, see CreateHostedZone.

", - "smithy.api#required": {} - } - }, - "CallerReference": { - "target": "com.amazonaws.route53#Nonce", - "traits": { - "smithy.api#documentation": "

The value that you specified for CallerReference when you created the\n\t\t\thosted zone.

", - "smithy.api#required": {} - } - }, - "Config": { - "target": "com.amazonaws.route53#HostedZoneConfig", - "traits": { - "smithy.api#documentation": "

A complex type that includes the Comment and PrivateZone\n\t\t\telements. If you omitted the HostedZoneConfig and Comment\n\t\t\telements from the request, the Config and Comment elements\n\t\t\tdon't appear in the response.

" - } - }, - "ResourceRecordSetCount": { - "target": "com.amazonaws.route53#HostedZoneRRSetCount", - "traits": { - "smithy.api#documentation": "

The number of resource record sets in the hosted zone.

" - } - }, - "LinkedService": { - "target": "com.amazonaws.route53#LinkedService", - "traits": { - "smithy.api#documentation": "

If the hosted zone was created by another service, the service that created the hosted\n\t\t\tzone. When a hosted zone is created by another service, you can't edit or delete it\n\t\t\tusing Route 53.

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

A complex type that contains general information about the hosted zone.

" - } - }, - "com.amazonaws.route53#HostedZoneAlreadyExists": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage", - "traits": { - "smithy.api#documentation": "

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

The hosted zone you're trying to create already exists. Amazon Route 53 returns this\n\t\t\terror when a hosted zone has already been created with the specified\n\t\t\t\tCallerReference.

", - "smithy.api#error": "client", - "smithy.api#httpError": 409 - } - }, - "com.amazonaws.route53#HostedZoneConfig": { - "type": "structure", - "members": { - "Comment": { - "target": "com.amazonaws.route53#ResourceDescription", - "traits": { - "smithy.api#documentation": "

Any comments that you want to include about the hosted zone.

" - } - }, - "PrivateZone": { - "target": "com.amazonaws.route53#IsPrivateZone", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A value that indicates whether this is a private hosted zone.

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

A complex type that contains an optional comment about your hosted zone. If you don't\n\t\t\twant to specify a comment, omit both the HostedZoneConfig and\n\t\t\t\tComment elements.

" - } - }, - "com.amazonaws.route53#HostedZoneCount": { - "type": "long" - }, - "com.amazonaws.route53#HostedZoneLimit": { - "type": "structure", - "members": { - "Type": { - "target": "com.amazonaws.route53#HostedZoneLimitType", - "traits": { - "smithy.api#documentation": "

The limit that you requested. Valid values include the following:

\n\t\t ", - "smithy.api#required": {} - } - }, - "Value": { - "target": "com.amazonaws.route53#LimitValue", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The current value for the limit that is specified by Type.

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

A complex type that contains the type of limit that you specified in the request and\n\t\t\tthe current value for that limit.

" - } - }, - "com.amazonaws.route53#HostedZoneLimitType": { - "type": "enum", - "members": { - "MAX_RRSETS_BY_ZONE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MAX_RRSETS_BY_ZONE" - } - }, - "MAX_VPCS_ASSOCIATED_BY_ZONE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MAX_VPCS_ASSOCIATED_BY_ZONE" - } - } - } - }, - "com.amazonaws.route53#HostedZoneNotEmpty": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage", - "traits": { - "smithy.api#documentation": "

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

The hosted zone contains resource records that are not SOA or NS records.

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

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

The specified HostedZone can't be found.

", - "smithy.api#error": "client" - } - }, - "com.amazonaws.route53#HostedZoneNotPrivate": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage", - "traits": { - "smithy.api#documentation": "

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

The specified hosted zone is a public hosted zone, not a private hosted zone.

", - "smithy.api#error": "client" - } - }, - "com.amazonaws.route53#HostedZoneOwner": { - "type": "structure", - "members": { - "OwningAccount": { - "target": "com.amazonaws.route53#AWSAccountID", - "traits": { - "smithy.api#documentation": "

If the hosted zone was created by an Amazon Web Services account, or was created by an\n\t\t\t\tAmazon Web Services service that creates hosted zones using the current account,\n\t\t\t\tOwningAccount contains the account ID of that account. For example,\n\t\t\twhen you use Cloud Map to create a hosted zone, Cloud Map creates the hosted\n\t\t\tzone using the current Amazon Web Services account.

" - } - }, - "OwningService": { - "target": "com.amazonaws.route53#HostedZoneOwningService", - "traits": { - "smithy.api#documentation": "

If an Amazon Web Services service uses its own account to create a hosted zone and\n\t\t\tassociate the specified VPC with that hosted zone, OwningService contains\n\t\t\tan abbreviation that identifies the service. For example, if Amazon Elastic File System\n\t\t\t(Amazon EFS) created a hosted zone and associated a VPC with the hosted zone, the value\n\t\t\tof OwningService is efs.amazonaws.com.

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

A complex type that identifies a hosted zone that a specified Amazon VPC is associated\n\t\t\twith and the owner of the hosted zone. If there is a value for\n\t\t\t\tOwningAccount, there is no value for OwningService, and\n\t\t\tvice versa.

" - } - }, - "com.amazonaws.route53#HostedZoneOwningService": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 128 - } - } - }, - "com.amazonaws.route53#HostedZonePartiallyDelegated": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "

The hosted zone nameservers don't match the parent nameservers. The hosted zone and\n\t\t\tparent must have the same nameservers.

", - "smithy.api#error": "client" - } - }, - "com.amazonaws.route53#HostedZoneRRSetCount": { - "type": "long" - }, - "com.amazonaws.route53#HostedZoneSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.route53#HostedZoneSummary", - "traits": { - "smithy.api#xmlName": "HostedZoneSummary" - } - } - }, - "com.amazonaws.route53#HostedZoneSummary": { - "type": "structure", - "members": { - "HostedZoneId": { - "target": "com.amazonaws.route53#ResourceId", - "traits": { - "smithy.api#documentation": "

The Route 53 hosted zone ID of a private hosted zone that the specified VPC is\n\t\t\tassociated with.

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

The name of the private hosted zone, such as example.com.

", - "smithy.api#required": {} - } - }, - "Owner": { - "target": "com.amazonaws.route53#HostedZoneOwner", - "traits": { - "smithy.api#documentation": "

The owner of a private hosted zone that the specified VPC is associated with. The\n\t\t\towner can be either an Amazon Web Services account or an Amazon Web Services\n\t\t\tservice.

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

In the response to a ListHostedZonesByVPC request, the\n\t\t\t\tHostedZoneSummaries element contains one HostedZoneSummary\n\t\t\telement for each hosted zone that the specified Amazon VPC is associated with. Each\n\t\t\t\tHostedZoneSummary element contains the hosted zone name and ID, and\n\t\t\tinformation about who owns the hosted zone.

" - } - }, - "com.amazonaws.route53#HostedZones": { - "type": "list", - "member": { - "target": "com.amazonaws.route53#HostedZone", - "traits": { - "smithy.api#xmlName": "HostedZone" - } - } - }, - "com.amazonaws.route53#IPAddress": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 45 - }, - "smithy.api#pattern": "^(^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))$|^(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9]))$)$" - } - }, - "com.amazonaws.route53#IPAddressCidr": { - "type": "string" - }, - "com.amazonaws.route53#IncompatibleVersion": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "

The resource you're trying to access is unsupported on this Amazon Route 53\n\t\t\tendpoint.

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

Amazon Route 53 doesn't have the permissions required to create log streams and send\n\t\t\tquery logs to log streams. Possible causes include the following:

\n\t\t ", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.route53#InsufficientDataHealthStatus": { - "type": "enum", - "members": { - "Healthy": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Healthy" - } - }, - "Unhealthy": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Unhealthy" - } - }, - "LastKnownStatus": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LastKnownStatus" - } - } - } - }, - "com.amazonaws.route53#InvalidArgument": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage", - "traits": { - "smithy.api#documentation": "

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

Parameter name is not valid.

", - "smithy.api#error": "client" - } - }, - "com.amazonaws.route53#InvalidChangeBatch": { - "type": "structure", - "members": { - "messages": { - "target": "com.amazonaws.route53#ErrorMessages", - "traits": { - "smithy.api#documentation": "

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

This exception contains a list of messages that might contain one or more error\n\t\t\tmessages. Each error message indicates one error in the change batch.

", - "smithy.api#error": "client" - } - }, - "com.amazonaws.route53#InvalidDomainName": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage", - "traits": { - "smithy.api#documentation": "

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

The specified domain name is not valid.

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

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

The input is not valid.

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

The KeyManagementServiceArn that you specified isn't valid to use with DNSSEC\n\t\t\tsigning.

", - "smithy.api#error": "client" - } - }, - "com.amazonaws.route53#InvalidKeySigningKeyName": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "

The key-signing key (KSK) name that you specified isn't a valid name.

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

The key-signing key (KSK) status isn't valid or another KSK has the status\n\t\t\t\tINTERNAL_FAILURE.

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

The value that you specified to get the second or subsequent page of results is\n\t\t\tinvalid.

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

Your hosted zone status isn't valid for this operation. In the hosted zone, change the\n\t\t\tstatus to enable DNSSEC or disable DNSSEC.

", - "smithy.api#error": "client" - } - }, - "com.amazonaws.route53#InvalidTrafficPolicyDocument": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage", - "traits": { - "smithy.api#documentation": "

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

The format of the traffic policy document that you specified in the\n\t\t\t\tDocument element is not valid.

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

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

The VPC ID that you specified either isn't a valid ID or the current account is not\n\t\t\tauthorized to access this VPC.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.route53#Inverted": { - "type": "boolean" - }, - "com.amazonaws.route53#IsPrivateZone": { - "type": "boolean", - "traits": { - "smithy.api#default": false - } - }, - "com.amazonaws.route53#KeySigningKey": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.route53#SigningKeyName", - "traits": { - "smithy.api#documentation": "

A string used to identify a key-signing key (KSK). Name can include\n\t\t\tnumbers, letters, and underscores (_). Name must be unique for each\n\t\t\tkey-signing key in the same hosted zone.

" - } - }, - "KmsArn": { - "target": "com.amazonaws.route53#SigningKeyString", - "traits": { - "smithy.api#documentation": "

The Amazon resource name (ARN) used to identify the customer managed key in Key Management Service (KMS). The KmsArn must be unique for each\n\t\t\tkey-signing key (KSK) in a single hosted zone.

\n\t\t

You must configure the customer managed key as follows:

\n\t\t
\n
Status
\n
\n\t\t\t\t\t

Enabled

\n\t\t\t\t
\n
Key spec
\n
\n\t\t\t\t\t

ECC_NIST_P256

\n\t\t\t\t
\n
Key usage
\n
\n\t\t\t\t\t

Sign and verify

\n\t\t\t\t
\n
Key policy
\n
\n\t\t\t\t\t

The key policy must give permission for the following actions:

\n\t\t\t\t\t
    \n
  • \n\t\t\t\t\t\t\t

    DescribeKey

    \n\t\t\t\t\t\t
    • \n
  • \n\t\t\t\t\t\t\t

    GetPublicKey

    \n\t\t\t\t\t\t
    • \n
  • \n\t\t\t\t\t\t\t

    Sign

    \n\t\t\t\t\t\t
    • \n
\n\t\t\t\t\t

The key policy must also include the Amazon Route 53 service in the\n\t\t\t\t\t\tprincipal for your account. Specify the following:

\n\t\t\t\t\t
    \n
  • \n\t\t\t\t\t\t\t

    \n \"Service\": \"dnssec-route53.amazonaws.com\"\n

    \n\t\t\t\t\t\t
    • \n
\n\t\t\t\t
\n
\n\t\t

For more information about working with the customer managed key in KMS, see Key Management Service\n\t\t\t\tconcepts.

" - } - }, - "Flag": { - "target": "com.amazonaws.route53#SigningKeyInteger", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

An integer that specifies how the key is used. For key-signing key (KSK), this value\n\t\t\tis always 257.

" - } - }, - "SigningAlgorithmMnemonic": { - "target": "com.amazonaws.route53#SigningKeyString", - "traits": { - "smithy.api#documentation": "

A string used to represent the signing algorithm. This value must follow the\n\t\t\tguidelines provided by RFC-8624 Section 3.1.

" - } - }, - "SigningAlgorithmType": { - "target": "com.amazonaws.route53#SigningKeyInteger", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

An integer used to represent the signing algorithm. This value must follow the\n\t\t\tguidelines provided by RFC-8624 Section 3.1.

" - } - }, - "DigestAlgorithmMnemonic": { - "target": "com.amazonaws.route53#SigningKeyString", - "traits": { - "smithy.api#documentation": "

A string used to represent the delegation signer digest algorithm. This value must\n\t\t\tfollow the guidelines provided by RFC-8624 Section 3.3.\n\t\t

" - } - }, - "DigestAlgorithmType": { - "target": "com.amazonaws.route53#SigningKeyInteger", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

An integer used to represent the delegation signer digest algorithm. This value must\n\t\t\tfollow the guidelines provided by RFC-8624 Section\n\t\t\t3.3.

" - } - }, - "KeyTag": { - "target": "com.amazonaws.route53#SigningKeyTag", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

An integer used to identify the DNSSEC record for the domain name. The process used to\n\t\t\tcalculate the value is described in RFC-4034 Appendix B.

" - } - }, - "DigestValue": { - "target": "com.amazonaws.route53#SigningKeyString", - "traits": { - "smithy.api#documentation": "

A cryptographic digest of a DNSKEY resource record (RR). DNSKEY records are used to\n\t\t\tpublish the public key that resolvers can use to verify DNSSEC signatures that are used\n\t\t\tto secure certain kinds of information provided by the DNS system.

" - } - }, - "PublicKey": { - "target": "com.amazonaws.route53#SigningKeyString", - "traits": { - "smithy.api#documentation": "

The public key, represented as a Base64 encoding, as required by RFC-4034 Page 5.

" - } - }, - "DSRecord": { - "target": "com.amazonaws.route53#SigningKeyString", - "traits": { - "smithy.api#documentation": "

A string that represents a delegation signer (DS) record.

" - } - }, - "DNSKEYRecord": { - "target": "com.amazonaws.route53#SigningKeyString", - "traits": { - "smithy.api#documentation": "

A string that represents a DNSKEY record.

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

A string that represents the current key-signing key (KSK) status.

\n\t\t

Status can have one of the following values:

\n\t\t
\n
ACTIVE
\n
\n\t\t\t\t\t

The KSK is being used for signing.

\n\t\t\t\t
\n
INACTIVE
\n
\n\t\t\t\t\t

The KSK is not being used for signing.

\n\t\t\t\t
\n
DELETING
\n
\n\t\t\t\t\t

The KSK is in the process of being deleted.

\n\t\t\t\t
\n
ACTION_NEEDED
\n
\n\t\t\t\t\t

There is a problem with the KSK that requires you to take action to\n\t\t\t\t\t\tresolve. For example, the customer managed key might have been deleted,\n\t\t\t\t\t\tor the permissions for the customer managed key might have been\n\t\t\t\t\t\tchanged.

\n\t\t\t\t
\n
INTERNAL_FAILURE
\n
\n\t\t\t\t\t

There was an error during a request. Before you can continue to work with\n\t\t\t\t\t\tDNSSEC signing, including actions that involve this KSK, you must correct\n\t\t\t\t\t\tthe problem. For example, you may need to activate or deactivate the\n\t\t\t\t\t\tKSK.

\n\t\t\t\t
\n
" - } - }, - "StatusMessage": { - "target": "com.amazonaws.route53#SigningKeyStatusMessage", - "traits": { - "smithy.api#documentation": "

The status message provided for the following key-signing key (KSK) statuses:\n\t\t\t\tACTION_NEEDED or INTERNAL_FAILURE. The status message\n\t\t\tincludes information about what the problem might be and steps that you can take to\n\t\t\tcorrect the issue.

" - } - }, - "CreatedDate": { - "target": "com.amazonaws.route53#TimeStamp", - "traits": { - "smithy.api#documentation": "

The date when the key-signing key (KSK) was created.

" - } - }, - "LastModifiedDate": { - "target": "com.amazonaws.route53#TimeStamp", - "traits": { - "smithy.api#documentation": "

The last time that the key-signing key (KSK) was changed.

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

A key-signing key (KSK) is a complex type that represents a public/private key pair.\n\t\t\tThe private key is used to generate a digital signature for the zone signing key (ZSK).\n\t\t\tThe public key is stored in the DNS and is used to authenticate the ZSK. A KSK is always\n\t\t\tassociated with a hosted zone; it cannot exist by itself.

" - } - }, - "com.amazonaws.route53#KeySigningKeyAlreadyExists": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "

You've already created a key-signing key (KSK) with this name or with the same customer managed key ARN.

", - "smithy.api#error": "client", - "smithy.api#httpError": 409 - } - }, - "com.amazonaws.route53#KeySigningKeyInParentDSRecord": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "

The key-signing key (KSK) is specified in a parent DS record.

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

The key-signing key (KSK) that you specified can't be deactivated because it's the\n\t\t\tonly KSK for a currently-enabled DNSSEC. Disable DNSSEC signing, or add or enable\n\t\t\tanother KSK.

", - "smithy.api#error": "client" - } - }, - "com.amazonaws.route53#KeySigningKeyWithActiveStatusNotFound": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "

A key-signing key (KSK) with ACTIVE status wasn't found.

", - "smithy.api#error": "client" - } - }, - "com.amazonaws.route53#KeySigningKeys": { - "type": "list", - "member": { - "target": "com.amazonaws.route53#KeySigningKey" - } - }, - "com.amazonaws.route53#LastVPCAssociation": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage", - "traits": { - "smithy.api#documentation": "

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

The VPC that you're trying to disassociate from the private hosted zone is the last\n\t\t\tVPC that is associated with the hosted zone. Amazon Route 53 doesn't support\n\t\t\tdisassociating the last VPC from a hosted zone.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.route53#LimitValue": { - "type": "long", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 1 - } - } - }, - "com.amazonaws.route53#LimitsExceeded": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage", - "traits": { - "smithy.api#documentation": "

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

This operation can't be completed because the current account has reached the\n\t\t\tlimit on the resource you are trying to create. To request a higher limit, create a case with the Amazon Web Services Support\n\t\t\tCenter.

", - "smithy.api#error": "client" - } - }, - "com.amazonaws.route53#LinkedService": { - "type": "structure", - "members": { - "ServicePrincipal": { - "target": "com.amazonaws.route53#ServicePrincipal", - "traits": { - "smithy.api#documentation": "

If the health check or hosted zone was created by another service, the service that\n\t\t\tcreated the resource. When a resource is created by another service, you can't edit or\n\t\t\tdelete it using Amazon Route 53.

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

If the health check or hosted zone was created by another service, an optional\n\t\t\tdescription that can be provided by the other service. When a resource is created by\n\t\t\tanother service, you can't edit or delete it using Amazon Route 53.

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

If a health check or hosted zone was created by another service,\n\t\t\t\tLinkedService is a complex type that describes the service that created\n\t\t\tthe resource. When a resource is created by another service, you can't edit or delete it\n\t\t\tusing Amazon Route 53.

" - } - }, - "com.amazonaws.route53#ListCidrBlocks": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#ListCidrBlocksRequest" - }, - "output": { - "target": "com.amazonaws.route53#ListCidrBlocksResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#NoSuchCidrCollectionException" - }, - { - "target": "com.amazonaws.route53#NoSuchCidrLocationException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns a paginated list of location objects and their CIDR blocks.

", - "smithy.api#http": { - "method": "GET", - "uri": "/2013-04-01/cidrcollection/{CollectionId}/cidrblocks", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "CidrBlocks", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.route53#ListCidrBlocksRequest": { - "type": "structure", - "members": { - "CollectionId": { - "target": "com.amazonaws.route53#UUID", - "traits": { - "smithy.api#documentation": "

The UUID of the CIDR collection.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "LocationName": { - "target": "com.amazonaws.route53#CidrLocationNameDefaultNotAllowed", - "traits": { - "smithy.api#documentation": "

The name of the CIDR collection location.

", - "smithy.api#httpQuery": "location" - } - }, - "NextToken": { - "target": "com.amazonaws.route53#PaginationToken", - "traits": { - "smithy.api#documentation": "

An opaque pagination token to indicate where the service is to begin enumerating\n\t\t\tresults.

", - "smithy.api#httpQuery": "nexttoken" - } - }, - "MaxResults": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#documentation": "

Maximum number of results you want returned.

", - "smithy.api#httpQuery": "maxresults" - } - } - } - }, - "com.amazonaws.route53#ListCidrBlocksResponse": { - "type": "structure", - "members": { - "NextToken": { - "target": "com.amazonaws.route53#PaginationToken", - "traits": { - "smithy.api#documentation": "

An opaque pagination token to indicate where the service is to begin enumerating\n\t\t\tresults.

\n\t\t

If no value is provided, the listing of results starts from the beginning.

" - } - }, - "CidrBlocks": { - "target": "com.amazonaws.route53#CidrBlockSummaries", - "traits": { - "smithy.api#documentation": "

A complex type that contains information about the CIDR blocks.

" - } - } - } - }, - "com.amazonaws.route53#ListCidrCollections": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#ListCidrCollectionsRequest" - }, - "output": { - "target": "com.amazonaws.route53#ListCidrCollectionsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#InvalidInput" - } - ], - "traits": { - "smithy.api#documentation": "

Returns a paginated list of CIDR collections in the Amazon Web Services account\n\t\t\t(metadata only).

", - "smithy.api#http": { - "method": "GET", - "uri": "/2013-04-01/cidrcollection", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "CidrCollections", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.route53#ListCidrCollectionsRequest": { - "type": "structure", - "members": { - "NextToken": { - "target": "com.amazonaws.route53#PaginationToken", - "traits": { - "smithy.api#documentation": "

An opaque pagination token to indicate where the service is to begin enumerating\n\t\t\tresults.

\n\t\t

If no value is provided, the listing of results starts from the beginning.

", - "smithy.api#httpQuery": "nexttoken" - } - }, - "MaxResults": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#documentation": "

The maximum number of CIDR collections to return in the response.

", - "smithy.api#httpQuery": "maxresults" - } - } - } - }, - "com.amazonaws.route53#ListCidrCollectionsResponse": { - "type": "structure", - "members": { - "NextToken": { - "target": "com.amazonaws.route53#PaginationToken", - "traits": { - "smithy.api#documentation": "

An opaque pagination token to indicate where the service is to begin enumerating\n\t\t\tresults.

\n\t\t

If no value is provided, the listing of results starts from the beginning.

" - } - }, - "CidrCollections": { - "target": "com.amazonaws.route53#CollectionSummaries", - "traits": { - "smithy.api#documentation": "

A complex type with information about the CIDR collection.

" - } - } - } - }, - "com.amazonaws.route53#ListCidrLocations": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#ListCidrLocationsRequest" - }, - "output": { - "target": "com.amazonaws.route53#ListCidrLocationsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#NoSuchCidrCollectionException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns a paginated list of CIDR locations for the given collection (metadata only,\n\t\t\tdoes not include CIDR blocks).

", - "smithy.api#http": { - "method": "GET", - "uri": "/2013-04-01/cidrcollection/{CollectionId}", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "CidrLocations", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.route53#ListCidrLocationsRequest": { - "type": "structure", - "members": { - "CollectionId": { - "target": "com.amazonaws.route53#UUID", - "traits": { - "smithy.api#documentation": "

The CIDR collection ID.

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

An opaque pagination token to indicate where the service is to begin enumerating\n\t\t\tresults.

\n\t\t

If no value is provided, the listing of results starts from the beginning.

", - "smithy.api#httpQuery": "nexttoken" - } - }, - "MaxResults": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#documentation": "

The maximum number of CIDR collection locations to return in the response.

", - "smithy.api#httpQuery": "maxresults" - } - } - } - }, - "com.amazonaws.route53#ListCidrLocationsResponse": { - "type": "structure", - "members": { - "NextToken": { - "target": "com.amazonaws.route53#PaginationToken", - "traits": { - "smithy.api#documentation": "

An opaque pagination token to indicate where the service is to begin enumerating\n\t\t\tresults.

\n\t\t

If no value is provided, the listing of results starts from the beginning.

" - } - }, - "CidrLocations": { - "target": "com.amazonaws.route53#LocationSummaries", - "traits": { - "smithy.api#documentation": "

A complex type that contains information about the list of CIDR locations.

" - } - } - } - }, - "com.amazonaws.route53#ListGeoLocations": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#ListGeoLocationsRequest" - }, - "output": { - "target": "com.amazonaws.route53#ListGeoLocationsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#InvalidInput" - } - ], - "traits": { - "smithy.api#documentation": "

Retrieves a list of supported geographic locations.

\n\t\t

Countries are listed first, and continents are listed last. If Amazon Route 53\n\t\t\tsupports subdivisions for a country (for example, states or provinces), the subdivisions\n\t\t\tfor that country are listed in alphabetical order immediately after the corresponding\n\t\t\tcountry.

\n\t\t

Route 53 does not perform authorization for this API because it retrieves information\n\t\t\tthat is already available to the public.

\n\t\t

For a list of supported geolocation codes, see the GeoLocation data\n\t\t\ttype.

", - "smithy.api#http": { - "method": "GET", - "uri": "/2013-04-01/geolocations", - "code": 200 - } - } - }, - "com.amazonaws.route53#ListGeoLocationsRequest": { - "type": "structure", - "members": { - "StartContinentCode": { - "target": "com.amazonaws.route53#GeoLocationContinentCode", - "traits": { - "smithy.api#documentation": "

The code for the continent with which you want to start listing locations that Amazon\n\t\t\tRoute 53 supports for geolocation. If Route 53 has already returned a page or more of\n\t\t\tresults, if IsTruncated is true, and if NextContinentCode from\n\t\t\tthe previous response has a value, enter that value in startcontinentcode\n\t\t\tto return the next page of results.

\n\t\t

Include startcontinentcode only if you want to list continents. Don't\n\t\t\tinclude startcontinentcode when you're listing countries or countries with\n\t\t\ttheir subdivisions.

", - "smithy.api#httpQuery": "startcontinentcode" - } - }, - "StartCountryCode": { - "target": "com.amazonaws.route53#GeoLocationCountryCode", - "traits": { - "smithy.api#documentation": "

The code for the country with which you want to start listing locations that Amazon\n\t\t\tRoute 53 supports for geolocation. If Route 53 has already returned a page or more of\n\t\t\tresults, if IsTruncated is true, and if\n\t\t\t\tNextCountryCode from the previous response has a value, enter that\n\t\t\tvalue in startcountrycode to return the next page of results.

", - "smithy.api#httpQuery": "startcountrycode" - } - }, - "StartSubdivisionCode": { - "target": "com.amazonaws.route53#GeoLocationSubdivisionCode", - "traits": { - "smithy.api#documentation": "

The code for the state of the United States with which you want to start listing\n\t\t\tlocations that Amazon Route 53 supports for geolocation. If Route 53 has already\n\t\t\treturned a page or more of results, if IsTruncated is true,\n\t\t\tand if NextSubdivisionCode from the previous response has a value, enter\n\t\t\tthat value in startsubdivisioncode to return the next page of\n\t\t\tresults.

\n\t\t

To list subdivisions (U.S. states), you must include both\n\t\t\t\tstartcountrycode and startsubdivisioncode.

", - "smithy.api#httpQuery": "startsubdivisioncode" - } - }, - "MaxItems": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#documentation": "

(Optional) The maximum number of geolocations to be included in the response body for\n\t\t\tthis request. If more than maxitems geolocations remain to be listed, then\n\t\t\tthe value of the IsTruncated element in the response is\n\t\t\ttrue.

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

A request to get a list of geographic locations that Amazon Route 53 supports for\n\t\t\tgeolocation resource record sets.

" - } - }, - "com.amazonaws.route53#ListGeoLocationsResponse": { - "type": "structure", - "members": { - "GeoLocationDetailsList": { - "target": "com.amazonaws.route53#GeoLocationDetailsList", - "traits": { - "smithy.api#documentation": "

A complex type that contains one GeoLocationDetails element for each\n\t\t\tlocation that Amazon Route 53 supports for geolocation.

", - "smithy.api#required": {} - } - }, - "IsTruncated": { - "target": "com.amazonaws.route53#PageTruncated", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A value that indicates whether more locations remain to be listed after the last\n\t\t\tlocation in this response. If so, the value of IsTruncated is\n\t\t\t\ttrue. To get more values, submit another request and include the values\n\t\t\tof NextContinentCode, NextCountryCode, and\n\t\t\t\tNextSubdivisionCode in the startcontinentcode,\n\t\t\t\tstartcountrycode, and startsubdivisioncode, as\n\t\t\tapplicable.

", - "smithy.api#required": {} - } - }, - "NextContinentCode": { - "target": "com.amazonaws.route53#GeoLocationContinentCode", - "traits": { - "smithy.api#documentation": "

If IsTruncated is true, you can make a follow-up request to\n\t\t\tdisplay more locations. Enter the value of NextContinentCode in the\n\t\t\t\tstartcontinentcode parameter in another ListGeoLocations\n\t\t\trequest.

" - } - }, - "NextCountryCode": { - "target": "com.amazonaws.route53#GeoLocationCountryCode", - "traits": { - "smithy.api#documentation": "

If IsTruncated is true, you can make a follow-up request to\n\t\t\tdisplay more locations. Enter the value of NextCountryCode in the\n\t\t\t\tstartcountrycode parameter in another ListGeoLocations\n\t\t\trequest.

" - } - }, - "NextSubdivisionCode": { - "target": "com.amazonaws.route53#GeoLocationSubdivisionCode", - "traits": { - "smithy.api#documentation": "

If IsTruncated is true, you can make a follow-up request to\n\t\t\tdisplay more locations. Enter the value of NextSubdivisionCode in the\n\t\t\t\tstartsubdivisioncode parameter in another ListGeoLocations\n\t\t\trequest.

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

The value that you specified for MaxItems in the request.

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

A complex type containing the response information for the request.

" - } - }, - "com.amazonaws.route53#ListHealthChecks": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#ListHealthChecksRequest" - }, - "output": { - "target": "com.amazonaws.route53#ListHealthChecksResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#IncompatibleVersion" - }, - { - "target": "com.amazonaws.route53#InvalidInput" - } - ], - "traits": { - "smithy.api#documentation": "

Retrieve a list of the health checks that are associated with the current Amazon Web Services account.

", - "smithy.api#http": { - "method": "GET", - "uri": "/2013-04-01/healthcheck", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "Marker", - "outputToken": "NextMarker", - "items": "HealthChecks", - "pageSize": "MaxItems" - } - } - }, - "com.amazonaws.route53#ListHealthChecksRequest": { - "type": "structure", - "members": { - "Marker": { - "target": "com.amazonaws.route53#PageMarker", - "traits": { - "smithy.api#documentation": "

If the value of IsTruncated in the previous response was\n\t\t\t\ttrue, you have more health checks. To get another group, submit another\n\t\t\t\tListHealthChecks request.

\n\t\t

For the value of marker, specify the value of NextMarker\n\t\t\tfrom the previous response, which is the ID of the first health check that Amazon Route\n\t\t\t53 will return if you submit another request.

\n\t\t

If the value of IsTruncated in the previous response was\n\t\t\t\tfalse, there are no more health checks to get.

", - "smithy.api#httpQuery": "marker" - } - }, - "MaxItems": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#documentation": "

The maximum number of health checks that you want ListHealthChecks to\n\t\t\treturn in response to the current request. Amazon Route 53 returns a maximum of 100\n\t\t\titems. If you set MaxItems to a value greater than 100, Route 53 returns\n\t\t\tonly the first 100 health checks.

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

A request to retrieve a list of the health checks that are associated with the current\n\t\t\t\tAmazon Web Services account.

" - } - }, - "com.amazonaws.route53#ListHealthChecksResponse": { - "type": "structure", - "members": { - "HealthChecks": { - "target": "com.amazonaws.route53#HealthChecks", - "traits": { - "smithy.api#documentation": "

A complex type that contains one HealthCheck element for each health\n\t\t\tcheck that is associated with the current Amazon Web Services account.

", - "smithy.api#required": {} - } - }, - "Marker": { - "target": "com.amazonaws.route53#PageMarker", - "traits": { - "smithy.api#documentation": "

For the second and subsequent calls to ListHealthChecks,\n\t\t\t\tMarker is the value that you specified for the marker\n\t\t\tparameter in the previous request.

", - "smithy.api#required": {} - } - }, - "IsTruncated": { - "target": "com.amazonaws.route53#PageTruncated", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A flag that indicates whether there are more health checks to be listed. If the\n\t\t\tresponse was truncated, you can get the next group of health checks by submitting\n\t\t\tanother ListHealthChecks request and specifying the value of\n\t\t\t\tNextMarker in the marker parameter.

", - "smithy.api#required": {} - } - }, - "NextMarker": { - "target": "com.amazonaws.route53#PageMarker", - "traits": { - "smithy.api#documentation": "

If IsTruncated is true, the value of NextMarker\n\t\t\tidentifies the first health check that Amazon Route 53 returns if you submit another\n\t\t\t\tListHealthChecks request and specify the value of\n\t\t\t\tNextMarker in the marker parameter.

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

The value that you specified for the maxitems parameter in the call to\n\t\t\t\tListHealthChecks that produced the current response.

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

A complex type that contains the response to a ListHealthChecks\n\t\t\trequest.

" - } - }, - "com.amazonaws.route53#ListHostedZones": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#ListHostedZonesRequest" - }, - "output": { - "target": "com.amazonaws.route53#ListHostedZonesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#DelegationSetNotReusable" - }, - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#NoSuchDelegationSet" - } - ], - "traits": { - "smithy.api#documentation": "

Retrieves a list of the public and private hosted zones that are associated with the\n\t\t\tcurrent Amazon Web Services account. The response includes a HostedZones\n\t\t\tchild element for each hosted zone.

\n\t\t

Amazon Route 53 returns a maximum of 100 items in each response. If you have a lot of\n\t\t\thosted zones, you can use the maxitems parameter to list them in groups of\n\t\t\tup to 100.

", - "smithy.api#http": { - "method": "GET", - "uri": "/2013-04-01/hostedzone", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "Marker", - "outputToken": "NextMarker", - "items": "HostedZones", - "pageSize": "MaxItems" - } - } - }, - "com.amazonaws.route53#ListHostedZonesByName": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#ListHostedZonesByNameRequest" - }, - "output": { - "target": "com.amazonaws.route53#ListHostedZonesByNameResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#InvalidDomainName" - }, - { - "target": "com.amazonaws.route53#InvalidInput" - } - ], - "traits": { - "smithy.api#documentation": "

Retrieves a list of your hosted zones in lexicographic order. The response includes a\n\t\t\t\tHostedZones child element for each hosted zone created by the current\n\t\t\t\tAmazon Web Services account.

\n\t\t

\n ListHostedZonesByName sorts hosted zones by name with the labels\n\t\t\treversed. For example:

\n\t\t

\n com.example.www.\n

\n\t\t

Note the trailing dot, which can change the sort order in some circumstances.

\n\t\t

If the domain name includes escape characters or Punycode,\n\t\t\t\tListHostedZonesByName alphabetizes the domain name using the escaped or\n\t\t\tPunycoded value, which is the format that Amazon Route 53 saves in its database. For\n\t\t\texample, to create a hosted zone for exämple.com, you specify ex\\344mple.com for\n\t\t\tthe domain name. ListHostedZonesByName alphabetizes it as:

\n\t\t

\n com.ex\\344mple.\n

\n\t\t

The labels are reversed and alphabetized using the escaped value. For more information\n\t\t\tabout valid domain name formats, including internationalized domain names, see DNS\n\t\t\t\tDomain Name Format in the Amazon Route 53 Developer\n\t\t\t\tGuide.

\n\t\t

Route 53 returns up to 100 items in each response. If you have a lot of hosted zones,\n\t\t\tuse the MaxItems parameter to list them in groups of up to 100. The\n\t\t\tresponse includes values that help navigate from one group of MaxItems\n\t\t\thosted zones to the next:

\n\t\t ", - "smithy.api#http": { - "method": "GET", - "uri": "/2013-04-01/hostedzonesbyname", - "code": 200 - } - } - }, - "com.amazonaws.route53#ListHostedZonesByNameRequest": { - "type": "structure", - "members": { - "DNSName": { - "target": "com.amazonaws.route53#DNSName", - "traits": { - "smithy.api#documentation": "

(Optional) For your first request to ListHostedZonesByName, include the\n\t\t\t\tdnsname parameter only if you want to specify the name of the first\n\t\t\thosted zone in the response. If you don't include the dnsname parameter,\n\t\t\tAmazon Route 53 returns all of the hosted zones that were created by the current Amazon Web Services account, in ASCII order. For subsequent requests, include both\n\t\t\t\tdnsname and hostedzoneid parameters. For\n\t\t\t\tdnsname, specify the value of NextDNSName from the\n\t\t\tprevious response.

", - "smithy.api#httpQuery": "dnsname" - } - }, - "HostedZoneId": { - "target": "com.amazonaws.route53#ResourceId", - "traits": { - "smithy.api#documentation": "

(Optional) For your first request to ListHostedZonesByName, do not\n\t\t\tinclude the hostedzoneid parameter.

\n\t\t

If you have more hosted zones than the value of maxitems,\n\t\t\t\tListHostedZonesByName returns only the first maxitems\n\t\t\thosted zones. To get the next group of maxitems hosted zones, submit\n\t\t\tanother request to ListHostedZonesByName and include both\n\t\t\t\tdnsname and hostedzoneid parameters. For the value of\n\t\t\t\thostedzoneid, specify the value of the NextHostedZoneId\n\t\t\telement from the previous response.

", - "smithy.api#httpQuery": "hostedzoneid" - } - }, - "MaxItems": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#documentation": "

The maximum number of hosted zones to be included in the response body for this\n\t\t\trequest. If you have more than maxitems hosted zones, then the value of the\n\t\t\t\tIsTruncated element in the response is true, and the values of\n\t\t\t\tNextDNSName and NextHostedZoneId specify the first hosted\n\t\t\tzone in the next group of maxitems hosted zones.

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

Retrieves a list of the public and private hosted zones that are associated with the\n\t\t\tcurrent Amazon Web Services account in ASCII order by domain name.

" - } - }, - "com.amazonaws.route53#ListHostedZonesByNameResponse": { - "type": "structure", - "members": { - "HostedZones": { - "target": "com.amazonaws.route53#HostedZones", - "traits": { - "smithy.api#documentation": "

A complex type that contains general information about the hosted zone.

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

For the second and subsequent calls to ListHostedZonesByName,\n\t\t\t\tDNSName is the value that you specified for the dnsname\n\t\t\tparameter in the request that produced the current response.

" - } - }, - "HostedZoneId": { - "target": "com.amazonaws.route53#ResourceId", - "traits": { - "smithy.api#documentation": "

The ID that Amazon Route 53 assigned to the hosted zone when you created it.

" - } - }, - "IsTruncated": { - "target": "com.amazonaws.route53#PageTruncated", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A flag that indicates whether there are more hosted zones to be listed. If the\n\t\t\tresponse was truncated, you can get the next group of maxitems hosted zones\n\t\t\tby calling ListHostedZonesByName again and specifying the values of\n\t\t\t\tNextDNSName and NextHostedZoneId elements in the\n\t\t\t\tdnsname and hostedzoneid parameters.

", - "smithy.api#required": {} - } - }, - "NextDNSName": { - "target": "com.amazonaws.route53#DNSName", - "traits": { - "smithy.api#documentation": "

If IsTruncated is true, the value of NextDNSName is the name\n\t\t\tof the first hosted zone in the next group of maxitems hosted zones. Call\n\t\t\t\tListHostedZonesByName again and specify the value of\n\t\t\t\tNextDNSName and NextHostedZoneId in the\n\t\t\t\tdnsname and hostedzoneid parameters, respectively.

\n\t\t

This element is present only if IsTruncated is true.

" - } - }, - "NextHostedZoneId": { - "target": "com.amazonaws.route53#ResourceId", - "traits": { - "smithy.api#documentation": "

If IsTruncated is true, the value of\n\t\t\t\tNextHostedZoneId identifies the first hosted zone in the next group of\n\t\t\t\tmaxitems hosted zones. Call ListHostedZonesByName again\n\t\t\tand specify the value of NextDNSName and NextHostedZoneId in\n\t\t\tthe dnsname and hostedzoneid parameters, respectively.

\n\t\t

This element is present only if IsTruncated is true.

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

The value that you specified for the maxitems parameter in the call to\n\t\t\t\tListHostedZonesByName that produced the current response.

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

A complex type that contains the response information for the request.

" - } - }, - "com.amazonaws.route53#ListHostedZonesByVPC": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#ListHostedZonesByVPCRequest" - }, - "output": { - "target": "com.amazonaws.route53#ListHostedZonesByVPCResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#InvalidPaginationToken" - } - ], - "traits": { - "smithy.api#documentation": "

Lists all the private hosted zones that a specified VPC is associated with, regardless\n\t\t\tof which Amazon Web Services account or Amazon Web Services service owns the hosted zones.\n\t\t\tThe HostedZoneOwner structure in the response contains one of the following\n\t\t\tvalues:

\n\t\t \n\t\t \n\t\t\t

When listing private hosted zones, the hosted zone and the Amazon VPC must\n\t\t\t\tbelong to the same partition where the hosted zones were created. A partition is a\n\t\t\t\tgroup of Amazon Web Services Regions. Each Amazon Web Services account is scoped to\n\t\t\t\tone partition.

\n\t\t\t

The following are the supported partitions:

\n\t\t\t \n\t\t\t

For more information, see Access Management\n\t\t\t\tin the Amazon Web Services General Reference.

\n\t\t ", - "smithy.api#http": { - "method": "GET", - "uri": "/2013-04-01/hostedzonesbyvpc", - "code": 200 - } - } - }, - "com.amazonaws.route53#ListHostedZonesByVPCRequest": { - "type": "structure", - "members": { - "VPCId": { - "target": "com.amazonaws.route53#VPCId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon VPC that you want to list hosted zones for.

", - "smithy.api#httpQuery": "vpcid", - "smithy.api#required": {} - } - }, - "VPCRegion": { - "target": "com.amazonaws.route53#VPCRegion", - "traits": { - "smithy.api#documentation": "

For the Amazon VPC that you specified for VPCId, the Amazon Web Services\n\t\t\tRegion that you created the VPC in.

", - "smithy.api#httpQuery": "vpcregion", - "smithy.api#required": {} - } - }, - "MaxItems": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#documentation": "

(Optional) The maximum number of hosted zones that you want Amazon Route 53 to return.\n\t\t\tIf the specified VPC is associated with more than MaxItems hosted zones,\n\t\t\tthe response includes a NextToken element. NextToken contains\n\t\t\tan encrypted token that identifies the first hosted zone that Route 53 will return if\n\t\t\tyou submit another request.

", - "smithy.api#httpQuery": "maxitems" - } - }, - "NextToken": { - "target": "com.amazonaws.route53#PaginationToken", - "traits": { - "smithy.api#documentation": "

If the previous response included a NextToken element, the specified VPC\n\t\t\tis associated with more hosted zones. To get more hosted zones, submit another\n\t\t\t\tListHostedZonesByVPC request.

\n\t\t

For the value of NextToken, specify the value of NextToken\n\t\t\tfrom the previous response.

\n\t\t

If the previous response didn't include a NextToken element, there are no\n\t\t\tmore hosted zones to get.

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

Lists all the private hosted zones that a specified VPC is associated with, regardless\n\t\t\tof which Amazon Web Services account created the hosted zones.

" - } - }, - "com.amazonaws.route53#ListHostedZonesByVPCResponse": { - "type": "structure", - "members": { - "HostedZoneSummaries": { - "target": "com.amazonaws.route53#HostedZoneSummaries", - "traits": { - "smithy.api#documentation": "

A list that contains one HostedZoneSummary element for each hosted zone\n\t\t\tthat the specified Amazon VPC is associated with. Each HostedZoneSummary\n\t\t\telement contains the hosted zone name and ID, and information about who owns the hosted\n\t\t\tzone.

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

The value that you specified for MaxItems in the most recent\n\t\t\t\tListHostedZonesByVPC request.

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

The value that you will use for NextToken in the next\n\t\t\t\tListHostedZonesByVPC request.

" - } - } - } - }, - "com.amazonaws.route53#ListHostedZonesRequest": { - "type": "structure", - "members": { - "Marker": { - "target": "com.amazonaws.route53#PageMarker", - "traits": { - "smithy.api#documentation": "

If the value of IsTruncated in the previous response was\n\t\t\t\ttrue, you have more hosted zones. To get more hosted zones, submit\n\t\t\tanother ListHostedZones request.

\n\t\t

For the value of marker, specify the value of NextMarker\n\t\t\tfrom the previous response, which is the ID of the first hosted zone that Amazon Route\n\t\t\t53 will return if you submit another request.

\n\t\t

If the value of IsTruncated in the previous response was\n\t\t\t\tfalse, there are no more hosted zones to get.

", - "smithy.api#httpQuery": "marker" - } - }, - "MaxItems": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#documentation": "

(Optional) The maximum number of hosted zones that you want Amazon Route 53 to return.\n\t\t\tIf you have more than maxitems hosted zones, the value of\n\t\t\t\tIsTruncated in the response is true, and the value of\n\t\t\t\tNextMarker is the hosted zone ID of the first hosted zone that Route 53\n\t\t\twill return if you submit another request.

", - "smithy.api#httpQuery": "maxitems" - } - }, - "DelegationSetId": { - "target": "com.amazonaws.route53#ResourceId", - "traits": { - "smithy.api#documentation": "

If you're using reusable delegation sets and you want to list all of the hosted zones\n\t\t\tthat are associated with a reusable delegation set, specify the ID of that reusable\n\t\t\tdelegation set.

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

A request to retrieve a list of the public and private hosted zones that are\n\t\t\tassociated with the current Amazon Web Services account.

" - } - }, - "com.amazonaws.route53#ListHostedZonesResponse": { - "type": "structure", - "members": { - "HostedZones": { - "target": "com.amazonaws.route53#HostedZones", - "traits": { - "smithy.api#documentation": "

A complex type that contains general information about the hosted zone.

", - "smithy.api#required": {} - } - }, - "Marker": { - "target": "com.amazonaws.route53#PageMarker", - "traits": { - "smithy.api#documentation": "

For the second and subsequent calls to ListHostedZones,\n\t\t\t\tMarker is the value that you specified for the marker\n\t\t\tparameter in the request that produced the current response.

", - "smithy.api#required": {} - } - }, - "IsTruncated": { - "target": "com.amazonaws.route53#PageTruncated", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A flag indicating whether there are more hosted zones to be listed. If the response\n\t\t\twas truncated, you can get more hosted zones by submitting another\n\t\t\t\tListHostedZones request and specifying the value of\n\t\t\t\tNextMarker in the marker parameter.

", - "smithy.api#required": {} - } - }, - "NextMarker": { - "target": "com.amazonaws.route53#PageMarker", - "traits": { - "smithy.api#documentation": "

If IsTruncated is true, the value of NextMarker\n\t\t\tidentifies the first hosted zone in the next group of hosted zones. Submit another\n\t\t\t\tListHostedZones request, and specify the value of\n\t\t\t\tNextMarker from the response in the marker\n\t\t\tparameter.

\n\t\t

This element is present only if IsTruncated is true.

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

The value that you specified for the maxitems parameter in the call to\n\t\t\t\tListHostedZones that produced the current response.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.route53#ListQueryLoggingConfigs": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#ListQueryLoggingConfigsRequest" - }, - "output": { - "target": "com.amazonaws.route53#ListQueryLoggingConfigsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#InvalidPaginationToken" - }, - { - "target": "com.amazonaws.route53#NoSuchHostedZone" - } - ], - "traits": { - "smithy.api#documentation": "

Lists the configurations for DNS query logging that are associated with the current\n\t\t\t\tAmazon Web Services account or the configuration that is associated with a specified\n\t\t\thosted zone.

\n\t\t

For more information about DNS query logs, see CreateQueryLoggingConfig. Additional information, including the format of\n\t\t\tDNS query logs, appears in Logging DNS Queries in\n\t\t\tthe Amazon Route 53 Developer Guide.

", - "smithy.api#http": { - "method": "GET", - "uri": "/2013-04-01/queryloggingconfig", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "QueryLoggingConfigs", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.route53#ListQueryLoggingConfigsRequest": { - "type": "structure", - "members": { - "HostedZoneId": { - "target": "com.amazonaws.route53#ResourceId", - "traits": { - "smithy.api#documentation": "

(Optional) If you want to list the query logging configuration that is associated with\n\t\t\ta hosted zone, specify the ID in HostedZoneId.

\n\t\t

If you don't specify a hosted zone ID, ListQueryLoggingConfigs returns\n\t\t\tall of the configurations that are associated with the current Amazon Web Services account.

", - "smithy.api#httpQuery": "hostedzoneid" - } - }, - "NextToken": { - "target": "com.amazonaws.route53#PaginationToken", - "traits": { - "smithy.api#documentation": "

(Optional) If the current Amazon Web Services account has more than\n\t\t\t\tMaxResults query logging configurations, use NextToken to\n\t\t\tget the second and subsequent pages of results.

\n\t\t

For the first ListQueryLoggingConfigs request, omit this value.

\n\t\t

For the second and subsequent requests, get the value of NextToken from\n\t\t\tthe previous response and specify that value for NextToken in the\n\t\t\trequest.

", - "smithy.api#httpQuery": "nexttoken" - } - }, - "MaxResults": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#documentation": "

(Optional) The maximum number of query logging configurations that you want Amazon\n\t\t\tRoute 53 to return in response to the current request. If the current Amazon Web Services account has more than MaxResults configurations, use the\n\t\t\tvalue of NextToken in the response to get the next page of results.

\n\t\t

If you don't specify a value for MaxResults, Route 53 returns up to 100\n\t\t\tconfigurations.

", - "smithy.api#httpQuery": "maxresults" - } - } - } - }, - "com.amazonaws.route53#ListQueryLoggingConfigsResponse": { - "type": "structure", - "members": { - "QueryLoggingConfigs": { - "target": "com.amazonaws.route53#QueryLoggingConfigs", - "traits": { - "smithy.api#documentation": "

An array that contains one QueryLoggingConfig element for each configuration for DNS query logging\n\t\t\tthat is associated with the current Amazon Web Services account.

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

If a response includes the last of the query logging configurations that are\n\t\t\tassociated with the current Amazon Web Services account, NextToken doesn't\n\t\t\tappear in the response.

\n\t\t

If a response doesn't include the last of the configurations, you can get more\n\t\t\tconfigurations by submitting another ListQueryLoggingConfigs request. Get the value of NextToken\n\t\t\tthat Amazon Route 53 returned in the previous response and include it in\n\t\t\t\tNextToken in the next request.

" - } - } - } - }, - "com.amazonaws.route53#ListResourceRecordSets": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#ListResourceRecordSetsRequest" - }, - "output": { - "target": "com.amazonaws.route53#ListResourceRecordSetsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#NoSuchHostedZone" - } - ], - "traits": { - "smithy.api#documentation": "

Lists the resource record sets in a specified hosted zone.

\n\t\t

\n ListResourceRecordSets returns up to 300 resource record sets at a time\n\t\t\tin ASCII order, beginning at a position specified by the name and\n\t\t\t\ttype elements.

\n\t\t

\n Sort order\n

\n\t\t

\n ListResourceRecordSets sorts results first by DNS name with the labels\n\t\t\treversed, for example:

\n\t\t

\n com.example.www.\n

\n\t\t

Note the trailing dot, which can change the sort order when the record name contains\n\t\t\tcharacters that appear before . (decimal 46) in the ASCII table. These\n\t\t\tcharacters include the following: ! \" # $ % & ' ( ) * + , -\n

\n\t\t

When multiple records have the same DNS name, ListResourceRecordSets\n\t\t\tsorts results by the record type.

\n\t\t

\n Specifying where to start listing records\n

\n\t\t

You can use the name and type elements to specify the resource record set that the\n\t\t\tlist begins with:

\n\t\t
\n
If you do not specify Name or Type
\n
\n\t\t\t\t\t

The results begin with the first resource record set that the hosted zone\n\t\t\t\t\t\tcontains.

\n\t\t\t\t
\n
If you specify Name but not Type
\n
\n\t\t\t\t\t

The results begin with the first resource record set in the list whose\n\t\t\t\t\t\tname is greater than or equal to Name.

\n\t\t\t\t
\n
If you specify Type but not Name
\n
\n\t\t\t\t\t

Amazon Route 53 returns the InvalidInput error.

\n\t\t\t\t
\n
If you specify both Name and Type
\n
\n\t\t\t\t\t

The results begin with the first resource record set in the list whose\n\t\t\t\t\t\tname is greater than or equal to Name, and whose type is\n\t\t\t\t\t\tgreater than or equal to Type.

\n\t\t\t\t
\n
\n\t\t

\n Resource record sets that are PENDING\n

\n\t\t

This action returns the most current version of the records. This includes records\n\t\t\tthat are PENDING, and that are not yet available on all Route 53 DNS\n\t\t\tservers.

\n\t\t

\n Changing resource record sets\n

\n\t\t

To ensure that you get an accurate listing of the resource record sets for a hosted\n\t\t\tzone at a point in time, do not submit a ChangeResourceRecordSets request\n\t\t\twhile you're paging through the results of a ListResourceRecordSets\n\t\t\trequest. If you do, some pages may display results without the latest changes while\n\t\t\tother pages display results with the latest changes.

\n\t\t

\n Displaying the next page of results\n

\n\t\t

If a ListResourceRecordSets command returns more than one page of\n\t\t\tresults, the value of IsTruncated is true. To display the next\n\t\t\tpage of results, get the values of NextRecordName,\n\t\t\t\tNextRecordType, and NextRecordIdentifier (if any) from the\n\t\t\tresponse. Then submit another ListResourceRecordSets request, and specify\n\t\t\tthose values for StartRecordName, StartRecordType, and\n\t\t\t\tStartRecordIdentifier.

", - "smithy.api#http": { - "method": "GET", - "uri": "/2013-04-01/hostedzone/{HostedZoneId}/rrset", - "code": 200 - } - } - }, - "com.amazonaws.route53#ListResourceRecordSetsRequest": { - "type": "structure", - "members": { - "HostedZoneId": { - "target": "com.amazonaws.route53#ResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the hosted zone that contains the resource record sets that you want to\n\t\t\tlist.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "StartRecordName": { - "target": "com.amazonaws.route53#DNSName", - "traits": { - "smithy.api#documentation": "

The first name in the lexicographic ordering of resource record sets that you want to\n\t\t\tlist. If the specified record name doesn't exist, the results begin with the first\n\t\t\tresource record set that has a name greater than the value of name.

", - "smithy.api#httpQuery": "name" - } - }, - "StartRecordType": { - "target": "com.amazonaws.route53#RRType", - "traits": { - "smithy.api#documentation": "

The type of resource record set to begin the record listing from.

\n\t\t

Valid values for basic resource record sets: A | AAAA |\n\t\t\t\tCAA | CNAME | MX | NAPTR |\n\t\t\t\tNS | PTR | SOA | SPF |\n\t\t\t\tSRV | TXT\n

\n\t\t

Values for weighted, latency, geolocation, and failover resource record sets:\n\t\t\t\tA | AAAA | CAA | CNAME |\n\t\t\t\tMX | NAPTR | PTR | SPF |\n\t\t\t\tSRV | TXT\n

\n\t\t

Values for alias resource record sets:

\n\t\t \n\t\t

Constraint: Specifying type without specifying name returns\n\t\t\tan InvalidInput error.

", - "smithy.api#httpQuery": "type" - } - }, - "StartRecordIdentifier": { - "target": "com.amazonaws.route53#ResourceRecordSetIdentifier", - "traits": { - "smithy.api#documentation": "

\n Resource record sets that have a routing policy other than\n\t\t\t\tsimple: If results were truncated for a given DNS name and type, specify\n\t\t\tthe value of NextRecordIdentifier from the previous response to get the\n\t\t\tnext resource record set that has the current DNS name and type.

", - "smithy.api#httpQuery": "identifier" - } - }, - "MaxItems": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#documentation": "

(Optional) The maximum number of resource records sets to include in the response body\n\t\t\tfor this request. If the response includes more than maxitems resource\n\t\t\trecord sets, the value of the IsTruncated element in the response is\n\t\t\t\ttrue, and the values of the NextRecordName and\n\t\t\t\tNextRecordType elements in the response identify the first resource\n\t\t\trecord set in the next group of maxitems resource record sets.

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

A request for the resource record sets that are associated with a specified hosted\n\t\t\tzone.

" - } - }, - "com.amazonaws.route53#ListResourceRecordSetsResponse": { - "type": "structure", - "members": { - "ResourceRecordSets": { - "target": "com.amazonaws.route53#ResourceRecordSets", - "traits": { - "smithy.api#documentation": "

Information about multiple resource record sets.

", - "smithy.api#required": {} - } - }, - "IsTruncated": { - "target": "com.amazonaws.route53#PageTruncated", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A flag that indicates whether more resource record sets remain to be listed. If your\n\t\t\tresults were truncated, you can make a follow-up pagination request by using the\n\t\t\t\tNextRecordName element.

", - "smithy.api#required": {} - } - }, - "NextRecordName": { - "target": "com.amazonaws.route53#DNSName", - "traits": { - "smithy.api#documentation": "

If the results were truncated, the name of the next record in the list.

\n\t\t

This element is present only if IsTruncated is true.

" - } - }, - "NextRecordType": { - "target": "com.amazonaws.route53#RRType", - "traits": { - "smithy.api#documentation": "

If the results were truncated, the type of the next record in the list.

\n\t\t

This element is present only if IsTruncated is true.

" - } - }, - "NextRecordIdentifier": { - "target": "com.amazonaws.route53#ResourceRecordSetIdentifier", - "traits": { - "smithy.api#documentation": "

\n Resource record sets that have a routing policy other than\n\t\t\t\tsimple: If results were truncated for a given DNS name and type, the\n\t\t\tvalue of SetIdentifier for the next resource record set that has the\n\t\t\tcurrent DNS name and type.

\n\t\t

For information about routing policies, see Choosing a Routing\n\t\t\t\tPolicy in the Amazon Route 53 Developer Guide.

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

The maximum number of records you requested.

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

A complex type that contains list information for the resource record set.

" - } - }, - "com.amazonaws.route53#ListReusableDelegationSets": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#ListReusableDelegationSetsRequest" - }, - "output": { - "target": "com.amazonaws.route53#ListReusableDelegationSetsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#InvalidInput" - } - ], - "traits": { - "smithy.api#documentation": "

Retrieves a list of the reusable delegation sets that are associated with the current\n\t\t\t\tAmazon Web Services account.

", - "smithy.api#http": { - "method": "GET", - "uri": "/2013-04-01/delegationset", - "code": 200 - } - } - }, - "com.amazonaws.route53#ListReusableDelegationSetsRequest": { - "type": "structure", - "members": { - "Marker": { - "target": "com.amazonaws.route53#PageMarker", - "traits": { - "smithy.api#documentation": "

If the value of IsTruncated in the previous response was\n\t\t\t\ttrue, you have more reusable delegation sets. To get another group,\n\t\t\tsubmit another ListReusableDelegationSets request.

\n\t\t

For the value of marker, specify the value of NextMarker\n\t\t\tfrom the previous response, which is the ID of the first reusable delegation set that\n\t\t\tAmazon Route 53 will return if you submit another request.

\n\t\t

If the value of IsTruncated in the previous response was\n\t\t\t\tfalse, there are no more reusable delegation sets to get.

", - "smithy.api#httpQuery": "marker" - } - }, - "MaxItems": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#documentation": "

The number of reusable delegation sets that you want Amazon Route 53 to return in the\n\t\t\tresponse to this request. If you specify a value greater than 100, Route 53 returns only\n\t\t\tthe first 100 reusable delegation sets.

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

A request to get a list of the reusable delegation sets that are associated with the\n\t\t\tcurrent Amazon Web Services account.

" - } - }, - "com.amazonaws.route53#ListReusableDelegationSetsResponse": { - "type": "structure", - "members": { - "DelegationSets": { - "target": "com.amazonaws.route53#DelegationSets", - "traits": { - "smithy.api#documentation": "

A complex type that contains one DelegationSet element for each reusable\n\t\t\tdelegation set that was created by the current Amazon Web Services account.

", - "smithy.api#required": {} - } - }, - "Marker": { - "target": "com.amazonaws.route53#PageMarker", - "traits": { - "smithy.api#documentation": "

For the second and subsequent calls to ListReusableDelegationSets,\n\t\t\t\tMarker is the value that you specified for the marker\n\t\t\tparameter in the request that produced the current response.

", - "smithy.api#required": {} - } - }, - "IsTruncated": { - "target": "com.amazonaws.route53#PageTruncated", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A flag that indicates whether there are more reusable delegation sets to be\n\t\t\tlisted.

", - "smithy.api#required": {} - } - }, - "NextMarker": { - "target": "com.amazonaws.route53#PageMarker", - "traits": { - "smithy.api#documentation": "

If IsTruncated is true, the value of NextMarker\n\t\t\tidentifies the next reusable delegation set that Amazon Route 53 will return if you\n\t\t\tsubmit another ListReusableDelegationSets request and specify the value of\n\t\t\t\tNextMarker in the marker parameter.

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

The value that you specified for the maxitems parameter in the call to\n\t\t\t\tListReusableDelegationSets that produced the current response.

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

A complex type that contains information about the reusable delegation sets that are\n\t\t\tassociated with the current Amazon Web Services account.

" - } - }, - "com.amazonaws.route53#ListTagsForResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#ListTagsForResourceRequest" - }, - "output": { - "target": "com.amazonaws.route53#ListTagsForResourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#NoSuchHealthCheck" - }, - { - "target": "com.amazonaws.route53#NoSuchHostedZone" - }, - { - "target": "com.amazonaws.route53#PriorRequestNotComplete" - }, - { - "target": "com.amazonaws.route53#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists tags for one health check or hosted zone.

\n\t\t

For information about using tags for cost allocation, see Using Cost Allocation\n\t\t\t\tTags in the Billing and Cost Management User Guide.

", - "smithy.api#http": { - "method": "GET", - "uri": "/2013-04-01/tags/{ResourceType}/{ResourceId}", - "code": 200 - } - } - }, - "com.amazonaws.route53#ListTagsForResourceRequest": { - "type": "structure", - "members": { - "ResourceType": { - "target": "com.amazonaws.route53#TagResourceType", - "traits": { - "smithy.api#documentation": "

The type of the resource.

\n\t\t ", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ResourceId": { - "target": "com.amazonaws.route53#TagResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the resource for which you want to retrieve tags.

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

A complex type containing information about a request for a list of the tags that are\n\t\t\tassociated with an individual resource.

" - } - }, - "com.amazonaws.route53#ListTagsForResourceResponse": { - "type": "structure", - "members": { - "ResourceTagSet": { - "target": "com.amazonaws.route53#ResourceTagSet", - "traits": { - "smithy.api#documentation": "

A ResourceTagSet containing tags associated with the specified\n\t\t\tresource.

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

A complex type that contains information about the health checks or hosted zones for\n\t\t\twhich you want to list tags.

" - } - }, - "com.amazonaws.route53#ListTagsForResources": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#ListTagsForResourcesRequest" - }, - "output": { - "target": "com.amazonaws.route53#ListTagsForResourcesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#NoSuchHealthCheck" - }, - { - "target": "com.amazonaws.route53#NoSuchHostedZone" - }, - { - "target": "com.amazonaws.route53#PriorRequestNotComplete" - }, - { - "target": "com.amazonaws.route53#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists tags for up to 10 health checks or hosted zones.

\n\t\t

For information about using tags for cost allocation, see Using Cost Allocation\n\t\t\t\tTags in the Billing and Cost Management User Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/2013-04-01/tags/{ResourceType}", - "code": 200 - } - } - }, - "com.amazonaws.route53#ListTagsForResourcesRequest": { - "type": "structure", - "members": { - "ResourceType": { - "target": "com.amazonaws.route53#TagResourceType", - "traits": { - "smithy.api#documentation": "

The type of the resources.

\n\t\t ", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ResourceIds": { - "target": "com.amazonaws.route53#TagResourceIdList", - "traits": { - "smithy.api#documentation": "

A complex type that contains the ResourceId element for each resource for which you\n\t\t\twant to get a list of tags.

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

A complex type that contains information about the health checks or hosted zones for\n\t\t\twhich you want to list tags.

" - } - }, - "com.amazonaws.route53#ListTagsForResourcesResponse": { - "type": "structure", - "members": { - "ResourceTagSets": { - "target": "com.amazonaws.route53#ResourceTagSetList", - "traits": { - "smithy.api#documentation": "

A list of ResourceTagSets containing tags associated with the specified\n\t\t\tresources.

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

A complex type containing tags for the specified resources.

" - } - }, - "com.amazonaws.route53#ListTrafficPolicies": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#ListTrafficPoliciesRequest" - }, - "output": { - "target": "com.amazonaws.route53#ListTrafficPoliciesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#InvalidInput" - } - ], - "traits": { - "smithy.api#documentation": "

Gets information about the latest version for every traffic policy that is associated\n\t\t\twith the current Amazon Web Services account. Policies are listed in the order that they\n\t\t\twere created in.

\n\t\t

For information about how of deleting a traffic policy affects the response from\n\t\t\t\tListTrafficPolicies, see DeleteTrafficPolicy.

", - "smithy.api#http": { - "method": "GET", - "uri": "/2013-04-01/trafficpolicies", - "code": 200 - } - } - }, - "com.amazonaws.route53#ListTrafficPoliciesRequest": { - "type": "structure", - "members": { - "TrafficPolicyIdMarker": { - "target": "com.amazonaws.route53#TrafficPolicyId", - "traits": { - "smithy.api#documentation": "

(Conditional) For your first request to ListTrafficPolicies, don't\n\t\t\tinclude the TrafficPolicyIdMarker parameter.

\n\t\t

If you have more traffic policies than the value of MaxItems,\n\t\t\t\tListTrafficPolicies returns only the first MaxItems\n\t\t\ttraffic policies. To get the next group of policies, submit another request to\n\t\t\t\tListTrafficPolicies. For the value of\n\t\t\t\tTrafficPolicyIdMarker, specify the value of\n\t\t\t\tTrafficPolicyIdMarker that was returned in the previous\n\t\t\tresponse.

", - "smithy.api#httpQuery": "trafficpolicyid" - } - }, - "MaxItems": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#documentation": "

(Optional) The maximum number of traffic policies that you want Amazon Route 53 to\n\t\t\treturn in response to this request. If you have more than MaxItems traffic\n\t\t\tpolicies, the value of IsTruncated in the response is true,\n\t\t\tand the value of TrafficPolicyIdMarker is the ID of the first traffic\n\t\t\tpolicy that Route 53 will return if you submit another request.

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

A complex type that contains the information about the request to list the traffic\n\t\t\tpolicies that are associated with the current Amazon Web Services account.

" - } - }, - "com.amazonaws.route53#ListTrafficPoliciesResponse": { - "type": "structure", - "members": { - "TrafficPolicySummaries": { - "target": "com.amazonaws.route53#TrafficPolicySummaries", - "traits": { - "smithy.api#documentation": "

A list that contains one TrafficPolicySummary element for each traffic\n\t\t\tpolicy that was created by the current Amazon Web Services account.

", - "smithy.api#required": {} - } - }, - "IsTruncated": { - "target": "com.amazonaws.route53#PageTruncated", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A flag that indicates whether there are more traffic policies to be listed. If the\n\t\t\tresponse was truncated, you can get the next group of traffic policies by submitting\n\t\t\tanother ListTrafficPolicies request and specifying the value of\n\t\t\t\tTrafficPolicyIdMarker in the TrafficPolicyIdMarker request\n\t\t\tparameter.

", - "smithy.api#required": {} - } - }, - "TrafficPolicyIdMarker": { - "target": "com.amazonaws.route53#TrafficPolicyId", - "traits": { - "smithy.api#documentation": "

If the value of IsTruncated is true,\n\t\t\t\tTrafficPolicyIdMarker is the ID of the first traffic policy in the next\n\t\t\tgroup of MaxItems traffic policies.

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

The value that you specified for the MaxItems parameter in the\n\t\t\t\tListTrafficPolicies request that produced the current response.

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

A complex type that contains the response information for the request.

" - } - }, - "com.amazonaws.route53#ListTrafficPolicyInstances": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#ListTrafficPolicyInstancesRequest" - }, - "output": { - "target": "com.amazonaws.route53#ListTrafficPolicyInstancesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#NoSuchTrafficPolicyInstance" - } - ], - "traits": { - "smithy.api#documentation": "

Gets information about the traffic policy instances that you created by using the\n\t\t\tcurrent Amazon Web Services account.

\n\t\t \n\t\t\t

After you submit an UpdateTrafficPolicyInstance request, there's a\n\t\t\t\tbrief delay while Amazon Route 53 creates the resource record sets that are\n\t\t\t\tspecified in the traffic policy definition. For more information, see the\n\t\t\t\t\tState response element.

\n\t\t \n\t\t

Route 53 returns a maximum of 100 items in each response. If you have a lot of traffic\n\t\t\tpolicy instances, you can use the MaxItems parameter to list them in groups\n\t\t\tof up to 100.

", - "smithy.api#http": { - "method": "GET", - "uri": "/2013-04-01/trafficpolicyinstances", - "code": 200 - } - } - }, - "com.amazonaws.route53#ListTrafficPolicyInstancesByHostedZone": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#ListTrafficPolicyInstancesByHostedZoneRequest" - }, - "output": { - "target": "com.amazonaws.route53#ListTrafficPolicyInstancesByHostedZoneResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#NoSuchHostedZone" - }, - { - "target": "com.amazonaws.route53#NoSuchTrafficPolicyInstance" - } - ], - "traits": { - "smithy.api#documentation": "

Gets information about the traffic policy instances that you created in a specified\n\t\t\thosted zone.

\n\t\t \n\t\t\t

After you submit a CreateTrafficPolicyInstance or an\n\t\t\t\t\tUpdateTrafficPolicyInstance request, there's a brief delay while\n\t\t\t\tAmazon Route 53 creates the resource record sets that are specified in the traffic\n\t\t\t\tpolicy definition. For more information, see the State response\n\t\t\t\telement.

\n\t\t \n\t\t

Route 53 returns a maximum of 100 items in each response. If you have a lot of traffic\n\t\t\tpolicy instances, you can use the MaxItems parameter to list them in groups\n\t\t\tof up to 100.

", - "smithy.api#http": { - "method": "GET", - "uri": "/2013-04-01/trafficpolicyinstances/hostedzone", - "code": 200 - } - } - }, - "com.amazonaws.route53#ListTrafficPolicyInstancesByHostedZoneRequest": { - "type": "structure", - "members": { - "HostedZoneId": { - "target": "com.amazonaws.route53#ResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the hosted zone that you want to list traffic policy instances for.

", - "smithy.api#httpQuery": "id", - "smithy.api#required": {} - } - }, - "TrafficPolicyInstanceNameMarker": { - "target": "com.amazonaws.route53#DNSName", - "traits": { - "smithy.api#documentation": "

If the value of IsTruncated in the previous response is true, you have\n\t\t\tmore traffic policy instances. To get more traffic policy instances, submit another\n\t\t\t\tListTrafficPolicyInstances request. For the value of\n\t\t\t\ttrafficpolicyinstancename, specify the value of\n\t\t\t\tTrafficPolicyInstanceNameMarker from the previous response, which is\n\t\t\tthe name of the first traffic policy instance in the next group of traffic policy\n\t\t\tinstances.

\n\t\t

If the value of IsTruncated in the previous response was\n\t\t\t\tfalse, there are no more traffic policy instances to get.

", - "smithy.api#httpQuery": "trafficpolicyinstancename" - } - }, - "TrafficPolicyInstanceTypeMarker": { - "target": "com.amazonaws.route53#RRType", - "traits": { - "smithy.api#documentation": "

If the value of IsTruncated in the previous response is true, you have\n\t\t\tmore traffic policy instances. To get more traffic policy instances, submit another\n\t\t\t\tListTrafficPolicyInstances request. For the value of\n\t\t\t\ttrafficpolicyinstancetype, specify the value of\n\t\t\t\tTrafficPolicyInstanceTypeMarker from the previous response, which is\n\t\t\tthe type of the first traffic policy instance in the next group of traffic policy\n\t\t\tinstances.

\n\t\t

If the value of IsTruncated in the previous response was\n\t\t\t\tfalse, there are no more traffic policy instances to get.

", - "smithy.api#httpQuery": "trafficpolicyinstancetype" - } - }, - "MaxItems": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#documentation": "

The maximum number of traffic policy instances to be included in the response body for\n\t\t\tthis request. If you have more than MaxItems traffic policy instances, the\n\t\t\tvalue of the IsTruncated element in the response is true, and\n\t\t\tthe values of HostedZoneIdMarker,\n\t\t\t\tTrafficPolicyInstanceNameMarker, and\n\t\t\t\tTrafficPolicyInstanceTypeMarker represent the first traffic policy\n\t\t\tinstance that Amazon Route 53 will return if you submit another request.

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

A request for the traffic policy instances that you created in a specified hosted\n\t\t\tzone.

" - } - }, - "com.amazonaws.route53#ListTrafficPolicyInstancesByHostedZoneResponse": { - "type": "structure", - "members": { - "TrafficPolicyInstances": { - "target": "com.amazonaws.route53#TrafficPolicyInstances", - "traits": { - "smithy.api#documentation": "

A list that contains one TrafficPolicyInstance element for each traffic\n\t\t\tpolicy instance that matches the elements in the request.

", - "smithy.api#required": {} - } - }, - "TrafficPolicyInstanceNameMarker": { - "target": "com.amazonaws.route53#DNSName", - "traits": { - "smithy.api#documentation": "

If IsTruncated is true,\n\t\t\t\tTrafficPolicyInstanceNameMarker is the name of the first traffic policy\n\t\t\tinstance in the next group of traffic policy instances.

" - } - }, - "TrafficPolicyInstanceTypeMarker": { - "target": "com.amazonaws.route53#RRType", - "traits": { - "smithy.api#documentation": "

If IsTruncated is true, TrafficPolicyInstanceTypeMarker is\n\t\t\tthe DNS type of the resource record sets that are associated with the first traffic\n\t\t\tpolicy instance in the next group of traffic policy instances.

" - } - }, - "IsTruncated": { - "target": "com.amazonaws.route53#PageTruncated", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A flag that indicates whether there are more traffic policy instances to be listed. If\n\t\t\tthe response was truncated, you can get the next group of traffic policy instances by\n\t\t\tsubmitting another ListTrafficPolicyInstancesByHostedZone request and\n\t\t\tspecifying the values of HostedZoneIdMarker,\n\t\t\t\tTrafficPolicyInstanceNameMarker, and\n\t\t\t\tTrafficPolicyInstanceTypeMarker in the corresponding request\n\t\t\tparameters.

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

The value that you specified for the MaxItems parameter in the\n\t\t\t\tListTrafficPolicyInstancesByHostedZone request that produced the\n\t\t\tcurrent response.

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

A complex type that contains the response information for the request.

" - } - }, - "com.amazonaws.route53#ListTrafficPolicyInstancesByPolicy": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#ListTrafficPolicyInstancesByPolicyRequest" - }, - "output": { - "target": "com.amazonaws.route53#ListTrafficPolicyInstancesByPolicyResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#NoSuchTrafficPolicy" - }, - { - "target": "com.amazonaws.route53#NoSuchTrafficPolicyInstance" - } - ], - "traits": { - "smithy.api#documentation": "

Gets information about the traffic policy instances that you created by using a\n\t\t\tspecify traffic policy version.

\n\t\t \n\t\t\t

After you submit a CreateTrafficPolicyInstance or an\n\t\t\t\t\tUpdateTrafficPolicyInstance request, there's a brief delay while\n\t\t\t\tAmazon Route 53 creates the resource record sets that are specified in the traffic\n\t\t\t\tpolicy definition. For more information, see the State response\n\t\t\t\telement.

\n\t\t \n\t\t

Route 53 returns a maximum of 100 items in each response. If you have a lot of traffic\n\t\t\tpolicy instances, you can use the MaxItems parameter to list them in groups\n\t\t\tof up to 100.

", - "smithy.api#http": { - "method": "GET", - "uri": "/2013-04-01/trafficpolicyinstances/trafficpolicy", - "code": 200 - } - } - }, - "com.amazonaws.route53#ListTrafficPolicyInstancesByPolicyRequest": { - "type": "structure", - "members": { - "TrafficPolicyId": { - "target": "com.amazonaws.route53#TrafficPolicyId", - "traits": { - "smithy.api#documentation": "

The ID of the traffic policy for which you want to list traffic policy\n\t\t\tinstances.

", - "smithy.api#httpQuery": "id", - "smithy.api#required": {} - } - }, - "TrafficPolicyVersion": { - "target": "com.amazonaws.route53#TrafficPolicyVersion", - "traits": { - "smithy.api#documentation": "

The version of the traffic policy for which you want to list traffic policy instances.\n\t\t\tThe version must be associated with the traffic policy that is specified by\n\t\t\t\tTrafficPolicyId.

", - "smithy.api#httpQuery": "version", - "smithy.api#required": {} - } - }, - "HostedZoneIdMarker": { - "target": "com.amazonaws.route53#ResourceId", - "traits": { - "smithy.api#documentation": "

If the value of IsTruncated in the previous response was\n\t\t\t\ttrue, you have more traffic policy instances. To get more traffic\n\t\t\tpolicy instances, submit another ListTrafficPolicyInstancesByPolicy\n\t\t\trequest.

\n\t\t

For the value of hostedzoneid, specify the value of\n\t\t\t\tHostedZoneIdMarker from the previous response, which is the hosted zone\n\t\t\tID of the first traffic policy instance that Amazon Route 53 will return if you submit\n\t\t\tanother request.

\n\t\t

If the value of IsTruncated in the previous response was\n\t\t\t\tfalse, there are no more traffic policy instances to get.

", - "smithy.api#httpQuery": "hostedzoneid" - } - }, - "TrafficPolicyInstanceNameMarker": { - "target": "com.amazonaws.route53#DNSName", - "traits": { - "smithy.api#documentation": "

If the value of IsTruncated in the previous response was\n\t\t\t\ttrue, you have more traffic policy instances. To get more traffic\n\t\t\tpolicy instances, submit another ListTrafficPolicyInstancesByPolicy\n\t\t\trequest.

\n\t\t

For the value of trafficpolicyinstancename, specify the value of\n\t\t\t\tTrafficPolicyInstanceNameMarker from the previous response, which is\n\t\t\tthe name of the first traffic policy instance that Amazon Route 53 will return if you\n\t\t\tsubmit another request.

\n\t\t

If the value of IsTruncated in the previous response was\n\t\t\t\tfalse, there are no more traffic policy instances to get.

", - "smithy.api#httpQuery": "trafficpolicyinstancename" - } - }, - "TrafficPolicyInstanceTypeMarker": { - "target": "com.amazonaws.route53#RRType", - "traits": { - "smithy.api#documentation": "

If the value of IsTruncated in the previous response was\n\t\t\t\ttrue, you have more traffic policy instances. To get more traffic\n\t\t\tpolicy instances, submit another ListTrafficPolicyInstancesByPolicy\n\t\t\trequest.

\n\t\t

For the value of trafficpolicyinstancetype, specify the value of\n\t\t\t\tTrafficPolicyInstanceTypeMarker from the previous response, which is\n\t\t\tthe name of the first traffic policy instance that Amazon Route 53 will return if you\n\t\t\tsubmit another request.

\n\t\t

If the value of IsTruncated in the previous response was\n\t\t\t\tfalse, there are no more traffic policy instances to get.

", - "smithy.api#httpQuery": "trafficpolicyinstancetype" - } - }, - "MaxItems": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#documentation": "

The maximum number of traffic policy instances to be included in the response body for\n\t\t\tthis request. If you have more than MaxItems traffic policy instances, the\n\t\t\tvalue of the IsTruncated element in the response is true, and\n\t\t\tthe values of HostedZoneIdMarker,\n\t\t\t\tTrafficPolicyInstanceNameMarker, and\n\t\t\t\tTrafficPolicyInstanceTypeMarker represent the first traffic policy\n\t\t\tinstance that Amazon Route 53 will return if you submit another request.

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

A complex type that contains the information about the request to list your traffic\n\t\t\tpolicy instances.

" - } - }, - "com.amazonaws.route53#ListTrafficPolicyInstancesByPolicyResponse": { - "type": "structure", - "members": { - "TrafficPolicyInstances": { - "target": "com.amazonaws.route53#TrafficPolicyInstances", - "traits": { - "smithy.api#documentation": "

A list that contains one TrafficPolicyInstance element for each traffic\n\t\t\tpolicy instance that matches the elements in the request.

", - "smithy.api#required": {} - } - }, - "HostedZoneIdMarker": { - "target": "com.amazonaws.route53#ResourceId", - "traits": { - "smithy.api#documentation": "

If IsTruncated is true, HostedZoneIdMarker is\n\t\t\tthe ID of the hosted zone of the first traffic policy instance in the next group of\n\t\t\ttraffic policy instances.

" - } - }, - "TrafficPolicyInstanceNameMarker": { - "target": "com.amazonaws.route53#DNSName", - "traits": { - "smithy.api#documentation": "

If IsTruncated is true,\n\t\t\t\tTrafficPolicyInstanceNameMarker is the name of the first traffic policy\n\t\t\tinstance in the next group of MaxItems traffic policy instances.

" - } - }, - "TrafficPolicyInstanceTypeMarker": { - "target": "com.amazonaws.route53#RRType", - "traits": { - "smithy.api#documentation": "

If IsTruncated is true,\n\t\t\t\tTrafficPolicyInstanceTypeMarker is the DNS type of the resource record\n\t\t\tsets that are associated with the first traffic policy instance in the next group of\n\t\t\t\tMaxItems traffic policy instances.

" - } - }, - "IsTruncated": { - "target": "com.amazonaws.route53#PageTruncated", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A flag that indicates whether there are more traffic policy instances to be listed. If\n\t\t\tthe response was truncated, you can get the next group of traffic policy instances by\n\t\t\tcalling ListTrafficPolicyInstancesByPolicy again and specifying the values\n\t\t\tof the HostedZoneIdMarker, TrafficPolicyInstanceNameMarker,\n\t\t\tand TrafficPolicyInstanceTypeMarker elements in the corresponding request\n\t\t\tparameters.

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

The value that you specified for the MaxItems parameter in the call to\n\t\t\t\tListTrafficPolicyInstancesByPolicy that produced the current\n\t\t\tresponse.

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

A complex type that contains the response information for the request.

" - } - }, - "com.amazonaws.route53#ListTrafficPolicyInstancesRequest": { - "type": "structure", - "members": { - "HostedZoneIdMarker": { - "target": "com.amazonaws.route53#ResourceId", - "traits": { - "smithy.api#documentation": "

If the value of IsTruncated in the previous response was\n\t\t\t\ttrue, you have more traffic policy instances. To get more traffic\n\t\t\tpolicy instances, submit another ListTrafficPolicyInstances request. For\n\t\t\tthe value of HostedZoneId, specify the value of\n\t\t\t\tHostedZoneIdMarker from the previous response, which is the hosted zone\n\t\t\tID of the first traffic policy instance in the next group of traffic policy\n\t\t\tinstances.

\n\t\t

If the value of IsTruncated in the previous response was\n\t\t\t\tfalse, there are no more traffic policy instances to get.

", - "smithy.api#httpQuery": "hostedzoneid" - } - }, - "TrafficPolicyInstanceNameMarker": { - "target": "com.amazonaws.route53#DNSName", - "traits": { - "smithy.api#documentation": "

If the value of IsTruncated in the previous response was\n\t\t\t\ttrue, you have more traffic policy instances. To get more traffic\n\t\t\tpolicy instances, submit another ListTrafficPolicyInstances request. For\n\t\t\tthe value of trafficpolicyinstancename, specify the value of\n\t\t\t\tTrafficPolicyInstanceNameMarker from the previous response, which is\n\t\t\tthe name of the first traffic policy instance in the next group of traffic policy\n\t\t\tinstances.

\n\t\t

If the value of IsTruncated in the previous response was\n\t\t\t\tfalse, there are no more traffic policy instances to get.

", - "smithy.api#httpQuery": "trafficpolicyinstancename" - } - }, - "TrafficPolicyInstanceTypeMarker": { - "target": "com.amazonaws.route53#RRType", - "traits": { - "smithy.api#documentation": "

If the value of IsTruncated in the previous response was\n\t\t\t\ttrue, you have more traffic policy instances. To get more traffic\n\t\t\tpolicy instances, submit another ListTrafficPolicyInstances request. For\n\t\t\tthe value of trafficpolicyinstancetype, specify the value of\n\t\t\t\tTrafficPolicyInstanceTypeMarker from the previous response, which is\n\t\t\tthe type of the first traffic policy instance in the next group of traffic policy\n\t\t\tinstances.

\n\t\t

If the value of IsTruncated in the previous response was\n\t\t\t\tfalse, there are no more traffic policy instances to get.

", - "smithy.api#httpQuery": "trafficpolicyinstancetype" - } - }, - "MaxItems": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#documentation": "

The maximum number of traffic policy instances that you want Amazon Route 53 to return\n\t\t\tin response to a ListTrafficPolicyInstances request. If you have more than\n\t\t\t\tMaxItems traffic policy instances, the value of the\n\t\t\t\tIsTruncated element in the response is true, and the\n\t\t\tvalues of HostedZoneIdMarker, TrafficPolicyInstanceNameMarker,\n\t\t\tand TrafficPolicyInstanceTypeMarker represent the first traffic policy\n\t\t\tinstance in the next group of MaxItems traffic policy instances.

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

A request to get information about the traffic policy instances that you created by\n\t\t\tusing the current Amazon Web Services account.

" - } - }, - "com.amazonaws.route53#ListTrafficPolicyInstancesResponse": { - "type": "structure", - "members": { - "TrafficPolicyInstances": { - "target": "com.amazonaws.route53#TrafficPolicyInstances", - "traits": { - "smithy.api#documentation": "

A list that contains one TrafficPolicyInstance element for each traffic\n\t\t\tpolicy instance that matches the elements in the request.

", - "smithy.api#required": {} - } - }, - "HostedZoneIdMarker": { - "target": "com.amazonaws.route53#ResourceId", - "traits": { - "smithy.api#documentation": "

If IsTruncated is true, HostedZoneIdMarker is\n\t\t\tthe ID of the hosted zone of the first traffic policy instance that Route 53 will return\n\t\t\tif you submit another ListTrafficPolicyInstances request.

" - } - }, - "TrafficPolicyInstanceNameMarker": { - "target": "com.amazonaws.route53#DNSName", - "traits": { - "smithy.api#documentation": "

If IsTruncated is true,\n\t\t\t\tTrafficPolicyInstanceNameMarker is the name of the first traffic policy\n\t\t\tinstance that Route 53 will return if you submit another\n\t\t\t\tListTrafficPolicyInstances request.

" - } - }, - "TrafficPolicyInstanceTypeMarker": { - "target": "com.amazonaws.route53#RRType", - "traits": { - "smithy.api#documentation": "

If IsTruncated is true,\n\t\t\t\tTrafficPolicyInstanceTypeMarker is the DNS type of the resource record\n\t\t\tsets that are associated with the first traffic policy instance that Amazon Route 53\n\t\t\twill return if you submit another ListTrafficPolicyInstances request.\n\t\t

" - } - }, - "IsTruncated": { - "target": "com.amazonaws.route53#PageTruncated", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A flag that indicates whether there are more traffic policy instances to be listed. If\n\t\t\tthe response was truncated, you can get more traffic policy instances by calling\n\t\t\t\tListTrafficPolicyInstances again and specifying the values of the\n\t\t\t\tHostedZoneIdMarker, TrafficPolicyInstanceNameMarker, and\n\t\t\t\tTrafficPolicyInstanceTypeMarker in the corresponding request\n\t\t\tparameters.

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

The value that you specified for the MaxItems parameter in the call to\n\t\t\t\tListTrafficPolicyInstances that produced the current response.

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

A complex type that contains the response information for the request.

" - } - }, - "com.amazonaws.route53#ListTrafficPolicyVersions": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#ListTrafficPolicyVersionsRequest" - }, - "output": { - "target": "com.amazonaws.route53#ListTrafficPolicyVersionsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#NoSuchTrafficPolicy" - } - ], - "traits": { - "smithy.api#documentation": "

Gets information about all of the versions for a specified traffic policy.

\n\t\t

Traffic policy versions are listed in numerical order by\n\t\t\tVersionNumber.

", - "smithy.api#http": { - "method": "GET", - "uri": "/2013-04-01/trafficpolicies/{Id}/versions", - "code": 200 - } - } - }, - "com.amazonaws.route53#ListTrafficPolicyVersionsRequest": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.route53#TrafficPolicyId", - "traits": { - "smithy.api#documentation": "

Specify the value of Id of the traffic policy for which you want to list\n\t\t\tall versions.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "TrafficPolicyVersionMarker": { - "target": "com.amazonaws.route53#TrafficPolicyVersionMarker", - "traits": { - "smithy.api#documentation": "

For your first request to ListTrafficPolicyVersions, don't include the\n\t\t\t\tTrafficPolicyVersionMarker parameter.

\n\t\t

If you have more traffic policy versions than the value of MaxItems,\n\t\t\t\tListTrafficPolicyVersions returns only the first group of\n\t\t\t\tMaxItems versions. To get more traffic policy versions, submit another\n\t\t\t\tListTrafficPolicyVersions request. For the value of\n\t\t\t\tTrafficPolicyVersionMarker, specify the value of\n\t\t\t\tTrafficPolicyVersionMarker in the previous response.

", - "smithy.api#httpQuery": "trafficpolicyversion" - } - }, - "MaxItems": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#documentation": "

The maximum number of traffic policy versions that you want Amazon Route 53 to include\n\t\t\tin the response body for this request. If the specified traffic policy has more than\n\t\t\t\tMaxItems versions, the value of IsTruncated in the\n\t\t\tresponse is true, and the value of the\n\t\t\t\tTrafficPolicyVersionMarker element is the ID of the first version that\n\t\t\tRoute 53 will return if you submit another request.

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

A complex type that contains the information about the request to list your traffic\n\t\t\tpolicies.

" - } - }, - "com.amazonaws.route53#ListTrafficPolicyVersionsResponse": { - "type": "structure", - "members": { - "TrafficPolicies": { - "target": "com.amazonaws.route53#TrafficPolicies", - "traits": { - "smithy.api#documentation": "

A list that contains one TrafficPolicy element for each traffic policy\n\t\t\tversion that is associated with the specified traffic policy.

", - "smithy.api#required": {} - } - }, - "IsTruncated": { - "target": "com.amazonaws.route53#PageTruncated", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A flag that indicates whether there are more traffic policies to be listed. If the\n\t\t\tresponse was truncated, you can get the next group of traffic policies by submitting\n\t\t\tanother ListTrafficPolicyVersions request and specifying the value of\n\t\t\t\tNextMarker in the marker parameter.

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

If IsTruncated is true, the value of\n\t\t\t\tTrafficPolicyVersionMarker identifies the first traffic policy that\n\t\t\tAmazon Route 53 will return if you submit another request. Call\n\t\t\t\tListTrafficPolicyVersions again and specify the value of\n\t\t\t\tTrafficPolicyVersionMarker in the\n\t\t\t\tTrafficPolicyVersionMarker request parameter.

\n\t\t

This element is present only if IsTruncated is true.

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

The value that you specified for the maxitems parameter in the\n\t\t\t\tListTrafficPolicyVersions request that produced the current\n\t\t\tresponse.

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

A complex type that contains the response information for the request.

" - } - }, - "com.amazonaws.route53#ListVPCAssociationAuthorizations": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#ListVPCAssociationAuthorizationsRequest" - }, - "output": { - "target": "com.amazonaws.route53#ListVPCAssociationAuthorizationsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#InvalidPaginationToken" - }, - { - "target": "com.amazonaws.route53#NoSuchHostedZone" - } - ], - "traits": { - "smithy.api#documentation": "

Gets a list of the VPCs that were created by other accounts and that can be associated\n\t\t\twith a specified hosted zone because you've submitted one or more\n\t\t\t\tCreateVPCAssociationAuthorization requests.

\n\t\t

The response includes a VPCs element with a VPC child\n\t\t\telement for each VPC that can be associated with the hosted zone.

", - "smithy.api#http": { - "method": "GET", - "uri": "/2013-04-01/hostedzone/{HostedZoneId}/authorizevpcassociation", - "code": 200 - } - } - }, - "com.amazonaws.route53#ListVPCAssociationAuthorizationsRequest": { - "type": "structure", - "members": { - "HostedZoneId": { - "target": "com.amazonaws.route53#ResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the hosted zone for which you want a list of VPCs that can be associated\n\t\t\twith the hosted zone.

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

\n Optional: If a response includes a NextToken\n\t\t\telement, there are more VPCs that can be associated with the specified hosted zone. To\n\t\t\tget the next page of results, submit another request, and include the value of\n\t\t\t\tNextToken from the response in the nexttoken parameter in\n\t\t\tanother ListVPCAssociationAuthorizations request.

", - "smithy.api#httpQuery": "nexttoken" - } - }, - "MaxResults": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#documentation": "

\n Optional: An integer that specifies the maximum number of VPCs\n\t\t\tthat you want Amazon Route 53 to return. If you don't specify a value for\n\t\t\t\tMaxResults, Route 53 returns up to 50 VPCs per page.

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

A complex type that contains information about that can be associated with your hosted\n\t\t\tzone.

" - } - }, - "com.amazonaws.route53#ListVPCAssociationAuthorizationsResponse": { - "type": "structure", - "members": { - "HostedZoneId": { - "target": "com.amazonaws.route53#ResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the hosted zone that you can associate the listed VPCs with.

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

When the response includes a NextToken element, there are more VPCs that\n\t\t\tcan be associated with the specified hosted zone. To get the next page of VPCs, submit\n\t\t\tanother ListVPCAssociationAuthorizations request, and include the value of\n\t\t\tthe NextToken element from the response in the nexttoken\n\t\t\trequest parameter.

" - } - }, - "VPCs": { - "target": "com.amazonaws.route53#VPCs", - "traits": { - "smithy.api#documentation": "

The list of VPCs that are authorized to be associated with the specified hosted\n\t\t\tzone.

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

A complex type that contains the response information for the request.

" - } - }, - "com.amazonaws.route53#LocationSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.route53#LocationSummary" - } - }, - "com.amazonaws.route53#LocationSummary": { - "type": "structure", - "members": { - "LocationName": { - "target": "com.amazonaws.route53#CidrLocationNameDefaultAllowed", - "traits": { - "smithy.api#documentation": "

A string that specifies a location name.

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

A complex type that contains information about the CIDR location.

" - } - }, - "com.amazonaws.route53#MeasureLatency": { - "type": "boolean" - }, - "com.amazonaws.route53#Message": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1024 - } - } - }, - "com.amazonaws.route53#MetricName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 255 - } - } - }, - "com.amazonaws.route53#Nameserver": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 255 - } - } - }, - "com.amazonaws.route53#Namespace": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 255 - } - } - }, - "com.amazonaws.route53#NoSuchChange": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "

A change with the specified change ID does not exist.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.route53#NoSuchCidrCollectionException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.route53#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "

The CIDR collection you specified, doesn't exist.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.route53#NoSuchCidrLocationException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.route53#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "

The CIDR collection location doesn't match any locations in your account.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.route53#NoSuchCloudWatchLogsLogGroup": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "

There is no CloudWatch Logs log group with the specified ARN.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.route53#NoSuchDelegationSet": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage", - "traits": { - "smithy.api#documentation": "

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

A reusable delegation set with the specified ID does not exist.

", - "smithy.api#error": "client" - } - }, - "com.amazonaws.route53#NoSuchGeoLocation": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage", - "traits": { - "smithy.api#documentation": "

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

Amazon Route 53 doesn't support the specified geographic location. For a list of\n\t\t\tsupported geolocation codes, see the GeoLocation data\n\t\t\ttype.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.route53#NoSuchHealthCheck": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage", - "traits": { - "smithy.api#documentation": "

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

No health check exists with the specified ID.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.route53#NoSuchHostedZone": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage", - "traits": { - "smithy.api#documentation": "

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

No hosted zone exists with the ID that you specified.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.route53#NoSuchKeySigningKey": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "

The specified key-signing key (KSK) doesn't exist.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.route53#NoSuchQueryLoggingConfig": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "

There is no DNS query logging configuration with the specified ID.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.route53#NoSuchTrafficPolicy": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage", - "traits": { - "smithy.api#documentation": "

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

No traffic policy exists with the specified ID.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.route53#NoSuchTrafficPolicyInstance": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage", - "traits": { - "smithy.api#documentation": "

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

No traffic policy instance exists with the specified ID.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.route53#Nonce": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - } - } - }, - "com.amazonaws.route53#NotAuthorizedException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage", - "traits": { - "smithy.api#documentation": "

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

Associating the specified VPC with the specified hosted zone has not been\n\t\t\tauthorized.

", - "smithy.api#error": "client", - "smithy.api#httpError": 401 - } - }, - "com.amazonaws.route53#PageMarker": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 64 - } - } - }, - "com.amazonaws.route53#PageTruncated": { - "type": "boolean", - "traits": { - "smithy.api#default": false - } - }, - "com.amazonaws.route53#PaginationToken": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1024 - } - } - }, - "com.amazonaws.route53#Period": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 60 - } - } - }, - "com.amazonaws.route53#Port": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 65535 - } - } - }, - "com.amazonaws.route53#PriorRequestNotComplete": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "

If Amazon Route 53 can't process a request before the next request arrives, it will\n\t\t\treject subsequent requests for the same hosted zone and return an HTTP 400\n\t\t\t\terror (Bad request). If Route 53 returns this error repeatedly\n\t\t\tfor the same request, we recommend that you wait, in intervals of increasing duration,\n\t\t\tbefore you try the request again.

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

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

You're trying to associate a VPC with a public hosted zone. Amazon Route 53 doesn't\n\t\t\tsupport associating a VPC with a public hosted zone.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.route53#QueryLoggingConfig": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.route53#QueryLoggingConfigId", - "traits": { - "smithy.api#documentation": "

The ID for a configuration for DNS query logging.

", - "smithy.api#required": {} - } - }, - "HostedZoneId": { - "target": "com.amazonaws.route53#ResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the hosted zone that CloudWatch Logs is logging queries for.

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

The Amazon Resource Name (ARN) of the CloudWatch Logs log group that Amazon Route 53\n\t\t\tis publishing logs to.

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

A complex type that contains information about a configuration for DNS query\n\t\t\tlogging.

" - } - }, - "com.amazonaws.route53#QueryLoggingConfigAlreadyExists": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "

You can create only one query logging configuration for a hosted zone, and a query\n\t\t\tlogging configuration already exists for this hosted zone.

", - "smithy.api#error": "client", - "smithy.api#httpError": 409 - } - }, - "com.amazonaws.route53#QueryLoggingConfigId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 36 - } - } - }, - "com.amazonaws.route53#QueryLoggingConfigs": { - "type": "list", - "member": { - "target": "com.amazonaws.route53#QueryLoggingConfig", - "traits": { - "smithy.api#xmlName": "QueryLoggingConfig" - } - } - }, - "com.amazonaws.route53#RData": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 4000 - } - } - }, - "com.amazonaws.route53#RRType": { - "type": "enum", - "members": { - "SOA": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SOA" - } - }, - "A": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "A" - } - }, - "TXT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TXT" - } - }, - "NS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NS" - } - }, - "CNAME": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CNAME" - } - }, - "MX": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MX" - } - }, - "NAPTR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NAPTR" - } - }, - "PTR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PTR" - } - }, - "SRV": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SRV" - } - }, - "SPF": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SPF" - } - }, - "AAAA": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AAAA" - } - }, - "CAA": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CAA" - } - }, - "DS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DS" - } - } - } - }, - "com.amazonaws.route53#RecordData": { - "type": "list", - "member": { - "target": "com.amazonaws.route53#RecordDataEntry", - "traits": { - "smithy.api#xmlName": "RecordDataEntry" - } - } - }, - "com.amazonaws.route53#RecordDataEntry": { - "type": "string", - "traits": { - "smithy.api#documentation": "

A value that Amazon Route 53 returned for this resource record set. A\n\t\t\t\tRecordDataEntry element is one of the following:

\n\t\t ", - "smithy.api#length": { - "min": 0, - "max": 512 - } - } - }, - "com.amazonaws.route53#RequestInterval": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 10, - "max": 30 - } - } - }, - "com.amazonaws.route53#ResettableElementName": { - "type": "enum", - "members": { - "FullyQualifiedDomainName": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FullyQualifiedDomainName" - } - }, - "Regions": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Regions" - } - }, - "ResourcePath": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ResourcePath" - } - }, - "ChildHealthChecks": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ChildHealthChecks" - } - } - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - } - } - }, - "com.amazonaws.route53#ResettableElementNameList": { - "type": "list", - "member": { - "target": "com.amazonaws.route53#ResettableElementName", - "traits": { - "smithy.api#xmlName": "ResettableElementName" - } - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 64 - } - } - }, - "com.amazonaws.route53#ResourceDescription": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - } - } - }, - "com.amazonaws.route53#ResourceId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 32 - } - } - }, - "com.amazonaws.route53#ResourcePath": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 255 - } - } - }, - "com.amazonaws.route53#ResourceRecord": { - "type": "structure", - "members": { - "Value": { - "target": "com.amazonaws.route53#RData", - "traits": { - "smithy.api#documentation": "

The current or new DNS record value, not to exceed 4,000 characters. In the case of a\n\t\t\t\tDELETE action, if the current value does not match the actual value, an\n\t\t\terror is returned. For descriptions about how to format Value for different\n\t\t\trecord types, see Supported DNS Resource\n\t\t\t\tRecord Types in the Amazon Route 53 Developer\n\t\t\tGuide.

\n\t\t

You can specify more than one value for all record types except CNAME and\n\t\t\t\tSOA.

\n\t\t \n\t\t\t

If you're creating an alias resource record set, omit Value.

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

Information specific to the resource record.

\n\t\t \n\t\t\t

If you're creating an alias resource record set, omit\n\t\t\t\tResourceRecord.

\n\t\t " - } - }, - "com.amazonaws.route53#ResourceRecordSet": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.route53#DNSName", - "traits": { - "smithy.api#documentation": "

For ChangeResourceRecordSets requests, the name of the record that you\n\t\t\twant to create, update, or delete. For ListResourceRecordSets responses,\n\t\t\tthe name of a record in the specified hosted zone.

\n\t\t

\n ChangeResourceRecordSets Only\n

\n\t\t

Enter a fully qualified domain name, for example, www.example.com. You\n\t\t\tcan optionally include a trailing dot. If you omit the trailing dot, Amazon Route 53\n\t\t\tassumes that the domain name that you specify is fully qualified. This means that Route\n\t\t\t53 treats www.example.com (without a trailing dot) and\n\t\t\t\twww.example.com. (with a trailing dot) as identical.

\n\t\t

For information about how to specify characters other than a-z,\n\t\t\t\t0-9, and - (hyphen) and how to specify internationalized\n\t\t\tdomain names, see DNS Domain Name\n\t\t\t\tFormat in the Amazon Route 53 Developer Guide.

\n\t\t

You can use the asterisk (*) wildcard to replace the leftmost label in a domain name,\n\t\t\tfor example, *.example.com. Note the following:

\n\t\t \n\t\t

You can use the * wildcard as the leftmost label in a domain name, for example,\n\t\t\t\t*.example.com. You can't use an * for one of the middle labels, for\n\t\t\texample, marketing.*.example.com. In addition, the * must replace the\n\t\t\tentire label; for example, you can't specify prod*.example.com.

", - "smithy.api#required": {} - } - }, - "Type": { - "target": "com.amazonaws.route53#RRType", - "traits": { - "smithy.api#documentation": "

The DNS record type. For information about different record types and how data is\n\t\t\tencoded for them, see Supported DNS Resource\n\t\t\t\tRecord Types in the Amazon Route 53 Developer\n\t\t\tGuide.

\n\t\t

Valid values for basic resource record sets: A | AAAA |\n\t\t\t\tCAA | CNAME | DS |MX |\n\t\t\t\tNAPTR | NS | PTR | SOA |\n\t\t\t\tSPF | SRV | TXT\n

\n\t\t

Values for weighted, latency, geolocation, and failover resource record sets:\n\t\t\t\tA | AAAA | CAA | CNAME |\n\t\t\t\tMX | NAPTR | PTR | SPF |\n\t\t\t\tSRV | TXT. When creating a group of weighted, latency,\n\t\t\tgeolocation, or failover resource record sets, specify the same value for all of the\n\t\t\tresource record sets in the group.

\n\t\t

Valid values for multivalue answer resource record sets: A |\n\t\t\t\tAAAA | MX | NAPTR | PTR |\n\t\t\t\tSPF | SRV | TXT\n

\n\t\t \n\t\t\t

SPF records were formerly used to verify the identity of the sender of email\n\t\t\t\tmessages. However, we no longer recommend that you create resource record sets for\n\t\t\t\twhich the value of Type is SPF. RFC 7208, Sender\n\t\t\t\t\tPolicy Framework (SPF) for Authorizing Use of Domains in Email, Version\n\t\t\t\t\t1, has been updated to say, \"...[I]ts existence and mechanism defined\n\t\t\t\tin [RFC4408] have led to some interoperability issues. Accordingly, its use is no\n\t\t\t\tlonger appropriate for SPF version 1; implementations are not to use it.\" In RFC\n\t\t\t\t7208, see section 14.1, The SPF DNS Record Type.

\n\t\t \n\t\t

Values for alias resource record sets:

\n\t\t ", - "smithy.api#required": {} - } - }, - "SetIdentifier": { - "target": "com.amazonaws.route53#ResourceRecordSetIdentifier", - "traits": { - "smithy.api#documentation": "

\n Resource record sets that have a routing policy other than\n\t\t\t\tsimple: An identifier that differentiates among multiple resource record\n\t\t\tsets that have the same combination of name and type, such as multiple weighted resource\n\t\t\trecord sets named acme.example.com that have a type of A. In a group of resource record\n\t\t\tsets that have the same name and type, the value of SetIdentifier must be\n\t\t\tunique for each resource record set.

\n\t\t

For information about routing policies, see Choosing a Routing\n\t\t\t\tPolicy in the Amazon Route 53 Developer Guide.

" - } - }, - "Weight": { - "target": "com.amazonaws.route53#ResourceRecordSetWeight", - "traits": { - "smithy.api#documentation": "

\n Weighted resource record sets only: Among resource record sets\n\t\t\tthat have the same combination of DNS name and type, a value that determines the\n\t\t\tproportion of DNS queries that Amazon Route 53 responds to using the current resource\n\t\t\trecord set. Route 53 calculates the sum of the weights for the resource record sets that\n\t\t\thave the same combination of DNS name and type. Route 53 then responds to queries based\n\t\t\ton the ratio of a resource's weight to the total. Note the following:

\n\t\t " - } - }, - "Region": { - "target": "com.amazonaws.route53#ResourceRecordSetRegion", - "traits": { - "smithy.api#documentation": "

\n Latency-based resource record sets only: The Amazon EC2 Region\n\t\t\twhere you created the resource that this resource record set refers to. The resource\n\t\t\ttypically is an Amazon Web Services resource, such as an EC2 instance or an ELB load\n\t\t\tbalancer, and is referred to by an IP address or a DNS domain name, depending on the\n\t\t\trecord type.

\n\t\n\t\t

When Amazon Route 53 receives a DNS query for a domain name and type for which you\n\t\t\thave created latency resource record sets, Route 53 selects the latency resource record\n\t\t\tset that has the lowest latency between the end user and the associated Amazon EC2\n\t\t\tRegion. Route 53 then returns the value that is associated with the selected resource\n\t\t\trecord set.

\n\t\t

Note the following:

\n\t\t " - } - }, - "GeoLocation": { - "target": "com.amazonaws.route53#GeoLocation", - "traits": { - "smithy.api#documentation": "

\n Geolocation resource record sets only: A complex type that lets\n\t\t\tyou control how Amazon Route 53 responds to DNS queries based on the geographic origin\n\t\t\tof the query. For example, if you want all queries from Africa to be routed to a web\n\t\t\tserver with an IP address of 192.0.2.111, create a resource record set with\n\t\t\ta Type of A and a ContinentCode of\n\t\t\t\tAF.

\n\t\t \n\t\t\t

Although creating geolocation and geolocation alias resource record sets in a\n\t\t\t\tprivate hosted zone is allowed, it's not supported.

\n\t\t \n\t\t

If you create separate resource record sets for overlapping geographic regions (for\n\t\t\texample, one resource record set for a continent and one for a country on the same\n\t\t\tcontinent), priority goes to the smallest geographic region. This allows you to route\n\t\t\tmost queries for a continent to one resource and to route queries for a country on that\n\t\t\tcontinent to a different resource.

\n\t\t

You can't create two geolocation resource record sets that specify the same geographic\n\t\t\tlocation.

\n\t\t

The value * in the CountryCode element matches all\n\t\t\tgeographic locations that aren't specified in other geolocation resource record sets\n\t\t\tthat have the same values for the Name and Type\n\t\t\telements.

\n\t\t \n\t\t\t

Geolocation works by mapping IP addresses to locations. However, some IP addresses\n\t\t\t\taren't mapped to geographic locations, so even if you create geolocation resource\n\t\t\t\trecord sets that cover all seven continents, Route 53 will receive some DNS queries\n\t\t\t\tfrom locations that it can't identify. We recommend that you create a resource\n\t\t\t\trecord set for which the value of CountryCode is *. Two\n\t\t\t\tgroups of queries are routed to the resource that you specify in this record:\n\t\t\t\tqueries that come from locations for which you haven't created geolocation resource\n\t\t\t\trecord sets and queries from IP addresses that aren't mapped to a location. If you\n\t\t\t\tdon't create a * resource record set, Route 53 returns a \"no answer\"\n\t\t\t\tresponse for queries from those locations.

\n\t\t \n\t\t

You can't create non-geolocation resource record sets that have the same values for\n\t\t\tthe Name and Type elements as geolocation resource record\n\t\t\tsets.

" - } - }, - "Failover": { - "target": "com.amazonaws.route53#ResourceRecordSetFailover", - "traits": { - "smithy.api#documentation": "

\n Failover resource record sets only: To configure failover, you\n\t\t\tadd the Failover element to two resource record sets. For one resource\n\t\t\trecord set, you specify PRIMARY as the value for Failover; for\n\t\t\tthe other resource record set, you specify SECONDARY. In addition, you\n\t\t\tinclude the HealthCheckId element and specify the health check that you\n\t\t\twant Amazon Route 53 to perform for each resource record set.

\n\t\t

Except where noted, the following failover behaviors assume that you have included the\n\t\t\t\tHealthCheckId element in both resource record sets:

\n\t\t \n\t\t

You can't create non-failover resource record sets that have the same values for the\n\t\t\t\tName and Type elements as failover resource record\n\t\t\tsets.

\n\t\t

For failover alias resource record sets, you must also include the\n\t\t\t\tEvaluateTargetHealth element and set the value to true.

\n\t\t

For more information about configuring failover for Route 53, see the following topics\n\t\t\tin the Amazon Route 53 Developer Guide:

\n\t\t " - } - }, - "MultiValueAnswer": { - "target": "com.amazonaws.route53#ResourceRecordSetMultiValueAnswer", - "traits": { - "smithy.api#documentation": "

\n Multivalue answer resource record sets only: To route traffic\n\t\t\tapproximately randomly to multiple resources, such as web servers, create one multivalue\n\t\t\tanswer record for each resource and specify true for\n\t\t\t\tMultiValueAnswer. Note the following:

\n\t\t \n\t\t

You can't create multivalue answer alias records.

" - } - }, - "TTL": { - "target": "com.amazonaws.route53#TTL", - "traits": { - "smithy.api#documentation": "

The resource record cache time to live (TTL), in seconds. Note the following:

\n\t\t " - } - }, - "ResourceRecords": { - "target": "com.amazonaws.route53#ResourceRecords", - "traits": { - "smithy.api#documentation": "

Information about the resource records to act upon.

\n\t\t \n\t\t\t

If you're creating an alias resource record set, omit\n\t\t\t\tResourceRecords.

\n\t\t " - } - }, - "AliasTarget": { - "target": "com.amazonaws.route53#AliasTarget", - "traits": { - "smithy.api#documentation": "

\n Alias resource record sets only: Information about the Amazon Web Services resource, such as a CloudFront distribution or an Amazon S3 bucket, that\n\t\t\tyou want to route traffic to.

\n\t\t

If you're creating resource records sets for a private hosted zone, note the\n\t\t\tfollowing:

\n\t\t " - } - }, - "HealthCheckId": { - "target": "com.amazonaws.route53#HealthCheckId", - "traits": { - "smithy.api#documentation": "

If you want Amazon Route 53 to return this resource record set in response to a DNS\n\t\t\tquery only when the status of a health check is healthy, include the\n\t\t\t\tHealthCheckId element and specify the ID of the applicable health\n\t\t\tcheck.

\n\t\t

Route 53 determines whether a resource record set is healthy based on one of the\n\t\t\tfollowing:

\n\t\t \n\t\t \n\t\t\t

Route 53 doesn't check the health of the endpoint that is specified in the\n\t\t\t\tresource record set, for example, the endpoint specified by the IP address in the\n\t\t\t\t\tValue element. When you add a HealthCheckId element to\n\t\t\t\ta resource record set, Route 53 checks the health of the endpoint that you specified\n\t\t\t\tin the health check.

\n\t\t \n\t\t

For more information, see the following topics in the Amazon Route 53\n\t\t\t\tDeveloper Guide:

\n\t\t \n\t\t

\n When to Specify HealthCheckId\n

\n\t\t

Specifying a value for HealthCheckId is useful only when Route 53 is\n\t\t\tchoosing between two or more resource record sets to respond to a DNS query, and you\n\t\t\twant Route 53 to base the choice in part on the status of a health check. Configuring\n\t\t\thealth checks makes sense only in the following configurations:

\n\t\t \n\t\t

\n Geolocation Routing\n

\n\t\t

For geolocation resource record sets, if an endpoint is unhealthy, Route 53 looks for\n\t\t\ta resource record set for the larger, associated geographic region. For example, suppose\n\t\t\tyou have resource record sets for a state in the United States, for the entire United\n\t\t\tStates, for North America, and a resource record set that has * for\n\t\t\t\tCountryCode is *, which applies to all locations. If the\n\t\t\tendpoint for the state resource record set is unhealthy, Route 53 checks for healthy\n\t\t\tresource record sets in the following order until it finds a resource record set for\n\t\t\twhich the endpoint is healthy:

\n\t\t \n\t\t

\n Specifying the Health Check Endpoint by Domain\n\t\t\tName\n

\n\t\t

If your health checks specify the endpoint only by domain name, we recommend that you\n\t\t\tcreate a separate health check for each endpoint. For example, create a health check for\n\t\t\teach HTTP server that is serving content for www.example.com.\n\t\t\tFor the value of FullyQualifiedDomainName, specify the domain name of the\n\t\t\tserver (such as us-east-2-www.example.com), not the name of the resource\n\t\t\trecord sets (www.example.com).

\n\t\t \n\t\t\t

Health check results will be unpredictable if you do the following:

\n\t\t\t \n\t\t " - } - }, - "TrafficPolicyInstanceId": { - "target": "com.amazonaws.route53#TrafficPolicyInstanceId", - "traits": { - "smithy.api#documentation": "

When you create a traffic policy instance, Amazon Route 53 automatically creates a\n\t\t\tresource record set. TrafficPolicyInstanceId is the ID of the traffic\n\t\t\tpolicy instance that Route 53 created this resource record set for.

\n\t\t \n\t\t\t

To delete the resource record set that is associated with a traffic policy\n\t\t\t\tinstance, use DeleteTrafficPolicyInstance. Route 53 will delete the\n\t\t\t\tresource record set automatically. If you delete the resource record set by using\n\t\t\t\t\tChangeResourceRecordSets, Route 53 doesn't automatically delete the\n\t\t\t\ttraffic policy instance, and you'll continue to be charged for it even though it's\n\t\t\t\tno longer in use.

\n\t\t " - } - }, - "CidrRoutingConfig": { - "target": "com.amazonaws.route53#CidrRoutingConfig" - } - }, - "traits": { - "smithy.api#documentation": "

Information about the resource record set to create or delete.

" - } - }, - "com.amazonaws.route53#ResourceRecordSetFailover": { - "type": "enum", - "members": { - "PRIMARY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PRIMARY" - } - }, - "SECONDARY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SECONDARY" - } - } - } - }, - "com.amazonaws.route53#ResourceRecordSetIdentifier": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - } - } - }, - "com.amazonaws.route53#ResourceRecordSetMultiValueAnswer": { - "type": "boolean" - }, - "com.amazonaws.route53#ResourceRecordSetRegion": { - "type": "enum", - "members": { - "us_east_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "us-east-1" - } - }, - "us_east_2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "us-east-2" - } - }, - "us_west_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "us-west-1" - } - }, - "us_west_2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "us-west-2" - } - }, - "ca_central_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ca-central-1" - } - }, - "eu_west_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "eu-west-1" - } - }, - "eu_west_2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "eu-west-2" - } - }, - "eu_west_3": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "eu-west-3" - } - }, - "eu_central_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "eu-central-1" - } - }, - "eu_central_2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "eu-central-2" - } - }, - "ap_southeast_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ap-southeast-1" - } - }, - "ap_southeast_2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ap-southeast-2" - } - }, - "ap_southeast_3": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ap-southeast-3" - } - }, - "ap_northeast_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ap-northeast-1" - } - }, - "ap_northeast_2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ap-northeast-2" - } - }, - "ap_northeast_3": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ap-northeast-3" - } - }, - "eu_north_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "eu-north-1" - } - }, - "sa_east_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "sa-east-1" - } - }, - "cn_north_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "cn-north-1" - } - }, - "cn_northwest_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "cn-northwest-1" - } - }, - "ap_east_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ap-east-1" - } - }, - "me_south_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "me-south-1" - } - }, - "me_central_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "me-central-1" - } - }, - "ap_south_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ap-south-1" - } - }, - "ap_south_2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ap-south-2" - } - }, - "af_south_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "af-south-1" - } - }, - "eu_south_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "eu-south-1" - } - }, - "eu_south_2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "eu-south-2" - } - } - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - } - } - }, - "com.amazonaws.route53#ResourceRecordSetWeight": { - "type": "long", - "traits": { - "smithy.api#range": { - "min": 0, - "max": 255 - } - } - }, - "com.amazonaws.route53#ResourceRecordSets": { - "type": "list", - "member": { - "target": "com.amazonaws.route53#ResourceRecordSet", - "traits": { - "smithy.api#xmlName": "ResourceRecordSet" - } - } - }, - "com.amazonaws.route53#ResourceRecords": { - "type": "list", - "member": { - "target": "com.amazonaws.route53#ResourceRecord", - "traits": { - "smithy.api#xmlName": "ResourceRecord" - } - }, - "traits": { - "smithy.api#length": { - "min": 1 - } - } - }, - "com.amazonaws.route53#ResourceTagSet": { - "type": "structure", - "members": { - "ResourceType": { - "target": "com.amazonaws.route53#TagResourceType", - "traits": { - "smithy.api#documentation": "

The type of the resource.

\n\t\t " - } - }, - "ResourceId": { - "target": "com.amazonaws.route53#TagResourceId", - "traits": { - "smithy.api#documentation": "

The ID for the specified resource.

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

The tags associated with the specified resource.

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

A complex type containing a resource and its associated tags.

" - } - }, - "com.amazonaws.route53#ResourceTagSetList": { - "type": "list", - "member": { - "target": "com.amazonaws.route53#ResourceTagSet", - "traits": { - "smithy.api#xmlName": "ResourceTagSet" - } - } - }, - "com.amazonaws.route53#ResourceURI": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1024 - } - } - }, - "com.amazonaws.route53#ReusableDelegationSetLimit": { - "type": "structure", - "members": { - "Type": { - "target": "com.amazonaws.route53#ReusableDelegationSetLimitType", - "traits": { - "smithy.api#documentation": "

The limit that you requested: MAX_ZONES_BY_REUSABLE_DELEGATION_SET, the\n\t\t\tmaximum number of hosted zones that you can associate with the specified reusable\n\t\t\tdelegation set.

", - "smithy.api#required": {} - } - }, - "Value": { - "target": "com.amazonaws.route53#LimitValue", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The current value for the MAX_ZONES_BY_REUSABLE_DELEGATION_SET\n\t\t\tlimit.

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

A complex type that contains the type of limit that you specified in the request and\n\t\t\tthe current value for that limit.

" - } - }, - "com.amazonaws.route53#ReusableDelegationSetLimitType": { - "type": "enum", - "members": { - "MAX_ZONES_BY_REUSABLE_DELEGATION_SET": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MAX_ZONES_BY_REUSABLE_DELEGATION_SET" - } - } - } - }, - "com.amazonaws.route53#RoutingControlArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 255 - } - } - }, - "com.amazonaws.route53#SearchString": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 255 - } - } - }, - "com.amazonaws.route53#ServeSignature": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1024 - } - } - }, - "com.amazonaws.route53#ServicePrincipal": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 128 - } - } - }, - "com.amazonaws.route53#SigningKeyInteger": { - "type": "integer", - "traits": { - "smithy.api#default": 0 - } - }, - "com.amazonaws.route53#SigningKeyName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 3, - "max": 128 - } - } - }, - "com.amazonaws.route53#SigningKeyStatus": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 5, - "max": 150 - } - } - }, - "com.amazonaws.route53#SigningKeyStatusMessage": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 512 - } - } - }, - "com.amazonaws.route53#SigningKeyString": { - "type": "string" - }, - "com.amazonaws.route53#SigningKeyTag": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 0, - "max": 65536 - } - } - }, - "com.amazonaws.route53#Statistic": { - "type": "enum", - "members": { - "Average": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Average" - } - }, - "Sum": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Sum" - } - }, - "SampleCount": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SampleCount" - } - }, - "Maximum": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Maximum" - } - }, - "Minimum": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Minimum" - } - } - } - }, - "com.amazonaws.route53#Status": { - "type": "string" - }, - "com.amazonaws.route53#StatusReport": { - "type": "structure", - "members": { - "Status": { - "target": "com.amazonaws.route53#Status", - "traits": { - "smithy.api#documentation": "

A description of the status of the health check endpoint as reported by one of the\n\t\t\tAmazon Route 53 health checkers.

" - } - }, - "CheckedTime": { - "target": "com.amazonaws.route53#TimeStamp", - "traits": { - "smithy.api#documentation": "

The date and time that the health checker performed the health check in ISO 8601 format and Coordinated\n\t\t\tUniversal Time (UTC). For example, the value 2017-03-27T17:48:16.751Z\n\t\t\trepresents March 27, 2017 at 17:48:16.751 UTC.

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

A complex type that contains the status that one Amazon Route 53 health checker\n\t\t\treports and the time of the health check.

" - } - }, - "com.amazonaws.route53#SubnetMask": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 3 - } - } - }, - "com.amazonaws.route53#TTL": { - "type": "long", - "traits": { - "smithy.api#range": { - "min": 0, - "max": 2147483647 - } - } - }, - "com.amazonaws.route53#Tag": { - "type": "structure", - "members": { - "Key": { - "target": "com.amazonaws.route53#TagKey", - "traits": { - "smithy.api#documentation": "

The value of Key depends on the operation that you want to\n\t\t\tperform:

\n\t\t " - } - }, - "Value": { - "target": "com.amazonaws.route53#TagValue", - "traits": { - "smithy.api#documentation": "

The value of Value depends on the operation that you want to\n\t\t\tperform:

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

A complex type that contains information about a tag that you want to add or edit for\n\t\t\tthe specified health check or hosted zone.

" - } - }, - "com.amazonaws.route53#TagKey": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 128 - } - } - }, - "com.amazonaws.route53#TagKeyList": { - "type": "list", - "member": { - "target": "com.amazonaws.route53#TagKey", - "traits": { - "smithy.api#xmlName": "Key" - } - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 10 - } - } - }, - "com.amazonaws.route53#TagList": { - "type": "list", - "member": { - "target": "com.amazonaws.route53#Tag", - "traits": { - "smithy.api#xmlName": "Tag" - } - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 10 - } - } - }, - "com.amazonaws.route53#TagResourceId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 64 - } - } - }, - "com.amazonaws.route53#TagResourceIdList": { - "type": "list", - "member": { - "target": "com.amazonaws.route53#TagResourceId", - "traits": { - "smithy.api#xmlName": "ResourceId" - } - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 10 - } - } - }, - "com.amazonaws.route53#TagResourceType": { - "type": "enum", - "members": { - "healthcheck": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "healthcheck" - } - }, - "hostedzone": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "hostedzone" - } - } - } - }, - "com.amazonaws.route53#TagValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - } - } - }, - "com.amazonaws.route53#TestDNSAnswer": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#TestDNSAnswerRequest" - }, - "output": { - "target": "com.amazonaws.route53#TestDNSAnswerResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#NoSuchHostedZone" - } - ], - "traits": { - "smithy.api#documentation": "

Gets the value that Amazon Route 53 returns in response to a DNS request for a\n\t\t\tspecified record name and type. You can optionally specify the IP address of a DNS\n\t\t\tresolver, an EDNS0 client subnet IP address, and a subnet mask.

\n\t\t

This call only supports querying public hosted zones.

", - "smithy.api#http": { - "method": "GET", - "uri": "/2013-04-01/testdnsanswer", - "code": 200 - } - } - }, - "com.amazonaws.route53#TestDNSAnswerRequest": { - "type": "structure", - "members": { - "HostedZoneId": { - "target": "com.amazonaws.route53#ResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the hosted zone that you want Amazon Route 53 to simulate a query\n\t\t\tfor.

", - "smithy.api#httpQuery": "hostedzoneid", - "smithy.api#required": {} - } - }, - "RecordName": { - "target": "com.amazonaws.route53#DNSName", - "traits": { - "smithy.api#documentation": "

The name of the resource record set that you want Amazon Route 53 to simulate a query\n\t\t\tfor.

", - "smithy.api#httpQuery": "recordname", - "smithy.api#required": {} - } - }, - "RecordType": { - "target": "com.amazonaws.route53#RRType", - "traits": { - "smithy.api#documentation": "

The type of the resource record set.

", - "smithy.api#httpQuery": "recordtype", - "smithy.api#required": {} - } - }, - "ResolverIP": { - "target": "com.amazonaws.route53#IPAddress", - "traits": { - "smithy.api#documentation": "

If you want to simulate a request from a specific DNS resolver, specify the IP address\n\t\t\tfor that resolver. If you omit this value, TestDnsAnswer uses the IP\n\t\t\taddress of a DNS resolver in the Amazon Web Services US East (N. Virginia) Region\n\t\t\t\t(us-east-1).

", - "smithy.api#httpQuery": "resolverip" - } - }, - "EDNS0ClientSubnetIP": { - "target": "com.amazonaws.route53#IPAddress", - "traits": { - "smithy.api#documentation": "

If the resolver that you specified for resolverip supports EDNS0, specify the IPv4 or\n\t\t\tIPv6 address of a client in the applicable location, for example,\n\t\t\t\t192.0.2.44 or 2001:db8:85a3::8a2e:370:7334.

", - "smithy.api#httpQuery": "edns0clientsubnetip" - } - }, - "EDNS0ClientSubnetMask": { - "target": "com.amazonaws.route53#SubnetMask", - "traits": { - "smithy.api#documentation": "

If you specify an IP address for edns0clientsubnetip, you can optionally\n\t\t\tspecify the number of bits of the IP address that you want the checking tool to include\n\t\t\tin the DNS query. For example, if you specify 192.0.2.44 for\n\t\t\t\tedns0clientsubnetip and 24 for\n\t\t\t\tedns0clientsubnetmask, the checking tool will simulate a request from\n\t\t\t192.0.2.0/24. The default value is 24 bits for IPv4 addresses and 64 bits for IPv6\n\t\t\taddresses.

\n\t\t

The range of valid values depends on whether edns0clientsubnetip is an\n\t\t\tIPv4 or an IPv6 address:

\n\t\t ", - "smithy.api#httpQuery": "edns0clientsubnetmask" - } - } - }, - "traits": { - "smithy.api#documentation": "

Gets the value that Amazon Route 53 returns in response to a DNS request for a\n\t\t\tspecified record name and type. You can optionally specify the IP address of a DNS\n\t\t\tresolver, an EDNS0 client subnet IP address, and a subnet mask.

" - } - }, - "com.amazonaws.route53#TestDNSAnswerResponse": { - "type": "structure", - "members": { - "Nameserver": { - "target": "com.amazonaws.route53#Nameserver", - "traits": { - "smithy.api#documentation": "

The Amazon Route 53 name server used to respond to the request.

", - "smithy.api#required": {} - } - }, - "RecordName": { - "target": "com.amazonaws.route53#DNSName", - "traits": { - "smithy.api#documentation": "

The name of the resource record set that you submitted a request for.

", - "smithy.api#required": {} - } - }, - "RecordType": { - "target": "com.amazonaws.route53#RRType", - "traits": { - "smithy.api#documentation": "

The type of the resource record set that you submitted a request for.

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

A list that contains values that Amazon Route 53 returned for this resource record\n\t\t\tset.

", - "smithy.api#required": {} - } - }, - "ResponseCode": { - "target": "com.amazonaws.route53#DNSRCode", - "traits": { - "smithy.api#documentation": "

A code that indicates whether the request is valid or not. The most common response\n\t\t\tcode is NOERROR, meaning that the request is valid. If the response is not\n\t\t\tvalid, Amazon Route 53 returns a response code that describes the error. For a list of\n\t\t\tpossible response codes, see DNS RCODES on the IANA website.

", - "smithy.api#required": {} - } - }, - "Protocol": { - "target": "com.amazonaws.route53#TransportProtocol", - "traits": { - "smithy.api#documentation": "

The protocol that Amazon Route 53 used to respond to the request, either\n\t\t\t\tUDP or TCP.

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

A complex type that contains the response to a TestDNSAnswer request.\n\t\t

" - } - }, - "com.amazonaws.route53#Threshold": { - "type": "double" - }, - "com.amazonaws.route53#ThrottlingException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "

The limit on the number of requests per second was exceeded.

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

This health check can't be created because the current account has reached the limit\n\t\t\ton the number of active health checks.

\n\t\t

For information about default limits, see Limits in the\n\t\t\t\tAmazon Route 53 Developer Guide.

\n\t\t

For information about how to get the current limit for an account, see GetAccountLimit. To request a higher limit, create a case with the Amazon Web Services Support\n\t\t\tCenter.

\n\t\t

You have reached the maximum number of active health checks for an Amazon Web Services account. To request a higher limit, create a case with the Amazon Web Services Support\n\t\t\tCenter.

", - "smithy.api#error": "client" - } - }, - "com.amazonaws.route53#TooManyHostedZones": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage", - "traits": { - "smithy.api#documentation": "

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

This operation can't be completed either because the current account has reached the\n\t\t\tlimit on the number of hosted zones or because you've reached the limit on the number of\n\t\t\thosted zones that can be associated with a reusable delegation set.

\n\t\t

For information about default limits, see Limits in the\n\t\t\t\tAmazon Route 53 Developer Guide.

\n\t\t

To get the current limit on hosted zones that can be created by an account, see GetAccountLimit.

\n\t\t

To get the current limit on hosted zones that can be associated with a reusable\n\t\t\tdelegation set, see GetReusableDelegationSetLimit.

\n\t\t

To request a higher limit, create a\n\t\t\t\tcase with the Amazon Web Services Support Center.

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

You've reached the limit for the number of key-signing keys (KSKs). Remove at least\n\t\t\tone KSK, and then try again.

", - "smithy.api#error": "client" - } - }, - "com.amazonaws.route53#TooManyTrafficPolicies": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage", - "traits": { - "smithy.api#documentation": "

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

This traffic policy can't be created because the current account has reached the limit\n\t\t\ton the number of traffic policies.

\n\t\t

For information about default limits, see Limits in the\n\t\t\t\tAmazon Route 53 Developer Guide.

\n\t\t

To get the current limit for an account, see GetAccountLimit.

\n\t\t

To request a higher limit, create a\n\t\t\t\tcase with the Amazon Web Services Support Center.

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

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

This traffic policy instance can't be created because the current account has reached\n\t\t\tthe limit on the number of traffic policy instances.

\n\t\t

For information about default limits, see Limits in the\n\t\t\t\tAmazon Route 53 Developer Guide.

\n\t\t

For information about how to get the current limit for an account, see GetAccountLimit.

\n\t\t

To request a higher limit, create a\n\t\t\t\tcase with the Amazon Web Services Support Center.

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

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

This traffic policy version can't be created because you've reached the limit of 1000\n\t\t\ton the number of versions that you can create for the current traffic policy.

\n\t\t

To create more traffic policy versions, you can use GetTrafficPolicy\n\t\t\tto get the traffic policy document for a specified traffic policy version, and then use\n\t\t\t\tCreateTrafficPolicy to create a new traffic policy using the traffic policy\n\t\t\tdocument.

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

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

You've created the maximum number of authorizations that can be created for the\n\t\t\tspecified hosted zone. To authorize another VPC to be associated with the hosted zone,\n\t\t\tsubmit a DeleteVPCAssociationAuthorization request to remove an existing\n\t\t\tauthorization. To get a list of existing authorizations, submit a\n\t\t\t\tListVPCAssociationAuthorizations request.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.route53#TrafficPolicies": { - "type": "list", - "member": { - "target": "com.amazonaws.route53#TrafficPolicy", - "traits": { - "smithy.api#xmlName": "TrafficPolicy" - } - } - }, - "com.amazonaws.route53#TrafficPolicy": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.route53#TrafficPolicyId", - "traits": { - "smithy.api#documentation": "

The ID that Amazon Route 53 assigned to a traffic policy when you created it.

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

The version number that Amazon Route 53 assigns to a traffic policy. For a new traffic\n\t\t\tpolicy, the value of Version is always 1.

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

The name that you specified when you created the traffic policy.

", - "smithy.api#required": {} - } - }, - "Type": { - "target": "com.amazonaws.route53#RRType", - "traits": { - "smithy.api#documentation": "

The DNS type of the resource record sets that Amazon Route 53 creates when you use a\n\t\t\ttraffic policy to create a traffic policy instance.

", - "smithy.api#required": {} - } - }, - "Document": { - "target": "com.amazonaws.route53#TrafficPolicyDocument", - "traits": { - "smithy.api#documentation": "

The definition of a traffic policy in JSON format. You specify the JSON document to\n\t\t\tuse for a new traffic policy in the CreateTrafficPolicy request. For more\n\t\t\tinformation about the JSON format, see Traffic Policy Document Format.

", - "smithy.api#required": {} - } - }, - "Comment": { - "target": "com.amazonaws.route53#TrafficPolicyComment", - "traits": { - "smithy.api#documentation": "

The comment that you specify in the CreateTrafficPolicy request, if\n\t\t\tany.

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

A complex type that contains settings for a traffic policy.

" - } - }, - "com.amazonaws.route53#TrafficPolicyAlreadyExists": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage", - "traits": { - "smithy.api#documentation": "

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

A traffic policy that has the same value for Name already exists.

", - "smithy.api#error": "client", - "smithy.api#httpError": 409 - } - }, - "com.amazonaws.route53#TrafficPolicyComment": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1024 - } - } - }, - "com.amazonaws.route53#TrafficPolicyDocument": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 102400 - } - } - }, - "com.amazonaws.route53#TrafficPolicyId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 36 - } - } - }, - "com.amazonaws.route53#TrafficPolicyInUse": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage", - "traits": { - "smithy.api#documentation": "

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

One or more traffic policy instances were created by using the specified traffic\n\t\t\tpolicy.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.route53#TrafficPolicyInstance": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.route53#TrafficPolicyInstanceId", - "traits": { - "smithy.api#documentation": "

The ID that Amazon Route 53 assigned to the new traffic policy instance.

", - "smithy.api#required": {} - } - }, - "HostedZoneId": { - "target": "com.amazonaws.route53#ResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the hosted zone that Amazon Route 53 created resource record sets in.

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

The DNS name, such as www.example.com, for which Amazon Route 53 responds to queries\n\t\t\tby using the resource record sets that are associated with this traffic policy instance.\n\t\t

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

The TTL that Amazon Route 53 assigned to all of the resource record sets that it\n\t\t\tcreated in the specified hosted zone.

", - "smithy.api#required": {} - } - }, - "State": { - "target": "com.amazonaws.route53#TrafficPolicyInstanceState", - "traits": { - "smithy.api#documentation": "

The value of State is one of the following values:

\n\t\t
\n
Applied
\n
\n\t\t\t\t\t

Amazon Route 53 has finished creating resource record sets, and changes\n\t\t\t\t\t\thave propagated to all Route 53 edge locations.

\n\t\t\t\t
\n
Creating
\n
\n\t\t\t\t\t

Route 53 is creating the resource record sets. Use\n\t\t\t\t\t\t\tGetTrafficPolicyInstance to confirm that the\n\t\t\t\t\t\t\tCreateTrafficPolicyInstance request completed\n\t\t\t\t\t\tsuccessfully.

\n\t\t\t\t
\n
Failed
\n
\n\t\t\t\t\t

Route 53 wasn't able to create or update the resource record sets. When\n\t\t\t\t\t\tthe value of State is Failed, see\n\t\t\t\t\t\t\tMessage for an explanation of what caused the request to\n\t\t\t\t\t\tfail.

\n\t\t\t\t
\n
", - "smithy.api#required": {} - } - }, - "Message": { - "target": "com.amazonaws.route53#Message", - "traits": { - "smithy.api#documentation": "

If State is Failed, an explanation of the reason for the\n\t\t\tfailure. If State is another value, Message is empty.

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

The ID of the traffic policy that Amazon Route 53 used to create resource record sets\n\t\t\tin the specified hosted zone.

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

The version of the traffic policy that Amazon Route 53 used to create resource record\n\t\t\tsets in the specified hosted zone.

", - "smithy.api#required": {} - } - }, - "TrafficPolicyType": { - "target": "com.amazonaws.route53#RRType", - "traits": { - "smithy.api#documentation": "

The DNS type that Amazon Route 53 assigned to all of the resource record sets that it\n\t\t\tcreated for this traffic policy instance.

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

A complex type that contains settings for the new traffic policy instance.

" - } - }, - "com.amazonaws.route53#TrafficPolicyInstanceAlreadyExists": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage", - "traits": { - "smithy.api#documentation": "

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

There is already a traffic policy instance with the specified ID.

", - "smithy.api#error": "client", - "smithy.api#httpError": 409 - } - }, - "com.amazonaws.route53#TrafficPolicyInstanceCount": { - "type": "integer" - }, - "com.amazonaws.route53#TrafficPolicyInstanceId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 36 - } - } - }, - "com.amazonaws.route53#TrafficPolicyInstanceState": { - "type": "string" - }, - "com.amazonaws.route53#TrafficPolicyInstances": { - "type": "list", - "member": { - "target": "com.amazonaws.route53#TrafficPolicyInstance", - "traits": { - "smithy.api#xmlName": "TrafficPolicyInstance" - } - } - }, - "com.amazonaws.route53#TrafficPolicyName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 512 - } - } - }, - "com.amazonaws.route53#TrafficPolicySummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.route53#TrafficPolicySummary", - "traits": { - "smithy.api#xmlName": "TrafficPolicySummary" - } - } - }, - "com.amazonaws.route53#TrafficPolicySummary": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.route53#TrafficPolicyId", - "traits": { - "smithy.api#documentation": "

The ID that Amazon Route 53 assigned to the traffic policy when you created it.

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

The name that you specified for the traffic policy when you created it.

", - "smithy.api#required": {} - } - }, - "Type": { - "target": "com.amazonaws.route53#RRType", - "traits": { - "smithy.api#documentation": "

The DNS type of the resource record sets that Amazon Route 53 creates when you use a\n\t\t\ttraffic policy to create a traffic policy instance.

", - "smithy.api#required": {} - } - }, - "LatestVersion": { - "target": "com.amazonaws.route53#TrafficPolicyVersion", - "traits": { - "smithy.api#documentation": "

The version number of the latest version of the traffic policy.

", - "smithy.api#required": {} - } - }, - "TrafficPolicyCount": { - "target": "com.amazonaws.route53#TrafficPolicyVersion", - "traits": { - "smithy.api#documentation": "

The number of traffic policies that are associated with the current Amazon Web Services account.

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

A complex type that contains information about the latest version of one traffic\n\t\t\tpolicy that is associated with the current Amazon Web Services account.

" - } - }, - "com.amazonaws.route53#TrafficPolicyVersion": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 1000 - } - } - }, - "com.amazonaws.route53#TrafficPolicyVersionMarker": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 4 - } - } - }, - "com.amazonaws.route53#TransportProtocol": { - "type": "string" - }, - "com.amazonaws.route53#UUID": { - "type": "string", - "traits": { - "smithy.api#pattern": "^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$" - } - }, - "com.amazonaws.route53#UpdateHealthCheck": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#UpdateHealthCheckRequest" - }, - "output": { - "target": "com.amazonaws.route53#UpdateHealthCheckResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#HealthCheckVersionMismatch" - }, - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#NoSuchHealthCheck" - } - ], - "traits": { - "smithy.api#documentation": "

Updates an existing health check. Note that some values can't be updated.

\n\t\t

For more information about updating health checks, see Creating,\n\t\t\t\tUpdating, and Deleting Health Checks in the Amazon Route 53\n\t\t\t\tDeveloper Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/2013-04-01/healthcheck/{HealthCheckId}", - "code": 200 - } - } - }, - "com.amazonaws.route53#UpdateHealthCheckRequest": { - "type": "structure", - "members": { - "HealthCheckId": { - "target": "com.amazonaws.route53#HealthCheckId", - "traits": { - "smithy.api#documentation": "

The ID for the health check for which you want detailed information. When you created\n\t\t\tthe health check, CreateHealthCheck returned the ID in the response, in the\n\t\t\t\tHealthCheckId element.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "HealthCheckVersion": { - "target": "com.amazonaws.route53#HealthCheckVersion", - "traits": { - "smithy.api#documentation": "

A sequential counter that Amazon Route 53 sets to 1 when you create a\n\t\t\thealth check and increments by 1 each time you update settings for the health\n\t\t\tcheck.

\n\t\t

We recommend that you use GetHealthCheck or ListHealthChecks\n\t\t\tto get the current value of HealthCheckVersion for the health check that\n\t\t\tyou want to update, and that you include that value in your\n\t\t\t\tUpdateHealthCheck request. This prevents Route 53 from overwriting an\n\t\t\tintervening update:

\n\t\t " - } - }, - "IPAddress": { - "target": "com.amazonaws.route53#IPAddress", - "traits": { - "smithy.api#documentation": "

The IPv4 or IPv6 IP address for the endpoint that you want Amazon Route 53 to perform\n\t\t\thealth checks on. If you don't specify a value for IPAddress, Route 53\n\t\t\tsends a DNS request to resolve the domain name that you specify in\n\t\t\t\tFullyQualifiedDomainName at the interval that you specify in\n\t\t\t\tRequestInterval. Using an IP address that is returned by DNS, Route 53\n\t\t\tthen checks the health of the endpoint.

\n\t\t

Use one of the following formats for the value of IPAddress:

\n\t\t \n\t\t

If the endpoint is an EC2 instance, we recommend that you create an Elastic IP\n\t\t\taddress, associate it with your EC2 instance, and specify the Elastic IP address for\n\t\t\t\tIPAddress. This ensures that the IP address of your instance never\n\t\t\tchanges. For more information, see the applicable documentation:

\n\t\t \n\t\t \n\t\t\t

If a health check already has a value for IPAddress, you can change\n\t\t\t\tthe value. However, you can't update an existing health check to add or remove the\n\t\t\t\tvalue of IPAddress.

\n\t\t \n\t\t

For more information, see FullyQualifiedDomainName.

\n\t\t

Constraints: Route 53 can't check the health of endpoints for which the IP address is\n\t\t\tin local, private, non-routable, or multicast ranges. For more information about IP\n\t\t\taddresses for which you can't create health checks, see the following documents:

\n\t\t " - } - }, - "Port": { - "target": "com.amazonaws.route53#Port", - "traits": { - "smithy.api#documentation": "

The port on the endpoint that you want Amazon Route 53 to perform health checks\n\t\t\ton.

\n\t\t \n\t\t\t

Don't specify a value for Port when you specify a value for\n\t\t\t\t\tType of CLOUDWATCH_METRIC or\n\t\t\t\tCALCULATED.

\n\t\t " - } - }, - "ResourcePath": { - "target": "com.amazonaws.route53#ResourcePath", - "traits": { - "smithy.api#documentation": "

The path that you want Amazon Route 53 to request when performing health checks. The\n\t\t\tpath can be any value for which your endpoint will return an HTTP status code of 2xx or\n\t\t\t3xx when the endpoint is healthy, for example the file /docs/route53-health-check.html.\n\t\t\tYou can also include query string parameters, for example,\n\t\t\t\t/welcome.html?language=jp&login=y.

\n\t\t

Specify this value only if you want to change it.

" - } - }, - "FullyQualifiedDomainName": { - "target": "com.amazonaws.route53#FullyQualifiedDomainName", - "traits": { - "smithy.api#documentation": "

Amazon Route 53 behavior depends on whether you specify a value for\n\t\t\t\tIPAddress.

\n\t\t \n\t\t\t

If a health check already has a value for IPAddress, you can change\n\t\t\t\tthe value. However, you can't update an existing health check to add or remove the\n\t\t\t\tvalue of IPAddress.

\n\t\t \n\t\t

\n If you specify a value for\n\t\t\t IPAddress:

\n\t\t

Route 53 sends health check requests to the specified IPv4 or IPv6 address and passes\n\t\t\tthe value of FullyQualifiedDomainName in the Host header for\n\t\t\tall health checks except TCP health checks. This is typically the fully qualified DNS\n\t\t\tname of the endpoint on which you want Route 53 to perform health checks.

\n\t\t

When Route 53 checks the health of an endpoint, here is how it constructs the\n\t\t\t\tHost header:

\n\t\t \n\t\t

If you don't specify a value for FullyQualifiedDomainName, Route 53\n\t\t\tsubstitutes the value of IPAddress in the Host header in each\n\t\t\tof the above cases.

\n\t\t

\n If you don't specify a value for\n\t\t\t IPAddress:

\n\t\t

If you don't specify a value for IPAddress, Route 53 sends a DNS request\n\t\t\tto the domain that you specify in FullyQualifiedDomainName at the interval\n\t\t\tyou specify in RequestInterval. Using an IPv4 address that is returned by\n\t\t\tDNS, Route 53 then checks the health of the endpoint.

\n\t\t \n\t\t\t

If you don't specify a value for IPAddress, Route 53 uses only IPv4\n\t\t\t\tto send health checks to the endpoint. If there's no resource record set with a type\n\t\t\t\tof A for the name that you specify for FullyQualifiedDomainName, the\n\t\t\t\thealth check fails with a \"DNS resolution failed\" error.

\n\t\t \n\t\t

If you want to check the health of weighted, latency, or failover resource record sets\n\t\t\tand you choose to specify the endpoint only by FullyQualifiedDomainName, we\n\t\t\trecommend that you create a separate health check for each endpoint. For example, create\n\t\t\ta health check for each HTTP server that is serving content for www.example.com. For the\n\t\t\tvalue of FullyQualifiedDomainName, specify the domain name of the server\n\t\t\t(such as us-east-2-www.example.com), not the name of the resource record\n\t\t\tsets (www.example.com).

\n\t\t \n\t\t\t

In this configuration, if the value of FullyQualifiedDomainName\n\t\t\t\tmatches the name of the resource record sets and you then associate the health check\n\t\t\t\twith those resource record sets, health check results will be unpredictable.

\n\t\t \n\t\t

In addition, if the value of Type is HTTP,\n\t\t\t\tHTTPS, HTTP_STR_MATCH, or HTTPS_STR_MATCH,\n\t\t\tRoute 53 passes the value of FullyQualifiedDomainName in the\n\t\t\t\tHost header, as it does when you specify a value for\n\t\t\t\tIPAddress. If the value of Type is TCP, Route\n\t\t\t53 doesn't pass a Host header.

" - } - }, - "SearchString": { - "target": "com.amazonaws.route53#SearchString", - "traits": { - "smithy.api#documentation": "

If the value of Type is HTTP_STR_MATCH or\n\t\t\t\tHTTPS_STR_MATCH, the string that you want Amazon Route 53 to search for\n\t\t\tin the response body from the specified resource. If the string appears in the response\n\t\t\tbody, Route 53 considers the resource healthy. (You can't change the value of\n\t\t\t\tType when you update a health check.)

" - } - }, - "FailureThreshold": { - "target": "com.amazonaws.route53#FailureThreshold", - "traits": { - "smithy.api#documentation": "

The number of consecutive health checks that an endpoint must pass or fail for Amazon\n\t\t\tRoute 53 to change the current status of the endpoint from unhealthy to healthy or vice\n\t\t\tversa. For more information, see How Amazon Route 53 Determines Whether an Endpoint Is Healthy in the\n\t\t\t\tAmazon Route 53 Developer Guide.

\n\t\t

If you don't specify a value for FailureThreshold, the default value is\n\t\t\tthree health checks.

" - } - }, - "Inverted": { - "target": "com.amazonaws.route53#Inverted", - "traits": { - "smithy.api#documentation": "

Specify whether you want Amazon Route 53 to invert the status of a health check, for\n\t\t\texample, to consider a health check unhealthy when it otherwise would be considered\n\t\t\thealthy.

" - } - }, - "Disabled": { - "target": "com.amazonaws.route53#Disabled", - "traits": { - "smithy.api#documentation": "

Stops Route 53 from performing health checks. When you disable a health check, here's\n\t\t\twhat happens:

\n\t\t \n\t\t

After you disable a health check, Route 53 considers the status of the health check to\n\t\t\talways be healthy. If you configured DNS failover, Route 53 continues to route traffic\n\t\t\tto the corresponding resources. If you want to stop routing traffic to a resource,\n\t\t\tchange the value of Inverted.

\n\t\t

Charges for a health check still apply when the health check is disabled. For more\n\t\t\tinformation, see Amazon Route 53\n\t\t\t\tPricing.

" - } - }, - "HealthThreshold": { - "target": "com.amazonaws.route53#HealthThreshold", - "traits": { - "smithy.api#documentation": "

The number of child health checks that are associated with a CALCULATED\n\t\t\thealth that Amazon Route 53 must consider healthy for the CALCULATED health\n\t\t\tcheck to be considered healthy. To specify the child health checks that you want to\n\t\t\tassociate with a CALCULATED health check, use the\n\t\t\t\tChildHealthChecks and ChildHealthCheck elements.

\n\t\t

Note the following:

\n\t\t " - } - }, - "ChildHealthChecks": { - "target": "com.amazonaws.route53#ChildHealthCheckList", - "traits": { - "smithy.api#documentation": "

A complex type that contains one ChildHealthCheck element for each health\n\t\t\tcheck that you want to associate with a CALCULATED health check.

" - } - }, - "EnableSNI": { - "target": "com.amazonaws.route53#EnableSNI", - "traits": { - "smithy.api#documentation": "

Specify whether you want Amazon Route 53 to send the value of\n\t\t\t\tFullyQualifiedDomainName to the endpoint in the\n\t\t\t\tclient_hello message during TLS negotiation. This allows\n\t\t\tthe endpoint to respond to HTTPS health check requests with the applicable\n\t\t\tSSL/TLS certificate.

\n\t\t

Some endpoints require that HTTPS requests include the host name in the\n\t\t\t\tclient_hello message. If you don't enable SNI, the status of the health\n\t\t\tcheck will be SSL alert handshake_failure. A health check can also have\n\t\t\tthat status for other reasons. If SNI is enabled and you're still getting the error,\n\t\t\tcheck the SSL/TLS configuration on your endpoint and confirm that your certificate is\n\t\t\tvalid.

\n\t\t

The SSL/TLS certificate on your endpoint includes a domain name in the Common\n\t\t\t\tName field and possibly several more in the Subject Alternative\n\t\t\t\tNames field. One of the domain names in the certificate should match the\n\t\t\tvalue that you specify for FullyQualifiedDomainName. If the endpoint\n\t\t\tresponds to the client_hello message with a certificate that does not\n\t\t\tinclude the domain name that you specified in FullyQualifiedDomainName, a\n\t\t\thealth checker will retry the handshake. In the second attempt, the health checker will\n\t\t\tomit FullyQualifiedDomainName from the client_hello\n\t\t\tmessage.

" - } - }, - "Regions": { - "target": "com.amazonaws.route53#HealthCheckRegionList", - "traits": { - "smithy.api#documentation": "

A complex type that contains one Region element for each region that you\n\t\t\twant Amazon Route 53 health checkers to check the specified endpoint from.

" - } - }, - "AlarmIdentifier": { - "target": "com.amazonaws.route53#AlarmIdentifier", - "traits": { - "smithy.api#documentation": "

A complex type that identifies the CloudWatch alarm that you want Amazon Route 53\n\t\t\thealth checkers to use to determine whether the specified health check is\n\t\t\thealthy.

" - } - }, - "InsufficientDataHealthStatus": { - "target": "com.amazonaws.route53#InsufficientDataHealthStatus", - "traits": { - "smithy.api#documentation": "

When CloudWatch has insufficient data about the metric to determine the alarm state,\n\t\t\tthe status that you want Amazon Route 53 to assign to the health check:

\n\t\t " - } - }, - "ResetElements": { - "target": "com.amazonaws.route53#ResettableElementNameList", - "traits": { - "smithy.api#documentation": "

A complex type that contains one ResettableElementName element for each\n\t\t\telement that you want to reset to the default value. Valid values for\n\t\t\t\tResettableElementName include the following:

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

A complex type that contains information about a request to update a health\n\t\t\tcheck.

" - } - }, - "com.amazonaws.route53#UpdateHealthCheckResponse": { - "type": "structure", - "members": { - "HealthCheck": { - "target": "com.amazonaws.route53#HealthCheck", - "traits": { - "smithy.api#documentation": "

A complex type that contains the response to an UpdateHealthCheck\n\t\t\trequest.

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

A complex type that contains the response to the UpdateHealthCheck\n\t\t\trequest.

" - } - }, - "com.amazonaws.route53#UpdateHostedZoneComment": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#UpdateHostedZoneCommentRequest" - }, - "output": { - "target": "com.amazonaws.route53#UpdateHostedZoneCommentResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#NoSuchHostedZone" - }, - { - "target": "com.amazonaws.route53#PriorRequestNotComplete" - } - ], - "traits": { - "smithy.api#documentation": "

Updates the comment for a specified hosted zone.

", - "smithy.api#http": { - "method": "POST", - "uri": "/2013-04-01/hostedzone/{Id}", - "code": 200 - } - } - }, - "com.amazonaws.route53#UpdateHostedZoneCommentRequest": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.route53#ResourceId", - "traits": { - "smithy.api#documentation": "

The ID for the hosted zone that you want to update the comment for.

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

The new comment for the hosted zone. If you don't specify a value for\n\t\t\t\tComment, Amazon Route 53 deletes the existing value of the\n\t\t\t\tComment element, if any.

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

A request to update the comment for a hosted zone.

" - } - }, - "com.amazonaws.route53#UpdateHostedZoneCommentResponse": { - "type": "structure", - "members": { - "HostedZone": { - "target": "com.amazonaws.route53#HostedZone", - "traits": { - "smithy.api#documentation": "

A complex type that contains the response to the UpdateHostedZoneComment\n\t\t\trequest.

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

A complex type that contains the response to the UpdateHostedZoneComment\n\t\t\trequest.

" - } - }, - "com.amazonaws.route53#UpdateTrafficPolicyComment": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#UpdateTrafficPolicyCommentRequest" - }, - "output": { - "target": "com.amazonaws.route53#UpdateTrafficPolicyCommentResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#ConcurrentModification" - }, - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#NoSuchTrafficPolicy" - } - ], - "traits": { - "smithy.api#documentation": "

Updates the comment for a specified traffic policy version.

", - "smithy.api#http": { - "method": "POST", - "uri": "/2013-04-01/trafficpolicy/{Id}/{Version}", - "code": 200 - } - } - }, - "com.amazonaws.route53#UpdateTrafficPolicyCommentRequest": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.route53#TrafficPolicyId", - "traits": { - "smithy.api#documentation": "

The value of Id for the traffic policy that you want to update the\n\t\t\tcomment for.

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

The value of Version for the traffic policy that you want to update the\n\t\t\tcomment for.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Comment": { - "target": "com.amazonaws.route53#TrafficPolicyComment", - "traits": { - "smithy.api#documentation": "

The new comment for the specified traffic policy and version.

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

A complex type that contains information about the traffic policy that you want to\n\t\t\tupdate the comment for.

" - } - }, - "com.amazonaws.route53#UpdateTrafficPolicyCommentResponse": { - "type": "structure", - "members": { - "TrafficPolicy": { - "target": "com.amazonaws.route53#TrafficPolicy", - "traits": { - "smithy.api#documentation": "

A complex type that contains settings for the specified traffic policy.

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

A complex type that contains the response information for the traffic policy.

" - } - }, - "com.amazonaws.route53#UpdateTrafficPolicyInstance": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#UpdateTrafficPolicyInstanceRequest" - }, - "output": { - "target": "com.amazonaws.route53#UpdateTrafficPolicyInstanceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#ConflictingTypes" - }, - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#NoSuchTrafficPolicy" - }, - { - "target": "com.amazonaws.route53#NoSuchTrafficPolicyInstance" - }, - { - "target": "com.amazonaws.route53#PriorRequestNotComplete" - } - ], - "traits": { - "smithy.api#documentation": "

Updates the resource record sets in a specified hosted zone that were created based on\n\t\t\tthe settings in a specified traffic policy version.

\n\t\t

When you update a traffic policy instance, Amazon Route 53 continues to respond to DNS\n\t\t\tqueries for the root resource record set name (such as example.com) while it replaces\n\t\t\tone group of resource record sets with another. Route 53 performs the following\n\t\t\toperations:

\n\t\t
    \n
  1. \n\t\t\t\t

    Route 53 creates a new group of resource record sets based on the specified\n\t\t\t\t\ttraffic policy. This is true regardless of how significant the differences are\n\t\t\t\t\tbetween the existing resource record sets and the new resource record sets.\n\t\t\t\t

    \n\t\t\t
    2. \n
  2. \n\t\t\t\t

    When all of the new resource record sets have been created, Route 53 starts to\n\t\t\t\t\trespond to DNS queries for the root resource record set name (such as\n\t\t\t\t\texample.com) by using the new resource record sets.

    \n\t\t\t
    3. \n
  3. \n\t\t\t\t

    Route 53 deletes the old group of resource record sets that are associated\n\t\t\t\t\twith the root resource record set name.

    \n\t\t\t
    4. \n
", - "smithy.api#http": { - "method": "POST", - "uri": "/2013-04-01/trafficpolicyinstance/{Id}", - "code": 200 - } - } - }, - "com.amazonaws.route53#UpdateTrafficPolicyInstanceRequest": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.route53#TrafficPolicyInstanceId", - "traits": { - "smithy.api#documentation": "

The ID of the traffic policy instance that you want to update.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "TTL": { - "target": "com.amazonaws.route53#TTL", - "traits": { - "smithy.api#documentation": "

The TTL that you want Amazon Route 53 to assign to all of the updated resource record\n\t\t\tsets.

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

The ID of the traffic policy that you want Amazon Route 53 to use to update resource\n\t\t\trecord sets for the specified traffic policy instance.

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

The version of the traffic policy that you want Amazon Route 53 to use to update\n\t\t\tresource record sets for the specified traffic policy instance.

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

A complex type that contains information about the resource record sets that you want\n\t\t\tto update based on a specified traffic policy instance.

" - } - }, - "com.amazonaws.route53#UpdateTrafficPolicyInstanceResponse": { - "type": "structure", - "members": { - "TrafficPolicyInstance": { - "target": "com.amazonaws.route53#TrafficPolicyInstance", - "traits": { - "smithy.api#documentation": "

A complex type that contains settings for the updated traffic policy instance.

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

A complex type that contains information about the resource record sets that Amazon\n\t\t\tRoute 53 created based on a specified traffic policy.

" - } - }, - "com.amazonaws.route53#UsageCount": { - "type": "long", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 0 - } - } - }, - "com.amazonaws.route53#VPC": { - "type": "structure", - "members": { - "VPCRegion": { - "target": "com.amazonaws.route53#VPCRegion", - "traits": { - "smithy.api#documentation": "

(Private hosted zones only) The region that an Amazon VPC was created\n\t\t\tin.

" - } - }, - "VPCId": { - "target": "com.amazonaws.route53#VPCId" - } - }, - "traits": { - "smithy.api#documentation": "

(Private hosted zones only) A complex type that contains information about an Amazon VPC.

\n\t\t

If you associate a private hosted zone with an Amazon VPC when you make a\n\t\t\t\tCreateHostedZone\n\t\t\trequest, the following parameters are also required.

" - } - }, - "com.amazonaws.route53#VPCAssociationAuthorizationNotFound": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage", - "traits": { - "smithy.api#documentation": "

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

The VPC that you specified is not authorized to be associated with the hosted\n\t\t\tzone.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.route53#VPCAssociationNotFound": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage", - "traits": { - "smithy.api#documentation": "

The specified VPC or hosted zone weren't found.

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

The specified VPC and hosted zone are not currently associated.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.route53#VPCId": { - "type": "string", - "traits": { - "smithy.api#documentation": "

(Private hosted zones only) The ID of an Amazon VPC.

", - "smithy.api#length": { - "min": 0, - "max": 1024 - } - } - }, - "com.amazonaws.route53#VPCRegion": { - "type": "enum", - "members": { - "us_east_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "us-east-1" - } - }, - "us_east_2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "us-east-2" - } - }, - "us_west_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "us-west-1" - } - }, - "us_west_2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "us-west-2" - } - }, - "eu_west_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "eu-west-1" - } - }, - "eu_west_2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "eu-west-2" - } - }, - "eu_west_3": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "eu-west-3" - } - }, - "eu_central_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "eu-central-1" - } - }, - "eu_central_2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "eu-central-2" - } - }, - "ap_east_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ap-east-1" - } - }, - "me_south_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "me-south-1" - } - }, - "us_gov_west_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "us-gov-west-1" - } - }, - "us_gov_east_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "us-gov-east-1" - } - }, - "us_iso_east_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "us-iso-east-1" - } - }, - "us_iso_west_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "us-iso-west-1" - } - }, - "us_isob_east_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "us-isob-east-1" - } - }, - "me_central_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "me-central-1" - } - }, - "ap_southeast_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ap-southeast-1" - } - }, - "ap_southeast_2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ap-southeast-2" - } - }, - "ap_southeast_3": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ap-southeast-3" - } - }, - "ap_south_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ap-south-1" - } - }, - "ap_south_2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ap-south-2" - } - }, - "ap_northeast_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ap-northeast-1" - } - }, - "ap_northeast_2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ap-northeast-2" - } - }, - "ap_northeast_3": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ap-northeast-3" - } - }, - "eu_north_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "eu-north-1" - } - }, - "sa_east_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "sa-east-1" - } - }, - "ca_central_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ca-central-1" - } - }, - "cn_north_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "cn-north-1" - } - }, - "af_south_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "af-south-1" - } - }, - "eu_south_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "eu-south-1" - } - }, - "eu_south_2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "eu-south-2" - } - } - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - } - } - }, - "com.amazonaws.route53#VPCs": { - "type": "list", - "member": { - "target": "com.amazonaws.route53#VPC", - "traits": { - "smithy.api#xmlName": "VPC" - } - }, - "traits": { - "smithy.api#documentation": "

(Private hosted zones only) A list of VPC elements.

", - "smithy.api#length": { - "min": 1 + "com.amazonaws.route53#CidrCollectionVersionMismatchException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.route53#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The CIDR collection version you provided, doesn't match the one in the\n\t\t\t\tListCidrCollections operation.

", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.route53#CidrList": { + "type": "list", + "member": { + "target": "com.amazonaws.route53#Cidr", + "traits": { + "smithy.api#xmlName": "Cidr" + } + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.route53#CidrLocationNameDefaultAllowed": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 16 + }, + "smithy.api#pattern": "^[0-9A-Za-z_\\-\\*]+$" + } + }, + "com.amazonaws.route53#CidrLocationNameDefaultNotAllowed": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 16 + }, + "smithy.api#pattern": "^[0-9A-Za-z_\\-]+$" + } + }, + "com.amazonaws.route53#CidrNonce": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^\\p{ASCII}+$" + } + }, + "com.amazonaws.route53#CidrRoutingConfig": { + "type": "structure", + "members": { + "CollectionId": { + "target": "com.amazonaws.route53#UUID", + "traits": { + "smithy.api#documentation": "

The CIDR collection ID.

", + "smithy.api#required": {} + } + }, + "LocationName": { + "target": "com.amazonaws.route53#CidrLocationNameDefaultAllowed", + "traits": { + "smithy.api#documentation": "

The CIDR collection location name.

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

The object that is specified in resource record set object when you are linking a\n\t\t\tresource record set to a CIDR location.

\n

A LocationName with an asterisk “*” can be used to create a default CIDR\n\t\t\trecord. CollectionId is still required for default record.

" + } + }, + "com.amazonaws.route53#CloudWatchAlarmConfiguration": { + "type": "structure", + "members": { + "EvaluationPeriods": { + "target": "com.amazonaws.route53#EvaluationPeriods", + "traits": { + "smithy.api#documentation": "

For the metric that the CloudWatch alarm is associated with, the number of periods\n\t\t\tthat the metric is compared to the threshold.

", + "smithy.api#required": {} + } + }, + "Threshold": { + "target": "com.amazonaws.route53#Threshold", + "traits": { + "smithy.api#documentation": "

For the metric that the CloudWatch alarm is associated with, the value the metric is\n\t\t\tcompared with.

", + "smithy.api#required": {} + } + }, + "ComparisonOperator": { + "target": "com.amazonaws.route53#ComparisonOperator", + "traits": { + "smithy.api#documentation": "

For the metric that the CloudWatch alarm is associated with, the arithmetic operation\n\t\t\tthat is used for the comparison.

", + "smithy.api#required": {} + } + }, + "Period": { + "target": "com.amazonaws.route53#Period", + "traits": { + "smithy.api#documentation": "

For the metric that the CloudWatch alarm is associated with, the duration of one\n\t\t\tevaluation period in seconds.

", + "smithy.api#required": {} + } + }, + "MetricName": { + "target": "com.amazonaws.route53#MetricName", + "traits": { + "smithy.api#documentation": "

The name of the CloudWatch metric that the alarm is associated with.

", + "smithy.api#required": {} + } + }, + "Namespace": { + "target": "com.amazonaws.route53#Namespace", + "traits": { + "smithy.api#documentation": "

The namespace of the metric that the alarm is associated with. For more information,\n\t\t\tsee Amazon\n\t\t\t\tCloudWatch Namespaces, Dimensions, and Metrics Reference in the\n\t\t\t\tAmazon CloudWatch User Guide.

", + "smithy.api#required": {} + } + }, + "Statistic": { + "target": "com.amazonaws.route53#Statistic", + "traits": { + "smithy.api#documentation": "

For the metric that the CloudWatch alarm is associated with, the statistic that is\n\t\t\tapplied to the metric.

", + "smithy.api#required": {} + } + }, + "Dimensions": { + "target": "com.amazonaws.route53#DimensionList", + "traits": { + "smithy.api#documentation": "

For the metric that the CloudWatch alarm is associated with, a complex type that\n\t\t\tcontains information about the dimensions for the metric. For information, see Amazon\n\t\t\t\tCloudWatch Namespaces, Dimensions, and Metrics Reference in the\n\t\t\t\tAmazon CloudWatch User Guide.

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

A complex type that contains information about the CloudWatch alarm that Amazon Route\n\t\t\t53 is monitoring for this health check.

" + } + }, + "com.amazonaws.route53#CloudWatchLogsLogGroupArn": { + "type": "string" + }, + "com.amazonaws.route53#CloudWatchRegion": { + "type": "enum", + "members": { + "us_east_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "us-east-1" + } + }, + "us_east_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "us-east-2" + } + }, + "us_west_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "us-west-1" + } + }, + "us_west_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "us-west-2" + } + }, + "ca_central_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ca-central-1" + } + }, + "eu_central_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "eu-central-1" + } + }, + "eu_central_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "eu-central-2" + } + }, + "eu_west_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "eu-west-1" + } + }, + "eu_west_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "eu-west-2" + } + }, + "eu_west_3": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "eu-west-3" + } + }, + "ap_east_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-east-1" + } + }, + "me_south_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "me-south-1" + } + }, + "me_central_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "me-central-1" + } + }, + "ap_south_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-south-1" + } + }, + "ap_south_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-south-2" + } + }, + "ap_southeast_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-southeast-1" + } + }, + "ap_southeast_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-southeast-2" + } + }, + "ap_southeast_3": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-southeast-3" + } + }, + "ap_northeast_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-northeast-1" + } + }, + "ap_northeast_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-northeast-2" + } + }, + "ap_northeast_3": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-northeast-3" + } + }, + "eu_north_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "eu-north-1" + } + }, + "sa_east_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "sa-east-1" + } + }, + "cn_northwest_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "cn-northwest-1" + } + }, + "cn_north_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "cn-north-1" + } + }, + "af_south_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "af-south-1" + } + }, + "eu_south_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "eu-south-1" + } + }, + "eu_south_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "eu-south-2" + } + }, + "us_gov_west_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "us-gov-west-1" + } + }, + "us_gov_east_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "us-gov-east-1" + } + }, + "us_iso_east_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "us-iso-east-1" + } + }, + "us_iso_west_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "us-iso-west-1" + } + }, + "us_isob_east_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "us-isob-east-1" + } + }, + "ap_southeast_4": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-southeast-4" + } + } + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + } + } + }, + "com.amazonaws.route53#CollectionName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[0-9A-Za-z_\\-]+$" + } + }, + "com.amazonaws.route53#CollectionSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.route53#CollectionSummary" + } + }, + "com.amazonaws.route53#CollectionSummary": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.route53#ARN", + "traits": { + "smithy.api#documentation": "

The ARN of the collection summary. Can be used to reference the collection in IAM\n\t\t\tpolicy or cross-account.

" + } + }, + "Id": { + "target": "com.amazonaws.route53#UUID", + "traits": { + "smithy.api#documentation": "

Unique ID for the CIDR collection.

" + } + }, + "Name": { + "target": "com.amazonaws.route53#CollectionName", + "traits": { + "smithy.api#documentation": "

The name of a CIDR collection.

" + } + }, + "Version": { + "target": "com.amazonaws.route53#CollectionVersion", + "traits": { + "smithy.api#documentation": "

A sequential counter that Route 53 sets to 1 when you create a CIDR\n\t\t\tcollection and increments by 1 each time you update settings for the CIDR\n\t\t\tcollection.

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

A complex type that is an entry in an CidrCollection\n\t\t\tarray.

" + } + }, + "com.amazonaws.route53#CollectionVersion": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.route53#ComparisonOperator": { + "type": "enum", + "members": { + "GreaterThanOrEqualToThreshold": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GreaterThanOrEqualToThreshold" + } + }, + "GreaterThanThreshold": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GreaterThanThreshold" + } + }, + "LessThanThreshold": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LessThanThreshold" + } + }, + "LessThanOrEqualToThreshold": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LessThanOrEqualToThreshold" + } + } + } + }, + "com.amazonaws.route53#ConcurrentModification": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage", + "traits": { + "smithy.api#documentation": "

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

Another user submitted a request to create, update, or delete the object at the same\n\t\t\ttime that you did. Retry the request.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.route53#ConflictingDomainExists": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The cause of this error depends on the operation that you're performing:

\n ", + "smithy.api#error": "client" + } + }, + "com.amazonaws.route53#ConflictingTypes": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage", + "traits": { + "smithy.api#documentation": "

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

You tried to update a traffic policy instance by using a traffic policy version that\n\t\t\thas a different DNS type than the current type for the instance. You specified the type\n\t\t\tin the JSON document in the CreateTrafficPolicy or\n\t\t\t\tCreateTrafficPolicyVersionrequest.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.route53#CreateCidrCollection": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#CreateCidrCollectionRequest" + }, + "output": { + "target": "com.amazonaws.route53#CreateCidrCollectionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#CidrCollectionAlreadyExistsException" + }, + { + "target": "com.amazonaws.route53#ConcurrentModification" + }, + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#LimitsExceeded" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a CIDR collection in the current Amazon Web Services account.

", + "smithy.api#http": { + "method": "POST", + "uri": "/2013-04-01/cidrcollection", + "code": 201 + } + } + }, + "com.amazonaws.route53#CreateCidrCollectionRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.route53#CollectionName", + "traits": { + "smithy.api#documentation": "

A unique identifier for the account that can be used to reference the collection from\n\t\t\tother API calls.

", + "smithy.api#required": {} + } + }, + "CallerReference": { + "target": "com.amazonaws.route53#CidrNonce", + "traits": { + "smithy.api#documentation": "

A client-specific token that allows requests to be securely retried so that the\n\t\t\tintended outcome will only occur once, retries receive a similar response, and there are\n\t\t\tno additional edge cases to handle.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.route53#CreateCidrCollectionResponse": { + "type": "structure", + "members": { + "Collection": { + "target": "com.amazonaws.route53#CidrCollection", + "traits": { + "smithy.api#documentation": "

A complex type that contains information about the CIDR collection.

" + } + }, + "Location": { + "target": "com.amazonaws.route53#ResourceURI", + "traits": { + "smithy.api#documentation": "

A unique URL that represents the location for the CIDR collection.

", + "smithy.api#httpHeader": "Location" + } + } + } + }, + "com.amazonaws.route53#CreateHealthCheck": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#CreateHealthCheckRequest" + }, + "output": { + "target": "com.amazonaws.route53#CreateHealthCheckResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#HealthCheckAlreadyExists" + }, + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#TooManyHealthChecks" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new health check.

\n

For information about adding health checks to resource record sets, see HealthCheckId in ChangeResourceRecordSets.

\n

\n ELB Load Balancers\n

\n

If you're registering EC2 instances with an Elastic Load Balancing (ELB) load\n\t\t\tbalancer, do not create Amazon Route 53 health checks for the EC2 instances. When you\n\t\t\tregister an EC2 instance with a load balancer, you configure settings for an ELB health\n\t\t\tcheck, which performs a similar function to a Route 53 health check.

\n

\n Private Hosted Zones\n

\n

You can associate health checks with failover resource record sets in a private hosted\n\t\t\tzone. Note the following:

\n ", + "smithy.api#http": { + "method": "POST", + "uri": "/2013-04-01/healthcheck", + "code": 201 + } + } + }, + "com.amazonaws.route53#CreateHealthCheckRequest": { + "type": "structure", + "members": { + "CallerReference": { + "target": "com.amazonaws.route53#HealthCheckNonce", + "traits": { + "smithy.api#documentation": "

A unique string that identifies the request and that allows you to retry a failed\n\t\t\t\tCreateHealthCheck request without the risk of creating two identical\n\t\t\thealth checks:

\n ", + "smithy.api#required": {} + } + }, + "HealthCheckConfig": { + "target": "com.amazonaws.route53#HealthCheckConfig", + "traits": { + "smithy.api#documentation": "

A complex type that contains settings for a new health check.

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

A complex type that contains the health check request information.

" + } + }, + "com.amazonaws.route53#CreateHealthCheckResponse": { + "type": "structure", + "members": { + "HealthCheck": { + "target": "com.amazonaws.route53#HealthCheck", + "traits": { + "smithy.api#documentation": "

A complex type that contains identifying information about the health check.

", + "smithy.api#required": {} + } + }, + "Location": { + "target": "com.amazonaws.route53#ResourceURI", + "traits": { + "smithy.api#documentation": "

The unique URL representing the new health check.

", + "smithy.api#httpHeader": "Location", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A complex type containing the response information for the new health check.

" + } + }, + "com.amazonaws.route53#CreateHostedZone": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#CreateHostedZoneRequest" + }, + "output": { + "target": "com.amazonaws.route53#CreateHostedZoneResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#ConflictingDomainExists" + }, + { + "target": "com.amazonaws.route53#DelegationSetNotAvailable" + }, + { + "target": "com.amazonaws.route53#DelegationSetNotReusable" + }, + { + "target": "com.amazonaws.route53#HostedZoneAlreadyExists" + }, + { + "target": "com.amazonaws.route53#InvalidDomainName" + }, + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#InvalidVPCId" + }, + { + "target": "com.amazonaws.route53#NoSuchDelegationSet" + }, + { + "target": "com.amazonaws.route53#TooManyHostedZones" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new public or private hosted zone. You create records in a public hosted\n\t\t\tzone to define how you want to route traffic on the internet for a domain, such as\n\t\t\texample.com, and its subdomains (apex.example.com, acme.example.com). You create records\n\t\t\tin a private hosted zone to define how you want to route traffic for a domain and its\n\t\t\tsubdomains within one or more Amazon Virtual Private Clouds (Amazon VPCs).

\n \n

You can't convert a public hosted zone to a private hosted zone or vice versa.\n\t\t\t\tInstead, you must create a new hosted zone with the same name and create new\n\t\t\t\tresource record sets.

\n \n

For more information about charges for hosted zones, see Amazon Route 53 Pricing.

\n

Note the following:

\n \n

When you submit a CreateHostedZone request, the initial status of the\n\t\t\thosted zone is PENDING. For public hosted zones, this means that the NS and\n\t\t\tSOA records are not yet available on all Route 53 DNS servers. When the NS and\n\t\t\tSOA records are available, the status of the zone changes to INSYNC.

\n

The CreateHostedZone request requires the caller to have an\n\t\t\t\tec2:DescribeVpcs permission.

\n \n

When creating private hosted zones, the Amazon VPC must belong to the same\n\t\t\t\tpartition where the hosted zone is created. A partition is a group of Amazon Web Services Regions. Each Amazon Web Services account is scoped to one\n\t\t\t\tpartition.

\n

The following are the supported partitions:

\n \n

For more information, see Access Management\n\t\t\t\tin the Amazon Web Services General Reference.

\n ", + "smithy.api#http": { + "method": "POST", + "uri": "/2013-04-01/hostedzone", + "code": 201 + } + } + }, + "com.amazonaws.route53#CreateHostedZoneRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.route53#DNSName", + "traits": { + "smithy.api#documentation": "

The name of the domain. Specify a fully qualified domain name, for example,\n\t\t\t\twww.example.com. The trailing dot is optional; Amazon Route 53 assumes that the domain name is fully qualified. This means that\n\t\t\t\tRoute 53 treats www.example.com (without a trailing\n\t\t\tdot) and www.example.com. (with a trailing dot) as\n\t\t\tidentical.

\n

If you're creating a public hosted zone, this is the name you have registered with\n\t\t\tyour DNS registrar. If your domain name is registered with a registrar other than\n\t\t\t\tRoute 53, change the name servers for your domain to the set of\n\t\t\t\tNameServers that CreateHostedZone returns in\n\t\t\t\tDelegationSet.

", + "smithy.api#required": {} + } + }, + "VPC": { + "target": "com.amazonaws.route53#VPC", + "traits": { + "smithy.api#documentation": "

(Private hosted zones only) A complex type that contains information about the Amazon\n\t\t\tVPC that you're associating with this hosted zone.

\n

You can specify only one Amazon VPC when you create a private hosted zone. If you are\n\t\t\tassociating a VPC with a hosted zone with this request, the paramaters\n\t\t\t\tVPCId and VPCRegion are also required.

\n

To associate additional Amazon VPCs with the hosted zone, use AssociateVPCWithHostedZone after you create a hosted zone.

" + } + }, + "CallerReference": { + "target": "com.amazonaws.route53#Nonce", + "traits": { + "smithy.api#documentation": "

A unique string that identifies the request and that allows failed\n\t\t\t\tCreateHostedZone requests to be retried without the risk of executing\n\t\t\tthe operation twice. You must use a unique CallerReference string every\n\t\t\ttime you submit a CreateHostedZone request. CallerReference\n\t\t\tcan be any unique string, for example, a date/time stamp.

", + "smithy.api#required": {} + } + }, + "HostedZoneConfig": { + "target": "com.amazonaws.route53#HostedZoneConfig", + "traits": { + "smithy.api#documentation": "

(Optional) A complex type that contains the following optional values:

\n \n

If you don't specify a comment or the PrivateZone element, omit\n\t\t\t\tHostedZoneConfig and the other elements.

" + } + }, + "DelegationSetId": { + "target": "com.amazonaws.route53#ResourceId", + "traits": { + "smithy.api#documentation": "

If you want to associate a reusable delegation set with this hosted zone, the ID that\n\t\t\t\tAmazon Route 53 assigned to the reusable delegation set when you created it.\n\t\t\tFor more information about reusable delegation sets, see CreateReusableDelegationSet.

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

A complex type that contains information about the request to create a public or\n\t\t\tprivate hosted zone.

" + } + }, + "com.amazonaws.route53#CreateHostedZoneResponse": { + "type": "structure", + "members": { + "HostedZone": { + "target": "com.amazonaws.route53#HostedZone", + "traits": { + "smithy.api#documentation": "

A complex type that contains general information about the hosted zone.

", + "smithy.api#required": {} + } + }, + "ChangeInfo": { + "target": "com.amazonaws.route53#ChangeInfo", + "traits": { + "smithy.api#documentation": "

A complex type that contains information about the CreateHostedZone\n\t\t\trequest.

", + "smithy.api#required": {} + } + }, + "DelegationSet": { + "target": "com.amazonaws.route53#DelegationSet", + "traits": { + "smithy.api#documentation": "

A complex type that describes the name servers for this hosted zone.

", + "smithy.api#required": {} + } + }, + "VPC": { + "target": "com.amazonaws.route53#VPC", + "traits": { + "smithy.api#documentation": "

A complex type that contains information about an Amazon VPC that you associated with\n\t\t\tthis hosted zone.

" + } + }, + "Location": { + "target": "com.amazonaws.route53#ResourceURI", + "traits": { + "smithy.api#documentation": "

The unique URL representing the new hosted zone.

", + "smithy.api#httpHeader": "Location", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A complex type containing the response information for the hosted zone.

" + } + }, + "com.amazonaws.route53#CreateKeySigningKey": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#CreateKeySigningKeyRequest" + }, + "output": { + "target": "com.amazonaws.route53#CreateKeySigningKeyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#ConcurrentModification" + }, + { + "target": "com.amazonaws.route53#InvalidArgument" + }, + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#InvalidKeySigningKeyName" + }, + { + "target": "com.amazonaws.route53#InvalidKeySigningKeyStatus" + }, + { + "target": "com.amazonaws.route53#InvalidKMSArn" + }, + { + "target": "com.amazonaws.route53#InvalidSigningStatus" + }, + { + "target": "com.amazonaws.route53#KeySigningKeyAlreadyExists" + }, + { + "target": "com.amazonaws.route53#NoSuchHostedZone" + }, + { + "target": "com.amazonaws.route53#TooManyKeySigningKeys" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new key-signing key (KSK) associated with a hosted zone. You can only have\n\t\t\ttwo KSKs per hosted zone.

", + "smithy.api#http": { + "method": "POST", + "uri": "/2013-04-01/keysigningkey", + "code": 201 + } + } + }, + "com.amazonaws.route53#CreateKeySigningKeyRequest": { + "type": "structure", + "members": { + "CallerReference": { + "target": "com.amazonaws.route53#Nonce", + "traits": { + "smithy.api#documentation": "

A unique string that identifies the request.

", + "smithy.api#required": {} + } + }, + "HostedZoneId": { + "target": "com.amazonaws.route53#ResourceId", + "traits": { + "smithy.api#documentation": "

The unique string (ID) used to identify a hosted zone.

", + "smithy.api#required": {} + } + }, + "KeyManagementServiceArn": { + "target": "com.amazonaws.route53#SigningKeyString", + "traits": { + "smithy.api#documentation": "

The Amazon resource name (ARN) for a customer managed key in Key Management Service\n\t\t\t\t(KMS). The KeyManagementServiceArn must be unique for\n\t\t\teach key-signing key (KSK) in a single hosted zone. To see an example of\n\t\t\t\tKeyManagementServiceArn that grants the correct permissions for DNSSEC,\n\t\t\tscroll down to Example.

\n

You must configure the customer managed customer managed key as follows:

\n
\n
Status
\n
\n

Enabled

\n
\n
Key spec
\n
\n

ECC_NIST_P256

\n
\n
Key usage
\n
\n

Sign and verify

\n
\n
Key policy
\n
\n

The key policy must give permission for the following actions:

\n
    \n
  • \n

    DescribeKey

    \n
    • \n
  • \n

    GetPublicKey

    \n
    • \n
  • \n

    Sign

    \n
    • \n
\n

The key policy must also include the Amazon Route 53 service in the\n\t\t\t\t\t\tprincipal for your account. Specify the following:

\n
    \n
  • \n

    \n \"Service\": \"dnssec-route53.amazonaws.com\"\n

    \n
    • \n
\n
\n
\n

For more information about working with a customer managed key in KMS, see Key Management Service concepts.

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.route53#SigningKeyName", + "traits": { + "smithy.api#documentation": "

A string used to identify a key-signing key (KSK). Name can include\n\t\t\tnumbers, letters, and underscores (_). Name must be unique for each\n\t\t\tkey-signing key in the same hosted zone.

", + "smithy.api#required": {} + } + }, + "Status": { + "target": "com.amazonaws.route53#SigningKeyStatus", + "traits": { + "smithy.api#documentation": "

A string specifying the initial status of the key-signing key (KSK). You can set the\n\t\t\tvalue to ACTIVE or INACTIVE.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.route53#CreateKeySigningKeyResponse": { + "type": "structure", + "members": { + "ChangeInfo": { + "target": "com.amazonaws.route53#ChangeInfo", + "traits": { + "smithy.api#required": {} + } + }, + "KeySigningKey": { + "target": "com.amazonaws.route53#KeySigningKey", + "traits": { + "smithy.api#documentation": "

The key-signing key (KSK) that the request creates.

", + "smithy.api#required": {} + } + }, + "Location": { + "target": "com.amazonaws.route53#ResourceURI", + "traits": { + "smithy.api#documentation": "

The unique URL representing the new key-signing key (KSK).

", + "smithy.api#httpHeader": "Location", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.route53#CreateQueryLoggingConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#CreateQueryLoggingConfigRequest" + }, + "output": { + "target": "com.amazonaws.route53#CreateQueryLoggingConfigResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#ConcurrentModification" + }, + { + "target": "com.amazonaws.route53#InsufficientCloudWatchLogsResourcePolicy" + }, + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#NoSuchCloudWatchLogsLogGroup" + }, + { + "target": "com.amazonaws.route53#NoSuchHostedZone" + }, + { + "target": "com.amazonaws.route53#QueryLoggingConfigAlreadyExists" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a configuration for DNS query logging. After you create a query logging\n\t\t\tconfiguration, Amazon Route 53 begins to publish log data to an Amazon CloudWatch Logs\n\t\t\tlog group.

\n

DNS query logs contain information about the queries that Route 53 receives for a\n\t\t\tspecified public hosted zone, such as the following:

\n \n
\n
Log Group and Resource Policy
\n
\n

Before you create a query logging configuration, perform the following\n\t\t\t\t\t\toperations.

\n \n

If you create a query logging configuration using the Route 53\n\t\t\t\t\t\t\tconsole, Route 53 performs these operations automatically.

\n \n
    \n
  1. \n

    Create a CloudWatch Logs log group, and make note of the ARN,\n\t\t\t\t\t\t\t\twhich you specify when you create a query logging configuration.\n\t\t\t\t\t\t\t\tNote the following:

    \n
      \n
    • \n

      You must create the log group in the us-east-1\n\t\t\t\t\t\t\t\t\t\tregion.

      \n
      • \n
    • \n

      You must use the same Amazon Web Services account to create\n\t\t\t\t\t\t\t\t\t\tthe log group and the hosted zone that you want to configure\n\t\t\t\t\t\t\t\t\t\tquery logging for.

      \n
      • \n
    • \n

      When you create log groups for query logging, we recommend\n\t\t\t\t\t\t\t\t\t\tthat you use a consistent prefix, for example:

      \n

      \n /aws/route53/hosted zone\n\t\t\t\t\t\t\t\t\t\t\tname\n \n

      \n

      In the next step, you'll create a resource policy, which\n\t\t\t\t\t\t\t\t\t\tcontrols access to one or more log groups and the associated\n\t\t\t\t\t\t\t\t\t\t\tAmazon Web Services resources, such as Route 53 hosted\n\t\t\t\t\t\t\t\t\t\tzones. There's a limit on the number of resource policies\n\t\t\t\t\t\t\t\t\t\tthat you can create, so we recommend that you use a\n\t\t\t\t\t\t\t\t\t\tconsistent prefix so you can use the same resource policy\n\t\t\t\t\t\t\t\t\t\tfor all the log groups that you create for query\n\t\t\t\t\t\t\t\t\t\tlogging.

      \n
      • \n
    \n
    2. \n
  2. \n

    Create a CloudWatch Logs resource policy, and give it the\n\t\t\t\t\t\t\t\tpermissions that Route 53 needs to create log streams and to send\n\t\t\t\t\t\t\t\tquery logs to log streams. For the value of Resource,\n\t\t\t\t\t\t\t\tspecify the ARN for the log group that you created in the previous\n\t\t\t\t\t\t\t\tstep. To use the same resource policy for all the CloudWatch Logs\n\t\t\t\t\t\t\t\tlog groups that you created for query logging configurations,\n\t\t\t\t\t\t\t\treplace the hosted zone name with *, for\n\t\t\t\t\t\t\t\texample:

    \n

    \n arn:aws:logs:us-east-1:123412341234:log-group:/aws/route53/*\n

    \n

    To avoid the confused deputy problem, a security issue where an\n\t\t\t\t\t\t\t\tentity without a permission for an action can coerce a\n\t\t\t\t\t\t\t\tmore-privileged entity to perform it, you can optionally limit the\n\t\t\t\t\t\t\t\tpermissions that a service has to a resource in a resource-based\n\t\t\t\t\t\t\t\tpolicy by supplying the following values:

    \n
      \n
    • \n

      For aws:SourceArn, supply the hosted zone ARN\n\t\t\t\t\t\t\t\t\t\tused in creating the query logging configuration. For\n\t\t\t\t\t\t\t\t\t\texample, aws:SourceArn:\n\t\t\t\t\t\t\t\t\t\t\tarn:aws:route53:::hostedzone/hosted zone\n\t\t\t\t\t\t\t\t\t\tID.

      \n
      • \n
    • \n

      For aws:SourceAccount, supply the account ID\n\t\t\t\t\t\t\t\t\t\tfor the account that creates the query logging\n\t\t\t\t\t\t\t\t\t\tconfiguration. For example,\n\t\t\t\t\t\t\t\t\t\t\taws:SourceAccount:111111111111.

      \n
      • \n
    \n

    For more information, see The confused\n\t\t\t\t\t\t\t\t\tdeputy problem in the Amazon Web Services\n\t\t\t\t\t\t\t\t\tIAM User Guide.

    \n \n

    You can't use the CloudWatch console to create or edit a\n\t\t\t\t\t\t\t\t\tresource policy. You must use the CloudWatch API, one of the\n\t\t\t\t\t\t\t\t\t\tAmazon Web Services SDKs, or the CLI.

    \n     \n
    3. \n
\n
\n
Log Streams and Edge Locations
\n
\n

When Route 53 finishes creating the configuration for DNS query logging,\n\t\t\t\t\t\tit does the following:

\n
    \n
  • \n

    Creates a log stream for an edge location the first time that the\n\t\t\t\t\t\t\t\tedge location responds to DNS queries for the specified hosted zone.\n\t\t\t\t\t\t\t\tThat log stream is used to log all queries that Route 53 responds to\n\t\t\t\t\t\t\t\tfor that edge location.

    \n
    • \n
  • \n

    Begins to send query logs to the applicable log stream.

    \n
    • \n
\n

The name of each log stream is in the following format:

\n

\n \n hosted zone ID/edge location\n\t\t\t\t\t\t\t\tcode\n \n

\n

The edge location code is a three-letter code and an arbitrarily assigned\n\t\t\t\t\t\tnumber, for example, DFW3. The three-letter code typically corresponds with\n\t\t\t\t\t\tthe International Air Transport Association airport code for an airport near\n\t\t\t\t\t\tthe edge location. (These abbreviations might change in the future.) For a\n\t\t\t\t\t\tlist of edge locations, see \"The Route 53 Global Network\" on the Route 53 Product Details\n\t\t\t\t\t\tpage.

\n
\n
Queries That Are Logged
\n
\n

Query logs contain only the queries that DNS resolvers forward to Route\n\t\t\t\t\t\t53. If a DNS resolver has already cached the response to a query (such as\n\t\t\t\t\t\tthe IP address for a load balancer for example.com), the resolver will\n\t\t\t\t\t\tcontinue to return the cached response. It doesn't forward another query to\n\t\t\t\t\t\tRoute 53 until the TTL for the corresponding resource record set expires.\n\t\t\t\t\t\tDepending on how many DNS queries are submitted for a resource record set,\n\t\t\t\t\t\tand depending on the TTL for that resource record set, query logs might\n\t\t\t\t\t\tcontain information about only one query out of every several thousand\n\t\t\t\t\t\tqueries that are submitted to DNS. For more information about how DNS works,\n\t\t\t\t\t\tsee Routing\n\t\t\t\t\t\t\tInternet Traffic to Your Website or Web Application in the\n\t\t\t\t\t\t\tAmazon Route 53 Developer Guide.

\n
\n
Log File Format
\n
\n

For a list of the values in each query log and the format of each value,\n\t\t\t\t\t\tsee Logging DNS\n\t\t\t\t\t\t\tQueries in the Amazon Route 53 Developer\n\t\t\t\t\t\t\tGuide.

\n
\n
Pricing
\n
\n

For information about charges for query logs, see Amazon CloudWatch Pricing.

\n
\n
How to Stop Logging
\n
\n

If you want Route 53 to stop sending query logs to CloudWatch Logs, delete\n\t\t\t\t\t\tthe query logging configuration. For more information, see DeleteQueryLoggingConfig.

\n
\n
", + "smithy.api#http": { + "method": "POST", + "uri": "/2013-04-01/queryloggingconfig", + "code": 201 + } + } + }, + "com.amazonaws.route53#CreateQueryLoggingConfigRequest": { + "type": "structure", + "members": { + "HostedZoneId": { + "target": "com.amazonaws.route53#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the hosted zone that you want to log queries for. You can log queries only\n\t\t\tfor public hosted zones.

", + "smithy.api#required": {} + } + }, + "CloudWatchLogsLogGroupArn": { + "target": "com.amazonaws.route53#CloudWatchLogsLogGroupArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the log group that you want to Amazon Route 53 to\n\t\t\tsend query logs to. This is the format of the ARN:

\n

arn:aws:logs:region:account-id:log-group:log_group_name\n

\n

To get the ARN for a log group, you can use the CloudWatch console, the DescribeLogGroups API action, the describe-log-groups\n\t\t\tcommand, or the applicable command in one of the Amazon Web Services SDKs.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.route53#CreateQueryLoggingConfigResponse": { + "type": "structure", + "members": { + "QueryLoggingConfig": { + "target": "com.amazonaws.route53#QueryLoggingConfig", + "traits": { + "smithy.api#documentation": "

A complex type that contains the ID for a query logging configuration, the ID of the\n\t\t\thosted zone that you want to log queries for, and the ARN for the log group that you\n\t\t\twant Amazon Route 53 to send query logs to.

", + "smithy.api#required": {} + } + }, + "Location": { + "target": "com.amazonaws.route53#ResourceURI", + "traits": { + "smithy.api#documentation": "

The unique URL representing the new query logging configuration.

", + "smithy.api#httpHeader": "Location", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.route53#CreateReusableDelegationSet": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#CreateReusableDelegationSetRequest" + }, + "output": { + "target": "com.amazonaws.route53#CreateReusableDelegationSetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#DelegationSetAlreadyCreated" + }, + { + "target": "com.amazonaws.route53#DelegationSetAlreadyReusable" + }, + { + "target": "com.amazonaws.route53#DelegationSetNotAvailable" + }, + { + "target": "com.amazonaws.route53#HostedZoneNotFound" + }, + { + "target": "com.amazonaws.route53#InvalidArgument" + }, + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#LimitsExceeded" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a delegation set (a group of four name servers) that can be reused by multiple\n\t\t\thosted zones that were created by the same Amazon Web Services account.

\n

You can also create a reusable delegation set that uses the four name servers that are\n\t\t\tassociated with an existing hosted zone. Specify the hosted zone ID in the\n\t\t\t\tCreateReusableDelegationSet request.

\n \n

You can't associate a reusable delegation set with a private hosted zone.

\n \n

For information about using a reusable delegation set to configure white label name\n\t\t\tservers, see Configuring White\n\t\t\t\tLabel Name Servers.

\n

The process for migrating existing hosted zones to use a reusable delegation set is\n\t\t\tcomparable to the process for configuring white label name servers. You need to perform\n\t\t\tthe following steps:

\n
    \n
  1. \n

    Create a reusable delegation set.

    \n
    2. \n
  2. \n

    Recreate hosted zones, and reduce the TTL to 60 seconds or less.

    \n
    3. \n
  3. \n

    Recreate resource record sets in the new hosted zones.

    \n
    4. \n
  4. \n

    Change the registrar's name servers to use the name servers for the new hosted\n\t\t\t\t\tzones.

    \n
    5. \n
  5. \n

    Monitor traffic for the website or application.

    \n
    6. \n
  6. \n

    Change TTLs back to their original values.

    \n
    7. \n
\n

If you want to migrate existing hosted zones to use a reusable delegation set, the\n\t\t\texisting hosted zones can't use any of the name servers that are assigned to the\n\t\t\treusable delegation set. If one or more hosted zones do use one or more name servers\n\t\t\tthat are assigned to the reusable delegation set, you can do one of the\n\t\t\tfollowing:

\n ", + "smithy.api#http": { + "method": "POST", + "uri": "/2013-04-01/delegationset", + "code": 201 + } + } + }, + "com.amazonaws.route53#CreateReusableDelegationSetRequest": { + "type": "structure", + "members": { + "CallerReference": { + "target": "com.amazonaws.route53#Nonce", + "traits": { + "smithy.api#documentation": "

A unique string that identifies the request, and that allows you to retry failed\n\t\t\t\tCreateReusableDelegationSet requests without the risk of executing the\n\t\t\toperation twice. You must use a unique CallerReference string every time\n\t\t\tyou submit a CreateReusableDelegationSet request.\n\t\t\t\tCallerReference can be any unique string, for example a date/time\n\t\t\tstamp.

", + "smithy.api#required": {} + } + }, + "HostedZoneId": { + "target": "com.amazonaws.route53#ResourceId", + "traits": { + "smithy.api#documentation": "

If you want to mark the delegation set for an existing hosted zone as reusable, the ID\n\t\t\tfor that hosted zone.

" + } + } + } + }, + "com.amazonaws.route53#CreateReusableDelegationSetResponse": { + "type": "structure", + "members": { + "DelegationSet": { + "target": "com.amazonaws.route53#DelegationSet", + "traits": { + "smithy.api#documentation": "

A complex type that contains name server information.

", + "smithy.api#required": {} + } + }, + "Location": { + "target": "com.amazonaws.route53#ResourceURI", + "traits": { + "smithy.api#documentation": "

The unique URL representing the new reusable delegation set.

", + "smithy.api#httpHeader": "Location", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.route53#CreateTrafficPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#CreateTrafficPolicyRequest" + }, + "output": { + "target": "com.amazonaws.route53#CreateTrafficPolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#InvalidTrafficPolicyDocument" + }, + { + "target": "com.amazonaws.route53#TooManyTrafficPolicies" + }, + { + "target": "com.amazonaws.route53#TrafficPolicyAlreadyExists" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a traffic policy, which you use to create multiple DNS resource record sets\n\t\t\tfor one domain name (such as example.com) or one subdomain name (such as\n\t\t\twww.example.com).

", + "smithy.api#http": { + "method": "POST", + "uri": "/2013-04-01/trafficpolicy", + "code": 201 + } + } + }, + "com.amazonaws.route53#CreateTrafficPolicyInstance": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#CreateTrafficPolicyInstanceRequest" + }, + "output": { + "target": "com.amazonaws.route53#CreateTrafficPolicyInstanceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#NoSuchHostedZone" + }, + { + "target": "com.amazonaws.route53#NoSuchTrafficPolicy" + }, + { + "target": "com.amazonaws.route53#TooManyTrafficPolicyInstances" + }, + { + "target": "com.amazonaws.route53#TrafficPolicyInstanceAlreadyExists" + } + ], + "traits": { + "smithy.api#documentation": "

Creates resource record sets in a specified hosted zone based on the settings in a\n\t\t\tspecified traffic policy version. In addition, CreateTrafficPolicyInstance\n\t\t\tassociates the resource record sets with a specified domain name (such as example.com)\n\t\t\tor subdomain name (such as www.example.com). Amazon Route 53 responds to DNS queries for\n\t\t\tthe domain or subdomain name by using the resource record sets that\n\t\t\t\tCreateTrafficPolicyInstance created.

", + "smithy.api#http": { + "method": "POST", + "uri": "/2013-04-01/trafficpolicyinstance", + "code": 201 + } + } + }, + "com.amazonaws.route53#CreateTrafficPolicyInstanceRequest": { + "type": "structure", + "members": { + "HostedZoneId": { + "target": "com.amazonaws.route53#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the hosted zone that you want Amazon Route 53 to create resource record sets\n\t\t\tin by using the configuration in a traffic policy.

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.route53#DNSName", + "traits": { + "smithy.api#documentation": "

The domain name (such as example.com) or subdomain name (such as www.example.com) for\n\t\t\twhich Amazon Route 53 responds to DNS queries by using the resource record sets that\n\t\t\tRoute 53 creates for this traffic policy instance.

", + "smithy.api#required": {} + } + }, + "TTL": { + "target": "com.amazonaws.route53#TTL", + "traits": { + "smithy.api#documentation": "

(Optional) The TTL that you want Amazon Route 53 to assign to all of the resource\n\t\t\trecord sets that it creates in the specified hosted zone.

", + "smithy.api#required": {} + } + }, + "TrafficPolicyId": { + "target": "com.amazonaws.route53#TrafficPolicyId", + "traits": { + "smithy.api#documentation": "

The ID of the traffic policy that you want to use to create resource record sets in\n\t\t\tthe specified hosted zone.

", + "smithy.api#required": {} + } + }, + "TrafficPolicyVersion": { + "target": "com.amazonaws.route53#TrafficPolicyVersion", + "traits": { + "smithy.api#documentation": "

The version of the traffic policy that you want to use to create resource record sets\n\t\t\tin the specified hosted zone.

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

A complex type that contains information about the resource record sets that you want\n\t\t\tto create based on a specified traffic policy.

" + } + }, + "com.amazonaws.route53#CreateTrafficPolicyInstanceResponse": { + "type": "structure", + "members": { + "TrafficPolicyInstance": { + "target": "com.amazonaws.route53#TrafficPolicyInstance", + "traits": { + "smithy.api#documentation": "

A complex type that contains settings for the new traffic policy instance.

", + "smithy.api#required": {} + } + }, + "Location": { + "target": "com.amazonaws.route53#ResourceURI", + "traits": { + "smithy.api#documentation": "

A unique URL that represents a new traffic policy instance.

", + "smithy.api#httpHeader": "Location", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A complex type that contains the response information for the\n\t\t\t\tCreateTrafficPolicyInstance request.

" + } + }, + "com.amazonaws.route53#CreateTrafficPolicyRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.route53#TrafficPolicyName", + "traits": { + "smithy.api#documentation": "

The name of the traffic policy.

", + "smithy.api#required": {} + } + }, + "Document": { + "target": "com.amazonaws.route53#TrafficPolicyDocument", + "traits": { + "smithy.api#documentation": "

The definition of this traffic policy in JSON format. For more information, see Traffic Policy Document Format.

", + "smithy.api#required": {} + } + }, + "Comment": { + "target": "com.amazonaws.route53#TrafficPolicyComment", + "traits": { + "smithy.api#documentation": "

(Optional) Any comments that you want to include about the traffic policy.

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

A complex type that contains information about the traffic policy that you want to\n\t\t\tcreate.

" + } + }, + "com.amazonaws.route53#CreateTrafficPolicyResponse": { + "type": "structure", + "members": { + "TrafficPolicy": { + "target": "com.amazonaws.route53#TrafficPolicy", + "traits": { + "smithy.api#documentation": "

A complex type that contains settings for the new traffic policy.

", + "smithy.api#required": {} + } + }, + "Location": { + "target": "com.amazonaws.route53#ResourceURI", + "traits": { + "smithy.api#documentation": "

A unique URL that represents a new traffic policy.

", + "smithy.api#httpHeader": "Location", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A complex type that contains the response information for the\n\t\t\t\tCreateTrafficPolicy request.

" + } + }, + "com.amazonaws.route53#CreateTrafficPolicyVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#CreateTrafficPolicyVersionRequest" + }, + "output": { + "target": "com.amazonaws.route53#CreateTrafficPolicyVersionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#ConcurrentModification" + }, + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#InvalidTrafficPolicyDocument" + }, + { + "target": "com.amazonaws.route53#NoSuchTrafficPolicy" + }, + { + "target": "com.amazonaws.route53#TooManyTrafficPolicyVersionsForCurrentPolicy" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new version of an existing traffic policy. When you create a new version of\n\t\t\ta traffic policy, you specify the ID of the traffic policy that you want to update and a\n\t\t\tJSON-formatted document that describes the new version. You use traffic policies to\n\t\t\tcreate multiple DNS resource record sets for one domain name (such as example.com) or\n\t\t\tone subdomain name (such as www.example.com). You can create a maximum of 1000 versions\n\t\t\tof a traffic policy. If you reach the limit and need to create another version, you'll\n\t\t\tneed to start a new traffic policy.

", + "smithy.api#http": { + "method": "POST", + "uri": "/2013-04-01/trafficpolicy/{Id}", + "code": 201 + } + } + }, + "com.amazonaws.route53#CreateTrafficPolicyVersionRequest": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.route53#TrafficPolicyId", + "traits": { + "smithy.api#documentation": "

The ID of the traffic policy for which you want to create a new version.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Document": { + "target": "com.amazonaws.route53#TrafficPolicyDocument", + "traits": { + "smithy.api#documentation": "

The definition of this version of the traffic policy, in JSON format. You specified\n\t\t\tthe JSON in the CreateTrafficPolicyVersion request. For more information\n\t\t\tabout the JSON format, see CreateTrafficPolicy.

", + "smithy.api#required": {} + } + }, + "Comment": { + "target": "com.amazonaws.route53#TrafficPolicyComment", + "traits": { + "smithy.api#documentation": "

The comment that you specified in the CreateTrafficPolicyVersion request,\n\t\t\tif any.

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

A complex type that contains information about the traffic policy that you want to\n\t\t\tcreate a new version for.

" + } + }, + "com.amazonaws.route53#CreateTrafficPolicyVersionResponse": { + "type": "structure", + "members": { + "TrafficPolicy": { + "target": "com.amazonaws.route53#TrafficPolicy", + "traits": { + "smithy.api#documentation": "

A complex type that contains settings for the new version of the traffic\n\t\t\tpolicy.

", + "smithy.api#required": {} + } + }, + "Location": { + "target": "com.amazonaws.route53#ResourceURI", + "traits": { + "smithy.api#documentation": "

A unique URL that represents a new traffic policy version.

", + "smithy.api#httpHeader": "Location", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A complex type that contains the response information for the\n\t\t\t\tCreateTrafficPolicyVersion request.

" + } + }, + "com.amazonaws.route53#CreateVPCAssociationAuthorization": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#CreateVPCAssociationAuthorizationRequest" + }, + "output": { + "target": "com.amazonaws.route53#CreateVPCAssociationAuthorizationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#ConcurrentModification" + }, + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#InvalidVPCId" + }, + { + "target": "com.amazonaws.route53#NoSuchHostedZone" + }, + { + "target": "com.amazonaws.route53#TooManyVPCAssociationAuthorizations" + } + ], + "traits": { + "smithy.api#documentation": "

Authorizes the Amazon Web Services account that created a specified VPC to submit an\n\t\t\t\tAssociateVPCWithHostedZone request to associate the VPC with a\n\t\t\tspecified hosted zone that was created by a different account. To submit a\n\t\t\t\tCreateVPCAssociationAuthorization request, you must use the account\n\t\t\tthat created the hosted zone. After you authorize the association, use the account that\n\t\t\tcreated the VPC to submit an AssociateVPCWithHostedZone request.

\n \n

If you want to associate multiple VPCs that you created by using one account with\n\t\t\t\ta hosted zone that you created by using a different account, you must submit one\n\t\t\t\tauthorization request for each VPC.

\n ", + "smithy.api#http": { + "method": "POST", + "uri": "/2013-04-01/hostedzone/{HostedZoneId}/authorizevpcassociation", + "code": 200 + } + } + }, + "com.amazonaws.route53#CreateVPCAssociationAuthorizationRequest": { + "type": "structure", + "members": { + "HostedZoneId": { + "target": "com.amazonaws.route53#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the private hosted zone that you want to authorize associating a VPC\n\t\t\twith.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "VPC": { + "target": "com.amazonaws.route53#VPC", + "traits": { + "smithy.api#documentation": "

A complex type that contains the VPC ID and region for the VPC that you want to\n\t\t\tauthorize associating with your hosted zone.

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

A complex type that contains information about the request to authorize associating a\n\t\t\tVPC with your private hosted zone. Authorization is only required when a private hosted\n\t\t\tzone and a VPC were created by using different accounts.

" + } + }, + "com.amazonaws.route53#CreateVPCAssociationAuthorizationResponse": { + "type": "structure", + "members": { + "HostedZoneId": { + "target": "com.amazonaws.route53#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the hosted zone that you authorized associating a VPC with.

", + "smithy.api#required": {} + } + }, + "VPC": { + "target": "com.amazonaws.route53#VPC", + "traits": { + "smithy.api#documentation": "

The VPC that you authorized associating with a hosted zone.

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

A complex type that contains the response information from a\n\t\t\t\tCreateVPCAssociationAuthorization request.

" + } + }, + "com.amazonaws.route53#DNSName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + } + } + }, + "com.amazonaws.route53#DNSRCode": { + "type": "string" + }, + "com.amazonaws.route53#DNSSECNotFound": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The hosted zone doesn't have any DNSSEC resources.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.route53#DNSSECStatus": { + "type": "structure", + "members": { + "ServeSignature": { + "target": "com.amazonaws.route53#ServeSignature", + "traits": { + "smithy.api#documentation": "

A string that represents the current hosted zone signing status.

\n

Status can have one of the following values:

\n
\n
SIGNING
\n
\n

DNSSEC signing is enabled for the hosted zone.

\n
\n
NOT_SIGNING
\n
\n

DNSSEC signing is not enabled for the hosted zone.

\n
\n
DELETING
\n
\n

DNSSEC signing is in the process of being removed for the hosted\n\t\t\t\t\t\tzone.

\n
\n
ACTION_NEEDED
\n
\n

There is a problem with signing in the hosted zone that requires you to\n\t\t\t\t\t\ttake action to resolve. For example, the customer managed key might have\n\t\t\t\t\t\tbeen deleted, or the permissions for the customer managed key might have\n\t\t\t\t\t\tbeen changed.

\n
\n
INTERNAL_FAILURE
\n
\n

There was an error during a request. Before you can continue to work with\n\t\t\t\t\t\tDNSSEC signing, including with key-signing keys (KSKs), you must correct the\n\t\t\t\t\t\tproblem by enabling or disabling DNSSEC signing for the hosted zone.

\n
\n
" + } + }, + "StatusMessage": { + "target": "com.amazonaws.route53#SigningKeyStatusMessage", + "traits": { + "smithy.api#documentation": "

The status message provided for the following DNSSEC signing status:\n\t\t\t\tINTERNAL_FAILURE. The status message includes information about what\n\t\t\tthe problem might be and steps that you can take to correct the issue.

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

A string repesenting the status of DNSSEC signing.

" + } + }, + "com.amazonaws.route53#DeactivateKeySigningKey": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#DeactivateKeySigningKeyRequest" + }, + "output": { + "target": "com.amazonaws.route53#DeactivateKeySigningKeyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#ConcurrentModification" + }, + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#InvalidKeySigningKeyStatus" + }, + { + "target": "com.amazonaws.route53#InvalidSigningStatus" + }, + { + "target": "com.amazonaws.route53#KeySigningKeyInParentDSRecord" + }, + { + "target": "com.amazonaws.route53#KeySigningKeyInUse" + }, + { + "target": "com.amazonaws.route53#NoSuchKeySigningKey" + } + ], + "traits": { + "smithy.api#documentation": "

Deactivates a key-signing key (KSK) so that it will not be used for signing by DNSSEC.\n\t\t\tThis operation changes the KSK status to INACTIVE.

", + "smithy.api#http": { + "method": "POST", + "uri": "/2013-04-01/keysigningkey/{HostedZoneId}/{Name}/deactivate", + "code": 200 + } + } + }, + "com.amazonaws.route53#DeactivateKeySigningKeyRequest": { + "type": "structure", + "members": { + "HostedZoneId": { + "target": "com.amazonaws.route53#ResourceId", + "traits": { + "smithy.api#documentation": "

A unique string used to identify a hosted zone.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.route53#SigningKeyName", + "traits": { + "smithy.api#documentation": "

A string used to identify a key-signing key (KSK).

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.route53#DeactivateKeySigningKeyResponse": { + "type": "structure", + "members": { + "ChangeInfo": { + "target": "com.amazonaws.route53#ChangeInfo", + "traits": { + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.route53#DelegationSet": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.route53#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID that Amazon Route 53 assigns to a reusable delegation set.

" + } + }, + "CallerReference": { + "target": "com.amazonaws.route53#Nonce", + "traits": { + "smithy.api#documentation": "

The value that you specified for CallerReference when you created the\n\t\t\treusable delegation set.

" + } + }, + "NameServers": { + "target": "com.amazonaws.route53#DelegationSetNameServers", + "traits": { + "smithy.api#documentation": "

A complex type that contains a list of the authoritative name servers for a hosted\n\t\t\tzone or for a reusable delegation set.

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

A complex type that lists the name servers in a delegation set, as well as the\n\t\t\t\tCallerReference and the ID for the delegation set.

" + } + }, + "com.amazonaws.route53#DelegationSetAlreadyCreated": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage", + "traits": { + "smithy.api#documentation": "

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

A delegation set with the same owner and caller reference combination has already been\n\t\t\tcreated.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.route53#DelegationSetAlreadyReusable": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage", + "traits": { + "smithy.api#documentation": "

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

The specified delegation set has already been marked as reusable.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.route53#DelegationSetInUse": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage", + "traits": { + "smithy.api#documentation": "

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

The specified delegation contains associated hosted zones which must be deleted before\n\t\t\tthe reusable delegation set can be deleted.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.route53#DelegationSetNameServers": { + "type": "list", + "member": { + "target": "com.amazonaws.route53#DNSName", + "traits": { + "smithy.api#xmlName": "NameServer" + } + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.route53#DelegationSetNotAvailable": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage", + "traits": { + "smithy.api#documentation": "

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

You can create a hosted zone that has the same name as an existing hosted zone\n\t\t\t(example.com is common), but there is a limit to the number of hosted zones that have\n\t\t\tthe same name. If you get this error, Amazon Route 53 has reached that limit. If you own\n\t\t\tthe domain name and Route 53 generates this error, contact Customer Support.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.route53#DelegationSetNotReusable": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage", + "traits": { + "smithy.api#documentation": "

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

A reusable delegation set with the specified ID does not exist.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.route53#DelegationSets": { + "type": "list", + "member": { + "target": "com.amazonaws.route53#DelegationSet", + "traits": { + "smithy.api#xmlName": "DelegationSet" + } + } + }, + "com.amazonaws.route53#DeleteCidrCollection": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#DeleteCidrCollectionRequest" + }, + "output": { + "target": "com.amazonaws.route53#DeleteCidrCollectionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#CidrCollectionInUseException" + }, + { + "target": "com.amazonaws.route53#ConcurrentModification" + }, + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#NoSuchCidrCollectionException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a CIDR collection in the current Amazon Web Services account. The collection\n\t\t\tmust be empty before it can be deleted.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/2013-04-01/cidrcollection/{Id}", + "code": 200 + } + } + }, + "com.amazonaws.route53#DeleteCidrCollectionRequest": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.route53#UUID", + "traits": { + "smithy.api#documentation": "

The UUID of the collection to delete.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.route53#DeleteCidrCollectionResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.route53#DeleteHealthCheck": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#DeleteHealthCheckRequest" + }, + "output": { + "target": "com.amazonaws.route53#DeleteHealthCheckResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#HealthCheckInUse" + }, + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#NoSuchHealthCheck" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a health check.

\n \n

Amazon Route 53 does not prevent you from deleting a health check even if the\n\t\t\t\thealth check is associated with one or more resource record sets. If you delete a\n\t\t\t\thealth check and you don't update the associated resource record sets, the future\n\t\t\t\tstatus of the health check can't be predicted and may change. This will affect the\n\t\t\t\trouting of DNS queries for your DNS failover configuration. For more information,\n\t\t\t\tsee Replacing and Deleting Health Checks in the Amazon Route 53\n\t\t\t\t\tDeveloper Guide.

\n \n

If you're using Cloud Map and you configured Cloud Map to create a Route 53\n\t\t\thealth check when you register an instance, you can't use the Route 53\n\t\t\t\tDeleteHealthCheck command to delete the health check. The health check\n\t\t\tis deleted automatically when you deregister the instance; there can be a delay of\n\t\t\tseveral hours before the health check is deleted from Route 53.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/2013-04-01/healthcheck/{HealthCheckId}", + "code": 200 + } + } + }, + "com.amazonaws.route53#DeleteHealthCheckRequest": { + "type": "structure", + "members": { + "HealthCheckId": { + "target": "com.amazonaws.route53#HealthCheckId", + "traits": { + "smithy.api#documentation": "

The ID of the health check that you want to delete.

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

This action deletes a health check.

" + } + }, + "com.amazonaws.route53#DeleteHealthCheckResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

An empty element.

" + } + }, + "com.amazonaws.route53#DeleteHostedZone": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#DeleteHostedZoneRequest" + }, + "output": { + "target": "com.amazonaws.route53#DeleteHostedZoneResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#HostedZoneNotEmpty" + }, + { + "target": "com.amazonaws.route53#InvalidDomainName" + }, + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#NoSuchHostedZone" + }, + { + "target": "com.amazonaws.route53#PriorRequestNotComplete" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a hosted zone.

\n

If the hosted zone was created by another service, such as Cloud Map, see\n\t\t\t\tDeleting Public Hosted Zones That Were Created by Another Service in the\n\t\t\t\t\tAmazon Route 53 Developer Guide for information\n\t\t\tabout how to delete it. (The process is the same for public and private hosted zones\n\t\t\tthat were created by another service.)

\n

If you want to keep your domain registration but you want to stop routing internet\n\t\t\ttraffic to your website or web application, we recommend that you delete resource record\n\t\t\tsets in the hosted zone instead of deleting the hosted zone.

\n \n

If you delete a hosted zone, you can't undelete it. You must create a new hosted\n\t\t\t\tzone and update the name servers for your domain registration, which can require up\n\t\t\t\tto 48 hours to take effect. (If you delegated responsibility for a subdomain to a\n\t\t\t\thosted zone and you delete the child hosted zone, you must update the name servers\n\t\t\t\tin the parent hosted zone.) In addition, if you delete a hosted zone, someone could\n\t\t\t\thijack the domain and route traffic to their own resources using your domain\n\t\t\t\tname.

\n \n

If you want to avoid the monthly charge for the hosted zone, you can transfer DNS\n\t\t\tservice for the domain to a free DNS service. When you transfer DNS service, you have to\n\t\t\tupdate the name servers for the domain registration. If the domain is registered with\n\t\t\t\tRoute 53, see UpdateDomainNameservers for information about how to replace Route 53 name servers with name servers for the new DNS service. If the domain is\n\t\t\tregistered with another registrar, use the method provided by the registrar to update\n\t\t\tname servers for the domain registration. For more information, perform an internet\n\t\t\tsearch on \"free DNS service.\"

\n

You can delete a hosted zone only if it contains only the default SOA record and NS\n\t\t\tresource record sets. If the hosted zone contains other resource record sets, you must\n\t\t\tdelete them before you can delete the hosted zone. If you try to delete a hosted zone\n\t\t\tthat contains other resource record sets, the request fails, and Route 53\n\t\t\treturns a HostedZoneNotEmpty error. For information about deleting records\n\t\t\tfrom your hosted zone, see ChangeResourceRecordSets.

\n

To verify that the hosted zone has been deleted, do one of the following:

\n ", + "smithy.api#http": { + "method": "DELETE", + "uri": "/2013-04-01/hostedzone/{Id}", + "code": 200 + } + } + }, + "com.amazonaws.route53#DeleteHostedZoneRequest": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.route53#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the hosted zone you want to delete.

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

A request to delete a hosted zone.

" + } + }, + "com.amazonaws.route53#DeleteHostedZoneResponse": { + "type": "structure", + "members": { + "ChangeInfo": { + "target": "com.amazonaws.route53#ChangeInfo", + "traits": { + "smithy.api#documentation": "

A complex type that contains the ID, the status, and the date and time of a request to\n\t\t\tdelete a hosted zone.

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

A complex type that contains the response to a DeleteHostedZone\n\t\t\trequest.

" + } + }, + "com.amazonaws.route53#DeleteKeySigningKey": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#DeleteKeySigningKeyRequest" + }, + "output": { + "target": "com.amazonaws.route53#DeleteKeySigningKeyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#ConcurrentModification" + }, + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#InvalidKeySigningKeyStatus" + }, + { + "target": "com.amazonaws.route53#InvalidKMSArn" + }, + { + "target": "com.amazonaws.route53#InvalidSigningStatus" + }, + { + "target": "com.amazonaws.route53#NoSuchKeySigningKey" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a key-signing key (KSK). Before you can delete a KSK, you must deactivate it.\n\t\t\tThe KSK must be deactivated before you can delete it regardless of whether the hosted\n\t\t\tzone is enabled for DNSSEC signing.

\n

You can use DeactivateKeySigningKey to deactivate the key before you delete it.

\n

Use GetDNSSEC to verify that the KSK is in an INACTIVE\n\t\t\tstatus.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/2013-04-01/keysigningkey/{HostedZoneId}/{Name}", + "code": 200 + } + } + }, + "com.amazonaws.route53#DeleteKeySigningKeyRequest": { + "type": "structure", + "members": { + "HostedZoneId": { + "target": "com.amazonaws.route53#ResourceId", + "traits": { + "smithy.api#documentation": "

A unique string used to identify a hosted zone.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.route53#SigningKeyName", + "traits": { + "smithy.api#documentation": "

A string used to identify a key-signing key (KSK).

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.route53#DeleteKeySigningKeyResponse": { + "type": "structure", + "members": { + "ChangeInfo": { + "target": "com.amazonaws.route53#ChangeInfo", + "traits": { + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.route53#DeleteQueryLoggingConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#DeleteQueryLoggingConfigRequest" + }, + "output": { + "target": "com.amazonaws.route53#DeleteQueryLoggingConfigResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#ConcurrentModification" + }, + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#NoSuchQueryLoggingConfig" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a configuration for DNS query logging. If you delete a configuration, Amazon\n\t\t\tRoute 53 stops sending query logs to CloudWatch Logs. Route 53 doesn't delete any logs\n\t\t\tthat are already in CloudWatch Logs.

\n

For more information about DNS query logs, see CreateQueryLoggingConfig.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/2013-04-01/queryloggingconfig/{Id}", + "code": 200 + } + } + }, + "com.amazonaws.route53#DeleteQueryLoggingConfigRequest": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.route53#QueryLoggingConfigId", + "traits": { + "smithy.api#documentation": "

The ID of the configuration that you want to delete.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.route53#DeleteQueryLoggingConfigResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.route53#DeleteReusableDelegationSet": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#DeleteReusableDelegationSetRequest" + }, + "output": { + "target": "com.amazonaws.route53#DeleteReusableDelegationSetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#DelegationSetInUse" + }, + { + "target": "com.amazonaws.route53#DelegationSetNotReusable" + }, + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#NoSuchDelegationSet" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a reusable delegation set.

\n \n

You can delete a reusable delegation set only if it isn't associated with any\n\t\t\t\thosted zones.

\n \n

To verify that the reusable delegation set is not associated with any hosted zones,\n\t\t\tsubmit a GetReusableDelegationSet request and specify the ID of the reusable\n\t\t\tdelegation set that you want to delete.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/2013-04-01/delegationset/{Id}", + "code": 200 + } + } + }, + "com.amazonaws.route53#DeleteReusableDelegationSetRequest": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.route53#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the reusable delegation set that you want to delete.

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

A request to delete a reusable delegation set.

" + } + }, + "com.amazonaws.route53#DeleteReusableDelegationSetResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

An empty element.

" + } + }, + "com.amazonaws.route53#DeleteTrafficPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#DeleteTrafficPolicyRequest" + }, + "output": { + "target": "com.amazonaws.route53#DeleteTrafficPolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#ConcurrentModification" + }, + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#NoSuchTrafficPolicy" + }, + { + "target": "com.amazonaws.route53#TrafficPolicyInUse" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a traffic policy.

\n

When you delete a traffic policy, Route 53 sets a flag on the policy to indicate that\n\t\t\tit has been deleted. However, Route 53 never fully deletes the traffic policy. Note the\n\t\t\tfollowing:

\n ", + "smithy.api#http": { + "method": "DELETE", + "uri": "/2013-04-01/trafficpolicy/{Id}/{Version}", + "code": 200 + } + } + }, + "com.amazonaws.route53#DeleteTrafficPolicyInstance": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#DeleteTrafficPolicyInstanceRequest" + }, + "output": { + "target": "com.amazonaws.route53#DeleteTrafficPolicyInstanceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#NoSuchTrafficPolicyInstance" + }, + { + "target": "com.amazonaws.route53#PriorRequestNotComplete" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a traffic policy instance and all of the resource record sets that Amazon\n\t\t\tRoute 53 created when you created the instance.

\n \n

In the Route 53 console, traffic policy instances are known as policy\n\t\t\t\trecords.

\n ", + "smithy.api#http": { + "method": "DELETE", + "uri": "/2013-04-01/trafficpolicyinstance/{Id}", + "code": 200 + } + } + }, + "com.amazonaws.route53#DeleteTrafficPolicyInstanceRequest": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.route53#TrafficPolicyInstanceId", + "traits": { + "smithy.api#documentation": "

The ID of the traffic policy instance that you want to delete.

\n \n

When you delete a traffic policy instance, Amazon Route 53 also deletes all of the\n\t\t\t\tresource record sets that were created when you created the traffic policy\n\t\t\t\tinstance.

\n ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A request to delete a specified traffic policy instance.

" + } + }, + "com.amazonaws.route53#DeleteTrafficPolicyInstanceResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

An empty element.

" + } + }, + "com.amazonaws.route53#DeleteTrafficPolicyRequest": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.route53#TrafficPolicyId", + "traits": { + "smithy.api#documentation": "

The ID of the traffic policy that you want to delete.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Version": { + "target": "com.amazonaws.route53#TrafficPolicyVersion", + "traits": { + "smithy.api#documentation": "

The version number of the traffic policy that you want to delete.

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

A request to delete a specified traffic policy version.

" + } + }, + "com.amazonaws.route53#DeleteTrafficPolicyResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

An empty element.

" + } + }, + "com.amazonaws.route53#DeleteVPCAssociationAuthorization": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#DeleteVPCAssociationAuthorizationRequest" + }, + "output": { + "target": "com.amazonaws.route53#DeleteVPCAssociationAuthorizationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#ConcurrentModification" + }, + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#InvalidVPCId" + }, + { + "target": "com.amazonaws.route53#NoSuchHostedZone" + }, + { + "target": "com.amazonaws.route53#VPCAssociationAuthorizationNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Removes authorization to submit an AssociateVPCWithHostedZone request to\n\t\t\tassociate a specified VPC with a hosted zone that was created by a different account.\n\t\t\tYou must use the account that created the hosted zone to submit a\n\t\t\t\tDeleteVPCAssociationAuthorization request.

\n \n

Sending this request only prevents the Amazon Web Services account that created the\n\t\t\t\tVPC from associating the VPC with the Amazon Route 53 hosted zone in the future. If\n\t\t\t\tthe VPC is already associated with the hosted zone,\n\t\t\t\t\tDeleteVPCAssociationAuthorization won't disassociate the VPC from\n\t\t\t\tthe hosted zone. If you want to delete an existing association, use\n\t\t\t\t\tDisassociateVPCFromHostedZone.

\n ", + "smithy.api#http": { + "method": "POST", + "uri": "/2013-04-01/hostedzone/{HostedZoneId}/deauthorizevpcassociation", + "code": 200 + } + } + }, + "com.amazonaws.route53#DeleteVPCAssociationAuthorizationRequest": { + "type": "structure", + "members": { + "HostedZoneId": { + "target": "com.amazonaws.route53#ResourceId", + "traits": { + "smithy.api#documentation": "

When removing authorization to associate a VPC that was created by one Amazon Web Services account with a hosted zone that was created with a different Amazon Web Services account, the ID of the hosted zone.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "VPC": { + "target": "com.amazonaws.route53#VPC", + "traits": { + "smithy.api#documentation": "

When removing authorization to associate a VPC that was created by one Amazon Web Services account with a hosted zone that was created with a different Amazon Web Services account, a complex type that includes the ID and region of the\n\t\t\tVPC.

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

A complex type that contains information about the request to remove authorization to\n\t\t\tassociate a VPC that was created by one Amazon Web Services account with a hosted zone\n\t\t\tthat was created with a different Amazon Web Services account.

" + } + }, + "com.amazonaws.route53#DeleteVPCAssociationAuthorizationResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

Empty response for the request.

" + } + }, + "com.amazonaws.route53#Dimension": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.route53#DimensionField", + "traits": { + "smithy.api#documentation": "

For the metric that the CloudWatch alarm is associated with, the name of one\n\t\t\tdimension.

", + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.route53#DimensionField", + "traits": { + "smithy.api#documentation": "

For the metric that the CloudWatch alarm is associated with, the value of one\n\t\t\tdimension.

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

For the metric that the CloudWatch alarm is associated with, a complex type that\n\t\t\tcontains information about one dimension.

" + } + }, + "com.amazonaws.route53#DimensionField": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "com.amazonaws.route53#DimensionList": { + "type": "list", + "member": { + "target": "com.amazonaws.route53#Dimension", + "traits": { + "smithy.api#xmlName": "Dimension" + } + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 + } + } + }, + "com.amazonaws.route53#DisableHostedZoneDNSSEC": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#DisableHostedZoneDNSSECRequest" + }, + "output": { + "target": "com.amazonaws.route53#DisableHostedZoneDNSSECResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#ConcurrentModification" + }, + { + "target": "com.amazonaws.route53#DNSSECNotFound" + }, + { + "target": "com.amazonaws.route53#InvalidArgument" + }, + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#InvalidKeySigningKeyStatus" + }, + { + "target": "com.amazonaws.route53#InvalidKMSArn" + }, + { + "target": "com.amazonaws.route53#KeySigningKeyInParentDSRecord" + }, + { + "target": "com.amazonaws.route53#NoSuchHostedZone" + } + ], + "traits": { + "smithy.api#documentation": "

Disables DNSSEC signing in a specific hosted zone. This action does not deactivate any\n\t\t\tkey-signing keys (KSKs) that are active in the hosted zone.

", + "smithy.api#http": { + "method": "POST", + "uri": "/2013-04-01/hostedzone/{HostedZoneId}/disable-dnssec", + "code": 200 + } + } + }, + "com.amazonaws.route53#DisableHostedZoneDNSSECRequest": { + "type": "structure", + "members": { + "HostedZoneId": { + "target": "com.amazonaws.route53#ResourceId", + "traits": { + "smithy.api#documentation": "

A unique string used to identify a hosted zone.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.route53#DisableHostedZoneDNSSECResponse": { + "type": "structure", + "members": { + "ChangeInfo": { + "target": "com.amazonaws.route53#ChangeInfo", + "traits": { + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.route53#Disabled": { + "type": "boolean" + }, + "com.amazonaws.route53#DisassociateVPCComment": { + "type": "string" + }, + "com.amazonaws.route53#DisassociateVPCFromHostedZone": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#DisassociateVPCFromHostedZoneRequest" + }, + "output": { + "target": "com.amazonaws.route53#DisassociateVPCFromHostedZoneResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#InvalidVPCId" + }, + { + "target": "com.amazonaws.route53#LastVPCAssociation" + }, + { + "target": "com.amazonaws.route53#NoSuchHostedZone" + }, + { + "target": "com.amazonaws.route53#VPCAssociationNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Disassociates an Amazon Virtual Private Cloud (Amazon VPC) from an Amazon Route 53\n\t\t\tprivate hosted zone. Note the following:

\n \n \n

When revoking access, the hosted zone and the Amazon VPC must belong to\n\t\t\t\tthe same partition. A partition is a group of Amazon Web Services Regions. Each\n\t\t\t\t\tAmazon Web Services account is scoped to one partition.

\n

The following are the supported partitions:

\n \n

For more information, see Access Management\n\t\t\t\tin the Amazon Web Services General Reference.

\n ", + "smithy.api#http": { + "method": "POST", + "uri": "/2013-04-01/hostedzone/{HostedZoneId}/disassociatevpc", + "code": 200 + } + } + }, + "com.amazonaws.route53#DisassociateVPCFromHostedZoneRequest": { + "type": "structure", + "members": { + "HostedZoneId": { + "target": "com.amazonaws.route53#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the private hosted zone that you want to disassociate a VPC from.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "VPC": { + "target": "com.amazonaws.route53#VPC", + "traits": { + "smithy.api#documentation": "

A complex type that contains information about the VPC that you're disassociating from\n\t\t\tthe specified hosted zone.

", + "smithy.api#required": {} + } + }, + "Comment": { + "target": "com.amazonaws.route53#DisassociateVPCComment", + "traits": { + "smithy.api#documentation": "

\n Optional: A comment about the disassociation request.

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

A complex type that contains information about the VPC that you want to disassociate\n\t\t\tfrom a specified private hosted zone.

" + } + }, + "com.amazonaws.route53#DisassociateVPCFromHostedZoneResponse": { + "type": "structure", + "members": { + "ChangeInfo": { + "target": "com.amazonaws.route53#ChangeInfo", + "traits": { + "smithy.api#documentation": "

A complex type that describes the changes made to the specified private hosted\n\t\t\tzone.

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

A complex type that contains the response information for the disassociate\n\t\t\trequest.

" + } + }, + "com.amazonaws.route53#EnableHostedZoneDNSSEC": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#EnableHostedZoneDNSSECRequest" + }, + "output": { + "target": "com.amazonaws.route53#EnableHostedZoneDNSSECResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#ConcurrentModification" + }, + { + "target": "com.amazonaws.route53#DNSSECNotFound" + }, + { + "target": "com.amazonaws.route53#HostedZonePartiallyDelegated" + }, + { + "target": "com.amazonaws.route53#InvalidArgument" + }, + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#InvalidKeySigningKeyStatus" + }, + { + "target": "com.amazonaws.route53#InvalidKMSArn" + }, + { + "target": "com.amazonaws.route53#KeySigningKeyWithActiveStatusNotFound" + }, + { + "target": "com.amazonaws.route53#NoSuchHostedZone" + } + ], + "traits": { + "smithy.api#documentation": "

Enables DNSSEC signing in a specific hosted zone.

", + "smithy.api#http": { + "method": "POST", + "uri": "/2013-04-01/hostedzone/{HostedZoneId}/enable-dnssec", + "code": 200 + } + } + }, + "com.amazonaws.route53#EnableHostedZoneDNSSECRequest": { + "type": "structure", + "members": { + "HostedZoneId": { + "target": "com.amazonaws.route53#ResourceId", + "traits": { + "smithy.api#documentation": "

A unique string used to identify a hosted zone.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.route53#EnableHostedZoneDNSSECResponse": { + "type": "structure", + "members": { + "ChangeInfo": { + "target": "com.amazonaws.route53#ChangeInfo", + "traits": { + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.route53#EnableSNI": { + "type": "boolean" + }, + "com.amazonaws.route53#ErrorMessage": { + "type": "string" + }, + "com.amazonaws.route53#ErrorMessages": { + "type": "list", + "member": { + "target": "com.amazonaws.route53#ErrorMessage", + "traits": { + "smithy.api#xmlName": "Message" + } + } + }, + "com.amazonaws.route53#EvaluationPeriods": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.route53#FailureThreshold": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.route53#FullyQualifiedDomainName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 255 + } + } + }, + "com.amazonaws.route53#GeoLocation": { + "type": "structure", + "members": { + "ContinentCode": { + "target": "com.amazonaws.route53#GeoLocationContinentCode", + "traits": { + "smithy.api#documentation": "

The two-letter code for the continent.

\n

Amazon Route 53 supports the following continent codes:

\n \n

Constraint: Specifying ContinentCode with either CountryCode\n\t\t\tor SubdivisionCode returns an InvalidInput error.

" + } + }, + "CountryCode": { + "target": "com.amazonaws.route53#GeoLocationCountryCode", + "traits": { + "smithy.api#documentation": "

For geolocation resource record sets, the two-letter code for a country.

\n

Amazon Route 53 uses the two-letter country codes that are specified in ISO standard 3166-1\n\t\t\t\talpha-2.

" + } + }, + "SubdivisionCode": { + "target": "com.amazonaws.route53#GeoLocationSubdivisionCode", + "traits": { + "smithy.api#documentation": "

For geolocation resource record sets, the two-letter code for a state of the United\n\t\t\tStates. Route 53 doesn't support any other values for SubdivisionCode. For\n\t\t\ta list of state abbreviations, see Appendix B: Two–Letter State and Possession Abbreviations on the United\n\t\t\tStates Postal Service website.

\n

If you specify subdivisioncode, you must also specify US for\n\t\t\t\tCountryCode.

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

A complex type that contains information about a geographic location.

" + } + }, + "com.amazonaws.route53#GeoLocationContinentCode": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 2, + "max": 2 + } + } + }, + "com.amazonaws.route53#GeoLocationContinentName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 32 + } + } + }, + "com.amazonaws.route53#GeoLocationCountryCode": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2 + } + } + }, + "com.amazonaws.route53#GeoLocationCountryName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + } + } + }, + "com.amazonaws.route53#GeoLocationDetails": { + "type": "structure", + "members": { + "ContinentCode": { + "target": "com.amazonaws.route53#GeoLocationContinentCode", + "traits": { + "smithy.api#documentation": "

The two-letter code for the continent.

" + } + }, + "ContinentName": { + "target": "com.amazonaws.route53#GeoLocationContinentName", + "traits": { + "smithy.api#documentation": "

The full name of the continent.

" + } + }, + "CountryCode": { + "target": "com.amazonaws.route53#GeoLocationCountryCode", + "traits": { + "smithy.api#documentation": "

The two-letter code for the country.

" + } + }, + "CountryName": { + "target": "com.amazonaws.route53#GeoLocationCountryName", + "traits": { + "smithy.api#documentation": "

The name of the country.

" + } + }, + "SubdivisionCode": { + "target": "com.amazonaws.route53#GeoLocationSubdivisionCode", + "traits": { + "smithy.api#documentation": "

The code for the subdivision, such as a particular state within the United States. For\n\t\t\ta list of US state abbreviations, see Appendix B: Two–Letter State and\n\t\t\t\tPossession Abbreviations on the United States Postal Service website. For a\n\t\t\tlist of all supported subdivision codes, use the ListGeoLocations\n\t\t\tAPI.

" + } + }, + "SubdivisionName": { + "target": "com.amazonaws.route53#GeoLocationSubdivisionName", + "traits": { + "smithy.api#documentation": "

The full name of the subdivision. Route 53 currently supports only states in the\n\t\t\tUnited States.

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

A complex type that contains the codes and full continent, country, and subdivision\n\t\t\tnames for the specified geolocation code.

" + } + }, + "com.amazonaws.route53#GeoLocationDetailsList": { + "type": "list", + "member": { + "target": "com.amazonaws.route53#GeoLocationDetails", + "traits": { + "smithy.api#xmlName": "GeoLocationDetails" + } + } + }, + "com.amazonaws.route53#GeoLocationSubdivisionCode": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 3 + } + } + }, + "com.amazonaws.route53#GeoLocationSubdivisionName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + } + } + }, + "com.amazonaws.route53#GetAccountLimit": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#GetAccountLimitRequest" + }, + "output": { + "target": "com.amazonaws.route53#GetAccountLimitResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#InvalidInput" + } + ], + "traits": { + "smithy.api#documentation": "

Gets the specified limit for the current account, for example, the maximum number of\n\t\t\thealth checks that you can create using the account.

\n

For the default limit, see Limits in the\n\t\t\t\tAmazon Route 53 Developer Guide. To request a higher limit,\n\t\t\t\topen a case.

\n \n

You can also view account limits in Amazon Web Services Trusted Advisor. Sign in to\n\t\t\t\tthe Amazon Web Services Management Console and open the Trusted Advisor console at https://console.aws.amazon.com/trustedadvisor/. Then choose Service limits in the navigation pane.

\n ", + "smithy.api#http": { + "method": "GET", + "uri": "/2013-04-01/accountlimit/{Type}", + "code": 200 + } + } + }, + "com.amazonaws.route53#GetAccountLimitRequest": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.route53#AccountLimitType", + "traits": { + "smithy.api#documentation": "

The limit that you want to get. Valid values include the following:

\n ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A complex type that contains information about the request to create a hosted\n\t\t\tzone.

" + } + }, + "com.amazonaws.route53#GetAccountLimitResponse": { + "type": "structure", + "members": { + "Limit": { + "target": "com.amazonaws.route53#AccountLimit", + "traits": { + "smithy.api#documentation": "

The current setting for the specified limit. For example, if you specified\n\t\t\t\tMAX_HEALTH_CHECKS_BY_OWNER for the value of Type in the\n\t\t\trequest, the value of Limit is the maximum number of health checks that you\n\t\t\tcan create using the current account.

", + "smithy.api#required": {} + } + }, + "Count": { + "target": "com.amazonaws.route53#UsageCount", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The current number of entities that you have created of the specified type. For\n\t\t\texample, if you specified MAX_HEALTH_CHECKS_BY_OWNER for the value of\n\t\t\t\tType in the request, the value of Count is the current\n\t\t\tnumber of health checks that you have created using the current account.

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

A complex type that contains the requested limit.

" + } + }, + "com.amazonaws.route53#GetChange": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#GetChangeRequest" + }, + "output": { + "target": "com.amazonaws.route53#GetChangeResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#NoSuchChange" + } + ], + "traits": { + "smithy.api#documentation": "

Returns the current status of a change batch request. The status is one of the\n\t\t\tfollowing values:

\n ", + "smithy.api#http": { + "method": "GET", + "uri": "/2013-04-01/change/{Id}", + "code": 200 + }, + "smithy.waiters#waitable": { + "ResourceRecordSetsChanged": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "ChangeInfo.Status", + "expected": "INSYNC", + "comparator": "stringEquals" + } + } + } + ], + "minDelay": 30 + } + } + } + }, + "com.amazonaws.route53#GetChangeRequest": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.route53#ChangeId", + "traits": { + "smithy.api#documentation": "

The ID of the change batch request. The value that you specify here is the value that\n\t\t\t\tChangeResourceRecordSets returned in the Id element when\n\t\t\tyou submitted the request.

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

The input for a GetChange request.

" + } + }, + "com.amazonaws.route53#GetChangeResponse": { + "type": "structure", + "members": { + "ChangeInfo": { + "target": "com.amazonaws.route53#ChangeInfo", + "traits": { + "smithy.api#documentation": "

A complex type that contains information about the specified change batch.

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

A complex type that contains the ChangeInfo element.

" + } + }, + "com.amazonaws.route53#GetCheckerIpRanges": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#GetCheckerIpRangesRequest" + }, + "output": { + "target": "com.amazonaws.route53#GetCheckerIpRangesResponse" + }, + "traits": { + "smithy.api#documentation": "

Route 53 does not perform authorization for this API because it retrieves information\n\t\t\tthat is already available to the public.

\n \n

\n GetCheckerIpRanges still works, but we recommend that you download\n\t\t\t\tip-ranges.json, which includes IP address ranges for all Amazon Web Services\n\t\t\t\tservices. For more information, see IP Address Ranges\n\t\t\t\t\tof Amazon Route 53 Servers in the Amazon Route 53 Developer\n\t\t\t\t\tGuide.

\n ", + "smithy.api#http": { + "method": "GET", + "uri": "/2013-04-01/checkeripranges", + "code": 200 + } + } + }, + "com.amazonaws.route53#GetCheckerIpRangesRequest": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

Empty request.

" + } + }, + "com.amazonaws.route53#GetCheckerIpRangesResponse": { + "type": "structure", + "members": { + "CheckerIpRanges": { + "target": "com.amazonaws.route53#CheckerIpRanges", + "traits": { + "smithy.api#documentation": "

A complex type that contains sorted list of IP ranges in CIDR format for Amazon Route\n\t\t\t53 health checkers.

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

A complex type that contains the CheckerIpRanges element.

" + } + }, + "com.amazonaws.route53#GetDNSSEC": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#GetDNSSECRequest" + }, + "output": { + "target": "com.amazonaws.route53#GetDNSSECResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#InvalidArgument" + }, + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#NoSuchHostedZone" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about DNSSEC for a specific hosted zone, including the key-signing\n\t\t\tkeys (KSKs) in the hosted zone.

", + "smithy.api#http": { + "method": "GET", + "uri": "/2013-04-01/hostedzone/{HostedZoneId}/dnssec", + "code": 200 + } + } + }, + "com.amazonaws.route53#GetDNSSECRequest": { + "type": "structure", + "members": { + "HostedZoneId": { + "target": "com.amazonaws.route53#ResourceId", + "traits": { + "smithy.api#documentation": "

A unique string used to identify a hosted zone.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.route53#GetDNSSECResponse": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.route53#DNSSECStatus", + "traits": { + "smithy.api#documentation": "

A string repesenting the status of DNSSEC.

", + "smithy.api#required": {} + } + }, + "KeySigningKeys": { + "target": "com.amazonaws.route53#KeySigningKeys", + "traits": { + "smithy.api#documentation": "

The key-signing keys (KSKs) in your account.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.route53#GetGeoLocation": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#GetGeoLocationRequest" + }, + "output": { + "target": "com.amazonaws.route53#GetGeoLocationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#NoSuchGeoLocation" + } + ], + "traits": { + "smithy.api#documentation": "

Gets information about whether a specified geographic location is supported for Amazon\n\t\t\tRoute 53 geolocation resource record sets.

\n

Route 53 does not perform authorization for this API because it retrieves information\n\t\t\tthat is already available to the public.

\n

Use the following syntax to determine whether a continent is supported for\n\t\t\tgeolocation:

\n

\n GET /2013-04-01/geolocation?continentcode=two-letter abbreviation for\n\t\t\t\t\ta continent\n \n

\n

Use the following syntax to determine whether a country is supported for\n\t\t\tgeolocation:

\n

\n GET /2013-04-01/geolocation?countrycode=two-character country\n\t\t\t\t\tcode\n \n

\n

Use the following syntax to determine whether a subdivision of a country is supported\n\t\t\tfor geolocation:

\n

\n GET /2013-04-01/geolocation?countrycode=two-character country\n\t\t\t\t\tcode&subdivisioncode=subdivision\n\t\t\tcode\n \n

", + "smithy.api#http": { + "method": "GET", + "uri": "/2013-04-01/geolocation", + "code": 200 + } + } + }, + "com.amazonaws.route53#GetGeoLocationRequest": { + "type": "structure", + "members": { + "ContinentCode": { + "target": "com.amazonaws.route53#GeoLocationContinentCode", + "traits": { + "smithy.api#documentation": "

For geolocation resource record sets, a two-letter abbreviation that identifies a\n\t\t\tcontinent. Amazon Route 53 supports the following continent codes:

\n ", + "smithy.api#httpQuery": "continentcode" + } + }, + "CountryCode": { + "target": "com.amazonaws.route53#GeoLocationCountryCode", + "traits": { + "smithy.api#documentation": "

Amazon Route 53 uses the two-letter country codes that are specified in ISO standard 3166-1\n\t\t\t\talpha-2.

", + "smithy.api#httpQuery": "countrycode" + } + }, + "SubdivisionCode": { + "target": "com.amazonaws.route53#GeoLocationSubdivisionCode", + "traits": { + "smithy.api#documentation": "

The code for the subdivision, such as a particular state within the United States. For\n\t\t\ta list of US state abbreviations, see Appendix B: Two–Letter State and\n\t\t\t\tPossession Abbreviations on the United States Postal Service website. For a\n\t\t\tlist of all supported subdivision codes, use the ListGeoLocations\n\t\t\tAPI.

", + "smithy.api#httpQuery": "subdivisioncode" + } + } + }, + "traits": { + "smithy.api#documentation": "

A request for information about whether a specified geographic location is supported\n\t\t\tfor Amazon Route 53 geolocation resource record sets.

" + } + }, + "com.amazonaws.route53#GetGeoLocationResponse": { + "type": "structure", + "members": { + "GeoLocationDetails": { + "target": "com.amazonaws.route53#GeoLocationDetails", + "traits": { + "smithy.api#documentation": "

A complex type that contains the codes and full continent, country, and subdivision\n\t\t\tnames for the specified geolocation code.

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

A complex type that contains the response information for the specified geolocation\n\t\t\tcode.

" + } + }, + "com.amazonaws.route53#GetHealthCheck": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#GetHealthCheckRequest" + }, + "output": { + "target": "com.amazonaws.route53#GetHealthCheckResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#IncompatibleVersion" + }, + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#NoSuchHealthCheck" + } + ], + "traits": { + "smithy.api#documentation": "

Gets information about a specified health check.

", + "smithy.api#http": { + "method": "GET", + "uri": "/2013-04-01/healthcheck/{HealthCheckId}", + "code": 200 + } + } + }, + "com.amazonaws.route53#GetHealthCheckCount": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#GetHealthCheckCountRequest" + }, + "output": { + "target": "com.amazonaws.route53#GetHealthCheckCountResponse" + }, + "traits": { + "smithy.api#documentation": "

Retrieves the number of health checks that are associated with the current Amazon Web Services account.

", + "smithy.api#http": { + "method": "GET", + "uri": "/2013-04-01/healthcheckcount", + "code": 200 + } + } + }, + "com.amazonaws.route53#GetHealthCheckCountRequest": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

A request for the number of health checks that are associated with the current Amazon Web Services account.

" + } + }, + "com.amazonaws.route53#GetHealthCheckCountResponse": { + "type": "structure", + "members": { + "HealthCheckCount": { + "target": "com.amazonaws.route53#HealthCheckCount", + "traits": { + "smithy.api#documentation": "

The number of health checks associated with the current Amazon Web Services account.

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

A complex type that contains the response to a GetHealthCheckCount\n\t\t\trequest.

" + } + }, + "com.amazonaws.route53#GetHealthCheckLastFailureReason": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#GetHealthCheckLastFailureReasonRequest" + }, + "output": { + "target": "com.amazonaws.route53#GetHealthCheckLastFailureReasonResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#NoSuchHealthCheck" + } + ], + "traits": { + "smithy.api#documentation": "

Gets the reason that a specified health check failed most recently.

", + "smithy.api#http": { + "method": "GET", + "uri": "/2013-04-01/healthcheck/{HealthCheckId}/lastfailurereason", + "code": 200 + } + } + }, + "com.amazonaws.route53#GetHealthCheckLastFailureReasonRequest": { + "type": "structure", + "members": { + "HealthCheckId": { + "target": "com.amazonaws.route53#HealthCheckId", + "traits": { + "smithy.api#documentation": "

The ID for the health check for which you want the last failure reason. When you\n\t\t\tcreated the health check, CreateHealthCheck returned the ID in the\n\t\t\tresponse, in the HealthCheckId element.

\n \n

If you want to get the last failure reason for a calculated health check, you must\n\t\t\t\tuse the Amazon Route 53 console or the CloudWatch console. You can't use\n\t\t\t\t\tGetHealthCheckLastFailureReason for a calculated health\n\t\t\t\tcheck.

\n ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A request for the reason that a health check failed most recently.

" + } + }, + "com.amazonaws.route53#GetHealthCheckLastFailureReasonResponse": { + "type": "structure", + "members": { + "HealthCheckObservations": { + "target": "com.amazonaws.route53#HealthCheckObservations", + "traits": { + "smithy.api#documentation": "

A list that contains one Observation element for each Amazon Route 53\n\t\t\thealth checker that is reporting a last failure reason.

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

A complex type that contains the response to a\n\t\t\t\tGetHealthCheckLastFailureReason request.

" + } + }, + "com.amazonaws.route53#GetHealthCheckRequest": { + "type": "structure", + "members": { + "HealthCheckId": { + "target": "com.amazonaws.route53#HealthCheckId", + "traits": { + "smithy.api#documentation": "

The identifier that Amazon Route 53 assigned to the health check when you created it.\n\t\t\tWhen you add or update a resource record set, you use this value to specify which health\n\t\t\tcheck to use. The value can be up to 64 characters long.

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

A request to get information about a specified health check.

" + } + }, + "com.amazonaws.route53#GetHealthCheckResponse": { + "type": "structure", + "members": { + "HealthCheck": { + "target": "com.amazonaws.route53#HealthCheck", + "traits": { + "smithy.api#documentation": "

A complex type that contains information about one health check that is associated\n\t\t\twith the current Amazon Web Services account.

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

A complex type that contains the response to a GetHealthCheck\n\t\t\trequest.

" + } + }, + "com.amazonaws.route53#GetHealthCheckStatus": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#GetHealthCheckStatusRequest" + }, + "output": { + "target": "com.amazonaws.route53#GetHealthCheckStatusResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#NoSuchHealthCheck" + } + ], + "traits": { + "smithy.api#documentation": "

Gets status of a specified health check.

\n \n

This API is intended for use during development to diagnose behavior. It doesn’t\n\t\t\t\tsupport production use-cases with high query rates that require immediate and\n\t\t\t\tactionable responses.

\n ", + "smithy.api#http": { + "method": "GET", + "uri": "/2013-04-01/healthcheck/{HealthCheckId}/status", + "code": 200 + } + } + }, + "com.amazonaws.route53#GetHealthCheckStatusRequest": { + "type": "structure", + "members": { + "HealthCheckId": { + "target": "com.amazonaws.route53#HealthCheckId", + "traits": { + "smithy.api#documentation": "

The ID for the health check that you want the current status for. When you created the\n\t\t\thealth check, CreateHealthCheck returned the ID in the response, in the\n\t\t\t\tHealthCheckId element.

\n \n

If you want to check the status of a calculated health check, you must use the\n\t\t\t\tAmazon Route 53 console or the CloudWatch console. You can't use\n\t\t\t\t\tGetHealthCheckStatus to get the status of a calculated health\n\t\t\t\tcheck.

\n ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A request to get the status for a health check.

" + } + }, + "com.amazonaws.route53#GetHealthCheckStatusResponse": { + "type": "structure", + "members": { + "HealthCheckObservations": { + "target": "com.amazonaws.route53#HealthCheckObservations", + "traits": { + "smithy.api#documentation": "

A list that contains one HealthCheckObservation element for each Amazon\n\t\t\tRoute 53 health checker that is reporting a status about the health check\n\t\t\tendpoint.

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

A complex type that contains the response to a GetHealthCheck\n\t\t\trequest.

" + } + }, + "com.amazonaws.route53#GetHostedZone": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#GetHostedZoneRequest" + }, + "output": { + "target": "com.amazonaws.route53#GetHostedZoneResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#NoSuchHostedZone" + } + ], + "traits": { + "smithy.api#documentation": "

Gets information about a specified hosted zone including the four name servers\n\t\t\tassigned to the hosted zone.

", + "smithy.api#http": { + "method": "GET", + "uri": "/2013-04-01/hostedzone/{Id}", + "code": 200 + } + } + }, + "com.amazonaws.route53#GetHostedZoneCount": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#GetHostedZoneCountRequest" + }, + "output": { + "target": "com.amazonaws.route53#GetHostedZoneCountResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#InvalidInput" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves the number of hosted zones that are associated with the current Amazon Web Services account.

", + "smithy.api#http": { + "method": "GET", + "uri": "/2013-04-01/hostedzonecount", + "code": 200 + } + } + }, + "com.amazonaws.route53#GetHostedZoneCountRequest": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

A request to retrieve a count of all the hosted zones that are associated with the\n\t\t\tcurrent Amazon Web Services account.

" + } + }, + "com.amazonaws.route53#GetHostedZoneCountResponse": { + "type": "structure", + "members": { + "HostedZoneCount": { + "target": "com.amazonaws.route53#HostedZoneCount", + "traits": { + "smithy.api#documentation": "

The total number of public and private hosted zones that are associated with the\n\t\t\tcurrent Amazon Web Services account.

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

A complex type that contains the response to a GetHostedZoneCount\n\t\t\trequest.

" + } + }, + "com.amazonaws.route53#GetHostedZoneLimit": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#GetHostedZoneLimitRequest" + }, + "output": { + "target": "com.amazonaws.route53#GetHostedZoneLimitResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#HostedZoneNotPrivate" + }, + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#NoSuchHostedZone" + } + ], + "traits": { + "smithy.api#documentation": "

Gets the specified limit for a specified hosted zone, for example, the maximum number\n\t\t\tof records that you can create in the hosted zone.

\n

For the default limit, see Limits in the\n\t\t\t\tAmazon Route 53 Developer Guide. To request a higher limit,\n\t\t\t\topen a case.

", + "smithy.api#http": { + "method": "GET", + "uri": "/2013-04-01/hostedzonelimit/{HostedZoneId}/{Type}", + "code": 200 + } + } + }, + "com.amazonaws.route53#GetHostedZoneLimitRequest": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.route53#HostedZoneLimitType", + "traits": { + "smithy.api#documentation": "

The limit that you want to get. Valid values include the following:

\n ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "HostedZoneId": { + "target": "com.amazonaws.route53#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the hosted zone that you want to get a limit for.

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

A complex type that contains information about the request to create a hosted\n\t\t\tzone.

" + } + }, + "com.amazonaws.route53#GetHostedZoneLimitResponse": { + "type": "structure", + "members": { + "Limit": { + "target": "com.amazonaws.route53#HostedZoneLimit", + "traits": { + "smithy.api#documentation": "

The current setting for the specified limit. For example, if you specified\n\t\t\t\tMAX_RRSETS_BY_ZONE for the value of Type in the request,\n\t\t\tthe value of Limit is the maximum number of records that you can create in\n\t\t\tthe specified hosted zone.

", + "smithy.api#required": {} + } + }, + "Count": { + "target": "com.amazonaws.route53#UsageCount", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The current number of entities that you have created of the specified type. For\n\t\t\texample, if you specified MAX_RRSETS_BY_ZONE for the value of\n\t\t\t\tType in the request, the value of Count is the current\n\t\t\tnumber of records that you have created in the specified hosted zone.

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

A complex type that contains the requested limit.

" + } + }, + "com.amazonaws.route53#GetHostedZoneRequest": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.route53#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the hosted zone that you want to get information about.

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

A request to get information about a specified hosted zone.

" + } + }, + "com.amazonaws.route53#GetHostedZoneResponse": { + "type": "structure", + "members": { + "HostedZone": { + "target": "com.amazonaws.route53#HostedZone", + "traits": { + "smithy.api#documentation": "

A complex type that contains general information about the specified hosted\n\t\t\tzone.

", + "smithy.api#required": {} + } + }, + "DelegationSet": { + "target": "com.amazonaws.route53#DelegationSet", + "traits": { + "smithy.api#documentation": "

A complex type that lists the Amazon Route 53 name servers for the specified hosted\n\t\t\tzone.

" + } + }, + "VPCs": { + "target": "com.amazonaws.route53#VPCs", + "traits": { + "smithy.api#documentation": "

A complex type that contains information about the VPCs that are associated with the\n\t\t\tspecified hosted zone.

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

A complex type that contain the response to a GetHostedZone\n\t\t\trequest.

" + } + }, + "com.amazonaws.route53#GetQueryLoggingConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#GetQueryLoggingConfigRequest" + }, + "output": { + "target": "com.amazonaws.route53#GetQueryLoggingConfigResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#NoSuchQueryLoggingConfig" + } + ], + "traits": { + "smithy.api#documentation": "

Gets information about a specified configuration for DNS query logging.

\n

For more information about DNS query logs, see CreateQueryLoggingConfig and Logging DNS\n\t\t\tQueries.

", + "smithy.api#http": { + "method": "GET", + "uri": "/2013-04-01/queryloggingconfig/{Id}", + "code": 200 + } + } + }, + "com.amazonaws.route53#GetQueryLoggingConfigRequest": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.route53#QueryLoggingConfigId", + "traits": { + "smithy.api#documentation": "

The ID of the configuration for DNS query logging that you want to get information\n\t\t\tabout.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.route53#GetQueryLoggingConfigResponse": { + "type": "structure", + "members": { + "QueryLoggingConfig": { + "target": "com.amazonaws.route53#QueryLoggingConfig", + "traits": { + "smithy.api#documentation": "

A complex type that contains information about the query logging configuration that\n\t\t\tyou specified in a GetQueryLoggingConfig request.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.route53#GetReusableDelegationSet": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#GetReusableDelegationSetRequest" + }, + "output": { + "target": "com.amazonaws.route53#GetReusableDelegationSetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#DelegationSetNotReusable" + }, + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#NoSuchDelegationSet" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves information about a specified reusable delegation set, including the four\n\t\t\tname servers that are assigned to the delegation set.

", + "smithy.api#http": { + "method": "GET", + "uri": "/2013-04-01/delegationset/{Id}", + "code": 200 + } + } + }, + "com.amazonaws.route53#GetReusableDelegationSetLimit": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#GetReusableDelegationSetLimitRequest" + }, + "output": { + "target": "com.amazonaws.route53#GetReusableDelegationSetLimitResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#NoSuchDelegationSet" + } + ], + "traits": { + "smithy.api#documentation": "

Gets the maximum number of hosted zones that you can associate with the specified\n\t\t\treusable delegation set.

\n

For the default limit, see Limits in the\n\t\t\t\tAmazon Route 53 Developer Guide. To request a higher limit,\n\t\t\t\topen a case.

", + "smithy.api#http": { + "method": "GET", + "uri": "/2013-04-01/reusabledelegationsetlimit/{DelegationSetId}/{Type}", + "code": 200 + } + } + }, + "com.amazonaws.route53#GetReusableDelegationSetLimitRequest": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.route53#ReusableDelegationSetLimitType", + "traits": { + "smithy.api#documentation": "

Specify MAX_ZONES_BY_REUSABLE_DELEGATION_SET to get the maximum number of\n\t\t\thosted zones that you can associate with the specified reusable delegation set.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "DelegationSetId": { + "target": "com.amazonaws.route53#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the delegation set that you want to get the limit for.

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

A complex type that contains information about the request to create a hosted\n\t\t\tzone.

" + } + }, + "com.amazonaws.route53#GetReusableDelegationSetLimitResponse": { + "type": "structure", + "members": { + "Limit": { + "target": "com.amazonaws.route53#ReusableDelegationSetLimit", + "traits": { + "smithy.api#documentation": "

The current setting for the limit on hosted zones that you can associate with the\n\t\t\tspecified reusable delegation set.

", + "smithy.api#required": {} + } + }, + "Count": { + "target": "com.amazonaws.route53#UsageCount", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The current number of hosted zones that you can associate with the specified reusable\n\t\t\tdelegation set.

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

A complex type that contains the requested limit.

" + } + }, + "com.amazonaws.route53#GetReusableDelegationSetRequest": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.route53#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the reusable delegation set that you want to get a list of name servers\n\t\t\tfor.

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

A request to get information about a specified reusable delegation set.

" + } + }, + "com.amazonaws.route53#GetReusableDelegationSetResponse": { + "type": "structure", + "members": { + "DelegationSet": { + "target": "com.amazonaws.route53#DelegationSet", + "traits": { + "smithy.api#documentation": "

A complex type that contains information about the reusable delegation set.

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

A complex type that contains the response to the GetReusableDelegationSet\n\t\t\trequest.

" + } + }, + "com.amazonaws.route53#GetTrafficPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#GetTrafficPolicyRequest" + }, + "output": { + "target": "com.amazonaws.route53#GetTrafficPolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#NoSuchTrafficPolicy" + } + ], + "traits": { + "smithy.api#documentation": "

Gets information about a specific traffic policy version.

\n

For information about how of deleting a traffic policy affects the response from\n\t\t\t\tGetTrafficPolicy, see DeleteTrafficPolicy.

", + "smithy.api#http": { + "method": "GET", + "uri": "/2013-04-01/trafficpolicy/{Id}/{Version}", + "code": 200 + } + } + }, + "com.amazonaws.route53#GetTrafficPolicyInstance": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#GetTrafficPolicyInstanceRequest" + }, + "output": { + "target": "com.amazonaws.route53#GetTrafficPolicyInstanceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#NoSuchTrafficPolicyInstance" + } + ], + "traits": { + "smithy.api#documentation": "

Gets information about a specified traffic policy instance.

\n \n

After you submit a CreateTrafficPolicyInstance or an\n\t\t\t\t\tUpdateTrafficPolicyInstance request, there's a brief delay while\n\t\t\t\tAmazon Route 53 creates the resource record sets that are specified in the traffic\n\t\t\t\tpolicy definition. For more information, see the State response\n\t\t\t\telement.

\n \n \n

In the Route 53 console, traffic policy instances are known as policy\n\t\t\t\trecords.

\n ", + "smithy.api#http": { + "method": "GET", + "uri": "/2013-04-01/trafficpolicyinstance/{Id}", + "code": 200 + } + } + }, + "com.amazonaws.route53#GetTrafficPolicyInstanceCount": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#GetTrafficPolicyInstanceCountRequest" + }, + "output": { + "target": "com.amazonaws.route53#GetTrafficPolicyInstanceCountResponse" + }, + "traits": { + "smithy.api#documentation": "

Gets the number of traffic policy instances that are associated with the current\n\t\t\t\tAmazon Web Services account.

", + "smithy.api#http": { + "method": "GET", + "uri": "/2013-04-01/trafficpolicyinstancecount", + "code": 200 + } + } + }, + "com.amazonaws.route53#GetTrafficPolicyInstanceCountRequest": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

Request to get the number of traffic policy instances that are associated with the\n\t\t\tcurrent Amazon Web Services account.

" + } + }, + "com.amazonaws.route53#GetTrafficPolicyInstanceCountResponse": { + "type": "structure", + "members": { + "TrafficPolicyInstanceCount": { + "target": "com.amazonaws.route53#TrafficPolicyInstanceCount", + "traits": { + "smithy.api#documentation": "

The number of traffic policy instances that are associated with the current Amazon Web Services account.

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

A complex type that contains information about the resource record sets that Amazon\n\t\t\tRoute 53 created based on a specified traffic policy.

" + } + }, + "com.amazonaws.route53#GetTrafficPolicyInstanceRequest": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.route53#TrafficPolicyInstanceId", + "traits": { + "smithy.api#documentation": "

The ID of the traffic policy instance that you want to get information about.

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

Gets information about a specified traffic policy instance.

" + } + }, + "com.amazonaws.route53#GetTrafficPolicyInstanceResponse": { + "type": "structure", + "members": { + "TrafficPolicyInstance": { + "target": "com.amazonaws.route53#TrafficPolicyInstance", + "traits": { + "smithy.api#documentation": "

A complex type that contains settings for the traffic policy instance.

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

A complex type that contains information about the resource record sets that Amazon\n\t\t\tRoute 53 created based on a specified traffic policy.

" + } + }, + "com.amazonaws.route53#GetTrafficPolicyRequest": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.route53#TrafficPolicyId", + "traits": { + "smithy.api#documentation": "

The ID of the traffic policy that you want to get information about.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Version": { + "target": "com.amazonaws.route53#TrafficPolicyVersion", + "traits": { + "smithy.api#documentation": "

The version number of the traffic policy that you want to get information\n\t\t\tabout.

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

Gets information about a specific traffic policy version.

" + } + }, + "com.amazonaws.route53#GetTrafficPolicyResponse": { + "type": "structure", + "members": { + "TrafficPolicy": { + "target": "com.amazonaws.route53#TrafficPolicy", + "traits": { + "smithy.api#documentation": "

A complex type that contains settings for the specified traffic policy.

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

A complex type that contains the response information for the request.

" + } + }, + "com.amazonaws.route53#HealthCheck": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.route53#HealthCheckId", + "traits": { + "smithy.api#documentation": "

The identifier that Amazon Route 53 assigned to the health check when you created it.\n\t\t\tWhen you add or update a resource record set, you use this value to specify which health\n\t\t\tcheck to use. The value can be up to 64 characters long.

", + "smithy.api#required": {} + } + }, + "CallerReference": { + "target": "com.amazonaws.route53#HealthCheckNonce", + "traits": { + "smithy.api#documentation": "

A unique string that you specified when you created the health check.

", + "smithy.api#required": {} + } + }, + "LinkedService": { + "target": "com.amazonaws.route53#LinkedService", + "traits": { + "smithy.api#documentation": "

If the health check was created by another service, the service that created the\n\t\t\thealth check. When a health check is created by another service, you can't edit or\n\t\t\tdelete it using Amazon Route 53.

" + } + }, + "HealthCheckConfig": { + "target": "com.amazonaws.route53#HealthCheckConfig", + "traits": { + "smithy.api#documentation": "

A complex type that contains detailed information about one health check.

", + "smithy.api#required": {} + } + }, + "HealthCheckVersion": { + "target": "com.amazonaws.route53#HealthCheckVersion", + "traits": { + "smithy.api#documentation": "

The version of the health check. You can optionally pass this value in a call to\n\t\t\t\tUpdateHealthCheck to prevent overwriting another change to the health\n\t\t\tcheck.

", + "smithy.api#required": {} + } + }, + "CloudWatchAlarmConfiguration": { + "target": "com.amazonaws.route53#CloudWatchAlarmConfiguration", + "traits": { + "smithy.api#documentation": "

A complex type that contains information about the CloudWatch alarm that Amazon Route\n\t\t\t53 is monitoring for this health check.

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

A complex type that contains information about one health check that is associated\n\t\t\twith the current Amazon Web Services account.

" + } + }, + "com.amazonaws.route53#HealthCheckAlreadyExists": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage", + "traits": { + "smithy.api#documentation": "

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

The health check you're attempting to create already exists. Amazon Route 53 returns\n\t\t\tthis error when you submit a request that has the following values:

\n ", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.route53#HealthCheckConfig": { + "type": "structure", + "members": { + "IPAddress": { + "target": "com.amazonaws.route53#IPAddress", + "traits": { + "smithy.api#documentation": "

The IPv4 or IPv6 IP address of the endpoint that you want Amazon Route 53 to perform\n\t\t\thealth checks on. If you don't specify a value for IPAddress, Route 53\n\t\t\tsends a DNS request to resolve the domain name that you specify in\n\t\t\t\tFullyQualifiedDomainName at the interval that you specify in\n\t\t\t\tRequestInterval. Using an IP address returned by DNS, Route 53 then\n\t\t\tchecks the health of the endpoint.

\n

Use one of the following formats for the value of IPAddress:

\n \n

If the endpoint is an EC2 instance, we recommend that you create an Elastic IP\n\t\t\taddress, associate it with your EC2 instance, and specify the Elastic IP address for\n\t\t\t\tIPAddress. This ensures that the IP address of your instance will never\n\t\t\tchange.

\n

For more information, see FullyQualifiedDomainName.

\n

Constraints: Route 53 can't check the health of endpoints for which the IP address is\n\t\t\tin local, private, non-routable, or multicast ranges. For more information about IP\n\t\t\taddresses for which you can't create health checks, see the following documents:

\n \n

When the value of Type is CALCULATED or\n\t\t\t\tCLOUDWATCH_METRIC, omit IPAddress.

" + } + }, + "Port": { + "target": "com.amazonaws.route53#Port", + "traits": { + "smithy.api#documentation": "

The port on the endpoint that you want Amazon Route 53 to perform health checks\n\t\t\ton.

\n \n

Don't specify a value for Port when you specify a value for\n\t\t\t\t\tType of CLOUDWATCH_METRIC or\n\t\t\t\tCALCULATED.

\n " + } + }, + "Type": { + "target": "com.amazonaws.route53#HealthCheckType", + "traits": { + "smithy.api#documentation": "

The type of health check that you want to create, which indicates how Amazon Route 53\n\t\t\tdetermines whether an endpoint is healthy.

\n \n

You can't change the value of Type after you create a health\n\t\t\t\tcheck.

\n \n

You can create the following types of health checks:

\n \n

For more information, see How Route 53 Determines Whether an Endpoint Is Healthy in the\n\t\t\t\tAmazon Route 53 Developer Guide.

", + "smithy.api#required": {} + } + }, + "ResourcePath": { + "target": "com.amazonaws.route53#ResourcePath", + "traits": { + "smithy.api#documentation": "

The path, if any, that you want Amazon Route 53 to request when performing health\n\t\t\tchecks. The path can be any value for which your endpoint will return an HTTP status\n\t\t\tcode of 2xx or 3xx when the endpoint is healthy, for example, the file\n\t\t\t/docs/route53-health-check.html. You can also include query string parameters, for\n\t\t\texample, /welcome.html?language=jp&login=y.

" + } + }, + "FullyQualifiedDomainName": { + "target": "com.amazonaws.route53#FullyQualifiedDomainName", + "traits": { + "smithy.api#documentation": "

Amazon Route 53 behavior depends on whether you specify a value for\n\t\t\t\tIPAddress.

\n

\n If you specify a value for\n IPAddress:

\n

Amazon Route 53 sends health check requests to the specified IPv4 or IPv6 address and\n\t\t\tpasses the value of FullyQualifiedDomainName in the Host\n\t\t\theader for all health checks except TCP health checks. This is typically the fully\n\t\t\tqualified DNS name of the endpoint on which you want Route 53 to perform health\n\t\t\tchecks.

\n

When Route 53 checks the health of an endpoint, here is how it constructs the\n\t\t\t\tHost header:

\n \n

If you don't specify a value for FullyQualifiedDomainName, Route 53\n\t\t\tsubstitutes the value of IPAddress in the Host header in each\n\t\t\tof the preceding cases.

\n

\n If you don't specify a value for\n IPAddress:

\n

Route 53 sends a DNS request to the domain that you specify for\n\t\t\t\tFullyQualifiedDomainName at the interval that you specify for\n\t\t\t\tRequestInterval. Using an IPv4 address that DNS returns, Route 53 then\n\t\t\tchecks the health of the endpoint.

\n \n

If you don't specify a value for IPAddress, Route 53 uses only IPv4\n\t\t\t\tto send health checks to the endpoint. If there's no resource record set with a type\n\t\t\t\tof A for the name that you specify for FullyQualifiedDomainName, the\n\t\t\t\thealth check fails with a \"DNS resolution failed\" error.

\n \n

If you want to check the health of weighted, latency, or failover resource record sets\n\t\t\tand you choose to specify the endpoint only by FullyQualifiedDomainName, we\n\t\t\trecommend that you create a separate health check for each endpoint. For example, create\n\t\t\ta health check for each HTTP server that is serving content for www.example.com. For the\n\t\t\tvalue of FullyQualifiedDomainName, specify the domain name of the server\n\t\t\t(such as us-east-2-www.example.com), not the name of the resource record sets\n\t\t\t(www.example.com).

\n \n

In this configuration, if you create a health check for which the value of\n\t\t\t\t\tFullyQualifiedDomainName matches the name of the resource record\n\t\t\t\tsets and you then associate the health check with those resource record sets, health\n\t\t\t\tcheck results will be unpredictable.

\n \n

In addition, if the value that you specify for Type is HTTP,\n\t\t\t\tHTTPS, HTTP_STR_MATCH, or HTTPS_STR_MATCH,\n\t\t\tRoute 53 passes the value of FullyQualifiedDomainName in the\n\t\t\t\tHost header, as it does when you specify a value for\n\t\t\t\tIPAddress. If the value of Type is TCP, Route\n\t\t\t53 doesn't pass a Host header.

" + } + }, + "SearchString": { + "target": "com.amazonaws.route53#SearchString", + "traits": { + "smithy.api#documentation": "

If the value of Type is HTTP_STR_MATCH or HTTPS_STR_MATCH,\n\t\t\tthe string that you want Amazon Route 53 to search for in the response body from the\n\t\t\tspecified resource. If the string appears in the response body, Route 53 considers the\n\t\t\tresource healthy.

\n

Route 53 considers case when searching for SearchString in the response\n\t\t\tbody.

" + } + }, + "RequestInterval": { + "target": "com.amazonaws.route53#RequestInterval", + "traits": { + "smithy.api#documentation": "

The number of seconds between the time that Amazon Route 53 gets a response from your\n\t\t\tendpoint and the time that it sends the next health check request. Each Route 53 health\n\t\t\tchecker makes requests at this interval.

\n \n

You can't change the value of RequestInterval after you create a\n\t\t\t\thealth check.

\n \n

If you don't specify a value for RequestInterval, the default value is\n\t\t\t\t30 seconds.

" + } + }, + "FailureThreshold": { + "target": "com.amazonaws.route53#FailureThreshold", + "traits": { + "smithy.api#documentation": "

The number of consecutive health checks that an endpoint must pass or fail for Amazon\n\t\t\tRoute 53 to change the current status of the endpoint from unhealthy to healthy or vice\n\t\t\tversa. For more information, see How Amazon Route 53 Determines Whether an Endpoint Is Healthy in the\n\t\t\t\tAmazon Route 53 Developer Guide.

\n

If you don't specify a value for FailureThreshold, the default value is\n\t\t\tthree health checks.

" + } + }, + "MeasureLatency": { + "target": "com.amazonaws.route53#MeasureLatency", + "traits": { + "smithy.api#documentation": "

Specify whether you want Amazon Route 53 to measure the latency between health\n\t\t\tcheckers in multiple Amazon Web Services regions and your endpoint, and to display\n\t\t\tCloudWatch latency graphs on the Health Checks page in\n\t\t\tthe Route 53 console.

\n \n

You can't change the value of MeasureLatency after you create a\n\t\t\t\thealth check.

\n " + } + }, + "Inverted": { + "target": "com.amazonaws.route53#Inverted", + "traits": { + "smithy.api#documentation": "

Specify whether you want Amazon Route 53 to invert the status of a health check, for\n\t\t\texample, to consider a health check unhealthy when it otherwise would be considered\n\t\t\thealthy.

" + } + }, + "Disabled": { + "target": "com.amazonaws.route53#Disabled", + "traits": { + "smithy.api#documentation": "

Stops Route 53 from performing health checks. When you disable a health check, here's\n\t\t\twhat happens:

\n \n

After you disable a health check, Route 53 considers the status of the health check to\n\t\t\talways be healthy. If you configured DNS failover, Route 53 continues to route traffic\n\t\t\tto the corresponding resources. If you want to stop routing traffic to a resource,\n\t\t\tchange the value of Inverted.

\n

Charges for a health check still apply when the health check is disabled. For more\n\t\t\tinformation, see Amazon Route 53\n\t\t\t\tPricing.

" + } + }, + "HealthThreshold": { + "target": "com.amazonaws.route53#HealthThreshold", + "traits": { + "smithy.api#documentation": "

The number of child health checks that are associated with a CALCULATED\n\t\t\thealth check that Amazon Route 53 must consider healthy for the CALCULATED\n\t\t\thealth check to be considered healthy. To specify the child health checks that you want\n\t\t\tto associate with a CALCULATED health check, use the ChildHealthChecks element.

\n

Note the following:

\n " + } + }, + "ChildHealthChecks": { + "target": "com.amazonaws.route53#ChildHealthCheckList", + "traits": { + "smithy.api#documentation": "

(CALCULATED Health Checks Only) A complex type that contains one\n\t\t\t\tChildHealthCheck element for each health check that you want to\n\t\t\tassociate with a CALCULATED health check.

" + } + }, + "EnableSNI": { + "target": "com.amazonaws.route53#EnableSNI", + "traits": { + "smithy.api#documentation": "

Specify whether you want Amazon Route 53 to send the value of\n\t\t\t\tFullyQualifiedDomainName to the endpoint in the\n\t\t\t\tclient_hello message during TLS negotiation. This allows the endpoint\n\t\t\tto respond to HTTPS health check requests with the applicable SSL/TLS\n\t\t\tcertificate.

\n

Some endpoints require that HTTPS requests include the host name in the\n\t\t\t\tclient_hello message. If you don't enable SNI, the status of the health\n\t\t\tcheck will be SSL alert handshake_failure. A health check can also have\n\t\t\tthat status for other reasons. If SNI is enabled and you're still getting the error,\n\t\t\tcheck the SSL/TLS configuration on your endpoint and confirm that your certificate is\n\t\t\tvalid.

\n

The SSL/TLS certificate on your endpoint includes a domain name in the Common\n\t\t\t\tName field and possibly several more in the Subject Alternative\n\t\t\t\tNames field. One of the domain names in the certificate should match the\n\t\t\tvalue that you specify for FullyQualifiedDomainName. If the endpoint\n\t\t\tresponds to the client_hello message with a certificate that does not\n\t\t\tinclude the domain name that you specified in FullyQualifiedDomainName, a\n\t\t\thealth checker will retry the handshake. In the second attempt, the health checker will\n\t\t\tomit FullyQualifiedDomainName from the client_hello\n\t\t\tmessage.

" + } + }, + "Regions": { + "target": "com.amazonaws.route53#HealthCheckRegionList", + "traits": { + "smithy.api#documentation": "

A complex type that contains one Region element for each region from\n\t\t\twhich you want Amazon Route 53 health checkers to check the specified endpoint.

\n

If you don't specify any regions, Route 53 health checkers automatically performs\n\t\t\tchecks from all of the regions that are listed under Valid\n\t\t\t\tValues.

\n

If you update a health check to remove a region that has been performing health\n\t\t\tchecks, Route 53 will briefly continue to perform checks from that region to ensure that\n\t\t\tsome health checkers are always checking the endpoint (for example, if you replace three\n\t\t\tregions with four different regions).

" + } + }, + "AlarmIdentifier": { + "target": "com.amazonaws.route53#AlarmIdentifier", + "traits": { + "smithy.api#documentation": "

A complex type that identifies the CloudWatch alarm that you want Amazon Route 53\n\t\t\thealth checkers to use to determine whether the specified health check is\n\t\t\thealthy.

" + } + }, + "InsufficientDataHealthStatus": { + "target": "com.amazonaws.route53#InsufficientDataHealthStatus", + "traits": { + "smithy.api#documentation": "

When CloudWatch has insufficient data about the metric to determine the alarm state,\n\t\t\tthe status that you want Amazon Route 53 to assign to the health check:

\n " + } + }, + "RoutingControlArn": { + "target": "com.amazonaws.route53#RoutingControlArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the Route 53 Application Recovery Controller\n\t\t\trouting control.

\n

For more information about Route 53 Application Recovery Controller, see Route 53 Application Recovery Controller Developer Guide..

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

A complex type that contains information about the health check.

" + } + }, + "com.amazonaws.route53#HealthCheckCount": { + "type": "long" + }, + "com.amazonaws.route53#HealthCheckId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 64 + } + } + }, + "com.amazonaws.route53#HealthCheckInUse": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage", + "traits": { + "smithy.api#documentation": "

" + } + } + }, + "traits": { + "smithy.api#deprecated": {}, + "smithy.api#documentation": "

This error code is not in use.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.route53#HealthCheckNonce": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + } + } + }, + "com.amazonaws.route53#HealthCheckObservation": { + "type": "structure", + "members": { + "Region": { + "target": "com.amazonaws.route53#HealthCheckRegion", + "traits": { + "smithy.api#documentation": "

The region of the Amazon Route 53 health checker that provided the status in\n\t\t\t\tStatusReport.

" + } + }, + "IPAddress": { + "target": "com.amazonaws.route53#IPAddress", + "traits": { + "smithy.api#documentation": "

The IP address of the Amazon Route 53 health checker that provided the failure reason\n\t\t\tin StatusReport.

" + } + }, + "StatusReport": { + "target": "com.amazonaws.route53#StatusReport", + "traits": { + "smithy.api#documentation": "

A complex type that contains the last failure reason as reported by one Amazon Route\n\t\t\t53 health checker and the time of the failed health check.

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

A complex type that contains the last failure reason as reported by one Amazon Route\n\t\t\t53 health checker.

" + } + }, + "com.amazonaws.route53#HealthCheckObservations": { + "type": "list", + "member": { + "target": "com.amazonaws.route53#HealthCheckObservation", + "traits": { + "smithy.api#xmlName": "HealthCheckObservation" + } + } + }, + "com.amazonaws.route53#HealthCheckRegion": { + "type": "enum", + "members": { + "us_east_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "us-east-1" + } + }, + "us_west_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "us-west-1" + } + }, + "us_west_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "us-west-2" + } + }, + "eu_west_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "eu-west-1" + } + }, + "ap_southeast_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-southeast-1" + } + }, + "ap_southeast_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-southeast-2" + } + }, + "ap_northeast_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-northeast-1" + } + }, + "sa_east_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "sa-east-1" + } + } + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + } + } + }, + "com.amazonaws.route53#HealthCheckRegionList": { + "type": "list", + "member": { + "target": "com.amazonaws.route53#HealthCheckRegion", + "traits": { + "smithy.api#xmlName": "Region" + } + }, + "traits": { + "smithy.api#length": { + "min": 3, + "max": 64 + } + } + }, + "com.amazonaws.route53#HealthCheckType": { + "type": "enum", + "members": { + "HTTP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HTTP" + } + }, + "HTTPS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HTTPS" + } + }, + "HTTP_STR_MATCH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HTTP_STR_MATCH" + } + }, + "HTTPS_STR_MATCH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HTTPS_STR_MATCH" + } + }, + "TCP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TCP" + } + }, + "CALCULATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CALCULATED" + } + }, + "CLOUDWATCH_METRIC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CLOUDWATCH_METRIC" + } + }, + "RECOVERY_CONTROL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RECOVERY_CONTROL" + } + } + } + }, + "com.amazonaws.route53#HealthCheckVersion": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.route53#HealthCheckVersionMismatch": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The value of HealthCheckVersion in the request doesn't match the value of\n\t\t\t\tHealthCheckVersion in the health check.

", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.route53#HealthChecks": { + "type": "list", + "member": { + "target": "com.amazonaws.route53#HealthCheck", + "traits": { + "smithy.api#xmlName": "HealthCheck" + } + } + }, + "com.amazonaws.route53#HealthThreshold": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.route53#HostedZone": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.route53#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID that Amazon Route 53 assigned to the hosted zone when you created it.

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.route53#DNSName", + "traits": { + "smithy.api#documentation": "

The name of the domain. For public hosted zones, this is the name that you have\n\t\t\tregistered with your DNS registrar.

\n

For information about how to specify characters other than a-z,\n\t\t\t\t0-9, and - (hyphen) and how to specify internationalized\n\t\t\tdomain names, see CreateHostedZone.

", + "smithy.api#required": {} + } + }, + "CallerReference": { + "target": "com.amazonaws.route53#Nonce", + "traits": { + "smithy.api#documentation": "

The value that you specified for CallerReference when you created the\n\t\t\thosted zone.

", + "smithy.api#required": {} + } + }, + "Config": { + "target": "com.amazonaws.route53#HostedZoneConfig", + "traits": { + "smithy.api#documentation": "

A complex type that includes the Comment and PrivateZone\n\t\t\telements. If you omitted the HostedZoneConfig and Comment\n\t\t\telements from the request, the Config and Comment elements\n\t\t\tdon't appear in the response.

" + } + }, + "ResourceRecordSetCount": { + "target": "com.amazonaws.route53#HostedZoneRRSetCount", + "traits": { + "smithy.api#documentation": "

The number of resource record sets in the hosted zone.

" + } + }, + "LinkedService": { + "target": "com.amazonaws.route53#LinkedService", + "traits": { + "smithy.api#documentation": "

If the hosted zone was created by another service, the service that created the hosted\n\t\t\tzone. When a hosted zone is created by another service, you can't edit or delete it\n\t\t\tusing Route 53.

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

A complex type that contains general information about the hosted zone.

" + } + }, + "com.amazonaws.route53#HostedZoneAlreadyExists": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage", + "traits": { + "smithy.api#documentation": "

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

The hosted zone you're trying to create already exists. Amazon Route 53 returns this\n\t\t\terror when a hosted zone has already been created with the specified\n\t\t\t\tCallerReference.

", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.route53#HostedZoneConfig": { + "type": "structure", + "members": { + "Comment": { + "target": "com.amazonaws.route53#ResourceDescription", + "traits": { + "smithy.api#documentation": "

Any comments that you want to include about the hosted zone.

" + } + }, + "PrivateZone": { + "target": "com.amazonaws.route53#IsPrivateZone", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A value that indicates whether this is a private hosted zone.

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

A complex type that contains an optional comment about your hosted zone. If you don't\n\t\t\twant to specify a comment, omit both the HostedZoneConfig and\n\t\t\t\tComment elements.

" + } + }, + "com.amazonaws.route53#HostedZoneCount": { + "type": "long" + }, + "com.amazonaws.route53#HostedZoneLimit": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.route53#HostedZoneLimitType", + "traits": { + "smithy.api#documentation": "

The limit that you requested. Valid values include the following:

\n ", + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.route53#LimitValue", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The current value for the limit that is specified by Type.

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

A complex type that contains the type of limit that you specified in the request and\n\t\t\tthe current value for that limit.

" + } + }, + "com.amazonaws.route53#HostedZoneLimitType": { + "type": "enum", + "members": { + "MAX_RRSETS_BY_ZONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MAX_RRSETS_BY_ZONE" + } + }, + "MAX_VPCS_ASSOCIATED_BY_ZONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MAX_VPCS_ASSOCIATED_BY_ZONE" + } + } + } + }, + "com.amazonaws.route53#HostedZoneNotEmpty": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage", + "traits": { + "smithy.api#documentation": "

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

The hosted zone contains resource records that are not SOA or NS records.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.route53#HostedZoneNotFound": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage", + "traits": { + "smithy.api#documentation": "

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

The specified HostedZone can't be found.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.route53#HostedZoneNotPrivate": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage", + "traits": { + "smithy.api#documentation": "

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

The specified hosted zone is a public hosted zone, not a private hosted zone.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.route53#HostedZoneOwner": { + "type": "structure", + "members": { + "OwningAccount": { + "target": "com.amazonaws.route53#AWSAccountID", + "traits": { + "smithy.api#documentation": "

If the hosted zone was created by an Amazon Web Services account, or was created by an\n\t\t\t\tAmazon Web Services service that creates hosted zones using the current account,\n\t\t\t\tOwningAccount contains the account ID of that account. For example,\n\t\t\twhen you use Cloud Map to create a hosted zone, Cloud Map creates the hosted\n\t\t\tzone using the current Amazon Web Services account.

" + } + }, + "OwningService": { + "target": "com.amazonaws.route53#HostedZoneOwningService", + "traits": { + "smithy.api#documentation": "

If an Amazon Web Services service uses its own account to create a hosted zone and\n\t\t\tassociate the specified VPC with that hosted zone, OwningService contains\n\t\t\tan abbreviation that identifies the service. For example, if Amazon Elastic File System\n\t\t\t(Amazon EFS) created a hosted zone and associated a VPC with the hosted zone, the value\n\t\t\tof OwningService is efs.amazonaws.com.

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

A complex type that identifies a hosted zone that a specified Amazon VPC is associated\n\t\t\twith and the owner of the hosted zone. If there is a value for\n\t\t\t\tOwningAccount, there is no value for OwningService, and\n\t\t\tvice versa.

" + } + }, + "com.amazonaws.route53#HostedZoneOwningService": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 128 + } + } + }, + "com.amazonaws.route53#HostedZonePartiallyDelegated": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The hosted zone nameservers don't match the parent nameservers. The hosted zone and\n\t\t\tparent must have the same nameservers.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.route53#HostedZoneRRSetCount": { + "type": "long" + }, + "com.amazonaws.route53#HostedZoneSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.route53#HostedZoneSummary", + "traits": { + "smithy.api#xmlName": "HostedZoneSummary" + } + } + }, + "com.amazonaws.route53#HostedZoneSummary": { + "type": "structure", + "members": { + "HostedZoneId": { + "target": "com.amazonaws.route53#ResourceId", + "traits": { + "smithy.api#documentation": "

The Route 53 hosted zone ID of a private hosted zone that the specified VPC is\n\t\t\tassociated with.

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.route53#DNSName", + "traits": { + "smithy.api#documentation": "

The name of the private hosted zone, such as example.com.

", + "smithy.api#required": {} + } + }, + "Owner": { + "target": "com.amazonaws.route53#HostedZoneOwner", + "traits": { + "smithy.api#documentation": "

The owner of a private hosted zone that the specified VPC is associated with. The\n\t\t\towner can be either an Amazon Web Services account or an Amazon Web Services\n\t\t\tservice.

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

In the response to a ListHostedZonesByVPC request, the\n\t\t\t\tHostedZoneSummaries element contains one HostedZoneSummary\n\t\t\telement for each hosted zone that the specified Amazon VPC is associated with. Each\n\t\t\t\tHostedZoneSummary element contains the hosted zone name and ID, and\n\t\t\tinformation about who owns the hosted zone.

" + } + }, + "com.amazonaws.route53#HostedZones": { + "type": "list", + "member": { + "target": "com.amazonaws.route53#HostedZone", + "traits": { + "smithy.api#xmlName": "HostedZone" + } + } + }, + "com.amazonaws.route53#IPAddress": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 45 + }, + "smithy.api#pattern": "^(^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))$|^(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9]))$)$" + } + }, + "com.amazonaws.route53#IPAddressCidr": { + "type": "string" + }, + "com.amazonaws.route53#IncompatibleVersion": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The resource you're trying to access is unsupported on this Amazon Route 53\n\t\t\tendpoint.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.route53#InsufficientCloudWatchLogsResourcePolicy": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

Amazon Route 53 doesn't have the permissions required to create log streams and send\n\t\t\tquery logs to log streams. Possible causes include the following:

\n ", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.route53#InsufficientDataHealthStatus": { + "type": "enum", + "members": { + "Healthy": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Healthy" + } + }, + "Unhealthy": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Unhealthy" + } + }, + "LastKnownStatus": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LastKnownStatus" + } + } + } + }, + "com.amazonaws.route53#InvalidArgument": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage", + "traits": { + "smithy.api#documentation": "

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

Parameter name is not valid.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.route53#InvalidChangeBatch": { + "type": "structure", + "members": { + "messages": { + "target": "com.amazonaws.route53#ErrorMessages", + "traits": { + "smithy.api#documentation": "

" + } + }, + "message": { + "target": "com.amazonaws.route53#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

This exception contains a list of messages that might contain one or more error\n\t\t\tmessages. Each error message indicates one error in the change batch.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.route53#InvalidDomainName": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage", + "traits": { + "smithy.api#documentation": "

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

The specified domain name is not valid.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.route53#InvalidInput": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage", + "traits": { + "smithy.api#documentation": "

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

The input is not valid.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.route53#InvalidKMSArn": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The KeyManagementServiceArn that you specified isn't valid to use with DNSSEC\n\t\t\tsigning.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.route53#InvalidKeySigningKeyName": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The key-signing key (KSK) name that you specified isn't a valid name.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.route53#InvalidKeySigningKeyStatus": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The key-signing key (KSK) status isn't valid or another KSK has the status\n\t\t\t\tINTERNAL_FAILURE.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.route53#InvalidPaginationToken": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The value that you specified to get the second or subsequent page of results is\n\t\t\tinvalid.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.route53#InvalidSigningStatus": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

Your hosted zone status isn't valid for this operation. In the hosted zone, change the\n\t\t\tstatus to enable DNSSEC or disable DNSSEC.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.route53#InvalidTrafficPolicyDocument": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage", + "traits": { + "smithy.api#documentation": "

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

The format of the traffic policy document that you specified in the\n\t\t\t\tDocument element is not valid.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.route53#InvalidVPCId": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage", + "traits": { + "smithy.api#documentation": "

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

The VPC ID that you specified either isn't a valid ID or the current account is not\n\t\t\tauthorized to access this VPC.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.route53#Inverted": { + "type": "boolean" + }, + "com.amazonaws.route53#IsPrivateZone": { + "type": "boolean", + "traits": { + "smithy.api#default": false + } + }, + "com.amazonaws.route53#KeySigningKey": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.route53#SigningKeyName", + "traits": { + "smithy.api#documentation": "

A string used to identify a key-signing key (KSK). Name can include\n\t\t\tnumbers, letters, and underscores (_). Name must be unique for each\n\t\t\tkey-signing key in the same hosted zone.

" + } + }, + "KmsArn": { + "target": "com.amazonaws.route53#SigningKeyString", + "traits": { + "smithy.api#documentation": "

The Amazon resource name (ARN) used to identify the customer managed key in Key Management Service (KMS). The KmsArn must be unique for each\n\t\t\tkey-signing key (KSK) in a single hosted zone.

\n

You must configure the customer managed key as follows:

\n
\n
Status
\n
\n

Enabled

\n
\n
Key spec
\n
\n

ECC_NIST_P256

\n
\n
Key usage
\n
\n

Sign and verify

\n
\n
Key policy
\n
\n

The key policy must give permission for the following actions:

\n
    \n
  • \n

    DescribeKey

    \n
    • \n
  • \n

    GetPublicKey

    \n
    • \n
  • \n

    Sign

    \n
    • \n
\n

The key policy must also include the Amazon Route 53 service in the\n\t\t\t\t\t\tprincipal for your account. Specify the following:

\n
    \n
  • \n

    \n \"Service\": \"dnssec-route53.amazonaws.com\"\n

    \n
    • \n
\n
\n
\n

For more information about working with the customer managed key in KMS, see Key Management Service\n\t\t\t\tconcepts.

" + } + }, + "Flag": { + "target": "com.amazonaws.route53#SigningKeyInteger", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

An integer that specifies how the key is used. For key-signing key (KSK), this value\n\t\t\tis always 257.

" + } + }, + "SigningAlgorithmMnemonic": { + "target": "com.amazonaws.route53#SigningKeyString", + "traits": { + "smithy.api#documentation": "

A string used to represent the signing algorithm. This value must follow the\n\t\t\tguidelines provided by RFC-8624 Section 3.1.

" + } + }, + "SigningAlgorithmType": { + "target": "com.amazonaws.route53#SigningKeyInteger", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

An integer used to represent the signing algorithm. This value must follow the\n\t\t\tguidelines provided by RFC-8624 Section 3.1.

" + } + }, + "DigestAlgorithmMnemonic": { + "target": "com.amazonaws.route53#SigningKeyString", + "traits": { + "smithy.api#documentation": "

A string used to represent the delegation signer digest algorithm. This value must\n\t\t\tfollow the guidelines provided by RFC-8624 Section 3.3.\n\t\t

" + } + }, + "DigestAlgorithmType": { + "target": "com.amazonaws.route53#SigningKeyInteger", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

An integer used to represent the delegation signer digest algorithm. This value must\n\t\t\tfollow the guidelines provided by RFC-8624 Section\n\t\t\t3.3.

" + } + }, + "KeyTag": { + "target": "com.amazonaws.route53#SigningKeyTag", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

An integer used to identify the DNSSEC record for the domain name. The process used to\n\t\t\tcalculate the value is described in RFC-4034 Appendix B.

" + } + }, + "DigestValue": { + "target": "com.amazonaws.route53#SigningKeyString", + "traits": { + "smithy.api#documentation": "

A cryptographic digest of a DNSKEY resource record (RR). DNSKEY records are used to\n\t\t\tpublish the public key that resolvers can use to verify DNSSEC signatures that are used\n\t\t\tto secure certain kinds of information provided by the DNS system.

" + } + }, + "PublicKey": { + "target": "com.amazonaws.route53#SigningKeyString", + "traits": { + "smithy.api#documentation": "

The public key, represented as a Base64 encoding, as required by RFC-4034 Page 5.

" + } + }, + "DSRecord": { + "target": "com.amazonaws.route53#SigningKeyString", + "traits": { + "smithy.api#documentation": "

A string that represents a delegation signer (DS) record.

" + } + }, + "DNSKEYRecord": { + "target": "com.amazonaws.route53#SigningKeyString", + "traits": { + "smithy.api#documentation": "

A string that represents a DNSKEY record.

" + } + }, + "Status": { + "target": "com.amazonaws.route53#SigningKeyStatus", + "traits": { + "smithy.api#documentation": "

A string that represents the current key-signing key (KSK) status.

\n

Status can have one of the following values:

\n
\n
ACTIVE
\n
\n

The KSK is being used for signing.

\n
\n
INACTIVE
\n
\n

The KSK is not being used for signing.

\n
\n
DELETING
\n
\n

The KSK is in the process of being deleted.

\n
\n
ACTION_NEEDED
\n
\n

There is a problem with the KSK that requires you to take action to\n\t\t\t\t\t\tresolve. For example, the customer managed key might have been deleted,\n\t\t\t\t\t\tor the permissions for the customer managed key might have been\n\t\t\t\t\t\tchanged.

\n
\n
INTERNAL_FAILURE
\n
\n

There was an error during a request. Before you can continue to work with\n\t\t\t\t\t\tDNSSEC signing, including actions that involve this KSK, you must correct\n\t\t\t\t\t\tthe problem. For example, you may need to activate or deactivate the\n\t\t\t\t\t\tKSK.

\n
\n
" + } + }, + "StatusMessage": { + "target": "com.amazonaws.route53#SigningKeyStatusMessage", + "traits": { + "smithy.api#documentation": "

The status message provided for the following key-signing key (KSK) statuses:\n\t\t\t\tACTION_NEEDED or INTERNAL_FAILURE. The status message\n\t\t\tincludes information about what the problem might be and steps that you can take to\n\t\t\tcorrect the issue.

" + } + }, + "CreatedDate": { + "target": "com.amazonaws.route53#TimeStamp", + "traits": { + "smithy.api#documentation": "

The date when the key-signing key (KSK) was created.

" + } + }, + "LastModifiedDate": { + "target": "com.amazonaws.route53#TimeStamp", + "traits": { + "smithy.api#documentation": "

The last time that the key-signing key (KSK) was changed.

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

A key-signing key (KSK) is a complex type that represents a public/private key pair.\n\t\t\tThe private key is used to generate a digital signature for the zone signing key (ZSK).\n\t\t\tThe public key is stored in the DNS and is used to authenticate the ZSK. A KSK is always\n\t\t\tassociated with a hosted zone; it cannot exist by itself.

" + } + }, + "com.amazonaws.route53#KeySigningKeyAlreadyExists": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

You've already created a key-signing key (KSK) with this name or with the same customer managed key ARN.

", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.route53#KeySigningKeyInParentDSRecord": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The key-signing key (KSK) is specified in a parent DS record.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.route53#KeySigningKeyInUse": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The key-signing key (KSK) that you specified can't be deactivated because it's the\n\t\t\tonly KSK for a currently-enabled DNSSEC. Disable DNSSEC signing, or add or enable\n\t\t\tanother KSK.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.route53#KeySigningKeyWithActiveStatusNotFound": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

A key-signing key (KSK) with ACTIVE status wasn't found.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.route53#KeySigningKeys": { + "type": "list", + "member": { + "target": "com.amazonaws.route53#KeySigningKey" + } + }, + "com.amazonaws.route53#LastVPCAssociation": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage", + "traits": { + "smithy.api#documentation": "

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

The VPC that you're trying to disassociate from the private hosted zone is the last\n\t\t\tVPC that is associated with the hosted zone. Amazon Route 53 doesn't support\n\t\t\tdisassociating the last VPC from a hosted zone.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.route53#LimitValue": { + "type": "long", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.route53#LimitsExceeded": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage", + "traits": { + "smithy.api#documentation": "

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

This operation can't be completed because the current account has reached the\n\t\t\tlimit on the resource you are trying to create. To request a higher limit, create a case with the Amazon Web Services Support\n\t\t\tCenter.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.route53#LinkedService": { + "type": "structure", + "members": { + "ServicePrincipal": { + "target": "com.amazonaws.route53#ServicePrincipal", + "traits": { + "smithy.api#documentation": "

If the health check or hosted zone was created by another service, the service that\n\t\t\tcreated the resource. When a resource is created by another service, you can't edit or\n\t\t\tdelete it using Amazon Route 53.

" + } + }, + "Description": { + "target": "com.amazonaws.route53#ResourceDescription", + "traits": { + "smithy.api#documentation": "

If the health check or hosted zone was created by another service, an optional\n\t\t\tdescription that can be provided by the other service. When a resource is created by\n\t\t\tanother service, you can't edit or delete it using Amazon Route 53.

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

If a health check or hosted zone was created by another service,\n\t\t\t\tLinkedService is a complex type that describes the service that created\n\t\t\tthe resource. When a resource is created by another service, you can't edit or delete it\n\t\t\tusing Amazon Route 53.

" + } + }, + "com.amazonaws.route53#ListCidrBlocks": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#ListCidrBlocksRequest" + }, + "output": { + "target": "com.amazonaws.route53#ListCidrBlocksResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#NoSuchCidrCollectionException" + }, + { + "target": "com.amazonaws.route53#NoSuchCidrLocationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a paginated list of location objects and their CIDR blocks.

", + "smithy.api#http": { + "method": "GET", + "uri": "/2013-04-01/cidrcollection/{CollectionId}/cidrblocks", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "CidrBlocks", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.route53#ListCidrBlocksRequest": { + "type": "structure", + "members": { + "CollectionId": { + "target": "com.amazonaws.route53#UUID", + "traits": { + "smithy.api#documentation": "

The UUID of the CIDR collection.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "LocationName": { + "target": "com.amazonaws.route53#CidrLocationNameDefaultNotAllowed", + "traits": { + "smithy.api#documentation": "

The name of the CIDR collection location.

", + "smithy.api#httpQuery": "location" + } + }, + "NextToken": { + "target": "com.amazonaws.route53#PaginationToken", + "traits": { + "smithy.api#documentation": "

An opaque pagination token to indicate where the service is to begin enumerating\n\t\t\tresults.

", + "smithy.api#httpQuery": "nexttoken" + } + }, + "MaxResults": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

Maximum number of results you want returned.

", + "smithy.api#httpQuery": "maxresults" + } + } + } + }, + "com.amazonaws.route53#ListCidrBlocksResponse": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.route53#PaginationToken", + "traits": { + "smithy.api#documentation": "

An opaque pagination token to indicate where the service is to begin enumerating\n\t\t\tresults.

\n

If no value is provided, the listing of results starts from the beginning.

" + } + }, + "CidrBlocks": { + "target": "com.amazonaws.route53#CidrBlockSummaries", + "traits": { + "smithy.api#documentation": "

A complex type that contains information about the CIDR blocks.

" + } + } + } + }, + "com.amazonaws.route53#ListCidrCollections": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#ListCidrCollectionsRequest" + }, + "output": { + "target": "com.amazonaws.route53#ListCidrCollectionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#InvalidInput" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a paginated list of CIDR collections in the Amazon Web Services account\n\t\t\t(metadata only).

", + "smithy.api#http": { + "method": "GET", + "uri": "/2013-04-01/cidrcollection", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "CidrCollections", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.route53#ListCidrCollectionsRequest": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.route53#PaginationToken", + "traits": { + "smithy.api#documentation": "

An opaque pagination token to indicate where the service is to begin enumerating\n\t\t\tresults.

\n

If no value is provided, the listing of results starts from the beginning.

", + "smithy.api#httpQuery": "nexttoken" + } + }, + "MaxResults": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The maximum number of CIDR collections to return in the response.

", + "smithy.api#httpQuery": "maxresults" + } + } + } + }, + "com.amazonaws.route53#ListCidrCollectionsResponse": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.route53#PaginationToken", + "traits": { + "smithy.api#documentation": "

An opaque pagination token to indicate where the service is to begin enumerating\n\t\t\tresults.

\n

If no value is provided, the listing of results starts from the beginning.

" + } + }, + "CidrCollections": { + "target": "com.amazonaws.route53#CollectionSummaries", + "traits": { + "smithy.api#documentation": "

A complex type with information about the CIDR collection.

" + } + } + } + }, + "com.amazonaws.route53#ListCidrLocations": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#ListCidrLocationsRequest" + }, + "output": { + "target": "com.amazonaws.route53#ListCidrLocationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#NoSuchCidrCollectionException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a paginated list of CIDR locations for the given collection (metadata only,\n\t\t\tdoes not include CIDR blocks).

", + "smithy.api#http": { + "method": "GET", + "uri": "/2013-04-01/cidrcollection/{CollectionId}", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "CidrLocations", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.route53#ListCidrLocationsRequest": { + "type": "structure", + "members": { + "CollectionId": { + "target": "com.amazonaws.route53#UUID", + "traits": { + "smithy.api#documentation": "

The CIDR collection ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.route53#PaginationToken", + "traits": { + "smithy.api#documentation": "

An opaque pagination token to indicate where the service is to begin enumerating\n\t\t\tresults.

\n

If no value is provided, the listing of results starts from the beginning.

", + "smithy.api#httpQuery": "nexttoken" + } + }, + "MaxResults": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The maximum number of CIDR collection locations to return in the response.

", + "smithy.api#httpQuery": "maxresults" + } + } + } + }, + "com.amazonaws.route53#ListCidrLocationsResponse": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.route53#PaginationToken", + "traits": { + "smithy.api#documentation": "

An opaque pagination token to indicate where the service is to begin enumerating\n\t\t\tresults.

\n

If no value is provided, the listing of results starts from the beginning.

" + } + }, + "CidrLocations": { + "target": "com.amazonaws.route53#LocationSummaries", + "traits": { + "smithy.api#documentation": "

A complex type that contains information about the list of CIDR locations.

" + } + } + } + }, + "com.amazonaws.route53#ListGeoLocations": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#ListGeoLocationsRequest" + }, + "output": { + "target": "com.amazonaws.route53#ListGeoLocationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#InvalidInput" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves a list of supported geographic locations.

\n

Countries are listed first, and continents are listed last. If Amazon Route 53\n\t\t\tsupports subdivisions for a country (for example, states or provinces), the subdivisions\n\t\t\tfor that country are listed in alphabetical order immediately after the corresponding\n\t\t\tcountry.

\n

Route 53 does not perform authorization for this API because it retrieves information\n\t\t\tthat is already available to the public.

\n

For a list of supported geolocation codes, see the GeoLocation data\n\t\t\ttype.

", + "smithy.api#http": { + "method": "GET", + "uri": "/2013-04-01/geolocations", + "code": 200 + } + } + }, + "com.amazonaws.route53#ListGeoLocationsRequest": { + "type": "structure", + "members": { + "StartContinentCode": { + "target": "com.amazonaws.route53#GeoLocationContinentCode", + "traits": { + "smithy.api#documentation": "

The code for the continent with which you want to start listing locations that Amazon\n\t\t\tRoute 53 supports for geolocation. If Route 53 has already returned a page or more of\n\t\t\tresults, if IsTruncated is true, and if NextContinentCode from\n\t\t\tthe previous response has a value, enter that value in startcontinentcode\n\t\t\tto return the next page of results.

\n

Include startcontinentcode only if you want to list continents. Don't\n\t\t\tinclude startcontinentcode when you're listing countries or countries with\n\t\t\ttheir subdivisions.

", + "smithy.api#httpQuery": "startcontinentcode" + } + }, + "StartCountryCode": { + "target": "com.amazonaws.route53#GeoLocationCountryCode", + "traits": { + "smithy.api#documentation": "

The code for the country with which you want to start listing locations that Amazon\n\t\t\tRoute 53 supports for geolocation. If Route 53 has already returned a page or more of\n\t\t\tresults, if IsTruncated is true, and if\n\t\t\t\tNextCountryCode from the previous response has a value, enter that\n\t\t\tvalue in startcountrycode to return the next page of results.

", + "smithy.api#httpQuery": "startcountrycode" + } + }, + "StartSubdivisionCode": { + "target": "com.amazonaws.route53#GeoLocationSubdivisionCode", + "traits": { + "smithy.api#documentation": "

The code for the state of the United States with which you want to start listing\n\t\t\tlocations that Amazon Route 53 supports for geolocation. If Route 53 has already\n\t\t\treturned a page or more of results, if IsTruncated is true,\n\t\t\tand if NextSubdivisionCode from the previous response has a value, enter\n\t\t\tthat value in startsubdivisioncode to return the next page of\n\t\t\tresults.

\n

To list subdivisions (U.S. states), you must include both\n\t\t\t\tstartcountrycode and startsubdivisioncode.

", + "smithy.api#httpQuery": "startsubdivisioncode" + } + }, + "MaxItems": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

(Optional) The maximum number of geolocations to be included in the response body for\n\t\t\tthis request. If more than maxitems geolocations remain to be listed, then\n\t\t\tthe value of the IsTruncated element in the response is\n\t\t\ttrue.

", + "smithy.api#httpQuery": "maxitems" + } + } + }, + "traits": { + "smithy.api#documentation": "

A request to get a list of geographic locations that Amazon Route 53 supports for\n\t\t\tgeolocation resource record sets.

" + } + }, + "com.amazonaws.route53#ListGeoLocationsResponse": { + "type": "structure", + "members": { + "GeoLocationDetailsList": { + "target": "com.amazonaws.route53#GeoLocationDetailsList", + "traits": { + "smithy.api#documentation": "

A complex type that contains one GeoLocationDetails element for each\n\t\t\tlocation that Amazon Route 53 supports for geolocation.

", + "smithy.api#required": {} + } + }, + "IsTruncated": { + "target": "com.amazonaws.route53#PageTruncated", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A value that indicates whether more locations remain to be listed after the last\n\t\t\tlocation in this response. If so, the value of IsTruncated is\n\t\t\t\ttrue. To get more values, submit another request and include the values\n\t\t\tof NextContinentCode, NextCountryCode, and\n\t\t\t\tNextSubdivisionCode in the startcontinentcode,\n\t\t\t\tstartcountrycode, and startsubdivisioncode, as\n\t\t\tapplicable.

", + "smithy.api#required": {} + } + }, + "NextContinentCode": { + "target": "com.amazonaws.route53#GeoLocationContinentCode", + "traits": { + "smithy.api#documentation": "

If IsTruncated is true, you can make a follow-up request to\n\t\t\tdisplay more locations. Enter the value of NextContinentCode in the\n\t\t\t\tstartcontinentcode parameter in another ListGeoLocations\n\t\t\trequest.

" + } + }, + "NextCountryCode": { + "target": "com.amazonaws.route53#GeoLocationCountryCode", + "traits": { + "smithy.api#documentation": "

If IsTruncated is true, you can make a follow-up request to\n\t\t\tdisplay more locations. Enter the value of NextCountryCode in the\n\t\t\t\tstartcountrycode parameter in another ListGeoLocations\n\t\t\trequest.

" + } + }, + "NextSubdivisionCode": { + "target": "com.amazonaws.route53#GeoLocationSubdivisionCode", + "traits": { + "smithy.api#documentation": "

If IsTruncated is true, you can make a follow-up request to\n\t\t\tdisplay more locations. Enter the value of NextSubdivisionCode in the\n\t\t\t\tstartsubdivisioncode parameter in another ListGeoLocations\n\t\t\trequest.

" + } + }, + "MaxItems": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The value that you specified for MaxItems in the request.

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

A complex type containing the response information for the request.

" + } + }, + "com.amazonaws.route53#ListHealthChecks": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#ListHealthChecksRequest" + }, + "output": { + "target": "com.amazonaws.route53#ListHealthChecksResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#IncompatibleVersion" + }, + { + "target": "com.amazonaws.route53#InvalidInput" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieve a list of the health checks that are associated with the current Amazon Web Services account.

", + "smithy.api#http": { + "method": "GET", + "uri": "/2013-04-01/healthcheck", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "NextMarker", + "items": "HealthChecks", + "pageSize": "MaxItems" + } + } + }, + "com.amazonaws.route53#ListHealthChecksRequest": { + "type": "structure", + "members": { + "Marker": { + "target": "com.amazonaws.route53#PageMarker", + "traits": { + "smithy.api#documentation": "

If the value of IsTruncated in the previous response was\n\t\t\t\ttrue, you have more health checks. To get another group, submit another\n\t\t\t\tListHealthChecks request.

\n

For the value of marker, specify the value of NextMarker\n\t\t\tfrom the previous response, which is the ID of the first health check that Amazon Route\n\t\t\t53 will return if you submit another request.

\n

If the value of IsTruncated in the previous response was\n\t\t\t\tfalse, there are no more health checks to get.

", + "smithy.api#httpQuery": "marker" + } + }, + "MaxItems": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The maximum number of health checks that you want ListHealthChecks to\n\t\t\treturn in response to the current request. Amazon Route 53 returns a maximum of 100\n\t\t\titems. If you set MaxItems to a value greater than 100, Route 53 returns\n\t\t\tonly the first 100 health checks.

", + "smithy.api#httpQuery": "maxitems" + } + } + }, + "traits": { + "smithy.api#documentation": "

A request to retrieve a list of the health checks that are associated with the current\n\t\t\t\tAmazon Web Services account.

" + } + }, + "com.amazonaws.route53#ListHealthChecksResponse": { + "type": "structure", + "members": { + "HealthChecks": { + "target": "com.amazonaws.route53#HealthChecks", + "traits": { + "smithy.api#documentation": "

A complex type that contains one HealthCheck element for each health\n\t\t\tcheck that is associated with the current Amazon Web Services account.

", + "smithy.api#required": {} + } + }, + "Marker": { + "target": "com.amazonaws.route53#PageMarker", + "traits": { + "smithy.api#documentation": "

For the second and subsequent calls to ListHealthChecks,\n\t\t\t\tMarker is the value that you specified for the marker\n\t\t\tparameter in the previous request.

", + "smithy.api#required": {} + } + }, + "IsTruncated": { + "target": "com.amazonaws.route53#PageTruncated", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A flag that indicates whether there are more health checks to be listed. If the\n\t\t\tresponse was truncated, you can get the next group of health checks by submitting\n\t\t\tanother ListHealthChecks request and specifying the value of\n\t\t\t\tNextMarker in the marker parameter.

", + "smithy.api#required": {} + } + }, + "NextMarker": { + "target": "com.amazonaws.route53#PageMarker", + "traits": { + "smithy.api#documentation": "

If IsTruncated is true, the value of NextMarker\n\t\t\tidentifies the first health check that Amazon Route 53 returns if you submit another\n\t\t\t\tListHealthChecks request and specify the value of\n\t\t\t\tNextMarker in the marker parameter.

" + } + }, + "MaxItems": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The value that you specified for the maxitems parameter in the call to\n\t\t\t\tListHealthChecks that produced the current response.

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

A complex type that contains the response to a ListHealthChecks\n\t\t\trequest.

" + } + }, + "com.amazonaws.route53#ListHostedZones": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#ListHostedZonesRequest" + }, + "output": { + "target": "com.amazonaws.route53#ListHostedZonesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#DelegationSetNotReusable" + }, + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#NoSuchDelegationSet" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves a list of the public and private hosted zones that are associated with the\n\t\t\tcurrent Amazon Web Services account. The response includes a HostedZones\n\t\t\tchild element for each hosted zone.

\n

Amazon Route 53 returns a maximum of 100 items in each response. If you have a lot of\n\t\t\thosted zones, you can use the maxitems parameter to list them in groups of\n\t\t\tup to 100.

", + "smithy.api#http": { + "method": "GET", + "uri": "/2013-04-01/hostedzone", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "NextMarker", + "items": "HostedZones", + "pageSize": "MaxItems" + } + } + }, + "com.amazonaws.route53#ListHostedZonesByName": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#ListHostedZonesByNameRequest" + }, + "output": { + "target": "com.amazonaws.route53#ListHostedZonesByNameResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#InvalidDomainName" + }, + { + "target": "com.amazonaws.route53#InvalidInput" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves a list of your hosted zones in lexicographic order. The response includes a\n\t\t\t\tHostedZones child element for each hosted zone created by the current\n\t\t\t\tAmazon Web Services account.

\n

\n ListHostedZonesByName sorts hosted zones by name with the labels\n\t\t\treversed. For example:

\n

\n com.example.www.\n

\n

Note the trailing dot, which can change the sort order in some circumstances.

\n

If the domain name includes escape characters or Punycode,\n\t\t\t\tListHostedZonesByName alphabetizes the domain name using the escaped or\n\t\t\tPunycoded value, which is the format that Amazon Route 53 saves in its database. For\n\t\t\texample, to create a hosted zone for exämple.com, you specify ex\\344mple.com for\n\t\t\tthe domain name. ListHostedZonesByName alphabetizes it as:

\n

\n com.ex\\344mple.\n

\n

The labels are reversed and alphabetized using the escaped value. For more information\n\t\t\tabout valid domain name formats, including internationalized domain names, see DNS\n\t\t\t\tDomain Name Format in the Amazon Route 53 Developer\n\t\t\t\tGuide.

\n

Route 53 returns up to 100 items in each response. If you have a lot of hosted zones,\n\t\t\tuse the MaxItems parameter to list them in groups of up to 100. The\n\t\t\tresponse includes values that help navigate from one group of MaxItems\n\t\t\thosted zones to the next:

\n ", + "smithy.api#http": { + "method": "GET", + "uri": "/2013-04-01/hostedzonesbyname", + "code": 200 + } + } + }, + "com.amazonaws.route53#ListHostedZonesByNameRequest": { + "type": "structure", + "members": { + "DNSName": { + "target": "com.amazonaws.route53#DNSName", + "traits": { + "smithy.api#documentation": "

(Optional) For your first request to ListHostedZonesByName, include the\n\t\t\t\tdnsname parameter only if you want to specify the name of the first\n\t\t\thosted zone in the response. If you don't include the dnsname parameter,\n\t\t\tAmazon Route 53 returns all of the hosted zones that were created by the current Amazon Web Services account, in ASCII order. For subsequent requests, include both\n\t\t\t\tdnsname and hostedzoneid parameters. For\n\t\t\t\tdnsname, specify the value of NextDNSName from the\n\t\t\tprevious response.

", + "smithy.api#httpQuery": "dnsname" + } + }, + "HostedZoneId": { + "target": "com.amazonaws.route53#ResourceId", + "traits": { + "smithy.api#documentation": "

(Optional) For your first request to ListHostedZonesByName, do not\n\t\t\tinclude the hostedzoneid parameter.

\n

If you have more hosted zones than the value of maxitems,\n\t\t\t\tListHostedZonesByName returns only the first maxitems\n\t\t\thosted zones. To get the next group of maxitems hosted zones, submit\n\t\t\tanother request to ListHostedZonesByName and include both\n\t\t\t\tdnsname and hostedzoneid parameters. For the value of\n\t\t\t\thostedzoneid, specify the value of the NextHostedZoneId\n\t\t\telement from the previous response.

", + "smithy.api#httpQuery": "hostedzoneid" + } + }, + "MaxItems": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The maximum number of hosted zones to be included in the response body for this\n\t\t\trequest. If you have more than maxitems hosted zones, then the value of the\n\t\t\t\tIsTruncated element in the response is true, and the values of\n\t\t\t\tNextDNSName and NextHostedZoneId specify the first hosted\n\t\t\tzone in the next group of maxitems hosted zones.

", + "smithy.api#httpQuery": "maxitems" + } + } + }, + "traits": { + "smithy.api#documentation": "

Retrieves a list of the public and private hosted zones that are associated with the\n\t\t\tcurrent Amazon Web Services account in ASCII order by domain name.

" + } + }, + "com.amazonaws.route53#ListHostedZonesByNameResponse": { + "type": "structure", + "members": { + "HostedZones": { + "target": "com.amazonaws.route53#HostedZones", + "traits": { + "smithy.api#documentation": "

A complex type that contains general information about the hosted zone.

", + "smithy.api#required": {} + } + }, + "DNSName": { + "target": "com.amazonaws.route53#DNSName", + "traits": { + "smithy.api#documentation": "

For the second and subsequent calls to ListHostedZonesByName,\n\t\t\t\tDNSName is the value that you specified for the dnsname\n\t\t\tparameter in the request that produced the current response.

" + } + }, + "HostedZoneId": { + "target": "com.amazonaws.route53#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID that Amazon Route 53 assigned to the hosted zone when you created it.

" + } + }, + "IsTruncated": { + "target": "com.amazonaws.route53#PageTruncated", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A flag that indicates whether there are more hosted zones to be listed. If the\n\t\t\tresponse was truncated, you can get the next group of maxitems hosted zones\n\t\t\tby calling ListHostedZonesByName again and specifying the values of\n\t\t\t\tNextDNSName and NextHostedZoneId elements in the\n\t\t\t\tdnsname and hostedzoneid parameters.

", + "smithy.api#required": {} + } + }, + "NextDNSName": { + "target": "com.amazonaws.route53#DNSName", + "traits": { + "smithy.api#documentation": "

If IsTruncated is true, the value of NextDNSName is the name\n\t\t\tof the first hosted zone in the next group of maxitems hosted zones. Call\n\t\t\t\tListHostedZonesByName again and specify the value of\n\t\t\t\tNextDNSName and NextHostedZoneId in the\n\t\t\t\tdnsname and hostedzoneid parameters, respectively.

\n

This element is present only if IsTruncated is true.

" + } + }, + "NextHostedZoneId": { + "target": "com.amazonaws.route53#ResourceId", + "traits": { + "smithy.api#documentation": "

If IsTruncated is true, the value of\n\t\t\t\tNextHostedZoneId identifies the first hosted zone in the next group of\n\t\t\t\tmaxitems hosted zones. Call ListHostedZonesByName again\n\t\t\tand specify the value of NextDNSName and NextHostedZoneId in\n\t\t\tthe dnsname and hostedzoneid parameters, respectively.

\n

This element is present only if IsTruncated is true.

" + } + }, + "MaxItems": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The value that you specified for the maxitems parameter in the call to\n\t\t\t\tListHostedZonesByName that produced the current response.

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

A complex type that contains the response information for the request.

" + } + }, + "com.amazonaws.route53#ListHostedZonesByVPC": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#ListHostedZonesByVPCRequest" + }, + "output": { + "target": "com.amazonaws.route53#ListHostedZonesByVPCResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#InvalidPaginationToken" + } + ], + "traits": { + "smithy.api#documentation": "

Lists all the private hosted zones that a specified VPC is associated with, regardless\n\t\t\tof which Amazon Web Services account or Amazon Web Services service owns the hosted zones.\n\t\t\tThe HostedZoneOwner structure in the response contains one of the following\n\t\t\tvalues:

\n \n \n

When listing private hosted zones, the hosted zone and the Amazon VPC must\n\t\t\t\tbelong to the same partition where the hosted zones were created. A partition is a\n\t\t\t\tgroup of Amazon Web Services Regions. Each Amazon Web Services account is scoped to\n\t\t\t\tone partition.

\n

The following are the supported partitions:

\n \n

For more information, see Access Management\n\t\t\t\tin the Amazon Web Services General Reference.

\n ", + "smithy.api#http": { + "method": "GET", + "uri": "/2013-04-01/hostedzonesbyvpc", + "code": 200 + } + } + }, + "com.amazonaws.route53#ListHostedZonesByVPCRequest": { + "type": "structure", + "members": { + "VPCId": { + "target": "com.amazonaws.route53#VPCId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon VPC that you want to list hosted zones for.

", + "smithy.api#httpQuery": "vpcid", + "smithy.api#required": {} + } + }, + "VPCRegion": { + "target": "com.amazonaws.route53#VPCRegion", + "traits": { + "smithy.api#documentation": "

For the Amazon VPC that you specified for VPCId, the Amazon Web Services\n\t\t\tRegion that you created the VPC in.

", + "smithy.api#httpQuery": "vpcregion", + "smithy.api#required": {} + } + }, + "MaxItems": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

(Optional) The maximum number of hosted zones that you want Amazon Route 53 to return.\n\t\t\tIf the specified VPC is associated with more than MaxItems hosted zones,\n\t\t\tthe response includes a NextToken element. NextToken contains\n\t\t\tan encrypted token that identifies the first hosted zone that Route 53 will return if\n\t\t\tyou submit another request.

", + "smithy.api#httpQuery": "maxitems" + } + }, + "NextToken": { + "target": "com.amazonaws.route53#PaginationToken", + "traits": { + "smithy.api#documentation": "

If the previous response included a NextToken element, the specified VPC\n\t\t\tis associated with more hosted zones. To get more hosted zones, submit another\n\t\t\t\tListHostedZonesByVPC request.

\n

For the value of NextToken, specify the value of NextToken\n\t\t\tfrom the previous response.

\n

If the previous response didn't include a NextToken element, there are no\n\t\t\tmore hosted zones to get.

", + "smithy.api#httpQuery": "nexttoken" + } + } + }, + "traits": { + "smithy.api#documentation": "

Lists all the private hosted zones that a specified VPC is associated with, regardless\n\t\t\tof which Amazon Web Services account created the hosted zones.

" + } + }, + "com.amazonaws.route53#ListHostedZonesByVPCResponse": { + "type": "structure", + "members": { + "HostedZoneSummaries": { + "target": "com.amazonaws.route53#HostedZoneSummaries", + "traits": { + "smithy.api#documentation": "

A list that contains one HostedZoneSummary element for each hosted zone\n\t\t\tthat the specified Amazon VPC is associated with. Each HostedZoneSummary\n\t\t\telement contains the hosted zone name and ID, and information about who owns the hosted\n\t\t\tzone.

", + "smithy.api#required": {} + } + }, + "MaxItems": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The value that you specified for MaxItems in the most recent\n\t\t\t\tListHostedZonesByVPC request.

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.route53#PaginationToken", + "traits": { + "smithy.api#documentation": "

The value that you will use for NextToken in the next\n\t\t\t\tListHostedZonesByVPC request.

" + } + } + } + }, + "com.amazonaws.route53#ListHostedZonesRequest": { + "type": "structure", + "members": { + "Marker": { + "target": "com.amazonaws.route53#PageMarker", + "traits": { + "smithy.api#documentation": "

If the value of IsTruncated in the previous response was\n\t\t\t\ttrue, you have more hosted zones. To get more hosted zones, submit\n\t\t\tanother ListHostedZones request.

\n

For the value of marker, specify the value of NextMarker\n\t\t\tfrom the previous response, which is the ID of the first hosted zone that Amazon Route\n\t\t\t53 will return if you submit another request.

\n

If the value of IsTruncated in the previous response was\n\t\t\t\tfalse, there are no more hosted zones to get.

", + "smithy.api#httpQuery": "marker" + } + }, + "MaxItems": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

(Optional) The maximum number of hosted zones that you want Amazon Route 53 to return.\n\t\t\tIf you have more than maxitems hosted zones, the value of\n\t\t\t\tIsTruncated in the response is true, and the value of\n\t\t\t\tNextMarker is the hosted zone ID of the first hosted zone that Route 53\n\t\t\twill return if you submit another request.

", + "smithy.api#httpQuery": "maxitems" + } + }, + "DelegationSetId": { + "target": "com.amazonaws.route53#ResourceId", + "traits": { + "smithy.api#documentation": "

If you're using reusable delegation sets and you want to list all of the hosted zones\n\t\t\tthat are associated with a reusable delegation set, specify the ID of that reusable\n\t\t\tdelegation set.

", + "smithy.api#httpQuery": "delegationsetid" + } + } + }, + "traits": { + "smithy.api#documentation": "

A request to retrieve a list of the public and private hosted zones that are\n\t\t\tassociated with the current Amazon Web Services account.

" + } + }, + "com.amazonaws.route53#ListHostedZonesResponse": { + "type": "structure", + "members": { + "HostedZones": { + "target": "com.amazonaws.route53#HostedZones", + "traits": { + "smithy.api#documentation": "

A complex type that contains general information about the hosted zone.

", + "smithy.api#required": {} + } + }, + "Marker": { + "target": "com.amazonaws.route53#PageMarker", + "traits": { + "smithy.api#documentation": "

For the second and subsequent calls to ListHostedZones,\n\t\t\t\tMarker is the value that you specified for the marker\n\t\t\tparameter in the request that produced the current response.

", + "smithy.api#required": {} + } + }, + "IsTruncated": { + "target": "com.amazonaws.route53#PageTruncated", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A flag indicating whether there are more hosted zones to be listed. If the response\n\t\t\twas truncated, you can get more hosted zones by submitting another\n\t\t\t\tListHostedZones request and specifying the value of\n\t\t\t\tNextMarker in the marker parameter.

", + "smithy.api#required": {} + } + }, + "NextMarker": { + "target": "com.amazonaws.route53#PageMarker", + "traits": { + "smithy.api#documentation": "

If IsTruncated is true, the value of NextMarker\n\t\t\tidentifies the first hosted zone in the next group of hosted zones. Submit another\n\t\t\t\tListHostedZones request, and specify the value of\n\t\t\t\tNextMarker from the response in the marker\n\t\t\tparameter.

\n

This element is present only if IsTruncated is true.

" + } + }, + "MaxItems": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The value that you specified for the maxitems parameter in the call to\n\t\t\t\tListHostedZones that produced the current response.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.route53#ListQueryLoggingConfigs": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#ListQueryLoggingConfigsRequest" + }, + "output": { + "target": "com.amazonaws.route53#ListQueryLoggingConfigsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#InvalidPaginationToken" + }, + { + "target": "com.amazonaws.route53#NoSuchHostedZone" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the configurations for DNS query logging that are associated with the current\n\t\t\t\tAmazon Web Services account or the configuration that is associated with a specified\n\t\t\thosted zone.

\n

For more information about DNS query logs, see CreateQueryLoggingConfig. Additional information, including the format of\n\t\t\tDNS query logs, appears in Logging DNS Queries in\n\t\t\tthe Amazon Route 53 Developer Guide.

", + "smithy.api#http": { + "method": "GET", + "uri": "/2013-04-01/queryloggingconfig", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "QueryLoggingConfigs", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.route53#ListQueryLoggingConfigsRequest": { + "type": "structure", + "members": { + "HostedZoneId": { + "target": "com.amazonaws.route53#ResourceId", + "traits": { + "smithy.api#documentation": "

(Optional) If you want to list the query logging configuration that is associated with\n\t\t\ta hosted zone, specify the ID in HostedZoneId.

\n

If you don't specify a hosted zone ID, ListQueryLoggingConfigs returns\n\t\t\tall of the configurations that are associated with the current Amazon Web Services account.

", + "smithy.api#httpQuery": "hostedzoneid" + } + }, + "NextToken": { + "target": "com.amazonaws.route53#PaginationToken", + "traits": { + "smithy.api#documentation": "

(Optional) If the current Amazon Web Services account has more than\n\t\t\t\tMaxResults query logging configurations, use NextToken to\n\t\t\tget the second and subsequent pages of results.

\n

For the first ListQueryLoggingConfigs request, omit this value.

\n

For the second and subsequent requests, get the value of NextToken from\n\t\t\tthe previous response and specify that value for NextToken in the\n\t\t\trequest.

", + "smithy.api#httpQuery": "nexttoken" + } + }, + "MaxResults": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

(Optional) The maximum number of query logging configurations that you want Amazon\n\t\t\tRoute 53 to return in response to the current request. If the current Amazon Web Services account has more than MaxResults configurations, use the\n\t\t\tvalue of NextToken in the response to get the next page of results.

\n

If you don't specify a value for MaxResults, Route 53 returns up to 100\n\t\t\tconfigurations.

", + "smithy.api#httpQuery": "maxresults" + } + } + } + }, + "com.amazonaws.route53#ListQueryLoggingConfigsResponse": { + "type": "structure", + "members": { + "QueryLoggingConfigs": { + "target": "com.amazonaws.route53#QueryLoggingConfigs", + "traits": { + "smithy.api#documentation": "

An array that contains one QueryLoggingConfig element for each configuration for DNS query logging\n\t\t\tthat is associated with the current Amazon Web Services account.

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.route53#PaginationToken", + "traits": { + "smithy.api#documentation": "

If a response includes the last of the query logging configurations that are\n\t\t\tassociated with the current Amazon Web Services account, NextToken doesn't\n\t\t\tappear in the response.

\n

If a response doesn't include the last of the configurations, you can get more\n\t\t\tconfigurations by submitting another ListQueryLoggingConfigs request. Get the value of NextToken\n\t\t\tthat Amazon Route 53 returned in the previous response and include it in\n\t\t\t\tNextToken in the next request.

" + } + } + } + }, + "com.amazonaws.route53#ListResourceRecordSets": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#ListResourceRecordSetsRequest" + }, + "output": { + "target": "com.amazonaws.route53#ListResourceRecordSetsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#NoSuchHostedZone" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the resource record sets in a specified hosted zone.

\n

\n ListResourceRecordSets returns up to 300 resource record sets at a time\n\t\t\tin ASCII order, beginning at a position specified by the name and\n\t\t\t\ttype elements.

\n

\n Sort order\n

\n

\n ListResourceRecordSets sorts results first by DNS name with the labels\n\t\t\treversed, for example:

\n

\n com.example.www.\n

\n

Note the trailing dot, which can change the sort order when the record name contains\n\t\t\tcharacters that appear before . (decimal 46) in the ASCII table. These\n\t\t\tcharacters include the following: ! \" # $ % & ' ( ) * + , -\n

\n

When multiple records have the same DNS name, ListResourceRecordSets\n\t\t\tsorts results by the record type.

\n

\n Specifying where to start listing records\n

\n

You can use the name and type elements to specify the resource record set that the\n\t\t\tlist begins with:

\n
\n
If you do not specify Name or Type
\n
\n

The results begin with the first resource record set that the hosted zone\n\t\t\t\t\t\tcontains.

\n
\n
If you specify Name but not Type
\n
\n

The results begin with the first resource record set in the list whose\n\t\t\t\t\t\tname is greater than or equal to Name.

\n
\n
If you specify Type but not Name
\n
\n

Amazon Route 53 returns the InvalidInput error.

\n
\n
If you specify both Name and Type
\n
\n

The results begin with the first resource record set in the list whose\n\t\t\t\t\t\tname is greater than or equal to Name, and whose type is\n\t\t\t\t\t\tgreater than or equal to Type.

\n
\n
\n

\n Resource record sets that are PENDING\n

\n

This action returns the most current version of the records. This includes records\n\t\t\tthat are PENDING, and that are not yet available on all Route 53 DNS\n\t\t\tservers.

\n

\n Changing resource record sets\n

\n

To ensure that you get an accurate listing of the resource record sets for a hosted\n\t\t\tzone at a point in time, do not submit a ChangeResourceRecordSets request\n\t\t\twhile you're paging through the results of a ListResourceRecordSets\n\t\t\trequest. If you do, some pages may display results without the latest changes while\n\t\t\tother pages display results with the latest changes.

\n

\n Displaying the next page of results\n

\n

If a ListResourceRecordSets command returns more than one page of\n\t\t\tresults, the value of IsTruncated is true. To display the next\n\t\t\tpage of results, get the values of NextRecordName,\n\t\t\t\tNextRecordType, and NextRecordIdentifier (if any) from the\n\t\t\tresponse. Then submit another ListResourceRecordSets request, and specify\n\t\t\tthose values for StartRecordName, StartRecordType, and\n\t\t\t\tStartRecordIdentifier.

", + "smithy.api#http": { + "method": "GET", + "uri": "/2013-04-01/hostedzone/{HostedZoneId}/rrset", + "code": 200 + } + } + }, + "com.amazonaws.route53#ListResourceRecordSetsRequest": { + "type": "structure", + "members": { + "HostedZoneId": { + "target": "com.amazonaws.route53#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the hosted zone that contains the resource record sets that you want to\n\t\t\tlist.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "StartRecordName": { + "target": "com.amazonaws.route53#DNSName", + "traits": { + "smithy.api#documentation": "

The first name in the lexicographic ordering of resource record sets that you want to\n\t\t\tlist. If the specified record name doesn't exist, the results begin with the first\n\t\t\tresource record set that has a name greater than the value of name.

", + "smithy.api#httpQuery": "name" + } + }, + "StartRecordType": { + "target": "com.amazonaws.route53#RRType", + "traits": { + "smithy.api#documentation": "

The type of resource record set to begin the record listing from.

\n

Valid values for basic resource record sets: A | AAAA |\n\t\t\t\tCAA | CNAME | MX | NAPTR |\n\t\t\t\tNS | PTR | SOA | SPF |\n\t\t\t\tSRV | TXT\n

\n

Values for weighted, latency, geolocation, and failover resource record sets:\n\t\t\t\tA | AAAA | CAA | CNAME |\n\t\t\t\tMX | NAPTR | PTR | SPF |\n\t\t\t\tSRV | TXT\n

\n

Values for alias resource record sets:

\n \n

Constraint: Specifying type without specifying name returns\n\t\t\tan InvalidInput error.

", + "smithy.api#httpQuery": "type" + } + }, + "StartRecordIdentifier": { + "target": "com.amazonaws.route53#ResourceRecordSetIdentifier", + "traits": { + "smithy.api#documentation": "

\n Resource record sets that have a routing policy other than\n\t\t\t\tsimple: If results were truncated for a given DNS name and type, specify\n\t\t\tthe value of NextRecordIdentifier from the previous response to get the\n\t\t\tnext resource record set that has the current DNS name and type.

", + "smithy.api#httpQuery": "identifier" + } + }, + "MaxItems": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

(Optional) The maximum number of resource records sets to include in the response body\n\t\t\tfor this request. If the response includes more than maxitems resource\n\t\t\trecord sets, the value of the IsTruncated element in the response is\n\t\t\t\ttrue, and the values of the NextRecordName and\n\t\t\t\tNextRecordType elements in the response identify the first resource\n\t\t\trecord set in the next group of maxitems resource record sets.

", + "smithy.api#httpQuery": "maxitems" + } + } + }, + "traits": { + "smithy.api#documentation": "

A request for the resource record sets that are associated with a specified hosted\n\t\t\tzone.

" + } + }, + "com.amazonaws.route53#ListResourceRecordSetsResponse": { + "type": "structure", + "members": { + "ResourceRecordSets": { + "target": "com.amazonaws.route53#ResourceRecordSets", + "traits": { + "smithy.api#documentation": "

Information about multiple resource record sets.

", + "smithy.api#required": {} + } + }, + "IsTruncated": { + "target": "com.amazonaws.route53#PageTruncated", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A flag that indicates whether more resource record sets remain to be listed. If your\n\t\t\tresults were truncated, you can make a follow-up pagination request by using the\n\t\t\t\tNextRecordName element.

", + "smithy.api#required": {} + } + }, + "NextRecordName": { + "target": "com.amazonaws.route53#DNSName", + "traits": { + "smithy.api#documentation": "

If the results were truncated, the name of the next record in the list.

\n

This element is present only if IsTruncated is true.

" + } + }, + "NextRecordType": { + "target": "com.amazonaws.route53#RRType", + "traits": { + "smithy.api#documentation": "

If the results were truncated, the type of the next record in the list.

\n

This element is present only if IsTruncated is true.

" + } + }, + "NextRecordIdentifier": { + "target": "com.amazonaws.route53#ResourceRecordSetIdentifier", + "traits": { + "smithy.api#documentation": "

\n Resource record sets that have a routing policy other than\n\t\t\t\tsimple: If results were truncated for a given DNS name and type, the\n\t\t\tvalue of SetIdentifier for the next resource record set that has the\n\t\t\tcurrent DNS name and type.

\n

For information about routing policies, see Choosing a Routing\n\t\t\t\tPolicy in the Amazon Route 53 Developer Guide.

" + } + }, + "MaxItems": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The maximum number of records you requested.

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

A complex type that contains list information for the resource record set.

" + } + }, + "com.amazonaws.route53#ListReusableDelegationSets": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#ListReusableDelegationSetsRequest" + }, + "output": { + "target": "com.amazonaws.route53#ListReusableDelegationSetsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#InvalidInput" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves a list of the reusable delegation sets that are associated with the current\n\t\t\t\tAmazon Web Services account.

", + "smithy.api#http": { + "method": "GET", + "uri": "/2013-04-01/delegationset", + "code": 200 + } + } + }, + "com.amazonaws.route53#ListReusableDelegationSetsRequest": { + "type": "structure", + "members": { + "Marker": { + "target": "com.amazonaws.route53#PageMarker", + "traits": { + "smithy.api#documentation": "

If the value of IsTruncated in the previous response was\n\t\t\t\ttrue, you have more reusable delegation sets. To get another group,\n\t\t\tsubmit another ListReusableDelegationSets request.

\n

For the value of marker, specify the value of NextMarker\n\t\t\tfrom the previous response, which is the ID of the first reusable delegation set that\n\t\t\tAmazon Route 53 will return if you submit another request.

\n

If the value of IsTruncated in the previous response was\n\t\t\t\tfalse, there are no more reusable delegation sets to get.

", + "smithy.api#httpQuery": "marker" + } + }, + "MaxItems": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The number of reusable delegation sets that you want Amazon Route 53 to return in the\n\t\t\tresponse to this request. If you specify a value greater than 100, Route 53 returns only\n\t\t\tthe first 100 reusable delegation sets.

", + "smithy.api#httpQuery": "maxitems" + } + } + }, + "traits": { + "smithy.api#documentation": "

A request to get a list of the reusable delegation sets that are associated with the\n\t\t\tcurrent Amazon Web Services account.

" + } + }, + "com.amazonaws.route53#ListReusableDelegationSetsResponse": { + "type": "structure", + "members": { + "DelegationSets": { + "target": "com.amazonaws.route53#DelegationSets", + "traits": { + "smithy.api#documentation": "

A complex type that contains one DelegationSet element for each reusable\n\t\t\tdelegation set that was created by the current Amazon Web Services account.

", + "smithy.api#required": {} + } + }, + "Marker": { + "target": "com.amazonaws.route53#PageMarker", + "traits": { + "smithy.api#documentation": "

For the second and subsequent calls to ListReusableDelegationSets,\n\t\t\t\tMarker is the value that you specified for the marker\n\t\t\tparameter in the request that produced the current response.

", + "smithy.api#required": {} + } + }, + "IsTruncated": { + "target": "com.amazonaws.route53#PageTruncated", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A flag that indicates whether there are more reusable delegation sets to be\n\t\t\tlisted.

", + "smithy.api#required": {} + } + }, + "NextMarker": { + "target": "com.amazonaws.route53#PageMarker", + "traits": { + "smithy.api#documentation": "

If IsTruncated is true, the value of NextMarker\n\t\t\tidentifies the next reusable delegation set that Amazon Route 53 will return if you\n\t\t\tsubmit another ListReusableDelegationSets request and specify the value of\n\t\t\t\tNextMarker in the marker parameter.

" + } + }, + "MaxItems": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The value that you specified for the maxitems parameter in the call to\n\t\t\t\tListReusableDelegationSets that produced the current response.

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

A complex type that contains information about the reusable delegation sets that are\n\t\t\tassociated with the current Amazon Web Services account.

" + } + }, + "com.amazonaws.route53#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#ListTagsForResourceRequest" + }, + "output": { + "target": "com.amazonaws.route53#ListTagsForResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#NoSuchHealthCheck" + }, + { + "target": "com.amazonaws.route53#NoSuchHostedZone" + }, + { + "target": "com.amazonaws.route53#PriorRequestNotComplete" + }, + { + "target": "com.amazonaws.route53#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists tags for one health check or hosted zone.

\n

For information about using tags for cost allocation, see Using Cost Allocation\n\t\t\t\tTags in the Billing and Cost Management User Guide.

", + "smithy.api#http": { + "method": "GET", + "uri": "/2013-04-01/tags/{ResourceType}/{ResourceId}", + "code": 200 + } + } + }, + "com.amazonaws.route53#ListTagsForResourceRequest": { + "type": "structure", + "members": { + "ResourceType": { + "target": "com.amazonaws.route53#TagResourceType", + "traits": { + "smithy.api#documentation": "

The type of the resource.

\n ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ResourceId": { + "target": "com.amazonaws.route53#TagResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the resource for which you want to retrieve tags.

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

A complex type containing information about a request for a list of the tags that are\n\t\t\tassociated with an individual resource.

" + } + }, + "com.amazonaws.route53#ListTagsForResourceResponse": { + "type": "structure", + "members": { + "ResourceTagSet": { + "target": "com.amazonaws.route53#ResourceTagSet", + "traits": { + "smithy.api#documentation": "

A ResourceTagSet containing tags associated with the specified\n\t\t\tresource.

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

A complex type that contains information about the health checks or hosted zones for\n\t\t\twhich you want to list tags.

" + } + }, + "com.amazonaws.route53#ListTagsForResources": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#ListTagsForResourcesRequest" + }, + "output": { + "target": "com.amazonaws.route53#ListTagsForResourcesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#NoSuchHealthCheck" + }, + { + "target": "com.amazonaws.route53#NoSuchHostedZone" + }, + { + "target": "com.amazonaws.route53#PriorRequestNotComplete" + }, + { + "target": "com.amazonaws.route53#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists tags for up to 10 health checks or hosted zones.

\n

For information about using tags for cost allocation, see Using Cost Allocation\n\t\t\t\tTags in the Billing and Cost Management User Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/2013-04-01/tags/{ResourceType}", + "code": 200 + } + } + }, + "com.amazonaws.route53#ListTagsForResourcesRequest": { + "type": "structure", + "members": { + "ResourceType": { + "target": "com.amazonaws.route53#TagResourceType", + "traits": { + "smithy.api#documentation": "

The type of the resources.

\n ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ResourceIds": { + "target": "com.amazonaws.route53#TagResourceIdList", + "traits": { + "smithy.api#documentation": "

A complex type that contains the ResourceId element for each resource for which you\n\t\t\twant to get a list of tags.

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

A complex type that contains information about the health checks or hosted zones for\n\t\t\twhich you want to list tags.

" + } + }, + "com.amazonaws.route53#ListTagsForResourcesResponse": { + "type": "structure", + "members": { + "ResourceTagSets": { + "target": "com.amazonaws.route53#ResourceTagSetList", + "traits": { + "smithy.api#documentation": "

A list of ResourceTagSets containing tags associated with the specified\n\t\t\tresources.

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

A complex type containing tags for the specified resources.

" + } + }, + "com.amazonaws.route53#ListTrafficPolicies": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#ListTrafficPoliciesRequest" + }, + "output": { + "target": "com.amazonaws.route53#ListTrafficPoliciesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#InvalidInput" + } + ], + "traits": { + "smithy.api#documentation": "

Gets information about the latest version for every traffic policy that is associated\n\t\t\twith the current Amazon Web Services account. Policies are listed in the order that they\n\t\t\twere created in.

\n

For information about how of deleting a traffic policy affects the response from\n\t\t\t\tListTrafficPolicies, see DeleteTrafficPolicy.

", + "smithy.api#http": { + "method": "GET", + "uri": "/2013-04-01/trafficpolicies", + "code": 200 + } + } + }, + "com.amazonaws.route53#ListTrafficPoliciesRequest": { + "type": "structure", + "members": { + "TrafficPolicyIdMarker": { + "target": "com.amazonaws.route53#TrafficPolicyId", + "traits": { + "smithy.api#documentation": "

(Conditional) For your first request to ListTrafficPolicies, don't\n\t\t\tinclude the TrafficPolicyIdMarker parameter.

\n

If you have more traffic policies than the value of MaxItems,\n\t\t\t\tListTrafficPolicies returns only the first MaxItems\n\t\t\ttraffic policies. To get the next group of policies, submit another request to\n\t\t\t\tListTrafficPolicies. For the value of\n\t\t\t\tTrafficPolicyIdMarker, specify the value of\n\t\t\t\tTrafficPolicyIdMarker that was returned in the previous\n\t\t\tresponse.

", + "smithy.api#httpQuery": "trafficpolicyid" + } + }, + "MaxItems": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

(Optional) The maximum number of traffic policies that you want Amazon Route 53 to\n\t\t\treturn in response to this request. If you have more than MaxItems traffic\n\t\t\tpolicies, the value of IsTruncated in the response is true,\n\t\t\tand the value of TrafficPolicyIdMarker is the ID of the first traffic\n\t\t\tpolicy that Route 53 will return if you submit another request.

", + "smithy.api#httpQuery": "maxitems" + } + } + }, + "traits": { + "smithy.api#documentation": "

A complex type that contains the information about the request to list the traffic\n\t\t\tpolicies that are associated with the current Amazon Web Services account.

" + } + }, + "com.amazonaws.route53#ListTrafficPoliciesResponse": { + "type": "structure", + "members": { + "TrafficPolicySummaries": { + "target": "com.amazonaws.route53#TrafficPolicySummaries", + "traits": { + "smithy.api#documentation": "

A list that contains one TrafficPolicySummary element for each traffic\n\t\t\tpolicy that was created by the current Amazon Web Services account.

", + "smithy.api#required": {} + } + }, + "IsTruncated": { + "target": "com.amazonaws.route53#PageTruncated", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A flag that indicates whether there are more traffic policies to be listed. If the\n\t\t\tresponse was truncated, you can get the next group of traffic policies by submitting\n\t\t\tanother ListTrafficPolicies request and specifying the value of\n\t\t\t\tTrafficPolicyIdMarker in the TrafficPolicyIdMarker request\n\t\t\tparameter.

", + "smithy.api#required": {} + } + }, + "TrafficPolicyIdMarker": { + "target": "com.amazonaws.route53#TrafficPolicyId", + "traits": { + "smithy.api#documentation": "

If the value of IsTruncated is true,\n\t\t\t\tTrafficPolicyIdMarker is the ID of the first traffic policy in the next\n\t\t\tgroup of MaxItems traffic policies.

", + "smithy.api#required": {} + } + }, + "MaxItems": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The value that you specified for the MaxItems parameter in the\n\t\t\t\tListTrafficPolicies request that produced the current response.

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

A complex type that contains the response information for the request.

" + } + }, + "com.amazonaws.route53#ListTrafficPolicyInstances": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#ListTrafficPolicyInstancesRequest" + }, + "output": { + "target": "com.amazonaws.route53#ListTrafficPolicyInstancesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#NoSuchTrafficPolicyInstance" + } + ], + "traits": { + "smithy.api#documentation": "

Gets information about the traffic policy instances that you created by using the\n\t\t\tcurrent Amazon Web Services account.

\n \n

After you submit an UpdateTrafficPolicyInstance request, there's a\n\t\t\t\tbrief delay while Amazon Route 53 creates the resource record sets that are\n\t\t\t\tspecified in the traffic policy definition. For more information, see the\n\t\t\t\t\tState response element.

\n \n

Route 53 returns a maximum of 100 items in each response. If you have a lot of traffic\n\t\t\tpolicy instances, you can use the MaxItems parameter to list them in groups\n\t\t\tof up to 100.

", + "smithy.api#http": { + "method": "GET", + "uri": "/2013-04-01/trafficpolicyinstances", + "code": 200 + } + } + }, + "com.amazonaws.route53#ListTrafficPolicyInstancesByHostedZone": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#ListTrafficPolicyInstancesByHostedZoneRequest" + }, + "output": { + "target": "com.amazonaws.route53#ListTrafficPolicyInstancesByHostedZoneResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#NoSuchHostedZone" + }, + { + "target": "com.amazonaws.route53#NoSuchTrafficPolicyInstance" + } + ], + "traits": { + "smithy.api#documentation": "

Gets information about the traffic policy instances that you created in a specified\n\t\t\thosted zone.

\n \n

After you submit a CreateTrafficPolicyInstance or an\n\t\t\t\t\tUpdateTrafficPolicyInstance request, there's a brief delay while\n\t\t\t\tAmazon Route 53 creates the resource record sets that are specified in the traffic\n\t\t\t\tpolicy definition. For more information, see the State response\n\t\t\t\telement.

\n \n

Route 53 returns a maximum of 100 items in each response. If you have a lot of traffic\n\t\t\tpolicy instances, you can use the MaxItems parameter to list them in groups\n\t\t\tof up to 100.

", + "smithy.api#http": { + "method": "GET", + "uri": "/2013-04-01/trafficpolicyinstances/hostedzone", + "code": 200 + } + } + }, + "com.amazonaws.route53#ListTrafficPolicyInstancesByHostedZoneRequest": { + "type": "structure", + "members": { + "HostedZoneId": { + "target": "com.amazonaws.route53#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the hosted zone that you want to list traffic policy instances for.

", + "smithy.api#httpQuery": "id", + "smithy.api#required": {} + } + }, + "TrafficPolicyInstanceNameMarker": { + "target": "com.amazonaws.route53#DNSName", + "traits": { + "smithy.api#documentation": "

If the value of IsTruncated in the previous response is true, you have\n\t\t\tmore traffic policy instances. To get more traffic policy instances, submit another\n\t\t\t\tListTrafficPolicyInstances request. For the value of\n\t\t\t\ttrafficpolicyinstancename, specify the value of\n\t\t\t\tTrafficPolicyInstanceNameMarker from the previous response, which is\n\t\t\tthe name of the first traffic policy instance in the next group of traffic policy\n\t\t\tinstances.

\n

If the value of IsTruncated in the previous response was\n\t\t\t\tfalse, there are no more traffic policy instances to get.

", + "smithy.api#httpQuery": "trafficpolicyinstancename" + } + }, + "TrafficPolicyInstanceTypeMarker": { + "target": "com.amazonaws.route53#RRType", + "traits": { + "smithy.api#documentation": "

If the value of IsTruncated in the previous response is true, you have\n\t\t\tmore traffic policy instances. To get more traffic policy instances, submit another\n\t\t\t\tListTrafficPolicyInstances request. For the value of\n\t\t\t\ttrafficpolicyinstancetype, specify the value of\n\t\t\t\tTrafficPolicyInstanceTypeMarker from the previous response, which is\n\t\t\tthe type of the first traffic policy instance in the next group of traffic policy\n\t\t\tinstances.

\n

If the value of IsTruncated in the previous response was\n\t\t\t\tfalse, there are no more traffic policy instances to get.

", + "smithy.api#httpQuery": "trafficpolicyinstancetype" + } + }, + "MaxItems": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The maximum number of traffic policy instances to be included in the response body for\n\t\t\tthis request. If you have more than MaxItems traffic policy instances, the\n\t\t\tvalue of the IsTruncated element in the response is true, and\n\t\t\tthe values of HostedZoneIdMarker,\n\t\t\t\tTrafficPolicyInstanceNameMarker, and\n\t\t\t\tTrafficPolicyInstanceTypeMarker represent the first traffic policy\n\t\t\tinstance that Amazon Route 53 will return if you submit another request.

", + "smithy.api#httpQuery": "maxitems" + } + } + }, + "traits": { + "smithy.api#documentation": "

A request for the traffic policy instances that you created in a specified hosted\n\t\t\tzone.

" + } + }, + "com.amazonaws.route53#ListTrafficPolicyInstancesByHostedZoneResponse": { + "type": "structure", + "members": { + "TrafficPolicyInstances": { + "target": "com.amazonaws.route53#TrafficPolicyInstances", + "traits": { + "smithy.api#documentation": "

A list that contains one TrafficPolicyInstance element for each traffic\n\t\t\tpolicy instance that matches the elements in the request.

", + "smithy.api#required": {} + } + }, + "TrafficPolicyInstanceNameMarker": { + "target": "com.amazonaws.route53#DNSName", + "traits": { + "smithy.api#documentation": "

If IsTruncated is true,\n\t\t\t\tTrafficPolicyInstanceNameMarker is the name of the first traffic policy\n\t\t\tinstance in the next group of traffic policy instances.

" + } + }, + "TrafficPolicyInstanceTypeMarker": { + "target": "com.amazonaws.route53#RRType", + "traits": { + "smithy.api#documentation": "

If IsTruncated is true, TrafficPolicyInstanceTypeMarker is\n\t\t\tthe DNS type of the resource record sets that are associated with the first traffic\n\t\t\tpolicy instance in the next group of traffic policy instances.

" + } + }, + "IsTruncated": { + "target": "com.amazonaws.route53#PageTruncated", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A flag that indicates whether there are more traffic policy instances to be listed. If\n\t\t\tthe response was truncated, you can get the next group of traffic policy instances by\n\t\t\tsubmitting another ListTrafficPolicyInstancesByHostedZone request and\n\t\t\tspecifying the values of HostedZoneIdMarker,\n\t\t\t\tTrafficPolicyInstanceNameMarker, and\n\t\t\t\tTrafficPolicyInstanceTypeMarker in the corresponding request\n\t\t\tparameters.

", + "smithy.api#required": {} + } + }, + "MaxItems": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The value that you specified for the MaxItems parameter in the\n\t\t\t\tListTrafficPolicyInstancesByHostedZone request that produced the\n\t\t\tcurrent response.

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

A complex type that contains the response information for the request.

" + } + }, + "com.amazonaws.route53#ListTrafficPolicyInstancesByPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#ListTrafficPolicyInstancesByPolicyRequest" + }, + "output": { + "target": "com.amazonaws.route53#ListTrafficPolicyInstancesByPolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#NoSuchTrafficPolicy" + }, + { + "target": "com.amazonaws.route53#NoSuchTrafficPolicyInstance" + } + ], + "traits": { + "smithy.api#documentation": "

Gets information about the traffic policy instances that you created by using a\n\t\t\tspecify traffic policy version.

\n \n

After you submit a CreateTrafficPolicyInstance or an\n\t\t\t\t\tUpdateTrafficPolicyInstance request, there's a brief delay while\n\t\t\t\tAmazon Route 53 creates the resource record sets that are specified in the traffic\n\t\t\t\tpolicy definition. For more information, see the State response\n\t\t\t\telement.

\n \n

Route 53 returns a maximum of 100 items in each response. If you have a lot of traffic\n\t\t\tpolicy instances, you can use the MaxItems parameter to list them in groups\n\t\t\tof up to 100.

", + "smithy.api#http": { + "method": "GET", + "uri": "/2013-04-01/trafficpolicyinstances/trafficpolicy", + "code": 200 + } + } + }, + "com.amazonaws.route53#ListTrafficPolicyInstancesByPolicyRequest": { + "type": "structure", + "members": { + "TrafficPolicyId": { + "target": "com.amazonaws.route53#TrafficPolicyId", + "traits": { + "smithy.api#documentation": "

The ID of the traffic policy for which you want to list traffic policy\n\t\t\tinstances.

", + "smithy.api#httpQuery": "id", + "smithy.api#required": {} + } + }, + "TrafficPolicyVersion": { + "target": "com.amazonaws.route53#TrafficPolicyVersion", + "traits": { + "smithy.api#documentation": "

The version of the traffic policy for which you want to list traffic policy instances.\n\t\t\tThe version must be associated with the traffic policy that is specified by\n\t\t\t\tTrafficPolicyId.

", + "smithy.api#httpQuery": "version", + "smithy.api#required": {} + } + }, + "HostedZoneIdMarker": { + "target": "com.amazonaws.route53#ResourceId", + "traits": { + "smithy.api#documentation": "

If the value of IsTruncated in the previous response was\n\t\t\t\ttrue, you have more traffic policy instances. To get more traffic\n\t\t\tpolicy instances, submit another ListTrafficPolicyInstancesByPolicy\n\t\t\trequest.

\n

For the value of hostedzoneid, specify the value of\n\t\t\t\tHostedZoneIdMarker from the previous response, which is the hosted zone\n\t\t\tID of the first traffic policy instance that Amazon Route 53 will return if you submit\n\t\t\tanother request.

\n

If the value of IsTruncated in the previous response was\n\t\t\t\tfalse, there are no more traffic policy instances to get.

", + "smithy.api#httpQuery": "hostedzoneid" + } + }, + "TrafficPolicyInstanceNameMarker": { + "target": "com.amazonaws.route53#DNSName", + "traits": { + "smithy.api#documentation": "

If the value of IsTruncated in the previous response was\n\t\t\t\ttrue, you have more traffic policy instances. To get more traffic\n\t\t\tpolicy instances, submit another ListTrafficPolicyInstancesByPolicy\n\t\t\trequest.

\n

For the value of trafficpolicyinstancename, specify the value of\n\t\t\t\tTrafficPolicyInstanceNameMarker from the previous response, which is\n\t\t\tthe name of the first traffic policy instance that Amazon Route 53 will return if you\n\t\t\tsubmit another request.

\n

If the value of IsTruncated in the previous response was\n\t\t\t\tfalse, there are no more traffic policy instances to get.

", + "smithy.api#httpQuery": "trafficpolicyinstancename" + } + }, + "TrafficPolicyInstanceTypeMarker": { + "target": "com.amazonaws.route53#RRType", + "traits": { + "smithy.api#documentation": "

If the value of IsTruncated in the previous response was\n\t\t\t\ttrue, you have more traffic policy instances. To get more traffic\n\t\t\tpolicy instances, submit another ListTrafficPolicyInstancesByPolicy\n\t\t\trequest.

\n

For the value of trafficpolicyinstancetype, specify the value of\n\t\t\t\tTrafficPolicyInstanceTypeMarker from the previous response, which is\n\t\t\tthe name of the first traffic policy instance that Amazon Route 53 will return if you\n\t\t\tsubmit another request.

\n

If the value of IsTruncated in the previous response was\n\t\t\t\tfalse, there are no more traffic policy instances to get.

", + "smithy.api#httpQuery": "trafficpolicyinstancetype" + } + }, + "MaxItems": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The maximum number of traffic policy instances to be included in the response body for\n\t\t\tthis request. If you have more than MaxItems traffic policy instances, the\n\t\t\tvalue of the IsTruncated element in the response is true, and\n\t\t\tthe values of HostedZoneIdMarker,\n\t\t\t\tTrafficPolicyInstanceNameMarker, and\n\t\t\t\tTrafficPolicyInstanceTypeMarker represent the first traffic policy\n\t\t\tinstance that Amazon Route 53 will return if you submit another request.

", + "smithy.api#httpQuery": "maxitems" + } + } + }, + "traits": { + "smithy.api#documentation": "

A complex type that contains the information about the request to list your traffic\n\t\t\tpolicy instances.

" + } + }, + "com.amazonaws.route53#ListTrafficPolicyInstancesByPolicyResponse": { + "type": "structure", + "members": { + "TrafficPolicyInstances": { + "target": "com.amazonaws.route53#TrafficPolicyInstances", + "traits": { + "smithy.api#documentation": "

A list that contains one TrafficPolicyInstance element for each traffic\n\t\t\tpolicy instance that matches the elements in the request.

", + "smithy.api#required": {} + } + }, + "HostedZoneIdMarker": { + "target": "com.amazonaws.route53#ResourceId", + "traits": { + "smithy.api#documentation": "

If IsTruncated is true, HostedZoneIdMarker is\n\t\t\tthe ID of the hosted zone of the first traffic policy instance in the next group of\n\t\t\ttraffic policy instances.

" + } + }, + "TrafficPolicyInstanceNameMarker": { + "target": "com.amazonaws.route53#DNSName", + "traits": { + "smithy.api#documentation": "

If IsTruncated is true,\n\t\t\t\tTrafficPolicyInstanceNameMarker is the name of the first traffic policy\n\t\t\tinstance in the next group of MaxItems traffic policy instances.

" + } + }, + "TrafficPolicyInstanceTypeMarker": { + "target": "com.amazonaws.route53#RRType", + "traits": { + "smithy.api#documentation": "

If IsTruncated is true,\n\t\t\t\tTrafficPolicyInstanceTypeMarker is the DNS type of the resource record\n\t\t\tsets that are associated with the first traffic policy instance in the next group of\n\t\t\t\tMaxItems traffic policy instances.

" + } + }, + "IsTruncated": { + "target": "com.amazonaws.route53#PageTruncated", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A flag that indicates whether there are more traffic policy instances to be listed. If\n\t\t\tthe response was truncated, you can get the next group of traffic policy instances by\n\t\t\tcalling ListTrafficPolicyInstancesByPolicy again and specifying the values\n\t\t\tof the HostedZoneIdMarker, TrafficPolicyInstanceNameMarker,\n\t\t\tand TrafficPolicyInstanceTypeMarker elements in the corresponding request\n\t\t\tparameters.

", + "smithy.api#required": {} + } + }, + "MaxItems": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The value that you specified for the MaxItems parameter in the call to\n\t\t\t\tListTrafficPolicyInstancesByPolicy that produced the current\n\t\t\tresponse.

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

A complex type that contains the response information for the request.

" + } + }, + "com.amazonaws.route53#ListTrafficPolicyInstancesRequest": { + "type": "structure", + "members": { + "HostedZoneIdMarker": { + "target": "com.amazonaws.route53#ResourceId", + "traits": { + "smithy.api#documentation": "

If the value of IsTruncated in the previous response was\n\t\t\t\ttrue, you have more traffic policy instances. To get more traffic\n\t\t\tpolicy instances, submit another ListTrafficPolicyInstances request. For\n\t\t\tthe value of HostedZoneId, specify the value of\n\t\t\t\tHostedZoneIdMarker from the previous response, which is the hosted zone\n\t\t\tID of the first traffic policy instance in the next group of traffic policy\n\t\t\tinstances.

\n

If the value of IsTruncated in the previous response was\n\t\t\t\tfalse, there are no more traffic policy instances to get.

", + "smithy.api#httpQuery": "hostedzoneid" + } + }, + "TrafficPolicyInstanceNameMarker": { + "target": "com.amazonaws.route53#DNSName", + "traits": { + "smithy.api#documentation": "

If the value of IsTruncated in the previous response was\n\t\t\t\ttrue, you have more traffic policy instances. To get more traffic\n\t\t\tpolicy instances, submit another ListTrafficPolicyInstances request. For\n\t\t\tthe value of trafficpolicyinstancename, specify the value of\n\t\t\t\tTrafficPolicyInstanceNameMarker from the previous response, which is\n\t\t\tthe name of the first traffic policy instance in the next group of traffic policy\n\t\t\tinstances.

\n

If the value of IsTruncated in the previous response was\n\t\t\t\tfalse, there are no more traffic policy instances to get.

", + "smithy.api#httpQuery": "trafficpolicyinstancename" + } + }, + "TrafficPolicyInstanceTypeMarker": { + "target": "com.amazonaws.route53#RRType", + "traits": { + "smithy.api#documentation": "

If the value of IsTruncated in the previous response was\n\t\t\t\ttrue, you have more traffic policy instances. To get more traffic\n\t\t\tpolicy instances, submit another ListTrafficPolicyInstances request. For\n\t\t\tthe value of trafficpolicyinstancetype, specify the value of\n\t\t\t\tTrafficPolicyInstanceTypeMarker from the previous response, which is\n\t\t\tthe type of the first traffic policy instance in the next group of traffic policy\n\t\t\tinstances.

\n

If the value of IsTruncated in the previous response was\n\t\t\t\tfalse, there are no more traffic policy instances to get.

", + "smithy.api#httpQuery": "trafficpolicyinstancetype" + } + }, + "MaxItems": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The maximum number of traffic policy instances that you want Amazon Route 53 to return\n\t\t\tin response to a ListTrafficPolicyInstances request. If you have more than\n\t\t\t\tMaxItems traffic policy instances, the value of the\n\t\t\t\tIsTruncated element in the response is true, and the\n\t\t\tvalues of HostedZoneIdMarker, TrafficPolicyInstanceNameMarker,\n\t\t\tand TrafficPolicyInstanceTypeMarker represent the first traffic policy\n\t\t\tinstance in the next group of MaxItems traffic policy instances.

", + "smithy.api#httpQuery": "maxitems" + } + } + }, + "traits": { + "smithy.api#documentation": "

A request to get information about the traffic policy instances that you created by\n\t\t\tusing the current Amazon Web Services account.

" + } + }, + "com.amazonaws.route53#ListTrafficPolicyInstancesResponse": { + "type": "structure", + "members": { + "TrafficPolicyInstances": { + "target": "com.amazonaws.route53#TrafficPolicyInstances", + "traits": { + "smithy.api#documentation": "

A list that contains one TrafficPolicyInstance element for each traffic\n\t\t\tpolicy instance that matches the elements in the request.

", + "smithy.api#required": {} + } + }, + "HostedZoneIdMarker": { + "target": "com.amazonaws.route53#ResourceId", + "traits": { + "smithy.api#documentation": "

If IsTruncated is true, HostedZoneIdMarker is\n\t\t\tthe ID of the hosted zone of the first traffic policy instance that Route 53 will return\n\t\t\tif you submit another ListTrafficPolicyInstances request.

" + } + }, + "TrafficPolicyInstanceNameMarker": { + "target": "com.amazonaws.route53#DNSName", + "traits": { + "smithy.api#documentation": "

If IsTruncated is true,\n\t\t\t\tTrafficPolicyInstanceNameMarker is the name of the first traffic policy\n\t\t\tinstance that Route 53 will return if you submit another\n\t\t\t\tListTrafficPolicyInstances request.

" + } + }, + "TrafficPolicyInstanceTypeMarker": { + "target": "com.amazonaws.route53#RRType", + "traits": { + "smithy.api#documentation": "

If IsTruncated is true,\n\t\t\t\tTrafficPolicyInstanceTypeMarker is the DNS type of the resource record\n\t\t\tsets that are associated with the first traffic policy instance that Amazon Route 53\n\t\t\twill return if you submit another ListTrafficPolicyInstances request.\n\t\t

" + } + }, + "IsTruncated": { + "target": "com.amazonaws.route53#PageTruncated", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A flag that indicates whether there are more traffic policy instances to be listed. If\n\t\t\tthe response was truncated, you can get more traffic policy instances by calling\n\t\t\t\tListTrafficPolicyInstances again and specifying the values of the\n\t\t\t\tHostedZoneIdMarker, TrafficPolicyInstanceNameMarker, and\n\t\t\t\tTrafficPolicyInstanceTypeMarker in the corresponding request\n\t\t\tparameters.

", + "smithy.api#required": {} + } + }, + "MaxItems": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The value that you specified for the MaxItems parameter in the call to\n\t\t\t\tListTrafficPolicyInstances that produced the current response.

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

A complex type that contains the response information for the request.

" + } + }, + "com.amazonaws.route53#ListTrafficPolicyVersions": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#ListTrafficPolicyVersionsRequest" + }, + "output": { + "target": "com.amazonaws.route53#ListTrafficPolicyVersionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#NoSuchTrafficPolicy" + } + ], + "traits": { + "smithy.api#documentation": "

Gets information about all of the versions for a specified traffic policy.

\n

Traffic policy versions are listed in numerical order by\n\t\t\tVersionNumber.

", + "smithy.api#http": { + "method": "GET", + "uri": "/2013-04-01/trafficpolicies/{Id}/versions", + "code": 200 + } + } + }, + "com.amazonaws.route53#ListTrafficPolicyVersionsRequest": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.route53#TrafficPolicyId", + "traits": { + "smithy.api#documentation": "

Specify the value of Id of the traffic policy for which you want to list\n\t\t\tall versions.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "TrafficPolicyVersionMarker": { + "target": "com.amazonaws.route53#TrafficPolicyVersionMarker", + "traits": { + "smithy.api#documentation": "

For your first request to ListTrafficPolicyVersions, don't include the\n\t\t\t\tTrafficPolicyVersionMarker parameter.

\n

If you have more traffic policy versions than the value of MaxItems,\n\t\t\t\tListTrafficPolicyVersions returns only the first group of\n\t\t\t\tMaxItems versions. To get more traffic policy versions, submit another\n\t\t\t\tListTrafficPolicyVersions request. For the value of\n\t\t\t\tTrafficPolicyVersionMarker, specify the value of\n\t\t\t\tTrafficPolicyVersionMarker in the previous response.

", + "smithy.api#httpQuery": "trafficpolicyversion" + } + }, + "MaxItems": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The maximum number of traffic policy versions that you want Amazon Route 53 to include\n\t\t\tin the response body for this request. If the specified traffic policy has more than\n\t\t\t\tMaxItems versions, the value of IsTruncated in the\n\t\t\tresponse is true, and the value of the\n\t\t\t\tTrafficPolicyVersionMarker element is the ID of the first version that\n\t\t\tRoute 53 will return if you submit another request.

", + "smithy.api#httpQuery": "maxitems" + } + } + }, + "traits": { + "smithy.api#documentation": "

A complex type that contains the information about the request to list your traffic\n\t\t\tpolicies.

" + } + }, + "com.amazonaws.route53#ListTrafficPolicyVersionsResponse": { + "type": "structure", + "members": { + "TrafficPolicies": { + "target": "com.amazonaws.route53#TrafficPolicies", + "traits": { + "smithy.api#documentation": "

A list that contains one TrafficPolicy element for each traffic policy\n\t\t\tversion that is associated with the specified traffic policy.

", + "smithy.api#required": {} + } + }, + "IsTruncated": { + "target": "com.amazonaws.route53#PageTruncated", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A flag that indicates whether there are more traffic policies to be listed. If the\n\t\t\tresponse was truncated, you can get the next group of traffic policies by submitting\n\t\t\tanother ListTrafficPolicyVersions request and specifying the value of\n\t\t\t\tNextMarker in the marker parameter.

", + "smithy.api#required": {} + } + }, + "TrafficPolicyVersionMarker": { + "target": "com.amazonaws.route53#TrafficPolicyVersionMarker", + "traits": { + "smithy.api#documentation": "

If IsTruncated is true, the value of\n\t\t\t\tTrafficPolicyVersionMarker identifies the first traffic policy that\n\t\t\tAmazon Route 53 will return if you submit another request. Call\n\t\t\t\tListTrafficPolicyVersions again and specify the value of\n\t\t\t\tTrafficPolicyVersionMarker in the\n\t\t\t\tTrafficPolicyVersionMarker request parameter.

\n

This element is present only if IsTruncated is true.

", + "smithy.api#required": {} + } + }, + "MaxItems": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The value that you specified for the maxitems parameter in the\n\t\t\t\tListTrafficPolicyVersions request that produced the current\n\t\t\tresponse.

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

A complex type that contains the response information for the request.

" + } + }, + "com.amazonaws.route53#ListVPCAssociationAuthorizations": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#ListVPCAssociationAuthorizationsRequest" + }, + "output": { + "target": "com.amazonaws.route53#ListVPCAssociationAuthorizationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#InvalidPaginationToken" + }, + { + "target": "com.amazonaws.route53#NoSuchHostedZone" + } + ], + "traits": { + "smithy.api#documentation": "

Gets a list of the VPCs that were created by other accounts and that can be associated\n\t\t\twith a specified hosted zone because you've submitted one or more\n\t\t\t\tCreateVPCAssociationAuthorization requests.

\n

The response includes a VPCs element with a VPC child\n\t\t\telement for each VPC that can be associated with the hosted zone.

", + "smithy.api#http": { + "method": "GET", + "uri": "/2013-04-01/hostedzone/{HostedZoneId}/authorizevpcassociation", + "code": 200 + } + } + }, + "com.amazonaws.route53#ListVPCAssociationAuthorizationsRequest": { + "type": "structure", + "members": { + "HostedZoneId": { + "target": "com.amazonaws.route53#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the hosted zone for which you want a list of VPCs that can be associated\n\t\t\twith the hosted zone.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.route53#PaginationToken", + "traits": { + "smithy.api#documentation": "

\n Optional: If a response includes a NextToken\n\t\t\telement, there are more VPCs that can be associated with the specified hosted zone. To\n\t\t\tget the next page of results, submit another request, and include the value of\n\t\t\t\tNextToken from the response in the nexttoken parameter in\n\t\t\tanother ListVPCAssociationAuthorizations request.

", + "smithy.api#httpQuery": "nexttoken" + } + }, + "MaxResults": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

\n Optional: An integer that specifies the maximum number of VPCs\n\t\t\tthat you want Amazon Route 53 to return. If you don't specify a value for\n\t\t\t\tMaxResults, Route 53 returns up to 50 VPCs per page.

", + "smithy.api#httpQuery": "maxresults" + } + } + }, + "traits": { + "smithy.api#documentation": "

A complex type that contains information about that can be associated with your hosted\n\t\t\tzone.

" + } + }, + "com.amazonaws.route53#ListVPCAssociationAuthorizationsResponse": { + "type": "structure", + "members": { + "HostedZoneId": { + "target": "com.amazonaws.route53#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the hosted zone that you can associate the listed VPCs with.

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.route53#PaginationToken", + "traits": { + "smithy.api#documentation": "

When the response includes a NextToken element, there are more VPCs that\n\t\t\tcan be associated with the specified hosted zone. To get the next page of VPCs, submit\n\t\t\tanother ListVPCAssociationAuthorizations request, and include the value of\n\t\t\tthe NextToken element from the response in the nexttoken\n\t\t\trequest parameter.

" + } + }, + "VPCs": { + "target": "com.amazonaws.route53#VPCs", + "traits": { + "smithy.api#documentation": "

The list of VPCs that are authorized to be associated with the specified hosted\n\t\t\tzone.

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

A complex type that contains the response information for the request.

" + } + }, + "com.amazonaws.route53#LocationSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.route53#LocationSummary" + } + }, + "com.amazonaws.route53#LocationSummary": { + "type": "structure", + "members": { + "LocationName": { + "target": "com.amazonaws.route53#CidrLocationNameDefaultAllowed", + "traits": { + "smithy.api#documentation": "

A string that specifies a location name.

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

A complex type that contains information about the CIDR location.

" + } + }, + "com.amazonaws.route53#MeasureLatency": { + "type": "boolean" + }, + "com.amazonaws.route53#Message": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + } + } + }, + "com.amazonaws.route53#MetricName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "com.amazonaws.route53#Nameserver": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 255 + } + } + }, + "com.amazonaws.route53#Namespace": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "com.amazonaws.route53#NoSuchChange": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

A change with the specified change ID does not exist.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.route53#NoSuchCidrCollectionException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.route53#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The CIDR collection you specified, doesn't exist.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.route53#NoSuchCidrLocationException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.route53#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The CIDR collection location doesn't match any locations in your account.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.route53#NoSuchCloudWatchLogsLogGroup": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

There is no CloudWatch Logs log group with the specified ARN.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.route53#NoSuchDelegationSet": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage", + "traits": { + "smithy.api#documentation": "

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

A reusable delegation set with the specified ID does not exist.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.route53#NoSuchGeoLocation": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage", + "traits": { + "smithy.api#documentation": "

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

Amazon Route 53 doesn't support the specified geographic location. For a list of\n\t\t\tsupported geolocation codes, see the GeoLocation data\n\t\t\ttype.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.route53#NoSuchHealthCheck": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage", + "traits": { + "smithy.api#documentation": "

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

No health check exists with the specified ID.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.route53#NoSuchHostedZone": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage", + "traits": { + "smithy.api#documentation": "

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

No hosted zone exists with the ID that you specified.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.route53#NoSuchKeySigningKey": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The specified key-signing key (KSK) doesn't exist.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.route53#NoSuchQueryLoggingConfig": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

There is no DNS query logging configuration with the specified ID.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.route53#NoSuchTrafficPolicy": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage", + "traits": { + "smithy.api#documentation": "

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

No traffic policy exists with the specified ID.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.route53#NoSuchTrafficPolicyInstance": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage", + "traits": { + "smithy.api#documentation": "

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

No traffic policy instance exists with the specified ID.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.route53#Nonce": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.route53#NotAuthorizedException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage", + "traits": { + "smithy.api#documentation": "

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

Associating the specified VPC with the specified hosted zone has not been\n\t\t\tauthorized.

", + "smithy.api#error": "client", + "smithy.api#httpError": 401 + } + }, + "com.amazonaws.route53#PageMarker": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 64 + } + } + }, + "com.amazonaws.route53#PageTruncated": { + "type": "boolean", + "traits": { + "smithy.api#default": false + } + }, + "com.amazonaws.route53#PaginationToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + } + } + }, + "com.amazonaws.route53#Period": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 60 + } + } + }, + "com.amazonaws.route53#Port": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 65535 + } + } + }, + "com.amazonaws.route53#PriorRequestNotComplete": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

If Amazon Route 53 can't process a request before the next request arrives, it will\n\t\t\treject subsequent requests for the same hosted zone and return an HTTP 400\n\t\t\t\terror (Bad request). If Route 53 returns this error repeatedly\n\t\t\tfor the same request, we recommend that you wait, in intervals of increasing duration,\n\t\t\tbefore you try the request again.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.route53#PublicZoneVPCAssociation": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage", + "traits": { + "smithy.api#documentation": "

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

You're trying to associate a VPC with a public hosted zone. Amazon Route 53 doesn't\n\t\t\tsupport associating a VPC with a public hosted zone.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.route53#QueryLoggingConfig": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.route53#QueryLoggingConfigId", + "traits": { + "smithy.api#documentation": "

The ID for a configuration for DNS query logging.

", + "smithy.api#required": {} + } + }, + "HostedZoneId": { + "target": "com.amazonaws.route53#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the hosted zone that CloudWatch Logs is logging queries for.

", + "smithy.api#required": {} + } + }, + "CloudWatchLogsLogGroupArn": { + "target": "com.amazonaws.route53#CloudWatchLogsLogGroupArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the CloudWatch Logs log group that Amazon Route 53\n\t\t\tis publishing logs to.

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

A complex type that contains information about a configuration for DNS query\n\t\t\tlogging.

" + } + }, + "com.amazonaws.route53#QueryLoggingConfigAlreadyExists": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

You can create only one query logging configuration for a hosted zone, and a query\n\t\t\tlogging configuration already exists for this hosted zone.

", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.route53#QueryLoggingConfigId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 36 + } + } + }, + "com.amazonaws.route53#QueryLoggingConfigs": { + "type": "list", + "member": { + "target": "com.amazonaws.route53#QueryLoggingConfig", + "traits": { + "smithy.api#xmlName": "QueryLoggingConfig" + } + } + }, + "com.amazonaws.route53#RData": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 4000 + } + } + }, + "com.amazonaws.route53#RRType": { + "type": "enum", + "members": { + "SOA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SOA" + } + }, + "A": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "A" + } + }, + "TXT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TXT" + } + }, + "NS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NS" + } + }, + "CNAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CNAME" + } + }, + "MX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MX" + } + }, + "NAPTR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NAPTR" + } + }, + "PTR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PTR" + } + }, + "SRV": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SRV" + } + }, + "SPF": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SPF" + } + }, + "AAAA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AAAA" + } + }, + "CAA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CAA" + } + }, + "DS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DS" + } + } + } + }, + "com.amazonaws.route53#RecordData": { + "type": "list", + "member": { + "target": "com.amazonaws.route53#RecordDataEntry", + "traits": { + "smithy.api#xmlName": "RecordDataEntry" + } + } + }, + "com.amazonaws.route53#RecordDataEntry": { + "type": "string", + "traits": { + "smithy.api#documentation": "

A value that Amazon Route 53 returned for this resource record set. A\n\t\t\t\tRecordDataEntry element is one of the following:

\n ", + "smithy.api#length": { + "min": 0, + "max": 512 + } + } + }, + "com.amazonaws.route53#RequestInterval": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 10, + "max": 30 + } + } + }, + "com.amazonaws.route53#ResettableElementName": { + "type": "enum", + "members": { + "FullyQualifiedDomainName": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FullyQualifiedDomainName" + } + }, + "Regions": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Regions" + } + }, + "ResourcePath": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ResourcePath" + } + }, + "ChildHealthChecks": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ChildHealthChecks" + } + } + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + } + } + }, + "com.amazonaws.route53#ResettableElementNameList": { + "type": "list", + "member": { + "target": "com.amazonaws.route53#ResettableElementName", + "traits": { + "smithy.api#xmlName": "ResettableElementName" + } + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 64 + } + } + }, + "com.amazonaws.route53#ResourceDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.route53#ResourceId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 32 + } + } + }, + "com.amazonaws.route53#ResourcePath": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 255 + } + } + }, + "com.amazonaws.route53#ResourceRecord": { + "type": "structure", + "members": { + "Value": { + "target": "com.amazonaws.route53#RData", + "traits": { + "smithy.api#documentation": "

The current or new DNS record value, not to exceed 4,000 characters. In the case of a\n\t\t\t\tDELETE action, if the current value does not match the actual value, an\n\t\t\terror is returned. For descriptions about how to format Value for different\n\t\t\trecord types, see Supported DNS Resource\n\t\t\t\tRecord Types in the Amazon Route 53 Developer\n\t\t\tGuide.

\n

You can specify more than one value for all record types except CNAME and\n\t\t\t\tSOA.

\n \n

If you're creating an alias resource record set, omit Value.

\n ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Information specific to the resource record.

\n \n

If you're creating an alias resource record set, omit\n\t\t\t\tResourceRecord.

\n " + } + }, + "com.amazonaws.route53#ResourceRecordSet": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.route53#DNSName", + "traits": { + "smithy.api#documentation": "

For ChangeResourceRecordSets requests, the name of the record that you\n\t\t\twant to create, update, or delete. For ListResourceRecordSets responses,\n\t\t\tthe name of a record in the specified hosted zone.

\n

\n ChangeResourceRecordSets Only\n

\n

Enter a fully qualified domain name, for example, www.example.com. You\n\t\t\tcan optionally include a trailing dot. If you omit the trailing dot, Amazon Route 53\n\t\t\tassumes that the domain name that you specify is fully qualified. This means that Route\n\t\t\t53 treats www.example.com (without a trailing dot) and\n\t\t\t\twww.example.com. (with a trailing dot) as identical.

\n

For information about how to specify characters other than a-z,\n\t\t\t\t0-9, and - (hyphen) and how to specify internationalized\n\t\t\tdomain names, see DNS Domain Name\n\t\t\t\tFormat in the Amazon Route 53 Developer Guide.

\n

You can use the asterisk (*) wildcard to replace the leftmost label in a domain name,\n\t\t\tfor example, *.example.com. Note the following:

\n \n

You can use the * wildcard as the leftmost label in a domain name, for example,\n\t\t\t\t*.example.com. You can't use an * for one of the middle labels, for\n\t\t\texample, marketing.*.example.com. In addition, the * must replace the\n\t\t\tentire label; for example, you can't specify prod*.example.com.

", + "smithy.api#required": {} + } + }, + "Type": { + "target": "com.amazonaws.route53#RRType", + "traits": { + "smithy.api#documentation": "

The DNS record type. For information about different record types and how data is\n\t\t\tencoded for them, see Supported DNS Resource\n\t\t\t\tRecord Types in the Amazon Route 53 Developer\n\t\t\tGuide.

\n

Valid values for basic resource record sets: A | AAAA |\n\t\t\t\tCAA | CNAME | DS |MX |\n\t\t\t\tNAPTR | NS | PTR | SOA |\n\t\t\t\tSPF | SRV | TXT\n

\n

Values for weighted, latency, geolocation, and failover resource record sets:\n\t\t\t\tA | AAAA | CAA | CNAME |\n\t\t\t\tMX | NAPTR | PTR | SPF |\n\t\t\t\tSRV | TXT. When creating a group of weighted, latency,\n\t\t\tgeolocation, or failover resource record sets, specify the same value for all of the\n\t\t\tresource record sets in the group.

\n

Valid values for multivalue answer resource record sets: A |\n\t\t\t\tAAAA | MX | NAPTR | PTR |\n\t\t\t\tSPF | SRV | TXT\n

\n \n

SPF records were formerly used to verify the identity of the sender of email\n\t\t\t\tmessages. However, we no longer recommend that you create resource record sets for\n\t\t\t\twhich the value of Type is SPF. RFC 7208, Sender\n\t\t\t\t\tPolicy Framework (SPF) for Authorizing Use of Domains in Email, Version\n\t\t\t\t\t1, has been updated to say, \"...[I]ts existence and mechanism defined\n\t\t\t\tin [RFC4408] have led to some interoperability issues. Accordingly, its use is no\n\t\t\t\tlonger appropriate for SPF version 1; implementations are not to use it.\" In RFC\n\t\t\t\t7208, see section 14.1, The SPF DNS Record Type.

\n \n

Values for alias resource record sets:

\n ", + "smithy.api#required": {} + } + }, + "SetIdentifier": { + "target": "com.amazonaws.route53#ResourceRecordSetIdentifier", + "traits": { + "smithy.api#documentation": "

\n Resource record sets that have a routing policy other than\n\t\t\t\tsimple: An identifier that differentiates among multiple resource record\n\t\t\tsets that have the same combination of name and type, such as multiple weighted resource\n\t\t\trecord sets named acme.example.com that have a type of A. In a group of resource record\n\t\t\tsets that have the same name and type, the value of SetIdentifier must be\n\t\t\tunique for each resource record set.

\n

For information about routing policies, see Choosing a Routing\n\t\t\t\tPolicy in the Amazon Route 53 Developer Guide.

" + } + }, + "Weight": { + "target": "com.amazonaws.route53#ResourceRecordSetWeight", + "traits": { + "smithy.api#documentation": "

\n Weighted resource record sets only: Among resource record sets\n\t\t\tthat have the same combination of DNS name and type, a value that determines the\n\t\t\tproportion of DNS queries that Amazon Route 53 responds to using the current resource\n\t\t\trecord set. Route 53 calculates the sum of the weights for the resource record sets that\n\t\t\thave the same combination of DNS name and type. Route 53 then responds to queries based\n\t\t\ton the ratio of a resource's weight to the total. Note the following:

\n " + } + }, + "Region": { + "target": "com.amazonaws.route53#ResourceRecordSetRegion", + "traits": { + "smithy.api#documentation": "

\n Latency-based resource record sets only: The Amazon EC2 Region\n\t\t\twhere you created the resource that this resource record set refers to. The resource\n\t\t\ttypically is an Amazon Web Services resource, such as an EC2 instance or an ELB load\n\t\t\tbalancer, and is referred to by an IP address or a DNS domain name, depending on the\n\t\t\trecord type.

\n

When Amazon Route 53 receives a DNS query for a domain name and type for which you\n\t\t\thave created latency resource record sets, Route 53 selects the latency resource record\n\t\t\tset that has the lowest latency between the end user and the associated Amazon EC2\n\t\t\tRegion. Route 53 then returns the value that is associated with the selected resource\n\t\t\trecord set.

\n

Note the following:

\n " + } + }, + "GeoLocation": { + "target": "com.amazonaws.route53#GeoLocation", + "traits": { + "smithy.api#documentation": "

\n Geolocation resource record sets only: A complex type that lets\n\t\t\tyou control how Amazon Route 53 responds to DNS queries based on the geographic origin\n\t\t\tof the query. For example, if you want all queries from Africa to be routed to a web\n\t\t\tserver with an IP address of 192.0.2.111, create a resource record set with\n\t\t\ta Type of A and a ContinentCode of\n\t\t\t\tAF.

\n \n

Although creating geolocation and geolocation alias resource record sets in a\n\t\t\t\tprivate hosted zone is allowed, it's not supported.

\n \n

If you create separate resource record sets for overlapping geographic regions (for\n\t\t\texample, one resource record set for a continent and one for a country on the same\n\t\t\tcontinent), priority goes to the smallest geographic region. This allows you to route\n\t\t\tmost queries for a continent to one resource and to route queries for a country on that\n\t\t\tcontinent to a different resource.

\n

You can't create two geolocation resource record sets that specify the same geographic\n\t\t\tlocation.

\n

The value * in the CountryCode element matches all\n\t\t\tgeographic locations that aren't specified in other geolocation resource record sets\n\t\t\tthat have the same values for the Name and Type\n\t\t\telements.

\n \n

Geolocation works by mapping IP addresses to locations. However, some IP addresses\n\t\t\t\taren't mapped to geographic locations, so even if you create geolocation resource\n\t\t\t\trecord sets that cover all seven continents, Route 53 will receive some DNS queries\n\t\t\t\tfrom locations that it can't identify. We recommend that you create a resource\n\t\t\t\trecord set for which the value of CountryCode is *. Two\n\t\t\t\tgroups of queries are routed to the resource that you specify in this record:\n\t\t\t\tqueries that come from locations for which you haven't created geolocation resource\n\t\t\t\trecord sets and queries from IP addresses that aren't mapped to a location. If you\n\t\t\t\tdon't create a * resource record set, Route 53 returns a \"no answer\"\n\t\t\t\tresponse for queries from those locations.

\n \n

You can't create non-geolocation resource record sets that have the same values for\n\t\t\tthe Name and Type elements as geolocation resource record\n\t\t\tsets.

" + } + }, + "Failover": { + "target": "com.amazonaws.route53#ResourceRecordSetFailover", + "traits": { + "smithy.api#documentation": "

\n Failover resource record sets only: To configure failover, you\n\t\t\tadd the Failover element to two resource record sets. For one resource\n\t\t\trecord set, you specify PRIMARY as the value for Failover; for\n\t\t\tthe other resource record set, you specify SECONDARY. In addition, you\n\t\t\tinclude the HealthCheckId element and specify the health check that you\n\t\t\twant Amazon Route 53 to perform for each resource record set.

\n

Except where noted, the following failover behaviors assume that you have included the\n\t\t\t\tHealthCheckId element in both resource record sets:

\n \n

You can't create non-failover resource record sets that have the same values for the\n\t\t\t\tName and Type elements as failover resource record\n\t\t\tsets.

\n

For failover alias resource record sets, you must also include the\n\t\t\t\tEvaluateTargetHealth element and set the value to true.

\n

For more information about configuring failover for Route 53, see the following topics\n\t\t\tin the Amazon Route 53 Developer Guide:

\n " + } + }, + "MultiValueAnswer": { + "target": "com.amazonaws.route53#ResourceRecordSetMultiValueAnswer", + "traits": { + "smithy.api#documentation": "

\n Multivalue answer resource record sets only: To route traffic\n\t\t\tapproximately randomly to multiple resources, such as web servers, create one multivalue\n\t\t\tanswer record for each resource and specify true for\n\t\t\t\tMultiValueAnswer. Note the following:

\n \n

You can't create multivalue answer alias records.

" + } + }, + "TTL": { + "target": "com.amazonaws.route53#TTL", + "traits": { + "smithy.api#documentation": "

The resource record cache time to live (TTL), in seconds. Note the following:

\n " + } + }, + "ResourceRecords": { + "target": "com.amazonaws.route53#ResourceRecords", + "traits": { + "smithy.api#documentation": "

Information about the resource records to act upon.

\n \n

If you're creating an alias resource record set, omit\n\t\t\t\tResourceRecords.

\n " + } + }, + "AliasTarget": { + "target": "com.amazonaws.route53#AliasTarget", + "traits": { + "smithy.api#documentation": "

\n Alias resource record sets only: Information about the Amazon Web Services resource, such as a CloudFront distribution or an Amazon S3 bucket, that\n\t\t\tyou want to route traffic to.

\n

If you're creating resource records sets for a private hosted zone, note the\n\t\t\tfollowing:

\n " + } + }, + "HealthCheckId": { + "target": "com.amazonaws.route53#HealthCheckId", + "traits": { + "smithy.api#documentation": "

If you want Amazon Route 53 to return this resource record set in response to a DNS\n\t\t\tquery only when the status of a health check is healthy, include the\n\t\t\t\tHealthCheckId element and specify the ID of the applicable health\n\t\t\tcheck.

\n

Route 53 determines whether a resource record set is healthy based on one of the\n\t\t\tfollowing:

\n \n \n

Route 53 doesn't check the health of the endpoint that is specified in the\n\t\t\t\tresource record set, for example, the endpoint specified by the IP address in the\n\t\t\t\t\tValue element. When you add a HealthCheckId element to\n\t\t\t\ta resource record set, Route 53 checks the health of the endpoint that you specified\n\t\t\t\tin the health check.

\n \n

For more information, see the following topics in the Amazon Route 53\n\t\t\t\tDeveloper Guide:

\n \n

\n When to Specify HealthCheckId\n

\n

Specifying a value for HealthCheckId is useful only when Route 53 is\n\t\t\tchoosing between two or more resource record sets to respond to a DNS query, and you\n\t\t\twant Route 53 to base the choice in part on the status of a health check. Configuring\n\t\t\thealth checks makes sense only in the following configurations:

\n \n

\n Geolocation Routing\n

\n

For geolocation resource record sets, if an endpoint is unhealthy, Route 53 looks for\n\t\t\ta resource record set for the larger, associated geographic region. For example, suppose\n\t\t\tyou have resource record sets for a state in the United States, for the entire United\n\t\t\tStates, for North America, and a resource record set that has * for\n\t\t\t\tCountryCode is *, which applies to all locations. If the\n\t\t\tendpoint for the state resource record set is unhealthy, Route 53 checks for healthy\n\t\t\tresource record sets in the following order until it finds a resource record set for\n\t\t\twhich the endpoint is healthy:

\n \n

\n Specifying the Health Check Endpoint by Domain\n\t\t\tName\n

\n

If your health checks specify the endpoint only by domain name, we recommend that you\n\t\t\tcreate a separate health check for each endpoint. For example, create a health check for\n\t\t\teach HTTP server that is serving content for www.example.com.\n\t\t\tFor the value of FullyQualifiedDomainName, specify the domain name of the\n\t\t\tserver (such as us-east-2-www.example.com), not the name of the resource\n\t\t\trecord sets (www.example.com).

\n \n

Health check results will be unpredictable if you do the following:

\n \n " + } + }, + "TrafficPolicyInstanceId": { + "target": "com.amazonaws.route53#TrafficPolicyInstanceId", + "traits": { + "smithy.api#documentation": "

When you create a traffic policy instance, Amazon Route 53 automatically creates a\n\t\t\tresource record set. TrafficPolicyInstanceId is the ID of the traffic\n\t\t\tpolicy instance that Route 53 created this resource record set for.

\n \n

To delete the resource record set that is associated with a traffic policy\n\t\t\t\tinstance, use DeleteTrafficPolicyInstance. Route 53 will delete the\n\t\t\t\tresource record set automatically. If you delete the resource record set by using\n\t\t\t\t\tChangeResourceRecordSets, Route 53 doesn't automatically delete the\n\t\t\t\ttraffic policy instance, and you'll continue to be charged for it even though it's\n\t\t\t\tno longer in use.

\n " + } + }, + "CidrRoutingConfig": { + "target": "com.amazonaws.route53#CidrRoutingConfig" + } + }, + "traits": { + "smithy.api#documentation": "

Information about the resource record set to create or delete.

" + } + }, + "com.amazonaws.route53#ResourceRecordSetFailover": { + "type": "enum", + "members": { + "PRIMARY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PRIMARY" + } + }, + "SECONDARY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SECONDARY" + } + } + } + }, + "com.amazonaws.route53#ResourceRecordSetIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.route53#ResourceRecordSetMultiValueAnswer": { + "type": "boolean" + }, + "com.amazonaws.route53#ResourceRecordSetRegion": { + "type": "enum", + "members": { + "us_east_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "us-east-1" + } + }, + "us_east_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "us-east-2" + } + }, + "us_west_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "us-west-1" + } + }, + "us_west_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "us-west-2" + } + }, + "ca_central_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ca-central-1" + } + }, + "eu_west_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "eu-west-1" + } + }, + "eu_west_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "eu-west-2" + } + }, + "eu_west_3": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "eu-west-3" + } + }, + "eu_central_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "eu-central-1" + } + }, + "eu_central_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "eu-central-2" + } + }, + "ap_southeast_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-southeast-1" + } + }, + "ap_southeast_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-southeast-2" + } + }, + "ap_southeast_3": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-southeast-3" + } + }, + "ap_northeast_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-northeast-1" + } + }, + "ap_northeast_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-northeast-2" + } + }, + "ap_northeast_3": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-northeast-3" + } + }, + "eu_north_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "eu-north-1" + } + }, + "sa_east_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "sa-east-1" + } + }, + "cn_north_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "cn-north-1" + } + }, + "cn_northwest_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "cn-northwest-1" + } + }, + "ap_east_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-east-1" + } + }, + "me_south_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "me-south-1" + } + }, + "me_central_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "me-central-1" + } + }, + "ap_south_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-south-1" + } + }, + "ap_south_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-south-2" + } + }, + "af_south_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "af-south-1" + } + }, + "eu_south_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "eu-south-1" + } + }, + "eu_south_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "eu-south-2" + } + }, + "ap_southeast_4": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-southeast-4" + } + } + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + } + } + }, + "com.amazonaws.route53#ResourceRecordSetWeight": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 255 + } + } + }, + "com.amazonaws.route53#ResourceRecordSets": { + "type": "list", + "member": { + "target": "com.amazonaws.route53#ResourceRecordSet", + "traits": { + "smithy.api#xmlName": "ResourceRecordSet" + } + } + }, + "com.amazonaws.route53#ResourceRecords": { + "type": "list", + "member": { + "target": "com.amazonaws.route53#ResourceRecord", + "traits": { + "smithy.api#xmlName": "ResourceRecord" + } + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.route53#ResourceTagSet": { + "type": "structure", + "members": { + "ResourceType": { + "target": "com.amazonaws.route53#TagResourceType", + "traits": { + "smithy.api#documentation": "

The type of the resource.

\n " + } + }, + "ResourceId": { + "target": "com.amazonaws.route53#TagResourceId", + "traits": { + "smithy.api#documentation": "

The ID for the specified resource.

" + } + }, + "Tags": { + "target": "com.amazonaws.route53#TagList", + "traits": { + "smithy.api#documentation": "

The tags associated with the specified resource.

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

A complex type containing a resource and its associated tags.

" + } + }, + "com.amazonaws.route53#ResourceTagSetList": { + "type": "list", + "member": { + "target": "com.amazonaws.route53#ResourceTagSet", + "traits": { + "smithy.api#xmlName": "ResourceTagSet" + } + } + }, + "com.amazonaws.route53#ResourceURI": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + } + } + }, + "com.amazonaws.route53#ReusableDelegationSetLimit": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.route53#ReusableDelegationSetLimitType", + "traits": { + "smithy.api#documentation": "

The limit that you requested: MAX_ZONES_BY_REUSABLE_DELEGATION_SET, the\n\t\t\tmaximum number of hosted zones that you can associate with the specified reusable\n\t\t\tdelegation set.

", + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.route53#LimitValue", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The current value for the MAX_ZONES_BY_REUSABLE_DELEGATION_SET\n\t\t\tlimit.

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

A complex type that contains the type of limit that you specified in the request and\n\t\t\tthe current value for that limit.

" + } + }, + "com.amazonaws.route53#ReusableDelegationSetLimitType": { + "type": "enum", + "members": { + "MAX_ZONES_BY_REUSABLE_DELEGATION_SET": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MAX_ZONES_BY_REUSABLE_DELEGATION_SET" + } + } + } + }, + "com.amazonaws.route53#RoutingControlArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "com.amazonaws.route53#SearchString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 255 + } + } + }, + "com.amazonaws.route53#ServeSignature": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + } + } + }, + "com.amazonaws.route53#ServicePrincipal": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 128 + } + } + }, + "com.amazonaws.route53#SigningKeyInteger": { + "type": "integer", + "traits": { + "smithy.api#default": 0 + } + }, + "com.amazonaws.route53#SigningKeyName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 128 + } + } + }, + "com.amazonaws.route53#SigningKeyStatus": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 5, + "max": 150 + } + } + }, + "com.amazonaws.route53#SigningKeyStatusMessage": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 512 + } + } + }, + "com.amazonaws.route53#SigningKeyString": { + "type": "string" + }, + "com.amazonaws.route53#SigningKeyTag": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0, + "max": 65536 + } + } + }, + "com.amazonaws.route53#Statistic": { + "type": "enum", + "members": { + "Average": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Average" + } + }, + "Sum": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Sum" + } + }, + "SampleCount": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SampleCount" + } + }, + "Maximum": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Maximum" + } + }, + "Minimum": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Minimum" + } + } + } + }, + "com.amazonaws.route53#Status": { + "type": "string" + }, + "com.amazonaws.route53#StatusReport": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.route53#Status", + "traits": { + "smithy.api#documentation": "

A description of the status of the health check endpoint as reported by one of the\n\t\t\tAmazon Route 53 health checkers.

" + } + }, + "CheckedTime": { + "target": "com.amazonaws.route53#TimeStamp", + "traits": { + "smithy.api#documentation": "

The date and time that the health checker performed the health check in ISO 8601 format and Coordinated\n\t\t\tUniversal Time (UTC). For example, the value 2017-03-27T17:48:16.751Z\n\t\t\trepresents March 27, 2017 at 17:48:16.751 UTC.

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

A complex type that contains the status that one Amazon Route 53 health checker\n\t\t\treports and the time of the health check.

" + } + }, + "com.amazonaws.route53#SubnetMask": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 3 + } + } + }, + "com.amazonaws.route53#TTL": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 2147483647 + } + } + }, + "com.amazonaws.route53#Tag": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.route53#TagKey", + "traits": { + "smithy.api#documentation": "

The value of Key depends on the operation that you want to\n\t\t\tperform:

\n " + } + }, + "Value": { + "target": "com.amazonaws.route53#TagValue", + "traits": { + "smithy.api#documentation": "

The value of Value depends on the operation that you want to\n\t\t\tperform:

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

A complex type that contains information about a tag that you want to add or edit for\n\t\t\tthe specified health check or hosted zone.

" + } + }, + "com.amazonaws.route53#TagKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 128 + } + } + }, + "com.amazonaws.route53#TagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.route53#TagKey", + "traits": { + "smithy.api#xmlName": "Key" + } + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.route53#TagList": { + "type": "list", + "member": { + "target": "com.amazonaws.route53#Tag", + "traits": { + "smithy.api#xmlName": "Tag" + } + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.route53#TagResourceId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 64 + } + } + }, + "com.amazonaws.route53#TagResourceIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.route53#TagResourceId", + "traits": { + "smithy.api#xmlName": "ResourceId" + } + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.route53#TagResourceType": { + "type": "enum", + "members": { + "healthcheck": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "healthcheck" + } + }, + "hostedzone": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "hostedzone" + } + } + } + }, + "com.amazonaws.route53#TagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.route53#TestDNSAnswer": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#TestDNSAnswerRequest" + }, + "output": { + "target": "com.amazonaws.route53#TestDNSAnswerResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#NoSuchHostedZone" + } + ], + "traits": { + "smithy.api#documentation": "

Gets the value that Amazon Route 53 returns in response to a DNS request for a\n\t\t\tspecified record name and type. You can optionally specify the IP address of a DNS\n\t\t\tresolver, an EDNS0 client subnet IP address, and a subnet mask.

\n

This call only supports querying public hosted zones.

", + "smithy.api#http": { + "method": "GET", + "uri": "/2013-04-01/testdnsanswer", + "code": 200 + } + } + }, + "com.amazonaws.route53#TestDNSAnswerRequest": { + "type": "structure", + "members": { + "HostedZoneId": { + "target": "com.amazonaws.route53#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the hosted zone that you want Amazon Route 53 to simulate a query\n\t\t\tfor.

", + "smithy.api#httpQuery": "hostedzoneid", + "smithy.api#required": {} + } + }, + "RecordName": { + "target": "com.amazonaws.route53#DNSName", + "traits": { + "smithy.api#documentation": "

The name of the resource record set that you want Amazon Route 53 to simulate a query\n\t\t\tfor.

", + "smithy.api#httpQuery": "recordname", + "smithy.api#required": {} + } + }, + "RecordType": { + "target": "com.amazonaws.route53#RRType", + "traits": { + "smithy.api#documentation": "

The type of the resource record set.

", + "smithy.api#httpQuery": "recordtype", + "smithy.api#required": {} + } + }, + "ResolverIP": { + "target": "com.amazonaws.route53#IPAddress", + "traits": { + "smithy.api#documentation": "

If you want to simulate a request from a specific DNS resolver, specify the IP address\n\t\t\tfor that resolver. If you omit this value, TestDnsAnswer uses the IP\n\t\t\taddress of a DNS resolver in the Amazon Web Services US East (N. Virginia) Region\n\t\t\t\t(us-east-1).

", + "smithy.api#httpQuery": "resolverip" + } + }, + "EDNS0ClientSubnetIP": { + "target": "com.amazonaws.route53#IPAddress", + "traits": { + "smithy.api#documentation": "

If the resolver that you specified for resolverip supports EDNS0, specify the IPv4 or\n\t\t\tIPv6 address of a client in the applicable location, for example,\n\t\t\t\t192.0.2.44 or 2001:db8:85a3::8a2e:370:7334.

", + "smithy.api#httpQuery": "edns0clientsubnetip" + } + }, + "EDNS0ClientSubnetMask": { + "target": "com.amazonaws.route53#SubnetMask", + "traits": { + "smithy.api#documentation": "

If you specify an IP address for edns0clientsubnetip, you can optionally\n\t\t\tspecify the number of bits of the IP address that you want the checking tool to include\n\t\t\tin the DNS query. For example, if you specify 192.0.2.44 for\n\t\t\t\tedns0clientsubnetip and 24 for\n\t\t\t\tedns0clientsubnetmask, the checking tool will simulate a request from\n\t\t\t192.0.2.0/24. The default value is 24 bits for IPv4 addresses and 64 bits for IPv6\n\t\t\taddresses.

\n

The range of valid values depends on whether edns0clientsubnetip is an\n\t\t\tIPv4 or an IPv6 address:

\n ", + "smithy.api#httpQuery": "edns0clientsubnetmask" + } + } + }, + "traits": { + "smithy.api#documentation": "

Gets the value that Amazon Route 53 returns in response to a DNS request for a\n\t\t\tspecified record name and type. You can optionally specify the IP address of a DNS\n\t\t\tresolver, an EDNS0 client subnet IP address, and a subnet mask.

" + } + }, + "com.amazonaws.route53#TestDNSAnswerResponse": { + "type": "structure", + "members": { + "Nameserver": { + "target": "com.amazonaws.route53#Nameserver", + "traits": { + "smithy.api#documentation": "

The Amazon Route 53 name server used to respond to the request.

", + "smithy.api#required": {} + } + }, + "RecordName": { + "target": "com.amazonaws.route53#DNSName", + "traits": { + "smithy.api#documentation": "

The name of the resource record set that you submitted a request for.

", + "smithy.api#required": {} + } + }, + "RecordType": { + "target": "com.amazonaws.route53#RRType", + "traits": { + "smithy.api#documentation": "

The type of the resource record set that you submitted a request for.

", + "smithy.api#required": {} + } + }, + "RecordData": { + "target": "com.amazonaws.route53#RecordData", + "traits": { + "smithy.api#documentation": "

A list that contains values that Amazon Route 53 returned for this resource record\n\t\t\tset.

", + "smithy.api#required": {} + } + }, + "ResponseCode": { + "target": "com.amazonaws.route53#DNSRCode", + "traits": { + "smithy.api#documentation": "

A code that indicates whether the request is valid or not. The most common response\n\t\t\tcode is NOERROR, meaning that the request is valid. If the response is not\n\t\t\tvalid, Amazon Route 53 returns a response code that describes the error. For a list of\n\t\t\tpossible response codes, see DNS RCODES on the IANA website.

", + "smithy.api#required": {} + } + }, + "Protocol": { + "target": "com.amazonaws.route53#TransportProtocol", + "traits": { + "smithy.api#documentation": "

The protocol that Amazon Route 53 used to respond to the request, either\n\t\t\t\tUDP or TCP.

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

A complex type that contains the response to a TestDNSAnswer request.\n\t\t

" + } + }, + "com.amazonaws.route53#Threshold": { + "type": "double" + }, + "com.amazonaws.route53#ThrottlingException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The limit on the number of requests per second was exceeded.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.route53#TimeStamp": { + "type": "timestamp" + }, + "com.amazonaws.route53#TooManyHealthChecks": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

This health check can't be created because the current account has reached the limit\n\t\t\ton the number of active health checks.

\n

For information about default limits, see Limits in the\n\t\t\t\tAmazon Route 53 Developer Guide.

\n

For information about how to get the current limit for an account, see GetAccountLimit. To request a higher limit, create a case with the Amazon Web Services Support\n\t\t\tCenter.

\n

You have reached the maximum number of active health checks for an Amazon Web Services account. To request a higher limit, create a case with the Amazon Web Services Support\n\t\t\tCenter.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.route53#TooManyHostedZones": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage", + "traits": { + "smithy.api#documentation": "

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

This operation can't be completed either because the current account has reached the\n\t\t\tlimit on the number of hosted zones or because you've reached the limit on the number of\n\t\t\thosted zones that can be associated with a reusable delegation set.

\n

For information about default limits, see Limits in the\n\t\t\t\tAmazon Route 53 Developer Guide.

\n

To get the current limit on hosted zones that can be created by an account, see GetAccountLimit.

\n

To get the current limit on hosted zones that can be associated with a reusable\n\t\t\tdelegation set, see GetReusableDelegationSetLimit.

\n

To request a higher limit, create a\n\t\t\t\tcase with the Amazon Web Services Support Center.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.route53#TooManyKeySigningKeys": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

You've reached the limit for the number of key-signing keys (KSKs). Remove at least\n\t\t\tone KSK, and then try again.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.route53#TooManyTrafficPolicies": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage", + "traits": { + "smithy.api#documentation": "

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

This traffic policy can't be created because the current account has reached the limit\n\t\t\ton the number of traffic policies.

\n

For information about default limits, see Limits in the\n\t\t\t\tAmazon Route 53 Developer Guide.

\n

To get the current limit for an account, see GetAccountLimit.

\n

To request a higher limit, create a\n\t\t\t\tcase with the Amazon Web Services Support Center.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.route53#TooManyTrafficPolicyInstances": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage", + "traits": { + "smithy.api#documentation": "

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

This traffic policy instance can't be created because the current account has reached\n\t\t\tthe limit on the number of traffic policy instances.

\n

For information about default limits, see Limits in the\n\t\t\t\tAmazon Route 53 Developer Guide.

\n

For information about how to get the current limit for an account, see GetAccountLimit.

\n

To request a higher limit, create a\n\t\t\t\tcase with the Amazon Web Services Support Center.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.route53#TooManyTrafficPolicyVersionsForCurrentPolicy": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage", + "traits": { + "smithy.api#documentation": "

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

This traffic policy version can't be created because you've reached the limit of 1000\n\t\t\ton the number of versions that you can create for the current traffic policy.

\n

To create more traffic policy versions, you can use GetTrafficPolicy\n\t\t\tto get the traffic policy document for a specified traffic policy version, and then use\n\t\t\t\tCreateTrafficPolicy to create a new traffic policy using the traffic policy\n\t\t\tdocument.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.route53#TooManyVPCAssociationAuthorizations": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage", + "traits": { + "smithy.api#documentation": "

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

You've created the maximum number of authorizations that can be created for the\n\t\t\tspecified hosted zone. To authorize another VPC to be associated with the hosted zone,\n\t\t\tsubmit a DeleteVPCAssociationAuthorization request to remove an existing\n\t\t\tauthorization. To get a list of existing authorizations, submit a\n\t\t\t\tListVPCAssociationAuthorizations request.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.route53#TrafficPolicies": { + "type": "list", + "member": { + "target": "com.amazonaws.route53#TrafficPolicy", + "traits": { + "smithy.api#xmlName": "TrafficPolicy" + } + } + }, + "com.amazonaws.route53#TrafficPolicy": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.route53#TrafficPolicyId", + "traits": { + "smithy.api#documentation": "

The ID that Amazon Route 53 assigned to a traffic policy when you created it.

", + "smithy.api#required": {} + } + }, + "Version": { + "target": "com.amazonaws.route53#TrafficPolicyVersion", + "traits": { + "smithy.api#documentation": "

The version number that Amazon Route 53 assigns to a traffic policy. For a new traffic\n\t\t\tpolicy, the value of Version is always 1.

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.route53#TrafficPolicyName", + "traits": { + "smithy.api#documentation": "

The name that you specified when you created the traffic policy.

", + "smithy.api#required": {} + } + }, + "Type": { + "target": "com.amazonaws.route53#RRType", + "traits": { + "smithy.api#documentation": "

The DNS type of the resource record sets that Amazon Route 53 creates when you use a\n\t\t\ttraffic policy to create a traffic policy instance.

", + "smithy.api#required": {} + } + }, + "Document": { + "target": "com.amazonaws.route53#TrafficPolicyDocument", + "traits": { + "smithy.api#documentation": "

The definition of a traffic policy in JSON format. You specify the JSON document to\n\t\t\tuse for a new traffic policy in the CreateTrafficPolicy request. For more\n\t\t\tinformation about the JSON format, see Traffic Policy Document Format.

", + "smithy.api#required": {} + } + }, + "Comment": { + "target": "com.amazonaws.route53#TrafficPolicyComment", + "traits": { + "smithy.api#documentation": "

The comment that you specify in the CreateTrafficPolicy request, if\n\t\t\tany.

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

A complex type that contains settings for a traffic policy.

" + } + }, + "com.amazonaws.route53#TrafficPolicyAlreadyExists": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage", + "traits": { + "smithy.api#documentation": "

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

A traffic policy that has the same value for Name already exists.

", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.route53#TrafficPolicyComment": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + } + } + }, + "com.amazonaws.route53#TrafficPolicyDocument": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 102400 + } + } + }, + "com.amazonaws.route53#TrafficPolicyId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 36 + } + } + }, + "com.amazonaws.route53#TrafficPolicyInUse": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage", + "traits": { + "smithy.api#documentation": "

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

One or more traffic policy instances were created by using the specified traffic\n\t\t\tpolicy.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.route53#TrafficPolicyInstance": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.route53#TrafficPolicyInstanceId", + "traits": { + "smithy.api#documentation": "

The ID that Amazon Route 53 assigned to the new traffic policy instance.

", + "smithy.api#required": {} + } + }, + "HostedZoneId": { + "target": "com.amazonaws.route53#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the hosted zone that Amazon Route 53 created resource record sets in.

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.route53#DNSName", + "traits": { + "smithy.api#documentation": "

The DNS name, such as www.example.com, for which Amazon Route 53 responds to queries\n\t\t\tby using the resource record sets that are associated with this traffic policy instance.\n\t\t

", + "smithy.api#required": {} + } + }, + "TTL": { + "target": "com.amazonaws.route53#TTL", + "traits": { + "smithy.api#documentation": "

The TTL that Amazon Route 53 assigned to all of the resource record sets that it\n\t\t\tcreated in the specified hosted zone.

", + "smithy.api#required": {} + } + }, + "State": { + "target": "com.amazonaws.route53#TrafficPolicyInstanceState", + "traits": { + "smithy.api#documentation": "

The value of State is one of the following values:

\n
\n
Applied
\n
\n

Amazon Route 53 has finished creating resource record sets, and changes\n\t\t\t\t\t\thave propagated to all Route 53 edge locations.

\n
\n
Creating
\n
\n

Route 53 is creating the resource record sets. Use\n\t\t\t\t\t\t\tGetTrafficPolicyInstance to confirm that the\n\t\t\t\t\t\t\tCreateTrafficPolicyInstance request completed\n\t\t\t\t\t\tsuccessfully.

\n
\n
Failed
\n
\n

Route 53 wasn't able to create or update the resource record sets. When\n\t\t\t\t\t\tthe value of State is Failed, see\n\t\t\t\t\t\t\tMessage for an explanation of what caused the request to\n\t\t\t\t\t\tfail.

\n
\n
", + "smithy.api#required": {} + } + }, + "Message": { + "target": "com.amazonaws.route53#Message", + "traits": { + "smithy.api#documentation": "

If State is Failed, an explanation of the reason for the\n\t\t\tfailure. If State is another value, Message is empty.

", + "smithy.api#required": {} + } + }, + "TrafficPolicyId": { + "target": "com.amazonaws.route53#TrafficPolicyId", + "traits": { + "smithy.api#documentation": "

The ID of the traffic policy that Amazon Route 53 used to create resource record sets\n\t\t\tin the specified hosted zone.

", + "smithy.api#required": {} + } + }, + "TrafficPolicyVersion": { + "target": "com.amazonaws.route53#TrafficPolicyVersion", + "traits": { + "smithy.api#documentation": "

The version of the traffic policy that Amazon Route 53 used to create resource record\n\t\t\tsets in the specified hosted zone.

", + "smithy.api#required": {} + } + }, + "TrafficPolicyType": { + "target": "com.amazonaws.route53#RRType", + "traits": { + "smithy.api#documentation": "

The DNS type that Amazon Route 53 assigned to all of the resource record sets that it\n\t\t\tcreated for this traffic policy instance.

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

A complex type that contains settings for the new traffic policy instance.

" + } + }, + "com.amazonaws.route53#TrafficPolicyInstanceAlreadyExists": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage", + "traits": { + "smithy.api#documentation": "

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

There is already a traffic policy instance with the specified ID.

", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.route53#TrafficPolicyInstanceCount": { + "type": "integer" + }, + "com.amazonaws.route53#TrafficPolicyInstanceId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 36 + } + } + }, + "com.amazonaws.route53#TrafficPolicyInstanceState": { + "type": "string" + }, + "com.amazonaws.route53#TrafficPolicyInstances": { + "type": "list", + "member": { + "target": "com.amazonaws.route53#TrafficPolicyInstance", + "traits": { + "smithy.api#xmlName": "TrafficPolicyInstance" + } + } + }, + "com.amazonaws.route53#TrafficPolicyName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 512 + } + } + }, + "com.amazonaws.route53#TrafficPolicySummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.route53#TrafficPolicySummary", + "traits": { + "smithy.api#xmlName": "TrafficPolicySummary" + } + } + }, + "com.amazonaws.route53#TrafficPolicySummary": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.route53#TrafficPolicyId", + "traits": { + "smithy.api#documentation": "

The ID that Amazon Route 53 assigned to the traffic policy when you created it.

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.route53#TrafficPolicyName", + "traits": { + "smithy.api#documentation": "

The name that you specified for the traffic policy when you created it.

", + "smithy.api#required": {} + } + }, + "Type": { + "target": "com.amazonaws.route53#RRType", + "traits": { + "smithy.api#documentation": "

The DNS type of the resource record sets that Amazon Route 53 creates when you use a\n\t\t\ttraffic policy to create a traffic policy instance.

", + "smithy.api#required": {} + } + }, + "LatestVersion": { + "target": "com.amazonaws.route53#TrafficPolicyVersion", + "traits": { + "smithy.api#documentation": "

The version number of the latest version of the traffic policy.

", + "smithy.api#required": {} + } + }, + "TrafficPolicyCount": { + "target": "com.amazonaws.route53#TrafficPolicyVersion", + "traits": { + "smithy.api#documentation": "

The number of traffic policies that are associated with the current Amazon Web Services account.

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

A complex type that contains information about the latest version of one traffic\n\t\t\tpolicy that is associated with the current Amazon Web Services account.

" + } + }, + "com.amazonaws.route53#TrafficPolicyVersion": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.route53#TrafficPolicyVersionMarker": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 4 + } + } + }, + "com.amazonaws.route53#TransportProtocol": { + "type": "string" + }, + "com.amazonaws.route53#UUID": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$" + } + }, + "com.amazonaws.route53#UpdateHealthCheck": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#UpdateHealthCheckRequest" + }, + "output": { + "target": "com.amazonaws.route53#UpdateHealthCheckResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#HealthCheckVersionMismatch" + }, + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#NoSuchHealthCheck" + } + ], + "traits": { + "smithy.api#documentation": "

Updates an existing health check. Note that some values can't be updated.

\n

For more information about updating health checks, see Creating,\n\t\t\t\tUpdating, and Deleting Health Checks in the Amazon Route 53\n\t\t\t\tDeveloper Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/2013-04-01/healthcheck/{HealthCheckId}", + "code": 200 + } + } + }, + "com.amazonaws.route53#UpdateHealthCheckRequest": { + "type": "structure", + "members": { + "HealthCheckId": { + "target": "com.amazonaws.route53#HealthCheckId", + "traits": { + "smithy.api#documentation": "

The ID for the health check for which you want detailed information. When you created\n\t\t\tthe health check, CreateHealthCheck returned the ID in the response, in the\n\t\t\t\tHealthCheckId element.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "HealthCheckVersion": { + "target": "com.amazonaws.route53#HealthCheckVersion", + "traits": { + "smithy.api#documentation": "

A sequential counter that Amazon Route 53 sets to 1 when you create a\n\t\t\thealth check and increments by 1 each time you update settings for the health\n\t\t\tcheck.

\n

We recommend that you use GetHealthCheck or ListHealthChecks\n\t\t\tto get the current value of HealthCheckVersion for the health check that\n\t\t\tyou want to update, and that you include that value in your\n\t\t\t\tUpdateHealthCheck request. This prevents Route 53 from overwriting an\n\t\t\tintervening update:

\n " + } + }, + "IPAddress": { + "target": "com.amazonaws.route53#IPAddress", + "traits": { + "smithy.api#documentation": "

The IPv4 or IPv6 IP address for the endpoint that you want Amazon Route 53 to perform\n\t\t\thealth checks on. If you don't specify a value for IPAddress, Route 53\n\t\t\tsends a DNS request to resolve the domain name that you specify in\n\t\t\t\tFullyQualifiedDomainName at the interval that you specify in\n\t\t\t\tRequestInterval. Using an IP address that is returned by DNS, Route 53\n\t\t\tthen checks the health of the endpoint.

\n

Use one of the following formats for the value of IPAddress:

\n \n

If the endpoint is an EC2 instance, we recommend that you create an Elastic IP\n\t\t\taddress, associate it with your EC2 instance, and specify the Elastic IP address for\n\t\t\t\tIPAddress. This ensures that the IP address of your instance never\n\t\t\tchanges. For more information, see the applicable documentation:

\n \n \n

If a health check already has a value for IPAddress, you can change\n\t\t\t\tthe value. However, you can't update an existing health check to add or remove the\n\t\t\t\tvalue of IPAddress.

\n \n

For more information, see FullyQualifiedDomainName.

\n

Constraints: Route 53 can't check the health of endpoints for which the IP address is\n\t\t\tin local, private, non-routable, or multicast ranges. For more information about IP\n\t\t\taddresses for which you can't create health checks, see the following documents:

\n " + } + }, + "Port": { + "target": "com.amazonaws.route53#Port", + "traits": { + "smithy.api#documentation": "

The port on the endpoint that you want Amazon Route 53 to perform health checks\n\t\t\ton.

\n \n

Don't specify a value for Port when you specify a value for\n\t\t\t\t\tType of CLOUDWATCH_METRIC or\n\t\t\t\tCALCULATED.

\n " + } + }, + "ResourcePath": { + "target": "com.amazonaws.route53#ResourcePath", + "traits": { + "smithy.api#documentation": "

The path that you want Amazon Route 53 to request when performing health checks. The\n\t\t\tpath can be any value for which your endpoint will return an HTTP status code of 2xx or\n\t\t\t3xx when the endpoint is healthy, for example the file /docs/route53-health-check.html.\n\t\t\tYou can also include query string parameters, for example,\n\t\t\t\t/welcome.html?language=jp&login=y.

\n

Specify this value only if you want to change it.

" + } + }, + "FullyQualifiedDomainName": { + "target": "com.amazonaws.route53#FullyQualifiedDomainName", + "traits": { + "smithy.api#documentation": "

Amazon Route 53 behavior depends on whether you specify a value for\n\t\t\t\tIPAddress.

\n \n

If a health check already has a value for IPAddress, you can change\n\t\t\t\tthe value. However, you can't update an existing health check to add or remove the\n\t\t\t\tvalue of IPAddress.

\n \n

\n If you specify a value for\n IPAddress:

\n

Route 53 sends health check requests to the specified IPv4 or IPv6 address and passes\n\t\t\tthe value of FullyQualifiedDomainName in the Host header for\n\t\t\tall health checks except TCP health checks. This is typically the fully qualified DNS\n\t\t\tname of the endpoint on which you want Route 53 to perform health checks.

\n

When Route 53 checks the health of an endpoint, here is how it constructs the\n\t\t\t\tHost header:

\n \n

If you don't specify a value for FullyQualifiedDomainName, Route 53\n\t\t\tsubstitutes the value of IPAddress in the Host header in each\n\t\t\tof the above cases.

\n

\n If you don't specify a value for\n IPAddress:

\n

If you don't specify a value for IPAddress, Route 53 sends a DNS request\n\t\t\tto the domain that you specify in FullyQualifiedDomainName at the interval\n\t\t\tyou specify in RequestInterval. Using an IPv4 address that is returned by\n\t\t\tDNS, Route 53 then checks the health of the endpoint.

\n \n

If you don't specify a value for IPAddress, Route 53 uses only IPv4\n\t\t\t\tto send health checks to the endpoint. If there's no resource record set with a type\n\t\t\t\tof A for the name that you specify for FullyQualifiedDomainName, the\n\t\t\t\thealth check fails with a \"DNS resolution failed\" error.

\n \n

If you want to check the health of weighted, latency, or failover resource record sets\n\t\t\tand you choose to specify the endpoint only by FullyQualifiedDomainName, we\n\t\t\trecommend that you create a separate health check for each endpoint. For example, create\n\t\t\ta health check for each HTTP server that is serving content for www.example.com. For the\n\t\t\tvalue of FullyQualifiedDomainName, specify the domain name of the server\n\t\t\t(such as us-east-2-www.example.com), not the name of the resource record\n\t\t\tsets (www.example.com).

\n \n

In this configuration, if the value of FullyQualifiedDomainName\n\t\t\t\tmatches the name of the resource record sets and you then associate the health check\n\t\t\t\twith those resource record sets, health check results will be unpredictable.

\n \n

In addition, if the value of Type is HTTP,\n\t\t\t\tHTTPS, HTTP_STR_MATCH, or HTTPS_STR_MATCH,\n\t\t\tRoute 53 passes the value of FullyQualifiedDomainName in the\n\t\t\t\tHost header, as it does when you specify a value for\n\t\t\t\tIPAddress. If the value of Type is TCP, Route\n\t\t\t53 doesn't pass a Host header.

" + } + }, + "SearchString": { + "target": "com.amazonaws.route53#SearchString", + "traits": { + "smithy.api#documentation": "

If the value of Type is HTTP_STR_MATCH or\n\t\t\t\tHTTPS_STR_MATCH, the string that you want Amazon Route 53 to search for\n\t\t\tin the response body from the specified resource. If the string appears in the response\n\t\t\tbody, Route 53 considers the resource healthy. (You can't change the value of\n\t\t\t\tType when you update a health check.)

" + } + }, + "FailureThreshold": { + "target": "com.amazonaws.route53#FailureThreshold", + "traits": { + "smithy.api#documentation": "

The number of consecutive health checks that an endpoint must pass or fail for Amazon\n\t\t\tRoute 53 to change the current status of the endpoint from unhealthy to healthy or vice\n\t\t\tversa. For more information, see How Amazon Route 53 Determines Whether an Endpoint Is Healthy in the\n\t\t\t\tAmazon Route 53 Developer Guide.

\n

If you don't specify a value for FailureThreshold, the default value is\n\t\t\tthree health checks.

" + } + }, + "Inverted": { + "target": "com.amazonaws.route53#Inverted", + "traits": { + "smithy.api#documentation": "

Specify whether you want Amazon Route 53 to invert the status of a health check, for\n\t\t\texample, to consider a health check unhealthy when it otherwise would be considered\n\t\t\thealthy.

" + } + }, + "Disabled": { + "target": "com.amazonaws.route53#Disabled", + "traits": { + "smithy.api#documentation": "

Stops Route 53 from performing health checks. When you disable a health check, here's\n\t\t\twhat happens:

\n \n

After you disable a health check, Route 53 considers the status of the health check to\n\t\t\talways be healthy. If you configured DNS failover, Route 53 continues to route traffic\n\t\t\tto the corresponding resources. If you want to stop routing traffic to a resource,\n\t\t\tchange the value of Inverted.

\n

Charges for a health check still apply when the health check is disabled. For more\n\t\t\tinformation, see Amazon Route 53\n\t\t\t\tPricing.

" + } + }, + "HealthThreshold": { + "target": "com.amazonaws.route53#HealthThreshold", + "traits": { + "smithy.api#documentation": "

The number of child health checks that are associated with a CALCULATED\n\t\t\thealth that Amazon Route 53 must consider healthy for the CALCULATED health\n\t\t\tcheck to be considered healthy. To specify the child health checks that you want to\n\t\t\tassociate with a CALCULATED health check, use the\n\t\t\t\tChildHealthChecks and ChildHealthCheck elements.

\n

Note the following:

\n " + } + }, + "ChildHealthChecks": { + "target": "com.amazonaws.route53#ChildHealthCheckList", + "traits": { + "smithy.api#documentation": "

A complex type that contains one ChildHealthCheck element for each health\n\t\t\tcheck that you want to associate with a CALCULATED health check.

" + } + }, + "EnableSNI": { + "target": "com.amazonaws.route53#EnableSNI", + "traits": { + "smithy.api#documentation": "

Specify whether you want Amazon Route 53 to send the value of\n\t\t\t\tFullyQualifiedDomainName to the endpoint in the\n\t\t\t\tclient_hello message during TLS negotiation. This allows\n\t\t\tthe endpoint to respond to HTTPS health check requests with the applicable\n\t\t\tSSL/TLS certificate.

\n

Some endpoints require that HTTPS requests include the host name in the\n\t\t\t\tclient_hello message. If you don't enable SNI, the status of the health\n\t\t\tcheck will be SSL alert handshake_failure. A health check can also have\n\t\t\tthat status for other reasons. If SNI is enabled and you're still getting the error,\n\t\t\tcheck the SSL/TLS configuration on your endpoint and confirm that your certificate is\n\t\t\tvalid.

\n

The SSL/TLS certificate on your endpoint includes a domain name in the Common\n\t\t\t\tName field and possibly several more in the Subject Alternative\n\t\t\t\tNames field. One of the domain names in the certificate should match the\n\t\t\tvalue that you specify for FullyQualifiedDomainName. If the endpoint\n\t\t\tresponds to the client_hello message with a certificate that does not\n\t\t\tinclude the domain name that you specified in FullyQualifiedDomainName, a\n\t\t\thealth checker will retry the handshake. In the second attempt, the health checker will\n\t\t\tomit FullyQualifiedDomainName from the client_hello\n\t\t\tmessage.

" + } + }, + "Regions": { + "target": "com.amazonaws.route53#HealthCheckRegionList", + "traits": { + "smithy.api#documentation": "

A complex type that contains one Region element for each region that you\n\t\t\twant Amazon Route 53 health checkers to check the specified endpoint from.

" + } + }, + "AlarmIdentifier": { + "target": "com.amazonaws.route53#AlarmIdentifier", + "traits": { + "smithy.api#documentation": "

A complex type that identifies the CloudWatch alarm that you want Amazon Route 53\n\t\t\thealth checkers to use to determine whether the specified health check is\n\t\t\thealthy.

" + } + }, + "InsufficientDataHealthStatus": { + "target": "com.amazonaws.route53#InsufficientDataHealthStatus", + "traits": { + "smithy.api#documentation": "

When CloudWatch has insufficient data about the metric to determine the alarm state,\n\t\t\tthe status that you want Amazon Route 53 to assign to the health check:

\n " + } + }, + "ResetElements": { + "target": "com.amazonaws.route53#ResettableElementNameList", + "traits": { + "smithy.api#documentation": "

A complex type that contains one ResettableElementName element for each\n\t\t\telement that you want to reset to the default value. Valid values for\n\t\t\t\tResettableElementName include the following:

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

A complex type that contains information about a request to update a health\n\t\t\tcheck.

" + } + }, + "com.amazonaws.route53#UpdateHealthCheckResponse": { + "type": "structure", + "members": { + "HealthCheck": { + "target": "com.amazonaws.route53#HealthCheck", + "traits": { + "smithy.api#documentation": "

A complex type that contains the response to an UpdateHealthCheck\n\t\t\trequest.

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

A complex type that contains the response to the UpdateHealthCheck\n\t\t\trequest.

" + } + }, + "com.amazonaws.route53#UpdateHostedZoneComment": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#UpdateHostedZoneCommentRequest" + }, + "output": { + "target": "com.amazonaws.route53#UpdateHostedZoneCommentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#NoSuchHostedZone" + }, + { + "target": "com.amazonaws.route53#PriorRequestNotComplete" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the comment for a specified hosted zone.

", + "smithy.api#http": { + "method": "POST", + "uri": "/2013-04-01/hostedzone/{Id}", + "code": 200 + } + } + }, + "com.amazonaws.route53#UpdateHostedZoneCommentRequest": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.route53#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID for the hosted zone that you want to update the comment for.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Comment": { + "target": "com.amazonaws.route53#ResourceDescription", + "traits": { + "smithy.api#documentation": "

The new comment for the hosted zone. If you don't specify a value for\n\t\t\t\tComment, Amazon Route 53 deletes the existing value of the\n\t\t\t\tComment element, if any.

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

A request to update the comment for a hosted zone.

" + } + }, + "com.amazonaws.route53#UpdateHostedZoneCommentResponse": { + "type": "structure", + "members": { + "HostedZone": { + "target": "com.amazonaws.route53#HostedZone", + "traits": { + "smithy.api#documentation": "

A complex type that contains the response to the UpdateHostedZoneComment\n\t\t\trequest.

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

A complex type that contains the response to the UpdateHostedZoneComment\n\t\t\trequest.

" + } + }, + "com.amazonaws.route53#UpdateTrafficPolicyComment": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#UpdateTrafficPolicyCommentRequest" + }, + "output": { + "target": "com.amazonaws.route53#UpdateTrafficPolicyCommentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#ConcurrentModification" + }, + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#NoSuchTrafficPolicy" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the comment for a specified traffic policy version.

", + "smithy.api#http": { + "method": "POST", + "uri": "/2013-04-01/trafficpolicy/{Id}/{Version}", + "code": 200 + } + } + }, + "com.amazonaws.route53#UpdateTrafficPolicyCommentRequest": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.route53#TrafficPolicyId", + "traits": { + "smithy.api#documentation": "

The value of Id for the traffic policy that you want to update the\n\t\t\tcomment for.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Version": { + "target": "com.amazonaws.route53#TrafficPolicyVersion", + "traits": { + "smithy.api#documentation": "

The value of Version for the traffic policy that you want to update the\n\t\t\tcomment for.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Comment": { + "target": "com.amazonaws.route53#TrafficPolicyComment", + "traits": { + "smithy.api#documentation": "

The new comment for the specified traffic policy and version.

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

A complex type that contains information about the traffic policy that you want to\n\t\t\tupdate the comment for.

" + } + }, + "com.amazonaws.route53#UpdateTrafficPolicyCommentResponse": { + "type": "structure", + "members": { + "TrafficPolicy": { + "target": "com.amazonaws.route53#TrafficPolicy", + "traits": { + "smithy.api#documentation": "

A complex type that contains settings for the specified traffic policy.

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

A complex type that contains the response information for the traffic policy.

" + } + }, + "com.amazonaws.route53#UpdateTrafficPolicyInstance": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#UpdateTrafficPolicyInstanceRequest" + }, + "output": { + "target": "com.amazonaws.route53#UpdateTrafficPolicyInstanceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#ConflictingTypes" + }, + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#NoSuchTrafficPolicy" + }, + { + "target": "com.amazonaws.route53#NoSuchTrafficPolicyInstance" + }, + { + "target": "com.amazonaws.route53#PriorRequestNotComplete" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the resource record sets in a specified hosted zone that were created based on\n\t\t\tthe settings in a specified traffic policy version.

\n

When you update a traffic policy instance, Amazon Route 53 continues to respond to DNS\n\t\t\tqueries for the root resource record set name (such as example.com) while it replaces\n\t\t\tone group of resource record sets with another. Route 53 performs the following\n\t\t\toperations:

\n
    \n
  1. \n

    Route 53 creates a new group of resource record sets based on the specified\n\t\t\t\t\ttraffic policy. This is true regardless of how significant the differences are\n\t\t\t\t\tbetween the existing resource record sets and the new resource record sets.\n\t\t\t\t

    \n
    2. \n
  2. \n

    When all of the new resource record sets have been created, Route 53 starts to\n\t\t\t\t\trespond to DNS queries for the root resource record set name (such as\n\t\t\t\t\texample.com) by using the new resource record sets.

    \n
    3. \n
  3. \n

    Route 53 deletes the old group of resource record sets that are associated\n\t\t\t\t\twith the root resource record set name.

    \n
    4. \n
", + "smithy.api#http": { + "method": "POST", + "uri": "/2013-04-01/trafficpolicyinstance/{Id}", + "code": 200 + } + } + }, + "com.amazonaws.route53#UpdateTrafficPolicyInstanceRequest": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.route53#TrafficPolicyInstanceId", + "traits": { + "smithy.api#documentation": "

The ID of the traffic policy instance that you want to update.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "TTL": { + "target": "com.amazonaws.route53#TTL", + "traits": { + "smithy.api#documentation": "

The TTL that you want Amazon Route 53 to assign to all of the updated resource record\n\t\t\tsets.

", + "smithy.api#required": {} + } + }, + "TrafficPolicyId": { + "target": "com.amazonaws.route53#TrafficPolicyId", + "traits": { + "smithy.api#documentation": "

The ID of the traffic policy that you want Amazon Route 53 to use to update resource\n\t\t\trecord sets for the specified traffic policy instance.

", + "smithy.api#required": {} + } + }, + "TrafficPolicyVersion": { + "target": "com.amazonaws.route53#TrafficPolicyVersion", + "traits": { + "smithy.api#documentation": "

The version of the traffic policy that you want Amazon Route 53 to use to update\n\t\t\tresource record sets for the specified traffic policy instance.

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

A complex type that contains information about the resource record sets that you want\n\t\t\tto update based on a specified traffic policy instance.

" + } + }, + "com.amazonaws.route53#UpdateTrafficPolicyInstanceResponse": { + "type": "structure", + "members": { + "TrafficPolicyInstance": { + "target": "com.amazonaws.route53#TrafficPolicyInstance", + "traits": { + "smithy.api#documentation": "

A complex type that contains settings for the updated traffic policy instance.

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

A complex type that contains information about the resource record sets that Amazon\n\t\t\tRoute 53 created based on a specified traffic policy.

" + } + }, + "com.amazonaws.route53#UsageCount": { + "type": "long", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.route53#VPC": { + "type": "structure", + "members": { + "VPCRegion": { + "target": "com.amazonaws.route53#VPCRegion", + "traits": { + "smithy.api#documentation": "

(Private hosted zones only) The region that an Amazon VPC was created\n\t\t\tin.

" + } + }, + "VPCId": { + "target": "com.amazonaws.route53#VPCId" + } + }, + "traits": { + "smithy.api#documentation": "

(Private hosted zones only) A complex type that contains information about an Amazon VPC.

\n

If you associate a private hosted zone with an Amazon VPC when you make a\n\t\t\t\tCreateHostedZone\n\t\t\trequest, the following parameters are also required.

" + } + }, + "com.amazonaws.route53#VPCAssociationAuthorizationNotFound": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage", + "traits": { + "smithy.api#documentation": "

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

The VPC that you specified is not authorized to be associated with the hosted\n\t\t\tzone.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.route53#VPCAssociationNotFound": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage", + "traits": { + "smithy.api#documentation": "

The specified VPC or hosted zone weren't found.

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

The specified VPC and hosted zone are not currently associated.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.route53#VPCId": { + "type": "string", + "traits": { + "smithy.api#documentation": "

(Private hosted zones only) The ID of an Amazon VPC.

", + "smithy.api#length": { + "min": 0, + "max": 1024 + } + } + }, + "com.amazonaws.route53#VPCRegion": { + "type": "enum", + "members": { + "us_east_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "us-east-1" + } + }, + "us_east_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "us-east-2" + } + }, + "us_west_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "us-west-1" + } + }, + "us_west_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "us-west-2" + } + }, + "eu_west_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "eu-west-1" + } + }, + "eu_west_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "eu-west-2" + } + }, + "eu_west_3": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "eu-west-3" + } + }, + "eu_central_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "eu-central-1" + } + }, + "eu_central_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "eu-central-2" + } + }, + "ap_east_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-east-1" + } + }, + "me_south_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "me-south-1" + } + }, + "us_gov_west_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "us-gov-west-1" + } + }, + "us_gov_east_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "us-gov-east-1" + } + }, + "us_iso_east_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "us-iso-east-1" + } + }, + "us_iso_west_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "us-iso-west-1" + } + }, + "us_isob_east_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "us-isob-east-1" + } + }, + "me_central_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "me-central-1" + } + }, + "ap_southeast_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-southeast-1" + } + }, + "ap_southeast_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-southeast-2" + } + }, + "ap_southeast_3": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-southeast-3" + } + }, + "ap_south_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-south-1" + } + }, + "ap_south_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-south-2" + } + }, + "ap_northeast_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-northeast-1" + } + }, + "ap_northeast_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-northeast-2" + } + }, + "ap_northeast_3": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-northeast-3" + } + }, + "eu_north_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "eu-north-1" + } + }, + "sa_east_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "sa-east-1" + } + }, + "ca_central_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ca-central-1" + } + }, + "cn_north_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "cn-north-1" + } + }, + "af_south_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "af-south-1" + } + }, + "eu_south_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "eu-south-1" + } + }, + "eu_south_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "eu-south-2" + } + }, + "ap_southeast_4": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-southeast-4" + } + } + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + } + } + }, + "com.amazonaws.route53#VPCs": { + "type": "list", + "member": { + "target": "com.amazonaws.route53#VPC", + "traits": { + "smithy.api#xmlName": "VPC" + } + }, + "traits": { + "smithy.api#documentation": "

(Private hosted zones only) A list of VPC elements.

", + "smithy.api#length": { + "min": 1 + } + } } - } } - } } diff --git a/codegen/sdk-codegen/aws-models/ssm-sap.json b/codegen/sdk-codegen/aws-models/ssm-sap.json index f1dafad1171a..e706ce07eca9 100644 --- a/codegen/sdk-codegen/aws-models/ssm-sap.json +++ b/codegen/sdk-codegen/aws-models/ssm-sap.json @@ -1,2584 +1,2772 @@ { - "smithy": "2.0", - "shapes": { - "com.amazonaws.ssmsap#AppRegistryArn": { - "type": "string", - "traits": { - "smithy.api#pattern": "^arn:aws:servicecatalog:[a-z0-9:\\/-]+$" - } - }, - "com.amazonaws.ssmsap#Application": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.ssmsap#ApplicationId", - "traits": { - "smithy.api#documentation": "

" - } - }, - "Type": { - "target": "com.amazonaws.ssmsap#ApplicationType", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "AppRegistryArn": { - "target": "com.amazonaws.ssmsap#AppRegistryArn", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "Components": { - "target": "com.amazonaws.ssmsap#ComponentIdList", - "traits": { - "smithy.api#documentation": "

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

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

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

" - } - }, - "com.amazonaws.ssmsap#ApplicationCredential": { - "type": "structure", - "members": { - "DatabaseName": { - "target": "com.amazonaws.ssmsap#DatabaseName", - "traits": { - "smithy.api#documentation": "

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

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

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

" - } - }, - "com.amazonaws.ssmsap#ApplicationCredentialList": { - "type": "list", - "member": { - "target": "com.amazonaws.ssmsap#ApplicationCredential" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 20 - } - } - }, - "com.amazonaws.ssmsap#ApplicationId": { - "type": "string", - "traits": { - "smithy.api#pattern": "^[\\w\\d]{1,50}$" - } - }, - "com.amazonaws.ssmsap#ApplicationStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ACTIVATED", - "name": "ACTIVATED" - }, - { - "value": "STARTING", - "name": "STARTING" - }, - { - "value": "STOPPED", - "name": "STOPPED" - }, - { - "value": "STOPPING", - "name": "STOPPING" - }, - { - "value": "FAILED", - "name": "FAILED" - }, - { - "value": "REGISTERING", - "name": "REGISTERING" - }, - { - "value": "DELETING", - "name": "DELETING" - }, - { - "value": "UNKNOWN", - "name": "UNKNOWN" - } - ] - } - }, - "com.amazonaws.ssmsap#ApplicationSummary": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.ssmsap#ApplicationId", - "traits": { - "smithy.api#documentation": "

" - } - }, - "Type": { - "target": "com.amazonaws.ssmsap#ApplicationType", - "traits": { - "smithy.api#documentation": "

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

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

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

" - } - }, - "com.amazonaws.ssmsap#ApplicationSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.ssmsap#ApplicationSummary" - } - }, - "com.amazonaws.ssmsap#ApplicationType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "HANA", - "name": "HANA" - } - ] - } - }, - "com.amazonaws.ssmsap#Arn": { - "type": "string", - "traits": { - "smithy.api#pattern": "^arn:(.+:){2,4}.+$|^arn:(.+:){1,3}.+\\/.+$" - } - }, - "com.amazonaws.ssmsap#Component": { - "type": "structure", - "members": { - "ComponentId": { - "target": "com.amazonaws.ssmsap#ComponentId", - "traits": { - "smithy.api#documentation": "

" - } - }, - "ApplicationId": { - "target": "com.amazonaws.ssmsap#ApplicationId", - "traits": { - "smithy.api#documentation": "

" - } - }, - "ComponentType": { - "target": "com.amazonaws.ssmsap#ComponentType", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "Databases": { - "target": "com.amazonaws.ssmsap#DatabaseIdList", - "traits": { - "smithy.api#documentation": "

" - } - }, - "Hosts": { - "target": "com.amazonaws.ssmsap#HostList", - "traits": { - "smithy.api#documentation": "

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

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

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

" - } - }, - "com.amazonaws.ssmsap#ComponentId": { - "type": "string", - "traits": { - "smithy.api#pattern": "^[\\w\\d-]+$" - } - }, - "com.amazonaws.ssmsap#ComponentIdList": { - "type": "list", - "member": { - "target": "com.amazonaws.ssmsap#ComponentId" - } - }, - "com.amazonaws.ssmsap#ComponentStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ACTIVATED", - "name": "ACTIVATED" - } - ] - } - }, - "com.amazonaws.ssmsap#ComponentSummary": { - "type": "structure", - "members": { - "ApplicationId": { - "target": "com.amazonaws.ssmsap#ApplicationId", - "traits": { - "smithy.api#documentation": "

" - } - }, - "ComponentId": { - "target": "com.amazonaws.ssmsap#ComponentId", - "traits": { - "smithy.api#documentation": "

" - } - }, - "ComponentType": { - "target": "com.amazonaws.ssmsap#ComponentType", - "traits": { - "smithy.api#documentation": "

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

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

" - } - }, - "com.amazonaws.ssmsap#ComponentSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.ssmsap#ComponentSummary" - } - }, - "com.amazonaws.ssmsap#ComponentType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "HANA", - "name": "HANA" - } - ] - } - }, - "com.amazonaws.ssmsap#ConflictException": { - "type": "structure", - "members": { - "Message": { - "target": "smithy.api#String" - } - }, - "traits": { - "smithy.api#documentation": "

", - "smithy.api#error": "client", - "smithy.api#httpError": 409 - } - }, - "com.amazonaws.ssmsap#CredentialType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ADMIN", - "name": "ADMIN" - } - ] - } - }, - "com.amazonaws.ssmsap#Database": { - "type": "structure", - "members": { - "ApplicationId": { - "target": "com.amazonaws.ssmsap#ApplicationId", - "traits": { - "smithy.api#documentation": "

" - } - }, - "ComponentId": { - "target": "com.amazonaws.ssmsap#ComponentId", - "traits": { - "smithy.api#documentation": "

" - } - }, - "Credentials": { - "target": "com.amazonaws.ssmsap#ApplicationCredentialList", - "traits": { - "smithy.api#documentation": "

" - } - }, - "DatabaseId": { - "target": "com.amazonaws.ssmsap#DatabaseId", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "DatabaseType": { - "target": "com.amazonaws.ssmsap#DatabaseType", - "traits": { - "smithy.api#documentation": "

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

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

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

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

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

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

" - } - }, - "com.amazonaws.ssmsap#DatabaseId": { - "type": "string", - "traits": { - "smithy.api#pattern": "[\\w\\d]+$" - } - }, - "com.amazonaws.ssmsap#DatabaseIdList": { - "type": "list", - "member": { - "target": "com.amazonaws.ssmsap#DatabaseId" - } - }, - "com.amazonaws.ssmsap#DatabaseName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 100 - } - } - }, - "com.amazonaws.ssmsap#DatabaseStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "RUNNING", - "name": "RUNNING" - }, - { - "value": "STARTING", - "name": "STARTING" - }, - { - "value": "STOPPED", - "name": "STOPPED" - }, - { - "value": "WARNING", - "name": "WARNING" - }, - { - "value": "UNKNOWN", - "name": "UNKNOWN" - } - ] - } - }, - "com.amazonaws.ssmsap#DatabaseSummary": { - "type": "structure", - "members": { - "ApplicationId": { - "target": "com.amazonaws.ssmsap#ApplicationId", - "traits": { - "smithy.api#documentation": "

" - } - }, - "ComponentId": { - "target": "com.amazonaws.ssmsap#ComponentId", - "traits": { - "smithy.api#documentation": "

" - } - }, - "DatabaseId": { - "target": "com.amazonaws.ssmsap#DatabaseId", - "traits": { - "smithy.api#documentation": "

" - } - }, - "DatabaseType": { - "target": "com.amazonaws.ssmsap#DatabaseType", - "traits": { - "smithy.api#documentation": "

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

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

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

" - } - }, - "com.amazonaws.ssmsap#DatabaseSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.ssmsap#DatabaseSummary" - } - }, - "com.amazonaws.ssmsap#DatabaseType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "SYSTEM", - "name": "SYSTEM" - }, - { - "value": "TENANT", - "name": "TENANT" - } - ] - } - }, - "com.amazonaws.ssmsap#DeleteResourcePermission": { - "type": "operation", - "input": { - "target": "com.amazonaws.ssmsap#DeleteResourcePermissionInput" - }, - "output": { - "target": "com.amazonaws.ssmsap#DeleteResourcePermissionOutput" - }, - "errors": [ - { - "target": "com.amazonaws.ssmsap#InternalServerException" - }, - { - "target": "com.amazonaws.ssmsap#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.ssmsap#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Removes permissions associated with the target database.

", - "smithy.api#http": { - "code": 200, - "method": "POST", - "uri": "/delete-resource-permission" - } - } - }, - "com.amazonaws.ssmsap#DeleteResourcePermissionInput": { - "type": "structure", - "members": { - "ActionType": { - "target": "com.amazonaws.ssmsap#PermissionActionType", - "traits": { - "smithy.api#documentation": "

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

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

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.ssmsap#DeleteResourcePermissionOutput": { - "type": "structure", - "members": { - "Policy": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

" - } - } - } - }, - "com.amazonaws.ssmsap#DeregisterApplication": { - "type": "operation", - "input": { - "target": "com.amazonaws.ssmsap#DeregisterApplicationInput" - }, - "output": { - "target": "com.amazonaws.ssmsap#DeregisterApplicationOutput" - }, - "errors": [ - { - "target": "com.amazonaws.ssmsap#InternalServerException" - }, - { - "target": "com.amazonaws.ssmsap#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Deregister an SAP application with AWS Systems Manager for SAP. This action does not\n affect the existing setup of your SAP workloads on Amazon EC2.

", - "smithy.api#http": { - "code": 200, - "method": "POST", - "uri": "/deregister-application" - } - } - }, - "com.amazonaws.ssmsap#DeregisterApplicationInput": { - "type": "structure", - "members": { - "ApplicationId": { - "target": "com.amazonaws.ssmsap#ApplicationId", - "traits": { - "smithy.api#documentation": "

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.ssmsap#DeregisterApplicationOutput": { - "type": "structure", - "members": {} - }, - "com.amazonaws.ssmsap#GetApplication": { - "type": "operation", - "input": { - "target": "com.amazonaws.ssmsap#GetApplicationInput" - }, - "output": { - "target": "com.amazonaws.ssmsap#GetApplicationOutput" - }, - "errors": [ - { - "target": "com.amazonaws.ssmsap#InternalServerException" - }, - { - "target": "com.amazonaws.ssmsap#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Gets an application registered with AWS Systems Manager for SAP. It also returns the\n components of the application.

", - "smithy.api#http": { - "code": 200, - "method": "POST", - "uri": "/get-application" - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.ssmsap#GetApplicationInput": { - "type": "structure", - "members": { - "ApplicationId": { - "target": "com.amazonaws.ssmsap#ApplicationId", - "traits": { - "smithy.api#documentation": "

" - } - }, - "ApplicationArn": { - "target": "com.amazonaws.ssmsap#SsmSapArn", - "traits": { - "smithy.api#documentation": "

" - } - } - } - }, - "com.amazonaws.ssmsap#GetApplicationOutput": { - "type": "structure", - "members": { - "Application": { - "target": "com.amazonaws.ssmsap#Application", - "traits": { - "smithy.api#documentation": "

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

" - } - } - } - }, - "com.amazonaws.ssmsap#GetComponent": { - "type": "operation", - "input": { - "target": "com.amazonaws.ssmsap#GetComponentInput" - }, - "output": { - "target": "com.amazonaws.ssmsap#GetComponentOutput" - }, - "errors": [ - { - "target": "com.amazonaws.ssmsap#InternalServerException" - }, - { - "target": "com.amazonaws.ssmsap#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Gets the component of an application registered with AWS Systems Manager for\n SAP.

", - "smithy.api#http": { - "code": 200, - "method": "POST", - "uri": "/get-component" - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.ssmsap#GetComponentInput": { - "type": "structure", - "members": { - "ApplicationId": { - "target": "com.amazonaws.ssmsap#ApplicationId", - "traits": { - "smithy.api#documentation": "

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

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.ssmsap#GetComponentOutput": { - "type": "structure", - "members": { - "Component": { - "target": "com.amazonaws.ssmsap#Component", - "traits": { - "smithy.api#documentation": "

" - } - } - } - }, - "com.amazonaws.ssmsap#GetDatabase": { - "type": "operation", - "input": { - "target": "com.amazonaws.ssmsap#GetDatabaseInput" - }, - "output": { - "target": "com.amazonaws.ssmsap#GetDatabaseOutput" - }, - "errors": [ - { - "target": "com.amazonaws.ssmsap#InternalServerException" - }, - { - "target": "com.amazonaws.ssmsap#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Gets the SAP HANA database of an application registered with AWS Systems Manager for\n SAP.

", - "smithy.api#http": { - "code": 200, - "method": "POST", - "uri": "/get-database" - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.ssmsap#GetDatabaseInput": { - "type": "structure", - "members": { - "ApplicationId": { - "target": "com.amazonaws.ssmsap#ApplicationId", - "traits": { - "smithy.api#documentation": "

" - } - }, - "ComponentId": { - "target": "com.amazonaws.ssmsap#ComponentId", - "traits": { - "smithy.api#documentation": "

" - } - }, - "DatabaseId": { - "target": "com.amazonaws.ssmsap#DatabaseId", - "traits": { - "smithy.api#documentation": "

" - } - }, - "DatabaseArn": { - "target": "com.amazonaws.ssmsap#SsmSapArn", - "traits": { - "smithy.api#documentation": "

" - } - } - } - }, - "com.amazonaws.ssmsap#GetDatabaseOutput": { - "type": "structure", - "members": { - "Database": { - "target": "com.amazonaws.ssmsap#Database", - "traits": { - "smithy.api#documentation": "

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

" - } - } - } - }, - "com.amazonaws.ssmsap#GetOperation": { - "type": "operation", - "input": { - "target": "com.amazonaws.ssmsap#GetOperationInput" - }, - "output": { - "target": "com.amazonaws.ssmsap#GetOperationOutput" - }, - "errors": [ - { - "target": "com.amazonaws.ssmsap#InternalServerException" - }, - { - "target": "com.amazonaws.ssmsap#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Gets the details of an operation by specifying the operation ID.

", - "smithy.api#http": { - "code": 200, - "method": "POST", - "uri": "/get-operation" - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.ssmsap#GetOperationInput": { - "type": "structure", - "members": { - "OperationId": { - "target": "com.amazonaws.ssmsap#OperationId", - "traits": { - "smithy.api#documentation": "

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.ssmsap#GetOperationOutput": { - "type": "structure", - "members": { - "Operation": { - "target": "com.amazonaws.ssmsap#Operation", - "traits": { - "smithy.api#documentation": "

" - } - } - } - }, - "com.amazonaws.ssmsap#GetResourcePermission": { - "type": "operation", - "input": { - "target": "com.amazonaws.ssmsap#GetResourcePermissionInput" - }, - "output": { - "target": "com.amazonaws.ssmsap#GetResourcePermissionOutput" - }, - "errors": [ - { - "target": "com.amazonaws.ssmsap#InternalServerException" - }, - { - "target": "com.amazonaws.ssmsap#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.ssmsap#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Gets permissions associated with the target database.

", - "smithy.api#http": { - "code": 200, - "method": "POST", - "uri": "/get-resource-permission" - } - } - }, - "com.amazonaws.ssmsap#GetResourcePermissionInput": { - "type": "structure", - "members": { - "ActionType": { - "target": "com.amazonaws.ssmsap#PermissionActionType", - "traits": { - "smithy.api#documentation": "

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

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.ssmsap#GetResourcePermissionOutput": { - "type": "structure", - "members": { - "Policy": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

" - } - } - } - }, - "com.amazonaws.ssmsap#Host": { - "type": "structure", - "members": { - "HostName": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

" - } - }, - "HostRole": { - "target": "com.amazonaws.ssmsap#HostRole", - "traits": { - "smithy.api#documentation": "

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

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

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

" - } - }, - "com.amazonaws.ssmsap#HostList": { - "type": "list", - "member": { - "target": "com.amazonaws.ssmsap#Host" - } - }, - "com.amazonaws.ssmsap#HostRole": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "LEADER", - "name": "LEADER" - }, - { - "value": "WORKER", - "name": "WORKER" - }, - { - "value": "STANDBY", - "name": "STANDBY" - }, - { - "value": "UNKNOWN", - "name": "UNKNOWN" - } - ] - } - }, - "com.amazonaws.ssmsap#InstanceId": { - "type": "string", - "traits": { - "smithy.api#pattern": "^i-[\\w\\d]{8}$|^i-[\\w\\d]{17}$" - } - }, - "com.amazonaws.ssmsap#InstanceList": { - "type": "list", - "member": { - "target": "com.amazonaws.ssmsap#InstanceId" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1 - } - } - }, - "com.amazonaws.ssmsap#InternalServerException": { - "type": "structure", - "members": { - "Message": { - "target": "smithy.api#String" - } - }, - "traits": { - "smithy.api#documentation": "

", - "smithy.api#error": "server", - "smithy.api#httpError": 500 - } - }, - "com.amazonaws.ssmsap#ListApplications": { - "type": "operation", - "input": { - "target": "com.amazonaws.ssmsap#ListApplicationsInput" - }, - "output": { - "target": "com.amazonaws.ssmsap#ListApplicationsOutput" - }, - "errors": [ - { - "target": "com.amazonaws.ssmsap#InternalServerException" - }, - { - "target": "com.amazonaws.ssmsap#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.ssmsap#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists all the applications registered with AWS Systems Manager for SAP.

", - "smithy.api#http": { - "code": 200, - "method": "POST", - "uri": "/list-applications" - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "pageSize": "MaxResults", - "items": "Applications" - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.ssmsap#ListApplicationsInput": { - "type": "structure", - "members": { - "NextToken": { - "target": "com.amazonaws.ssmsap#NextToken", - "traits": { - "smithy.api#documentation": "

" - } - }, - "MaxResults": { - "target": "com.amazonaws.ssmsap#MaxResults", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

" - } - } - } - }, - "com.amazonaws.ssmsap#ListApplicationsOutput": { - "type": "structure", - "members": { - "Applications": { - "target": "com.amazonaws.ssmsap#ApplicationSummaryList", - "traits": { - "smithy.api#documentation": "

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

" - } - } - } - }, - "com.amazonaws.ssmsap#ListComponents": { - "type": "operation", - "input": { - "target": "com.amazonaws.ssmsap#ListComponentsInput" - }, - "output": { - "target": "com.amazonaws.ssmsap#ListComponentsOutput" - }, - "errors": [ - { - "target": "com.amazonaws.ssmsap#InternalServerException" - }, - { - "target": "com.amazonaws.ssmsap#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.ssmsap#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists all the components registered with AWS Systems Manager for SAP.

", - "smithy.api#http": { - "code": 200, - "method": "POST", - "uri": "/list-components" - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "pageSize": "MaxResults", - "items": "Components" - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.ssmsap#ListComponentsInput": { - "type": "structure", - "members": { - "ApplicationId": { - "target": "com.amazonaws.ssmsap#ApplicationId", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "MaxResults": { - "target": "com.amazonaws.ssmsap#MaxResults", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

" - } - } - } - }, - "com.amazonaws.ssmsap#ListComponentsOutput": { - "type": "structure", - "members": { - "Components": { - "target": "com.amazonaws.ssmsap#ComponentSummaryList", - "traits": { - "smithy.api#documentation": "

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

" - } - } - } - }, - "com.amazonaws.ssmsap#ListDatabases": { - "type": "operation", - "input": { - "target": "com.amazonaws.ssmsap#ListDatabasesInput" - }, - "output": { - "target": "com.amazonaws.ssmsap#ListDatabasesOutput" - }, - "errors": [ - { - "target": "com.amazonaws.ssmsap#InternalServerException" - }, - { - "target": "com.amazonaws.ssmsap#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.ssmsap#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists the SAP HANA databases of an application registered with AWS Systems Manager for\n SAP.

", - "smithy.api#http": { - "code": 200, - "method": "POST", - "uri": "/list-databases" - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "pageSize": "MaxResults", - "items": "Databases" - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.ssmsap#ListDatabasesInput": { - "type": "structure", - "members": { - "ApplicationId": { - "target": "com.amazonaws.ssmsap#ApplicationId", - "traits": { - "smithy.api#documentation": "

" - } - }, - "ComponentId": { - "target": "com.amazonaws.ssmsap#ComponentId", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "MaxResults": { - "target": "com.amazonaws.ssmsap#MaxResults", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

" - } - } - } - }, - "com.amazonaws.ssmsap#ListDatabasesOutput": { - "type": "structure", - "members": { - "Databases": { - "target": "com.amazonaws.ssmsap#DatabaseSummaryList", - "traits": { - "smithy.api#documentation": "

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

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

Lists all tags on an SAP HANA application and/or database registered with AWS Systems\n Manager for SAP.

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

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

" - } - } - } - }, - "com.amazonaws.ssmsap#MaxResults": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 1, - "max": 50 - } - } - }, - "com.amazonaws.ssmsap#NextToken": { - "type": "string", - "traits": { - "smithy.api#pattern": "^.{16,1024}$" - } - }, - "com.amazonaws.ssmsap#Operation": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.ssmsap#OperationId", - "traits": { - "smithy.api#documentation": "

" - } - }, - "Type": { - "target": "com.amazonaws.ssmsap#OperationType", - "traits": { - "smithy.api#documentation": "

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

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

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

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

" - } - }, - "ResourceId": { - "target": "com.amazonaws.ssmsap#ResourceId", - "traits": { - "smithy.api#documentation": "

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

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

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

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

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

" - } - }, - "com.amazonaws.ssmsap#OperationId": { - "type": "string", - "traits": { - "smithy.api#pattern": "^[{]?[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}[}]?$" - } - }, - "com.amazonaws.ssmsap#OperationIdList": { - "type": "list", - "member": { - "target": "com.amazonaws.ssmsap#OperationId" - } - }, - "com.amazonaws.ssmsap#OperationProperties": { - "type": "map", - "key": { - "target": "smithy.api#String" - }, - "value": { - "target": "smithy.api#String" - }, - "traits": { - "smithy.api#sparse": {} - } - }, - "com.amazonaws.ssmsap#OperationStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "INPROGRESS", - "name": "INPROGRESS" - }, - { - "value": "SUCCESS", - "name": "SUCCESS" - }, - { - "value": "ERROR", - "name": "ERROR" - } - ] - } - }, - "com.amazonaws.ssmsap#OperationType": { - "type": "string" - }, - "com.amazonaws.ssmsap#PermissionActionType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "RESTORE", - "name": "RESTORE" - } - ] - } - }, - "com.amazonaws.ssmsap#PutResourcePermission": { - "type": "operation", - "input": { - "target": "com.amazonaws.ssmsap#PutResourcePermissionInput" - }, - "output": { - "target": "com.amazonaws.ssmsap#PutResourcePermissionOutput" - }, - "errors": [ - { - "target": "com.amazonaws.ssmsap#InternalServerException" - }, - { - "target": "com.amazonaws.ssmsap#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.ssmsap#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Adds permissions to the target database.

", - "smithy.api#http": { - "code": 200, - "method": "POST", - "uri": "/put-resource-permission" - } - } - }, - "com.amazonaws.ssmsap#PutResourcePermissionInput": { - "type": "structure", - "members": { - "ActionType": { - "target": "com.amazonaws.ssmsap#PermissionActionType", - "traits": { - "smithy.api#documentation": "

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

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

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.ssmsap#PutResourcePermissionOutput": { - "type": "structure", - "members": { - "Policy": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

" - } - } - } - }, - "com.amazonaws.ssmsap#RegisterApplication": { - "type": "operation", - "input": { - "target": "com.amazonaws.ssmsap#RegisterApplicationInput" - }, - "output": { - "target": "com.amazonaws.ssmsap#RegisterApplicationOutput" - }, - "errors": [ - { - "target": "com.amazonaws.ssmsap#ConflictException" - }, - { - "target": "com.amazonaws.ssmsap#InternalServerException" - }, - { - "target": "com.amazonaws.ssmsap#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Register an SAP application with AWS Systems Manager for SAP. You must meet the\n following requirements before registering.

\n

The SAP application you want to register with AWS Systems Manager for SAP is running\n on Amazon EC2.

\n

AWS Systems Manager Agent must be setup on an Amazon EC2 instance along with the required\n IAM permissions.

\n

Amazon EC2 instance(s) must have access to the secrets created in AWS Secrets\n Manager to manage SAP applications and components.

", - "smithy.api#http": { - "code": 200, - "method": "POST", - "uri": "/register-application" - } - } - }, - "com.amazonaws.ssmsap#RegisterApplicationInput": { - "type": "structure", - "members": { - "ApplicationId": { - "target": "com.amazonaws.ssmsap#ApplicationId", - "traits": { - "smithy.api#documentation": "

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

", - "smithy.api#required": {} - } - }, - "Instances": { - "target": "com.amazonaws.ssmsap#InstanceList", - "traits": { - "smithy.api#documentation": "

", - "smithy.api#required": {} - } - }, - "SapInstanceNumber": { - "target": "com.amazonaws.ssmsap#SAPInstanceNumber", - "traits": { - "smithy.api#documentation": "

" - } - }, - "Sid": { - "target": "com.amazonaws.ssmsap#SID", - "traits": { - "smithy.api#documentation": "

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

" - } - }, - "Credentials": { - "target": "com.amazonaws.ssmsap#ApplicationCredentialList", - "traits": { - "smithy.api#documentation": "

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.ssmsap#RegisterApplicationOutput": { - "type": "structure", - "members": { - "Application": { - "target": "com.amazonaws.ssmsap#Application", - "traits": { - "smithy.api#documentation": "

" - } - }, - "OperationId": { - "target": "com.amazonaws.ssmsap#OperationId", - "traits": { - "smithy.api#documentation": "

" - } - } - } - }, - "com.amazonaws.ssmsap#ResourceId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - } - } - }, - "com.amazonaws.ssmsap#ResourceNotFoundException": { - "type": "structure", - "members": { - "Message": { - "target": "smithy.api#String" - } - }, - "traits": { - "smithy.api#documentation": "

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.ssmsap#ResourceType": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - } - } - }, - "com.amazonaws.ssmsap#SAPInstanceNumber": { - "type": "string", - "traits": { - "smithy.api#pattern": "^[0-9]{2}$" - } - }, - "com.amazonaws.ssmsap#SID": { - "type": "string", - "traits": { - "smithy.api#pattern": "^[A-Z][A-Z0-9]{2}$" - } - }, - "com.amazonaws.ssmsap#SecretId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 100 - }, - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.ssmsap#SsmSap": { - "type": "service", - "version": "2018-05-10", - "operations": [ - { - "target": "com.amazonaws.ssmsap#DeleteResourcePermission" - }, - { - "target": "com.amazonaws.ssmsap#DeregisterApplication" - }, - { - "target": "com.amazonaws.ssmsap#GetApplication" - }, - { - "target": "com.amazonaws.ssmsap#GetComponent" - }, - { - "target": "com.amazonaws.ssmsap#GetDatabase" - }, - { - "target": "com.amazonaws.ssmsap#GetOperation" - }, - { - "target": "com.amazonaws.ssmsap#GetResourcePermission" - }, - { - "target": "com.amazonaws.ssmsap#ListApplications" - }, - { - "target": "com.amazonaws.ssmsap#ListComponents" - }, - { - "target": "com.amazonaws.ssmsap#ListDatabases" - }, - { - "target": "com.amazonaws.ssmsap#ListTagsForResource" - }, - { - "target": "com.amazonaws.ssmsap#PutResourcePermission" - }, - { - "target": "com.amazonaws.ssmsap#RegisterApplication" - }, - { - "target": "com.amazonaws.ssmsap#TagResource" - }, - { - "target": "com.amazonaws.ssmsap#UntagResource" - }, - { - "target": "com.amazonaws.ssmsap#UpdateApplicationSettings" - } - ], - "traits": { - "aws.api#service": { - "sdkId": "Ssm Sap", - "arnNamespace": "ssm-sap", - "cloudTrailEventSource": "ssm-sap.amazonaws.com", - "endpointPrefix": "ssm-sap" - }, - "aws.auth#sigv4": { - "name": "ssm-sap" - }, - "aws.protocols#restJson1": {}, - "smithy.api#cors": { - "additionalAllowedHeaders": [ - "content-type", - "x-amz-date", - "authorization", - "x-api-key", - "x-amz-security-token", - "x-amz-content-sha256", - "x-amz-user-agent" - ], - "origin": "*" - }, - "smithy.api#documentation": "

This API reference provides descriptions, syntax, and other details about each of the\n actions and data types for AWS Systems Manager for SAP. The topic for each action shows\n the API request parameters and responses.

", - "smithy.api#title": "AWS Systems Manager for SAP", - "smithy.rules#endpointRuleSet": { - "version": "1.0", - "parameters": { - "Region": { - "builtIn": "AWS::Region", - "required": true, - "documentation": "The AWS region used to dispatch the request.", - "type": "String" + "smithy": "2.0", + "shapes": { + "com.amazonaws.ssmsap#AppRegistryArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:aws:servicecatalog:[a-z0-9:\\/-]+$" + } + }, + "com.amazonaws.ssmsap#Application": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.ssmsap#ApplicationId", + "traits": { + "smithy.api#documentation": "

The ID of the application.

" + } + }, + "Type": { + "target": "com.amazonaws.ssmsap#ApplicationType", + "traits": { + "smithy.api#documentation": "

The type of the application.

" + } + }, + "Arn": { + "target": "com.amazonaws.ssmsap#SsmSapArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the application.

" + } + }, + "AppRegistryArn": { + "target": "com.amazonaws.ssmsap#AppRegistryArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Application Registry.

" + } + }, + "Status": { + "target": "com.amazonaws.ssmsap#ApplicationStatus", + "traits": { + "smithy.api#documentation": "

The status of the application.

" + } + }, + "Components": { + "target": "com.amazonaws.ssmsap#ComponentIdList", + "traits": { + "smithy.api#documentation": "

The components of the application.

" + } + }, + "LastUpdated": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The time at which the application was last updated.

" + } + }, + "StatusMessage": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The status message.

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

An SAP application registered with AWS Systems Manager for SAP.

" + } + }, + "com.amazonaws.ssmsap#ApplicationCredential": { + "type": "structure", + "members": { + "DatabaseName": { + "target": "com.amazonaws.ssmsap#DatabaseName", + "traits": { + "smithy.api#documentation": "

The name of the SAP HANA database.

", + "smithy.api#required": {} + } + }, + "CredentialType": { + "target": "com.amazonaws.ssmsap#CredentialType", + "traits": { + "smithy.api#documentation": "

The type of the application credentials.

", + "smithy.api#required": {} + } + }, + "SecretId": { + "target": "com.amazonaws.ssmsap#SecretId", + "traits": { + "smithy.api#documentation": "

The secret ID created in AWS Secrets Manager to store the credentials of the SAP\n application.

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

The credentials of your SAP application.

" + } + }, + "com.amazonaws.ssmsap#ApplicationCredentialList": { + "type": "list", + "member": { + "target": "com.amazonaws.ssmsap#ApplicationCredential" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 20 + } + } + }, + "com.amazonaws.ssmsap#ApplicationId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[\\w\\d]{1,50}$" + } + }, + "com.amazonaws.ssmsap#ApplicationStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ACTIVATED", + "name": "ACTIVATED" + }, + { + "value": "STARTING", + "name": "STARTING" + }, + { + "value": "STOPPED", + "name": "STOPPED" + }, + { + "value": "STOPPING", + "name": "STOPPING" + }, + { + "value": "FAILED", + "name": "FAILED" + }, + { + "value": "REGISTERING", + "name": "REGISTERING" + }, + { + "value": "DELETING", + "name": "DELETING" + }, + { + "value": "UNKNOWN", + "name": "UNKNOWN" + } + ] + } + }, + "com.amazonaws.ssmsap#ApplicationSummary": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.ssmsap#ApplicationId", + "traits": { + "smithy.api#documentation": "

The ID of the application.

" + } + }, + "Type": { + "target": "com.amazonaws.ssmsap#ApplicationType", + "traits": { + "smithy.api#documentation": "

The type of the application.

" + } + }, + "Arn": { + "target": "com.amazonaws.ssmsap#SsmSapArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the application.

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

The tags on the application.

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

The summary of the SAP application registered with AWS Systems Manager for SAP.\n

" + } + }, + "com.amazonaws.ssmsap#ApplicationSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.ssmsap#ApplicationSummary" + } + }, + "com.amazonaws.ssmsap#ApplicationType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "HANA", + "name": "HANA" + } + ] + } + }, + "com.amazonaws.ssmsap#Arn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:(.+:){2,4}.+$|^arn:(.+:){1,3}.+\\/.+$" + } + }, + "com.amazonaws.ssmsap#Component": { + "type": "structure", + "members": { + "ComponentId": { + "target": "com.amazonaws.ssmsap#ComponentId", + "traits": { + "smithy.api#documentation": "

The ID of the component.

" + } + }, + "ApplicationId": { + "target": "com.amazonaws.ssmsap#ApplicationId", + "traits": { + "smithy.api#documentation": "

The ID of the application.

" + } + }, + "ComponentType": { + "target": "com.amazonaws.ssmsap#ComponentType", + "traits": { + "smithy.api#documentation": "

The type of the component.

" + } + }, + "Status": { + "target": "com.amazonaws.ssmsap#ComponentStatus", + "traits": { + "smithy.api#documentation": "

The status of the component.

" + } + }, + "Databases": { + "target": "com.amazonaws.ssmsap#DatabaseIdList", + "traits": { + "smithy.api#documentation": "

The SAP HANA databases of the component.

" + } + }, + "Hosts": { + "target": "com.amazonaws.ssmsap#HostList", + "traits": { + "smithy.api#documentation": "

The hosts of the component.

" + } + }, + "PrimaryHost": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The primary host of the component.

" + } + }, + "LastUpdated": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The time at which the component was last updated.

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

The SAP component of your application.

" + } + }, + "com.amazonaws.ssmsap#ComponentId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[\\w\\d-]+$" + } + }, + "com.amazonaws.ssmsap#ComponentIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.ssmsap#ComponentId" + } + }, + "com.amazonaws.ssmsap#ComponentStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ACTIVATED", + "name": "ACTIVATED" + } + ] + } + }, + "com.amazonaws.ssmsap#ComponentSummary": { + "type": "structure", + "members": { + "ApplicationId": { + "target": "com.amazonaws.ssmsap#ApplicationId", + "traits": { + "smithy.api#documentation": "

The ID of the application.

" + } + }, + "ComponentId": { + "target": "com.amazonaws.ssmsap#ComponentId", + "traits": { + "smithy.api#documentation": "

The ID of the component.

" + } + }, + "ComponentType": { + "target": "com.amazonaws.ssmsap#ComponentType", + "traits": { + "smithy.api#documentation": "

The type of the component.

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

The tags of the component.

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

The summary of the component.

" + } + }, + "com.amazonaws.ssmsap#ComponentSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.ssmsap#ComponentSummary" + } + }, + "com.amazonaws.ssmsap#ComponentType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "HANA", + "name": "HANA" + } + ] + } + }, + "com.amazonaws.ssmsap#ConflictException": { + "type": "structure", + "members": { + "Message": { + "target": "smithy.api#String" + } + }, + "traits": { + "smithy.api#documentation": "

A conflict has occurred.

", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.ssmsap#CredentialType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ADMIN", + "name": "ADMIN" + } + ] + } + }, + "com.amazonaws.ssmsap#Database": { + "type": "structure", + "members": { + "ApplicationId": { + "target": "com.amazonaws.ssmsap#ApplicationId", + "traits": { + "smithy.api#documentation": "

The ID of the application.

" + } + }, + "ComponentId": { + "target": "com.amazonaws.ssmsap#ComponentId", + "traits": { + "smithy.api#documentation": "

The ID of the component.

" + } + }, + "Credentials": { + "target": "com.amazonaws.ssmsap#ApplicationCredentialList", + "traits": { + "smithy.api#documentation": "

The credentials of the database.

" + } + }, + "DatabaseId": { + "target": "com.amazonaws.ssmsap#DatabaseId", + "traits": { + "smithy.api#documentation": "

The ID of the SAP HANA database.

" + } + }, + "DatabaseName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The name of the database.

" + } + }, + "DatabaseType": { + "target": "com.amazonaws.ssmsap#DatabaseType", + "traits": { + "smithy.api#documentation": "

The type of the database.

" + } + }, + "Arn": { + "target": "com.amazonaws.ssmsap#SsmSapArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the database.

" + } + }, + "Status": { + "target": "com.amazonaws.ssmsap#DatabaseStatus", + "traits": { + "smithy.api#documentation": "

The status of the database.

" + } + }, + "PrimaryHost": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The primary host of the database.

" + } + }, + "SQLPort": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The SQL port of the database.

" + } + }, + "LastUpdated": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The time at which the database was last updated.

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

The SAP HANA database of the application registered with AWS Systems Manager for\n SAP.

" + } + }, + "com.amazonaws.ssmsap#DatabaseId": { + "type": "string", + "traits": { + "smithy.api#pattern": "[\\w\\d]+$" + } + }, + "com.amazonaws.ssmsap#DatabaseIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.ssmsap#DatabaseId" + } + }, + "com.amazonaws.ssmsap#DatabaseName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.ssmsap#DatabaseStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "RUNNING", + "name": "RUNNING" + }, + { + "value": "STARTING", + "name": "STARTING" + }, + { + "value": "STOPPED", + "name": "STOPPED" + }, + { + "value": "WARNING", + "name": "WARNING" + }, + { + "value": "UNKNOWN", + "name": "UNKNOWN" + } + ] + } + }, + "com.amazonaws.ssmsap#DatabaseSummary": { + "type": "structure", + "members": { + "ApplicationId": { + "target": "com.amazonaws.ssmsap#ApplicationId", + "traits": { + "smithy.api#documentation": "

The ID of the application.

" + } + }, + "ComponentId": { + "target": "com.amazonaws.ssmsap#ComponentId", + "traits": { + "smithy.api#documentation": "

The ID of the component.

" + } + }, + "DatabaseId": { + "target": "com.amazonaws.ssmsap#DatabaseId", + "traits": { + "smithy.api#documentation": "

The ID of the database.

" + } + }, + "DatabaseType": { + "target": "com.amazonaws.ssmsap#DatabaseType", + "traits": { + "smithy.api#documentation": "

The type of the database.

" + } + }, + "Arn": { + "target": "com.amazonaws.ssmsap#SsmSapArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the database.

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

The tags of the database.

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

The summary of the database.

" + } + }, + "com.amazonaws.ssmsap#DatabaseSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.ssmsap#DatabaseSummary" + } + }, + "com.amazonaws.ssmsap#DatabaseType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "SYSTEM", + "name": "SYSTEM" + }, + { + "value": "TENANT", + "name": "TENANT" + } + ] + } + }, + "com.amazonaws.ssmsap#DeleteResourcePermission": { + "type": "operation", + "input": { + "target": "com.amazonaws.ssmsap#DeleteResourcePermissionInput" + }, + "output": { + "target": "com.amazonaws.ssmsap#DeleteResourcePermissionOutput" + }, + "errors": [ + { + "target": "com.amazonaws.ssmsap#InternalServerException" + }, + { + "target": "com.amazonaws.ssmsap#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.ssmsap#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Removes permissions associated with the target database.

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/delete-resource-permission" + } + } + }, + "com.amazonaws.ssmsap#DeleteResourcePermissionInput": { + "type": "structure", + "members": { + "ActionType": { + "target": "com.amazonaws.ssmsap#PermissionActionType", + "traits": { + "smithy.api#documentation": "

Delete or restore the permissions on the target database.

" + } + }, + "SourceResourceArn": { + "target": "com.amazonaws.ssmsap#Arn", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "ResourceArn": { + "target": "com.amazonaws.ssmsap#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.ssmsap#DeleteResourcePermissionOutput": { + "type": "structure", + "members": { + "Policy": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The policy that removes permissions on the target database.

" + } + } + } + }, + "com.amazonaws.ssmsap#DeregisterApplication": { + "type": "operation", + "input": { + "target": "com.amazonaws.ssmsap#DeregisterApplicationInput" + }, + "output": { + "target": "com.amazonaws.ssmsap#DeregisterApplicationOutput" + }, + "errors": [ + { + "target": "com.amazonaws.ssmsap#InternalServerException" + }, + { + "target": "com.amazonaws.ssmsap#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deregister an SAP application with AWS Systems Manager for SAP. This action does not\n affect the existing setup of your SAP workloads on Amazon EC2.

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/deregister-application" + } + } + }, + "com.amazonaws.ssmsap#DeregisterApplicationInput": { + "type": "structure", + "members": { + "ApplicationId": { + "target": "com.amazonaws.ssmsap#ApplicationId", + "traits": { + "smithy.api#documentation": "

The ID of the application.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.ssmsap#DeregisterApplicationOutput": { + "type": "structure", + "members": {} + }, + "com.amazonaws.ssmsap#Filter": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.ssmsap#FilterName", + "traits": { + "smithy.api#documentation": "

The name of the filter. Filter names are case-sensitive.

", + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.ssmsap#FilterValue", + "traits": { + "smithy.api#documentation": "

The filter values. Filter values are case-sensitive. If you specify multiple values for\n a filter, the values are joined with an OR, and the request returns all results that match\n any of the specified values

", + "smithy.api#required": {} + } + }, + "Operator": { + "target": "com.amazonaws.ssmsap#FilterOperator", + "traits": { + "smithy.api#documentation": "

The operator for the filter.

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

A specific result obtained by specifying the name, value, and operator.

" + } + }, + "com.amazonaws.ssmsap#FilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.ssmsap#Filter" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.ssmsap#FilterName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 32 + } + } + }, + "com.amazonaws.ssmsap#FilterOperator": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "Equals", + "name": "EQUALS" + }, + { + "value": "GreaterThanOrEquals", + "name": "GREATER_THAN_OR_EQUALS" + }, + { + "value": "LessThanOrEquals", + "name": "LESS_THAN_OR_EQUALS" + } + ] + } + }, + "com.amazonaws.ssmsap#FilterValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + } + } + }, + "com.amazonaws.ssmsap#GetApplication": { + "type": "operation", + "input": { + "target": "com.amazonaws.ssmsap#GetApplicationInput" + }, + "output": { + "target": "com.amazonaws.ssmsap#GetApplicationOutput" + }, + "errors": [ + { + "target": "com.amazonaws.ssmsap#InternalServerException" + }, + { + "target": "com.amazonaws.ssmsap#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets an application registered with AWS Systems Manager for SAP. It also returns the\n components of the application.

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/get-application" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.ssmsap#GetApplicationInput": { + "type": "structure", + "members": { + "ApplicationId": { + "target": "com.amazonaws.ssmsap#ApplicationId", + "traits": { + "smithy.api#documentation": "

The ID of the application.

" + } + }, + "ApplicationArn": { + "target": "com.amazonaws.ssmsap#SsmSapArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the application.

" + } + }, + "AppRegistryArn": { + "target": "com.amazonaws.ssmsap#AppRegistryArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the application registry.

" + } + } + } + }, + "com.amazonaws.ssmsap#GetApplicationOutput": { + "type": "structure", + "members": { + "Application": { + "target": "com.amazonaws.ssmsap#Application", + "traits": { + "smithy.api#documentation": "

Returns all of the metadata of an application registered with AWS Systems Manager for\n SAP.

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

The tags of a registered application.

" + } + } + } + }, + "com.amazonaws.ssmsap#GetComponent": { + "type": "operation", + "input": { + "target": "com.amazonaws.ssmsap#GetComponentInput" + }, + "output": { + "target": "com.amazonaws.ssmsap#GetComponentOutput" + }, + "errors": [ + { + "target": "com.amazonaws.ssmsap#InternalServerException" + }, + { + "target": "com.amazonaws.ssmsap#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets the component of an application registered with AWS Systems Manager for\n SAP.

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/get-component" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.ssmsap#GetComponentInput": { + "type": "structure", + "members": { + "ApplicationId": { + "target": "com.amazonaws.ssmsap#ApplicationId", + "traits": { + "smithy.api#documentation": "

The ID of the application.

", + "smithy.api#required": {} + } + }, + "ComponentId": { + "target": "com.amazonaws.ssmsap#ComponentId", + "traits": { + "smithy.api#documentation": "

The ID of the component.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.ssmsap#GetComponentOutput": { + "type": "structure", + "members": { + "Component": { + "target": "com.amazonaws.ssmsap#Component", + "traits": { + "smithy.api#documentation": "

The component of an application registered with AWS Systems Manager for SAP.

" + } + } + } + }, + "com.amazonaws.ssmsap#GetDatabase": { + "type": "operation", + "input": { + "target": "com.amazonaws.ssmsap#GetDatabaseInput" + }, + "output": { + "target": "com.amazonaws.ssmsap#GetDatabaseOutput" + }, + "errors": [ + { + "target": "com.amazonaws.ssmsap#InternalServerException" + }, + { + "target": "com.amazonaws.ssmsap#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets the SAP HANA database of an application registered with AWS Systems Manager for\n SAP.

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/get-database" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.ssmsap#GetDatabaseInput": { + "type": "structure", + "members": { + "ApplicationId": { + "target": "com.amazonaws.ssmsap#ApplicationId", + "traits": { + "smithy.api#documentation": "

The ID of the application.

" + } + }, + "ComponentId": { + "target": "com.amazonaws.ssmsap#ComponentId", + "traits": { + "smithy.api#documentation": "

The ID of the component.

" + } + }, + "DatabaseId": { + "target": "com.amazonaws.ssmsap#DatabaseId", + "traits": { + "smithy.api#documentation": "

The ID of the database.

" + } + }, + "DatabaseArn": { + "target": "com.amazonaws.ssmsap#SsmSapArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the database.

" + } + } + } + }, + "com.amazonaws.ssmsap#GetDatabaseOutput": { + "type": "structure", + "members": { + "Database": { + "target": "com.amazonaws.ssmsap#Database", + "traits": { + "smithy.api#documentation": "

The SAP HANA database of an application registered with AWS Systems Manager for\n SAP.

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

The tags of a database.

" + } + } + } + }, + "com.amazonaws.ssmsap#GetOperation": { + "type": "operation", + "input": { + "target": "com.amazonaws.ssmsap#GetOperationInput" + }, + "output": { + "target": "com.amazonaws.ssmsap#GetOperationOutput" + }, + "errors": [ + { + "target": "com.amazonaws.ssmsap#InternalServerException" + }, + { + "target": "com.amazonaws.ssmsap#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets the details of an operation by specifying the operation ID.

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/get-operation" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.ssmsap#GetOperationInput": { + "type": "structure", + "members": { + "OperationId": { + "target": "com.amazonaws.ssmsap#OperationId", + "traits": { + "smithy.api#documentation": "

The ID of the operation.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.ssmsap#GetOperationOutput": { + "type": "structure", + "members": { + "Operation": { + "target": "com.amazonaws.ssmsap#Operation", + "traits": { + "smithy.api#documentation": "

Returns the details of an operation.

" + } + } + } + }, + "com.amazonaws.ssmsap#GetResourcePermission": { + "type": "operation", + "input": { + "target": "com.amazonaws.ssmsap#GetResourcePermissionInput" + }, + "output": { + "target": "com.amazonaws.ssmsap#GetResourcePermissionOutput" + }, + "errors": [ + { + "target": "com.amazonaws.ssmsap#InternalServerException" + }, + { + "target": "com.amazonaws.ssmsap#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.ssmsap#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets permissions associated with the target database.

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/get-resource-permission" + } + } + }, + "com.amazonaws.ssmsap#GetResourcePermissionInput": { + "type": "structure", + "members": { + "ActionType": { + "target": "com.amazonaws.ssmsap#PermissionActionType", + "traits": { + "smithy.api#documentation": "

" + } + }, + "ResourceArn": { + "target": "com.amazonaws.ssmsap#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.ssmsap#GetResourcePermissionOutput": { + "type": "structure", + "members": { + "Policy": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

" + } + } + } + }, + "com.amazonaws.ssmsap#Host": { + "type": "structure", + "members": { + "HostName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The name of the Dedicated Host.

" + } + }, + "HostRole": { + "target": "com.amazonaws.ssmsap#HostRole", + "traits": { + "smithy.api#documentation": "

The role of the Dedicated Host.

" + } + }, + "HostIp": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The IP address of the Dedicated Host.

" + } + }, + "InstanceId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The instance ID of the instance on the Dedicated Host.

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

Describes the properties of the Dedicated Host.

" + } + }, + "com.amazonaws.ssmsap#HostList": { + "type": "list", + "member": { + "target": "com.amazonaws.ssmsap#Host" + } + }, + "com.amazonaws.ssmsap#HostRole": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "LEADER", + "name": "LEADER" + }, + { + "value": "WORKER", + "name": "WORKER" + }, + { + "value": "STANDBY", + "name": "STANDBY" + }, + { + "value": "UNKNOWN", + "name": "UNKNOWN" + } + ] + } + }, + "com.amazonaws.ssmsap#InstanceId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^i-[\\w\\d]{8}$|^i-[\\w\\d]{17}$" + } + }, + "com.amazonaws.ssmsap#InstanceList": { + "type": "list", + "member": { + "target": "com.amazonaws.ssmsap#InstanceId" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.ssmsap#InternalServerException": { + "type": "structure", + "members": { + "Message": { + "target": "smithy.api#String" + } + }, + "traits": { + "smithy.api#documentation": "

An internal error has occurred.

", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.ssmsap#ListApplications": { + "type": "operation", + "input": { + "target": "com.amazonaws.ssmsap#ListApplicationsInput" + }, + "output": { + "target": "com.amazonaws.ssmsap#ListApplicationsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.ssmsap#InternalServerException" + }, + { + "target": "com.amazonaws.ssmsap#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.ssmsap#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists all the applications registered with AWS Systems Manager for SAP.

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/list-applications" + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults", + "items": "Applications" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.ssmsap#ListApplicationsInput": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.ssmsap#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ssmsap#MaxResults", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The maximum number of results to return with a single call. To retrieve the remaining\n results, make another call with the returned nextToken value.

" + } + } + } + }, + "com.amazonaws.ssmsap#ListApplicationsOutput": { + "type": "structure", + "members": { + "Applications": { + "target": "com.amazonaws.ssmsap#ApplicationSummaryList", + "traits": { + "smithy.api#documentation": "

The applications registered with AWS Systems Manager for SAP.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ssmsap#NextToken", + "traits": { + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are\n no more results to return.

" + } + } + } + }, + "com.amazonaws.ssmsap#ListComponents": { + "type": "operation", + "input": { + "target": "com.amazonaws.ssmsap#ListComponentsInput" + }, + "output": { + "target": "com.amazonaws.ssmsap#ListComponentsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.ssmsap#InternalServerException" + }, + { + "target": "com.amazonaws.ssmsap#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.ssmsap#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists all the components registered with AWS Systems Manager for SAP.

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/list-components" + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults", + "items": "Components" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.ssmsap#ListComponentsInput": { + "type": "structure", + "members": { + "ApplicationId": { + "target": "com.amazonaws.ssmsap#ApplicationId", + "traits": { + "smithy.api#documentation": "

The ID of the application.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ssmsap#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ssmsap#MaxResults", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The maximum number of results to return with a single call. To retrieve the remaining\n results, make another call with the returned nextToken value.

\n

If you do not specify a value for MaxResults, the request returns 50 items per page by\n default.

" + } + } + } + }, + "com.amazonaws.ssmsap#ListComponentsOutput": { + "type": "structure", + "members": { + "Components": { + "target": "com.amazonaws.ssmsap#ComponentSummaryList", + "traits": { + "smithy.api#documentation": "

List of components registered with AWS System Manager for SAP.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ssmsap#NextToken", + "traits": { + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are\n no more results to return.

" + } + } + } + }, + "com.amazonaws.ssmsap#ListDatabases": { + "type": "operation", + "input": { + "target": "com.amazonaws.ssmsap#ListDatabasesInput" + }, + "output": { + "target": "com.amazonaws.ssmsap#ListDatabasesOutput" + }, + "errors": [ + { + "target": "com.amazonaws.ssmsap#InternalServerException" + }, + { + "target": "com.amazonaws.ssmsap#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.ssmsap#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the SAP HANA databases of an application registered with AWS Systems Manager for\n SAP.

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/list-databases" + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults", + "items": "Databases" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.ssmsap#ListDatabasesInput": { + "type": "structure", + "members": { + "ApplicationId": { + "target": "com.amazonaws.ssmsap#ApplicationId", + "traits": { + "smithy.api#documentation": "

The ID of the application.

" + } + }, + "ComponentId": { + "target": "com.amazonaws.ssmsap#ComponentId", + "traits": { + "smithy.api#documentation": "

The ID of the component.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ssmsap#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ssmsap#MaxResults", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The maximum number of results to return with a single call. To retrieve the remaining\n results, make another call with the returned nextToken value. If you do not specify a value\n for MaxResults, the request returns 50 items per page by default.

" + } + } + } + }, + "com.amazonaws.ssmsap#ListDatabasesOutput": { + "type": "structure", + "members": { + "Databases": { + "target": "com.amazonaws.ssmsap#DatabaseSummaryList", + "traits": { + "smithy.api#documentation": "

The SAP HANA databases of an application.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ssmsap#NextToken", + "traits": { + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more\n results to return.

" + } + } + } + }, + "com.amazonaws.ssmsap#ListOperations": { + "type": "operation", + "input": { + "target": "com.amazonaws.ssmsap#ListOperationsInput" + }, + "output": { + "target": "com.amazonaws.ssmsap#ListOperationsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.ssmsap#InternalServerException" + }, + { + "target": "com.amazonaws.ssmsap#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the operations performed by AWS Systems Manager for SAP.

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/list-operations" + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults", + "items": "Operations" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.ssmsap#ListOperationsInput": { + "type": "structure", + "members": { + "ApplicationId": { + "target": "com.amazonaws.ssmsap#ApplicationId", + "traits": { + "smithy.api#documentation": "

The ID of the application.

", + "smithy.api#required": {} + } + }, + "MaxResults": { + "target": "com.amazonaws.ssmsap#MaxResults", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The maximum number of results to return with a single call. To retrieve the remaining results, make\n another call with the returned nextToken value.\n If you do not specify a value for MaxResults, the request returns 50 items per page by default.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ssmsap#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next page of results.\n

" + } + }, + "Filters": { + "target": "com.amazonaws.ssmsap#FilterList", + "traits": { + "smithy.api#documentation": "

The filters of an operation.

" + } + } + } + }, + "com.amazonaws.ssmsap#ListOperationsOutput": { + "type": "structure", + "members": { + "Operations": { + "target": "com.amazonaws.ssmsap#OperationList", + "traits": { + "smithy.api#documentation": "

List of operations performed by AWS Systems Manager for SAP.

" + } + }, + "NextToken": { + "target": "com.amazonaws.ssmsap#NextToken", + "traits": { + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more\n results to return.

" + } + } + } + }, + "com.amazonaws.ssmsap#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.ssmsap#ListTagsForResourceRequest" + }, + "output": { + "target": "com.amazonaws.ssmsap#ListTagsForResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ssmsap#ConflictException" + }, + { + "target": "com.amazonaws.ssmsap#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.ssmsap#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists all tags on an SAP HANA application and/or database registered with AWS Systems\n Manager for SAP.

", + "smithy.api#http": { + "method": "GET", + "uri": "/tags/{resourceArn}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.ssmsap#ListTagsForResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.ssmsap#SsmSapArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

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

" + } + } + } + }, + "com.amazonaws.ssmsap#MaxResults": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.ssmsap#NextToken": { + "type": "string", + "traits": { + "smithy.api#pattern": "^.{16,1024}$" + } + }, + "com.amazonaws.ssmsap#Operation": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.ssmsap#OperationId", + "traits": { + "smithy.api#documentation": "

The ID of the operation.

" + } + }, + "Type": { + "target": "com.amazonaws.ssmsap#OperationType", + "traits": { + "smithy.api#documentation": "

The type of the operation.

" + } + }, + "Status": { + "target": "com.amazonaws.ssmsap#OperationStatus", + "traits": { + "smithy.api#documentation": "

The status of the operation.

" + } + }, + "StatusMessage": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The status message of the operation.

" + } + }, + "Properties": { + "target": "com.amazonaws.ssmsap#OperationProperties", + "traits": { + "smithy.api#documentation": "

The properties of the operation.

" + } + }, + "ResourceType": { + "target": "com.amazonaws.ssmsap#ResourceType", + "traits": { + "smithy.api#documentation": "

The resource type of the operation.

" + } + }, + "ResourceId": { + "target": "com.amazonaws.ssmsap#ResourceId", + "traits": { + "smithy.api#documentation": "

The resource ID of the operation.

" + } + }, + "ResourceArn": { + "target": "com.amazonaws.ssmsap#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the operation.

" + } + }, + "StartTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The start time of the operation.

" + } + }, + "EndTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The end time of the operation.

" + } + }, + "LastUpdatedTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The time at which the operation was last updated.

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

The operations performed by AWS Systems Manager for SAP.

" + } + }, + "com.amazonaws.ssmsap#OperationId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[{]?[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}[}]?$" + } + }, + "com.amazonaws.ssmsap#OperationIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.ssmsap#OperationId" + } + }, + "com.amazonaws.ssmsap#OperationList": { + "type": "list", + "member": { + "target": "com.amazonaws.ssmsap#Operation" + } + }, + "com.amazonaws.ssmsap#OperationProperties": { + "type": "map", + "key": { + "target": "smithy.api#String" + }, + "value": { + "target": "smithy.api#String" + }, + "traits": { + "smithy.api#sparse": {} + } + }, + "com.amazonaws.ssmsap#OperationStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "INPROGRESS", + "name": "INPROGRESS" + }, + { + "value": "SUCCESS", + "name": "SUCCESS" + }, + { + "value": "ERROR", + "name": "ERROR" + } + ] + } + }, + "com.amazonaws.ssmsap#OperationType": { + "type": "string" + }, + "com.amazonaws.ssmsap#PermissionActionType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "RESTORE", + "name": "RESTORE" + } + ] + } + }, + "com.amazonaws.ssmsap#PutResourcePermission": { + "type": "operation", + "input": { + "target": "com.amazonaws.ssmsap#PutResourcePermissionInput" + }, + "output": { + "target": "com.amazonaws.ssmsap#PutResourcePermissionOutput" + }, + "errors": [ + { + "target": "com.amazonaws.ssmsap#InternalServerException" + }, + { + "target": "com.amazonaws.ssmsap#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.ssmsap#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Adds permissions to the target database.

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/put-resource-permission" + } + } + }, + "com.amazonaws.ssmsap#PutResourcePermissionInput": { + "type": "structure", + "members": { + "ActionType": { + "target": "com.amazonaws.ssmsap#PermissionActionType", + "traits": { + "smithy.api#documentation": "

", + "smithy.api#required": {} + } + }, + "SourceResourceArn": { + "target": "com.amazonaws.ssmsap#Arn", + "traits": { + "smithy.api#documentation": "

", + "smithy.api#required": {} + } + }, + "ResourceArn": { + "target": "com.amazonaws.ssmsap#Arn", + "traits": { + "smithy.api#documentation": "

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.ssmsap#PutResourcePermissionOutput": { + "type": "structure", + "members": { + "Policy": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

" + } + } + } + }, + "com.amazonaws.ssmsap#RegisterApplication": { + "type": "operation", + "input": { + "target": "com.amazonaws.ssmsap#RegisterApplicationInput" }, - "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" + "output": { + "target": "com.amazonaws.ssmsap#RegisterApplicationOutput" }, - "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" + "errors": [ + { + "target": "com.amazonaws.ssmsap#ConflictException" + }, + { + "target": "com.amazonaws.ssmsap#InternalServerException" + }, + { + "target": "com.amazonaws.ssmsap#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Register an SAP application with AWS Systems Manager for SAP. You must meet the\n following requirements before registering.

\n

The SAP application you want to register with AWS Systems Manager for SAP is running\n on Amazon EC2.

\n

AWS Systems Manager Agent must be setup on an Amazon EC2 instance along with the required\n IAM permissions.

\n

Amazon EC2 instance(s) must have access to the secrets created in AWS Secrets Manager to\n manage SAP applications and components.

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/register-application" + } + } + }, + "com.amazonaws.ssmsap#RegisterApplicationInput": { + "type": "structure", + "members": { + "ApplicationId": { + "target": "com.amazonaws.ssmsap#ApplicationId", + "traits": { + "smithy.api#documentation": "

The ID of the application.

", + "smithy.api#required": {} + } + }, + "ApplicationType": { + "target": "com.amazonaws.ssmsap#ApplicationType", + "traits": { + "smithy.api#documentation": "

The type of the application.

", + "smithy.api#required": {} + } + }, + "Instances": { + "target": "com.amazonaws.ssmsap#InstanceList", + "traits": { + "smithy.api#documentation": "

The Amazon EC2 instances on which your SAP application is running.

", + "smithy.api#required": {} + } + }, + "SapInstanceNumber": { + "target": "com.amazonaws.ssmsap#SAPInstanceNumber", + "traits": { + "smithy.api#documentation": "

The SAP instance number of the application.

" + } + }, + "Sid": { + "target": "com.amazonaws.ssmsap#SID", + "traits": { + "smithy.api#documentation": "

The System ID of the application.

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

The tags to be attached to the SAP application.

" + } + }, + "Credentials": { + "target": "com.amazonaws.ssmsap#ApplicationCredentialList", + "traits": { + "smithy.api#documentation": "

The credentials of the SAP application.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.ssmsap#RegisterApplicationOutput": { + "type": "structure", + "members": { + "Application": { + "target": "com.amazonaws.ssmsap#Application", + "traits": { + "smithy.api#documentation": "

The application registered with AWS Systems Manager for SAP.

" + } + }, + "OperationId": { + "target": "com.amazonaws.ssmsap#OperationId", + "traits": { + "smithy.api#documentation": "

The ID of the operation.

" + } + } + } + }, + "com.amazonaws.ssmsap#ResourceId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + } + } + }, + "com.amazonaws.ssmsap#ResourceNotFoundException": { + "type": "structure", + "members": { + "Message": { + "target": "smithy.api#String" + } }, - "Endpoint": { - "builtIn": "SDK::Endpoint", - "required": false, - "documentation": "Override the endpoint used to send this request", - "type": "String" - } - }, - "rules": [ - { - "conditions": [ + "traits": { + "smithy.api#documentation": "

The resource is not available.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.ssmsap#ResourceType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + } + } + }, + "com.amazonaws.ssmsap#SAPInstanceNumber": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[0-9]{2}$" + } + }, + "com.amazonaws.ssmsap#SID": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[A-Z][A-Z0-9]{2}$" + } + }, + "com.amazonaws.ssmsap#SecretId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.ssmsap#SsmSap": { + "type": "service", + "version": "2018-05-10", + "operations": [ + { + "target": "com.amazonaws.ssmsap#DeleteResourcePermission" + }, + { + "target": "com.amazonaws.ssmsap#DeregisterApplication" + }, + { + "target": "com.amazonaws.ssmsap#GetApplication" + }, + { + "target": "com.amazonaws.ssmsap#GetComponent" + }, + { + "target": "com.amazonaws.ssmsap#GetDatabase" + }, { - "fn": "aws.partition", - "argv": [ - { - "ref": "Region" - } - ], - "assign": "PartitionResult" - } - ], - "type": "tree", - "rules": [ + "target": "com.amazonaws.ssmsap#GetOperation" + }, { - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Endpoint" + "target": "com.amazonaws.ssmsap#GetResourcePermission" + }, + { + "target": "com.amazonaws.ssmsap#ListApplications" + }, + { + "target": "com.amazonaws.ssmsap#ListComponents" + }, + { + "target": "com.amazonaws.ssmsap#ListDatabases" + }, + { + "target": "com.amazonaws.ssmsap#ListOperations" + }, + { + "target": "com.amazonaws.ssmsap#ListTagsForResource" + }, + { + "target": "com.amazonaws.ssmsap#PutResourcePermission" + }, + { + "target": "com.amazonaws.ssmsap#RegisterApplication" + }, + { + "target": "com.amazonaws.ssmsap#TagResource" + }, + { + "target": "com.amazonaws.ssmsap#UntagResource" + }, + { + "target": "com.amazonaws.ssmsap#UpdateApplicationSettings" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "Ssm Sap", + "arnNamespace": "ssm-sap", + "cloudTrailEventSource": "ssm-sap.amazonaws.com", + "endpointPrefix": "ssm-sap" + }, + "aws.auth#sigv4": { + "name": "ssm-sap" + }, + "aws.protocols#restJson1": {}, + "smithy.api#cors": { + "additionalAllowedHeaders": [ + "content-type", + "x-amz-date", + "authorization", + "x-api-key", + "x-amz-security-token", + "x-amz-content-sha256", + "x-amz-user-agent" + ], + "origin": "*" + }, + "smithy.api#documentation": "

This API reference provides descriptions, syntax, and other details about each of the\n actions and data types for AWS Systems Manager for SAP. The topic for each action shows\n the API request parameters and responses.

", + "smithy.api#title": "AWS Systems Manager for SAP", + "smithy.rules#endpointRuleSet": { + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": true, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" } - ] }, - { - "fn": "parseURL", - "argv": [ + "rules": [ { - "ref": "Endpoint" + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://ssm-sap-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://ssm-sap-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://ssm-sap.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ] + }, + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://ssm-sap.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] } - ], - "assign": "url" - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ssm-sap-fips.us-gov-east-1.api.aws" + } }, - true - ] - } - ], - "error": "Invalid Configuration: FIPS and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [], - "type": "tree", - "rules": [ + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "us-gov-east-1" + } + }, { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ssm-sap-fips.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "us-gov-east-1" } - ], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" }, { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ssm-sap.us-gov-east-1.api.aws" + } }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] - } - ] - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "us-gov-east-1" + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ssm-sap.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "us-gov-east-1" + } + }, { - "ref": "UseFIPS" + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ssm-sap-fips.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "cn-north-1" + } }, - true - ] - }, - { - "fn": "booleanEquals", - "argv": [ { - "ref": "UseDualStack" + "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ssm-sap-fips.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "cn-north-1" + } }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ssm-sap.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "cn-north-1" } - ] }, { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ssm-sap.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "cn-north-1" } - ] - } - ], - "type": "tree", - "rules": [ + }, { - "conditions": [], - "endpoint": { - "url": "https://ssm-sap-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] - }, - { - "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" - } - ] - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "us-iso-east-1" + } + }, { - "ref": "UseFIPS" + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ssm-sap-fips.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "us-iso-east-1" + } }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "us-iso-east-1" } - ] - } - ], - "type": "tree", - "rules": [ + }, { - "conditions": [], - "endpoint": { - "url": "https://ssm-sap-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] - }, - { - "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" - } - ] - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ssm-sap.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "us-iso-east-1" + } + }, { - "ref": "UseDualStack" + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ssm-sap-fips.us-east-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "us-east-1" + } }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ssm-sap-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "us-east-1" } - ] - } - ], - "type": "tree", - "rules": [ + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ssm-sap.us-east-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "us-east-1" + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ssm-sap.us-east-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "us-east-1" + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "us-isob-east-1" + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ssm-sap-fips.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "us-isob-east-1" + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "us-isob-east-1" + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ssm-sap.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "us-isob-east-1" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "us-east-1", + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips enabled and dualstack disabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "us-east-1", + "Endpoint": "https://example.com" + } + }, { - "conditions": [], - "endpoint": { - "url": "https://ssm-sap.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" + "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "us-east-1", + "Endpoint": "https://example.com" + } } - ] - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" - } - ] - }, - { - "conditions": [], - "endpoint": { - "url": "https://ssm-sap.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] - } - ] - }, - "smithy.rules#endpointTests": { - "testCases": [ - { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://ssm-sap-fips.us-gov-east-1.api.aws" - } - }, - "params": { - "UseDualStack": true, - "Region": "us-gov-east-1", - "UseFIPS": true - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://ssm-sap-fips.us-gov-east-1.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "Region": "us-gov-east-1", - "UseFIPS": true - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://ssm-sap.us-gov-east-1.api.aws" - } - }, - "params": { - "UseDualStack": true, - "Region": "us-gov-east-1", - "UseFIPS": false - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://ssm-sap.us-gov-east-1.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "Region": "us-gov-east-1", - "UseFIPS": false - } - }, - { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://ssm-sap-fips.cn-north-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "UseDualStack": true, - "Region": "cn-north-1", - "UseFIPS": true - } - }, - { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://ssm-sap-fips.cn-north-1.amazonaws.com.cn" - } - }, - "params": { - "UseDualStack": false, - "Region": "cn-north-1", - "UseFIPS": true - } - }, - { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://ssm-sap.cn-north-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "UseDualStack": true, - "Region": "cn-north-1", - "UseFIPS": false - } - }, - { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://ssm-sap.cn-north-1.amazonaws.com.cn" - } - }, - "params": { - "UseDualStack": false, - "Region": "cn-north-1", - "UseFIPS": false - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "UseDualStack": true, - "Region": "us-iso-east-1", - "UseFIPS": true - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://ssm-sap-fips.us-iso-east-1.c2s.ic.gov" - } - }, - "params": { - "UseDualStack": false, - "Region": "us-iso-east-1", - "UseFIPS": true - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "UseDualStack": true, - "Region": "us-iso-east-1", - "UseFIPS": false - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://ssm-sap.us-iso-east-1.c2s.ic.gov" - } - }, - "params": { - "UseDualStack": false, - "Region": "us-iso-east-1", - "UseFIPS": false - } - }, - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://ssm-sap-fips.us-east-1.api.aws" - } - }, - "params": { - "UseDualStack": true, - "Region": "us-east-1", - "UseFIPS": true - } - }, - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://ssm-sap-fips.us-east-1.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "Region": "us-east-1", - "UseFIPS": true - } - }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://ssm-sap.us-east-1.api.aws" - } - }, - "params": { - "UseDualStack": true, - "Region": "us-east-1", - "UseFIPS": false - } + ], + "version": "1.0" + } + } + }, + "com.amazonaws.ssmsap#SsmSapArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:(.+:){2,4}.+$|^arn:(.+:){1,3}.+\\/.+$" + } + }, + "com.amazonaws.ssmsap#TagKey": { + "type": "string", + "traits": { + "smithy.api#pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$" + } + }, + "com.amazonaws.ssmsap#TagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.ssmsap#TagKey" + } + }, + "com.amazonaws.ssmsap#TagMap": { + "type": "map", + "key": { + "target": "com.amazonaws.ssmsap#TagKey" }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://ssm-sap.us-east-1.amazonaws.com" - } - }, - "params": { - "UseDualStack": false, - "Region": "us-east-1", - "UseFIPS": false - } + "value": { + "target": "com.amazonaws.ssmsap#TagValue" + } + }, + "com.amazonaws.ssmsap#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.ssmsap#TagResourceRequest" }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "UseDualStack": true, - "Region": "us-isob-east-1", - "UseFIPS": true - } + "output": { + "target": "com.amazonaws.ssmsap#TagResourceResponse" }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://ssm-sap-fips.us-isob-east-1.sc2s.sgov.gov" - } - }, - "params": { - "UseDualStack": false, - "Region": "us-isob-east-1", - "UseFIPS": true - } + "errors": [ + { + "target": "com.amazonaws.ssmsap#ConflictException" + }, + { + "target": "com.amazonaws.ssmsap#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.ssmsap#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates tag for a resource by specifying the ARN.

", + "smithy.api#http": { + "method": "POST", + "uri": "/tags/{resourceArn}" + } + } + }, + "com.amazonaws.ssmsap#TagResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.ssmsap#SsmSapArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

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

The tags on a resource.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.ssmsap#TagResourceResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.ssmsap#TagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, + "com.amazonaws.ssmsap#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.ssmsap#UntagResourceRequest" }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "UseDualStack": true, - "Region": "us-isob-east-1", - "UseFIPS": false - } + "output": { + "target": "com.amazonaws.ssmsap#UntagResourceResponse" }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://ssm-sap.us-isob-east-1.sc2s.sgov.gov" - } - }, - "params": { - "UseDualStack": false, - "Region": "us-isob-east-1", - "UseFIPS": false - } + "errors": [ + { + "target": "com.amazonaws.ssmsap#ConflictException" + }, + { + "target": "com.amazonaws.ssmsap#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.ssmsap#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Delete the tags for a resource.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/tags/{resourceArn}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.ssmsap#UntagResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.ssmsap#SsmSapArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

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

Adds/updates or removes credentials for applications registered with AWS Systems\n Manager for SAP.

", + "smithy.api#httpQuery": "tagKeys", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.ssmsap#UntagResourceResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.ssmsap#UpdateApplicationSettings": { + "type": "operation", + "input": { + "target": "com.amazonaws.ssmsap#UpdateApplicationSettingsInput" }, - { - "documentation": "For custom endpoint with fips disabled and dualstack disabled", - "expect": { - "endpoint": { - "url": "https://example.com" - } - }, - "params": { - "UseDualStack": false, - "Region": "us-east-1", - "UseFIPS": false, - "Endpoint": "https://example.com" - } + "output": { + "target": "com.amazonaws.ssmsap#UpdateApplicationSettingsOutput" }, - { - "documentation": "For custom endpoint with fips enabled and dualstack disabled", - "expect": { - "error": "Invalid Configuration: FIPS and custom endpoint are not supported" - }, - "params": { - "UseDualStack": false, - "Region": "us-east-1", - "UseFIPS": true, - "Endpoint": "https://example.com" - } + "errors": [ + { + "target": "com.amazonaws.ssmsap#InternalServerException" + }, + { + "target": "com.amazonaws.ssmsap#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.ssmsap#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the settings of an application registered with AWS Systems Manager for\n SAP.

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/update-application-settings" + } + } + }, + "com.amazonaws.ssmsap#UpdateApplicationSettingsInput": { + "type": "structure", + "members": { + "ApplicationId": { + "target": "com.amazonaws.ssmsap#ApplicationId", + "traits": { + "smithy.api#documentation": "

The ID of the application.

", + "smithy.api#required": {} + } + }, + "CredentialsToAddOrUpdate": { + "target": "com.amazonaws.ssmsap#ApplicationCredentialList", + "traits": { + "smithy.api#documentation": "

The credentials to be added or updated.

" + } + }, + "CredentialsToRemove": { + "target": "com.amazonaws.ssmsap#ApplicationCredentialList", + "traits": { + "smithy.api#documentation": "

The credentials to be removed.

" + } + } + } + }, + "com.amazonaws.ssmsap#UpdateApplicationSettingsOutput": { + "type": "structure", + "members": { + "Message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The update message.

" + } + }, + "OperationIds": { + "target": "com.amazonaws.ssmsap#OperationIdList", + "traits": { + "smithy.api#documentation": "

The IDs of the operations.

" + } + } + } + }, + "com.amazonaws.ssmsap#ValidationException": { + "type": "structure", + "members": { + "Message": { + "target": "smithy.api#String" + } }, - { - "documentation": "For custom endpoint with fips disabled and dualstack enabled", - "expect": { - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" - }, - "params": { - "UseDualStack": true, - "Region": "us-east-1", - "UseFIPS": false, - "Endpoint": "https://example.com" - } - } - ], - "version": "1.0" - } - } - }, - "com.amazonaws.ssmsap#SsmSapArn": { - "type": "string", - "traits": { - "smithy.api#pattern": "^arn:(.+:){2,4}.+$|^arn:(.+:){1,3}.+\\/.+$" - } - }, - "com.amazonaws.ssmsap#TagKey": { - "type": "string", - "traits": { - "smithy.api#pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$" - } - }, - "com.amazonaws.ssmsap#TagKeyList": { - "type": "list", - "member": { - "target": "com.amazonaws.ssmsap#TagKey" - } - }, - "com.amazonaws.ssmsap#TagMap": { - "type": "map", - "key": { - "target": "com.amazonaws.ssmsap#TagKey" - }, - "value": { - "target": "com.amazonaws.ssmsap#TagValue" - } - }, - "com.amazonaws.ssmsap#TagResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.ssmsap#TagResourceRequest" - }, - "output": { - "target": "com.amazonaws.ssmsap#TagResourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.ssmsap#ConflictException" - }, - { - "target": "com.amazonaws.ssmsap#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.ssmsap#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates tag for a resource by specifying the ARN.

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

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

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.ssmsap#TagResourceResponse": { - "type": "structure", - "members": {} - }, - "com.amazonaws.ssmsap#TagValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - } - } - }, - "com.amazonaws.ssmsap#UntagResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.ssmsap#UntagResourceRequest" - }, - "output": { - "target": "com.amazonaws.ssmsap#UntagResourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.ssmsap#ConflictException" - }, - { - "target": "com.amazonaws.ssmsap#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.ssmsap#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Delete the tags for a resource.

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

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

Adds/updates or removes credentials for applications registered with AWS Systems Manager for SAP.

", - "smithy.api#httpQuery": "tagKeys", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.ssmsap#UntagResourceResponse": { - "type": "structure", - "members": {} - }, - "com.amazonaws.ssmsap#UpdateApplicationSettings": { - "type": "operation", - "input": { - "target": "com.amazonaws.ssmsap#UpdateApplicationSettingsInput" - }, - "output": { - "target": "com.amazonaws.ssmsap#UpdateApplicationSettingsOutput" - }, - "errors": [ - { - "target": "com.amazonaws.ssmsap#InternalServerException" - }, - { - "target": "com.amazonaws.ssmsap#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.ssmsap#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

", - "smithy.api#http": { - "code": 200, - "method": "POST", - "uri": "/update-application-settings" - } - } - }, - "com.amazonaws.ssmsap#UpdateApplicationSettingsInput": { - "type": "structure", - "members": { - "ApplicationId": { - "target": "com.amazonaws.ssmsap#ApplicationId", - "traits": { - "smithy.api#documentation": "

", - "smithy.api#required": {} - } - }, - "CredentialsToAddOrUpdate": { - "target": "com.amazonaws.ssmsap#ApplicationCredentialList", - "traits": { - "smithy.api#documentation": "

" - } - }, - "CredentialsToRemove": { - "target": "com.amazonaws.ssmsap#ApplicationCredentialList", - "traits": { - "smithy.api#documentation": "

" - } - } - } - }, - "com.amazonaws.ssmsap#UpdateApplicationSettingsOutput": { - "type": "structure", - "members": { - "Message": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

" - } - }, - "OperationIds": { - "target": "com.amazonaws.ssmsap#OperationIdList", - "traits": { - "smithy.api#documentation": "

" - } - } - } - }, - "com.amazonaws.ssmsap#ValidationException": { - "type": "structure", - "members": { - "Message": { - "target": "smithy.api#String" + "traits": { + "smithy.api#documentation": "

The input fails to satisfy the constraints specified by an AWS service.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } } - }, - "traits": { - "smithy.api#documentation": "

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } } - } -} +} \ No newline at end of file